uri.php

См. документацию.

<?php

 
namespace Bitrix\Main\Web;
 
use Bitrix\Main;
use Bitrix\Main\Text\Encoding;
use Psr\Http\Message\UriInterface;
 
class Uri implements \JsonSerializable, UriInterface
{
    protected $scheme = '';
    protected $host = '';
    protected $port = null;
    protected $user = '';
    protected $pass = '';
    protected $path = '';
    protected $query = '';
    protected $fragment = '';

    public function __construct($url)
    {
        if (str_starts_with($url, '/'))
        {
            //we don't support "current scheme" e.g. "//host/path"
            $url = '/' . ltrim($url, '/');
        }
 
        $parsedUrl = parse_url($url);
 
        if ($parsedUrl !== false)
        {
            $this->scheme = strtolower($parsedUrl['scheme'] ?? '');
            $this->setHost($parsedUrl['host'] ?? '');
            $this->port = $parsedUrl['port'] ?? null;
            $this->setUser($parsedUrl['user'] ?? '');
            $this->setPass($parsedUrl['pass'] ?? '');
            $this->path = $parsedUrl['path'] ?? '';
            $this->query = $parsedUrl['query'] ?? '';
            $this->fragment = $parsedUrl['fragment'] ?? '';
        }
    }

    public function getUrl()
    {
        return $this->getLocator();
    }

    public function getLocator()
    {
        $uri = '';
 
        $scheme = $this->getScheme();
        if ($scheme != '')
        {
            $uri .= $scheme . ':';
        }
 
        $authority = $this->getAuthority();
        $path = $this->getPath();
        if ($authority != '')
        {
            $uri .= '//' . $authority;
 
            if (!str_starts_with($path, '/'))
            {
                $uri .= '/';
            }
            $uri .= $path;
        }
        else
        {
            $uri .= $path;
        }
 
        $query = $this->getQuery();
        if ($query != '')
        {
            $uri .= '?' . $query;
        }
 
        return $uri;
    }

    public function getUri()
    {
        $url = $this->getLocator();
        $fragment = $this->getFragment();
 
        if ($fragment != '')
        {
            $url .= '#' . $fragment;
        }
 
        return $url;
    }

    public function getFragment(): string
    {
        return $this->fragment;
    }

    public function getHost(): string
    {
        return $this->host;
    }

    public function setHost($host)
    {
        $this->host = strtolower($host);
        return $this;
    }

    public function getPass()
    {
        return rawurlencode($this->pass);
    }

    public function setPass($pass)
    {
        $this->pass = rawurldecode($pass);
        return $this;
    }

    public function getPath(): string
    {
        // TODO: make it work as described
        return $this->path;
    }

    public function setPath($path)
    {
        $this->path = $path;
        return $this;
    }

    public function getPathQuery()
    {
        $pathQuery = $this->getPath();
 
        if ($pathQuery == '')
        {
            $pathQuery = '/';
        }
 
        $query = $this->getQuery();
 
        if ($query != '')
        {
            $pathQuery .= '?' . $query;
        }
 
        return $pathQuery;
    }

    public function getPort(): ?int
    {
        if ($this->port === null)
        {
            switch ($this->getScheme())
            {
                case 'https':
                    return 443;
                case 'http':
                    return 80;
                default:
                    return null;
            }
        }
        return (int)$this->port;
    }

    public function getQuery(): string
    {
        return $this->query;
    }

    public function getScheme(): string
    {
        return $this->scheme;
    }

    public function getUser()
    {
        return rawurlencode($this->user);
    }

    public function setUser($user)
    {
        $this->user = rawurldecode($user);
        return $this;
    }

    protected static function parseParams($params)
    {
        $data = preg_replace_callback(
            '/(?:^|(?<=&))[^=[]+/',
            function($match)
            {
                return bin2hex(urldecode($match[0]));
            },
            $params
        );
 
        parse_str($data, $values);
 
        return array_combine(array_map('hex2bin', array_keys($values)), $values);
    }

    public function deleteParams(array $params, $preserveDots = false)
    {
        $query = $this->getQuery();
        if ($query != '')
        {
            if ($preserveDots)
            {
                $currentParams = static::parseParams($query);
            }
            else
            {
                $currentParams = [];
                parse_str($query, $currentParams);
            }
 
            foreach($params as $param)
            {
                unset($currentParams[$param]);
            }
 
            $this->query = http_build_query($currentParams, '', '&', PHP_QUERY_RFC3986);
        }
        return $this;
    }

    public function addParams(array $params, $preserveDots = false)
    {
        $currentParams = [];
        $query = $this->getQuery();
 
        if ($query != '')
        {
            if ($preserveDots)
            {
                $currentParams = static::parseParams($query);
            }
            else
            {
                parse_str($query, $currentParams);
            }
        }
 
        $currentParams = array_replace($currentParams, $params);
 
        $this->query = http_build_query($currentParams, '', '&', PHP_QUERY_RFC3986);
 
        return $this;
    }

    public function __toString(): string
    {
        return $this->getUri();
    }

    public function jsonSerialize(): string
    {
        return $this->getUri();
    }

    public function convertToPunycode()
    {
        $host = \CBXPunycode::ToASCII($this->getHost(), $encodingErrors);
 
        if (!empty($encodingErrors))
        {
            return new Main\Error(implode("\n", $encodingErrors));
        }
 
        $this->setHost($host);
 
        return $host;
    }

