-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathUserAgent.php
More file actions
379 lines (322 loc) · 8.05 KB
/
UserAgent.php
File metadata and controls
379 lines (322 loc) · 8.05 KB
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\HTTP;
use Config\UserAgents;
use Stringable;
/**
* Abstraction for an HTTP user agent
*
* @see \CodeIgniter\HTTP\UserAgentTest
*/
class UserAgent implements Stringable
{
/**
* Current user-agent
*
* @var string
*/
protected $agent = '';
/**
* Flag for if the user-agent belongs to a browser
*
* @var bool
*/
protected $isBrowser = false;
/**
* Flag for if the user-agent is a robot
*
* @var bool
*/
protected $isRobot = false;
/**
* Flag for if the user-agent is a mobile browser
*
* @var bool
*/
protected $isMobile = false;
/**
* Holds the config file contents.
*
* @var UserAgents
*/
protected $config;
/**
* Current user-agent platform
*
* @var string
*/
protected $platform = '';
/**
* Current user-agent browser
*
* @var string
*/
protected $browser = '';
/**
* Current user-agent version
*
* @var string
*/
protected $version = '';
/**
* Current user-agent mobile name
*
* @var string
*/
protected $mobile = '';
/**
* Current user-agent robot name
*
* @var string
*/
protected $robot = '';
/**
* HTTP Referer
*
* @var bool|string|null
*/
protected $referrer;
/**
* Constructor
*
* Sets the User Agent and runs the compilation routine
*/
public function __construct(?UserAgents $config = null)
{
$this->config = $config ?? config(UserAgents::class);
$userAgent = service('superglobals')->server('HTTP_USER_AGENT');
if ($userAgent !== null) {
$this->agent = trim($userAgent);
$this->compileData();
}
}
/**
* Is Browser
*/
public function isBrowser(?string $key = null): bool
{
if (! $this->isBrowser) {
return false;
}
// No need to be specific, it's a browser
if ((string) $key === '') {
return true;
}
// Check for a specific browser
return isset($this->config->browsers[$key]) && $this->browser === $this->config->browsers[$key];
}
/**
* Is Robot
*/
public function isRobot(?string $key = null): bool
{
if (! $this->isRobot) {
return false;
}
// No need to be specific, it's a robot
if ((string) $key === '') {
return true;
}
// Check for a specific robot
return isset($this->config->robots[$key]) && $this->robot === $this->config->robots[$key];
}
/**
* Is Mobile
*/
public function isMobile(?string $key = null): bool
{
if (! $this->isMobile) {
return false;
}
// No need to be specific, it's a mobile
if ((string) $key === '') {
return true;
}
// Check for a specific robot
return isset($this->config->mobiles[$key]) && $this->mobile === $this->config->mobiles[$key];
}
/**
* Is this a referral from another site?
*/
public function isReferral(): bool
{
if (! isset($this->referrer)) {
$referer = service('superglobals')->server('HTTP_REFERER');
if ($referer === null || $referer === '') {
$this->referrer = false;
} else {
$refererHost = @parse_url($referer, PHP_URL_HOST);
$ownHost = parse_url(\base_url(), PHP_URL_HOST);
$this->referrer = ($refererHost && $refererHost !== $ownHost);
}
}
return $this->referrer;
}
/**
* Agent String
*/
public function getAgentString(): string
{
return $this->agent;
}
/**
* Get Platform
*/
public function getPlatform(): string
{
return $this->platform;
}
/**
* Get Browser Name
*/
public function getBrowser(): string
{
return $this->browser;
}
/**
* Get the Browser Version
*/
public function getVersion(): string
{
return $this->version;
}
/**
* Get The Robot Name
*/
public function getRobot(): string
{
return $this->robot;
}
/**
* Get the Mobile Device
*/
public function getMobile(): string
{
return $this->mobile;
}
/**
* Get the referrer
*/
public function getReferrer(): string
{
$referrer = service('superglobals')->server('HTTP_REFERER');
return $referrer === null ? '' : trim($referrer);
}
/**
* Parse a custom user-agent string
*
* @return void
*/
public function parse(string $string)
{
// Reset values
$this->isBrowser = false;
$this->isRobot = false;
$this->isMobile = false;
$this->browser = '';
$this->version = '';
$this->mobile = '';
$this->robot = '';
// Set the new user-agent string and parse it, unless empty
$this->agent = $string;
if ($string !== '') {
$this->compileData();
}
}
/**
* Compile the User Agent Data
*
* @return void
*/
protected function compileData()
{
$this->setPlatform();
foreach (['setRobot', 'setBrowser', 'setMobile'] as $function) {
if ($this->{$function}()) {
break;
}
}
}
/**
* Set the Platform
*/
protected function setPlatform(): bool
{
if (is_array($this->config->platforms) && $this->config->platforms !== []) {
foreach ($this->config->platforms as $key => $val) {
if (preg_match('|' . preg_quote($key, '|') . '|i', $this->agent)) {
$this->platform = $val;
return true;
}
}
}
$this->platform = 'Unknown Platform';
return false;
}
/**
* Set the Browser
*/
protected function setBrowser(): bool
{
if (is_array($this->config->browsers) && $this->config->browsers !== []) {
foreach ($this->config->browsers as $key => $val) {
if (preg_match('|' . $key . '.*?([0-9\.]+)|i', $this->agent, $match)) {
$this->isBrowser = true;
$this->version = $match[1];
$this->browser = $val;
$this->setMobile();
return true;
}
}
}
return false;
}
/**
* Set the Robot
*/
protected function setRobot(): bool
{
if (is_array($this->config->robots) && $this->config->robots !== []) {
foreach ($this->config->robots as $key => $val) {
if (preg_match('|' . preg_quote($key, '|') . '|i', $this->agent)) {
$this->isRobot = true;
$this->robot = $val;
$this->setMobile();
return true;
}
}
}
return false;
}
/**
* Set the Mobile Device
*/
protected function setMobile(): bool
{
if (is_array($this->config->mobiles) && $this->config->mobiles !== []) {
foreach ($this->config->mobiles as $key => $val) {
if (false !== (stripos($this->agent, $key))) {
$this->isMobile = true;
$this->mobile = $val;
return true;
}
}
}
return false;
}
/**
* Outputs the original Agent String when cast as a string.
*/
public function __toString(): string
{
return $this->getAgentString();
}
}