Uri.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Http;
 
use Psr\Http\Message\UriInterface;
 
class ‪Uri implements UriInterface
{
    public const ‪SUBDELIMITER_CHARLIST = '!\$&\'\‍(\‍)\*\+,;=';
 
    public const ‪UNRESERVED_CHARLIST = 'a-zA-Z0-9_\-\.~';
 
    protected string ‪$scheme = '';
 
    protected array ‪$supportedSchemes = [
        'http'  => 80,
        'https' => 443,
        'ws' => 80,
        'wss' => 443,
    ];
 
    protected string ‪$authority = '';
 
    protected string ‪$userInfo = '';
 
    protected string ‪$host = '';
 
    protected ?int ‪$port = null;
 
    protected string ‪$path = '';
 
    protected string ‪$query = '';
 
    protected string ‪$fragment = '';
 
    public function ‪__construct(string $uri = '')
    {
        if (!empty($uri)) {
            $this->‪parseUri($uri);
        }
    }
 
    protected function ‪parseUri(string $uri): void
    {
        $uriParts = parse_url($uri);
 
        if ($uriParts === false) {
            throw new \InvalidArgumentException('The parsedUri "' . $uri . '" appears to be malformed', 1436717322);
        }
 
        if (isset($uriParts['scheme'])) {
            $this->scheme = $this->‪sanitizeScheme($uriParts['scheme']);
        }
        if (isset($uriParts['user'])) {
            $this->userInfo = $uriParts['user'];
            if (isset($uriParts['pass'])) {
                $this->userInfo .= ':' . $uriParts['pass'];
            }
        }
        if (isset($uriParts['host'])) {
            $this->host = $uriParts['host'];
        }
        if (isset($uriParts['port'])) {
            $this->port = (int)$uriParts['port'];
        }
        if (isset($uriParts['path'])) {
            $this->path = $this->‪sanitizePath($uriParts['path']);
        }
        if (isset($uriParts['query'])) {
            $this->query = $this->‪sanitizeQuery($uriParts['query']);
        }
        if (isset($uriParts['fragment'])) {
            $this->fragment = $this->‪sanitizeFragment($uriParts['fragment']);
        }
    }
 
    public function ‪getScheme(): string
    {
        return ‪$this->scheme;
    }
 
    public function ‪getAuthority(): string
    {
        if (empty($this->host)) {
            return '';
        }
 
        ‪$authority = ‪$this->host;
        if (!empty($this->userInfo)) {
            ‪$authority = $this->userInfo . '@' . ‪$authority;
        }
 
        if ($this->‪isNonStandardPort($this->scheme, $this->host, $this->port)) {
            ‪$authority .= ':' . ‪$this->port;
        }
 
        return ‪$authority;
    }
 
    public function ‪getUserInfo(): string
    {
        return ‪$this->userInfo;
    }
 
    public function ‪getHost(): string
    {
        return ‪$this->host;
    }
 
    public function ‪getPort(): ?int
    {
        return $this->‪isNonStandardPort($this->scheme, $this->host, $this->port) ? $this->port : null;
    }
 
    public function ‪getPath(): string
    {
        return ‪$this->path;
    }
 
    public function ‪getQuery(): string
    {
        return ‪$this->query;
    }
 
    public function ‪getFragment(): string
    {
        return ‪$this->fragment;
    }
 
    public function ‪withScheme(string ‪$scheme): UriInterface
    {
        ‪$scheme = $this->‪sanitizeScheme($scheme);
        $clonedObject = clone $this;
        $clonedObject->scheme = ‪$scheme;
        return $clonedObject;
    }
 
    public function ‪withUserInfo(string $user, ?string $password = null): UriInterface
    {
        ‪$userInfo = $user;
        if (!empty($password)) {
            ‪$userInfo .= ':' . $password;
        }
 
        $clonedObject = clone $this;
        $clonedObject->userInfo = ‪$userInfo;
        return $clonedObject;
    }
 
    public function ‪withHost(string ‪$host): UriInterface
    {
        $clonedObject = clone $this;
        $clonedObject->host = ‪$host;
        return $clonedObject;
    }
 
    public function ‪withPort(?int ‪$port): UriInterface
    {
        if (‪$port !== null) {
            if ($port < 1 || $port > 65535) {
                throw new \InvalidArgumentException('Invalid port "' . ‪$port . '" specified, must be a valid TCP/UDP port.', 1436717326);
            }
        }
 
        $clonedObject = clone $this;
        $clonedObject->port = ‪$port;
        return $clonedObject;
    }
 
