/api/vendor/guzzlehttp/guzzle/src/Url.php
PHP | 595 lines | 330 code | 64 blank | 201 comment | 55 complexity | 04b6409edc7a893612037ea2abe2bedb MD5 | raw file
- <?php
- namespace GuzzleHttp;
- use GuzzleHttp\Ring\Core;
- /**
- * Parses and generates URLs based on URL parts
- */
- class Url
- {
- private $scheme;
- private $host;
- private $port;
- private $username;
- private $password;
- private $path = '';
- private $fragment;
- private static $defaultPorts = ['http' => 80, 'https' => 443, 'ftp' => 21];
- private static $pathPattern = '/[^a-zA-Z0-9\-\._~!\$&\'\(\)\*\+,;=%:@\/]+|%(?![A-Fa-f0-9]{2})/';
- private static $queryPattern = '/[^a-zA-Z0-9\-\._~!\$\'\(\)\*\+,;%:@\/\?=&]+|%(?![A-Fa-f0-9]{2})/';
- /** @var Query|string Query part of the URL */
- private $query;
- /**
- * Factory method to create a new URL from a URL string
- *
- * @param string $url Full URL used to create a Url object
- *
- * @return Url
- * @throws \InvalidArgumentException
- */
- public static function fromString($url)
- {
- static $defaults = ['scheme' => null, 'host' => null,
- 'path' => null, 'port' => null, 'query' => null,
- 'user' => null, 'pass' => null, 'fragment' => null];
- if (false === ($parts = parse_url($url))) {
- throw new \InvalidArgumentException('Unable to parse malformed '
- . 'url: ' . $url);
- }
- $parts += $defaults;
- // Convert the query string into a Query object
- if ($parts['query'] || 0 !== strlen($parts['query'])) {
- $parts['query'] = Query::fromString($parts['query']);
- }
- return new static($parts['scheme'], $parts['host'], $parts['user'],
- $parts['pass'], $parts['port'], $parts['path'], $parts['query'],
- $parts['fragment']);
- }
- /**
- * Build a URL from parse_url parts. The generated URL will be a relative
- * URL if a scheme or host are not provided.
- *
- * @param array $parts Array of parse_url parts
- *
- * @return string
- */
- public static function buildUrl(array $parts)
- {
- $url = $scheme = '';
- if (!empty($parts['scheme'])) {
- $scheme = $parts['scheme'];
- $url .= $scheme . ':';
- }
- if (!empty($parts['host'])) {
- $url .= '//';
- if (isset($parts['user'])) {
- $url .= $parts['user'];
- if (isset($parts['pass'])) {
- $url .= ':' . $parts['pass'];
- }
- $url .= '@';
- }
- $url .= $parts['host'];
- // Only include the port if it is not the default port of the scheme
- if (isset($parts['port']) &&
- (!isset(self::$defaultPorts[$scheme]) ||
- $parts['port'] != self::$defaultPorts[$scheme])
- ) {
- $url .= ':' . $parts['port'];
- }
- }
- // Add the path component if present
- if (isset($parts['path']) && strlen($parts['path'])) {
- // Always ensure that the path begins with '/' if set and something
- // is before the path
- if (!empty($parts['host']) && $parts['path'][0] != '/') {
- $url .= '/';
- }
- $url .= $parts['path'];
- }
- // Add the query string if present
- if (isset($parts['query'])) {
- $queryStr = (string) $parts['query'];
- if ($queryStr || $queryStr === '0') {
- $url .= '?' . $queryStr;
- }
- }
- // Ensure that # is only added to the url if fragment contains anything.
- if (isset($parts['fragment'])) {
- $url .= '#' . $parts['fragment'];
- }
- return $url;
- }
- /**
- * Create a new URL from URL parts
- *
- * @param string $scheme Scheme of the URL
- * @param string $host Host of the URL
- * @param string $username Username of the URL
- * @param string $password Password of the URL
- * @param int $port Port of the URL
- * @param string $path Path of the URL
- * @param Query|array|string $query Query string of the URL
- * @param string $fragment Fragment of the URL
- */
- public function __construct(
- $scheme,
- $host,
- $username = null,
- $password = null,
- $port = null,
- $path = null,
- $query = null,
- $fragment = null
- ) {
- $this->scheme = $scheme;
- $this->host = $host;
- $this->port = $port;
- $this->username = $username;
- $this->password = $password;
- $this->fragment = $fragment;
- if ($query) {
- $this->setQuery($query);
- }
- $this->setPath($path);
- }
- /**
- * Clone the URL
- */
- public function __clone()
- {
- if ($this->query instanceof Query) {
- $this->query = clone $this->query;
- }
- }
- /**
- * Returns the URL as a URL string
- *
- * @return string
- */
- public function __toString()
- {
- return static::buildUrl($this->getParts());
- }
- /**
- * Get the parts of the URL as an array
- *
- * @return array
- */
- public function getParts()
- {
- return array(
- 'scheme' => $this->scheme,
- 'user' => $this->username,
- 'pass' => $this->password,
- 'host' => $this->host,
- 'port' => $this->port,
- 'path' => $this->path,
- 'query' => $this->query,
- 'fragment' => $this->fragment,
- );
- }
- /**
- * Set the host of the request.
- *
- * @param string $host Host to set (e.g. www.yahoo.com, yahoo.com)
- *
- * @return Url
- */
- public function setHost($host)
- {
- if (strpos($host, ':') === false) {
- $this->host = $host;
- } else {
- list($host, $port) = explode(':', $host);
- $this->host = $host;
- $this->setPort($port);
- }
- }
- /**
- * Get the host part of the URL
- *
- * @return string
- */
- public function getHost()
- {
- return $this->host;
- }
- /**
- * Set the scheme part of the URL (http, https, ftp, etc.)
- *
- * @param string $scheme Scheme to set
- */
- public function setScheme($scheme)
- {
- // Remove the default port if one is specified
- if ($this->port
- && isset(self::$defaultPorts[$this->scheme])
- && self::$defaultPorts[$this->scheme] == $this->port
- ) {
- $this->port = null;
- }
- $this->scheme = $scheme;
- }
- /**
- * Get the scheme part of the URL
- *
- * @return string
- */
- public function getScheme()
- {
- return $this->scheme;
- }
- /**
- * Set the port part of the URL
- *
- * @param int $port Port to set
- */
- public function setPort($port)
- {
- $this->port = $port;
- }
- /**
- * Get the port part of the URl.
- *
- * If no port was set, this method will return the default port for the
- * scheme of the URI.
- *
- * @return int|null
- */
- public function getPort()
- {
- if ($this->port) {
- return $this->port;
- } elseif (isset(self::$defaultPorts[$this->scheme])) {
- return self::$defaultPorts[$this->scheme];
- }
- return null;
- }
- /**
- * Set the path part of the URL.
- *
- * The provided URL is URL encoded as necessary.
- *
- * @param string $path Path string to set
- */
- public function setPath($path)
- {
- $this->path = self::encodePath($path);
- }
- /**
- * Removes dot segments from a URL
- * @link http://tools.ietf.org/html/rfc3986#section-5.2.4
- */
- public function removeDotSegments()
- {
- static $noopPaths = ['' => true, '/' => true, '*' => true];
- static $ignoreSegments = ['.' => true, '..' => true];
- if (isset($noopPaths[$this->path])) {
- return;
- }
- $results = [];
- $segments = $this->getPathSegments();
- foreach ($segments as $segment) {
- if ($segment == '..') {
- array_pop($results);
- } elseif (!isset($ignoreSegments[$segment])) {
- $results[] = $segment;
- }
- }
- $newPath = implode('/', $results);
- // Add the leading slash if necessary
- if (substr($this->path, 0, 1) === '/' &&
- substr($newPath, 0, 1) !== '/'
- ) {
- $newPath = '/' . $newPath;
- }
- // Add the trailing slash if necessary
- if ($newPath != '/' && isset($ignoreSegments[end($segments)])) {
- $newPath .= '/';
- }
- $this->path = $newPath;
- }
- /**
- * Add a relative path to the currently set path.
- *
- * @param string $relativePath Relative path to add
- */
- public function addPath($relativePath)
- {
- if ($relativePath != '/' &&
- is_string($relativePath) &&
- strlen($relativePath) > 0
- ) {
- // Add a leading slash if needed
- if ($relativePath[0] !== '/' &&
- substr($this->path, -1, 1) !== '/'
- ) {
- $relativePath = '/' . $relativePath;
- }
- $this->setPath($this->path . $relativePath);
- }
- }
- /**
- * Get the path part of the URL
- *
- * @return string
- */
- public function getPath()
- {
- return $this->path;
- }
- /**
- * Get the path segments of the URL as an array
- *
- * @return array
- */
- public function getPathSegments()
- {
- return explode('/', $this->path);
- }
- /**
- * Set the password part of the URL
- *
- * @param string $password Password to set
- */
- public function setPassword($password)
- {
- $this->password = $password;
- }
- /**
- * Get the password part of the URL
- *
- * @return null|string
- */
- public function getPassword()
- {
- return $this->password;
- }
- /**
- * Set the username part of the URL
- *
- * @param string $username Username to set
- */
- public function setUsername($username)
- {
- $this->username = $username;
- }
- /**
- * Get the username part of the URl
- *
- * @return null|string
- */
- public function getUsername()
- {
- return $this->username;
- }
- /**
- * Get the query part of the URL as a Query object
- *
- * @return Query
- */
- public function getQuery()
- {
- // Convert the query string to a query object if not already done.
- if (!$this->query instanceof Query) {
- $this->query = $this->query === null
- ? new Query()
- : Query::fromString($this->query);
- }
- return $this->query;
- }
- /**
- * Set the query part of the URL.
- *
- * You may provide a query string as a string and pass $rawString as true
- * to provide a query string that is not parsed until a call to getQuery()
- * is made. Setting a raw query string will still encode invalid characters
- * in a query string.
- *
- * @param Query|string|array $query Query string value to set. Can
- * be a string that will be parsed into a Query object, an array
- * of key value pairs, or a Query object.
- * @param bool $rawString Set to true when providing a raw query string.
- *
- * @throws \InvalidArgumentException
- */
- public function setQuery($query, $rawString = false)
- {
- if ($query instanceof Query) {
- $this->query = $query;
- } elseif (is_string($query)) {
- if (!$rawString) {
- $this->query = Query::fromString($query);
- } else {
- // Ensure the query does not have illegal characters.
- $this->query = preg_replace_callback(
- self::$queryPattern,
- [__CLASS__, 'encodeMatch'],
- $query
- );
- }
- } elseif (is_array($query)) {
- $this->query = new Query($query);
- } else {
- throw new \InvalidArgumentException('Query must be a Query, '
- . 'array, or string. Got ' . Core::describeType($query));
- }
- }
- /**
- * Get the fragment part of the URL
- *
- * @return null|string
- */
- public function getFragment()
- {
- return $this->fragment;
- }
- /**
- * Set the fragment part of the URL
- *
- * @param string $fragment Fragment to set
- */
- public function setFragment($fragment)
- {
- $this->fragment = $fragment;
- }
- /**
- * Check if this is an absolute URL
- *
- * @return bool
- */
- public function isAbsolute()
- {
- return $this->scheme && $this->host;
- }
- /**
- * Combine the URL with another URL and return a new URL instance.
- *
- * Follows the rules specific in RFC 3986 section 5.4.
- *
- * @param string $url Relative URL to combine with
- *
- * @return Url
- * @throws \InvalidArgumentException
- * @link http://tools.ietf.org/html/rfc3986#section-5.4
- */
- public function combine($url)
- {
- $url = static::fromString($url);
- // Use the more absolute URL as the base URL
- if (!$this->isAbsolute() && $url->isAbsolute()) {
- $url = $url->combine($this);
- }
- $parts = $url->getParts();
- // Passing a URL with a scheme overrides everything
- if ($parts['scheme']) {
- return clone $url;
- }
- // Setting a host overrides the entire rest of the URL
- if ($parts['host']) {
- return new static(
- $this->scheme,
- $parts['host'],
- $parts['user'],
- $parts['pass'],
- $parts['port'],
- $parts['path'],
- $parts['query'] instanceof Query
- ? clone $parts['query']
- : $parts['query'],
- $parts['fragment']
- );
- }
- if (!$parts['path'] && $parts['path'] !== '0') {
- // The relative URL has no path, so check if it is just a query
- $path = $this->path ?: '';
- $query = $parts['query'] ?: $this->query;
- } else {
- $query = $parts['query'];
- if ($parts['path'][0] == '/' || !$this->path) {
- // Overwrite the existing path if the rel path starts with "/"
- $path = $parts['path'];
- } else {
- // If the relative URL does not have a path or the base URL
- // path does not end in a "/" then overwrite the existing path
- // up to the last "/"
- $path = substr($this->path, 0, strrpos($this->path, '/') + 1) . $parts['path'];
- }
- }
- $result = new self(
- $this->scheme,
- $this->host,
- $this->username,
- $this->password,
- $this->port,
- $path,
- $query instanceof Query ? clone $query : $query,
- $parts['fragment']
- );
- if ($path) {
- $result->removeDotSegments();
- }
- return $result;
- }
- /**
- * Encodes the path part of a URL without double-encoding percent-encoded
- * key value pairs.
- *
- * @param string $path Path to encode
- *
- * @return string
- */
- public static function encodePath($path)
- {
- static $cb = [__CLASS__, 'encodeMatch'];
- return preg_replace_callback(self::$pathPattern, $cb, $path);
- }
- private static function encodeMatch(array $match)
- {
- return rawurlencode($match[0]);
- }
- }