zip-fa/useragent-parser

PHP 的用户代理嗅探库

v2.2 2022-11-10 18:09 UTC

README

这是一个极其复杂且几乎完全无用的浏览器嗅探库。无用的原因是你不应该使用浏览器嗅探。所以,马上停止,去读一读关于特性检测的东西。我是认真的。走开。你以后会感谢我的。

WhichBrowser/Parser-PHP

在服务器上使用的 WhichBrowser 的 PHP 版本。完全兼容 PHP 7.0 或更高版本,包括 PHP 8。

Build Coverage Status License Latest Stable Version

Twitter Follow

也可用

关于 WhichBrowser

但为什么说是几乎完全无用的,而不是完全无用的? 好吧,总有例外。进行浏览器嗅探有合理的原因:提高用户体验或收集关于您网站上使用的浏览器的信息。我的网站是 html5test.com,我想知道哪个分数属于哪个浏览器。为此,你需要一个浏览器嗅探库。

为什么它如此复杂?
因为每个人都撒谎。说实话,没有一款浏览器是完全诚实的。几乎所有的浏览器都声称自己是 Netscape 5,而几乎所有基于 WebKit 的浏览器都说它们是基于 Gecko。即使 Internet Explorer 11 现在也不再声称自己是 IE,而是一个类似于 Gecko 的未命名浏览器。而且情况变得更糟。这就是为什么它很复杂。

它提供了哪些信息? 你会得到一个包含关于浏览器、渲染引擎、操作系统和设备的信息的漂亮对象。它提供了名称、版本,甚至设备制造商和型号。WhichBrowser 非常顽强。它提供了其他人没有的信息。例如

JUC (Linux; U; 2.3.6; zh-cn; GT-I8150; 480*800) UCWEB8.7.4.225/145/800  
UC Browser 8.7 on a Samsung Galaxy W running Android 2.3.6

Android 从未提及

Mozilla/5.0 (Series40; Nokia501/10.0.2; Profile/MIDP-2.1 Configuration/CLDC-1.1) Gecko/20100401 S40OviBrowser/3.0.0.0.73  
Nokia Xpress 3.0.0 on a Nokia Asha 501 running Nokia Asha Platform

尽管用户代理头声称是 Series40 设备,但我们知道它实际上运行的是 Asha 平台,我们还知道 OviBrowser 已经更名为 Nokia Xpress。

Opera/9.80 (X11; Linux zvav; U; zh) Presto/2.8.119 Version/11.10  
Opera Mini on a Nokia 5230 running Series60 5.0

用户代理头看起来像是 Linux 上的 Opera 11.10,但我们知道它是 Opera Mini。我们甚至可以从中其他头部信息中找出真实的操作系统和设备型号。

需求

WhichBrowser 需要 PHP 7.0 或更高版本,并支持 PHP 8。WhichBrowser 兼容 PSR-4 自动加载标准,并遵循 PSR-1 和 PSR-2 编码风格。

如何安装

您可以通过 Composer 安装 WhichBrowser - PHP 的标准包管理器。该软件包的名称为 whichbrowser/parser

composer require whichbrowser/parser

您可以通过运行一个简单的命令轻松更新 WhichBrowser。

composer update whichbrowser/parser

您应该尽可能经常运行此命令。您甚至可以考虑为此设置一个 cron 作业。

如何使用

第一步需要 Composer 自动加载器

<?php

    require 'vendor/autoload.php';

第二步是创建一个新的 WhichBrowser\Parser 对象。该对象将包含库关于浏览器可能找到的所有信息。该对象有一个必需的参数,即浏览器发送的头部或用户代理字符串。使用头部更佳,因为它将允许更好的检测,但如果您只有用户代理字符串,这也会起作用。

例如

$result = new WhichBrowser\Parser(getallheaders());

$result = new WhichBrowser\Parser($_SERVER['HTTP_USER_AGENT']);

现在变量 $result 包含了一个对象,您可以查询信息。有各种方式来访问信息。

首先,您可以调用 toString() 函数以获取可读性好的标识

"You are using " . $result->toString();
// You are using Chrome 27 on OS X Mountain Lion 10.8

另一种可能性是查询对象

$result->isType('desktop');
// true

$result->isType('mobile', 'tablet', 'media', 'gaming:portable');
// false

$result->isBrowser('Maxthon', '<', '4.0.5');
// false

$result->isOs('iOS', '>=', '8');
// false

$result->isOs('OS X');
// true

$result->isEngine('Blink');
// true

您也可以直接访问这些属性

$result->browser->toString();
// Chrome 27  

$result->engine->toString();
// Blink

$result->os->toString();
// OS X Mountain Lion 10.8

或直接访问这些属性的某些部分

$result->browser->name;
// Chrome

$result->browser->name . ' ' . $result->browser->version.toString();
// Chrome 27

$result->browser->version->value;
// 27.0.1453.110

$result->engine->name;
// Blink

您现在也可以直接查询版本了

$result->browser->version->is('>', 26);
// true

$result->os->version->is('<', '10.7.4');
// false

