Extension
2 months ago
Translator.php
2 months ago
TranslatorInterface.php
2 months ago
XPathExpr.php
2 months ago
Translator.php
189 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace ProfilePressVendor\Symfony\Component\CssSelector\XPath; |
| 12 | |
| 13 | use ProfilePressVendor\Symfony\Component\CssSelector\Exception\ExpressionErrorException; |
| 14 | use ProfilePressVendor\Symfony\Component\CssSelector\Node\FunctionNode; |
| 15 | use ProfilePressVendor\Symfony\Component\CssSelector\Node\NodeInterface; |
| 16 | use ProfilePressVendor\Symfony\Component\CssSelector\Node\SelectorNode; |
| 17 | use ProfilePressVendor\Symfony\Component\CssSelector\Parser\Parser; |
| 18 | use ProfilePressVendor\Symfony\Component\CssSelector\Parser\ParserInterface; |
| 19 | /** |
| 20 | * XPath expression translator interface. |
| 21 | * |
| 22 | * This component is a port of the Python cssselect library, |
| 23 | * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect. |
| 24 | * |
| 25 | * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> |
| 26 | * |
| 27 | * @internal |
| 28 | */ |
| 29 | class Translator implements TranslatorInterface |
| 30 | { |
| 31 | private $mainParser; |
| 32 | /** |
| 33 | * @var ParserInterface[] |
| 34 | */ |
| 35 | private $shortcutParsers = []; |
| 36 | /** |
| 37 | * @var Extension\ExtensionInterface[] |
| 38 | */ |
| 39 | private $extensions = []; |
| 40 | private $nodeTranslators = []; |
| 41 | private $combinationTranslators = []; |
| 42 | private $functionTranslators = []; |
| 43 | private $pseudoClassTranslators = []; |
| 44 | private $attributeMatchingTranslators = []; |
| 45 | public function __construct(?ParserInterface $parser = null) |
| 46 | { |
| 47 | $this->mainParser = $parser ?? new Parser(); |
| 48 | $this->registerExtension(new Extension\NodeExtension())->registerExtension(new Extension\CombinationExtension())->registerExtension(new Extension\FunctionExtension())->registerExtension(new Extension\PseudoClassExtension())->registerExtension(new Extension\AttributeMatchingExtension()); |
| 49 | } |
| 50 | public static function getXpathLiteral(string $element): string |
| 51 | { |
| 52 | if (!str_contains($element, "'")) { |
| 53 | return "'" . $element . "'"; |
| 54 | } |
| 55 | if (!str_contains($element, '"')) { |
| 56 | return '"' . $element . '"'; |
| 57 | } |
| 58 | $string = $element; |
| 59 | $parts = []; |
| 60 | while (\true) { |
| 61 | if (\false !== $pos = strpos($string, "'")) { |
| 62 | $parts[] = sprintf("'%s'", substr($string, 0, $pos)); |
| 63 | $parts[] = "\"'\""; |
| 64 | $string = substr($string, $pos + 1); |
| 65 | } else { |
| 66 | $parts[] = "'{$string}'"; |
| 67 | break; |
| 68 | } |
| 69 | } |
| 70 | return sprintf('concat(%s)', implode(', ', $parts)); |
| 71 | } |
| 72 | /** |
| 73 | * {@inheritdoc} |
| 74 | */ |
| 75 | public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string |
| 76 | { |
| 77 | $selectors = $this->parseSelectors($cssExpr); |
| 78 | /** @var SelectorNode $selector */ |
| 79 | foreach ($selectors as $index => $selector) { |
| 80 | if (null !== $selector->getPseudoElement()) { |
| 81 | throw new ExpressionErrorException('Pseudo-elements are not supported.'); |
| 82 | } |
| 83 | $selectors[$index] = $this->selectorToXPath($selector, $prefix); |
| 84 | } |
| 85 | return implode(' | ', $selectors); |
| 86 | } |
| 87 | /** |
| 88 | * {@inheritdoc} |
| 89 | */ |
| 90 | public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::'): string |
| 91 | { |
| 92 | return ($prefix ?: '') . $this->nodeToXPath($selector); |
| 93 | } |
| 94 | /** |
| 95 | * @return $this |
| 96 | */ |
| 97 | public function registerExtension(Extension\ExtensionInterface $extension): self |
| 98 | { |
| 99 | $this->extensions[$extension->getName()] = $extension; |
| 100 | $this->nodeTranslators = array_merge($this->nodeTranslators, $extension->getNodeTranslators()); |
| 101 | $this->combinationTranslators = array_merge($this->combinationTranslators, $extension->getCombinationTranslators()); |
| 102 | $this->functionTranslators = array_merge($this->functionTranslators, $extension->getFunctionTranslators()); |
| 103 | $this->pseudoClassTranslators = array_merge($this->pseudoClassTranslators, $extension->getPseudoClassTranslators()); |
| 104 | $this->attributeMatchingTranslators = array_merge($this->attributeMatchingTranslators, $extension->getAttributeMatchingTranslators()); |
| 105 | return $this; |
| 106 | } |
| 107 | /** |
| 108 | * @throws ExpressionErrorException |
| 109 | */ |
| 110 | public function getExtension(string $name): Extension\ExtensionInterface |
| 111 | { |
| 112 | if (!isset($this->extensions[$name])) { |
| 113 | throw new ExpressionErrorException(sprintf('Extension "%s" not registered.', $name)); |
| 114 | } |
| 115 | return $this->extensions[$name]; |
| 116 | } |
| 117 | /** |
| 118 | * @return $this |
| 119 | */ |
| 120 | public function registerParserShortcut(ParserInterface $shortcut): self |
| 121 | { |
| 122 | $this->shortcutParsers[] = $shortcut; |
| 123 | return $this; |
| 124 | } |
| 125 | /** |
| 126 | * @throws ExpressionErrorException |
| 127 | */ |
| 128 | public function nodeToXPath(NodeInterface $node): XPathExpr |
| 129 | { |
| 130 | if (!isset($this->nodeTranslators[$node->getNodeName()])) { |
| 131 | throw new ExpressionErrorException(sprintf('Node "%s" not supported.', $node->getNodeName())); |
| 132 | } |
| 133 | return $this->nodeTranslators[$node->getNodeName()]($node, $this); |
| 134 | } |
| 135 | /** |
| 136 | * @throws ExpressionErrorException |
| 137 | */ |
| 138 | public function addCombination(string $combiner, NodeInterface $xpath, NodeInterface $combinedXpath): XPathExpr |
| 139 | { |
| 140 | if (!isset($this->combinationTranslators[$combiner])) { |
| 141 | throw new ExpressionErrorException(sprintf('Combiner "%s" not supported.', $combiner)); |
| 142 | } |
| 143 | return $this->combinationTranslators[$combiner]($this->nodeToXPath($xpath), $this->nodeToXPath($combinedXpath)); |
| 144 | } |
| 145 | /** |
| 146 | * @throws ExpressionErrorException |
| 147 | */ |
| 148 | public function addFunction(XPathExpr $xpath, FunctionNode $function): XPathExpr |
| 149 | { |
| 150 | if (!isset($this->functionTranslators[$function->getName()])) { |
| 151 | throw new ExpressionErrorException(sprintf('Function "%s" not supported.', $function->getName())); |
| 152 | } |
| 153 | return $this->functionTranslators[$function->getName()]($xpath, $function); |
| 154 | } |
| 155 | /** |
| 156 | * @throws ExpressionErrorException |
| 157 | */ |
| 158 | public function addPseudoClass(XPathExpr $xpath, string $pseudoClass): XPathExpr |
| 159 | { |
| 160 | if (!isset($this->pseudoClassTranslators[$pseudoClass])) { |
| 161 | throw new ExpressionErrorException(sprintf('Pseudo-class "%s" not supported.', $pseudoClass)); |
| 162 | } |
| 163 | return $this->pseudoClassTranslators[$pseudoClass]($xpath); |
| 164 | } |
| 165 | /** |
| 166 | * @throws ExpressionErrorException |
| 167 | */ |
| 168 | public function addAttributeMatching(XPathExpr $xpath, string $operator, string $attribute, ?string $value): XPathExpr |
| 169 | { |
| 170 | if (!isset($this->attributeMatchingTranslators[$operator])) { |
| 171 | throw new ExpressionErrorException(sprintf('Attribute matcher operator "%s" not supported.', $operator)); |
| 172 | } |
| 173 | return $this->attributeMatchingTranslators[$operator]($xpath, $attribute, $value); |
| 174 | } |
| 175 | /** |
| 176 | * @return SelectorNode[] |
| 177 | */ |
| 178 | private function parseSelectors(string $css): array |
| 179 | { |
| 180 | foreach ($this->shortcutParsers as $shortcut) { |
| 181 | $tokens = $shortcut->parse($css); |
| 182 | if (!empty($tokens)) { |
| 183 | return $tokens; |
| 184 | } |
| 185 | } |
| 186 | return $this->mainParser->parse($css); |
| 187 | } |
| 188 | } |
| 189 |