hexydec / agentzero

src/agentzero.php

<?php
declare(strict_types = 1);
namespace hexydec\agentzero;

class agentzero {

	// ua string
	public readonly string $string;

	// categories
	public readonly ?string $type;
	public readonly ?string $category;

	// device
	public readonly ?string $vendor;
	public readonly ?string $device;
	public readonly ?string $model;
	public readonly ?string $build;
	public readonly ?int $ram;

	// architecture
	public readonly ?string $processor;
	public readonly ?string $architecture;
	public readonly ?int $bits;
	public readonly ?string $cpu;
	public readonly ?int $cpuclock;

	// platform
	public readonly ?string $kernel;
	public readonly ?string $platform;
	public readonly ?string $platformversion;

	// browser
	public readonly ?string $engine;
	public readonly ?string $engineversion;
	public readonly ?string $browser;
	public readonly ?string $browserversion;
	public readonly ?string $browserstatus;
	public readonly ?string $browserreleased;
	public readonly ?string $browserlatest;
	public readonly ?string $language;

	// app
	public readonly ?string $app;
	public readonly ?string $appname;
	public readonly ?string $appversion;
	public readonly ?string $framework;
	public readonly ?string $frameworkversion;
	public readonly ?string $url;

	// network
	public readonly ?string $nettype;
	public readonly ?string $proxy;

	// screen
	public readonly ?int $width;
	public readonly ?int $height;
	public readonly ?int $dpi;
	public readonly ?float $density;
	public readonly ?bool $darkmode;

	/**
	 * Constructs a new AgentZero object, private because it can only be created internally
	 * 
	 * @param string $ua The user-agent string
	 * @param \stdClass $data A stdClass object containing the UA details
	 */
	private function __construct(string $ua, \stdClass $data) {
		$this->string = $ua;

The property string is declared read-only in hexydec\agentzero\agentzero.

		// categories
		$this->type = $data->type ?? null;

The property type is declared read-only in hexydec\agentzero\agentzero.

		$this->category = $data->category ?? null;

The property category is declared read-only in hexydec\agentzero\agentzero.

		// device
		$this->vendor = $data->vendor ?? null;

The property vendor is declared read-only in hexydec\agentzero\agentzero.

		$this->device = $data->device ?? null;

The property device is declared read-only in hexydec\agentzero\agentzero.

		$this->model = $data->model ?? null;

The property model is declared read-only in hexydec\agentzero\agentzero.

		$this->build = $data->build ?? null;

The property build is declared read-only in hexydec\agentzero\agentzero.

		$this->ram = $data->ram ?? null;

The property ram is declared read-only in hexydec\agentzero\agentzero.

		// architecture
		$this->processor = $data->processor ?? null;

The property processor is declared read-only in hexydec\agentzero\agentzero.

		$this->architecture = $data->architecture ?? null;

The property architecture is declared read-only in hexydec\agentzero\agentzero.

		$this->bits = $data->bits ?? null;

The property bits is declared read-only in hexydec\agentzero\agentzero.

		$this->cpu = $data->cpu ?? null;

The property cpu is declared read-only in hexydec\agentzero\agentzero.

		$this->cpuclock = $data->cpuclock ?? null;

The property cpuclock is declared read-only in hexydec\agentzero\agentzero.

		// platform
		$this->kernel = $data->kernel ?? null;

The property kernel is declared read-only in hexydec\agentzero\agentzero.

		$this->platform = $data->platform ?? null;

The property platform is declared read-only in hexydec\agentzero\agentzero.

		$this->platformversion = $data->platformversion ?? null;

The property platformversion is declared read-only in hexydec\agentzero\agentzero.

		// browser
		$this->engine = $data->engine ?? null;

The property engine is declared read-only in hexydec\agentzero\agentzero.

		$this->engineversion = $data->engineversion ?? null;

The property engineversion is declared read-only in hexydec\agentzero\agentzero.

		$this->browser = $data->browser ?? null;

The property browser is declared read-only in hexydec\agentzero\agentzero.

		$this->browserversion = $data->browserversion ?? null;

The property browserversion is declared read-only in hexydec\agentzero\agentzero.

		$this->browserstatus = $data->browserstatus ?? null;

The property browserstatus is declared read-only in hexydec\agentzero\agentzero.

		$this->browserreleased = !empty($data->browserreleased) ? $data->browserreleased : null;

The property browserreleased is declared read-only in hexydec\agentzero\agentzero.

		$this->browserlatest = $data->browserlatest ?? null;

The property browserlatest is declared read-only in hexydec\agentzero\agentzero.

		$this->language = $data->language ?? null;

The property language is declared read-only in hexydec\agentzero\agentzero.

		// app
		$this->app = $data->app ?? null;

The property app is declared read-only in hexydec\agentzero\agentzero.

		$this->appname = $data->appname ?? null;

The property appname is declared read-only in hexydec\agentzero\agentzero.

		$this->appversion = $data->appversion ?? null;

The property appversion is declared read-only in hexydec\agentzero\agentzero.

		$this->framework = $data->framework ?? null;

The property framework is declared read-only in hexydec\agentzero\agentzero.

		$this->frameworkversion = $data->frameworkversion ?? null;

The property frameworkversion is declared read-only in hexydec\agentzero\agentzero.

		$this->url = $data->url ?? null;

The property url is declared read-only in hexydec\agentzero\agentzero.

		// network
		$this->nettype = $data->nettype ?? null;

The property nettype is declared read-only in hexydec\agentzero\agentzero.

		$this->proxy = $data->proxy ?? null;

The property proxy is declared read-only in hexydec\agentzero\agentzero.

		// screen
		$this->width = $data->width ?? null;

The property width is declared read-only in hexydec\agentzero\agentzero.

		$this->height = $data->height ?? null;

The property height is declared read-only in hexydec\agentzero\agentzero.

		$this->dpi = $data->dpi ?? null;

The property dpi is declared read-only in hexydec\agentzero\agentzero.

		$this->density = $data->density ?? null;

The property density is declared read-only in hexydec\agentzero\agentzero.

		$this->darkmode = $data->darkmode ?? null;

The property darkmode is declared read-only in hexydec\agentzero\agentzero.

	}

