Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\CssSelector\XPath;
Chris@0: 
Chris@0: use Symfony\Component\CssSelector\Exception\ExpressionErrorException;
Chris@0: use Symfony\Component\CssSelector\Node\FunctionNode;
Chris@0: use Symfony\Component\CssSelector\Node\NodeInterface;
Chris@0: use Symfony\Component\CssSelector\Node\SelectorNode;
Chris@0: use Symfony\Component\CssSelector\Parser\Parser;
Chris@0: use Symfony\Component\CssSelector\Parser\ParserInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * XPath expression translator interface.
Chris@0:  *
Chris@0:  * This component is a port of the Python cssselect library,
Chris@0:  * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect.
Chris@0:  *
Chris@0:  * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
Chris@0:  *
Chris@0:  * @internal
Chris@0:  */
Chris@0: class Translator implements TranslatorInterface
Chris@0: {
Chris@0:     private $mainParser;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var ParserInterface[]
Chris@0:      */
Chris@17:     private $shortcutParsers = [];
Chris@0: 
Chris@0:     /**
Chris@14:      * @var Extension\ExtensionInterface[]
Chris@0:      */
Chris@17:     private $extensions = [];
Chris@0: 
Chris@17:     private $nodeTranslators = [];
Chris@17:     private $combinationTranslators = [];
Chris@17:     private $functionTranslators = [];
Chris@17:     private $pseudoClassTranslators = [];
Chris@17:     private $attributeMatchingTranslators = [];
Chris@0: 
Chris@0:     public function __construct(ParserInterface $parser = null)
Chris@0:     {
Chris@0:         $this->mainParser = $parser ?: new Parser();
Chris@0: 
Chris@0:         $this
Chris@0:             ->registerExtension(new Extension\NodeExtension())
Chris@0:             ->registerExtension(new Extension\CombinationExtension())
Chris@0:             ->registerExtension(new Extension\FunctionExtension())
Chris@0:             ->registerExtension(new Extension\PseudoClassExtension())
Chris@0:             ->registerExtension(new Extension\AttributeMatchingExtension())
Chris@0:         ;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $element
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public static function getXpathLiteral($element)
Chris@0:     {
Chris@0:         if (false === strpos($element, "'")) {
Chris@0:             return "'".$element."'";
Chris@0:         }
Chris@0: 
Chris@0:         if (false === strpos($element, '"')) {
Chris@0:             return '"'.$element.'"';
Chris@0:         }
Chris@0: 
Chris@0:         $string = $element;
Chris@17:         $parts = [];
Chris@0:         while (true) {
Chris@0:             if (false !== $pos = strpos($string, "'")) {
Chris@0:                 $parts[] = sprintf("'%s'", substr($string, 0, $pos));
Chris@0:                 $parts[] = "\"'\"";
Chris@0:                 $string = substr($string, $pos + 1);
Chris@0:             } else {
Chris@0:                 $parts[] = "'$string'";
Chris@0:                 break;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@17:         return sprintf('concat(%s)', implode(', ', $parts));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function cssToXPath($cssExpr, $prefix = 'descendant-or-self::')
Chris@0:     {
Chris@0:         $selectors = $this->parseSelectors($cssExpr);
Chris@0: 
Chris@0:         /** @var SelectorNode $selector */
Chris@0:         foreach ($selectors as $index => $selector) {
Chris@0:             if (null !== $selector->getPseudoElement()) {
Chris@0:                 throw new ExpressionErrorException('Pseudo-elements are not supported.');
Chris@0:             }
Chris@0: 
Chris@0:             $selectors[$index] = $this->selectorToXPath($selector, $prefix);
Chris@0:         }
Chris@0: 
Chris@0:         return implode(' | ', $selectors);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function selectorToXPath(SelectorNode $selector, $prefix = 'descendant-or-self::')
Chris@0:     {
Chris@0:         return ($prefix ?: '').$this->nodeToXPath($selector);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Registers an extension.
Chris@0:      *
Chris@0:      * @return $this
Chris@0:      */
Chris@0:     public function registerExtension(Extension\ExtensionInterface $extension)
Chris@0:     {
Chris@0:         $this->extensions[$extension->getName()] = $extension;
Chris@0: 
Chris@0:         $this->nodeTranslators = array_merge($this->nodeTranslators, $extension->getNodeTranslators());
Chris@0:         $this->combinationTranslators = array_merge($this->combinationTranslators, $extension->getCombinationTranslators());
Chris@0:         $this->functionTranslators = array_merge($this->functionTranslators, $extension->getFunctionTranslators());
Chris@0:         $this->pseudoClassTranslators = array_merge($this->pseudoClassTranslators, $extension->getPseudoClassTranslators());
Chris@0:         $this->attributeMatchingTranslators = array_merge($this->attributeMatchingTranslators, $extension->getAttributeMatchingTranslators());
Chris@0: 
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $name
Chris@0:      *
Chris@0:      * @return Extension\ExtensionInterface
Chris@0:      *
Chris@0:      * @throws ExpressionErrorException
Chris@0:      */
Chris@0:     public function getExtension($name)
Chris@0:     {
Chris@0:         if (!isset($this->extensions[$name])) {
Chris@0:             throw new ExpressionErrorException(sprintf('Extension "%s" not registered.', $name));
Chris@0:         }
Chris@0: 
Chris@0:         return $this->extensions[$name];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Registers a shortcut parser.
Chris@0:      *
Chris@0:      * @return $this
Chris@0:      */
Chris@0:     public function registerParserShortcut(ParserInterface $shortcut)
Chris@0:     {
Chris@0:         $this->shortcutParsers[] = $shortcut;
Chris@0: 
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return XPathExpr
Chris@0:      *
Chris@0:      * @throws ExpressionErrorException
Chris@0:      */
Chris@0:     public function nodeToXPath(NodeInterface $node)
Chris@0:     {
Chris@0:         if (!isset($this->nodeTranslators[$node->getNodeName()])) {
Chris@0:             throw new ExpressionErrorException(sprintf('Node "%s" not supported.', $node->getNodeName()));
Chris@0:         }
Chris@0: 
Chris@17:         return \call_user_func($this->nodeTranslators[$node->getNodeName()], $node, $this);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string        $combiner
Chris@0:      * @param NodeInterface $xpath
Chris@0:      * @param NodeInterface $combinedXpath
Chris@0:      *
Chris@0:      * @return XPathExpr
Chris@0:      *
Chris@0:      * @throws ExpressionErrorException
Chris@0:      */
Chris@0:     public function addCombination($combiner, NodeInterface $xpath, NodeInterface $combinedXpath)
Chris@0:     {
Chris@0:         if (!isset($this->combinationTranslators[$combiner])) {
Chris@0:             throw new ExpressionErrorException(sprintf('Combiner "%s" not supported.', $combiner));
Chris@0:         }
Chris@0: 
Chris@17:         return \call_user_func($this->combinationTranslators[$combiner], $this->nodeToXPath($xpath), $this->nodeToXPath($combinedXpath));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return XPathExpr
Chris@0:      *
Chris@0:      * @throws ExpressionErrorException
Chris@0:      */
Chris@0:     public function addFunction(XPathExpr $xpath, FunctionNode $function)
Chris@0:     {
Chris@0:         if (!isset($this->functionTranslators[$function->getName()])) {
Chris@0:             throw new ExpressionErrorException(sprintf('Function "%s" not supported.', $function->getName()));
Chris@0:         }
Chris@0: 
Chris@17:         return \call_user_func($this->functionTranslators[$function->getName()], $xpath, $function);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param XPathExpr $xpath
Chris@0:      * @param string    $pseudoClass
Chris@0:      *
Chris@0:      * @return XPathExpr
Chris@0:      *
Chris@0:      * @throws ExpressionErrorException
Chris@0:      */
Chris@0:     public function addPseudoClass(XPathExpr $xpath, $pseudoClass)
Chris@0:     {
Chris@0:         if (!isset($this->pseudoClassTranslators[$pseudoClass])) {
Chris@0:             throw new ExpressionErrorException(sprintf('Pseudo-class "%s" not supported.', $pseudoClass));
Chris@0:         }
Chris@0: 
Chris@17:         return \call_user_func($this->pseudoClassTranslators[$pseudoClass], $xpath);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param XPathExpr $xpath
Chris@0:      * @param string    $operator
Chris@0:      * @param string    $attribute
Chris@0:      * @param string    $value
Chris@0:      *
Chris@0:      * @return XPathExpr
Chris@0:      *
Chris@0:      * @throws ExpressionErrorException
Chris@0:      */
Chris@0:     public function addAttributeMatching(XPathExpr $xpath, $operator, $attribute, $value)
Chris@0:     {
Chris@0:         if (!isset($this->attributeMatchingTranslators[$operator])) {
Chris@0:             throw new ExpressionErrorException(sprintf('Attribute matcher operator "%s" not supported.', $operator));
Chris@0:         }
Chris@0: 
Chris@17:         return \call_user_func($this->attributeMatchingTranslators[$operator], $xpath, $attribute, $value);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $css
Chris@0:      *
Chris@0:      * @return SelectorNode[]
Chris@0:      */
Chris@0:     private function parseSelectors($css)
Chris@0:     {
Chris@0:         foreach ($this->shortcutParsers as $shortcut) {
Chris@0:             $tokens = $shortcut->parse($css);
Chris@0: 
Chris@0:             if (!empty($tokens)) {
Chris@0:                 return $tokens;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return $this->mainParser->parse($css);
Chris@0:     }
Chris@0: }