1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\DeviceDetector;
use DeviceDetector\ClientHints;
use DeviceDetector\DeviceDetector;
use Piwik\Container\StaticContainer;
class DeviceDetectorFactory
{
protected static $deviceDetectorInstances = [];
/**
* Returns an instance of DeviceDetector for the given user agent. Uses template method pattern
* and calls getDeviceDetectionInfo() when it doesn't find a matching instance in the cache.
* @param string $userAgent
* @param array $clientHints
* @return DeviceDetector
*/
public function makeInstance($userAgent, array $clientHints = [])
{
$cacheKey = self::getNormalizedUserAgent($userAgent, $clientHints);
if (array_key_exists($cacheKey, self::$deviceDetectorInstances)) {
return self::$deviceDetectorInstances[$cacheKey];
}
$deviceDetector = $this->getDeviceDetectionInfo($userAgent, $clientHints);
self::$deviceDetectorInstances[$cacheKey] = $deviceDetector;
return $deviceDetector;
}
public static function getNormalizedUserAgent($userAgent, array $clientHints = [])
{
$normalizedClientHints = '';
if (is_array($clientHints) && count($clientHints)) {
$hints = ClientHints::factory($clientHints);
$brands = $hints->getBrandList();
ksort($brands);
// we only take the (sorted) list of brand, os + version and model name into account, as the other values
// are actually not used and should not change the result
$normalizedClientHints = md5(json_encode($brands) . $hints->getOperatingSystem() . $hints->getOperatingSystemVersion() . $hints->getModel());
}
return mb_substr($normalizedClientHints . trim($userAgent), 0, 500);
}
/**
* Creates a new DeviceDetector for the user agent. Called by makeInstance() when no matching instance
* was found in the cache.
* @param string $userAgent
* @param array $clientHints
* @return DeviceDetector
*/
protected function getDeviceDetectionInfo($userAgent, array $clientHints = [])
{
$deviceDetector = new DeviceDetector($userAgent, ClientHints::factory($clientHints));
$deviceDetector->discardBotInformation();
$deviceDetector->setCache(StaticContainer::get('DeviceDetector\Cache\Cache'));
$deviceDetector->parse();
return $deviceDetector;
}
public static function clearInstancesCache()
{
self::$deviceDetectorInstances = [];
}
}
|