	/**
	 * Retrieves calculated properties
	 * 
	 * @param string $key The name of the property to retrieve
	 * @return string|int|null The requested property or null if it doesn't exist
	 */
	public function __get(string $key) : string|int|null {
		switch ($key) {
			case 'host':
				if ($this->url !== null && ($host = \parse_url($this->url, PHP_URL_HOST)) !== false && $host !== null) {
					return \str_starts_with($host, 'www.') ? \substr($host, 4) : $host;
				}
				return null;
			case 'browsermajorversion':
			case 'enginemajorversion':
			case 'platformmajorversion':
			case 'appmajorversion':
				$item = \str_replace('major', '', $key);
				$value = $this->{$item} ?? null;
				return $value === null ? null : \intval(\substr($value, 0, \strspn($value, '0123456789')));
		}
		return $this->{$key} ?? null;
	}

	/**
	 * Fetch the client hints sent by the browser
	 * 
	 * @return array<string,string> An array containing relevant client hints sent by the client
	 */
	public static function getHints() : array {
		$hints = [
			'sec-ch-ua-mobile',
			'sec-ch-ua-full-version-list',
			'sec-ch-ua-platform',
			'sec-ch-ua-platform-version',
			'sec-ch-ua-model',
			'device-memory',
			'width',
			'ect'
		];
		$data = [];
		foreach ($hints AS $item) {
			$upper = \strtoupper(\str_replace('-', '_', $item));
			if (!empty($_SERVER['HTTP_'.$upper])) {
				$data[$item] = $_SERVER['HTTP_'.$upper];
			}
		}
		return $data;
	}

