[^:]+)(?::(?.*))?$`'; protected const HOST_LABEL_REGEX = '`^(?:(?:%[a-f0-9]{2})+|[a-z0-9-]+)*$`i'; protected const AUTHORITY_REGEX = '`^(?:(?[^@]+)\@)?(?(\[[a-f0-9:]+\]|[^:]+))(?::(?\d+))?$`i'; protected const PATH_REGEX = '`^(?:(?:%[a-f0-9]{2})+|[a-z0-9-._~!$&\'()*+,;=:@/]+)*$`i'; protected const QUERY_OR_FRAGMENT_REGEX = '`^(?:(?:%[a-f0-9]{2})+|[a-z0-9-._~!$&\'"()\[\]*+,;=:@?/%]+)*$`i'; protected array $components; protected ?string $str = null; /** * @param array $components An array of normalized components */ public function __construct(array $components) { $this->components = $components + [ 'scheme' => null, 'user' => null, 'pass' => null, 'host' => null, 'port' => null, 'path' => null, 'query' => null, 'fragment' => null, ]; } /** * @return string|null */ public function scheme(): ?string { return $this->components['scheme']; } /** * @return string|null */ public function user(): ?string { return $this->components['user']; } /** * @return string|null */ public function pass(): ?string { return $this->components['pass']; } /** * @return string|null */ public function userInfo(): ?string { if ($this->components['user'] === null) { return null; } if ($this->components['pass'] === null) { return $this->components['user']; } return $this->components['user'] . ':' . $this->components['pass']; } /** * @return string|null */ public function host(): ?string { return $this->components['host']; } /** * @return int|null */ public function port(): ?int { return $this->components['port']; } /** * @return string|null */ public function authority(): ?string { if ($this->components['host'] === null) { return null; } $authority = $this->userInfo(); if ($authority !== null) { $authority .= '@'; } $authority .= $this->components['host']; if ($this->components['port'] !== null) { $authority .= ':' . $this->components['port']; } return $authority; } /** * @return string|null */ public function path(): ?string { return $this->components['path']; } /** * @return string|null */ public function query(): ?string { return $this->components['query']; } /** * @return string|null */ public function fragment(): ?string { return $this->components['fragment']; } /** * @return array|null[] */ public function components(): array { return $this->components; } /** * @return bool */ public function isAbsolute(): bool { return $this->components['scheme'] !== null; } /** * Use this URI as base to resolve the reference * @param static|string|array $ref * @param bool $normalize * @return $this|null */ public function resolveRef($ref, bool $normalize = false): ?self { $ref = self::resolveComponents($ref); if ($ref === null) { return $this; } return new static(self::mergeComponents($ref, $this->components, $normalize)); } /** * Resolve this URI reference using a base URI * @param static|string|array $base * @param bool $normalize * @return static */ public function resolve($base, bool $normalize = false): self { if ($this->isAbsolute()) { return $this; } $base = self::resolveComponents($base); if ($base === null) { return $this; } return new static(self::mergeComponents($this->components, $base, $normalize)); } /** * @return string */ public function __toString(): string { if ($this->str !== null) { return $this->str; } $str = ''; if ($this->components['scheme'] !== null) { $str .= $this->components['scheme'] . ':'; } if ($this->components['host'] !== null) { $str .= '//' . $this->authority(); } $str .= $this->components['path']; if ($this->components['query'] !== null) { $str .= '?' . $this->components['query']; } if ($this->components['fragment'] !== null) { $str .= '#' . $this->components['fragment']; } return $this->str = $str; } /** * @param string $uri * @param bool $normalize * @return static|null */ public static function create(string $uri, bool $normalize = false): ?self { $comp = self::parseComponents($uri); if (!$comp) { return null; } if ($normalize) { $comp = self::normalizeComponents($comp); } return new static($comp); } /** * Checks if the scheme contains valid chars * @param string $scheme * @return bool */ public static function isValidScheme(string $scheme): bool { return (bool)preg_match(self::SCHEME_REGEX, $scheme); } /** * Checks if user contains valid chars * @param string $user * @return bool */ public static function isValidUser(string $user): bool { return (bool)preg_match(self::USER_OR_PASS_REGEX, $user); } /** * Checks if pass contains valid chars * @param string $pass * @return bool */ public static function isValidPass(string $pass): bool { return (bool)preg_match(self::USER_OR_PASS_REGEX, $pass); } /** * @param string $userInfo * @return bool */ public static function isValidUserInfo(string $userInfo): bool { /** @var array|string $userInfo */ if (!preg_match(self::USERINFO_REGEX, $userInfo, $userInfo)) { return false; } if (!self::isValidUser($userInfo['user'])) { return false; } if (isset($userInfo['pass'])) { return self::isValidPass($userInfo['pass']); } return true; } /** * Checks if host is valid * @param string $host * @return bool */ public static function isValidHost(string $host): bool { // min and max length if ($host === '' || isset($host[253])) { return false; } // check ipv6 if ($host[0] === '[') { if ($host[-1] !== ']') { return false; } return filter_var( substr($host, 1, -1), \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6 ) !== false; } // check ipv4 if (preg_match('`^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\$`', $host)) { return \filter_var($host, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4) !== false; } foreach (explode('.', $host) as $host) { // empty or too long label if ($host === '' || isset($host[63])) { return false; } if ($host[0] === '-' || $host[-1] === '-') { return false; } if (!preg_match(self::HOST_LABEL_REGEX, $host)) { return false; } } return true; } /** * Checks if the port is valid * @param int $port * @return bool */ public static function isValidPort(int $port): bool { return $port >= 0 && $port <= 65535; } /** * Checks if authority contains valid chars * @param string $authority * @return bool */ public static function isValidAuthority(string $authority): bool { if ($authority === '') { return true; } /** @var array|string $authority */ if (!preg_match(self::AUTHORITY_REGEX, $authority, $authority)) { return false; } if (isset($authority['port']) && !self::isValidPort((int)$authority['port'])) { return false; } if (isset($authority['userinfo']) && !self::isValidUserInfo($authority['userinfo'])) { return false; } return self::isValidHost($authority['host']); } /** * Checks if the path contains valid chars * @param string $path * @return bool */ public static function isValidPath(string $path): bool { return $path === '' || (bool)preg_match(self::PATH_REGEX, $path); } /** * Checks if the query string contains valid chars * @param string $query * @return bool */ public static function isValidQuery(string $query): bool { return $query === '' || (bool)preg_match(self::QUERY_OR_FRAGMENT_REGEX, $query); } /** * Checks if the fragment contains valid chars * @param string $fragment * @return bool */ public static function isValidFragment(string $fragment): bool { return $fragment === '' || (bool)preg_match(self::QUERY_OR_FRAGMENT_REGEX, $fragment); } /** * @param string $uri * @param bool $expand_authority * @param bool $validate * @return array|null */ public static function parseComponents(string $uri, bool $expand_authority = true, bool $validate = true): ?array { if (!preg_match(self::URI_REGEX, $uri, $uri)) { return null; } $comp = []; // scheme if (isset($uri[2]) && $uri[2] !== '') { if ($validate && !self::isValidScheme($uri[2])) { return null; } $comp['scheme'] = $uri[2]; } // authority if (isset($uri[4]) && isset($uri[3][0])) { if ($uri[4] === '') { if ($expand_authority) { $comp['host'] = ''; } else { $comp['authority'] = ''; } } elseif ($expand_authority) { $au = self::parseAuthorityComponents($uri[4], $validate); if ($au === null) { return null; } $comp += $au; unset($au); } else { if ($validate && !self::isValidAuthority($uri[4])) { return null; } $comp['authority'] = $uri[4]; } } // path if (isset($uri[5])) { if ($validate && !self::isValidPath($uri[5])) { return null; } $comp['path'] = $uri[5]; // not a relative uri, remove dot segments if (isset($comp['scheme']) || isset($comp['authority']) || isset($comp['host'])) { $comp['path'] = self::removeDotSegmentsFromPath($comp['path']); } } // query if (isset($uri[7]) && isset($uri[6][0])) { if ($validate && !self::isValidQuery($uri[7])) { return null; } $comp['query'] = $uri[7]; } // fragment if (isset($uri[9]) && isset($uri[8][0])) { if ($validate && !self::isValidFragment($uri[9])) { return null; } $comp['fragment'] = $uri[9]; } return $comp; } /** * @param self|string|array $uri * @return array|null */ public static function resolveComponents($uri): ?array { if ($uri instanceof self) { return $uri->components; } if (is_string($uri)) { return self::parseComponents($uri); } if (is_array($uri)) { if (isset($uri['host'])) { unset($uri['authority']); } elseif (isset($uri['authority'])) { $au = self::parseAuthorityComponents($uri['authority']); unset($uri['authority']); if ($au !== null) { unset($uri['user'], $uri['pass'], $uri['host'], $uri['port']); $uri += $au; } } return $uri; } return null; } /** * @param string $authority * @param bool $validate * @return array|null */ public static function parseAuthorityComponents(string $authority, bool $validate = true): ?array { /** @var array|string $authority */ if (!preg_match(self::AUTHORITY_REGEX, $authority, $authority)) { return null; } $comp = []; // userinfo if (isset($authority['userinfo']) && $authority['userinfo'] !== '') { if (!preg_match(self::USERINFO_REGEX, $authority['userinfo'], $ui)) { return null; } // user if ($validate && !self::isValidUser($ui['user'])) { return null; } $comp['user'] = $ui['user']; // pass if (isset($ui['pass']) && $ui['pass'] !== '') { if ($validate && !self::isValidPass($ui['pass'])) { return null; } $comp['pass'] = $ui['pass']; } unset($ui); } // host if ($validate && !self::isValidHost($authority['host'])) { return null; } $comp['host'] = $authority['host']; // port if (isset($authority['port'])) { $authority['port'] = (int)$authority['port']; if (!self::isValidPort($authority['port'])) { return null; } $comp['port'] = $authority['port']; } return $comp; } /** * @param array $ref * @param array $base * @param bool $normalize * @return array */ public static function mergeComponents(array $ref, array $base, bool $normalize = false): array { if (isset($ref['scheme'])) { $dest = $ref; } else { $dest = []; $dest['scheme'] = $base['scheme'] ?? null; if (isset($ref['authority']) || isset($ref['host'])) { $dest += $ref; } else { if (isset($base['authority'])) { $dest['authority'] = $base['authority']; } else { $dest['user'] = $base['user'] ?? null; $dest['pass'] = $base['pass'] ?? null; $dest['host'] = $base['host'] ?? null; $dest['port'] = $base['port'] ?? null; } if (!isset($ref['path'])) { $ref['path'] = ''; } if (!isset($base['path'])) { $base['path'] = ''; } if ($ref['path'] === '') { $dest['path'] = $base['path']; $dest['query'] = $ref['query'] ?? $base['query'] ?? null; } else { if ($ref['path'][0] === '/') { $dest['path'] = $ref['path']; } else { if ((isset($base['authority']) || isset($base['host'])) && $base['path'] === '') { $dest['path'] = '/' . $ref['path']; } else { $dest['path'] = $base['path']; if ($dest['path'] !== '') { $pos = strrpos($dest['path'], '/'); if ($pos === false) { $dest['path'] = ''; } else { $dest['path'] = substr($dest['path'], 0, $pos); } unset($pos); } $dest['path'] .= '/' . $ref['path']; } } $dest['query'] = $ref['query'] ?? null; } } } $dest['fragment'] = $ref['fragment'] ?? null; if ($normalize) { return self::normalizeComponents($dest); } if (isset($dest['path'])) { $dest['path'] = self::removeDotSegmentsFromPath($dest['path']); } return $dest; } public static function normalizeComponents(array $components): array { if (isset($components['scheme'])) { $components['scheme'] = strtolower($components['scheme']); // Remove default port if (isset($components['port']) && self::getSchemePort($components['scheme']) === $components['port']) { $components['port'] = null; } } if (isset($components['host'])) { $components['host'] = strtolower($components['host']); } if (isset($components['path'])) { $components['path'] = self::removeDotSegmentsFromPath($components['path']); } if (isset($components['query'])) { $components['query'] = self::normalizeQueryString($components['query']); } return $components; } /** * Removes dot segments from path * @param string $path * @return string */ public static function removeDotSegmentsFromPath(string $path): string { // Fast check common simple paths if ($path === '' || $path === '/') { return $path; } $output = ''; $last_slash = 0; $len = strlen($path); $i = 0; while ($i < $len) { if ($path[$i] === '.') { $j = $i + 1; // search for . if ($j >= $len) { break; } // search for ./ if ($path[$j] === '/') { $i = $j + 1; continue; } // search for ../ if ($path[$j] === '.') { $k = $j + 1; if ($k >= $len) { break; } if ($path[$k] === '/') { $i = $k + 1; continue; } } } elseif ($path[$i] === '/') { $j = $i + 1; if ($j >= $len) { $output .= '/'; break; } // search for /. if ($path[$j] === '.') { $k = $j + 1; if ($k >= $len) { $output .= '/'; break; } // search for /./ if ($path[$k] === '/') { $i = $k; continue; } // search for /.. if ($path[$k] === '.') { $n = $k + 1; if ($n >= $len) { // keep the slash $output = substr($output, 0, $last_slash + 1); break; } // search for /../ if ($path[$n] === '/') { $output = substr($output, 0, $last_slash); $last_slash = (int)strrpos($output, '/'); $i = $n; continue; } } } } $pos = strpos($path, '/', $i + 1); if ($pos === false) { $output .= substr($path, $i); break; } $last_slash = strlen($output); $output .= substr($path, $i, $pos - $i); $i = $pos; } return $output; } /** * @param string|null $query * @return array */ public static function parseQueryString(?string $query): array { if ($query === null) { return []; } $list = []; foreach (explode('&', $query) as $name) { $value = null; if (($pos = strpos($name, '=')) !== false) { $value = self::decodeComponent(substr($name, $pos + 1)); $name = self::decodeComponent(substr($name, 0, $pos)); } else { $name = self::decodeComponent($name); } $list[$name] = $value; } return $list; } /** * @param array $qs * @param string|null $prefix * @param string $separator * @param bool $sort * @return string */ public static function buildQueryString(array $qs, ?string $prefix = null, string $separator = '&', bool $sort = false): string { $isIndexed = static function (array $array): bool { for ($i = 0, $max = count($array); $i < $max; $i++) { if (!array_key_exists($i, $array)) { return false; } } return true; }; $f = static function (array $arr, ?string $prefix = null) use (&$f, &$isIndexed): iterable { $indexed = $prefix !== null && $isIndexed($arr); foreach ($arr as $key => $value) { if ($prefix !== null) { $key = $prefix . ($indexed ? "[]" : "[{$key}]"); } if (is_array($value)) { yield from $f($value, $key); } else { yield $key => $value; } } }; $data = []; foreach ($f($qs, $prefix) as $key => $value) { $item = is_string($key) ? self::encodeComponent($key) : $key; if ($value !== null) { $item .= '='; $item .= is_string($value) ? self::encodeComponent($value) : $value; } if ($item === '' || $item === '=') { continue; } $data[] = $item; } if (!$data) { return ''; } if ($sort) { sort($data); } return implode($separator, $data); } /** * @param string $query * @return string */ public static function normalizeQueryString(string $query): string { return static::buildQueryString(self::parseQueryString($query), null, '&', true); } public static function decodeComponent(string $component): string { return rawurldecode($component); } public static function encodeComponent(string $component, ?array $skip = null): string { if (!$skip) { return rawurlencode($component); } $str = ''; foreach (UnicodeString::walkString($component) as [$cp, $chars]) { if ($cp < 0x80) { if ($cp === 0x2D || $cp === 0x2E || $cp === 0x5F || $cp === 0x7E || ($cp >= 0x41 && $cp <= 0x5A) || ($cp >= 0x61 && $cp <= 0x7A) || ($cp >= 0x30 && $cp <= 0x39) || in_array($cp, $skip, true) ) { $str .= chr($cp); } else { $str .= '%' . strtoupper(dechex($cp)); } } else { $i = 0; while (isset($chars[$i])) { $str .= '%' . strtoupper(dechex($chars[$i++])); } } } return $str; } public static function setSchemePort(string $scheme, ?int $port): void { $scheme = strtolower($scheme); if ($port === null) { unset(self::$KNOWN_PORTS[$scheme]); } else { self::$KNOWN_PORTS[$scheme] = $port; } } public static function getSchemePort(string $scheme): ?int { return self::$KNOWN_PORTS[strtolower($scheme)] ?? null; } protected static array $KNOWN_PORTS = [ 'ftp' => 21, 'ssh' => 22, 'telnet' => 23, 'smtp' => 25, 'tftp' => 69, 'http' => 80, 'pop' => 110, 'sftp' => 115, 'imap' => 143, 'irc' => 194, 'ldap' => 389, 'https' => 443, 'ldaps' => 636, 'telnets' => 992, 'imaps' => 993, 'ircs' => 994, 'pops' => 995, ]; }