$only
423 | *
424 | * @return static
425 | */
426 | public function setQueryData(array $data, array $only = []) : static
427 | {
428 | if ($only) {
429 | $data = \array_intersect_key($data, \array_flip($only));
430 | }
431 | $this->queryData = $data;
432 | return $this;
433 | }
434 |
435 | /**
436 | * @param string $scheme
437 | *
438 | * @return static
439 | */
440 | public function setScheme(string $scheme) : static
441 | {
442 | $this->scheme = $scheme;
443 | return $this;
444 | }
445 |
446 | /**
447 | * @param string $url
448 | *
449 | * @throws InvalidArgumentException for invalid URL
450 | *
451 | * @return static
452 | */
453 | protected function setUrl(string $url) : static
454 | {
455 | $filteredUrl = \filter_var($url, \FILTER_VALIDATE_URL);
456 | if (!$filteredUrl) {
457 | throw new InvalidArgumentException("Invalid URL: {$url}");
458 | }
459 | $url = \parse_url($filteredUrl);
460 | if ($url === false) {
461 | throw new RuntimeException("URL could not be parsed: {$filteredUrl}");
462 | }
463 | $this->setScheme($url['scheme']); // @phpstan-ignore-line
464 | if (isset($url['user'])) {
465 | $this->setUser($url['user']);
466 | }
467 | if (isset($url['pass'])) {
468 | $this->setPass($url['pass']);
469 | }
470 | $this->setHostname($url['host']); // @phpstan-ignore-line
471 | if (isset($url['port'])) {
472 | $this->setPort($url['port']);
473 | }
474 | if (isset($url['path'])) {
475 | $this->setPath($url['path']);
476 | }
477 | if (isset($url['query'])) {
478 | $this->setQuery($url['query']);
479 | }
480 | if (isset($url['fragment'])) {
481 | $this->setFragment($url['fragment']);
482 | }
483 | return $this;
484 | }
485 |
486 | /**
487 | * @param string $user
488 | *
489 | * @return static
490 | */
491 | public function setUser(string $user) : static
492 | {
493 | $this->user = $user;
494 | return $this;
495 | }
496 |
497 | #[Pure]
498 | public function jsonSerialize() : string
499 | {
500 | return $this->toString();
501 | }
502 | }
503 |
--------------------------------------------------------------------------------
/src/Debug/HTTPCollector.php:
--------------------------------------------------------------------------------
1 |
6 | *
7 | * For the full copyright and license information, please view the LICENSE
8 | * file that was distributed with this source code.
9 | */
10 | namespace Framework\HTTP\Debug;
11 |
12 | use Framework\Debug\Collector;
13 | use Framework\Debug\Debugger;
14 | use Framework\Helpers\ArraySimple;
15 | use Framework\HTTP\Request;
16 | use Framework\HTTP\Response;
17 |
18 | /**
19 | * Class HTTPCollector.
20 | *
21 | * @package http
22 | */
23 | class HTTPCollector extends Collector
24 | {
25 | protected Request $request;
26 | protected Response $response;
27 |
28 | public function setRequest(Request $request) : static
29 | {
30 | $this->request = $request;
31 | return $this;
32 | }
33 |
34 | public function setResponse(Response $response, bool $replaceRequest = true) : static
35 | {
36 | $this->response = $response;
37 | if ($replaceRequest) {
38 | $this->setRequest($response->getRequest());
39 | }
40 | return $this;
41 | }
42 |
43 | public function getActivities() : array
44 | {
45 | $activities = [];
46 | foreach ($this->getData() as $data) {
47 | if (isset($data['message'], $data['type']) &&
48 | $data['message'] === 'response' &&
49 | $data['type'] === 'send'
50 | ) {
51 | $activities[] = [
52 | 'collector' => $this->getName(),
53 | 'class' => static::class,
54 | 'description' => 'Send response',
55 | 'start' => $data['start'],
56 | 'end' => $data['end'],
57 | ];
58 | }
59 | }
60 | return $activities;
61 | }
62 |
63 | public function getContents() : string
64 | {
65 | \ob_start(); ?>
66 | Request
67 | renderRequest() ?>
68 | Response
69 | renderResponse() ?>
70 | request)) {
77 | return 'A Request instance has not been set on this collector.
';
78 | }
79 | \ob_start(); ?>
80 | IP: request->getIp() ?>
81 | Is Secure: request->isSecure() ? 'Yes' : 'No' ?>
82 | Protocol: request->getProtocol() ?>
83 | Method: request->getMethod() ?>
84 | URL: request->getUrl() ?>
85 | Server: request->getServer('SERVER_SOFTWARE') ?>
86 | Hostname:
87 | renderRequestUserAgent() ?>
88 | renderHeadersTable($this->request->getHeaderLines());
90 | echo $this->renderRequestBody();
91 | echo $this->renderRequestForm();
92 | echo $this->renderRequestFiles();
93 | return \ob_get_clean(); // @phpstan-ignore-line
94 | }
95 |
96 | protected function renderRequestUserAgent() : string
97 | {
98 | $userAgent = $this->request->getUserAgent();
99 | if ($userAgent === null) {
100 | return '';
101 | }
102 | \ob_start(); ?>
103 | User-Agent
104 |
105 |
106 |
107 | | Type |
108 | Name |
109 | Version |
110 | Platform |
111 | Is Mobile |
112 |
113 |
114 |
115 |
116 | | getType()) ?> |
117 | getName()) ?> |
118 | isBrowser()
119 | ? \htmlentities((string) $userAgent->getBrowserVersion())
120 | : '' ?> |
121 | getPlatform()) ?> |
122 | isMobile() ? 'Yes' : 'No' ?> |
123 |
124 |
125 |
126 | request->hasFiles()
133 | ? \http_build_query($this->request->getPost())
134 | : $this->request->getBody();
135 | if ($body === '') {
136 | return '';
137 | }
138 | \ob_start(); ?>
139 | Body Contents
140 |
143 | request->isPost() && !$this->request->isFormUrlEncoded()) {
150 | return '';
151 | }
152 | \ob_start(); ?>
153 | Form
154 |
155 |
156 |
157 | | Field |
158 | Value |
159 |
160 |
161 |
162 | request->getParsedBody()) as $field => $value): ?>
163 |
164 | |
165 |
166 |
167 | |
168 |
169 |
170 |
171 |
172 | request->hasFiles()) {
179 | return '';
180 | }
181 | \ob_start(); ?>
182 | Uploaded Files
183 |
184 |
185 |
186 | | Field |
187 | Name |
188 | Full Path |
189 | Type |
190 | Client Type |
191 | Extension |
192 | Size |
193 | Destination |
194 | Error |
195 |
196 |
197 |
198 | request->getFiles()) as $field => $file): ?>
199 |
200 | |
201 | getName()) ?> |
202 | getFullPath()) ?> |
203 | getType()) ?> |
204 | getClientType()) ?> |
205 | getExtension()) ?> |
206 | getSize()) ?> |
207 | getDestination() ?> |
208 | getError() ?> |
209 | getErrorMessage()) ?> |
210 |
211 |
212 |
213 |
214 | response)) {
221 | return 'A Response instance has not been set on this collector.
';
222 | }
223 | \ob_start(); ?>
224 | Protocol: response->getProtocol()) ?>
225 | Status: response->getStatus()) ?>
226 | Sent: response->isSent() ? 'Yes' : 'No' ?>
227 | response->isSent()):
229 | $info = [];
230 | foreach ($this->getData() as $data) {
231 | if (
232 | isset($data['message'], $data['type'])
233 | && $data['message'] === 'response'
234 | && $data['type'] === 'send'
235 | ) {
236 | $info = $data;
237 | break;
238 | }
239 | } ?>
240 |
241 | Time Sending: ms
242 |
243 | renderHeadersTable($this->response->getHeaderLines());
246 | if ($this->response->isReplacingHeaders()) {
247 | echo '* Note that the Response is replacing headers.
';
248 | }
249 | echo '* Note that some headers can be set outside the Response';
250 | echo ' class, for example by the session or the server.';
251 | echo ' So they don\'t appear here.
';
252 | echo $this->renderResponseCookies();
253 | echo $this->renderResponseBody();
254 | return \ob_get_clean(); // @phpstan-ignore-line
255 | }
256 |
257 | protected function renderResponseCookies() : string
258 | {
259 | if (!$this->response->getCookies()) {
260 | return '';
261 | }
262 | \ob_start(); ?>
263 | Cookies
264 |
265 |
266 |
267 | | Name |
268 | Value |
269 | Expires |
270 | Path |
271 | Domain |
272 | Is Secure |
273 | Is HTTP Only |
274 | SameSite |
275 |
276 |
277 |
278 | response->getCookies() as $cookie): ?>
279 |
280 | | getName()) ?> |
281 | getValue()) ?> |
282 | getExpires()?->format('D, d-M-Y H:i:s \G\M\T') ?> |
283 | getPath()) ?> |
284 | getDomain()) ?> |
285 | isSecure() ? 'Yes' : 'No' ?> |
286 | isHttpOnly() ? 'Yes' : 'No' ?> |
287 | getSameSite()) ?> |
288 |
289 |
290 |
291 |
292 |
299 | Body Contents
300 | response->isSent()) {
302 | echo 'Response has not been sent.
';
303 | return \ob_get_clean(); // @phpstan-ignore-line
304 | }
305 | if ($this->response->hasDownload()) {
306 | echo 'Body has downloadable content.
';
307 | return \ob_get_clean(); // @phpstan-ignore-line
308 | }
309 | $body = $this->response->getBody();
310 | if ($body === '') {
311 | echo 'Body is empty.
';
312 | return \ob_get_clean(); // @phpstan-ignore-line
313 | } ?>
314 |
317 | $headerLines
323 | *
324 | * @return string
325 | */
326 | protected function renderHeadersTable(array $headerLines) : string
327 | {
328 | \ob_start(); ?>
329 | Headers
330 | No headers.';
333 | return \ob_get_clean(); // @phpstan-ignore-line
334 | } ?>
335 |
336 |
337 |
338 | | Name |
339 | Value |
340 |
341 |
342 |
343 |
345 |
346 | |
347 | |
348 |
349 |
350 |
351 |
352 |
6 | *
7 | * For the full copyright and license information, please view the LICENSE
8 | * file that was distributed with this source code.
9 | */
10 | namespace Framework\HTTP;
11 |
12 | use BadMethodCallException;
13 | use InvalidArgumentException;
14 | use JetBrains\PhpStorm\Pure;
15 |
16 | /**
17 | * Class Message.
18 | *
19 | * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages
20 | * @see https://datatracker.ietf.org/doc/html/rfc7231
21 | *
22 | * @package http
23 | */
24 | abstract class Message implements MessageInterface
25 | {
26 | /**
27 | * HTTP Message Protocol.
28 | */
29 | protected string $protocol = Protocol::HTTP_1_1;
30 | /**
31 | * HTTP Request URL.
32 | */
33 | protected URL $url;
34 | /**
35 | * HTTP Request Method.
36 | */
37 | protected string $method;
38 | /**
39 | * HTTP Response Status Code.
40 | */
41 | protected int $statusCode;
42 | /**
43 | * HTTP Message Body.
44 | */
45 | protected string $body;
46 | /**
47 | * HTTP Message Cookies.
48 | *
49 | * @var array
50 | */
51 | protected array $cookies = [];
52 | /**
53 | * HTTP Message Headers.
54 | *
55 | * @var array
56 | */
57 | protected array $headers = [];
58 | protected int $jsonFlags = \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE;
59 |
60 | public function __toString() : string
61 | {
62 | $eol = "\r\n";
63 | $message = $this->getStartLine() . $eol;
64 | foreach ($this->getHeaderLines() as $headerLine) {
65 | $message .= $headerLine . $eol;
66 | }
67 | $message .= $eol;
68 | $message .= $this->getBody();
69 | return $message;
70 | }
71 |
72 | /**
73 | * Get the Message Start-Line.
74 | *
75 | * @throws BadMethodCallException if $this is not an instance of
76 | * RequestInterface or ResponseInterface
77 | *
78 | * @return string
79 | */
80 | public function getStartLine() : string
81 | {
82 | if ($this instanceof RequestInterface) {
83 | $query = $this->getUrl()->getQuery();
84 | $query = ($query !== null && $query !== '') ? '?' . $query : '';
85 | return $this->getMethod()
86 | . ' ' . $this->getUrl()->getPath() . $query
87 | . ' ' . $this->getProtocol();
88 | }
89 | if ($this instanceof ResponseInterface) {
90 | return $this->getProtocol()
91 | . ' ' . $this->getStatus();
92 | }
93 | throw new BadMethodCallException(
94 | static::class . ' is not an instance of ' . RequestInterface::class
95 | . ' or ' . ResponseInterface::class
96 | );
97 | }
98 |
99 | #[Pure]
100 | public function hasHeader(string $name, ?string $value = null) : bool
101 | {
102 | return $value === null
103 | ? $this->getHeader($name) !== null
104 | : $this->getHeader($name) === $value;
105 | }
106 |
107 | #[Pure]
108 | public function getHeader(string $name) : ?string
109 | {
110 | return $this->headers[\strtolower($name)] ?? null;
111 | }
112 |
113 | /**
114 | * @return array
115 | */
116 | #[Pure]
117 | public function getHeaders() : array
118 | {
119 | return $this->headers;
120 | }
121 |
122 | #[Pure]
123 | public function getHeaderLine(string $name) : ?string
124 | {
125 | $value = $this->getHeader($name);
126 | if ($value === null) {
127 | return null;
128 | }
129 | $name = ResponseHeader::getName($name);
130 | return $name . ': ' . $value;
131 | }
132 |
133 | /**
134 | * @return array
135 | */
136 | #[Pure]
137 | public function getHeaderLines() : array
138 | {
139 | $lines = [];
140 | foreach ($this->getHeaders() as $name => $value) {
141 | $name = ResponseHeader::getName($name);
142 | if (\str_contains($value, "\n")) {
143 | foreach (\explode("\n", $value) as $val) {
144 | $lines[] = $name . ': ' . $val;
145 | }
146 | continue;
147 | }
148 | $lines[] = $name . ': ' . $value;
149 | }
150 | return $lines;
151 | }
152 |
153 | /**
154 | * Set a Message header.
155 | *
156 | * @param string $name
157 | * @param string $value
158 | *
159 | * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
160 | *
161 | * @return static
162 | */
163 | protected function setHeader(string $name, string $value) : static
164 | {
165 | $this->headers[\strtolower($name)] = $value;
166 | return $this;
167 | }
168 |
169 | /**
170 | * Set a list of headers.
171 | *
172 | * @param array $headers
173 | *
174 | * @return static
175 | */
176 | protected function setHeaders(array $headers) : static
177 | {
178 | foreach ($headers as $name => $value) {
179 | $this->setHeader((string) $name, (string) $value);
180 | }
181 | return $this;
182 | }
183 |
184 | /**
185 | * Append a Message header.
186 | *
187 | * Used to set repeated header field names.
188 | *
189 | * @param string $name
190 | * @param string $value
191 | *
192 | * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
193 | *
194 | * @return static
195 | */
196 | protected function appendHeader(string $name, string $value) : static
197 | {
198 | $current = $this->getHeader($name);
199 | if ($current !== null) {
200 | $separator = $this->getHeaderValueSeparator($name);
201 | $value = $current . $separator . $value;
202 | }
203 | $this->setHeader($name, $value);
204 | return $this;
205 | }
206 |
207 | /**
208 | * @param string $headerName
209 | *
210 | * @see https://stackoverflow.com/a/38406581/6027968
211 | *
212 | * @return string
213 | */
214 | private function getHeaderValueSeparator(string $headerName) : string
215 | {
216 | if (ResponseHeader::isMultiline($headerName)) {
217 | return "\n";
218 | }
219 | return ', ';
220 | }
221 |
222 | /**
223 | * Remove a header by name.
224 | *
225 | * @param string $name
226 | *
227 | * @return static
228 | */
229 | protected function removeHeader(string $name) : static
230 | {
231 | unset($this->headers[\strtolower($name)]);
232 | return $this;
233 | }
234 |
235 | /**
236 | * Remove all headers.
237 | *
238 | * @return static
239 | */
240 | protected function removeHeaders() : static
241 | {
242 | $this->headers = [];
243 | return $this;
244 | }
245 |
246 | /**
247 | * Remove headers by names.
248 | *
249 | * @param array $names
250 | *
251 | * @return static
252 | */
253 | protected function removeHeadersByNames(array $names) : static
254 | {
255 | foreach ($names as $name) {
256 | $this->removeHeader($name);
257 | }
258 | return $this;
259 | }
260 |
261 | /**
262 | * Say if the Message has a Cookie.
263 | *
264 | * @param string $name Cookie name
265 | *
266 | * @return bool
267 | */
268 | #[Pure]
269 | public function hasCookie(string $name) : bool
270 | {
271 | return (bool) $this->getCookie($name);
272 | }
273 |
274 | /**
275 | * Get a Cookie by name.
276 | *
277 | * @param string $name
278 | *
279 | * @return Cookie|null
280 | */
281 | #[Pure]
282 | public function getCookie(string $name) : ?Cookie
283 | {
284 | return $this->cookies[$name] ?? null;
285 | }
286 |
287 | /**
288 | * Get all Cookies.
289 | *
290 | * @return array
291 | */
292 | #[Pure]
293 | public function getCookies() : array
294 | {
295 | return $this->cookies;
296 | }
297 |
298 | /**
299 | * Set a new Cookie.
300 | *
301 | * @param Cookie $cookie
302 | *
303 | * @return static
304 | */
305 | protected function setCookie(Cookie $cookie) : static
306 | {
307 | $this->cookies[$cookie->getName()] = $cookie;
308 | return $this;
309 | }
310 |
311 | /**
312 | * Set a list of Cookies.
313 | *
314 | * @param array $cookies
315 | *
316 | * @return static
317 | */
318 | protected function setCookies(array $cookies) : static
319 | {
320 | foreach ($cookies as $cookie) {
321 | $this->setCookie($cookie);
322 | }
323 | return $this;
324 | }
325 |
326 | /**
327 | * Remove a Cookie by name.
328 | *
329 | * @param string $name
330 | *
331 | * @return static
332 | */
333 | protected function removeCookie(string $name) : static
334 | {
335 | unset($this->cookies[$name]);
336 | return $this;
337 | }
338 |
339 | /**
340 | * Remove many Cookies by names.
341 | *
342 | * @param array $names
343 | *
344 | * @return static
345 | */
346 | protected function removeCookies(array $names) : static
347 | {
348 | foreach ($names as $name) {
349 | $this->removeCookie($name);
350 | }
351 | return $this;
352 | }
353 |
354 | /**
355 | * Get the Message body.
356 | *
357 | * @return string
358 | */
359 | #[Pure]
360 | public function getBody() : string
361 | {
362 | return $this->body ?? '';
363 | }
364 |
365 | /**
366 | * Set the Message body.
367 | *
368 | * @param string $body
369 | *
370 | * @return static
371 | */
372 | protected function setBody(string $body) : static
373 | {
374 | $this->body = $body;
375 | return $this;
376 | }
377 |
378 | /**
379 | * Get the HTTP protocol.
380 | *
381 | * @return string
382 | */
383 | #[Pure]
384 | public function getProtocol() : string
385 | {
386 | return $this->protocol;
387 | }
388 |
389 | /**
390 | * Set the HTTP protocol.
391 | *
392 | * @param string $protocol HTTP/1.1, HTTP/2, etc
393 | *
394 | * @return static
395 | */
396 | protected function setProtocol(string $protocol) : static
397 | {
398 | $this->protocol = Protocol::validate($protocol);
399 | return $this;
400 | }
401 |
402 | /**
403 | * Gets the HTTP Request Method.
404 | *
405 | * @return string $method One of: CONNECT, DELETE, GET, HEAD, OPTIONS,
406 | * PATCH, POST, PUT, or TRACE
407 | */
408 | #[Pure]
409 | protected function getMethod() : string
410 | {
411 | return $this->method;
412 | }
413 |
414 | /**
415 | * @param string $method
416 | *
417 | * @throws InvalidArgumentException for invalid method
418 | *
419 | * @return bool
420 | */
421 | protected function isMethod(string $method) : bool
422 | {
423 | return $this->getMethod() === Method::validate($method);
424 | }
425 |
426 | /**
427 | * Set the request method.
428 | *
429 | * @param string $method One of: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH,
430 | * POST, PUT, or TRACE
431 | *
432 | * @throws InvalidArgumentException for invalid method
433 | *
434 | * @return static
435 | */
436 | protected function setMethod(string $method) : static
437 | {
438 | $this->method = Method::validate($method);
439 | return $this;
440 | }
441 |
442 | protected function setStatusCode(int $code) : static
443 | {
444 | $this->statusCode = Status::validate($code);
445 | return $this;
446 | }
447 |
448 | /**
449 | * Get the status code.
450 | *
451 | * @return int
452 | */
453 | #[Pure]
454 | protected function getStatusCode() : int
455 | {
456 | return $this->statusCode;
457 | }
458 |
459 | protected function isStatusCode(int $code) : bool
460 | {
461 | return $this->getStatusCode() === Status::validate($code);
462 | }
463 |
464 | /**
465 | * Gets the requested URL.
466 | *
467 | * @return URL
468 | */
469 | #[Pure]
470 | protected function getUrl() : URL
471 | {
472 | return $this->url;
473 | }
474 |
475 | /**
476 | * Set the Message URL.
477 | *
478 | * @param URL|string $url
479 | *
480 | * @return static
481 | */
482 | protected function setUrl(URL | string $url) : static
483 | {
484 | if (!$url instanceof URL) {
485 | $url = new URL($url);
486 | }
487 | $this->url = $url;
488 | return $this;
489 | }
490 |
491 | #[Pure]
492 | protected function parseContentType() : ?string
493 | {
494 | $contentType = $this->getHeader('Content-Type');
495 | if ($contentType === null) {
496 | return null;
497 | }
498 | $contentType = \explode(';', $contentType, 2)[0];
499 | return \trim($contentType);
500 | }
501 |
502 | /**
503 | * Set JSON flags.
504 | *
505 | * @since 5.6
506 | *
507 | * @param int $flags
508 | *
509 | * @return static
510 | */
511 | public function setJsonFlags(int $flags) : static
512 | {
513 | $this->jsonFlags = $flags;
514 | return $this;
515 | }
516 |
517 | /**
518 | * Get JSON flags.
519 | *
520 | * @since 5.6
521 | *
522 | * @return int
523 | */
524 | public function getJsonFlags() : int
525 | {
526 | return $this->jsonFlags;
527 | }
528 |
529 | /**
530 | * @see https://developer.mozilla.org/en-US/docs/Glossary/Quality_values
531 | * @see https://stackoverflow.com/a/33748742/6027968
532 | *
533 | * @param string|null $string
534 | *
535 | * @return array
536 | */
537 | public static function parseQualityValues(?string $string) : array
538 | {
539 | if (empty($string)) {
540 | return [];
541 | }
542 | $quality = \array_reduce(
543 | \explode(',', $string, 20),
544 | static function ($qualifier, $part) {
545 | [$value, $priority] = \array_merge(\explode(';q=', $part), [1]);
546 | $qualifier[\trim((string) $value)] = (float) $priority;
547 | return $qualifier;
548 | },
549 | []
550 | );
551 | \arsort($quality);
552 | return $quality;
553 | }
554 | }
555 |
--------------------------------------------------------------------------------
/src/UserAgent.php:
--------------------------------------------------------------------------------
1 |
6 | *
7 | * For the full copyright and license information, please view the LICENSE
8 | * file that was distributed with this source code.
9 | */
10 | namespace Framework\HTTP;
11 |
12 | use JetBrains\PhpStorm\Pure;
13 |
14 | /**
15 | * Class UserAgent.
16 | *
17 | * @package http
18 | */
19 | class UserAgent implements \JsonSerializable, \Stringable
20 | {
21 | protected ?string $agent = null;
22 | protected ?string $browser = null;
23 | protected ?string $browserVersion = null;
24 | protected ?string $mobile = null;
25 | protected ?string $platform = null;
26 | protected ?string $robot = null;
27 | protected bool $isBrowser = false;
28 | protected bool $isMobile = false;
29 | protected bool $isRobot = false;
30 | /**
31 | * @var array>
32 | */
33 | protected static array $config = [
34 | 'platforms' => [
35 | 'windows nt 10.0' => 'Windows 10',
36 | 'windows nt 6.3' => 'Windows 8.1',
37 | 'windows nt 6.2' => 'Windows 8',
38 | 'windows nt 6.1' => 'Windows 7',
39 | 'windows nt 6.0' => 'Windows Vista',
40 | 'windows nt 5.2' => 'Windows 2003',
41 | 'windows nt 5.1' => 'Windows XP',
42 | 'windows nt 5.0' => 'Windows 2000',
43 | 'windows nt 4.0' => 'Windows NT 4.0',
44 | 'winnt4.0' => 'Windows NT 4.0',
45 | 'winnt 4.0' => 'Windows NT',
46 | 'winnt' => 'Windows NT',
47 | 'windows 98' => 'Windows 98',
48 | 'win98' => 'Windows 98',
49 | 'windows 95' => 'Windows 95',
50 | 'win95' => 'Windows 95',
51 | 'windows phone' => 'Windows Phone',
52 | 'windows' => 'Unknown Windows OS',
53 | 'android' => 'Android',
54 | 'blackberry' => 'BlackBerry',
55 | 'iphone' => 'iOS',
56 | 'ipad' => 'iOS',
57 | 'ipod' => 'iOS',
58 | 'os x' => 'Mac OS X',
59 | 'ppc mac' => 'Power PC Mac',
60 | 'freebsd' => 'FreeBSD',
61 | 'ppc' => 'Macintosh',
62 | 'ubuntu' => 'Ubuntu',
63 | 'debian' => 'Debian',
64 | 'fedora' => 'Fedora',
65 | 'linux' => 'Linux',
66 | 'sunos' => 'Sun Solaris',
67 | 'beos' => 'BeOS',
68 | 'apachebench' => 'ApacheBench',
69 | 'aix' => 'AIX',
70 | 'irix' => 'Irix',
71 | 'osf' => 'DEC OSF',
72 | 'hp-ux' => 'HP-UX',
73 | 'netbsd' => 'NetBSD',
74 | 'bsdi' => 'BSDi',
75 | 'openbsd' => 'OpenBSD',
76 | 'gnu' => 'GNU/Linux',
77 | 'unix' => 'Unknown Unix OS',
78 | 'symbian' => 'Symbian OS',
79 | ],
80 | // The order of this array should NOT be changed. Many browsers return
81 | // multiple browser types so we want to identify the sub-type first.
82 | 'browsers' => [
83 | 'curl' => 'Curl',
84 | 'PostmanRuntime' => 'Postman',
85 | 'OPR' => 'Opera',
86 | 'Flock' => 'Flock',
87 | 'Edge' => 'Spartan',
88 | 'Edg' => 'Edge',
89 | 'EdgA' => 'Edge',
90 | 'Chrome' => 'Chrome',
91 | // Opera 10+ always reports Opera/9.80 and appends
92 | // Version/ to the user agent string
93 | 'Opera.*?Version' => 'Opera',
94 | 'Opera' => 'Opera',
95 | 'MSIE' => 'Internet Explorer',
96 | 'Internet Explorer' => 'Internet Explorer',
97 | 'Trident.* rv' => 'Internet Explorer',
98 | 'Shiira' => 'Shiira',
99 | 'Firefox' => 'Firefox',
100 | 'Chimera' => 'Chimera',
101 | 'Phoenix' => 'Phoenix',
102 | 'Firebird' => 'Firebird',
103 | 'Camino' => 'Camino',
104 | 'Netscape' => 'Netscape',
105 | 'OmniWeb' => 'OmniWeb',
106 | 'Safari' => 'Safari',
107 | 'Mozilla' => 'Mozilla',
108 | 'Konqueror' => 'Konqueror',
109 | 'icab' => 'iCab',
110 | 'Lynx' => 'Lynx',
111 | 'Links' => 'Links',
112 | 'hotjava' => 'HotJava',
113 | 'amaya' => 'Amaya',
114 | 'IBrowse' => 'IBrowse',
115 | 'Maxthon' => 'Maxthon',
116 | 'Ubuntu' => 'Ubuntu Web Browser',
117 | 'Vivaldi' => 'Vivaldi',
118 | ],
119 | 'mobiles' => [
120 | 'mobileexplorer' => 'Mobile Explorer',
121 | 'palmsource' => 'Palm',
122 | 'palmscape' => 'Palmscape',
123 | // Phones and Manufacturers
124 | 'motorola' => 'Motorola',
125 | 'nokia' => 'Nokia',
126 | 'palm' => 'Palm',
127 | 'iphone' => 'Apple iPhone',
128 | 'ipad' => 'iPad',
129 | 'ipod' => 'Apple iPod Touch',
130 | 'sony' => 'Sony Ericsson',
131 | 'ericsson' => 'Sony Ericsson',
132 | 'blackberry' => 'BlackBerry',
133 | 'cocoon' => 'O2 Cocoon',
134 | 'blazer' => 'Treo',
135 | 'lg' => 'LG',
136 | 'amoi' => 'Amoi',
137 | 'xda' => 'XDA',
138 | 'mda' => 'MDA',
139 | 'vario' => 'Vario',
140 | 'htc' => 'HTC',
141 | 'samsung' => 'Samsung',
142 | 'sharp' => 'Sharp',
143 | 'sie-' => 'Siemens',
144 | 'alcatel' => 'Alcatel',
145 | 'benq' => 'BenQ',
146 | 'ipaq' => 'HP iPaq',
147 | 'mot-' => 'Motorola',
148 | 'playstation portable' => 'PlayStation Portable',
149 | 'playstation 3' => 'PlayStation 3',
150 | 'playstation vita' => 'PlayStation Vita',
151 | 'hiptop' => 'Danger Hiptop',
152 | 'nec-' => 'NEC',
153 | 'panasonic' => 'Panasonic',
154 | 'philips' => 'Philips',
155 | 'sagem' => 'Sagem',
156 | 'sanyo' => 'Sanyo',
157 | 'spv' => 'SPV',
158 | 'zte' => 'ZTE',
159 | 'sendo' => 'Sendo',
160 | 'nintendo dsi' => 'Nintendo DSi',
161 | 'nintendo ds' => 'Nintendo DS',
162 | 'nintendo 3ds' => 'Nintendo 3DS',
163 | 'wii' => 'Nintendo Wii',
164 | 'open web' => 'Open Web',
165 | 'openweb' => 'OpenWeb',
166 | // Operating Systems
167 | 'android' => 'Android',
168 | 'symbian' => 'Symbian',
169 | 'SymbianOS' => 'SymbianOS',
170 | 'elaine' => 'Palm',
171 | 'series60' => 'Symbian S60',
172 | 'windows ce' => 'Windows CE',
173 | // Browsers
174 | 'obigo' => 'Obigo',
175 | 'netfront' => 'Netfront Browser',
176 | 'openwave' => 'Openwave Browser',
177 | 'mobilexplorer' => 'Mobile Explorer',
178 | 'operamini' => 'Opera Mini',
179 | 'opera mini' => 'Opera Mini',
180 | 'opera mobi' => 'Opera Mobile',
181 | 'fennec' => 'Firefox Mobile',
182 | // Other
183 | 'digital paths' => 'Digital Paths',
184 | 'avantgo' => 'AvantGo',
185 | 'xiino' => 'Xiino',
186 | 'novarra' => 'Novarra Transcoder',
187 | 'vodafone' => 'Vodafone',
188 | 'docomo' => 'NTT DoCoMo',
189 | 'o2' => 'O2',
190 | // Fallback
191 | 'mobile' => 'Generic Mobile',
192 | 'wireless' => 'Generic Mobile',
193 | 'j2me' => 'Generic Mobile',
194 | 'midp' => 'Generic Mobile',
195 | 'cldc' => 'Generic Mobile',
196 | 'up.link' => 'Generic Mobile',
197 | 'up.browser' => 'Generic Mobile',
198 | 'smartphone' => 'Generic Mobile',
199 | 'cellphone' => 'Generic Mobile',
200 | ],
201 | 'robots' => [
202 | 'googlebot' => 'Googlebot',
203 | 'msnbot' => 'MSNBot',
204 | 'baiduspider' => 'Baiduspider',
205 | 'bingbot' => 'Bing',
206 | 'slurp' => 'Inktomi Slurp',
207 | 'yahoo' => 'Yahoo',
208 | 'ask jeeves' => 'Ask Jeeves',
209 | 'fastcrawler' => 'FastCrawler',
210 | 'infoseek' => 'InfoSeek Robot 1.0',
211 | 'lycos' => 'Lycos',
212 | 'yandex' => 'YandexBot',
213 | 'mediapartners-google' => 'MediaPartners Google',
214 | 'CRAZYWEBCRAWLER' => 'Crazy Webcrawler',
215 | 'adsbot-google' => 'AdsBot Google',
216 | 'feedfetcher-google' => 'Feedfetcher Google',
217 | 'curious george' => 'Curious George',
218 | 'ia_archiver' => 'Alexa Crawler',
219 | 'MJ12bot' => 'Majestic-12',
220 | 'Uptimebot' => 'Uptimebot',
221 | ],
222 | ];
223 |
224 | /**
225 | * UserAgent constructor.
226 | *
227 | * @param string $userAgent User-Agent string
228 | */
229 | public function __construct(string $userAgent)
230 | {
231 | $this->parse($userAgent);
232 | }
233 |
234 | #[Pure]
235 | public function __toString() : string
236 | {
237 | return $this->toString();
238 | }
239 |
240 | /**
241 | * @param string $string
242 | *
243 | * @return static
244 | */
245 | protected function parse(string $string) : static
246 | {
247 | $this->isBrowser = false;
248 | $this->isRobot = false;
249 | $this->isMobile = false;
250 | $this->browser = null;
251 | $this->browserVersion = null;
252 | $this->mobile = null;
253 | $this->robot = null;
254 | $this->agent = $string;
255 | $this->compileData();
256 | return $this;
257 | }
258 |
259 | protected function compileData() : void
260 | {
261 | $this->setPlatform();
262 | foreach (['setRobot', 'setBrowser', 'setMobile'] as $function) {
263 | if ($this->{$function}()) {
264 | break;
265 | }
266 | }
267 | }
268 |
269 | protected function setPlatform() : bool
270 | {
271 | foreach (static::$config['platforms'] as $key => $val) {
272 | if (\preg_match('#' . \preg_quote($key, '#') . '#i', $this->agent)) {
273 | $this->platform = $val;
274 | return true;
275 | }
276 | }
277 | return false;
278 | }
279 |
280 | protected function setBrowser() : bool
281 | {
282 | foreach (static::$config['browsers'] as $key => $val) {
283 | if (\preg_match(
284 | '#' . \preg_quote($key, '#') . '.*?([0-9\.]+)#i',
285 | $this->agent,
286 | $match
287 | )) {
288 | $this->isBrowser = true;
289 | $this->browserVersion = $match[1];
290 | $this->browser = $val;
291 | $this->setMobile();
292 | return true;
293 | }
294 | }
295 | return false;
296 | }
297 |
298 | protected function setMobile() : bool
299 | {
300 | foreach (static::$config['mobiles'] as $key => $val) {
301 | if (\stripos($this->agent, $key) !== false) {
302 | $this->isMobile = true;
303 | $this->mobile = $val;
304 | return true;
305 | }
306 | }
307 | return false;
308 | }
309 |
310 | protected function setRobot() : bool
311 | {
312 | foreach (static::$config['robots'] as $key => $val) {
313 | if (\preg_match('#' . \preg_quote($key, '#') . '#i', $this->agent)) {
314 | $this->isRobot = true;
315 | $this->robot = $val;
316 | $this->setMobile();
317 | return true;
318 | }
319 | }
320 | return false;
321 | }
322 |
323 | /**
324 | * Get the User-Agent as string.
325 | *
326 | * @since 5.3
327 | *
328 | * @return string
329 | */
330 | #[Pure]
331 | public function toString() : string
332 | {
333 | return $this->agent;
334 | }
335 |
336 | /**
337 | * Gets the Browser name.
338 | *
339 | * @return string|null
340 | */
341 | #[Pure]
342 | public function getBrowser() : ?string
343 | {
344 | return $this->browser;
345 | }
346 |
347 | /**
348 | * Gets the Browser Version.
349 | *
350 | * @return string|null
351 | */
352 | #[Pure]
353 | public function getBrowserVersion() : ?string
354 | {
355 | return $this->browserVersion;
356 | }
357 |
358 | /**
359 | * Gets the Mobile device.
360 | *
361 | * @return string|null
362 | */
363 | #[Pure]
364 | public function getMobile() : ?string
365 | {
366 | return $this->mobile;
367 | }
368 |
369 | /**
370 | * Gets the OS Platform.
371 | *
372 | * @return string|null
373 | */
374 | #[Pure]
375 | public function getPlatform() : ?string
376 | {
377 | return $this->platform;
378 | }
379 |
380 | /**
381 | * Gets the Robot name.
382 | *
383 | * @return string|null
384 | */
385 | #[Pure]
386 | public function getRobot() : ?string
387 | {
388 | return $this->robot;
389 | }
390 |
391 | /**
392 | * Is Browser.
393 | *
394 | * @param string|null $key
395 | *
396 | * @return bool
397 | */
398 | #[Pure]
399 | public function isBrowser(?string $key = null) : bool
400 | {
401 | if ($key === null || $this->isBrowser === false) {
402 | return $this->isBrowser;
403 | }
404 | $config = static::$config['browsers'] ?? [];
405 | return isset($config[$key])
406 | && $this->browser === $config[$key];
407 | }
408 |
409 | /**
410 | * Is Mobile.
411 | *
412 | * @param string|null $key
413 | *
414 | * @return bool
415 | */
416 | #[Pure]
417 | public function isMobile(?string $key = null) : bool
418 | {
419 | if ($key === null || $this->isMobile === false) {
420 | return $this->isMobile;
421 | }
422 | $config = static::$config['mobiles'] ?? [];
423 | return isset($config[$key])
424 | && $this->mobile === $config[$key];
425 | }
426 |
427 | /**
428 | * Is Robot.
429 | *
430 | * @param string|null $key
431 | *
432 | * @return bool
433 | */
434 | #[Pure]
435 | public function isRobot(?string $key = null) : bool
436 | {
437 | if ($key === null || $this->isRobot === false) {
438 | return $this->isRobot;
439 | }
440 | $config = static::$config['robots'] ?? [];
441 | return isset($config[$key])
442 | && $this->robot === $config[$key];
443 | }
444 |
445 | #[Pure]
446 | public function getType() : string
447 | {
448 | if ($this->isBrowser()) {
449 | return 'Browser';
450 | }
451 | if ($this->isRobot()) {
452 | return 'Robot';
453 | }
454 | return 'Unknown';
455 | }
456 |
457 | #[Pure]
458 | public function getName() : string
459 | {
460 | if ($this->isBrowser()) {
461 | return $this->getBrowser();
462 | }
463 | if ($this->isRobot()) {
464 | return $this->getRobot();
465 | }
466 | return 'Unknown';
467 | }
468 |
469 | #[Pure]
470 | public function jsonSerialize() : string
471 | {
472 | return $this->toString();
473 | }
474 | }
475 |
--------------------------------------------------------------------------------
/src/CSP.php:
--------------------------------------------------------------------------------
1 |
6 | *
7 | * For the full copyright and license information, please view the LICENSE
8 | * file that was distributed with this source code.
9 | */
10 | namespace Framework\HTTP;
11 |
12 | use InvalidArgumentException;
13 | use LogicException;
14 |
15 | /**
16 | * Class CSP.
17 | *
18 | * @see https://content-security-policy.com/
19 | * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
20 | * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
21 | *
22 | * @package http
23 | */
24 | class CSP implements \Stringable
25 | {
26 | /**
27 | * Restricts the URLs which can be used in a document's `` element.
28 | *
29 | * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/base-uri
30 | */
31 | public const string baseUri = 'base-uri';
32 | /**
33 | * Defines the valid sources for web workers and nested browsing contexts
34 | * loaded using elements such as `` and `