forked from TYPO3/html-sanitizer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CommonBuilder.php
190 lines (173 loc) · 7.41 KB
/
CommonBuilder.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 project.
*
* It is free software; you can redistribute it and/or modify it under the terms
* of the MIT License (MIT). For the full copyright and license information,
* please read the LICENSE file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\HtmlSanitizer\Builder;
use TYPO3\HtmlSanitizer\Behavior;
use TYPO3\HtmlSanitizer\Sanitizer;
use TYPO3\HtmlSanitizer\Visitor\CommonVisitor;
/**
* Builder, creating a `Sanitizer` instance with "common"
* behavior for tags, attributes and values.
*/
class CommonBuilder implements BuilderInterface
{
/**
* @var Behavior\Attr[]
*/
protected $globalAttrs;
/**
* @var Behavior\Attr
*/
protected $srcAttr;
/**
* @var Behavior\Attr
*/
protected $srcsetAttr;
/**
* @var Behavior\Attr
*/
protected $hrefAttr;
public function __construct()
{
// + starting with `http://` or `https://`
// + starting with `/` but, not starting with `//`
// + not starting with `/` and not having `:` at all
$isHttpOrLocalUri = new Behavior\RegExpAttrValue('#^(https?://|/(?!/)|[^/:][^:]*$)#');
// + starting with `mailto:`
$isMailtoUri = new Behavior\RegExpAttrValue('#^mailto:#');
$this->globalAttrs = $this->createGlobalAttrs();
$this->srcAttr = (new Behavior\Attr('src', Behavior\Attr::MATCH_FIRST_VALUE))
// @todo consider adding `data:` check
->addValues($isHttpOrLocalUri);
$this->srcsetAttr = (new Behavior\Attr('srcset', Behavior\Attr::MATCH_FIRST_VALUE))
// @todo consider adding `data:` check
// @todo Add test for `srcset="media.png 1080w"`
->addValues($isHttpOrLocalUri);
$this->hrefAttr = (new Behavior\Attr('href', Behavior\Attr::MATCH_FIRST_VALUE))
->addValues($isHttpOrLocalUri, $isMailtoUri);
}
public function build(): Sanitizer
{
$behavior = $this->createBehavior();
$visitor = new CommonVisitor($behavior);
return new Sanitizer($visitor);
}
protected function createBehavior(): Behavior
{
return (new Behavior())
->withFlags(Behavior::ENCODE_INVALID_TAG + Behavior::REMOVE_UNEXPECTED_CHILDREN)
->withName('common')
->withTags(...array_values($this->createBasicTags()))
->withTags(...array_values($this->createMediaTags()));
}
protected function createBasicTags(): array
{
$names = [
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#content_sectioning
'address', 'article', 'aside', 'footer', 'header',
'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'main', 'nav', 'section',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#text_content
'blockquote', 'dd', 'div', 'dl', 'dt', 'figcaption', 'li', 'ol', 'p', 'pre', 'ul',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#inline_text_semantics
'a', 'abbr', 'b', 'bdi', 'bdo', 'cite', 'code', 'data', 'dfn', 'em', 'i', 'kbd', 'mark',
'q', 'rb', 'rp', 'rt', 'rtc', 'ruby', 's', 'samp', 'small', 'span', 'strong', 'sub', 'sup',
'time', 'u', 'var', 'wbr',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#demarcating_edits
'del', 'ins',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#table_content
'caption', 'col', 'colgroup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#forms
'button', 'datalist', 'label', 'legend', 'meter', 'output', 'progress',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#interactive_elements
'details', 'dialog', 'menu', 'summary',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#web_components
// 'slot', 'template',
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#obsolete_and_deprecated_elements
'acronym', 'big', 'nobr', 'tt',
];
$tags = [];
foreach ($names as $name) {
$tags[$name] = (new Behavior\Tag($name, Behavior\Tag::ALLOW_CHILDREN))
->addAttrs(...$this->globalAttrs);
}
$tags['a']->addAttrs(
$this->hrefAttr,
...$this->createAttrs('hreflang', 'rel', 'referrerpolicy', 'target', 'type')
);
$tags['br'] = (new Behavior\Tag('br'))->addAttrs(...$this->globalAttrs);
$tags['hr'] = (new Behavior\Tag('hr'))->addAttrs(...$this->globalAttrs);
$tags['label']->addAttrs(...$this->createAttrs('for'));
$tags['td']->addAttrs(...$this->createAttrs('colspan', 'rowspan', 'scope'));
$tags['th']->addAttrs(...$this->createAttrs('colspan', 'rowspan', 'scope'));
return $tags;
}
protected function createMediaTags(): array
{
$tags = [];
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#image_and_multimedia
$tags[] = (new Behavior\Tag('audio', Behavior\Tag::ALLOW_CHILDREN))
->addAttrs($this->srcAttr, ...$this->globalAttrs)
->addAttrs(...$this->createAttrs('autoplay', 'controls', 'loop', 'muted', 'preload'));
$tags[] = (new Behavior\Tag('video', Behavior\Tag::ALLOW_CHILDREN))
->addAttrs($this->srcAttr, ...$this->globalAttrs)
->addAttrs(...$this->createAttrs('autoplay', 'controls', 'height', 'loop', 'muted', 'playsinline', 'poster', 'preload', 'width'));
$tags[] = (new Behavior\Tag('img', Behavior\Tag::PURGE_WITHOUT_ATTRS))
->addAttrs($this->srcAttr, $this->srcsetAttr, ...$this->globalAttrs)
->addAttrs(...$this->createAttrs('alt', 'decoding', 'height', 'sizes', 'width'));
$tags[] = (new Behavior\Tag('track', Behavior\Tag::PURGE_WITHOUT_ATTRS))
->addAttrs($this->srcAttr, ...$this->globalAttrs)
->addAttrs(...$this->createAttrs('default', 'kind', 'label', 'srcLang'));
// https://developer.mozilla.org/en-US/docs/Web/HTML/Element#embedded_content
$tags[] = (new Behavior\Tag('picture', Behavior\Tag::ALLOW_CHILDREN))->addAttrs(...$this->globalAttrs);
$tags[] = (new Behavior\Tag('source'))->addAttrs(...$this->globalAttrs);
return $tags;
}
/**
* @return Behavior\Attr[]
*/
protected function createGlobalAttrs(): array
{
// https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes
$attrs = $this->createAttrs(
'class',
'id',
'dir',
'lang',
'nonce',
'xml:lang',
'itemid',
'itemprop',
'itemref',
'itemscope',
'itemtype',
'role',
'tabindex',
'title',
'translate'
);
$attrs[] = new Behavior\Attr('aria-', Behavior\Attr::NAME_PREFIX);
$attrs[] = new Behavior\Attr('data-', Behavior\Attr::NAME_PREFIX);
return $attrs;
}
/**
* @param string ...$names
* @return Behavior\Attr[]
*/
protected function createAttrs(string ...$names): array
{
return array_map(
function (string $name) {
return new Behavior\Attr($name);
},
$names
);
}
}