forked from magento-arcticfoxes/php72-framwork
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathEscaper.php
349 lines (325 loc) · 9.96 KB
/
Escaper.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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework;
/**
* Magento escape methods
*
* @api
*/
class Escaper
{
/**
* @var \Magento\Framework\ZendEscaper
*/
private $escaper;
/**
* @var \Psr\Log\LoggerInterface
*/
private $logger;
/**
* @var string[]
*/
private $notAllowedTags = ['script', 'img', 'embed', 'iframe', 'video', 'source', 'object', 'audio'];
/**
* @var string[]
*/
private $allowedAttributes = ['id', 'class', 'href', 'target', 'title', 'style'];
/**
* @var string[]
*/
private $escapeAsUrlAttributes = ['href'];
/**
* Escape string for HTML context. allowedTags will not be escaped, except the following: script, img, embed,
* iframe, video, source, object, audio
*
* @param string|array $data
* @param array|null $allowedTags
* @return string|array
*/
public function escapeHtml($data, $allowedTags = null)
{
if (is_array($data)) {
$result = [];
foreach ($data as $item) {
$result[] = $this->escapeHtml($item, $allowedTags);
}
} elseif (strlen($data)) {
if (is_array($allowedTags) && !empty($allowedTags)) {
$notAllowedTags = array_intersect(
array_map('strtolower', $allowedTags),
$this->notAllowedTags
);
if (!empty($notAllowedTags)) {
$this->getLogger()->critical(
'The following tag(s) are not allowed: ' . implode(', ', $notAllowedTags)
);
$allowedTags = array_diff($allowedTags, $this->notAllowedTags);
}
$wrapperElementId = uniqid();
$domDocument = new \DOMDocument('1.0', 'UTF-8');
set_error_handler(
function ($errorNumber, $errorString) {
throw new \Exception($errorString, $errorNumber);
}
);
$string = mb_convert_encoding($data, 'HTML-ENTITIES', 'UTF-8');
try {
$domDocument->loadHTML(
'<html><body id="' . $wrapperElementId . '">' . $string . '</body></html>'
);
} catch (\Exception $e) {
restore_error_handler();
$this->getLogger()->critical($e);
}
restore_error_handler();
$this->removeNotAllowedTags($domDocument, $allowedTags);
$this->removeNotAllowedAttributes($domDocument);
$this->escapeText($domDocument);
$this->escapeAttributeValues($domDocument);
$result = mb_convert_encoding($domDocument->saveHTML(), 'UTF-8', 'HTML-ENTITIES');
preg_match('/<body id="' . $wrapperElementId . '">(.+)<\/body><\/html>$/si', $result, $matches);
return !empty($matches) ? $matches[1] : '';
} else {
$result = htmlspecialchars($data, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8', false);
}
} else {
$result = $data;
}
return $result;
}
/**
* Remove not allowed tags
*
* @param \DOMDocument $domDocument
* @param string[] $allowedTags
* @return void
*/
private function removeNotAllowedTags(\DOMDocument $domDocument, array $allowedTags)
{
$xpath = new \DOMXPath($domDocument);
$nodes = $xpath->query(
'//node()[name() != \''
. implode('\' and name() != \'', array_merge($allowedTags, ['html', 'body']))
. '\']'
);
foreach ($nodes as $node) {
if ($node->nodeName != '#text' && $node->nodeName != '#comment') {
$node->parentNode->replaceChild($domDocument->createTextNode($node->textContent), $node);
}
}
}
/**
* Remove not allowed attributes
*
* @param \DOMDocument $domDocument
* @return void
*/
private function removeNotAllowedAttributes(\DOMDocument $domDocument)
{
$xpath = new \DOMXPath($domDocument);
$nodes = $xpath->query(
'//@*[name() != \'' . implode('\' and name() != \'', $this->allowedAttributes) . '\']'
);
foreach ($nodes as $node) {
$node->parentNode->removeAttribute($node->nodeName);
}
}
/**
* Escape text
*
* @param \DOMDocument $domDocument
* @return void
*/
private function escapeText(\DOMDocument $domDocument)
{
$xpath = new \DOMXPath($domDocument);
$nodes = $xpath->query('//text()');
foreach ($nodes as $node) {
$node->textContent = $this->escapeHtml($node->textContent);
}
}
/**
* Escape attribute values
*
* @param \DOMDocument $domDocument
* @return void
*/
private function escapeAttributeValues(\DOMDocument $domDocument)
{
$xpath = new \DOMXPath($domDocument);
$nodes = $xpath->query('//@*');
foreach ($nodes as $node) {
$value = $this->escapeAttributeValue(
$node->nodeName,
$node->parentNode->getAttribute($node->nodeName)
);
$node->parentNode->setAttribute($node->nodeName, $value);
}
}
/**
* Escape attribute value using escapeHtml or escapeUrl
*
* @param string $name
* @param string $value
* @return string
*/
private function escapeAttributeValue($name, $value)
{
return in_array($name, $this->escapeAsUrlAttributes) ? $this->escapeUrl($value) : $this->escapeHtml($value);
}
/**
* Escape a string for the HTML attribute context
*
* @param string $string
* @param boolean $escapeSingleQuote
* @return string
* @since 100.2.0
*/
public function escapeHtmlAttr($string, $escapeSingleQuote = true)
{
if ($escapeSingleQuote) {
return $this->getEscaper()->escapeHtmlAttr((string) $string);
}
return htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false);
}
/**
* Escape URL
*
* @param string $string
* @return string
*/
public function escapeUrl($string)
{
return $this->escapeHtml($this->escapeXssInUrl($string));
}
/**
* Encode URL
*
* @param string $string
* @return string
* @since 100.2.0
*/
public function encodeUrlParam($string)
{
return $this->getEscaper()->escapeUrl($string);
}
/**
* Escape string for the JavaScript context
*
* @param string $string
* @return string
* @since 100.2.0
*/
public function escapeJs($string)
{
if ($string === '' || ctype_digit($string)) {
return $string;
}
return preg_replace_callback(
'/[^a-z0-9,\._]/iSu',
function ($matches) {
$chr = $matches[0];
if (strlen($chr) != 1) {
$chr = mb_convert_encoding($chr, 'UTF-16BE', 'UTF-8');
$chr = ($chr === false) ? '' : $chr;
}
return sprintf('\\u%04s', strtoupper(bin2hex($chr)));
},
$string
);
}
/**
* Escape string for the CSS context
*
* @param string $string
* @return string
* @since 100.2.0
*/
public function escapeCss($string)
{
return $this->getEscaper()->escapeCss($string);
}
/**
* Escape quotes in java script
*
* @param string|array $data
* @param string $quote
* @return string|array
* @deprecated 100.2.0
*/
public function escapeJsQuote($data, $quote = '\'')
{
if (is_array($data)) {
$result = [];
foreach ($data as $item) {
$result[] = $this->escapeJsQuote($item, $quote);
}
} else {
$result = str_replace($quote, '\\' . $quote, $data);
}
return $result;
}
/**
* Escape xss in urls
* Remove `javascript:`, `vbscript:`, `data:` words from url
*
* @param string $data
* @return string
* @deprecated 100.2.0
*/
public function escapeXssInUrl($data)
{
$pattern = '/((javascript(\\\\x3a|:|%3A))|(data(\\\\x3a|:|%3A))|(vbscript:))|'
. '((\\\\x6A\\\\x61\\\\x76\\\\x61\\\\x73\\\\x63\\\\x72\\\\x69\\\\x70\\\\x74(\\\\x3a|:|%3A))|'
. '(\\\\x64\\\\x61\\\\x74\\\\x61(\\\\x3a|:|%3A)))/i';
$result = preg_replace($pattern, ':', $data);
return htmlspecialchars($result, ENT_COMPAT | ENT_HTML5 | ENT_HTML401, 'UTF-8', false);
}
/**
* Escape quotes inside html attributes
* Use $addSlashes = false for escaping js that inside html attribute (onClick, onSubmit etc)
*
* @param string $data
* @param bool $addSlashes
* @return string
* @deprecated 100.2.0
*/
public function escapeQuote($data, $addSlashes = false)
{
if ($addSlashes === true) {
$data = addslashes($data);
}
return htmlspecialchars($data, ENT_QUOTES, null, false);
}
/**
* Get escaper
*
* @return \Magento\Framework\ZendEscaper
* @deprecated 100.2.0
*/
private function getEscaper()
{
if ($this->escaper == null) {
$this->escaper = \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\ZendEscaper::class);
}
return $this->escaper;
}
/**
* Get logger
*
* @return \Psr\Log\LoggerInterface
* @deprecated 100.2.0
*/
private function getLogger()
{
if ($this->logger == null) {
$this->logger = \Magento\Framework\App\ObjectManager::getInstance()
->get(\Psr\Log\LoggerInterface::class);
}
return $this->logger;
}
}