	/**
	 * Extracts tokens from a UA string
	 * 
	 * @param string $ua The User Agent string to be tokenised
	 * @param array<string> $single An array of strings that can appear on their own, enables the tokens to be split correctly
	 * @param array<string> $ignore An array of tokens that can be ignored in the UA string
	 * @return false|array<int,string> An array of tokens, or false if no tokens could be extracted
	 */
	protected static function getTokens(string $ua, array $single, array $ignore) : array|false {

		// prepare regexp
		$single = \implode('|', \array_map('\\preg_quote', $single, \array_fill(0, \count($single), '/')));
		$pattern = '/\{[^}]++\}|[^()\[\];,\/  _-](?:(?<!'.$single.') (?!https?:\/\/)|(?<=[a-z])\([^)]+\)|[^()\[\];,\/ ]*)*[^()\[\];,\/  _-](?:\/[^;,()\[\]  ]++)?|[0-9]/i';

		// split up ua string
		if (\preg_match_all($pattern, $ua, $match)) {

			// userland token processing
			$tokens = [];
			foreach ($match[0] AS $key => $item) {
				$lower = \mb_strtolower($item);

				// special case for handling like
				if (\str_starts_with($lower, 'like ')) {

					// chop off words up to a useful token e.g. Platform/Version
					if (\str_contains($item, '/') && ($pos = \mb_strrpos($item, ' ')) !== false) {
						$tokens[$key] = \mb_substr($item, $pos + 1);
					}

				// check token is not ignored
				} elseif (!\in_array($lower, $ignore, true)) {
					$tokens[$key] = $item;
				}
			}

			// rekey and return
			return \array_values($tokens);
		}
		return false;
	}

	/**
	 * Parses a User Agent string
	 * 
	 * @param string $ua The User Agent string to be parsed
	 * @param array $config An array of configuration keys 
	 * @return agentzero|false An agentzero object containing the parsed values of the input UA, or false if it could not be parsed
	 */
	public static function parse(string $ua, array $hints = [], array $config = []) : agentzero|false {
		$ua = \str_replace('  ', ' ', \trim(\preg_replace( '/[^[:print:]]/', '', $ua)));

		// parse client hints
		$hinted = $ua;
		$browser = hints::parse($hinted, $hints);

		// get config
		if (($config = config::get($config)) === null) {

		// get tokens
		} elseif (($tokens = self::getTokens(\trim($hinted, ' "\''), $config['single'], $config['ignore'])) !== false) {

			// extract UA info
			$tokenslower = \array_map('\\mb_strtolower', $tokens);
			foreach ($config['match'] AS $key => $item) {
				$item->match($browser, $key, $tokens, $tokenslower, $config);
			}

			// default information
			$arr = (array) $browser;
			if (empty($arr) && !empty($tokens)) {
				self::parseDefault($browser, $tokens);
			}

			// create agentzero object and return
			$arr = (array) $browser;
			if (!empty($arr)) {
				return new agentzero($ua, $browser);
			}
		}
		return false;
	}

	/**
	 * Parse the UA string when no other extractions were able to be made
	 * 
	 * @param \stdClass $obj A standard class object to populate
	 * @param array<string> $tokens An array of tokens
	 * @return void
	 */
	protected static function parseDefault(\stdClass $obj, array $tokens) : void {
		$obj->type = 'robot';
		$obj->category = 'scraper';

		// find app names
		foreach ($tokens AS $item) {
			if (\str_contains($item, '/')) {
				$parts = \explode('/', $item);
				$obj->app = crawlers::normaliseAppname($parts[0]);
				$obj->appname = $parts[0];
				if (!empty($parts[1])) {
					$obj->appversion = \ltrim($parts[1], 'v');
				}
				return;
			}
		}

		// parse the string
		foreach ($tokens AS $token) {
			$name = [];
			foreach (\explode(' ', $token) AS $item) {
				$ver = \ltrim($item, 'v'); // strip 'v' off the front of version number
				if (\strspn($ver, '0123456789.') === \strlen($ver)) {
					$app = \implode(' ', $name);
					$obj->app = crawlers::normaliseAppname($app);
					$obj->appname = $app;
					$obj->appversion = $ver;
					return;
				} else {
					$name[] = $item;
				}
			}
		}

		// just use the string
		$obj->app = crawlers::normaliseAppname($tokens[0]);
		$obj->appname = $tokens[0];
	}
}