357 lines
9.5 KiB
PHP
357 lines
9.5 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
namespace Nyholm\Psr7;
|
||
|
|
|
||
|
|
use Psr\Http\Message\UriInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* PSR-7 URI implementation.
|
||
|
|
*
|
||
|
|
* @author Michael Dowling
|
||
|
|
* @author Tobias Schultze
|
||
|
|
* @author Matthew Weier O'Phinney
|
||
|
|
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
|
||
|
|
* @author Martijn van der Ven <martijn@vanderven.se>
|
||
|
|
*
|
||
|
|
* @final This class should never be extended. See https://github.com/Nyholm/psr7/blob/master/doc/final.md
|
||
|
|
*/
|
||
|
|
class Uri implements UriInterface
|
||
|
|
{
|
||
|
|
private const SCHEMES = ['http' => 80, 'https' => 443];
|
||
|
|
|
||
|
|
private const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~';
|
||
|
|
|
||
|
|
private const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;=';
|
||
|
|
|
||
|
|
private const CHAR_GEN_DELIMS = ':\/\?#\[\]@';
|
||
|
|
|
||
|
|
/** @var string Uri scheme. */
|
||
|
|
private $scheme = '';
|
||
|
|
|
||
|
|
/** @var string Uri user info. */
|
||
|
|
private $userInfo = '';
|
||
|
|
|
||
|
|
/** @var string Uri host. */
|
||
|
|
private $host = '';
|
||
|
|
|
||
|
|
/** @var int|null Uri port. */
|
||
|
|
private $port;
|
||
|
|
|
||
|
|
/** @var string Uri path. */
|
||
|
|
private $path = '';
|
||
|
|
|
||
|
|
/** @var string Uri query string. */
|
||
|
|
private $query = '';
|
||
|
|
|
||
|
|
/** @var string Uri fragment. */
|
||
|
|
private $fragment = '';
|
||
|
|
|
||
|
|
public function __construct(string $uri = '')
|
||
|
|
{
|
||
|
|
if ('' !== $uri) {
|
||
|
|
if (false === $parts = \parse_url($uri)) {
|
||
|
|
throw new \InvalidArgumentException(\sprintf('Unable to parse URI: "%s"', $uri));
|
||
|
|
}
|
||
|
|
|
||
|
|
// Apply parse_url parts to a URI.
|
||
|
|
$this->scheme = isset($parts['scheme']) ? \strtr($parts['scheme'], 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz') : '';
|
||
|
|
$this->userInfo = $parts['user'] ?? '';
|
||
|
|
$this->host = isset($parts['host']) ? \strtr($parts['host'], 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz') : '';
|
||
|
|
$this->port = isset($parts['port']) ? $this->filterPort($parts['port']) : null;
|
||
|
|
$this->path = isset($parts['path']) ? $this->filterPath($parts['path']) : '';
|
||
|
|
$this->query = isset($parts['query']) ? $this->filterQueryAndFragment($parts['query']) : '';
|
||
|
|
$this->fragment = isset($parts['fragment']) ? $this->filterQueryAndFragment($parts['fragment']) : '';
|
||
|
|
if (isset($parts['pass'])) {
|
||
|
|
$this->userInfo .= ':' . $parts['pass'];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function __toString(): string
|
||
|
|
{
|
||
|
|
return self::createUriString($this->scheme, $this->getAuthority(), $this->path, $this->query, $this->fragment);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getScheme(): string
|
||
|
|
{
|
||
|
|
return $this->scheme;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getAuthority(): string
|
||
|
|
{
|
||
|
|
if ('' === $this->host) {
|
||
|
|
return '';
|
||
|
|
}
|
||
|
|
|
||
|
|
$authority = $this->host;
|
||
|
|
if ('' !== $this->userInfo) {
|
||
|
|
$authority = $this->userInfo . '@' . $authority;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (null !== $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->port;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getPath(): string
|
||
|
|
{
|
||
|
|
$path = $this->path;
|
||
|
|
|
||
|
|
if ('' !== $path && '/' !== $path[0]) {
|
||
|
|
if ('' !== $this->host) {
|
||
|
|
// If the path is rootless and an authority is present, the path MUST be prefixed by "/"
|
||
|
|
$path = '/' . $path;
|
||
|
|
}
|
||
|
|
} elseif (isset($path[1]) && '/' === $path[1]) {
|
||
|
|
// If the path is starting with more than one "/", the
|
||
|
|
// starting slashes MUST be reduced to one.
|
||
|
|
$path = '/' . \ltrim($path, '/');
|
||
|
|
}
|
||
|
|
|
||
|
|
return $path;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getQuery(): string
|
||
|
|
{
|
||
|
|
return $this->query;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getFragment(): string
|
||
|
|
{
|
||
|
|
return $this->fragment;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withScheme($scheme): UriInterface
|
||
|
|
{
|
||
|
|
if (!\is_string($scheme)) {
|
||
|
|
throw new \InvalidArgumentException('Scheme must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->scheme === $scheme = \strtr($scheme, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->scheme = $scheme;
|
||
|
|
$new->port = $new->filterPort($new->port);
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withUserInfo($user, $password = null): UriInterface
|
||
|
|
{
|
||
|
|
if (!\is_string($user)) {
|
||
|
|
throw new \InvalidArgumentException('User must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
$info = \preg_replace_callback('/[' . self::CHAR_GEN_DELIMS . self::CHAR_SUB_DELIMS . ']++/', [__CLASS__, 'rawurlencodeMatchZero'], $user);
|
||
|
|
if (null !== $password && '' !== $password) {
|
||
|
|
if (!\is_string($password)) {
|
||
|
|
throw new \InvalidArgumentException('Password must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
$info .= ':' . \preg_replace_callback('/[' . self::CHAR_GEN_DELIMS . self::CHAR_SUB_DELIMS . ']++/', [__CLASS__, 'rawurlencodeMatchZero'], $password);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->userInfo === $info) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->userInfo = $info;
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withHost($host): UriInterface
|
||
|
|
{
|
||
|
|
if (!\is_string($host)) {
|
||
|
|
throw new \InvalidArgumentException('Host must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->host === $host = \strtr($host, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->host = $host;
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withPort($port): UriInterface
|
||
|
|
{
|
||
|
|
if ($this->port === $port = $this->filterPort($port)) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->port = $port;
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withPath($path): UriInterface
|
||
|
|
{
|
||
|
|
if ($this->path === $path = $this->filterPath($path)) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->path = $path;
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withQuery($query): UriInterface
|
||
|
|
{
|
||
|
|
if ($this->query === $query = $this->filterQueryAndFragment($query)) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->query = $query;
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return static
|
||
|
|
*/
|
||
|
|
public function withFragment($fragment): UriInterface
|
||
|
|
{
|
||
|
|
if ($this->fragment === $fragment = $this->filterQueryAndFragment($fragment)) {
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
$new = clone $this;
|
||
|
|
$new->fragment = $fragment;
|
||
|
|
|
||
|
|
return $new;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a URI string from its various parts.
|
||
|
|
*/
|
||
|
|
private static function createUriString(string $scheme, string $authority, string $path, string $query, string $fragment): string
|
||
|
|
{
|
||
|
|
$uri = '';
|
||
|
|
if ('' !== $scheme) {
|
||
|
|
$uri .= $scheme . ':';
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' !== $authority) {
|
||
|
|
$uri .= '//' . $authority;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' !== $path) {
|
||
|
|
if ('/' !== $path[0]) {
|
||
|
|
if ('' !== $authority) {
|
||
|
|
// If the path is rootless and an authority is present, the path MUST be prefixed by "/"
|
||
|
|
$path = '/' . $path;
|
||
|
|
}
|
||
|
|
} elseif (isset($path[1]) && '/' === $path[1]) {
|
||
|
|
if ('' === $authority) {
|
||
|
|
// If the path is starting with more than one "/" and no authority is present, the
|
||
|
|
// starting slashes MUST be reduced to one.
|
||
|
|
$path = '/' . \ltrim($path, '/');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$uri .= $path;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' !== $query) {
|
||
|
|
$uri .= '?' . $query;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ('' !== $fragment) {
|
||
|
|
$uri .= '#' . $fragment;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $uri;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Is a given port non-standard for the current scheme?
|
||
|
|
*/
|
||
|
|
private static function isNonStandardPort(string $scheme, int $port): bool
|
||
|
|
{
|
||
|
|
return !isset(self::SCHEMES[$scheme]) || $port !== self::SCHEMES[$scheme];
|
||
|
|
}
|
||
|
|
|
||
|
|
private function filterPort($port): ?int
|
||
|
|
{
|
||
|
|
if (null === $port) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
$port = (int) $port;
|
||
|
|
if (0 > $port || 0xFFFF < $port) {
|
||
|
|
throw new \InvalidArgumentException(\sprintf('Invalid port: %d. Must be between 0 and 65535', $port));
|
||
|
|
}
|
||
|
|
|
||
|
|
return self::isNonStandardPort($this->scheme, $port) ? $port : null;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function filterPath($path): string
|
||
|
|
{
|
||
|
|
if (!\is_string($path)) {
|
||
|
|
throw new \InvalidArgumentException('Path must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
return \preg_replace_callback('/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/]++|%(?![A-Fa-f0-9]{2}))/', [__CLASS__, 'rawurlencodeMatchZero'], $path);
|
||
|
|
}
|
||
|
|
|
||
|
|
private function filterQueryAndFragment($str): string
|
||
|
|
{
|
||
|
|
if (!\is_string($str)) {
|
||
|
|
throw new \InvalidArgumentException('Query and fragment must be a string');
|
||
|
|
}
|
||
|
|
|
||
|
|
return \preg_replace_callback('/(?:[^' . self::CHAR_UNRESERVED . self::CHAR_SUB_DELIMS . '%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', [__CLASS__, 'rawurlencodeMatchZero'], $str);
|
||
|
|
}
|
||
|
|
|
||
|
|
private static function rawurlencodeMatchZero(array $match): string
|
||
|
|
{
|
||
|
|
return \rawurlencode($match[0]);
|
||
|
|
}
|
||
|
|
}
|