vendor/shopware/platform/src/Core/Framework/Util/HtmlSanitizer.php line 56

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.     public function __construct(
  25.         ?string $cacheDir = null,
  26.         bool $cacheEnabled = true,
  27.         array $sets = [],
  28.         array $fieldSets = []
  29.     ) {
  30.         $this->cacheDir = (string) $cacheDir;
  31.         $this->cacheEnabled = $cacheEnabled;
  32.         $this->sets = $sets;
  33.         $this->fieldSets = $fieldSets;
  34.     }
  36.     public function sanitize(string $text, ?array $options = [], bool $override = false, ?string $field = null): string
  37.     {
  38.         $options = $options ?? [];
  40.         $hash = md5(sprintf('%s%s', (string) json_encode($options), (string) $field));
  42.         if ($override) {
  43.             $hash .= '-override';
  44.         }
  46.         $textKey = $hash . md5($text);
  47.         if (isset($this->cache[$textKey])) {
  48.             return $this->cache[$textKey];
  49.         }
  51.         if (!isset($this->purifiers[$hash])) {
  52.             $config = $this->getConfig($options, $override, $field);
  53.             $this->purifiers[$hash] = new \HTMLPurifier($config);
  54.         }
  56.         $this->cache[$textKey] = $this->purifiers[$hash]->purify($text);
  58.         return $this->cache[$textKey];
  59.     }
  61.     private function getBaseConfig(): \HTMLPurifier_Config
  62.     {
  63.         $config = \HTMLPurifier_Config::createDefault();
  65.         if ($this->cacheDir !== '') {
  66.             $config->set('Cache.SerializerPath', $this->cacheDir);
  67.         }
  69.         if (!$this->cacheEnabled) {
  70.             $config->set('Cache.DefinitionImpl', null);
  71.         }
  73.         $config->set('Cache.SerializerPermissions', 0775 & ~umask());
  75.         return $config;
  76.     }
  78.     private function getConfig(array $options, bool $override, ?string $field): \HTMLPurifier_Config
  79.     {
  80.         $config = $this->getBaseConfig();
  82.         $allowedElements = [];
  83.         $allowedAttributes = [];
  85.         foreach ($options as $element => $attributes) {
  86.             if ($element !== '*') {
  87.                 $allowedElements[] = $element;
  88.             }
  90.             foreach ($attributes as $attr) {
  91.                 $allowedAttributes[] = $element === '*' ? $attr : "{$element}.{$attr}";
  92.             }
  93.         }
  95.         if (!$override) {
  96.             $sets = $this->fieldSets[$field]['sets'] ?? ['basic'];
  98.             foreach ($sets as $set) {
  99.                 if (isset($this->sets[$set]['tags'])) {
  100.                     $allowedElements = array_merge($allowedElements, $this->sets[$set]['tags']);
  101.                 }
  102.                 if (isset($this->sets[$set]['attributes'])) {
  103.                     $allowedAttributes = array_merge($allowedAttributes, $this->sets[$set]['attributes']);
  104.                 }
  105.                 if (isset($this->sets[$set]['options'])) {
  106.                     foreach ($this->sets[$set]['options'] as $key => $value) {
  107.                         $config->set($key, $value);
  108.                     }
  109.                 }
  110.             }
  111.         }
  113.         $config->set('HTML.AllowedElements', $allowedElements);
  114.         $config->set('HTML.AllowedAttributes', $allowedAttributes);
  116.         return $config;
  117.     }
  118. }