forked from TYPO3/html-sanitizer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Behavior.php
207 lines (181 loc) · 5.09 KB
/
Behavior.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?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;
use LogicException;
use TYPO3\HtmlSanitizer\Behavior\Tag;
/**
* Declares behavior used by node visitors
* (and any component used during sanitization)
*/
class Behavior
{
/**
* in case an unexpected tag was found, encode the whole tag as HTML
*/
public const ENCODE_INVALID_TAG = 1;
/**
* in case an unexpected attribute was found, encode the whole tag as HTML
*/
public const ENCODE_INVALID_ATTR = 2;
/**
* remove children at tags that did not expect children
*/
public const REMOVE_UNEXPECTED_CHILDREN = 4;
/**
* https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
* custom elements must contain a hyphen (`-`), start with ASCII lower alpha
*/
public const ALLOW_CUSTOM_ELEMENTS = 8;
/**
* @var int
*/
protected $flags = 0;
/**
* @var string
*/
protected $name = 'undefined';
/**
* Tag names as array index, e.g. `['strong' => new Tag('strong')]`
* @var array<string, Tag>
*/
protected $tags = [];
public function withFlags(int $flags): self
{
if ($flags === $this->flags) {
return $this;
}
$target = clone $this;
$target->flags = $flags;
return $target;
}
public function withName(string $name): self
{
if ($name === $this->name) {
return $this;
}
$target = clone $this;
$target->name = $name;
return $target;
}
public function withTags(Tag ...$tags): self
{
$names = array_map([$this, 'getTagName'], $tags);
$this->assertScalarUniqueness($names);
// uses tag name as array index, e.g. `['strong' => new Tag('strong')]`
$indexedTags = array_combine($names, $tags);
if (!is_array($indexedTags)) {
return $this;
}
$this->assertTagUniqueness($indexedTags);
$target = clone $this;
$target->tags = array_merge($target->tags, $indexedTags);
return $target;
}
public function withoutTags(Tag ...$tags): self
{
$filteredTags = array_filter(
$this->tags,
function (Tag $tag) use ($tags) {
return !in_array($tag, $tags, true);
}
);
if ($filteredTags === $this->tags) {
return $this;
}
$target = clone $this;
$target->tags = $filteredTags;
return $target;
}
/**
* @return int
*/
public function getFlags(): int
{
return $this->flags;
}
/**
* @return string
*/
public function getName(): string
{
return $this->name;
}
/**
* @return Tag[]
*/
public function getTags(): array
{
return $this->tags;
}
/**
* @param string $name
* @return Tag|null
*/
public function getTag(string $name): ?Tag
{
$name = strtolower($name);
return $this->tags[$name] ?? null;
}
public function shallEncodeInvalidTag(): bool
{
return ($this->flags & self::ENCODE_INVALID_TAG) === self::ENCODE_INVALID_TAG;
}
public function shallEncodeInvalidAttr(): bool
{
return ($this->flags & self::ENCODE_INVALID_ATTR) === self::ENCODE_INVALID_ATTR;
}
public function shallRemoveUnexpectedChildren(): bool
{
return ($this->flags & self::REMOVE_UNEXPECTED_CHILDREN) === self::REMOVE_UNEXPECTED_CHILDREN;
}
public function shallAllowCustomElements(): bool
{
return ($this->flags & self::ALLOW_CUSTOM_ELEMENTS) === self::ALLOW_CUSTOM_ELEMENTS;
}
/**
* @param string[] $names
* @throws LogicException
*/
protected function assertScalarUniqueness(array $names): void
{
$ambiguousNames = array_diff_assoc($names, array_unique($names));
if ($ambiguousNames !== []) {
throw new LogicException(
sprintf(
'Ambiguous tag names %s.',
implode(', ', $ambiguousNames)
),
1625591503
);
}
}
/**
* @param array<string, Tag> $tags
*/
protected function assertTagUniqueness(array $tags): void
{
$existingTagNames = array_intersect_key($this->tags, $tags);
if ($existingTagNames !== []) {
throw new LogicException(
sprintf(
'Cannot redeclare tag names %s. Remove duplicates first',
implode(', ', array_keys($existingTagNames))
),
1625391217
);
}
}
protected function getTagName(Tag $tag): string
{
return strtolower($tag->getName());
}
}