    public function ‪withPath(string ‪$path): UriInterface
    {
        if (str_contains(‪$path, '?')) {
            throw new \InvalidArgumentException('Invalid path provided. Must not contain a query string.', 1436717330);
        }
 
        if (str_contains(‪$path, '#')) {
            throw new \InvalidArgumentException('Invalid path provided; must not contain a URI fragment', 1436717332);
        }
 
        ‪$path = $this->‪sanitizePath($path);
        $clonedObject = clone $this;
        $clonedObject->path = ‪$path;
        return $clonedObject;
    }
 
    public function ‪withQuery(string ‪$query): UriInterface
    {
        if (str_contains(‪$query, '#')) {
            throw new \InvalidArgumentException('Query string must not include a URI fragment.', 1436717336);
        }
 
        ‪$query = $this->‪sanitizeQuery($query);
        $clonedObject = clone $this;
        $clonedObject->query = ‪$query;
        return $clonedObject;
    }
 
    public function ‪withFragment(string ‪$fragment): UriInterface
    {
        ‪$fragment = $this->‪sanitizeFragment($fragment);
        $clonedObject = clone $this;
        $clonedObject->fragment = ‪$fragment;
        return $clonedObject;
    }
 
    public function ‪__toString(): string
    {
        $uri = '';
 
        if (!empty($this->scheme)) {
            $uri .= $this->scheme . ':';
        }
 
        ‪$authority = $this->‪getAuthority();
        if (!empty(‪$authority)) {
            $uri .= '//' . ‪$authority;
        }
 
        ‪$path = $this->‪getPath();
        if ($path !== '' && !str_starts_with(‪$path, '/')) {
            ‪$path = '/' . ‪$path;
        }
        $uri .= ‪$path;
 
        if ($this->query) {
            $uri .= '?' . ‪$this->query;
        }
        if ($this->fragment) {
            $uri .= '#' . ‪$this->fragment;
        }
        return $uri;
    }
 
    protected function ‪isNonStandardPort(string ‪$scheme, string ‪$host, ?int ‪$port): bool
    {
        if (empty(‪$scheme)) {
            return empty(‪$host) || !empty(‪$port);
        }
        if (empty(‪$host) || empty(‪$port)) {
            return false;
        }
        return !isset($this->supportedSchemes[‪$scheme]) || ‪$port !== $this->supportedSchemes[‪$scheme];
    }
 
    protected function ‪sanitizeScheme(string ‪$scheme): string
    {
        ‪$scheme = strtolower(‪$scheme);
        ‪$scheme = preg_replace('#:(//)?$#', '', ‪$scheme);
 
        if (empty(‪$scheme)) {
            return '';
        }
 
        if (!array_key_exists(‪$scheme, $this->supportedSchemes)) {
            throw new \InvalidArgumentException('Unsupported scheme "' . ‪$scheme . '"; must be any empty string or in the set (' . implode(', ', array_keys($this->supportedSchemes)) . ')', 1436717338);
        }
 
        return ‪$scheme;
    }
 
    protected function ‪sanitizePath(string ‪$path): string
    {
        return preg_replace_callback(
            '/(?:[^' . self::UNRESERVED_CHARLIST . ':@&=\+\$,\/;%]+|%(?![A-Fa-f0-9]{2}))/',
            static function ($matches) {
                return rawurlencode($matches[0]);
            },
            ‪$path
        );
    }
 
    protected function ‪sanitizeQuery(string ‪$query): string
    {
        if (!empty(‪$query) && str_starts_with(‪$query, '?')) {
            ‪$query = substr(‪$query, 1);
        }
 
        $parts = explode('&', ‪$query);
        foreach ($parts as $index => $part) {
            [$key, $value] = $this->‪splitQueryValue($part);
            if ($value === null) {
                $parts[$index] = $this->‪sanitizeQueryOrFragment($key);
                continue;
            }
            $parts[$index] = $this->‪sanitizeQueryOrFragment($key) . '=' . $this->‪sanitizeQueryOrFragment($value);
        }
 
        return implode('&', $parts);
    }
 
    protected function ‪splitQueryValue(string $value): array
    {
        $data = explode('=', $value, 2);
        if (count($data) === 1) {
            $data[] = null;
        }
        return $data;
    }
 
    protected function ‪sanitizeFragment(string ‪$fragment): string
    {
        if (!empty(‪$fragment) && str_starts_with(‪$fragment, '#')) {
            ‪$fragment = substr(‪$fragment, 1);
        }
        return $this->‪sanitizeQueryOrFragment($fragment);
    }
 
    protected function ‪sanitizeQueryOrFragment(string $value): string
    {
        return preg_replace_callback(
            '/(?:[^' . self::UNRESERVED_CHARLIST . self::SUBDELIMITER_CHARLIST . '%:@\/\?]+|%(?![A-Fa-f0-9]{2}))/',
            static function ($matches) {
                return rawurlencode($matches[0]);
            },
            $value
        );
    }
}