    public function convertToUnicode()
    {
        $host = \CBXPunycode::ToUnicode($this->getHost(), $encodingErrors);
 
        if (!empty($encodingErrors))
        {
            return new Main\Error(implode("\n", $encodingErrors));
        }
 
        $this->setHost($host);
 
        return $host;
    }

    public function isPathTraversal(): bool
    {
        return (bool)preg_match("#(?:/|2f|^|\\\\|5c)(?:(?:%0*(25)*2e)|\\.){2,}(?:/|%0*(25)*2f|\\\\|%0*(25)*5c|$)#i", $this->getPath());
    }

    public static function urnEncode($str, $charset = 'UTF-8')
    {
        $result = '';
        $parts = preg_split("#(://|:\\d+/|/|\\?|=|&)#", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
 
        if ($charset === false)
        {
            foreach ($parts as $i => $part)
            {
                $result .= ($i % 2) ? $part : rawurlencode($part);
            }
        }
        else
        {
            $currentCharset = Main\Context::getCurrent()->getCulture()->getCharset();
            foreach ($parts as $i => $part)
            {
                $result .= ($i % 2)    ? $part : rawurlencode(Encoding::convertEncoding($part, $currentCharset, $charset));
            }
        }
        return $result;
    }

    public static function urnDecode($str, $charset = false)
    {
        $result = '';
        $parts = preg_split("#(://|:\\d+/|/|\\?|=|&)#", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
 
        if ($charset === false)
        {
            foreach ($parts as $i => $part)
            {
                $result .= ($i % 2) ? $part : rawurldecode($part);
            }
        }
        else
        {
            $currentCharset = Main\Context::getCurrent()->getCulture()->getCharset();
            foreach ($parts as $i => $part)
            {
                $result .= ($i % 2) ? $part : rawurldecode(Encoding::convertEncoding($part, $charset, $currentCharset));
            }
        }
        return $result;
    }

    public function toAbsolute(string $host = null): Uri
    {
        if ($this->host == '')
        {
            $request = Main\HttpContext::getCurrent()->getRequest();
 
            $this->scheme = $request->isHttps() ? 'https' : 'http';
 
            if ($host !== null)
            {
                $this->host = preg_replace('/:(443|80)$/', '', $host);
            }
            else
            {
                $this->host = $request->getHttpHost();
            }
        }
        return $this;
    }

    public function resolveRelativeUri(Uri $base): Uri
    {
        if (empty($this->scheme))
        {
            if (empty($this->getAuthority()))
            {
                if (empty($this->getPath()))
                {
                    $this->setPath($base->getPath());
 
                    if (empty($this->getQuery()))
                    {
                        $this->query = $base->getQuery();
                    }
                }
                else
                {
                    if (!str_starts_with($this->getPath(), '/'))
                    {
                        $basePath = $base->getPath();
 
                        if (!empty($base->getAuthority()) && empty($basePath))
                        {
                            $this->setPath('/' . $this->getPath());
                        }
                        else
                        {
                            if (($p = strrpos($basePath, '/')) !== false)
                            {
                                $this->setPath(substr($basePath, 0, $p + 1) . $this->getPath());
                            }
                        }
                    }
                }
 
                // authority
                $this->setUser($base->getUser());
                $this->setPass($base->getPass());
                $this->setHost($base->getHost());
                $this->port = $base->getPort();
            }
 
            $this->scheme = $base->getScheme();
        }
 
        return $this;
    }

    public function getAuthority(): string
    {
        $authority = '';
 
        $userInfo = $this->getUserInfo();
        if ($userInfo != '')
        {
            $authority = $userInfo . '@';
        }
 
        $host = $this->getHost();
        if ($host != '')
        {
            $authority .= $host;
            $port = $this->getPort();
 
            if ($port !== null)
            {
                if (($this->scheme == 'http' && $port != 80) || ($this->scheme == 'https' && $port != 443))
                {
                    $authority .= ':' . $port;
                }
            }
        }
 
        return $authority;
    }

    public function getUserInfo(): string
    {
        $user = $this->getUser();
 
        if ($user != '')
        {
            $password = $this->getPass();
            return $user . ($password != '' ? ':' . $password : '');
        }
 
        return '';
    }

    public function withScheme(string $scheme): UriInterface
    {
        $new = clone $this;
        $new->scheme = $scheme;
 
        return $new;
    }

    public function withUserInfo(string $user, ?string $password = null): UriInterface
    {
        $new = clone $this;
        $new
            ->setUser($user)
            ->setPass((string)$password)
        ;
 
        return $new;
    }

    public function withHost(string $host): UriInterface
    {
        $new = clone $this;
        $new->setHost($host);
 
        return $new;
    }

    public function withPort(?int $port): UriInterface
    {
        $new = clone $this;
        $new->port = $port;
 
        return $new;
    }

    public function withPath(string $path): UriInterface
    {
        $new = clone $this;
        $new->setPath($path);
 
        return $new;
    }

    public function withQuery(string $query): UriInterface
    {
        $new = clone $this;
        $new->query = $query;
 
        return $new;
    }

    public function withFragment(string $fragment): UriInterface
    {
        $new = clone $this;
        $new->fragment = $fragment;
 
        return $new;
    }
}