Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
95.12%
39 / 41
71.43%
5 / 7
 CRAP
0.00%
0 / 1
SafeHtml
95.12%
39 / 41
71.43%
5 / 7
 10
0.00%
0 / 1
 getHtmlSanitizer
100.00%
23 / 23
100.00%
1 / 1
 2
 createRandom
100.00%
8 / 8
100.00%
1 / 1
 2
 provideIndexes
100.00%
1 / 1
100.00%
1 / 1
 1
 validate
100.00%
2 / 2
100.00%
1 / 1
 2
 convert
100.00%
5 / 5
100.00%
1 / 1
 1
 minStringLength
0.00%
0 / 1
0.00%
0 / 1
 2
 maxStringLength
0.00%
0 / 1
0.00%
0 / 1
 2
1<?php
2namespace Apie\CommonValueObjects;
3
4use Apie\CommonValueObjects\Bridge\Symfony\AllowedCssInSpanSanitizer;
5use Apie\CommonValueObjects\Bridge\Symfony\YoutubeNoCookieSanitizer;
6use Apie\Core\Attributes\CmsSingleInput;
7use Apie\Core\Attributes\FakeMethod;
8use Apie\Core\Attributes\ProvideIndex;
9use Apie\Core\ValueObjects\Exceptions\InvalidStringForValueObjectException;
10use Apie\Core\ValueObjects\Interfaces\LengthConstraintStringValueObjectInterface;
11use Apie\Core\ValueObjects\Interfaces\StringValueObjectInterface;
12use Apie\Core\ValueObjects\IsStringValueObject;
13use Apie\CountWords\WordCounter;
14use Faker\Generator;
15use ReflectionClass;
16use Symfony\Component\HtmlSanitizer\HtmlSanitizer;
17use Symfony\Component\HtmlSanitizer\HtmlSanitizerConfig;
18
19#[FakeMethod('createRandom')]
20#[ProvideIndex('provideIndexes')]
21#[CmsSingleInput(['html'])]
22final class SafeHtml implements StringValueObjectInterface, LengthConstraintStringValueObjectInterface
23{
24    use IsStringValueObject;
25
26    private static HtmlSanitizer $htmlSanitizer;
27
28    private static function getHtmlSanitizer(): HtmlSanitizer
29    {
30        if (!isset(self::$htmlSanitizer)) {
31            $config = (new HtmlSanitizerConfig())
32                ->allowSafeElements()
33                ->allowElement('b')
34                ->allowElement('i')
35                ->dropAttribute('id', [])
36                ->forceAttribute('a', 'rel', 'noopener noreferrer')
37                ->forceAttribute('a', 'target', '_blank')
38                ->allowLinkSchemes(['https', 'http', 'mailto'])
39                ->allowRelativeLinks(false)
40                ->withMaxInputLength(1024 * 1024 * 21) // character limit is 20mb, but could be truncated
41                ->dropElement('html')
42                ->dropElement('head')
43                ->dropElement('script')
44                ->dropElement('style')
45                ->allowAttribute('style', 'span')
46                ->withAttributeSanitizer(new YoutubeNoCookieSanitizer())
47                ->allowElement('iframe', ['src', 'referrerpolicy', 'width', 'title', 'height', 'frameborder', 'allowfullscreen', 'allow'])
48                ->withAttributeSanitizer(new AllowedCssInSpanSanitizer());
49            self::$htmlSanitizer = new HtmlSanitizer(
50                $config
51            );
52        }
53
54        return self::$htmlSanitizer;
55    }
56
57    public static function createRandom(Generator $factory): self
58    {
59        $randomHtmls = ['div', 'h1', 'h2', 'h3', 'p'];
60        $string = '<div>';
61        $counter = $factory->numberBetween(1, 3);
62        for ($i = 0; $i < $counter; $i++) {
63            $tag = $factory->randomElement($randomHtmls);
64            $string .= '<' . $tag . '>' . $factory->text(50) . '</' . $tag . '>';
65        }
66        $string .= '</div>';
67        return new self($string);
68    }
69
70    /**
71     * @return array<string, int>
72     */
73    public function provideIndexes(): array
74    {
75        return WordCounter::countFromString(strip_tags(str_replace('<', ' <', $this->internal)));
76    }
77
78    public static function validate(string $input): void
79    {
80        if (strlen($input) > (1024 * 1024 * 20)) {
81            throw new InvalidStringForValueObjectException($input, new ReflectionClass(__CLASS__));
82        }
83    }
84
85    protected function convert(string $input): string
86    {
87        return str_replace(
88            ' ',
89            '&nbsp;',
90            self::getHtmlSanitizer()->sanitizeFor('body', $input)
91        );
92    }
93
94    public static function minStringLength(): int
95    {
96        return 0;
97    }
98
99    public static function maxStringLength(): int
100    {
101        return 1024 * 1024 * 20;
102    }
103}