vendor/shopware/core/Framework/Util/HtmlSanitizer.php line 59

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Shopware\Core\Framework\Util;
  7. class HtmlSanitizer
  8. {
  9.     /**
  10.      * @var \HTMLPurifier[]
  11.      */
  12.     private array $purifiers = [];
  14.     private string $cacheDir;
  16.     private bool $cacheEnabled;
  18.     private array $sets;
  20.     private array $fieldSets;
  22.     private array $cache = [];
  24.     /**
  25.      * @internal
  26.      */
  27.     public function __construct(
  28.         ?string $cacheDir = null,
  29.         bool $cacheEnabled = true,
  30.         array $sets = [],
  31.         array $fieldSets = []
  32.     ) {
  33.         $this->cacheDir = (string) $cacheDir;
  34.         $this->cacheEnabled = $cacheEnabled;
  35.         $this->sets = $sets;
  36.         $this->fieldSets = $fieldSets;
  37.     }
  39.     public function sanitize(string $text, ?array $options = [], bool $override = false, ?string $field = null): string
  40.     {
  41.         $options = $options ?? [];
  43.         $hash = md5(sprintf('%s%s', (string) json_encode($options), (string) $field));
  45.         if ($override) {
  46.             $hash .= '-override';
  47.         }
  49.         $textKey = $hash . md5($text);
  50.         if (isset($this->cache[$textKey])) {
  51.             return $this->cache[$textKey];
  52.         }
  54.         if (!isset($this->purifiers[$hash])) {
  55.             $config = $this->getConfig($options, $override, $field);
  56.             $this->purifiers[$hash] = new \HTMLPurifier($config);
  57.         }
  59.         $this->cache[$textKey] = $this->purifiers[$hash]->purify($text);
  61.         return $this->cache[$textKey];
  62.     }
  64.     private function getBaseConfig(): \HTMLPurifier_Config
  65.     {
  66.         $config = \HTMLPurifier_Config::createDefault();
  68.         if ($this->cacheDir !== '') {
  69.             $config->set('Cache.SerializerPath', $this->cacheDir);
  70.         }
  72.         if (!$this->cacheEnabled) {
  73.             $config->set('Cache.DefinitionImpl', null);
  74.         }
  76.         $config->set('Cache.SerializerPermissions', 0775 & ~umask());
  78.         return $config;
  79.     }
  81.     private function getConfig(array $options, bool $override, ?string $field): \HTMLPurifier_Config
  82.     {
  83.         $config = $this->getBaseConfig();
  85.         $allowedElements = [];
  86.         $allowedAttributes = [];
  88.         foreach ($options as $element => $attributes) {
  89.             if ($element !== '*') {
  90.                 $allowedElements[] = $element;
  91.             }
  93.             foreach ($attributes as $attr) {
  94.                 $allowedAttributes[] = $element === '*' ? $attr : "{$element}.{$attr}";
  95.             }
  96.         }
  98.         if (!$override) {
  99.             $sets = $this->fieldSets[$field]['sets'] ?? ['basic'];
  101.             foreach ($sets as $set) {
  102.                 if (isset($this->sets[$set]['tags'])) {
  103.                     $allowedElements = array_merge($allowedElements, $this->sets[$set]['tags']);
  104.                 }
  105.                 if (isset($this->sets[$set]['attributes'])) {
  106.                     $allowedAttributes = array_merge($allowedAttributes, $this->sets[$set]['attributes']);
  107.                 }
  108.                 if (isset($this->sets[$set]['options'])) {
  109.                     foreach ($this->sets[$set]['options'] as $key => $value) {
  110.                         $config->set($key, $value);
  111.                     }
  112.                 }
  113.             }
  114.         }
  116.         $config->set('HTML.AllowedElements', $allowedElements);
  117.         $config->set('HTML.AllowedAttributes', $allowedAttributes);
  119.         return $config;
  120.     }
  121. }