1
|
|
|
<?php |
2
|
|
|
namespace UserAgentParser\Provider; |
3
|
|
|
|
4
|
|
|
use UserAgentParser\Exception\NoResultFoundException; |
5
|
|
|
use UserAgentParser\Exception\PackageNotLoadedException; |
6
|
|
|
use UserAgentParser\Model; |
7
|
|
|
use WhichBrowser\Parser as WhichBrowserParser; |
8
|
|
|
|
9
|
|
|
class WhichBrowser extends AbstractProvider |
10
|
|
|
{ |
11
|
|
|
/** |
12
|
|
|
* Name of the provider |
13
|
|
|
* |
14
|
|
|
* @var string |
15
|
|
|
*/ |
16
|
|
|
protected $name = 'WhichBrowser'; |
17
|
|
|
|
18
|
|
|
/** |
19
|
|
|
* Homepage of the provider |
20
|
|
|
* |
21
|
|
|
* @var string |
22
|
|
|
*/ |
23
|
|
|
protected $homepage = 'https://github.com/WhichBrowser/Parser'; |
24
|
|
|
|
25
|
|
|
/** |
26
|
|
|
* Composer package name |
27
|
|
|
* |
28
|
|
|
* @var string |
29
|
|
|
*/ |
30
|
|
|
protected $packageName = 'whichbrowser/parser'; |
31
|
|
|
|
32
|
|
|
protected $detectionCapabilities = [ |
33
|
|
|
|
34
|
|
|
'browser' => [ |
35
|
|
|
'name' => true, |
36
|
|
|
'version' => true, |
37
|
|
|
], |
38
|
|
|
|
39
|
|
|
'renderingEngine' => [ |
40
|
|
|
'name' => true, |
41
|
|
|
'version' => true, |
42
|
|
|
], |
43
|
|
|
|
44
|
|
|
'operatingSystem' => [ |
45
|
|
|
'name' => true, |
46
|
|
|
'version' => true, |
47
|
|
|
], |
48
|
|
|
|
49
|
|
|
'device' => [ |
50
|
|
|
'model' => true, |
51
|
|
|
'brand' => true, |
52
|
|
|
'type' => true, |
53
|
|
|
'isMobile' => true, |
54
|
|
|
'isTouch' => false, |
55
|
|
|
], |
56
|
|
|
|
57
|
|
|
'bot' => [ |
58
|
|
|
'isBot' => true, |
59
|
|
|
'name' => true, |
60
|
|
|
'type' => false, |
61
|
|
|
], |
62
|
|
|
]; |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* Used for unitTests mocking |
66
|
|
|
* |
67
|
|
|
* @var WhichBrowserParser |
68
|
|
|
*/ |
69
|
|
|
private $parser; |
70
|
|
|
|
71
|
|
|
/** |
72
|
|
|
* |
73
|
|
|
* @throws PackageNotLoadedException |
74
|
|
|
*/ |
75
|
15 |
|
public function __construct() |
76
|
|
|
{ |
77
|
15 |
|
if (! file_exists('vendor/' . $this->getPackageName() . '/composer.json')) { |
78
|
1 |
|
throw new PackageNotLoadedException('You need to install the package ' . $this->getPackageName() . ' to use this provider'); |
79
|
|
|
} |
80
|
14 |
|
} |
81
|
|
|
|
82
|
|
|
/** |
83
|
|
|
* |
84
|
|
|
* @param array $headers |
85
|
|
|
* @return WhichBrowserParser |
86
|
|
|
*/ |
87
|
8 |
|
public function getParser(array $headers) |
88
|
|
|
{ |
89
|
8 |
|
if ($this->parser !== null) { |
90
|
7 |
|
return $this->parser; |
91
|
|
|
} |
92
|
|
|
|
93
|
1 |
|
return new WhichBrowserParser($headers); |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* |
98
|
|
|
* @param Model\Bot $bot |
99
|
|
|
* @param \WhichBrowser\Model\Browser $browserRaw |
100
|
|
|
*/ |
101
|
1 |
|
private function hydrateBot(Model\Bot $bot, \WhichBrowser\Model\Browser $browserRaw) |
102
|
|
|
{ |
103
|
1 |
|
$bot->setIsBot(true); |
104
|
|
|
|
105
|
1 |
|
if ($this->isRealResult($browserRaw->getName()) === true) { |
106
|
1 |
|
$bot->setName($browserRaw->getName()); |
107
|
1 |
|
} |
108
|
1 |
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* |
112
|
|
|
* @param Model\Browser $browser |
113
|
|
|
* @param \WhichBrowser\Model\Browser $browserRaw |
114
|
|
|
*/ |
115
|
5 |
|
private function hydrateBrowser(Model\Browser $browser, \WhichBrowser\Model\Browser $browserRaw) |
116
|
|
|
{ |
117
|
5 |
|
if ($this->isRealResult($browserRaw->getName()) === true) { |
118
|
1 |
|
$browser->setName($browserRaw->getName()); |
119
|
|
|
|
120
|
1 |
|
if ($this->isRealResult($browserRaw->getVersion()) === true) { |
121
|
1 |
|
$browser->getVersion()->setComplete($browserRaw->getVersion()); |
122
|
1 |
|
} |
123
|
|
|
|
124
|
1 |
|
return; |
125
|
|
|
} |
126
|
|
|
|
127
|
4 |
|
if (isset($browserRaw->using) && $browserRaw->using instanceof \WhichBrowser\Model\Using) { |
128
|
|
|
/* @var $usingRaw \WhichBrowser\Model\Using */ |
129
|
1 |
|
$usingRaw = $browserRaw->using; |
130
|
|
|
|
131
|
1 |
|
if ($this->isRealResult($usingRaw->getName()) === true) { |
132
|
1 |
|
$browser->setName($usingRaw->getName()); |
133
|
|
|
|
134
|
1 |
|
if ($this->isRealResult($usingRaw->getVersion()) === true) { |
135
|
1 |
|
$browser->getVersion()->setComplete($usingRaw->getVersion()); |
136
|
1 |
|
} |
137
|
1 |
|
} |
138
|
1 |
|
} |
139
|
4 |
|
} |
140
|
|
|
|
141
|
|
|
/** |
142
|
|
|
* |
143
|
|
|
* @param Model\RenderingEngine $engine |
144
|
|
|
* @param \WhichBrowser\Model\Engine $engineRaw |
145
|
|
|
*/ |
146
|
5 |
|
private function hydrateRenderingEngine(Model\RenderingEngine $engine, \WhichBrowser\Model\Engine $engineRaw) |
147
|
|
|
{ |
148
|
5 |
|
if ($this->isRealResult($engineRaw->getName()) === true) { |
149
|
1 |
|
$engine->setName($engineRaw->getName()); |
150
|
1 |
|
} |
151
|
|
|
|
152
|
5 |
|
if ($this->isRealResult($engineRaw->getVersion()) === true) { |
153
|
1 |
|
$engine->getVersion()->setComplete($engineRaw->getVersion()); |
154
|
1 |
|
} |
155
|
5 |
|
} |
156
|
|
|
|
157
|
|
|
/** |
158
|
|
|
* |
159
|
|
|
* @param Model\OperatingSystem $os |
160
|
|
|
* @param \WhichBrowser\Model\Os $osRaw |
161
|
|
|
*/ |
162
|
5 |
|
private function hydrateOperatingSystem(Model\OperatingSystem $os, \WhichBrowser\Model\Os $osRaw) |
163
|
|
|
{ |
164
|
5 |
|
if ($this->isRealResult($osRaw->getName()) === true) { |
165
|
1 |
|
$os->setName($osRaw->getName()); |
166
|
1 |
|
} |
167
|
|
|
|
168
|
5 |
|
if ($this->isRealResult($osRaw->getVersion()) === true) { |
169
|
1 |
|
$os->getVersion()->setComplete($osRaw->getVersion()); |
170
|
1 |
|
} |
171
|
5 |
|
} |
172
|
|
|
|
173
|
|
|
/** |
174
|
|
|
* |
175
|
|
|
* @param Model\Device $device |
176
|
|
|
* @param \WhichBrowser\Model\Device $deviceRaw |
177
|
|
|
* @param WhichBrowserParser $parser |
178
|
|
|
*/ |
179
|
5 |
|
private function hydrateDevice(Model\Device $device, \WhichBrowser\Model\Device $deviceRaw, WhichBrowserParser $parser) |
180
|
|
|
{ |
181
|
5 |
|
if ($this->isRealResult($deviceRaw->getModel()) === true) { |
182
|
1 |
|
$device->setModel($deviceRaw->getModel()); |
183
|
1 |
|
} |
184
|
|
|
|
185
|
5 |
|
if ($this->isRealResult($deviceRaw->getManufacturer()) === true) { |
186
|
1 |
|
$device->setBrand($deviceRaw->getManufacturer()); |
187
|
1 |
|
} |
188
|
|
|
|
189
|
5 |
|
if ($this->isRealResult($parser->getType()) === true) { |
190
|
1 |
|
$device->setType($parser->getType()); |
191
|
1 |
|
} |
192
|
|
|
|
193
|
5 |
|
if ($parser->isMobile() === true) { |
194
|
1 |
|
$device->setIsMobile(true); |
195
|
1 |
|
} |
196
|
5 |
|
} |
197
|
|
|
|
198
|
7 |
|
public function parse($userAgent, array $headers = []) |
199
|
|
|
{ |
200
|
7 |
|
$headers['User-Agent'] = $userAgent; |
201
|
|
|
|
202
|
7 |
|
$parser = $this->getParser($headers); |
203
|
|
|
|
204
|
|
|
/* |
205
|
|
|
* No result found? |
206
|
|
|
*/ |
207
|
7 |
|
if ($parser->isDetected() !== true) { |
208
|
1 |
|
throw new NoResultFoundException('No result found for user agent: ' . $userAgent); |
209
|
|
|
} |
210
|
|
|
|
211
|
|
|
/* |
212
|
|
|
* Hydrate the model |
213
|
|
|
*/ |
214
|
6 |
|
$result = new Model\UserAgent(); |
215
|
6 |
|
$result->setProviderResultRaw($parser->toArray()); |
216
|
|
|
|
217
|
|
|
/* |
218
|
|
|
* Bot detection |
219
|
|
|
*/ |
220
|
6 |
|
if ($parser->getType() === 'bot') { |
221
|
1 |
|
$this->hydrateBot($result->getBot(), $parser->browser); |
222
|
|
|
|
223
|
1 |
|
return $result; |
224
|
|
|
} |
225
|
|
|
|
226
|
|
|
/* |
227
|
|
|
* hydrate the result |
228
|
|
|
*/ |
229
|
5 |
|
$this->hydrateBrowser($result->getBrowser(), $parser->browser); |
230
|
5 |
|
$this->hydrateRenderingEngine($result->getRenderingEngine(), $parser->engine); |
231
|
5 |
|
$this->hydrateOperatingSystem($result->getOperatingSystem(), $parser->os); |
232
|
5 |
|
$this->hydrateDevice($result->getDevice(), $parser->device, $parser); |
233
|
|
|
|
234
|
5 |
|
return $result; |
235
|
|
|
} |
236
|
|
|
} |
237
|
|
|
|