vendor/twig/twig/src/Extension/EscaperExtension.php line 172

  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Twig\Extension;
  14. use Twig\Environment;
  15. use Twig\FileExtensionEscapingStrategy;
  16. use Twig\Node\Expression\ConstantExpression;
  17. use Twig\Node\Node;
  18. use Twig\NodeVisitor\EscaperNodeVisitor;
  19. use Twig\Runtime\EscaperRuntime;
  20. use Twig\TokenParser\AutoEscapeTokenParser;
  21. use Twig\TwigFilter;
  23. final class EscaperExtension extends AbstractExtension
  24. {
  25.     private $environment;
  26.     private $escapers = [];
  27.     private $escaper;
  28.     private $defaultStrategy;
  30.     /**
  31.      * @param string|false|callable $defaultStrategy An escaping strategy
  32.      *
  33.      * @see setDefaultStrategy()
  34.      */
  35.     public function __construct($defaultStrategy = 'html')
  36.     {
  37.         $this->setDefaultStrategy($defaultStrategy);
  38.     }
  40.     public function getTokenParsers(): array
  41.     {
  42.         return [new AutoEscapeTokenParser()];
  43.     }
  45.     public function getNodeVisitors(): array
  46.     {
  47.         return [new EscaperNodeVisitor()];
  48.     }
  50.     public function getFilters(): array
  51.     {
  52.         return [
  53.             new TwigFilter('escape', [EscaperRuntime::class, 'escape'], ['is_safe_callback' => [self::class, 'escapeFilterIsSafe']]),
  54.             new TwigFilter('e', [EscaperRuntime::class, 'escape'], ['is_safe_callback' => [self::class, 'escapeFilterIsSafe']]),
  55.             new TwigFilter('raw', [self::class, 'raw'], ['is_safe' => ['all']]),
  56.         ];
  57.     }
  59.     /**
  60.      * @deprecated since Twig 3.10
  61.      */
  62.     public function setEnvironment(Environment $environment, bool $triggerDeprecation = true): void
  63.     {
  64.         if ($triggerDeprecation) {
  65.             trigger_deprecation('twig/twig', '3.10', 'The "%s()" method is deprecated and not needed if you are using methods from "Twig\Runtime\EscaperRuntime".', __METHOD__);
  66.         }
  68.         $this->environment = $environment;
  69.         $this->escaper = $environment->getRuntime(EscaperRuntime::class);
  70.     }
  72.     /**
  73.      * @deprecated since Twig 3.10
  74.      */
  75.     public function setEscaperRuntime(EscaperRuntime $escaper)
  76.     {
  77.         trigger_deprecation('twig/twig', '3.10', 'The "%s()" method is deprecated and not needed if you are using methods from "Twig\Runtime\EscaperRuntime".', __METHOD__);
  79.         $this->escaper = $escaper;
  80.     }
  82.     /**
  83.      * Sets the default strategy to use when not defined by the user.
  84.      *
  85.      * The strategy can be a valid PHP callback that takes the template
  86.      * name as an argument and returns the strategy to use.
  87.      *
  88.      * @param string|false|callable(string $templateName): string $defaultStrategy An escaping strategy
  89.      */
  90.     public function setDefaultStrategy($defaultStrategy): void
  91.     {
  92.         if ('name' === $defaultStrategy) {
  93.             $defaultStrategy = [FileExtensionEscapingStrategy::class, 'guess'];
  94.         }
  96.         $this->defaultStrategy = $defaultStrategy;
  97.     }
  99.     /**
  100.      * Gets the default strategy to use when not defined by the user.
  101.      *
  102.      * @param string $name The template name
  103.      *
  104.      * @return string|false The default strategy to use for the template
  105.      */
  106.     public function getDefaultStrategy(string $name)
  107.     {
  108.         // disable string callables to avoid calling a function named html or js,
  109.         // or any other upcoming escaping strategy
  110.         if (!\is_string($this->defaultStrategy) && false !== $this->defaultStrategy) {
  111.             return \call_user_func($this->defaultStrategy, $name);
  112.         }
  114.         return $this->defaultStrategy;
  115.     }
  117.     /**
  118.      * Defines a new escaper to be used via the escape filter.
  119.      *
  120.      * @param string                                $strategy The strategy name that should be used as a strategy in the escape call
  121.      * @param callable(Environment, string, string) $callable A valid PHP callable
  122.      *
  123.      * @deprecated since Twig 3.10
  124.      */
  125.     public function setEscaper($strategy, callable $callable)
  126.     {
  127.         trigger_deprecation('twig/twig', '3.10', 'The "%s()" method is deprecated, use the "Twig\Runtime\EscaperRuntime::setEscaper()" method instead (be warned that Environment is not passed anymore to the callable).', __METHOD__);
  129.         if (!isset($this->environment)) {
  130.             throw new \LogicException(sprintf('You must call "setEnvironment()" before calling "%s()".', __METHOD__));
  131.         }
  133.         $this->escapers[$strategy] = $callable;
  134.         $callable = function ($string, $charset) use ($callable) {
  135.             return $callable($this->environment, $string, $charset);
  136.         };
  138.         $this->escaper->setEscaper($strategy, $callable);
  139.     }
  141.     /**
  142.      * Gets all defined escapers.
  143.      *
  144.      * @return array<callable(Environment, string, string)> An array of escapers
  145.      *
  146.      * @deprecated since Twig 3.10
  147.      */
  148.     public function getEscapers()
  149.     {
  150.         trigger_deprecation('twig/twig', '3.10', 'The "%s()" method is deprecated, use the "Twig\Runtime\EscaperRuntime::getEscaper()" method instead.', __METHOD__);
  152.         return $this->escapers;
  153.     }
  155.     /**
  156.      * @deprecated since Twig 3.10
  157.      */
  158.     public function setSafeClasses(array $safeClasses = [])
  159.     {
  160.         trigger_deprecation('twig/twig', '3.10', 'The "%s()" method is deprecated, use the "Twig\Runtime\EscaperRuntime::setSafeClasses()" method instead.', __METHOD__);
  162.         if (!isset($this->escaper)) {
  163.             throw new \LogicException(sprintf('You must call "setEnvironment()" before calling "%s()".', __METHOD__));
  164.         }
  166.         $this->escaper->setSafeClasses($safeClasses);
  167.     }
  169.     /**
  170.      * @deprecated since Twig 3.10
  171.      */
  172.     public function addSafeClass(string $class, array $strategies)
  173.     {
  174.         trigger_deprecation('twig/twig', '3.10', 'The "%s()" method is deprecated, use the "Twig\Runtime\EscaperRuntime::addSafeClass()" method instead.', __METHOD__);
  176.         if (!isset($this->escaper)) {
  177.             throw new \LogicException(sprintf('You must call "setEnvironment()" before calling "%s()".', __METHOD__));
  178.         }
  180.         $this->escaper->addSafeClass($class, $strategies);
  181.     }
  183.     /**
  184.      * Marks a variable as being safe.
  185.      *
  186.      * @param string $string A PHP variable
  187.      *
  188.      * @internal
  189.      */
  190.     public static function raw($string)
  191.     {
  192.         return $string;
  193.     }
  195.     /**
  196.      * @internal
  197.      */
  198.     public static function escapeFilterIsSafe(Node $filterArgs)
  199.     {
  200.         foreach ($filterArgs as $arg) {
  201.             if ($arg instanceof ConstantExpression) {
  202.                 return [$arg->getAttribute('value')];
  203.             }
  205.             return [];
  206.         }
  208.         return ['html'];
  209.     }
  210. }