选项

在创建Parser对象时,可以通过传递一个数组作为第二个参数来设置其他选项。

禁用机器人检测

在某些情况下,您可能希望禁用机器人的检测。这允许机器人故意欺骗WhichBrowser,从而您可以捕获机器人试图模仿的用户代理身份。这特别有用,当您想使用WhichBrowser在不同版本的网站之间切换,并确保爬虫看到正确的网站版本时。例如,模仿移动设备的机器人将看到您网站的移动版本。

$result = new WhichBrowser\Parser(getallheaders(), [ 'detectBots' => false ]);

启用结果缓存

WhichBrowser支持PSR-6兼容的缓存适配器,用于在请求之间缓存结果。使用缓存特别有用,如果您在网站每个页面上使用WhichBrowser,并且用户访问多个页面。在第一次访问期间,将解析标题并将结果缓存起来。在后续访问中,将使用缓存的结果,这比反复解析标题要快得多。

还有其他类型的缓存适配器,如APC、Doctrine、Memcached、MongoDB、Redis等。这些适配器的配置各不相同,但一旦配置,您只需在创建Parser对象时将其作为选项传递,或使用setCache()函数设置它。WhichBrowser已测试与PHP Cache提供的适配器兼容。有关提供适配器的其他包的列表,请参阅Packagist

例如,如果您想启用基于Memcached的缓存,则需要安装额外的Composer包

composer require cache/memcached-adapter

并按照如下方式更改对WhichBrowser/Parser的调用

$client = new \Memcached();
$client->addServer('localhost', 11211);

$pool = new \Cache\Adapter\Memcached\MemcachedCachePool($client);

$result = new WhichBrowser\Parser(getallheaders(), [ 'cache' => $pool ]);

$client = new \Memcached();
$client->addServer('localhost', 11211);

$pool = new \Cache\Adapter\Memcached\MemcachedCachePool($client);

$result = new WhichBrowser\Parser();
$result->setCache($pool);
$result->analyse(getallheaders());

您还可以指定缓存结果应在多少秒后被丢弃。默认值为900秒或15分钟。如果您认为WhichBrowser缓存使用太多内存,应降低此值。您可以通过设置cacheExpires选项或将它作为setCache()函数的第二个参数来做到这一点。

API参考

解析器对象

创建新的WhichBrowser\Parser对象后,它包含多个属性和函数。所有这些属性都保证存在。

属性

  • browser
    一个包含有关浏览器自身信息的对象
  • engine
    一个包含有关渲染引擎信息的对象
  • os
    一个包含有关操作系统信息的对象
  • device
    一个包含有关设备信息的对象

函数

getType()
返回device对象的typesubtype属性。如果存在子类型,它将与类型连接,并以分号分隔,例如:mobile:smartgaming:portable。如果子类型不适用,它只返回类型,例如:desktopereader

isType($type [,$type [,$type [,$type]]])
如果使用单个参数,该函数返回true如果参数与device对象的type属性匹配。参数可以可选地通过将子类型连接到类型并以分号分隔来提供子类型。它可以使用多个参数,在这种情况下,如果其中一个参数匹配,则函数返回true。如果没有参数匹配,则返回false

isMobile()
如果浏览器是手机、平板电脑、电子阅读器、相机、便携式媒体播放器、手表或便携式游戏机等移动设备,则返回true。否则返回false

isBrowser($name [, $comparison, $version])
用于查询浏览器对象的 nameversion 属性。此函数可以包含一个参数,用于根据 name 进行简单的比较,或者包含三个参数,用于同时比较 nameversion。第一个参数总是包含浏览器的名称。第二个参数是一个字符串,可以包含 <<===>>。第三个是一个整数、浮点数或字符串,包含版本号。您可以使用类似 1010.7'10.7.4' 的版本。有关版本比较的更多信息,请参阅 Version 对象的 is() 函数。

isEngine($name [, $comparison, $version])
用于查询 engine 对象的 nameversion 属性。此函数的工作方式与 isBrowser 完全相同。

isOs($name [, $comparison, $version])
用于查询 os 对象的 nameversion 属性。此函数的工作方式与 isBrowser 完全相同。

isDetected()
实际上检测到浏览器了吗,或者我们未能检测到任何内容?

toString()
获取检测到的浏览器的人类可读表示,包括操作系统和设备信息。

浏览器对象

WhichBrowser\Model\Browser 类的对象用于主 WhichBrowser\Parser 对象的 browser 属性,并包含多个属性。如果属性在此情况下不适用,它将是 null 或 undefined。

属性

  • name
    包含浏览器名称的字符串
  • alias
    包含浏览器的备选名称的字符串
  • version
    包含有关浏览器版本信息的版本对象
  • stock
    布尔值,如果浏览器是操作系统的默认浏览器则为 true,否则为 false
  • channel
    包含分发渠道的字符串,即 'Nightly' 或 'Next'。
  • mode
    可以包含浏览器操作模式的字符串,即 'proxy'。
  • hidden
    布尔值,如果浏览器没有名称且是操作系统的默认浏览器则为 true
  • family
    包含有关该浏览器属于哪个家族的信息的对象
  • using
    包含有关该浏览器使用的哪种类型的 webview 的信息的对象

