MediaWiki REL1_34
Sanitizer.php
Go to the documentation of this file.
1<?php
28
33class Sanitizer {
39 '/&([A-Za-z0-9\x80-\xff]+);
40 |&\#([0-9]+);
41 |&\#[xX]([0-9A-Fa-f]+);
42 |(&)/x';
43
48 const ELEMENT_BITS_REGEX = '!^(/?)([A-Za-z][^\t\n\v />\0]*+)([^>]*?)(/?>)([^<]*)$!';
49
58 const EVIL_URI_PATTERN = '!(^|\s|\*/\s*)(javascript|vbscript)([^\w]|$)!i';
59 const XMLNS_ATTRIBUTE_PATTERN = "/^xmlns:[:A-Z_a-z-.0-9]+$/";
60
66 const ID_PRIMARY = 0;
67
74 const ID_FALLBACK = 1;
75
81 private static $htmlEntities = [
82 'Aacute' => 193,
83 'aacute' => 225,
84 'Acirc' => 194,
85 'acirc' => 226,
86 'acute' => 180,
87 'AElig' => 198,
88 'aelig' => 230,
89 'Agrave' => 192,
90 'agrave' => 224,
91 'alefsym' => 8501,
92 'Alpha' => 913,
93 'alpha' => 945,
94 'amp' => 38,
95 'and' => 8743,
96 'ang' => 8736,
97 'apos' => 39, // New in XHTML & HTML 5; avoid in output for compatibility with IE.
98 'Aring' => 197,
99 'aring' => 229,
100 'asymp' => 8776,
101 'Atilde' => 195,
102 'atilde' => 227,
103 'Auml' => 196,
104 'auml' => 228,
105 'bdquo' => 8222,
106 'Beta' => 914,
107 'beta' => 946,
108 'brvbar' => 166,
109 'bull' => 8226,
110 'cap' => 8745,
111 'Ccedil' => 199,
112 'ccedil' => 231,
113 'cedil' => 184,
114 'cent' => 162,
115 'Chi' => 935,
116 'chi' => 967,
117 'circ' => 710,
118 'clubs' => 9827,
119 'cong' => 8773,
120 'copy' => 169,
121 'crarr' => 8629,
122 'cup' => 8746,
123 'curren' => 164,
124 'dagger' => 8224,
125 'Dagger' => 8225,
126 'darr' => 8595,
127 'dArr' => 8659,
128 'deg' => 176,
129 'Delta' => 916,
130 'delta' => 948,
131 'diams' => 9830,
132 'divide' => 247,
133 'Eacute' => 201,
134 'eacute' => 233,
135 'Ecirc' => 202,
136 'ecirc' => 234,
137 'Egrave' => 200,
138 'egrave' => 232,
139 'empty' => 8709,
140 'emsp' => 8195,
141 'ensp' => 8194,
142 'Epsilon' => 917,
143 'epsilon' => 949,
144 'equiv' => 8801,
145 'Eta' => 919,
146 'eta' => 951,
147 'ETH' => 208,
148 'eth' => 240,
149 'Euml' => 203,
150 'euml' => 235,
151 'euro' => 8364,
152 'exist' => 8707,
153 'fnof' => 402,
154 'forall' => 8704,
155 'frac12' => 189,
156 'frac14' => 188,
157 'frac34' => 190,
158 'frasl' => 8260,
159 'Gamma' => 915,
160 'gamma' => 947,
161 'ge' => 8805,
162 'gt' => 62,
163 'harr' => 8596,
164 'hArr' => 8660,
165 'hearts' => 9829,
166 'hellip' => 8230,
167 'Iacute' => 205,
168 'iacute' => 237,
169 'Icirc' => 206,
170 'icirc' => 238,
171 'iexcl' => 161,
172 'Igrave' => 204,
173 'igrave' => 236,
174 'image' => 8465,
175 'infin' => 8734,
176 'int' => 8747,
177 'Iota' => 921,
178 'iota' => 953,
179 'iquest' => 191,
180 'isin' => 8712,
181 'Iuml' => 207,
182 'iuml' => 239,
183 'Kappa' => 922,
184 'kappa' => 954,
185 'Lambda' => 923,
186 'lambda' => 955,
187 'lang' => 9001,
188 'laquo' => 171,
189 'larr' => 8592,
190 'lArr' => 8656,
191 'lceil' => 8968,
192 'ldquo' => 8220,
193 'le' => 8804,
194 'lfloor' => 8970,
195 'lowast' => 8727,
196 'loz' => 9674,
197 'lrm' => 8206,
198 'lsaquo' => 8249,
199 'lsquo' => 8216,
200 'lt' => 60,
201 'macr' => 175,
202 'mdash' => 8212,
203 'micro' => 181,
204 'middot' => 183,
205 'minus' => 8722,
206 'Mu' => 924,
207 'mu' => 956,
208 'nabla' => 8711,
209 'nbsp' => 160,
210 'ndash' => 8211,
211 'ne' => 8800,
212 'ni' => 8715,
213 'not' => 172,
214 'notin' => 8713,
215 'nsub' => 8836,
216 'Ntilde' => 209,
217 'ntilde' => 241,
218 'Nu' => 925,
219 'nu' => 957,
220 'Oacute' => 211,
221 'oacute' => 243,
222 'Ocirc' => 212,
223 'ocirc' => 244,
224 'OElig' => 338,
225 'oelig' => 339,
226 'Ograve' => 210,
227 'ograve' => 242,
228 'oline' => 8254,
229 'Omega' => 937,
230 'omega' => 969,
231 'Omicron' => 927,
232 'omicron' => 959,
233 'oplus' => 8853,
234 'or' => 8744,
235 'ordf' => 170,
236 'ordm' => 186,
237 'Oslash' => 216,
238 'oslash' => 248,
239 'Otilde' => 213,
240 'otilde' => 245,
241 'otimes' => 8855,
242 'Ouml' => 214,
243 'ouml' => 246,
244 'para' => 182,
245 'part' => 8706,
246 'permil' => 8240,
247 'perp' => 8869,
248 'Phi' => 934,
249 'phi' => 966,
250 'Pi' => 928,
251 'pi' => 960,
252 'piv' => 982,
253 'plusmn' => 177,
254 'pound' => 163,
255 'prime' => 8242,
256 'Prime' => 8243,
257 'prod' => 8719,
258 'prop' => 8733,
259 'Psi' => 936,
260 'psi' => 968,
261 'quot' => 34,
262 'radic' => 8730,
263 'rang' => 9002,
264 'raquo' => 187,
265 'rarr' => 8594,
266 'rArr' => 8658,
267 'rceil' => 8969,
268 'rdquo' => 8221,
269 'real' => 8476,
270 'reg' => 174,
271 'rfloor' => 8971,
272 'Rho' => 929,
273 'rho' => 961,
274 'rlm' => 8207,
275 'rsaquo' => 8250,
276 'rsquo' => 8217,
277 'sbquo' => 8218,
278 'Scaron' => 352,
279 'scaron' => 353,
280 'sdot' => 8901,
281 'sect' => 167,
282 'shy' => 173,
283 'Sigma' => 931,
284 'sigma' => 963,
285 'sigmaf' => 962,
286 'sim' => 8764,
287 'spades' => 9824,
288 'sub' => 8834,
289 'sube' => 8838,
290 'sum' => 8721,
291 'sup' => 8835,
292 'sup1' => 185,
293 'sup2' => 178,
294 'sup3' => 179,
295 'supe' => 8839,
296 'szlig' => 223,
297 'Tau' => 932,
298 'tau' => 964,
299 'there4' => 8756,
300 'Theta' => 920,
301 'theta' => 952,
302 'thetasym' => 977,
303 'thinsp' => 8201,
304 'THORN' => 222,
305 'thorn' => 254,
306 'tilde' => 732,
307 'times' => 215,
308 'trade' => 8482,
309 'Uacute' => 218,
310 'uacute' => 250,
311 'uarr' => 8593,
312 'uArr' => 8657,
313 'Ucirc' => 219,
314 'ucirc' => 251,
315 'Ugrave' => 217,
316 'ugrave' => 249,
317 'uml' => 168,
318 'upsih' => 978,
319 'Upsilon' => 933,
320 'upsilon' => 965,
321 'Uuml' => 220,
322 'uuml' => 252,
323 'weierp' => 8472,
324 'Xi' => 926,
325 'xi' => 958,
326 'Yacute' => 221,
327 'yacute' => 253,
328 'yen' => 165,
329 'Yuml' => 376,
330 'yuml' => 255,
331 'Zeta' => 918,
332 'zeta' => 950,
333 'zwj' => 8205,
334 'zwnj' => 8204
335 ];
336
340 private static $htmlEntityAliases = [
341 'רלמ' => 'rlm',
342 'رلم' => 'rlm',
343 ];
344
348 private static $attribsRegex;
349
356 static function getAttribsRegex() {
357 if ( self::$attribsRegex === null ) {
358 $spaceChars = '\x09\x0a\x0c\x0d\x20';
359 $space = "[{$spaceChars}]";
360 $attrib = "[^{$spaceChars}\/>=]";
361 $attribFirst = "(?:{$attrib}|=)";
362 self::$attribsRegex =
363 "/({$attribFirst}{$attrib}*)
364 ($space*=$space*
365 (?:
366 # The attribute value: quoted or alone
367 \"([^\"]*)(?:\"|\$)
368 | '([^']*)(?:'|\$)
369 | (((?!$space|>).)*)
370 )
371 )?/sxu";
372 }
373 return self::$attribsRegex;
374 }
375
379 private static $attribNameRegex;
380
385 static function getAttribNameRegex() {
386 if ( self::$attribNameRegex === null ) {
387 $attribFirst = "[:_\p{L}\p{N}]";
388 $attrib = "[:_\.\-\p{L}\p{N}]";
389 self::$attribNameRegex = "/^({$attribFirst}{$attrib}*)$/sxu";
390 }
391 return self::$attribNameRegex;
392 }
393
400 public static function getRecognizedTagData( $extratags = [], $removetags = [] ) {
401 global $wgAllowImageTag;
402
403 static $htmlpairsStatic, $htmlsingle, $htmlsingleonly, $htmlnest, $tabletags,
404 $htmllist, $listtags, $htmlsingleallowed, $htmlelementsStatic, $staticInitialised;
405
406 // Base our staticInitialised variable off of the global config state so that if the globals
407 // are changed (like in the screwed up test system) we will re-initialise the settings.
408 $globalContext = $wgAllowImageTag;
409 if ( !$staticInitialised || $staticInitialised != $globalContext ) {
410 $htmlpairsStatic = [ # Tags that must be closed
411 'b', 'bdi', 'del', 'i', 'ins', 'u', 'font', 'big', 'small', 'sub', 'sup', 'h1',
412 'h2', 'h3', 'h4', 'h5', 'h6', 'cite', 'code', 'em', 's',
413 'strike', 'strong', 'tt', 'var', 'div', 'center',
414 'blockquote', 'ol', 'ul', 'dl', 'table', 'caption', 'pre',
415 'ruby', 'rb', 'rp', 'rt', 'rtc', 'p', 'span', 'abbr', 'dfn',
416 'kbd', 'samp', 'data', 'time', 'mark'
417 ];
418 $htmlsingle = [
419 'br', 'wbr', 'hr', 'li', 'dt', 'dd', 'meta', 'link'
420 ];
421
422 # Elements that cannot have close tags. This is (not coincidentally)
423 # also the list of tags for which the HTML 5 parsing algorithm
424 # requires you to "acknowledge the token's self-closing flag", i.e.
425 # a self-closing tag like <br/> is not an HTML 5 parse error only
426 # for this list.
427 $htmlsingleonly = [
428 'br', 'wbr', 'hr', 'meta', 'link'
429 ];
430
431 $htmlnest = [ # Tags that can be nested--??
432 'table', 'tr', 'td', 'th', 'div', 'blockquote', 'ol', 'ul',
433 'li', 'dl', 'dt', 'dd', 'font', 'big', 'small', 'sub', 'sup', 'span',
434 'var', 'kbd', 'samp', 'em', 'strong', 'q', 'ruby', 'bdo'
435 ];
436 $tabletags = [ # Can only appear inside table, we will close them
437 'td', 'th', 'tr',
438 ];
439 $htmllist = [ # Tags used by list
440 'ul', 'ol',
441 ];
442 $listtags = [ # Tags that can appear in a list
443 'li',
444 ];
445
446 if ( $wgAllowImageTag ) {
447 $htmlsingle[] = 'img';
448 $htmlsingleonly[] = 'img';
449 }
450
451 $htmlsingleallowed = array_unique( array_merge( $htmlsingle, $tabletags ) );
452 $htmlelementsStatic = array_unique( array_merge( $htmlsingle, $htmlpairsStatic, $htmlnest ) );
453
454 # Convert them all to hashtables for faster lookup
455 $vars = [ 'htmlpairsStatic', 'htmlsingle', 'htmlsingleonly', 'htmlnest', 'tabletags',
456 'htmllist', 'listtags', 'htmlsingleallowed', 'htmlelementsStatic' ];
457 foreach ( $vars as $var ) {
458 $$var = array_flip( $$var );
459 }
460 $staticInitialised = $globalContext;
461 }
462
463 # Populate $htmlpairs and $htmlelements with the $extratags and $removetags arrays
464 $extratags = array_flip( $extratags );
465 $removetags = array_flip( $removetags );
466 $htmlpairs = array_merge( $extratags, $htmlpairsStatic );
467 $htmlelements = array_diff_key( array_merge( $extratags, $htmlelementsStatic ), $removetags );
468
469 return [
470 'htmlpairs' => $htmlpairs,
471 'htmlsingle' => $htmlsingle,
472 'htmlsingleonly' => $htmlsingleonly,
473 'htmlnest' => $htmlnest,
474 'tabletags' => $tabletags,
475 'htmllist' => $htmllist,
476 'listtags' => $listtags,
477 'htmlsingleallowed' => $htmlsingleallowed,
478 'htmlelements' => $htmlelements,
479 ];
480 }
481
497 public static function removeHTMLtags( $text, $processCallback = null,
498 $args = [], $extratags = [], $removetags = [], $warnCallback = null
499 ) {
500 $tagData = self::getRecognizedTagData( $extratags, $removetags );
501 $htmlpairs = $tagData['htmlpairs'];
502 $htmlsingle = $tagData['htmlsingle'];
503 $htmlsingleonly = $tagData['htmlsingleonly'];
504 $htmlnest = $tagData['htmlnest'];
505 $tabletags = $tagData['tabletags'];
506 $htmllist = $tagData['htmllist'];
507 $listtags = $tagData['listtags'];
508 $htmlsingleallowed = $tagData['htmlsingleallowed'];
509 $htmlelements = $tagData['htmlelements'];
510
511 # Remove HTML comments
512 $text = self::removeHTMLcomments( $text );
513 $bits = explode( '<', $text );
514 $text = str_replace( '>', '&gt;', array_shift( $bits ) );
515 if ( !MWTidy::isEnabled() ) {
516 wfDeprecated( 'disabling tidy', '1.33' );
517 $tagstack = $tablestack = [];
518 foreach ( $bits as $x ) {
519 $regs = [];
520 # $slash: Does the current element start with a '/'?
521 # $t: Current element name
522 # $params: String between element name and >
523 # $brace: Ending '>' or '/>'
524 # $rest: Everything until the next element of $bits
525 if ( preg_match( self::ELEMENT_BITS_REGEX, $x, $regs ) ) {
526 list( /* $qbar */, $slash, $t, $params, $brace, $rest ) = $regs;
527 } else {
528 $slash = $t = $params = $brace = $rest = null;
529 }
530
531 $badtag = false;
532 $t = strtolower( $t );
533 if ( isset( $htmlelements[$t] ) ) {
534 # Check our stack
535 if ( $slash && isset( $htmlsingleonly[$t] ) ) {
536 $badtag = true;
537 } elseif ( $slash ) {
538 # Closing a tag... is it the one we just opened?
539 Wikimedia\suppressWarnings();
540 $ot = array_pop( $tagstack );
541 Wikimedia\restoreWarnings();
542
543 if ( $ot != $t ) {
544 if ( isset( $htmlsingleallowed[$ot] ) ) {
545 # Pop all elements with an optional close tag
546 # and see if we find a match below them
547 $optstack = [];
548 array_push( $optstack, $ot );
549 Wikimedia\suppressWarnings();
550 $ot = array_pop( $tagstack );
551 Wikimedia\restoreWarnings();
552 while ( $ot != $t && isset( $htmlsingleallowed[$ot] ) ) {
553 array_push( $optstack, $ot );
554 Wikimedia\suppressWarnings();
555 $ot = array_pop( $tagstack );
556 Wikimedia\restoreWarnings();
557 }
558 if ( $t != $ot ) {
559 # No match. Push the optional elements back again
560 $badtag = true;
561 Wikimedia\suppressWarnings();
562 $ot = array_pop( $optstack );
563 Wikimedia\restoreWarnings();
564 while ( $ot ) {
565 array_push( $tagstack, $ot );
566 Wikimedia\suppressWarnings();
567 $ot = array_pop( $optstack );
568 Wikimedia\restoreWarnings();
569 }
570 }
571 } else {
572 Wikimedia\suppressWarnings();
573 array_push( $tagstack, $ot );
574 Wikimedia\restoreWarnings();
575
576 # <li> can be nested in <ul> or <ol>, skip those cases:
577 if ( !isset( $htmllist[$ot] ) || !isset( $listtags[$t] ) ) {
578 $badtag = true;
579 }
580 }
581 } elseif ( $t == 'table' ) {
582 $tagstack = array_pop( $tablestack );
583 }
584 $newparams = '';
585 } else {
586 # Keep track for later
587 if ( isset( $tabletags[$t] ) && !in_array( 'table', $tagstack ) ) {
588 $badtag = true;
589 } elseif ( in_array( $t, $tagstack ) && !isset( $htmlnest[$t] ) ) {
590 $badtag = true;
591 #  Is it a self closed htmlpair ? (T7487)
592 } elseif ( $brace == '/>' && isset( $htmlpairs[$t] ) ) {
593 // Eventually we'll just remove the self-closing
594 // slash, in order to be consistent with HTML5
595 // semantics.
596 // $brace = '>';
597 // For now, let's just warn authors to clean up.
598 if ( is_callable( $warnCallback ) ) {
599 call_user_func_array( $warnCallback, [ 'deprecated-self-close-category' ] );
600 }
601 $badtag = true;
602 } elseif ( isset( $htmlsingleonly[$t] ) ) {
603 # Hack to force empty tag for unclosable elements
604 $brace = '/>';
605 } elseif ( isset( $htmlsingle[$t] ) ) {
606 # Hack to not close $htmlsingle tags
607 $brace = null;
608 # Still need to push this optionally-closed tag to
609 # the tag stack so that we can match end tags
610 # instead of marking them as bad.
611 array_push( $tagstack, $t );
612 } elseif ( isset( $tabletags[$t] ) && in_array( $t, $tagstack ) ) {
613 // New table tag but forgot to close the previous one
614 $text .= "</$t>";
615 } else {
616 if ( $t == 'table' ) {
617 array_push( $tablestack, $tagstack );
618 $tagstack = [];
619 }
620 array_push( $tagstack, $t );
621 }
622
623 # Replace any variables or template parameters with
624 # plaintext results.
625 if ( is_callable( $processCallback ) ) {
626 call_user_func_array( $processCallback, [ &$params, $args ] );
627 }
628
629 if ( !self::validateTag( $params, $t ) ) {
630 $badtag = true;
631 }
632
633 # Strip non-approved attributes from the tag
634 $newparams = self::fixTagAttributes( $params, $t );
635 }
636 if ( !$badtag ) {
637 $rest = str_replace( '>', '&gt;', $rest );
638 $close = ( $brace == '/>' && !$slash ) ? ' /' : '';
639 $text .= "<$slash$t$newparams$close>$rest";
640 continue;
641 }
642 }
643 $text .= '&lt;' . str_replace( '>', '&gt;', $x );
644 }
645 # Close off any remaining tags
646 while ( is_array( $tagstack ) && ( $t = array_pop( $tagstack ) ) ) {
647 $text .= "</$t>\n";
648 if ( $t == 'table' ) {
649 $tagstack = array_pop( $tablestack );
650 }
651 }
652 } else {
653 # this might be possible using tidy itself
654 foreach ( $bits as $x ) {
655 if ( preg_match( self::ELEMENT_BITS_REGEX, $x, $regs ) ) {
656 list( /* $qbar */, $slash, $t, $params, $brace, $rest ) = $regs;
657
658 $badtag = false;
659 $t = strtolower( $t );
660 if ( isset( $htmlelements[$t] ) ) {
661 if ( is_callable( $processCallback ) ) {
662 call_user_func_array( $processCallback, [ &$params, $args ] );
663 }
664
665 if ( $brace == '/>' && !( isset( $htmlsingle[$t] ) || isset( $htmlsingleonly[$t] ) ) ) {
666 // Eventually we'll just remove the self-closing
667 // slash, in order to be consistent with HTML5
668 // semantics.
669 // $brace = '>';
670 // For now, let's just warn authors to clean up.
671 if ( is_callable( $warnCallback ) ) {
672 call_user_func_array( $warnCallback, [ 'deprecated-self-close-category' ] );
673 }
674 }
675 if ( !self::validateTag( $params, $t ) ) {
676 $badtag = true;
677 }
678
679 $newparams = self::fixTagAttributes( $params, $t );
680 if ( !$badtag ) {
681 if ( $brace === '/>' && !isset( $htmlsingleonly[$t] ) ) {
682 # Interpret self-closing tags as empty tags even when
683 # HTML 5 would interpret them as start tags. Such input
684 # is commonly seen on Wikimedia wikis with this intention.
685 $brace = "></$t>";
686 }
687
688 $rest = str_replace( '>', '&gt;', $rest );
689 $text .= "<$slash$t$newparams$brace$rest";
690 continue;
691 }
692 }
693 }
694 $text .= '&lt;' . str_replace( '>', '&gt;', $x );
695 }
696 }
697 return $text;
698 }
699
709 public static function removeHTMLcomments( $text ) {
710 while ( ( $start = strpos( $text, '<!--' ) ) !== false ) {
711 $end = strpos( $text, '-->', $start + 4 );
712 if ( $end === false ) {
713 # Unterminated comment; bail out
714 break;
715 }
716
717 $end += 3;
718
719 # Trim space and newline if the comment is both
720 # preceded and followed by a newline
721 $spaceStart = max( $start - 1, 0 );
722 $spaceLen = $end - $spaceStart;
723 while ( substr( $text, $spaceStart, 1 ) === ' ' && $spaceStart > 0 ) {
724 $spaceStart--;
725 $spaceLen++;
726 }
727 while ( substr( $text, $spaceStart + $spaceLen, 1 ) === ' ' ) {
728 $spaceLen++;
729 }
730 if ( substr( $text, $spaceStart, 1 ) === "\n"
731 && substr( $text, $spaceStart + $spaceLen, 1 ) === "\n" ) {
732 # Remove the comment, leading and trailing
733 # spaces, and leave only one newline.
734 $text = substr_replace( $text, "\n", $spaceStart, $spaceLen + 1 );
735 } else {
736 # Remove just the comment.
737 $text = substr_replace( $text, '', $start, $end - $start );
738 }
739 }
740 return $text;
741 }
742
755 static function validateTag( $params, $element ) {
756 $params = self::decodeTagAttributes( $params );
757
758 if ( $element == 'meta' || $element == 'link' ) {
759 if ( !isset( $params['itemprop'] ) ) {
760 // <meta> and <link> must have an itemprop="" otherwise they are not valid or safe in content
761 return false;
762 }
763 if ( $element == 'meta' && !isset( $params['content'] ) ) {
764 // <meta> must have a content="" for the itemprop
765 return false;
766 }
767 if ( $element == 'link' && !isset( $params['href'] ) ) {
768 // <link> must have an associated href=""
769 return false;
770 }
771 }
772
773 return true;
774 }
775
791 static function validateTagAttributes( $attribs, $element ) {
792 return self::validateAttributes( $attribs,
793 self::attributeWhitelistInternal( $element ) );
794 }
795
813 static function validateAttributes( $attribs, $whitelist ) {
814 if ( isset( $whitelist[0] ) ) {
815 // We would like to eventually deprecate calling this
816 // function with a sequential array, but for now just
817 // convert it.
818 $whitelist = array_flip( $whitelist );
819 }
820 $hrefExp = '/^(' . wfUrlProtocols() . ')[^\s]+$/';
821
822 $out = [];
823 foreach ( $attribs as $attribute => $value ) {
824 # Allow XML namespace declaration to allow RDFa
825 if ( preg_match( self::XMLNS_ATTRIBUTE_PATTERN, $attribute ) ) {
826 if ( !preg_match( self::EVIL_URI_PATTERN, $value ) ) {
827 $out[$attribute] = $value;
828 }
829
830 continue;
831 }
832
833 # Allow any attribute beginning with "data-"
834 # However:
835 # * Disallow data attributes used by MediaWiki code
836 # * Ensure that the attribute is not namespaced by banning
837 # colons.
838 if ( (
839 !preg_match( '/^data-[^:]*$/i', $attribute ) &&
840 !array_key_exists( $attribute, $whitelist )
841 ) || self::isReservedDataAttribute( $attribute ) ) {
842 continue;
843 }
844
845 # Strip javascript "expression" from stylesheets.
846 # https://msdn.microsoft.com/en-us/library/ms537634.aspx
847 if ( $attribute == 'style' ) {
848 $value = self::checkCss( $value );
849 }
850
851 # Escape HTML id attributes
852 if ( $attribute === 'id' ) {
853 $value = self::escapeIdForAttribute( $value, self::ID_PRIMARY );
854 }
855
856 # Escape HTML id reference lists
857 if ( $attribute === 'aria-describedby'
858 || $attribute === 'aria-flowto'
859 || $attribute === 'aria-labelledby'
860 || $attribute === 'aria-owns'
861 ) {
862 $value = self::escapeIdReferenceList( $value );
863 }
864
865 // RDFa and microdata properties allow URLs, URIs and/or CURIs.
866 // Check them for sanity.
867 if ( $attribute === 'rel' || $attribute === 'rev'
868 # RDFa
869 || $attribute === 'about' || $attribute === 'property'
870 || $attribute === 'resource' || $attribute === 'datatype'
871 || $attribute === 'typeof'
872 # HTML5 microdata
873 || $attribute === 'itemid' || $attribute === 'itemprop'
874 || $attribute === 'itemref' || $attribute === 'itemscope'
875 || $attribute === 'itemtype'
876 ) {
877 // Paranoia. Allow "simple" values but suppress javascript
878 if ( preg_match( self::EVIL_URI_PATTERN, $value ) ) {
879 continue;
880 }
881 }
882
883 # NOTE: even though elements using href/src are not allowed directly, supply
884 # validation code that can be used by tag hook handlers, etc
885 if ( $attribute === 'href' || $attribute === 'src' || $attribute === 'poster' ) {
886 if ( !preg_match( $hrefExp, $value ) ) {
887 continue; // drop any href or src attributes not using an allowed protocol.
888 // NOTE: this also drops all relative URLs
889 }
890 }
891
892 // If this attribute was previously set, override it.
893 // Output should only have one attribute of each name.
894 $out[$attribute] = $value;
895 }
896
897 # itemtype, itemid, itemref don't make sense without itemscope
898 if ( !array_key_exists( 'itemscope', $out ) ) {
899 unset( $out['itemtype'] );
900 unset( $out['itemid'] );
901 unset( $out['itemref'] );
902 }
903 # TODO: Strip itemprop if we aren't descendants of an itemscope or pointed to by an itemref.
904
905 return $out;
906 }
907
915 public static function isReservedDataAttribute( $attr ) {
916 // data-ooui is reserved for ooui.
917 // data-mw and data-parsoid are reserved for parsoid.
918 // data-mw-<name here> is reserved for extensions (or core) if
919 // they need to communicate some data to the client and want to be
920 // sure that it isn't coming from an untrusted user.
921 // We ignore the possibility of namespaces since user-generated HTML
922 // can't use them anymore.
923 return (bool)preg_match( '/^data-(ooui|mw|parsoid)/i', $attr );
924 }
925
936 static function mergeAttributes( $a, $b ) {
937 $out = array_merge( $a, $b );
938 if ( isset( $a['class'] ) && isset( $b['class'] )
939 && is_string( $a['class'] ) && is_string( $b['class'] )
940 && $a['class'] !== $b['class']
941 ) {
942 $classes = preg_split( '/\s+/', "{$a['class']} {$b['class']}",
943 -1, PREG_SPLIT_NO_EMPTY );
944 $out['class'] = implode( ' ', array_unique( $classes ) );
945 }
946 return $out;
947 }
948
958 public static function normalizeCss( $value ) {
959 // Decode character references like &#123;
960 $value = self::decodeCharReferences( $value );
961
962 // Decode escape sequences and line continuation
963 // See the grammar in the CSS 2 spec, appendix D.
964 // This has to be done AFTER decoding character references.
965 // This means it isn't possible for this function to return
966 // unsanitized escape sequences. It is possible to manufacture
967 // input that contains character references that decode to
968 // escape sequences that decode to character references, but
969 // it's OK for the return value to contain character references
970 // because the caller is supposed to escape those anyway.
971 static $decodeRegex;
972 if ( !$decodeRegex ) {
973 $space = '[\\x20\\t\\r\\n\\f]';
974 $nl = '(?:\\n|\\r\\n|\\r|\\f)';
975 $backslash = '\\\\';
976 $decodeRegex = "/ $backslash
977 (?:
978 ($nl) | # 1. Line continuation
979 ([0-9A-Fa-f]{1,6})$space? | # 2. character number
980 (.) | # 3. backslash cancelling special meaning
981 () | # 4. backslash at end of string
982 )/xu";
983 }
984 $value = preg_replace_callback( $decodeRegex,
985 [ __CLASS__, 'cssDecodeCallback' ], $value );
986
987 // Normalize Halfwidth and Fullwidth Unicode block that IE6 might treat as ascii
988 $value = preg_replace_callback(
989 '/[!-[]-z]/u', // U+FF01 to U+FF5A, excluding U+FF3C (T60088)
990 function ( $matches ) {
991 $cp = UtfNormal\Utils::utf8ToCodepoint( $matches[0] );
992 if ( $cp === false ) {
993 return '';
994 }
995 return chr( $cp - 65248 ); // ASCII range \x21-\x7A
996 },
997 $value
998 );
999
1000 // Convert more characters IE6 might treat as ascii
1001 // U+0280, U+0274, U+207F, U+029F, U+026A, U+207D, U+208D
1002 $value = str_replace(
1003 [ 'ʀ', 'ɴ', 'ⁿ', 'ʟ', 'ɪ', '⁽', '₍' ],
1004 [ 'r', 'n', 'n', 'l', 'i', '(', '(' ],
1005 $value
1006 );
1007
1008 // Let the value through if it's nothing but a single comment, to
1009 // allow other functions which may reject it to pass some error
1010 // message through.
1011 if ( !preg_match( '! ^ \s* /\* [^*\\/]* \*/ \s* $ !x', $value ) ) {
1012 // Remove any comments; IE gets token splitting wrong
1013 // This must be done AFTER decoding character references and
1014 // escape sequences, because those steps can introduce comments
1015 // This step cannot introduce character references or escape
1016 // sequences, because it replaces comments with spaces rather
1017 // than removing them completely.
1018 $value = StringUtils::delimiterReplace( '/*', '*/', ' ', $value );
1019
1020 // Remove anything after a comment-start token, to guard against
1021 // incorrect client implementations.
1022 $commentPos = strpos( $value, '/*' );
1023 if ( $commentPos !== false ) {
1024 $value = substr( $value, 0, $commentPos );
1025 }
1026 }
1027
1028 // S followed by repeat, iteration, or prolonged sound marks,
1029 // which IE will treat as "ss"
1030 $value = preg_replace(
1031 '/s(?:
1032 \xE3\x80\xB1 | # U+3031
1033 \xE3\x82\x9D | # U+309D
1034 \xE3\x83\xBC | # U+30FC
1035 \xE3\x83\xBD | # U+30FD
1036 \xEF\xB9\xBC | # U+FE7C
1037 \xEF\xB9\xBD | # U+FE7D
1038 \xEF\xBD\xB0 # U+FF70
1039 )/ix',
1040 'ss',
1041 $value
1042 );
1043
1044 return $value;
1045 }
1046
1065 static function checkCss( $value ) {
1066 $value = self::normalizeCss( $value );
1067
1068 // Reject problematic keywords and control characters
1069 if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ||
1070 strpos( $value, UtfNormal\Constants::UTF8_REPLACEMENT ) !== false ) {
1071 return '/* invalid control char */';
1072 } elseif ( preg_match(
1073 '! expression
1074 | filter\s*:
1075 | accelerator\s*:
1076 | -o-link\s*:
1077 | -o-link-source\s*:
1078 | -o-replace\s*:
1079 | url\s*\‍(
1080 | image\s*\‍(
1081 | image-set\s*\‍(
1082 | attr\s*\‍([^)]+[\s,]+url
1083 | var\s*\‍(
1084 !ix', $value ) ) {
1085 return '/* insecure input */';
1086 }
1087 return $value;
1088 }
1089
1094 static function cssDecodeCallback( $matches ) {
1095 if ( $matches[1] !== '' ) {
1096 // Line continuation
1097 return '';
1098 } elseif ( $matches[2] !== '' ) {
1099 $char = UtfNormal\Utils::codepointToUtf8( hexdec( $matches[2] ) );
1100 } elseif ( $matches[3] !== '' ) {
1101 $char = $matches[3];
1102 } else {
1103 $char = '\\';
1104 }
1105 if ( $char == "\n" || $char == '"' || $char == "'" || $char == '\\' ) {
1106 // These characters need to be escaped in strings
1107 // Clean up the escape sequence to avoid parsing errors by clients
1108 return '\\' . dechex( ord( $char ) ) . ' ';
1109 } else {
1110 // Decode unnecessary escape
1111 return $char;
1112 }
1113 }
1114
1136 static function fixTagAttributes( $text, $element, $sorted = false ) {
1137 if ( trim( $text ) == '' ) {
1138 return '';
1139 }
1140
1141 $decoded = self::decodeTagAttributes( $text );
1142 $stripped = self::validateTagAttributes( $decoded, $element );
1143
1144 if ( $sorted ) {
1145 ksort( $stripped );
1146 }
1147
1148 return self::safeEncodeTagAttributes( $stripped );
1149 }
1150
1156 static function encodeAttribute( $text ) {
1157 $encValue = htmlspecialchars( $text, ENT_QUOTES );
1158
1159 // Whitespace is normalized during attribute decoding,
1160 // so if we've been passed non-spaces we must encode them
1161 // ahead of time or they won't be preserved.
1162 $encValue = strtr( $encValue, [
1163 "\n" => '&#10;',
1164 "\r" => '&#13;',
1165 "\t" => '&#9;',
1166 ] );
1167
1168 return $encValue;
1169 }
1170
1179 public static function armorFrenchSpaces( $text, $space = '&#160;' ) {
1180 // Replace $ with \$ and \ with \\
1181 $space = preg_replace( '#(?<!\\\\‍)(\\$|\\\\‍)#', '\\\\$1', $space );
1182 $fixtags = [
1183 # French spaces, last one Guillemet-left
1184 # only if there is something before the space
1185 # and a non-word character after the punctuation.
1186 '/(\S) (?=[?:;!%»›](?!\w))/u' => "\\1$space",
1187 # French spaces, Guillemet-right
1188 '/([«‹]) /u' => "\\1$space",
1189 ];
1190 return preg_replace( array_keys( $fixtags ), array_values( $fixtags ), $text );
1191 }
1192
1199 static function safeEncodeAttribute( $text ) {
1200 $encValue = self::encodeAttribute( $text );
1201
1202 # Templates and links may be expanded in later parsing,
1203 # creating invalid or dangerous output. Suppress this.
1204 $encValue = strtr( $encValue, [
1205 '<' => '&lt;', // This should never happen,
1206 '>' => '&gt;', // we've received invalid input
1207 '"' => '&quot;', // which should have been escaped.
1208 '{' => '&#123;',
1209 '}' => '&#125;', // prevent unpaired language conversion syntax
1210 '[' => '&#91;',
1211 ']' => '&#93;',
1212 "''" => '&#39;&#39;',
1213 'ISBN' => '&#73;SBN',
1214 'RFC' => '&#82;FC',
1215 'PMID' => '&#80;MID',
1216 '|' => '&#124;',
1217 '__' => '&#95;_',
1218 ] );
1219
1220 # Armor against French spaces detection (T5158)
1221 $encValue = self::armorFrenchSpaces( $encValue, '&#32;' );
1222
1223 # Stupid hack
1224 $encValue = preg_replace_callback(
1225 '/((?i)' . wfUrlProtocols() . ')/',
1226 function ( $matches ) {
1227 return str_replace( ':', '&#58;', $matches[1] );
1228 },
1229 $encValue );
1230 return $encValue;
1231 }
1232
1261 static function escapeId( $id, $options = [] ) {
1262 $options = (array)$options;
1263
1264 // HTML4-style escaping
1265 static $replace = [
1266 '%3A' => ':',
1267 '%' => '.'
1268 ];
1269
1270 $id = urlencode( strtr( $id, ' ', '_' ) );
1271 $id = strtr( $id, $replace );
1272
1273 if ( !preg_match( '/^[a-zA-Z]/', $id ) && !in_array( 'noninitial', $options ) ) {
1274 // Initial character must be a letter!
1275 $id = "x$id";
1276 }
1277 return $id;
1278 }
1279
1295 public static function escapeIdForAttribute( $id, $mode = self::ID_PRIMARY ) {
1296 global $wgFragmentMode;
1297
1298 if ( !isset( $wgFragmentMode[$mode] ) ) {
1299 if ( $mode === self::ID_PRIMARY ) {
1300 throw new UnexpectedValueException( '$wgFragmentMode is configured with no primary mode' );
1301 }
1302 return false;
1303 }
1304
1305 $internalMode = $wgFragmentMode[$mode];
1306
1307 return self::escapeIdInternal( $id, $internalMode );
1308 }
1309
1322 public static function escapeIdForLink( $id ) {
1323 global $wgFragmentMode;
1324
1325 if ( !isset( $wgFragmentMode[self::ID_PRIMARY] ) ) {
1326 throw new UnexpectedValueException( '$wgFragmentMode is configured with no primary mode' );
1327 }
1328
1329 $mode = $wgFragmentMode[self::ID_PRIMARY];
1330
1331 $id = self::escapeIdInternal( $id, $mode );
1332
1333 return $id;
1334 }
1335
1345 public static function escapeIdForExternalInterwiki( $id ) {
1347
1348 $id = self::escapeIdInternal( $id, $wgExternalInterwikiFragmentMode );
1349
1350 return $id;
1351 }
1352
1360 private static function escapeIdInternal( $id, $mode ) {
1361 // Truncate overly-long IDs. This isn't an HTML limit, it's just
1362 // griefer protection. [T251506]
1363 $id = mb_substr( $id, 0, 1024 );
1364
1365 switch ( $mode ) {
1366 case 'html5':
1367 $id = str_replace( ' ', '_', $id );
1368 break;
1369 case 'legacy':
1370 // This corresponds to 'noninitial' mode of the old escapeId()
1371 static $replace = [
1372 '%3A' => ':',
1373 '%' => '.'
1374 ];
1375
1376 $id = urlencode( str_replace( ' ', '_', $id ) );
1377 $id = strtr( $id, $replace );
1378 break;
1379 default:
1380 throw new InvalidArgumentException( "Invalid mode '$mode' passed to '" . __METHOD__ );
1381 }
1382
1383 return $id;
1384 }
1385
1395 public static function escapeIdReferenceList( $referenceString ) {
1396 # Explode the space delimited list string into an array of tokens
1397 $references = preg_split( '/\s+/', "{$referenceString}", -1, PREG_SPLIT_NO_EMPTY );
1398
1399 # Escape each token as an id
1400 foreach ( $references as &$ref ) {
1401 $ref = self::escapeIdForAttribute( $ref );
1402 }
1403
1404 # Merge the array back to a space delimited list string
1405 # If the array is empty, the result will be an empty string ('')
1406 $referenceString = implode( ' ', $references );
1407
1408 return $referenceString;
1409 }
1410
1422 static function escapeClass( $class ) {
1423 // Convert ugly stuff to underscores and kill underscores in ugly places
1424 return rtrim( preg_replace(
1425 [ '/(^[0-9\\-])|[\\x00-\\x20!"#$%&\'()*+,.\\/:;<=>?@[\\]^`{|}~]|\\xC2\\xA0/', '/_+/' ],
1426 '_',
1427 $class ), '_' );
1428 }
1429
1437 static function escapeHtmlAllowEntities( $html ) {
1438 $html = self::decodeCharReferences( $html );
1439 # It seems wise to escape ' as well as ", as a matter of course. Can't
1440 # hurt. Use ENT_SUBSTITUTE so that incorrectly truncated multibyte characters
1441 # don't cause the entire string to disappear.
1442 $html = htmlspecialchars( $html, ENT_QUOTES | ENT_SUBSTITUTE );
1443 return $html;
1444 }
1445
1454 public static function decodeTagAttributes( $text ) {
1455 if ( trim( $text ) == '' ) {
1456 return [];
1457 }
1458
1459 $pairs = [];
1460 if ( !preg_match_all(
1461 self::getAttribsRegex(),
1462 $text,
1463 $pairs,
1464 PREG_SET_ORDER ) ) {
1465 return [];
1466 }
1467
1468 $attribs = [];
1469 foreach ( $pairs as $set ) {
1470 $attribute = strtolower( $set[1] );
1471
1472 // Filter attribute names with unacceptable characters
1473 if ( !preg_match( self::getAttribNameRegex(), $attribute ) ) {
1474 continue;
1475 }
1476
1477 $value = self::getTagAttributeCallback( $set );
1478
1479 // Normalize whitespace
1480 $value = preg_replace( '/[\t\r\n ]+/', ' ', $value );
1481 $value = trim( $value );
1482
1483 // Decode character references
1484 $attribs[$attribute] = self::decodeCharReferences( $value );
1485 }
1486 return $attribs;
1487 }
1488
1496 public static function safeEncodeTagAttributes( $assoc_array ) {
1497 $attribs = [];
1498 foreach ( $assoc_array as $attribute => $value ) {
1499 $encAttribute = htmlspecialchars( $attribute );
1500 $encValue = self::safeEncodeAttribute( $value );
1501
1502 $attribs[] = "$encAttribute=\"$encValue\"";
1503 }
1504 return count( $attribs ) ? ' ' . implode( ' ', $attribs ) : '';
1505 }
1506
1515 private static function getTagAttributeCallback( $set ) {
1516 if ( isset( $set[5] ) ) {
1517 # No quotes.
1518 return $set[5];
1519 } elseif ( isset( $set[4] ) ) {
1520 # Single-quoted
1521 return $set[4];
1522 } elseif ( isset( $set[3] ) ) {
1523 # Double-quoted
1524 return $set[3];
1525 } elseif ( !isset( $set[2] ) ) {
1526 # In XHTML, attributes must have a value so return an empty string.
1527 # See "Empty attribute syntax",
1528 # https://www.w3.org/TR/html5/syntax.html#syntax-attribute-name
1529 return "";
1530 } else {
1531 throw new MWException( "Tag conditions not met. This should never happen and is a bug." );
1532 }
1533 }
1534
1539 private static function normalizeWhitespace( $text ) {
1540 return trim( preg_replace(
1541 '/(?:\r\n|[\x20\x0d\x0a\x09])+/',
1542 ' ',
1543 $text ) );
1544 }
1545
1554 static function normalizeSectionNameWhitespace( $section ) {
1555 return trim( preg_replace( '/[ _]+/', ' ', $section ) );
1556 }
1557
1573 static function normalizeCharReferences( $text ) {
1574 return preg_replace_callback(
1575 self::CHAR_REFS_REGEX,
1576 [ self::class, 'normalizeCharReferencesCallback' ],
1577 $text );
1578 }
1579
1585 $ret = null;
1586 if ( $matches[1] != '' ) {
1587 $ret = self::normalizeEntity( $matches[1] );
1588 } elseif ( $matches[2] != '' ) {
1589 $ret = self::decCharReference( $matches[2] );
1590 } elseif ( $matches[3] != '' ) {
1591 $ret = self::hexCharReference( $matches[3] );
1592 }
1593 if ( is_null( $ret ) ) {
1594 return htmlspecialchars( $matches[0] );
1595 } else {
1596 return $ret;
1597 }
1598 }
1599
1610 static function normalizeEntity( $name ) {
1611 if ( isset( self::$htmlEntityAliases[$name] ) ) {
1612 return '&' . self::$htmlEntityAliases[$name] . ';';
1613 } elseif ( in_array( $name, [ 'lt', 'gt', 'amp', 'quot' ] ) ) {
1614 return "&$name;";
1615 } elseif ( isset( self::$htmlEntities[$name] ) ) {
1616 return '&#' . self::$htmlEntities[$name] . ';';
1617 } else {
1618 return "&amp;$name;";
1619 }
1620 }
1621
1626 static function decCharReference( $codepoint ) {
1627 $point = intval( $codepoint );
1628 if ( self::validateCodepoint( $point ) ) {
1629 return sprintf( '&#%d;', $point );
1630 } else {
1631 return null;
1632 }
1633 }
1634
1639 static function hexCharReference( $codepoint ) {
1640 $point = hexdec( $codepoint );
1641 if ( self::validateCodepoint( $point ) ) {
1642 return sprintf( '&#x%x;', $point );
1643 } else {
1644 return null;
1645 }
1646 }
1647
1654 private static function validateCodepoint( $codepoint ) {
1655 # U+000C is valid in HTML5 but not allowed in XML.
1656 # U+000D is valid in XML but not allowed in HTML5.
1657 # U+007F - U+009F are disallowed in HTML5 (control characters).
1658 return $codepoint == 0x09
1659 || $codepoint == 0x0a
1660 || ( $codepoint >= 0x20 && $codepoint <= 0x7e )
1661 || ( $codepoint >= 0xa0 && $codepoint <= 0xd7ff )
1662 || ( $codepoint >= 0xe000 && $codepoint <= 0xfffd )
1663 || ( $codepoint >= 0x10000 && $codepoint <= 0x10ffff );
1664 }
1665
1673 public static function decodeCharReferences( $text ) {
1674 return preg_replace_callback(
1675 self::CHAR_REFS_REGEX,
1676 [ self::class, 'decodeCharReferencesCallback' ],
1677 $text );
1678 }
1679
1690 public static function decodeCharReferencesAndNormalize( $text ) {
1691 $text = preg_replace_callback(
1692 self::CHAR_REFS_REGEX,
1693 [ self::class, 'decodeCharReferencesCallback' ],
1694 $text,
1695 -1, //limit
1696 $count
1697 );
1698
1699 if ( $count ) {
1700 return MediaWikiServices::getInstance()->getContentLanguage()->normalize( $text );
1701 } else {
1702 return $text;
1703 }
1704 }
1705
1711 if ( $matches[1] != '' ) {
1712 return self::decodeEntity( $matches[1] );
1713 } elseif ( $matches[2] != '' ) {
1714 return self::decodeChar( intval( $matches[2] ) );
1715 } elseif ( $matches[3] != '' ) {
1716 return self::decodeChar( hexdec( $matches[3] ) );
1717 }
1718 # Last case should be an ampersand by itself
1719 return $matches[0];
1720 }
1721
1729 static function decodeChar( $codepoint ) {
1730 if ( self::validateCodepoint( $codepoint ) ) {
1731 return UtfNormal\Utils::codepointToUtf8( $codepoint );
1732 } else {
1733 return UtfNormal\Constants::UTF8_REPLACEMENT;
1734 }
1735 }
1736
1745 static function decodeEntity( $name ) {
1746 if ( isset( self::$htmlEntityAliases[$name] ) ) {
1747 $name = self::$htmlEntityAliases[$name];
1748 }
1749 if ( isset( self::$htmlEntities[$name] ) ) {
1750 return UtfNormal\Utils::codepointToUtf8( self::$htmlEntities[$name] );
1751 } else {
1752 return "&$name;";
1753 }
1754 }
1755
1763 static function attributeWhitelist( $element ) {
1764 wfDeprecated( __METHOD__, '1.34' );
1765 $list = self::setupAttributeWhitelist();
1766 return $list[$element] ?? [];
1767 }
1768
1776 private static function attributeWhitelistInternal( $element ) {
1777 $list = self::setupAttributeWhitelistInternal();
1778 return $list[$element] ?? [];
1779 }
1780
1787 static function setupAttributeWhitelist() {
1788 wfDeprecated( __METHOD__, '1.34' );
1789 $wlist = self::setupAttributeWhitelistInternal();
1790 // This method is expected to return a sequential array as the
1791 // value for each HTML element key.
1792 return array_map( function ( $v ) {
1793 return array_keys( $v );
1794 }, $wlist );
1795 }
1796
1804 private static function setupAttributeWhitelistInternal() {
1805 static $whitelist;
1806
1807 if ( $whitelist !== null ) {
1808 return $whitelist;
1809 }
1810
1811 // For lookup efficiency flip each attributes array so the keys are
1812 // the valid attributes.
1813 $merge = function ( $a, $b, $c = [] ) {
1814 return array_merge( $a, array_flip( $b ), array_flip( $c ) );
1815 };
1816 $common = $merge( [], [
1817 # HTML
1818 'id',
1819 'class',
1820 'style',
1821 'lang',
1822 'dir',
1823 'title',
1824
1825 # WAI-ARIA
1826 'aria-describedby',
1827 'aria-flowto',
1828 'aria-label',
1829 'aria-labelledby',
1830 'aria-owns',
1831 'role',
1832
1833 # RDFa
1834 # These attributes are specified in section 9 of
1835 # https://www.w3.org/TR/2008/REC-rdfa-syntax-20081014
1836 'about',
1837 'property',
1838 'resource',
1839 'datatype',
1840 'typeof',
1841
1842 # Microdata. These are specified by
1843 # https://html.spec.whatwg.org/multipage/microdata.html#the-microdata-model
1844 'itemid',
1845 'itemprop',
1846 'itemref',
1847 'itemscope',
1848 'itemtype',
1849 ] );
1850
1851 $block = $merge( $common, [ 'align' ] );
1852
1853 $tablealign = [ 'align', 'valign' ];
1854 $tablecell = [
1855 'abbr',
1856 'axis',
1857 'headers',
1858 'scope',
1859 'rowspan',
1860 'colspan',
1861 'nowrap', # deprecated
1862 'width', # deprecated
1863 'height', # deprecated
1864 'bgcolor', # deprecated
1865 ];
1866
1867 # Numbers refer to sections in HTML 4.01 standard describing the element.
1868 # See: https://www.w3.org/TR/html4/
1869 $whitelist = [
1870 # 7.5.4
1871 'div' => $block,
1872 'center' => $common, # deprecated
1873 'span' => $common,
1874
1875 # 7.5.5
1876 'h1' => $block,
1877 'h2' => $block,
1878 'h3' => $block,
1879 'h4' => $block,
1880 'h5' => $block,
1881 'h6' => $block,
1882
1883 # 7.5.6
1884 # address
1885
1886 # 8.2.4
1887 'bdo' => $common,
1888
1889 # 9.2.1
1890 'em' => $common,
1891 'strong' => $common,
1892 'cite' => $common,
1893 'dfn' => $common,
1894 'code' => $common,
1895 'samp' => $common,
1896 'kbd' => $common,
1897 'var' => $common,
1898 'abbr' => $common,
1899 # acronym
1900
1901 # 9.2.2
1902 'blockquote' => $merge( $common, [ 'cite' ] ),
1903 'q' => $merge( $common, [ 'cite' ] ),
1904
1905 # 9.2.3
1906 'sub' => $common,
1907 'sup' => $common,
1908
1909 # 9.3.1
1910 'p' => $block,
1911
1912 # 9.3.2
1913 'br' => $merge( $common, [ 'clear' ] ),
1914
1915 # https://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element
1916 'wbr' => $common,
1917
1918 # 9.3.4
1919 'pre' => $merge( $common, [ 'width' ] ),
1920
1921 # 9.4
1922 'ins' => $merge( $common, [ 'cite', 'datetime' ] ),
1923 'del' => $merge( $common, [ 'cite', 'datetime' ] ),
1924
1925 # 10.2
1926 'ul' => $merge( $common, [ 'type' ] ),
1927 'ol' => $merge( $common, [ 'type', 'start', 'reversed' ] ),
1928 'li' => $merge( $common, [ 'type', 'value' ] ),
1929
1930 # 10.3
1931 'dl' => $common,
1932 'dd' => $common,
1933 'dt' => $common,
1934
1935 # 11.2.1
1936 'table' => $merge( $common,
1937 [ 'summary', 'width', 'border', 'frame',
1938 'rules', 'cellspacing', 'cellpadding',
1939 'align', 'bgcolor',
1940 ] ),
1941
1942 # 11.2.2
1943 'caption' => $block,
1944
1945 # 11.2.3
1946 'thead' => $common,
1947 'tfoot' => $common,
1948 'tbody' => $common,
1949
1950 # 11.2.4
1951 'colgroup' => $merge( $common, [ 'span' ] ),
1952 'col' => $merge( $common, [ 'span' ] ),
1953
1954 # 11.2.5
1955 'tr' => $merge( $common, [ 'bgcolor' ], $tablealign ),
1956
1957 # 11.2.6
1958 'td' => $merge( $common, $tablecell, $tablealign ),
1959 'th' => $merge( $common, $tablecell, $tablealign ),
1960
1961 # 12.2
1962 # NOTE: <a> is not allowed directly, but the attrib
1963 # whitelist is used from the Parser object
1964 'a' => $merge( $common, [ 'href', 'rel', 'rev' ] ), # rel/rev esp. for RDFa
1965
1966 # 13.2
1967 # Not usually allowed, but may be used for extension-style hooks
1968 # such as <math> when it is rasterized, or if $wgAllowImageTag is
1969 # true
1970 'img' => $merge( $common, [ 'alt', 'src', 'width', 'height', 'srcset' ] ),
1971 # Attributes for A/V tags added in T163583 / T133673
1972 'audio' => $merge( $common, [ 'controls', 'preload', 'width', 'height' ] ),
1973 'video' => $merge( $common, [ 'poster', 'controls', 'preload', 'width', 'height' ] ),
1974 'source' => $merge( $common, [ 'type', 'src' ] ),
1975 'track' => $merge( $common, [ 'type', 'src', 'srclang', 'kind', 'label' ] ),
1976
1977 # 15.2.1
1978 'tt' => $common,
1979 'b' => $common,
1980 'i' => $common,
1981 'big' => $common,
1982 'small' => $common,
1983 'strike' => $common,
1984 's' => $common,
1985 'u' => $common,
1986
1987 # 15.2.2
1988 'font' => $merge( $common, [ 'size', 'color', 'face' ] ),
1989 # basefont
1990
1991 # 15.3
1992 'hr' => $merge( $common, [ 'width' ] ),
1993
1994 # HTML Ruby annotation text module, simple ruby only.
1995 # https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element
1996 'ruby' => $common,
1997 # rbc
1998 'rb' => $common,
1999 'rp' => $common,
2000 'rt' => $common, # $merge( $common, [ 'rbspan' ] ),
2001 'rtc' => $common,
2002
2003 # MathML root element, where used for extensions
2004 # 'title' may not be 100% valid here; it's XHTML
2005 # https://www.w3.org/TR/REC-MathML/
2006 'math' => $merge( [], [ 'class', 'style', 'id', 'title' ] ),
2007
2008 // HTML 5 section 4.5
2009 'figure' => $common,
2010 'figure-inline' => $common, # T118520
2011 'figcaption' => $common,
2012
2013 # HTML 5 section 4.6
2014 'bdi' => $common,
2015
2016 # HTML5 elements, defined by:
2017 # https://html.spec.whatwg.org/multipage/semantics.html#the-data-element
2018 'data' => $merge( $common, [ 'value' ] ),
2019 'time' => $merge( $common, [ 'datetime' ] ),
2020 'mark' => $common,
2021
2022 // meta and link are only permitted by removeHTMLtags when Microdata
2023 // is enabled so we don't bother adding a conditional to hide these
2024 // Also meta and link are only valid in WikiText as Microdata elements
2025 // (ie: validateTag rejects tags missing the attributes needed for Microdata)
2026 // So we don't bother including $common attributes that have no purpose.
2027 'meta' => $merge( [], [ 'itemprop', 'content' ] ),
2028 'link' => $merge( [], [ 'itemprop', 'href', 'title' ] ),
2029 ];
2030
2031 return $whitelist;
2032 }
2033
2045 static function stripAllTags( $html ) {
2046 // Use RemexHtml to tokenize $html and extract the text
2047 $handler = new RemexStripTagHandler;
2048 $tokenizer = new RemexHtml\Tokenizer\Tokenizer( $handler, $html, [
2049 'ignoreErrors' => true,
2050 // don't ignore char refs, we want them to be decoded
2051 'ignoreNulls' => true,
2052 'skipPreprocess' => true,
2053 ] );
2054 $tokenizer->execute();
2055 $text = $handler->getResult();
2056
2057 $text = self::normalizeWhitespace( $text );
2058 return $text;
2059 }
2060
2070 static function hackDocType() {
2071 $out = "<!DOCTYPE html [\n";
2072 foreach ( self::$htmlEntities as $entity => $codepoint ) {
2073 $out .= "<!ENTITY $entity \"&#$codepoint;\">";
2074 }
2075 $out .= "]>\n";
2076 return $out;
2077 }
2078
2083 static function cleanUrl( $url ) {
2084 # Normalize any HTML entities in input. They will be
2085 # re-escaped by makeExternalLink().
2086 $url = self::decodeCharReferences( $url );
2087
2088 # Escape any control characters introduced by the above step
2089 $url = preg_replace_callback( '/[\][<>"\\x00-\\x20\\x7F\|]/',
2090 [ __CLASS__, 'cleanUrlCallback' ], $url );
2091
2092 # Validate hostname portion
2093 $matches = [];
2094 if ( preg_match( '!^([^:]+:)(//[^/]+)?(.*)$!iD', $url, $matches ) ) {
2095 list( /* $whole */, $protocol, $host, $rest ) = $matches;
2096
2097 // Characters that will be ignored in IDNs.
2098 // https://tools.ietf.org/html/rfc3454#section-3.1
2099 // Strip them before further processing so blacklists and such work.
2100 $strip = "/
2101 \\s| # general whitespace
2102 \xc2\xad| # 00ad SOFT HYPHEN
2103 \xe1\xa0\x86| # 1806 MONGOLIAN TODO SOFT HYPHEN
2104 \xe2\x80\x8b| # 200b ZERO WIDTH SPACE
2105 \xe2\x81\xa0| # 2060 WORD JOINER
2106 \xef\xbb\xbf| # feff ZERO WIDTH NO-BREAK SPACE
2107 \xcd\x8f| # 034f COMBINING GRAPHEME JOINER
2108 \xe1\xa0\x8b| # 180b MONGOLIAN FREE VARIATION SELECTOR ONE
2109 \xe1\xa0\x8c| # 180c MONGOLIAN FREE VARIATION SELECTOR TWO
2110 \xe1\xa0\x8d| # 180d MONGOLIAN FREE VARIATION SELECTOR THREE
2111 \xe2\x80\x8c| # 200c ZERO WIDTH NON-JOINER
2112 \xe2\x80\x8d| # 200d ZERO WIDTH JOINER
2113 [\xef\xb8\x80-\xef\xb8\x8f] # fe00-fe0f VARIATION SELECTOR-1-16
2114 /xuD";
2115
2116 $host = preg_replace( $strip, '', $host );
2117
2118 // IPv6 host names are bracketed with []. Url-decode these.
2119 if ( substr_compare( "//%5B", $host, 0, 5 ) === 0 &&
2120 preg_match( '!^//%5B([0-9A-Fa-f:.]+)%5D((:\d+)?)$!', $host, $matches )
2121 ) {
2122 $host = '//[' . $matches[1] . ']' . $matches[2];
2123 }
2124
2125 // @todo FIXME: Validate hostnames here
2126
2127 return $protocol . $host . $rest;
2128 } else {
2129 return $url;
2130 }
2131 }
2132
2137 static function cleanUrlCallback( $matches ) {
2138 return urlencode( $matches[0] );
2139 }
2140
2169 public static function validateEmail( $addr ) {
2170 $result = null;
2171 if ( !Hooks::run( 'isValidEmailAddr', [ $addr, &$result ] ) ) {
2172 return $result;
2173 }
2174
2175 // Please note strings below are enclosed in brackets [], this make the
2176 // hyphen "-" a range indicator. Hence it is double backslashed below.
2177 // See T28948
2178 $rfc5322_atext = "a-z0-9!#$%&'*+\\-\/=?^_`{|}~";
2179 $rfc1034_ldh_str = "a-z0-9\\-";
2180
2181 $html5_email_regexp = "/
2182 ^ # start of string
2183 [$rfc5322_atext\\.]+ # user part which is liberal :p
2184 @ # 'apostrophe'
2185 [$rfc1034_ldh_str]+ # First domain part
2186 (\\.[$rfc1034_ldh_str]+)* # Following part prefixed with a dot
2187 $ # End of string
2188 /ix"; // case Insensitive, eXtended
2189
2190 return (bool)preg_match( $html5_email_regexp, $addr );
2191 }
2192}
$wgAllowImageTag
A different approach to the above: simply allow the "<img>" tag to be used.
$wgFragmentMode
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of...
$wgExternalInterwikiFragmentMode
Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragment...
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
if( $line===false) $args
Definition cdb.php:64
MediaWiki exception.
static isEnabled()
Definition MWTidy.php:54
MediaWikiServices is the service locator for the application scope of MediaWiki.
HTML sanitizer for MediaWiki.
Definition Sanitizer.php:33
static fixTagAttributes( $text, $element, $sorted=false)
Take a tag soup fragment listing an HTML element's attributes and normalize it to well-formed XML,...
static attributeWhitelistInternal( $element)
Fetch the whitelist of acceptable attributes for a given element name.
const CHAR_REFS_REGEX
Regular expression to match various types of character references in Sanitizer::normalizeCharReferenc...
Definition Sanitizer.php:38
static cleanUrl( $url)
static validateAttributes( $attribs, $whitelist)
Take an array of attribute names and values and normalize or discard illegal values for the given whi...
static decCharReference( $codepoint)
static isReservedDataAttribute( $attr)
Given an attribute name, checks whether it is a reserved data attribute (such as data-mw-foo) which i...
static decodeChar( $codepoint)
Return UTF-8 string for a codepoint if that is a valid character reference, otherwise U+FFFD REPLACEM...
static escapeHtmlAllowEntities( $html)
Given HTML input, escape with htmlspecialchars but un-escape entities.
static getAttribNameRegex()
Used in Sanitizer::decodeTagAttributes to filter attributes.
static checkCss( $value)
Pick apart some CSS and check it for forbidden or unsafe structures.
static decodeEntity( $name)
If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD, return the UTF-8 encoding of that chara...
static normalizeEntity( $name)
If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD, return the equivalent numeric entity re...
static armorFrenchSpaces( $text, $space='&#160;')
Armor French spaces with a replacement character.
static getRecognizedTagData( $extratags=[], $removetags=[])
Return the various lists of recognized tags.
static $attribsRegex
Lazy-initialised attributes regex, see getAttribsRegex()
static escapeIdForLink( $id)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid URL...
static setupAttributeWhitelistInternal()
Foreach array key (an allowed HTML element), return an array of allowed attributes.
static removeHTMLcomments( $text)
Remove '', and everything between.
static encodeAttribute( $text)
Encode an attribute value for HTML output.
static hexCharReference( $codepoint)
static validateTagAttributes( $attribs, $element)
Take an array of attribute names and values and normalize or discard illegal values for the given ele...
static escapeClass( $class)
Given a value, escape it so that it can be used as a CSS class and return it.
const EVIL_URI_PATTERN
Blacklist for evil uris like javascript: WARNING: DO NOT use this in any place that actually requires...
Definition Sanitizer.php:58
static normalizeSectionNameWhitespace( $section)
Normalizes whitespace in a section name, such as might be returned by Parser::stripSectionName(),...
static setupAttributeWhitelist()
Foreach array key (an allowed HTML element), return an array of allowed attributes.
static normalizeCharReferencesCallback( $matches)
static hackDocType()
Hack up a private DOCTYPE with HTML's standard entity declarations.
static cleanUrlCallback( $matches)
static normalizeCharReferences( $text)
Ensure that any entities and character references are legal for XML and XHTML specifically.
static cssDecodeCallback( $matches)
static escapeIdReferenceList( $referenceString)
Given a string containing a space delimited list of ids, escape each id to match ids escaped by the e...
static normalizeWhitespace( $text)
static removeHTMLtags( $text, $processCallback=null, $args=[], $extratags=[], $removetags=[], $warnCallback=null)
Cleans up HTML, removes dangerous tags and attributes, and removes HTML comments.
static getAttribsRegex()
Regular expression to match HTML/XML attribute pairs within a tag.
static validateCodepoint( $codepoint)
Returns true if a given Unicode codepoint is a valid character in both HTML5 and XML.
const ID_FALLBACK
Tells escapeUrlForHtml() to encode the ID using the fallback encoding, or return false if no fallback...
Definition Sanitizer.php:74
static $htmlEntities
List of all named character entities defined in HTML 4.01 https://www.w3.org/TR/html4/sgml/entities....
Definition Sanitizer.php:81
static decodeCharReferences( $text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string.
static escapeIdForAttribute( $id, $mode=self::ID_PRIMARY)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid HTM...
static $attribNameRegex
Lazy-initialised attribute name regex, see getAttribNameRegex()
static getTagAttributeCallback( $set)
Pick the appropriate attribute value from a match set from the attribs regex matches.
static escapeIdInternal( $id, $mode)
Helper for escapeIdFor*() functions.
static validateTag( $params, $element)
Takes attribute names and values for a tag and the tag name and validates that the tag is allowed to ...
static stripAllTags( $html)
Take a fragment of (potentially invalid) HTML and return a version with any tags removed,...
static decodeCharReferencesAndNormalize( $text)
Decode any character references, numeric or named entities, in the next and normalize the resulting s...
static $htmlEntityAliases
Character entity aliases accepted by MediaWiki.
static escapeId( $id, $options=[])
Given a value, escape it so that it can be used in an id attribute and return it.
static attributeWhitelist( $element)
Fetch the whitelist of acceptable attributes for a given element name.
static decodeCharReferencesCallback( $matches)
static mergeAttributes( $a, $b)
Merge two sets of HTML attributes.
static escapeIdForExternalInterwiki( $id)
Given a section name or other user-generated or otherwise unsafe string, escapes it to be a valid URL...
static validateEmail( $addr)
Does a string look like an e-mail address?
const ID_PRIMARY
Tells escapeUrlForHtml() to encode the ID using the wiki's primary encoding.
Definition Sanitizer.php:66
const ELEMENT_BITS_REGEX
Acceptable tag name charset from HTML5 parsing spec https://www.w3.org/TR/html5/syntax....
Definition Sanitizer.php:48
static safeEncodeAttribute( $text)
Encode an attribute value for HTML tags, with extra armoring against further wiki processing.
const XMLNS_ATTRIBUTE_PATTERN
Definition Sanitizer.php:59
static normalizeCss( $value)
Normalize CSS into a format we can easily search for hostile input.
static delimiterReplace( $startDelim, $endDelim, $replace, $subject, $flags='')
Perform an operation equivalent to preg_replace() with flags.