class.ilHtmlPurifierAbstractLibWrapper.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilHtmlPurifierAbstractLibWrapper implements ilHtmlPurifierInterface
{
    private const HTML_PURIFIER_DIRECTORY = '/HTMLPurifier';
    private const NOT_SUPPORTED_TAGS = [
        'rp',
        'rt',
        'rb',
        'rtc',
        'rbc',
        'ruby',
        'u',
        'strike',
        'param',
        'object'
    ];

    protected HTMLPurifier $purifier;

    public function __construct()
    {
        $this->setPurifier(
            new HTMLPurifier($this->getPurifierConfigInstance())
        );
    }

    final public function purify(string $html): string
    {
        return $this->purifier->purify($html);
    }

    final public function purifyArray(array $htmlCollection): array
    {
        foreach ($htmlCollection as $key => $html) {
            if (!is_string($html)) {
                throw new InvalidArgumentException(sprintf(
                    'The element on index %s is not of type string: %s',
                    $key,
                    print_r($html, true)
                ));
            }
        }

        return $this->purifier->purifyArray($htmlCollection);
    }

    abstract protected function getPurifierConfigInstance(): HTMLPurifier_Config;

    final protected function setPurifier(HTMLPurifier $purifier): self
    {
        $this->purifier = $purifier;
        return $this;
    }

    final protected function getPurifier(): HTMLPurifier
    {
        return $this->purifier;
    }

    final public static function _getCacheDirectory(): string
    {
        if (!is_dir(ilFileUtils::getDataDir() . self::HTML_PURIFIER_DIRECTORY)) {
            ilFileUtils::makeDirParents(ilFileUtils::getDataDir() . self::HTML_PURIFIER_DIRECTORY);
        }

        return ilFileUtils::getDataDir() . self::HTML_PURIFIER_DIRECTORY;
    }

    final protected function removeUnsupportedElements(array $elements): array
    {
        $supportedElements = [];

        foreach ($elements as $element) {
            if (!in_array($element, self::NOT_SUPPORTED_TAGS)) {
                $supportedElements[] = $element;
            }
        }

        return $supportedElements;
    }

    final protected function makeElementListTinyMceCompliant(array $elements): array
    {
        // Bugfix #5945: Necessary because TinyMCE does not use the "u"
        // html element but <span style="text-decoration: underline">E</span>

        if (in_array('u', $elements) && !in_array('span', $elements)) {
            $elements[] = 'span';
        }

        return $elements;
    }
}