函数

isFamily($name)
此浏览器的家族是否有此名称,或者浏览器本身是否有此名称。

isUsing($name)
浏览器是否使用具有提供名称的 webview。

getName()
获取浏览器名称

getVersion()
获取浏览器版本

toString()
获取检测到的浏览器的人类可读表示

引擎对象

WhichBrowser\Model\Engine 类的对象用于主 WhichBrowser\Parser 对象的 engine 属性,并包含多个属性。如果属性在此情况下不适用,它将是 null 或 undefined。

属性

  • name
    包含渲染引擎名称的字符串
  • version
    包含有关渲染引擎版本信息的版本对象

函数

getName()
获取渲染引擎名称

getVersion()
获取渲染引擎版本

toString()
获取检测到的渲染引擎的人类可读表示

操作系统对象

WhichBrowser\Model\Os 类的对象用于主 WhichBrowser\Parser 对象的 os 属性,并包含多个属性。如果属性在此情况下不适用,它将是 null 或 undefined。

属性

  • name
    包含操作系统名称的字符串
  • version
    包含有关操作系统版本信息的版本对象
  • family
    包含有关此操作系统属于哪个家族的信息的对象

函数

isFamily($name)
这个操作系统的家族名称是这个吗,还是操作系统本身的名称是这个。

getName()
获取操作系统的名称

getVersion()
获取操作系统的版本

toString()
获取检测到的操作系统的可读表示形式

设备对象

一个WhichBrowser\Model\Device类的对象用于主WhichBrowser\Parser对象的device属性,并包含许多属性。如果属性在此情况下不适用,它将是null或undefined。

属性

  • 类型
    包含浏览器类型的字符串。
  • 子类型
    包含浏览器子类型的字符串。
  • 已识别
    一个布尔值,如果设备已被正确定义则为true。
  • 制造商
    包含设备制造商的字符串,例如 'Apple' 或 'Samsung'。
  • 型号
    包含设备型号的字符串,例如 'iPhone' 或 'Galaxy S4'。

type属性可以包含以下列表中的任何值

  • 桌面
  • 移动
  • PDA
  • DECT
  • 平板电脑
  • 游戏
  • 电子阅读器
  • 媒体
  • 耳机
  • 手表
  • 模拟器
  • 电视
  • 显示器
  • 相机
  • 打印机
  • 标牌
  • 白板
  • 开发板
  • 飞行中
  • 电器
  • GPS
  • 汽车
  • POS
  • 机器人
  • 投影仪

如果type是"移动",则subtype属性可以包含以下列表中的任何值

  • 功能
  • 智能

如果type是"游戏",则subtype属性可以包含以下列表中的任何值

  • 控制台
  • 便携式

函数

getManufacturer()
获取制造商名称

getModel()
获取型号名称

toString()
获取检测到的设备的可读表示形式

家族对象

一个WhichBrowser\Model\Family类的对象用于WhichBrowser\Model\BrowserWhichBrowser\Model\Os对象的family属性,并包含许多属性。如果属性在此情况下不适用,它将是null或undefined。

属性

  • name
    包含家族名称的字符串
  • version
    包含有关家族版本信息的版本对象

函数

getName()
获取家族名称

getVersion()
获取家族版本

toString()
获取家族的可读表示形式

使用对象

一个WhichBrowser\Model\Using类的对象用于WhichBrowser\Model\Browser对象的using属性,并包含许多属性。如果属性在此情况下不适用,它将是null或undefined。

属性

  • name
    包含webview名称的字符串
  • version
    包含有关webview版本信息的版本对象

函数

getName()
获取webview名称

getVersion()
获取webview版本

toString()
获取webview的可读表示形式

版本对象

一个WhichBrowser\Model\Version类的对象用于browserengineos对象的version属性,并包含许多属性和函数。如果属性在此情况下不适用,它将是null或undefined。

属性


  • 包含原始版本号的字符串。
  • alias
    包含版本号的别名,例如 Windows '5.1' 的 'XP'。
  • 昵称
    包含版本号的昵称,例如 OS X '10.14' 的 'Mojave'。
  • 细节
    包含应该打印的版本号数字的整数。

函数

is($version)is($comparison, $version)
使用此功能可以轻松比较两个版本。如果您只指定一个参数,此函数将返回版本是否相同。您也可以指定两个参数,在这种情况下,第一个参数包含比较运算符,例如 <<===>>。第二个参数是要比较的版本。您可以使用类似 1010.7'10.7.4' 的版本,但请注意,1010.0 不同。例如,如果我们的操作系统版本是 10.7.4

$result->os->version->is('10.7.4');
// true

$result->os->version->is('10.7');
// true

$result->os->version->is('10');
// true

$result->os->version->is('10.0');
// false

$result->os->version->is('>', '10');
// false

$result->os->version->is('>', '10.7');
// false

$result->os->version->is('>', '10.7.3');
// true