diff options
author | Andrew Dolgov <[email protected]> | 2022-07-24 14:03:04 +0300 |
---|---|---|
committer | Andrew Dolgov <[email protected]> | 2022-07-24 14:03:04 +0300 |
commit | 5006c754c42a09f5b88b258c2da4b9eff7508357 (patch) | |
tree | 841425d4e163d746642d70b8ac0df381343bbf2b /plugins/af_readability/vendor/league/uri/src/UriTemplate/Expression.php | |
parent | f7b3c50828d4604ac5999daf3c3405e65c877e2f (diff) |
readability: add missing dependencies
Diffstat (limited to 'plugins/af_readability/vendor/league/uri/src/UriTemplate/Expression.php')
-rw-r--r-- | plugins/af_readability/vendor/league/uri/src/UriTemplate/Expression.php | 329 |
1 files changed, 329 insertions, 0 deletions
diff --git a/plugins/af_readability/vendor/league/uri/src/UriTemplate/Expression.php b/plugins/af_readability/vendor/league/uri/src/UriTemplate/Expression.php new file mode 100644 index 000000000..99ecac98b --- /dev/null +++ b/plugins/af_readability/vendor/league/uri/src/UriTemplate/Expression.php @@ -0,0 +1,329 @@ +<?php + +/** + * League.Uri (https://uri.thephpleague.com) + * + * (c) Ignace Nyamagana Butera <[email protected]> + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +declare(strict_types=1); + +namespace League\Uri\UriTemplate; + +use League\Uri\Exceptions\SyntaxError; +use League\Uri\Exceptions\TemplateCanNotBeExpanded; +use function array_filter; +use function array_keys; +use function array_map; +use function array_unique; +use function explode; +use function implode; +use function preg_match; +use function rawurlencode; +use function str_replace; +use function strpos; +use function substr; + +final class Expression +{ + /** + * Expression regular expression pattern. + * + * @link https://tools.ietf.org/html/rfc6570#section-2.2 + */ + private const REGEXP_EXPRESSION = '/^\{ + (?: + (?<operator>[\.\/;\?&\=,\!@\|\+#])? + (?<variables>[^\}]*) + ) + \}$/x'; + + /** + * Reserved Operator characters. + * + * @link https://tools.ietf.org/html/rfc6570#section-2.2 + */ + private const RESERVED_OPERATOR = '=,!@|'; + + /** + * Processing behavior according to the expression type operator. + * + * @link https://tools.ietf.org/html/rfc6570#appendix-A + */ + private const OPERATOR_HASH_LOOKUP = [ + '' => ['prefix' => '', 'joiner' => ',', 'query' => false], + '+' => ['prefix' => '', 'joiner' => ',', 'query' => false], + '#' => ['prefix' => '#', 'joiner' => ',', 'query' => false], + '.' => ['prefix' => '.', 'joiner' => '.', 'query' => false], + '/' => ['prefix' => '/', 'joiner' => '/', 'query' => false], + ';' => ['prefix' => ';', 'joiner' => ';', 'query' => true], + '?' => ['prefix' => '?', 'joiner' => '&', 'query' => true], + '&' => ['prefix' => '&', 'joiner' => '&', 'query' => true], + ]; + + private string $operator; + /** @var array<VarSpecifier> */ + private array $varSpecifiers; + private string $joiner; + /** @var array<string> */ + private array $variableNames; + private string $expressionString; + + private function __construct(string $operator, VarSpecifier ...$varSpecifiers) + { + $this->operator = $operator; + $this->varSpecifiers = $varSpecifiers; + $this->joiner = self::OPERATOR_HASH_LOOKUP[$operator]['joiner']; + $this->variableNames = $this->setVariableNames(); + $this->expressionString = $this->setExpressionString(); + } + + /** + * @return array<string> + */ + private function setVariableNames(): array + { + return array_unique(array_map( + static fn (VarSpecifier $varSpecifier): string => $varSpecifier->name(), + $this->varSpecifiers + )); + } + + private function setExpressionString(): string + { + $varSpecifierString = implode(',', array_map( + static fn (VarSpecifier $variable): string => $variable->toString(), + $this->varSpecifiers + )); + + return '{'.$this->operator.$varSpecifierString.'}'; + } + + /** + * {@inheritDoc} + */ + public static function __set_state(array $properties): self + { + return new self($properties['operator'], ...$properties['varSpecifiers']); + } + + /** + * @throws SyntaxError if the expression is invalid + * @throws SyntaxError if the operator used in the expression is invalid + * @throws SyntaxError if the variable specifiers is invalid + */ + public static function createFromString(string $expression): self + { + if (1 !== preg_match(self::REGEXP_EXPRESSION, $expression, $parts)) { + throw new SyntaxError('The expression "'.$expression.'" is invalid.'); + } + + /** @var array{operator:string, variables:string} $parts */ + $parts = $parts + ['operator' => '']; + if ('' !== $parts['operator'] && false !== strpos(self::RESERVED_OPERATOR, $parts['operator'])) { + throw new SyntaxError('The operator used in the expression "'.$expression.'" is reserved.'); + } + + return new Expression($parts['operator'], ...array_map( + static fn (string $varSpec): VarSpecifier => VarSpecifier::createFromString($varSpec), + explode(',', $parts['variables']) + )); + } + + /** + * Returns the expression string representation. + * + */ + public function toString(): string + { + return $this->expressionString; + } + + /** + * @return array<string> + */ + public function variableNames(): array + { + return $this->variableNames; + } + + public function expand(VariableBag $variables): string + { + $parts = []; + foreach ($this->varSpecifiers as $varSpecifier) { + $parts[] = $this->replace($varSpecifier, $variables); + } + + $expanded = implode($this->joiner, array_filter($parts, static fn ($value): bool => '' !== $value)); + if ('' === $expanded) { + return $expanded; + } + + $prefix = self::OPERATOR_HASH_LOOKUP[$this->operator]['prefix']; + if ('' === $prefix) { + return $expanded; + } + + return $prefix.$expanded; + } + + /** + * Replaces an expression with the given variables. + * + * @throws TemplateCanNotBeExpanded if the variables is an array and a ":" modifier needs to be applied + * @throws TemplateCanNotBeExpanded if the variables contains nested array values + */ + private function replace(VarSpecifier $varSpec, VariableBag $variables): string + { + $value = $variables->fetch($varSpec->name()); + if (null === $value) { + return ''; + } + + $useQuery = self::OPERATOR_HASH_LOOKUP[$this->operator]['query']; + [$expanded, $actualQuery] = $this->inject($value, $varSpec, $useQuery); + if (!$actualQuery) { + return $expanded; + } + + if ('&' !== $this->joiner && '' === $expanded) { + return $varSpec->name(); + } + + return $varSpec->name().'='.$expanded; + } + + /** + * @param string|array<string> $value + * + * @return array{0:string, 1:bool} + */ + private function inject($value, VarSpecifier $varSpec, bool $useQuery): array + { + if (is_string($value)) { + return $this->replaceString($value, $varSpec, $useQuery); + } + + return $this->replaceList($value, $varSpec, $useQuery); + } + + /** + * Expands an expression using a string value. + * + * @return array{0:string, 1:bool} + */ + private function replaceString(string $value, VarSpecifier $varSpec, bool $useQuery): array + { + if (':' === $varSpec->modifier()) { + $value = substr($value, 0, $varSpec->position()); + } + + $expanded = rawurlencode($value); + if ('+' === $this->operator || '#' === $this->operator) { + return [$this->decodeReserved($expanded), $useQuery]; + } + + return [$expanded, $useQuery]; + } + + /** + * Expands an expression using a list of values. + * + * @param array<string> $value + * + * @throws TemplateCanNotBeExpanded if the variables is an array and a ":" modifier needs to be applied + * + * @return array{0:string, 1:bool} + */ + private function replaceList(array $value, VarSpecifier $varSpec, bool $useQuery): array + { + if ([] === $value) { + return ['', false]; + } + + if (':' === $varSpec->modifier()) { + throw TemplateCanNotBeExpanded::dueToUnableToProcessValueListWithPrefix($varSpec->name()); + } + + $pairs = []; + $isAssoc = $this->isAssoc($value); + foreach ($value as $key => $var) { + if ($isAssoc) { + $key = rawurlencode((string) $key); + } + + $var = rawurlencode($var); + if ('+' === $this->operator || '#' === $this->operator) { + $var = $this->decodeReserved($var); + } + + if ('*' === $varSpec->modifier()) { + if ($isAssoc) { + $var = $key.'='.$var; + } elseif ($key > 0 && $useQuery) { + $var = $varSpec->name().'='.$var; + } + } + + $pairs[$key] = $var; + } + + if ('*' === $varSpec->modifier()) { + if ($isAssoc) { + // Don't prepend the value name when using the explode + // modifier with an associative array. + $useQuery = false; + } + + return [implode($this->joiner, $pairs), $useQuery]; + } + + if ($isAssoc) { + // When an associative array is encountered and the + // explode modifier is not set, then the result must be + // a comma separated list of keys followed by their + // respective values. + foreach ($pairs as $offset => &$data) { + $data = $offset.','.$data; + } + + unset($data); + } + + return [implode(',', $pairs), $useQuery]; + } + + /** + * Determines if an array is associative. + * + * This makes the assumption that input arrays are sequences or hashes. + * This assumption is a trade-off for accuracy in favor of speed, but it + * should work in almost every case where input is supplied for a URI + * template. + */ + private function isAssoc(array $array): bool + { + return [] !== $array && 0 !== array_keys($array)[0]; + } + + /** + * Removes percent encoding on reserved characters (used with + and # modifiers). + */ + private function decodeReserved(string $str): string + { + static $delimiters = [ + ':', '/', '?', '#', '[', ']', '@', '!', '$', + '&', '\'', '(', ')', '*', '+', ',', ';', '=', + ]; + + static $delimitersEncoded = [ + '%3A', '%2F', '%3F', '%23', '%5B', '%5D', '%40', '%21', '%24', + '%26', '%27', '%28', '%29', '%2A', '%2B', '%2C', '%3B', '%3D', + ]; + + return str_replace($delimitersEncoded, $delimiters, $str); + } +} |