MediaWiki  1.30.0
Sanitizer.php
Go to the documentation of this file.
1 <?php
31 class Sanitizer {
36  const CHAR_REFS_REGEX =
37  '/&([A-Za-z0-9\x80-\xff]+);
38  |&\#([0-9]+);
39  |&\#[xX]([0-9A-Fa-f]+);
40  |(&)/x';
41 
46  const ELEMENT_BITS_REGEX = '!^(/?)([A-Za-z][^\t\n\v />\0]*+)([^>]*?)(/?>)([^<]*)$!';
47 
56  const EVIL_URI_PATTERN = '!(^|\s|\*/\s*)(javascript|vbscript)([^\w]|$)!i';
57  const XMLNS_ATTRIBUTE_PATTERN = "/^xmlns:[:A-Z_a-z-.0-9]+$/";
58 
64  const ID_PRIMARY = 0;
65 
72  const ID_FALLBACK = 1;
73 
79  private static $htmlEntities = [
80  'Aacute' => 193,
81  'aacute' => 225,
82  'Acirc' => 194,
83  'acirc' => 226,
84  'acute' => 180,
85  'AElig' => 198,
86  'aelig' => 230,
87  'Agrave' => 192,
88  'agrave' => 224,
89  'alefsym' => 8501,
90  'Alpha' => 913,
91  'alpha' => 945,
92  'amp' => 38,
93  'and' => 8743,
94  'ang' => 8736,
95  'apos' => 39, // New in XHTML & HTML 5; avoid in output for compatibility with IE.
96  'Aring' => 197,
97  'aring' => 229,
98  'asymp' => 8776,
99  'Atilde' => 195,
100  'atilde' => 227,
101  'Auml' => 196,
102  'auml' => 228,
103  'bdquo' => 8222,
104  'Beta' => 914,
105  'beta' => 946,
106  'brvbar' => 166,
107  'bull' => 8226,
108  'cap' => 8745,
109  'Ccedil' => 199,
110  'ccedil' => 231,
111  'cedil' => 184,
112  'cent' => 162,
113  'Chi' => 935,
114  'chi' => 967,
115  'circ' => 710,
116  'clubs' => 9827,
117  'cong' => 8773,
118  'copy' => 169,
119  'crarr' => 8629,
120  'cup' => 8746,
121  'curren' => 164,
122  'dagger' => 8224,
123  'Dagger' => 8225,
124  'darr' => 8595,
125  'dArr' => 8659,
126  'deg' => 176,
127  'Delta' => 916,
128  'delta' => 948,
129  'diams' => 9830,
130  'divide' => 247,
131  'Eacute' => 201,
132  'eacute' => 233,
133  'Ecirc' => 202,
134  'ecirc' => 234,
135  'Egrave' => 200,
136  'egrave' => 232,
137  'empty' => 8709,
138  'emsp' => 8195,
139  'ensp' => 8194,
140  'Epsilon' => 917,
141  'epsilon' => 949,
142  'equiv' => 8801,
143  'Eta' => 919,
144  'eta' => 951,
145  'ETH' => 208,
146  'eth' => 240,
147  'Euml' => 203,
148  'euml' => 235,
149  'euro' => 8364,
150  'exist' => 8707,
151  'fnof' => 402,
152  'forall' => 8704,
153  'frac12' => 189,
154  'frac14' => 188,
155  'frac34' => 190,
156  'frasl' => 8260,
157  'Gamma' => 915,
158  'gamma' => 947,
159  'ge' => 8805,
160  'gt' => 62,
161  'harr' => 8596,
162  'hArr' => 8660,
163  'hearts' => 9829,
164  'hellip' => 8230,
165  'Iacute' => 205,
166  'iacute' => 237,
167  'Icirc' => 206,
168  'icirc' => 238,
169  'iexcl' => 161,
170  'Igrave' => 204,
171  'igrave' => 236,
172  'image' => 8465,
173  'infin' => 8734,
174  'int' => 8747,
175  'Iota' => 921,
176  'iota' => 953,
177  'iquest' => 191,
178  'isin' => 8712,
179  'Iuml' => 207,
180  'iuml' => 239,
181  'Kappa' => 922,
182  'kappa' => 954,
183  'Lambda' => 923,
184  'lambda' => 955,
185  'lang' => 9001,
186  'laquo' => 171,
187  'larr' => 8592,
188  'lArr' => 8656,
189  'lceil' => 8968,
190  'ldquo' => 8220,
191  'le' => 8804,
192  'lfloor' => 8970,
193  'lowast' => 8727,
194  'loz' => 9674,
195  'lrm' => 8206,
196  'lsaquo' => 8249,
197  'lsquo' => 8216,
198  'lt' => 60,
199  'macr' => 175,
200  'mdash' => 8212,
201  'micro' => 181,
202  'middot' => 183,
203  'minus' => 8722,
204  'Mu' => 924,
205  'mu' => 956,
206  'nabla' => 8711,
207  'nbsp' => 160,
208  'ndash' => 8211,
209  'ne' => 8800,
210  'ni' => 8715,
211  'not' => 172,
212  'notin' => 8713,
213  'nsub' => 8836,
214  'Ntilde' => 209,
215  'ntilde' => 241,
216  'Nu' => 925,
217  'nu' => 957,
218  'Oacute' => 211,
219  'oacute' => 243,
220  'Ocirc' => 212,
221  'ocirc' => 244,
222  'OElig' => 338,
223  'oelig' => 339,
224  'Ograve' => 210,
225  'ograve' => 242,
226  'oline' => 8254,
227  'Omega' => 937,
228  'omega' => 969,
229  'Omicron' => 927,
230  'omicron' => 959,
231  'oplus' => 8853,
232  'or' => 8744,
233  'ordf' => 170,
234  'ordm' => 186,
235  'Oslash' => 216,
236  'oslash' => 248,
237  'Otilde' => 213,
238  'otilde' => 245,
239  'otimes' => 8855,
240  'Ouml' => 214,
241  'ouml' => 246,
242  'para' => 182,
243  'part' => 8706,
244  'permil' => 8240,
245  'perp' => 8869,
246  'Phi' => 934,
247  'phi' => 966,
248  'Pi' => 928,
249  'pi' => 960,
250  'piv' => 982,
251  'plusmn' => 177,
252  'pound' => 163,
253  'prime' => 8242,
254  'Prime' => 8243,
255  'prod' => 8719,
256  'prop' => 8733,
257  'Psi' => 936,
258  'psi' => 968,
259  'quot' => 34,
260  'radic' => 8730,
261  'rang' => 9002,
262  'raquo' => 187,
263  'rarr' => 8594,
264  'rArr' => 8658,
265  'rceil' => 8969,
266  'rdquo' => 8221,
267  'real' => 8476,
268  'reg' => 174,
269  'rfloor' => 8971,
270  'Rho' => 929,
271  'rho' => 961,
272  'rlm' => 8207,
273  'rsaquo' => 8250,
274  'rsquo' => 8217,
275  'sbquo' => 8218,
276  'Scaron' => 352,
277  'scaron' => 353,
278  'sdot' => 8901,
279  'sect' => 167,
280  'shy' => 173,
281  'Sigma' => 931,
282  'sigma' => 963,
283  'sigmaf' => 962,
284  'sim' => 8764,
285  'spades' => 9824,
286  'sub' => 8834,
287  'sube' => 8838,
288  'sum' => 8721,
289  'sup' => 8835,
290  'sup1' => 185,
291  'sup2' => 178,
292  'sup3' => 179,
293  'supe' => 8839,
294  'szlig' => 223,
295  'Tau' => 932,
296  'tau' => 964,
297  'there4' => 8756,
298  'Theta' => 920,
299  'theta' => 952,
300  'thetasym' => 977,
301  'thinsp' => 8201,
302  'THORN' => 222,
303  'thorn' => 254,
304  'tilde' => 732,
305  'times' => 215,
306  'trade' => 8482,
307  'Uacute' => 218,
308  'uacute' => 250,
309  'uarr' => 8593,
310  'uArr' => 8657,
311  'Ucirc' => 219,
312  'ucirc' => 251,
313  'Ugrave' => 217,
314  'ugrave' => 249,
315  'uml' => 168,
316  'upsih' => 978,
317  'Upsilon' => 933,
318  'upsilon' => 965,
319  'Uuml' => 220,
320  'uuml' => 252,
321  'weierp' => 8472,
322  'Xi' => 926,
323  'xi' => 958,
324  'Yacute' => 221,
325  'yacute' => 253,
326  'yen' => 165,
327  'Yuml' => 376,
328  'yuml' => 255,
329  'Zeta' => 918,
330  'zeta' => 950,
331  'zwj' => 8205,
332  'zwnj' => 8204
333  ];
334 
338  private static $htmlEntityAliases = [
339  'רלמ' => 'rlm',
340  'رلم' => 'rlm',
341  ];
342 
346  private static $attribsRegex;
347 
355  static function getAttribsRegex() {
356  if ( self::$attribsRegex === null ) {
357  $attribFirst = "[:_\p{L}\p{N}]";
358  $attrib = "[:_\.\-\p{L}\p{N}]";
359  $space = '[\x09\x0a\x0c\x0d\x20]';
360  self::$attribsRegex =
361  "/(?:^|$space)({$attribFirst}{$attrib}*)
362  ($space*=$space*
363  (?:
364  # The attribute value: quoted or alone
365  \"([^\"]*)(?:\"|\$)
366  | '([^']*)(?:'|\$)
367  | (((?!$space|>).)*)
368  )
369  )?(?=$space|\$)/sxu";
370  }
371  return self::$attribsRegex;
372  }
373 
380  public static function getRecognizedTagData( $extratags = [], $removetags = [] ) {
382 
383  static $htmlpairsStatic, $htmlsingle, $htmlsingleonly, $htmlnest, $tabletags,
384  $htmllist, $listtags, $htmlsingleallowed, $htmlelementsStatic, $staticInitialised;
385 
386  // Base our staticInitialised variable off of the global config state so that if the globals
387  // are changed (like in the screwed up test system) we will re-initialise the settings.
388  $globalContext = $wgAllowImageTag;
389  if ( !$staticInitialised || $staticInitialised != $globalContext ) {
390  $htmlpairsStatic = [ # Tags that must be closed
391  'b', 'bdi', 'del', 'i', 'ins', 'u', 'font', 'big', 'small', 'sub', 'sup', 'h1',
392  'h2', 'h3', 'h4', 'h5', 'h6', 'cite', 'code', 'em', 's',
393  'strike', 'strong', 'tt', 'var', 'div', 'center',
394  'blockquote', 'ol', 'ul', 'dl', 'table', 'caption', 'pre',
395  'ruby', 'rb', 'rp', 'rt', 'rtc', 'p', 'span', 'abbr', 'dfn',
396  'kbd', 'samp', 'data', 'time', 'mark'
397  ];
398  $htmlsingle = [
399  'br', 'wbr', 'hr', 'li', 'dt', 'dd', 'meta', 'link'
400  ];
401 
402  # Elements that cannot have close tags. This is (not coincidentally)
403  # also the list of tags for which the HTML 5 parsing algorithm
404  # requires you to "acknowledge the token's self-closing flag", i.e.
405  # a self-closing tag like <br/> is not an HTML 5 parse error only
406  # for this list.
407  $htmlsingleonly = [
408  'br', 'wbr', 'hr', 'meta', 'link'
409  ];
410 
411  $htmlnest = [ # Tags that can be nested--??
412  'table', 'tr', 'td', 'th', 'div', 'blockquote', 'ol', 'ul',
413  'li', 'dl', 'dt', 'dd', 'font', 'big', 'small', 'sub', 'sup', 'span',
414  'var', 'kbd', 'samp', 'em', 'strong', 'q', 'ruby', 'bdo'
415  ];
416  $tabletags = [ # Can only appear inside table, we will close them
417  'td', 'th', 'tr',
418  ];
419  $htmllist = [ # Tags used by list
420  'ul', 'ol',
421  ];
422  $listtags = [ # Tags that can appear in a list
423  'li',
424  ];
425 
426  if ( $wgAllowImageTag ) {
427  $htmlsingle[] = 'img';
428  $htmlsingleonly[] = 'img';
429  }
430 
431  $htmlsingleallowed = array_unique( array_merge( $htmlsingle, $tabletags ) );
432  $htmlelementsStatic = array_unique( array_merge( $htmlsingle, $htmlpairsStatic, $htmlnest ) );
433 
434  # Convert them all to hashtables for faster lookup
435  $vars = [ 'htmlpairsStatic', 'htmlsingle', 'htmlsingleonly', 'htmlnest', 'tabletags',
436  'htmllist', 'listtags', 'htmlsingleallowed', 'htmlelementsStatic' ];
437  foreach ( $vars as $var ) {
438  $$var = array_flip( $$var );
439  }
440  $staticInitialised = $globalContext;
441  }
442 
443  # Populate $htmlpairs and $htmlelements with the $extratags and $removetags arrays
444  $extratags = array_flip( $extratags );
445  $removetags = array_flip( $removetags );
446  $htmlpairs = array_merge( $extratags, $htmlpairsStatic );
447  $htmlelements = array_diff_key( array_merge( $extratags, $htmlelementsStatic ), $removetags );
448 
449  return [
450  'htmlpairs' => $htmlpairs,
451  'htmlsingle' => $htmlsingle,
452  'htmlsingleonly' => $htmlsingleonly,
453  'htmlnest' => $htmlnest,
454  'tabletags' => $tabletags,
455  'htmllist' => $htmllist,
456  'listtags' => $listtags,
457  'htmlsingleallowed' => $htmlsingleallowed,
458  'htmlelements' => $htmlelements,
459  ];
460  }
461 
477  public static function removeHTMLtags( $text, $processCallback = null,
478  $args = [], $extratags = [], $removetags = [], $warnCallback = null
479  ) {
480  extract( self::getRecognizedTagData( $extratags, $removetags ) );
481 
482  # Remove HTML comments
483  $text = self::removeHTMLcomments( $text );
484  $bits = explode( '<', $text );
485  $text = str_replace( '>', '&gt;', array_shift( $bits ) );
486  if ( !MWTidy::isEnabled() ) {
487  $tagstack = $tablestack = [];
488  foreach ( $bits as $x ) {
489  $regs = [];
490  # $slash: Does the current element start with a '/'?
491  # $t: Current element name
492  # $params: String between element name and >
493  # $brace: Ending '>' or '/>'
494  # $rest: Everything until the next element of $bits
495  if ( preg_match( self::ELEMENT_BITS_REGEX, $x, $regs ) ) {
496  list( /* $qbar */, $slash, $t, $params, $brace, $rest ) = $regs;
497  } else {
498  $slash = $t = $params = $brace = $rest = null;
499  }
500 
501  $badtag = false;
502  $t = strtolower( $t );
503  if ( isset( $htmlelements[$t] ) ) {
504  # Check our stack
505  if ( $slash && isset( $htmlsingleonly[$t] ) ) {
506  $badtag = true;
507  } elseif ( $slash ) {
508  # Closing a tag... is it the one we just opened?
509  MediaWiki\suppressWarnings();
510  $ot = array_pop( $tagstack );
511  MediaWiki\restoreWarnings();
512 
513  if ( $ot != $t ) {
514  if ( isset( $htmlsingleallowed[$ot] ) ) {
515  # Pop all elements with an optional close tag
516  # and see if we find a match below them
517  $optstack = [];
518  array_push( $optstack, $ot );
519  MediaWiki\suppressWarnings();
520  $ot = array_pop( $tagstack );
521  MediaWiki\restoreWarnings();
522  while ( $ot != $t && isset( $htmlsingleallowed[$ot] ) ) {
523  array_push( $optstack, $ot );
524  MediaWiki\suppressWarnings();
525  $ot = array_pop( $tagstack );
526  MediaWiki\restoreWarnings();
527  }
528  if ( $t != $ot ) {
529  # No match. Push the optional elements back again
530  $badtag = true;
531  MediaWiki\suppressWarnings();
532  $ot = array_pop( $optstack );
533  MediaWiki\restoreWarnings();
534  while ( $ot ) {
535  array_push( $tagstack, $ot );
536  MediaWiki\suppressWarnings();
537  $ot = array_pop( $optstack );
538  MediaWiki\restoreWarnings();
539  }
540  }
541  } else {
542  MediaWiki\suppressWarnings();
543  array_push( $tagstack, $ot );
544  MediaWiki\restoreWarnings();
545 
546  # <li> can be nested in <ul> or <ol>, skip those cases:
547  if ( !isset( $htmllist[$ot] ) || !isset( $listtags[$t] ) ) {
548  $badtag = true;
549  }
550  }
551  } else {
552  if ( $t == 'table' ) {
553  $tagstack = array_pop( $tablestack );
554  }
555  }
556  $newparams = '';
557  } else {
558  # Keep track for later
559  if ( isset( $tabletags[$t] ) && !in_array( 'table', $tagstack ) ) {
560  $badtag = true;
561  } elseif ( in_array( $t, $tagstack ) && !isset( $htmlnest[$t] ) ) {
562  $badtag = true;
563  #  Is it a self closed htmlpair ? (T7487)
564  } elseif ( $brace == '/>' && isset( $htmlpairs[$t] ) ) {
565  // Eventually we'll just remove the self-closing
566  // slash, in order to be consistent with HTML5
567  // semantics.
568  // $brace = '>';
569  // For now, let's just warn authors to clean up.
570  if ( is_callable( $warnCallback ) ) {
571  call_user_func_array( $warnCallback, [ 'deprecated-self-close-category' ] );
572  }
573  $badtag = true;
574  } elseif ( isset( $htmlsingleonly[$t] ) ) {
575  # Hack to force empty tag for unclosable elements
576  $brace = '/>';
577  } elseif ( isset( $htmlsingle[$t] ) ) {
578  # Hack to not close $htmlsingle tags
579  $brace = null;
580  # Still need to push this optionally-closed tag to
581  # the tag stack so that we can match end tags
582  # instead of marking them as bad.
583  array_push( $tagstack, $t );
584  } elseif ( isset( $tabletags[$t] ) && in_array( $t, $tagstack ) ) {
585  // New table tag but forgot to close the previous one
586  $text .= "</$t>";
587  } else {
588  if ( $t == 'table' ) {
589  array_push( $tablestack, $tagstack );
590  $tagstack = [];
591  }
592  array_push( $tagstack, $t );
593  }
594 
595  # Replace any variables or template parameters with
596  # plaintext results.
597  if ( is_callable( $processCallback ) ) {
598  call_user_func_array( $processCallback, [ &$params, $args ] );
599  }
600 
601  if ( !self::validateTag( $params, $t ) ) {
602  $badtag = true;
603  }
604 
605  # Strip non-approved attributes from the tag
606  $newparams = self::fixTagAttributes( $params, $t );
607  }
608  if ( !$badtag ) {
609  $rest = str_replace( '>', '&gt;', $rest );
610  $close = ( $brace == '/>' && !$slash ) ? ' /' : '';
611  $text .= "<$slash$t$newparams$close>$rest";
612  continue;
613  }
614  }
615  $text .= '&lt;' . str_replace( '>', '&gt;', $x );
616  }
617  # Close off any remaining tags
618  while ( is_array( $tagstack ) && ( $t = array_pop( $tagstack ) ) ) {
619  $text .= "</$t>\n";
620  if ( $t == 'table' ) {
621  $tagstack = array_pop( $tablestack );
622  }
623  }
624  } else {
625  # this might be possible using tidy itself
626  foreach ( $bits as $x ) {
627  if ( preg_match( self::ELEMENT_BITS_REGEX, $x, $regs ) ) {
628  list( /* $qbar */, $slash, $t, $params, $brace, $rest ) = $regs;
629 
630  $badtag = false;
631  $t = strtolower( $t );
632  if ( isset( $htmlelements[$t] ) ) {
633  if ( is_callable( $processCallback ) ) {
634  call_user_func_array( $processCallback, [ &$params, $args ] );
635  }
636 
637  if ( $brace == '/>' && !( isset( $htmlsingle[$t] ) || isset( $htmlsingleonly[$t] ) ) ) {
638  // Eventually we'll just remove the self-closing
639  // slash, in order to be consistent with HTML5
640  // semantics.
641  // $brace = '>';
642  // For now, let's just warn authors to clean up.
643  if ( is_callable( $warnCallback ) ) {
644  call_user_func_array( $warnCallback, [ 'deprecated-self-close-category' ] );
645  }
646  }
647  if ( !self::validateTag( $params, $t ) ) {
648  $badtag = true;
649  }
650 
651  $newparams = self::fixTagAttributes( $params, $t );
652  if ( !$badtag ) {
653  if ( $brace === '/>' && !isset( $htmlsingleonly[$t] ) ) {
654  # Interpret self-closing tags as empty tags even when
655  # HTML 5 would interpret them as start tags. Such input
656  # is commonly seen on Wikimedia wikis with this intention.
657  $brace = "></$t>";
658  }
659 
660  $rest = str_replace( '>', '&gt;', $rest );
661  $text .= "<$slash$t$newparams$brace$rest";
662  continue;
663  }
664  }
665  }
666  $text .= '&lt;' . str_replace( '>', '&gt;', $x );
667  }
668  }
669  return $text;
670  }
671 
681  public static function removeHTMLcomments( $text ) {
682  while ( ( $start = strpos( $text, '<!--' ) ) !== false ) {
683  $end = strpos( $text, '-->', $start + 4 );
684  if ( $end === false ) {
685  # Unterminated comment; bail out
686  break;
687  }
688 
689  $end += 3;
690 
691  # Trim space and newline if the comment is both
692  # preceded and followed by a newline
693  $spaceStart = max( $start - 1, 0 );
694  $spaceLen = $end - $spaceStart;
695  while ( substr( $text, $spaceStart, 1 ) === ' ' && $spaceStart > 0 ) {
696  $spaceStart--;
697  $spaceLen++;
698  }
699  while ( substr( $text, $spaceStart + $spaceLen, 1 ) === ' ' ) {
700  $spaceLen++;
701  }
702  if ( substr( $text, $spaceStart, 1 ) === "\n"
703  && substr( $text, $spaceStart + $spaceLen, 1 ) === "\n" ) {
704  # Remove the comment, leading and trailing
705  # spaces, and leave only one newline.
706  $text = substr_replace( $text, "\n", $spaceStart, $spaceLen + 1 );
707  } else {
708  # Remove just the comment.
709  $text = substr_replace( $text, '', $start, $end - $start );
710  }
711  }
712  return $text;
713  }
714 
727  static function validateTag( $params, $element ) {
728  $params = self::decodeTagAttributes( $params );
729 
730  if ( $element == 'meta' || $element == 'link' ) {
731  if ( !isset( $params['itemprop'] ) ) {
732  // <meta> and <link> must have an itemprop="" otherwise they are not valid or safe in content
733  return false;
734  }
735  if ( $element == 'meta' && !isset( $params['content'] ) ) {
736  // <meta> must have a content="" for the itemprop
737  return false;
738  }
739  if ( $element == 'link' && !isset( $params['href'] ) ) {
740  // <link> must have an associated href=""
741  return false;
742  }
743  }
744 
745  return true;
746  }
747 
763  static function validateTagAttributes( $attribs, $element ) {
764  return self::validateAttributes( $attribs,
765  self::attributeWhitelist( $element ) );
766  }
767 
783  static function validateAttributes( $attribs, $whitelist ) {
784  $whitelist = array_flip( $whitelist );
785  $hrefExp = '/^(' . wfUrlProtocols() . ')[^\s]+$/';
786 
787  $out = [];
788  foreach ( $attribs as $attribute => $value ) {
789  # Allow XML namespace declaration to allow RDFa
790  if ( preg_match( self::XMLNS_ATTRIBUTE_PATTERN, $attribute ) ) {
791  if ( !preg_match( self::EVIL_URI_PATTERN, $value ) ) {
792  $out[$attribute] = $value;
793  }
794 
795  continue;
796  }
797 
798  # Allow any attribute beginning with "data-"
799  # However:
800  # * Disallow data attributes used by MediaWiki code
801  # * Ensure that the attribute is not namespaced by banning
802  # colons.
803  if ( !preg_match( '/^data-[^:]*$/i', $attribute )
804  && !isset( $whitelist[$attribute] )
805  || self::isReservedDataAttribute( $attribute )
806  ) {
807  continue;
808  }
809 
810  # Strip javascript "expression" from stylesheets.
811  # https://msdn.microsoft.com/en-us/library/ms537634.aspx
812  if ( $attribute == 'style' ) {
813  $value = self::checkCss( $value );
814  }
815 
816  # Escape HTML id attributes
817  if ( $attribute === 'id' ) {
818  $value = self::escapeIdForAttribute( $value, self::ID_PRIMARY );
819  }
820 
821  # Escape HTML id reference lists
822  if ( $attribute === 'aria-describedby'
823  || $attribute === 'aria-flowto'
824  || $attribute === 'aria-labelledby'
825  || $attribute === 'aria-owns'
826  ) {
827  $value = self::escapeIdReferenceList( $value, 'noninitial' );
828  }
829 
830  // RDFa and microdata properties allow URLs, URIs and/or CURIs.
831  // Check them for sanity.
832  if ( $attribute === 'rel' || $attribute === 'rev'
833  # RDFa
834  || $attribute === 'about' || $attribute === 'property'
835  || $attribute === 'resource' || $attribute === 'datatype'
836  || $attribute === 'typeof'
837  # HTML5 microdata
838  || $attribute === 'itemid' || $attribute === 'itemprop'
839  || $attribute === 'itemref' || $attribute === 'itemscope'
840  || $attribute === 'itemtype'
841  ) {
842  // Paranoia. Allow "simple" values but suppress javascript
843  if ( preg_match( self::EVIL_URI_PATTERN, $value ) ) {
844  continue;
845  }
846  }
847 
848  # NOTE: even though elements using href/src are not allowed directly, supply
849  # validation code that can be used by tag hook handlers, etc
850  if ( $attribute === 'href' || $attribute === 'src' || $attribute === 'poster' ) {
851  if ( !preg_match( $hrefExp, $value ) ) {
852  continue; // drop any href or src attributes not using an allowed protocol.
853  // NOTE: this also drops all relative URLs
854  }
855  }
856 
857  // If this attribute was previously set, override it.
858  // Output should only have one attribute of each name.
859  $out[$attribute] = $value;
860  }
861 
862  # itemtype, itemid, itemref don't make sense without itemscope
863  if ( !array_key_exists( 'itemscope', $out ) ) {
864  unset( $out['itemtype'] );
865  unset( $out['itemid'] );
866  unset( $out['itemref'] );
867  }
868  # TODO: Strip itemprop if we aren't descendants of an itemscope or pointed to by an itemref.
869 
870  return $out;
871  }
872 
880  public static function isReservedDataAttribute( $attr ) {
881  // data-ooui is reserved for ooui.
882  // data-mw and data-parsoid are reserved for parsoid.
883  // data-mw-<name here> is reserved for extensions (or core) if
884  // they need to communicate some data to the client and want to be
885  // sure that it isn't coming from an untrusted user.
886  // We ignore the possibility of namespaces since user-generated HTML
887  // can't use them anymore.
888  return (bool)preg_match( '/^data-(ooui|mw|parsoid)/i', $attr );
889  }
890 
901  static function mergeAttributes( $a, $b ) {
902  $out = array_merge( $a, $b );
903  if ( isset( $a['class'] ) && isset( $b['class'] )
904  && is_string( $a['class'] ) && is_string( $b['class'] )
905  && $a['class'] !== $b['class']
906  ) {
907  $classes = preg_split( '/\s+/', "{$a['class']} {$b['class']}",
908  -1, PREG_SPLIT_NO_EMPTY );
909  $out['class'] = implode( ' ', array_unique( $classes ) );
910  }
911  return $out;
912  }
913 
923  public static function normalizeCss( $value ) {
924  // Decode character references like &#123;
925  $value = self::decodeCharReferences( $value );
926 
927  // Decode escape sequences and line continuation
928  // See the grammar in the CSS 2 spec, appendix D.
929  // This has to be done AFTER decoding character references.
930  // This means it isn't possible for this function to return
931  // unsanitized escape sequences. It is possible to manufacture
932  // input that contains character references that decode to
933  // escape sequences that decode to character references, but
934  // it's OK for the return value to contain character references
935  // because the caller is supposed to escape those anyway.
936  static $decodeRegex;
937  if ( !$decodeRegex ) {
938  $space = '[\\x20\\t\\r\\n\\f]';
939  $nl = '(?:\\n|\\r\\n|\\r|\\f)';
940  $backslash = '\\\\';
941  $decodeRegex = "/ $backslash
942  (?:
943  ($nl) | # 1. Line continuation
944  ([0-9A-Fa-f]{1,6})$space? | # 2. character number
945  (.) | # 3. backslash cancelling special meaning
946  () | # 4. backslash at end of string
947  )/xu";
948  }
949  $value = preg_replace_callback( $decodeRegex,
950  [ __CLASS__, 'cssDecodeCallback' ], $value );
951 
952  // Normalize Halfwidth and Fullwidth Unicode block that IE6 might treat as ascii
953  $value = preg_replace_callback(
954  '/[!-[]-z]/u', // U+FF01 to U+FF5A, excluding U+FF3C (T60088)
955  function ( $matches ) {
957  if ( $cp === false ) {
958  return '';
959  }
960  return chr( $cp - 65248 ); // ASCII range \x21-\x7A
961  },
962  $value
963  );
964 
965  // Convert more characters IE6 might treat as ascii
966  // U+0280, U+0274, U+207F, U+029F, U+026A, U+207D, U+208D
967  $value = str_replace(
968  [ 'ʀ', 'ɴ', 'ⁿ', 'ʟ', 'ɪ', '⁽', '₍' ],
969  [ 'r', 'n', 'n', 'l', 'i', '(', '(' ],
970  $value
971  );
972 
973  // Let the value through if it's nothing but a single comment, to
974  // allow other functions which may reject it to pass some error
975  // message through.
976  if ( !preg_match( '! ^ \s* /\* [^*\\/]* \*/ \s* $ !x', $value ) ) {
977  // Remove any comments; IE gets token splitting wrong
978  // This must be done AFTER decoding character references and
979  // escape sequences, because those steps can introduce comments
980  // This step cannot introduce character references or escape
981  // sequences, because it replaces comments with spaces rather
982  // than removing them completely.
983  $value = StringUtils::delimiterReplace( '/*', '*/', ' ', $value );
984 
985  // Remove anything after a comment-start token, to guard against
986  // incorrect client implementations.
987  $commentPos = strpos( $value, '/*' );
988  if ( $commentPos !== false ) {
989  $value = substr( $value, 0, $commentPos );
990  }
991  }
992 
993  // S followed by repeat, iteration, or prolonged sound marks,
994  // which IE will treat as "ss"
995  $value = preg_replace(
996  '/s(?:
997  \xE3\x80\xB1 | # U+3031
998  \xE3\x82\x9D | # U+309D
999  \xE3\x83\xBC | # U+30FC
1000  \xE3\x83\xBD | # U+30FD
1001  \xEF\xB9\xBC | # U+FE7C
1002  \xEF\xB9\xBD | # U+FE7D
1003  \xEF\xBD\xB0 # U+FF70
1004  )/ix',
1005  'ss',
1006  $value
1007  );
1008 
1009  return $value;
1010  }
1011 
1030  static function checkCss( $value ) {
1031  $value = self::normalizeCss( $value );
1032 
1033  // Reject problematic keywords and control characters
1034  if ( preg_match( '/[\000-\010\013\016-\037\177]/', $value ) ||
1035  strpos( $value, UtfNormal\Constants::UTF8_REPLACEMENT ) !== false ) {
1036  return '/* invalid control char */';
1037  } elseif ( preg_match(
1038  '! expression
1039  | filter\s*:
1040  | accelerator\s*:
1041  | -o-link\s*:
1042  | -o-link-source\s*:
1043  | -o-replace\s*:
1044  | url\s*\(
1045  | image\s*\(
1046  | image-set\s*\(
1047  | attr\s*\([^)]+[\s,]+url
1048  !ix', $value ) ) {
1049  return '/* insecure input */';
1050  }
1051  return $value;
1052  }
1053 
1058  static function cssDecodeCallback( $matches ) {
1059  if ( $matches[1] !== '' ) {
1060  // Line continuation
1061  return '';
1062  } elseif ( $matches[2] !== '' ) {
1063  $char = UtfNormal\Utils::codepointToUtf8( hexdec( $matches[2] ) );
1064  } elseif ( $matches[3] !== '' ) {
1065  $char = $matches[3];
1066  } else {
1067  $char = '\\';
1068  }
1069  if ( $char == "\n" || $char == '"' || $char == "'" || $char == '\\' ) {
1070  // These characters need to be escaped in strings
1071  // Clean up the escape sequence to avoid parsing errors by clients
1072  return '\\' . dechex( ord( $char ) ) . ' ';
1073  } else {
1074  // Decode unnecessary escape
1075  return $char;
1076  }
1077  }
1078 
1100  static function fixTagAttributes( $text, $element, $sorted = false ) {
1101  if ( trim( $text ) == '' ) {
1102  return '';
1103  }
1104 
1105  $decoded = self::decodeTagAttributes( $text );
1106  $stripped = self::validateTagAttributes( $decoded, $element );
1107 
1108  if ( $sorted ) {
1109  ksort( $stripped );
1110  }
1111 
1112  return self::safeEncodeTagAttributes( $stripped );
1113  }
1114 
1120  static function encodeAttribute( $text ) {
1121  $encValue = htmlspecialchars( $text, ENT_QUOTES );
1122 
1123  // Whitespace is normalized during attribute decoding,
1124  // so if we've been passed non-spaces we must encode them
1125  // ahead of time or they won't be preserved.
1126  $encValue = strtr( $encValue, [
1127  "\n" => '&#10;',
1128  "\r" => '&#13;',
1129  "\t" => '&#9;',
1130  ] );
1131 
1132  return $encValue;
1133  }
1134 
1141  static function safeEncodeAttribute( $text ) {
1142  $encValue = self::encodeAttribute( $text );
1143 
1144  # Templates and links may be expanded in later parsing,
1145  # creating invalid or dangerous output. Suppress this.
1146  $encValue = strtr( $encValue, [
1147  '<' => '&lt;', // This should never happen,
1148  '>' => '&gt;', // we've received invalid input
1149  '"' => '&quot;', // which should have been escaped.
1150  '{' => '&#123;',
1151  '}' => '&#125;', // prevent unpaired language conversion syntax
1152  '[' => '&#91;',
1153  "''" => '&#39;&#39;',
1154  'ISBN' => '&#73;SBN',
1155  'RFC' => '&#82;FC',
1156  'PMID' => '&#80;MID',
1157  '|' => '&#124;',
1158  '__' => '&#95;_',
1159  ] );
1160 
1161  # Stupid hack
1162  $encValue = preg_replace_callback(
1163  '/((?i)' . wfUrlProtocols() . ')/',
1164  [ 'Sanitizer', 'armorLinksCallback' ],
1165  $encValue );
1166  return $encValue;
1167  }
1168 
1202  static function escapeId( $id, $options = [] ) {
1204  $options = (array)$options;
1205 
1206  if ( $wgExperimentalHtmlIds && !in_array( 'legacy', $options ) ) {
1207  $id = preg_replace( '/[ \t\n\r\f_\'"&#%]+/', '_', $id );
1208  $id = trim( $id, '_' );
1209  if ( $id === '' ) {
1210  // Must have been all whitespace to start with.
1211  return '_';
1212  } else {
1213  return $id;
1214  }
1215  }
1216 
1217  // HTML4-style escaping
1218  static $replace = [
1219  '%3A' => ':',
1220  '%' => '.'
1221  ];
1222 
1223  $id = urlencode( strtr( $id, ' ', '_' ) );
1224  $id = strtr( $id, $replace );
1225 
1226  if ( !preg_match( '/^[a-zA-Z]/', $id ) && !in_array( 'noninitial', $options ) ) {
1227  // Initial character must be a letter!
1228  $id = "x$id";
1229  }
1230  return $id;
1231  }
1232 
1248  public static function escapeIdForAttribute( $id, $mode = self::ID_PRIMARY ) {
1250 
1251  if ( !isset( $wgFragmentMode[$mode] ) ) {
1252  if ( $mode === self::ID_PRIMARY ) {
1253  throw new UnexpectedValueException( '$wgFragmentMode is configured with no primary mode' );
1254  }
1255  return false;
1256  }
1257 
1258  $internalMode = $wgFragmentMode[$mode];
1259 
1260  return self::escapeIdInternal( $id, $internalMode );
1261  }
1262 
1275  public static function escapeIdForLink( $id ) {
1277 
1278  if ( !isset( $wgFragmentMode[self::ID_PRIMARY] ) ) {
1279  throw new UnexpectedValueException( '$wgFragmentMode is configured with no primary mode' );
1280  }
1281 
1282  $mode = $wgFragmentMode[self::ID_PRIMARY];
1283 
1284  $id = self::escapeIdInternal( $id, $mode );
1285 
1286  return $id;
1287  }
1288 
1298  public static function escapeIdForExternalInterwiki( $id ) {
1300 
1301  $id = self::escapeIdInternal( $id, $wgExternalInterwikiFragmentMode );
1302 
1303  return $id;
1304  }
1305 
1313  private static function escapeIdInternal( $id, $mode ) {
1314  switch ( $mode ) {
1315  case 'html5':
1316  $id = str_replace( ' ', '_', $id );
1317  break;
1318  case 'legacy':
1319  // This corresponds to 'noninitial' mode of the old escapeId()
1320  static $replace = [
1321  '%3A' => ':',
1322  '%' => '.'
1323  ];
1324 
1325  $id = urlencode( str_replace( ' ', '_', $id ) );
1326  $id = strtr( $id, $replace );
1327  break;
1328  case 'html5-legacy':
1329  $id = preg_replace( '/[ \t\n\r\f_\'"&#%]+/', '_', $id );
1330  $id = trim( $id, '_' );
1331  if ( $id === '' ) {
1332  // Must have been all whitespace to start with.
1333  $id = '_';
1334  }
1335  break;
1336  default:
1337  throw new InvalidArgumentException( "Invalid mode '$mode' passed to '" . __METHOD__ );
1338  }
1339 
1340  return $id;
1341  }
1342 
1355  static function escapeIdReferenceList( $referenceString, $options = [] ) {
1356  # Explode the space delimited list string into an array of tokens
1357  $references = preg_split( '/\s+/', "{$referenceString}", -1, PREG_SPLIT_NO_EMPTY );
1358 
1359  # Escape each token as an id
1360  foreach ( $references as &$ref ) {
1361  $ref = self::escapeIdForAttribute( $ref );
1362  }
1363 
1364  # Merge the array back to a space delimited list string
1365  # If the array is empty, the result will be an empty string ('')
1366  $referenceString = implode( ' ', $references );
1367 
1368  return $referenceString;
1369  }
1370 
1382  static function escapeClass( $class ) {
1383  // Convert ugly stuff to underscores and kill underscores in ugly places
1384  return rtrim( preg_replace(
1385  [ '/(^[0-9\\-])|[\\x00-\\x20!"#$%&\'()*+,.\\/:;<=>?@[\\]^`{|}~]|\\xC2\\xA0/', '/_+/' ],
1386  '_',
1387  $class ), '_' );
1388  }
1389 
1397  static function escapeHtmlAllowEntities( $html ) {
1398  $html = self::decodeCharReferences( $html );
1399  # It seems wise to escape ' as well as ", as a matter of course. Can't
1400  # hurt. Use ENT_SUBSTITUTE so that incorrectly truncated multibyte characters
1401  # don't cause the entire string to disappear.
1402  $html = htmlspecialchars( $html, ENT_QUOTES | ENT_SUBSTITUTE );
1403  return $html;
1404  }
1405 
1411  private static function armorLinksCallback( $matches ) {
1412  return str_replace( ':', '&#58;', $matches[1] );
1413  }
1414 
1423  public static function decodeTagAttributes( $text ) {
1424  if ( trim( $text ) == '' ) {
1425  return [];
1426  }
1427 
1428  $attribs = [];
1429  $pairs = [];
1430  if ( !preg_match_all(
1431  self::getAttribsRegex(),
1432  $text,
1433  $pairs,
1434  PREG_SET_ORDER ) ) {
1435  return $attribs;
1436  }
1437 
1438  foreach ( $pairs as $set ) {
1439  $attribute = strtolower( $set[1] );
1440  $value = self::getTagAttributeCallback( $set );
1441 
1442  // Normalize whitespace
1443  $value = preg_replace( '/[\t\r\n ]+/', ' ', $value );
1444  $value = trim( $value );
1445 
1446  // Decode character references
1447  $attribs[$attribute] = self::decodeCharReferences( $value );
1448  }
1449  return $attribs;
1450  }
1451 
1459  public static function safeEncodeTagAttributes( $assoc_array ) {
1460  $attribs = [];
1461  foreach ( $assoc_array as $attribute => $value ) {
1462  $encAttribute = htmlspecialchars( $attribute );
1463  $encValue = self::safeEncodeAttribute( $value );
1464 
1465  $attribs[] = "$encAttribute=\"$encValue\"";
1466  }
1467  return count( $attribs ) ? ' ' . implode( ' ', $attribs ) : '';
1468  }
1469 
1478  private static function getTagAttributeCallback( $set ) {
1479  if ( isset( $set[5] ) ) {
1480  # No quotes.
1481  return $set[5];
1482  } elseif ( isset( $set[4] ) ) {
1483  # Single-quoted
1484  return $set[4];
1485  } elseif ( isset( $set[3] ) ) {
1486  # Double-quoted
1487  return $set[3];
1488  } elseif ( !isset( $set[2] ) ) {
1489  # In XHTML, attributes must have a value so return an empty string.
1490  # See "Empty attribute syntax",
1491  # https://www.w3.org/TR/html5/syntax.html#syntax-attribute-name
1492  return "";
1493  } else {
1494  throw new MWException( "Tag conditions not met. This should never happen and is a bug." );
1495  }
1496  }
1497 
1502  private static function normalizeWhitespace( $text ) {
1503  return preg_replace(
1504  '/\r\n|[\x20\x0d\x0a\x09]/',
1505  ' ',
1506  $text );
1507  }
1508 
1517  static function normalizeSectionNameWhitespace( $section ) {
1518  return trim( preg_replace( '/[ _]+/', ' ', $section ) );
1519  }
1520 
1536  static function normalizeCharReferences( $text ) {
1537  return preg_replace_callback(
1538  self::CHAR_REFS_REGEX,
1539  [ 'Sanitizer', 'normalizeCharReferencesCallback' ],
1540  $text );
1541  }
1542 
1547  static function normalizeCharReferencesCallback( $matches ) {
1548  $ret = null;
1549  if ( $matches[1] != '' ) {
1550  $ret = self::normalizeEntity( $matches[1] );
1551  } elseif ( $matches[2] != '' ) {
1552  $ret = self::decCharReference( $matches[2] );
1553  } elseif ( $matches[3] != '' ) {
1554  $ret = self::hexCharReference( $matches[3] );
1555  }
1556  if ( is_null( $ret ) ) {
1557  return htmlspecialchars( $matches[0] );
1558  } else {
1559  return $ret;
1560  }
1561  }
1562 
1573  static function normalizeEntity( $name ) {
1574  if ( isset( self::$htmlEntityAliases[$name] ) ) {
1575  return '&' . self::$htmlEntityAliases[$name] . ';';
1576  } elseif ( in_array( $name, [ 'lt', 'gt', 'amp', 'quot' ] ) ) {
1577  return "&$name;";
1578  } elseif ( isset( self::$htmlEntities[$name] ) ) {
1579  return '&#' . self::$htmlEntities[$name] . ';';
1580  } else {
1581  return "&amp;$name;";
1582  }
1583  }
1584 
1589  static function decCharReference( $codepoint ) {
1590  $point = intval( $codepoint );
1591  if ( self::validateCodepoint( $point ) ) {
1592  return sprintf( '&#%d;', $point );
1593  } else {
1594  return null;
1595  }
1596  }
1597 
1602  static function hexCharReference( $codepoint ) {
1603  $point = hexdec( $codepoint );
1604  if ( self::validateCodepoint( $point ) ) {
1605  return sprintf( '&#x%x;', $point );
1606  } else {
1607  return null;
1608  }
1609  }
1610 
1617  private static function validateCodepoint( $codepoint ) {
1618  # U+000C is valid in HTML5 but not allowed in XML.
1619  # U+000D is valid in XML but not allowed in HTML5.
1620  # U+007F - U+009F are disallowed in HTML5 (control characters).
1621  return $codepoint == 0x09
1622  || $codepoint == 0x0a
1623  || ( $codepoint >= 0x20 && $codepoint <= 0x7e )
1624  || ( $codepoint >= 0xa0 && $codepoint <= 0xd7ff )
1625  || ( $codepoint >= 0xe000 && $codepoint <= 0xfffd )
1626  || ( $codepoint >= 0x10000 && $codepoint <= 0x10ffff );
1627  }
1628 
1636  public static function decodeCharReferences( $text ) {
1637  return preg_replace_callback(
1638  self::CHAR_REFS_REGEX,
1639  [ 'Sanitizer', 'decodeCharReferencesCallback' ],
1640  $text );
1641  }
1642 
1653  public static function decodeCharReferencesAndNormalize( $text ) {
1655  $text = preg_replace_callback(
1656  self::CHAR_REFS_REGEX,
1657  [ 'Sanitizer', 'decodeCharReferencesCallback' ],
1658  $text,
1659  -1, //limit
1660  $count
1661  );
1662 
1663  if ( $count ) {
1664  return $wgContLang->normalize( $text );
1665  } else {
1666  return $text;
1667  }
1668  }
1669 
1674  static function decodeCharReferencesCallback( $matches ) {
1675  if ( $matches[1] != '' ) {
1676  return self::decodeEntity( $matches[1] );
1677  } elseif ( $matches[2] != '' ) {
1678  return self::decodeChar( intval( $matches[2] ) );
1679  } elseif ( $matches[3] != '' ) {
1680  return self::decodeChar( hexdec( $matches[3] ) );
1681  }
1682  # Last case should be an ampersand by itself
1683  return $matches[0];
1684  }
1685 
1693  static function decodeChar( $codepoint ) {
1694  if ( self::validateCodepoint( $codepoint ) ) {
1695  return UtfNormal\Utils::codepointToUtf8( $codepoint );
1696  } else {
1698  }
1699  }
1700 
1709  static function decodeEntity( $name ) {
1710  if ( isset( self::$htmlEntityAliases[$name] ) ) {
1711  $name = self::$htmlEntityAliases[$name];
1712  }
1713  if ( isset( self::$htmlEntities[$name] ) ) {
1714  return UtfNormal\Utils::codepointToUtf8( self::$htmlEntities[$name] );
1715  } else {
1716  return "&$name;";
1717  }
1718  }
1719 
1726  static function attributeWhitelist( $element ) {
1727  $list = self::setupAttributeWhitelist();
1728  return isset( $list[$element] )
1729  ? $list[$element]
1730  : [];
1731  }
1732 
1738  static function setupAttributeWhitelist() {
1739  static $whitelist;
1740 
1741  if ( $whitelist !== null ) {
1742  return $whitelist;
1743  }
1744 
1745  $common = [
1746  # HTML
1747  'id',
1748  'class',
1749  'style',
1750  'lang',
1751  'dir',
1752  'title',
1753 
1754  # WAI-ARIA
1755  'aria-describedby',
1756  'aria-flowto',
1757  'aria-label',
1758  'aria-labelledby',
1759  'aria-owns',
1760  'role',
1761 
1762  # RDFa
1763  # These attributes are specified in section 9 of
1764  # https://www.w3.org/TR/2008/REC-rdfa-syntax-20081014
1765  'about',
1766  'property',
1767  'resource',
1768  'datatype',
1769  'typeof',
1770 
1771  # Microdata. These are specified by
1772  # https://html.spec.whatwg.org/multipage/microdata.html#the-microdata-model
1773  'itemid',
1774  'itemprop',
1775  'itemref',
1776  'itemscope',
1777  'itemtype',
1778  ];
1779 
1780  $block = array_merge( $common, [ 'align' ] );
1781  $tablealign = [ 'align', 'valign' ];
1782  $tablecell = [
1783  'abbr',
1784  'axis',
1785  'headers',
1786  'scope',
1787  'rowspan',
1788  'colspan',
1789  'nowrap', # deprecated
1790  'width', # deprecated
1791  'height', # deprecated
1792  'bgcolor', # deprecated
1793  ];
1794 
1795  # Numbers refer to sections in HTML 4.01 standard describing the element.
1796  # See: https://www.w3.org/TR/html4/
1797  $whitelist = [
1798  # 7.5.4
1799  'div' => $block,
1800  'center' => $common, # deprecated
1801  'span' => $common,
1802 
1803  # 7.5.5
1804  'h1' => $block,
1805  'h2' => $block,
1806  'h3' => $block,
1807  'h4' => $block,
1808  'h5' => $block,
1809  'h6' => $block,
1810 
1811  # 7.5.6
1812  # address
1813 
1814  # 8.2.4
1815  'bdo' => $common,
1816 
1817  # 9.2.1
1818  'em' => $common,
1819  'strong' => $common,
1820  'cite' => $common,
1821  'dfn' => $common,
1822  'code' => $common,
1823  'samp' => $common,
1824  'kbd' => $common,
1825  'var' => $common,
1826  'abbr' => $common,
1827  # acronym
1828 
1829  # 9.2.2
1830  'blockquote' => array_merge( $common, [ 'cite' ] ),
1831  'q' => array_merge( $common, [ 'cite' ] ),
1832 
1833  # 9.2.3
1834  'sub' => $common,
1835  'sup' => $common,
1836 
1837  # 9.3.1
1838  'p' => $block,
1839 
1840  # 9.3.2
1841  'br' => array_merge( $common, [ 'clear' ] ),
1842 
1843  # https://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element
1844  'wbr' => $common,
1845 
1846  # 9.3.4
1847  'pre' => array_merge( $common, [ 'width' ] ),
1848 
1849  # 9.4
1850  'ins' => array_merge( $common, [ 'cite', 'datetime' ] ),
1851  'del' => array_merge( $common, [ 'cite', 'datetime' ] ),
1852 
1853  # 10.2
1854  'ul' => array_merge( $common, [ 'type' ] ),
1855  'ol' => array_merge( $common, [ 'type', 'start', 'reversed' ] ),
1856  'li' => array_merge( $common, [ 'type', 'value' ] ),
1857 
1858  # 10.3
1859  'dl' => $common,
1860  'dd' => $common,
1861  'dt' => $common,
1862 
1863  # 11.2.1
1864  'table' => array_merge( $common,
1865  [ 'summary', 'width', 'border', 'frame',
1866  'rules', 'cellspacing', 'cellpadding',
1867  'align', 'bgcolor',
1868  ] ),
1869 
1870  # 11.2.2
1871  'caption' => $block,
1872 
1873  # 11.2.3
1874  'thead' => $common,
1875  'tfoot' => $common,
1876  'tbody' => $common,
1877 
1878  # 11.2.4
1879  'colgroup' => array_merge( $common, [ 'span' ] ),
1880  'col' => array_merge( $common, [ 'span' ] ),
1881 
1882  # 11.2.5
1883  'tr' => array_merge( $common, [ 'bgcolor' ], $tablealign ),
1884 
1885  # 11.2.6
1886  'td' => array_merge( $common, $tablecell, $tablealign ),
1887  'th' => array_merge( $common, $tablecell, $tablealign ),
1888 
1889  # 12.2
1890  # NOTE: <a> is not allowed directly, but the attrib
1891  # whitelist is used from the Parser object
1892  'a' => array_merge( $common, [ 'href', 'rel', 'rev' ] ), # rel/rev esp. for RDFa
1893 
1894  # 13.2
1895  # Not usually allowed, but may be used for extension-style hooks
1896  # such as <math> when it is rasterized, or if $wgAllowImageTag is
1897  # true
1898  'img' => array_merge( $common, [ 'alt', 'src', 'width', 'height', 'srcset' ] ),
1899 
1900  'video' => array_merge( $common, [ 'poster', 'controls', 'preload', 'width', 'height' ] ),
1901  'source' => array_merge( $common, [ 'type', 'src' ] ),
1902  'track' => array_merge( $common, [ 'type', 'src', 'srclang', 'kind', 'label' ] ),
1903 
1904  # 15.2.1
1905  'tt' => $common,
1906  'b' => $common,
1907  'i' => $common,
1908  'big' => $common,
1909  'small' => $common,
1910  'strike' => $common,
1911  's' => $common,
1912  'u' => $common,
1913 
1914  # 15.2.2
1915  'font' => array_merge( $common, [ 'size', 'color', 'face' ] ),
1916  # basefont
1917 
1918  # 15.3
1919  'hr' => array_merge( $common, [ 'width' ] ),
1920 
1921  # HTML Ruby annotation text module, simple ruby only.
1922  # https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element
1923  'ruby' => $common,
1924  # rbc
1925  'rb' => $common,
1926  'rp' => $common,
1927  'rt' => $common, # array_merge( $common, array( 'rbspan' ) ),
1928  'rtc' => $common,
1929 
1930  # MathML root element, where used for extensions
1931  # 'title' may not be 100% valid here; it's XHTML
1932  # https://www.w3.org/TR/REC-MathML/
1933  'math' => [ 'class', 'style', 'id', 'title' ],
1934 
1935  // HTML 5 section 4.5
1936  'figure' => $common,
1937  'figcaption' => $common,
1938 
1939  # HTML 5 section 4.6
1940  'bdi' => $common,
1941 
1942  # HTML5 elements, defined by:
1943  # https://html.spec.whatwg.org/multipage/semantics.html#the-data-element
1944  'data' => array_merge( $common, [ 'value' ] ),
1945  'time' => array_merge( $common, [ 'datetime' ] ),
1946  'mark' => $common,
1947 
1948  // meta and link are only permitted by removeHTMLtags when Microdata
1949  // is enabled so we don't bother adding a conditional to hide these
1950  // Also meta and link are only valid in WikiText as Microdata elements
1951  // (ie: validateTag rejects tags missing the attributes needed for Microdata)
1952  // So we don't bother including $common attributes that have no purpose.
1953  'meta' => [ 'itemprop', 'content' ],
1954  'link' => [ 'itemprop', 'href', 'title' ],
1955  ];
1956 
1957  return $whitelist;
1958  }
1959 
1970  static function stripAllTags( $text ) {
1971  # Actual <tags>
1972  $text = StringUtils::delimiterReplace( '<', '>', '', $text );
1973 
1974  # Normalize &entities and whitespace
1975  $text = self::decodeCharReferences( $text );
1976  $text = self::normalizeWhitespace( $text );
1977 
1978  return $text;
1979  }
1980 
1990  static function hackDocType() {
1991  $out = "<!DOCTYPE html [\n";
1992  foreach ( self::$htmlEntities as $entity => $codepoint ) {
1993  $out .= "<!ENTITY $entity \"&#$codepoint;\">";
1994  }
1995  $out .= "]>\n";
1996  return $out;
1997  }
1998 
2003  static function cleanUrl( $url ) {
2004  # Normalize any HTML entities in input. They will be
2005  # re-escaped by makeExternalLink().
2006  $url = self::decodeCharReferences( $url );
2007 
2008  # Escape any control characters introduced by the above step
2009  $url = preg_replace_callback( '/[\][<>"\\x00-\\x20\\x7F\|]/',
2010  [ __CLASS__, 'cleanUrlCallback' ], $url );
2011 
2012  # Validate hostname portion
2013  $matches = [];
2014  if ( preg_match( '!^([^:]+:)(//[^/]+)?(.*)$!iD', $url, $matches ) ) {
2015  list( /* $whole */, $protocol, $host, $rest ) = $matches;
2016 
2017  // Characters that will be ignored in IDNs.
2018  // https://tools.ietf.org/html/rfc3454#section-3.1
2019  // Strip them before further processing so blacklists and such work.
2020  $strip = "/
2021  \\s| # general whitespace
2022  \xc2\xad| # 00ad SOFT HYPHEN
2023  \xe1\xa0\x86| # 1806 MONGOLIAN TODO SOFT HYPHEN
2024  \xe2\x80\x8b| # 200b ZERO WIDTH SPACE
2025  \xe2\x81\xa0| # 2060 WORD JOINER
2026  \xef\xbb\xbf| # feff ZERO WIDTH NO-BREAK SPACE
2027  \xcd\x8f| # 034f COMBINING GRAPHEME JOINER
2028  \xe1\xa0\x8b| # 180b MONGOLIAN FREE VARIATION SELECTOR ONE
2029  \xe1\xa0\x8c| # 180c MONGOLIAN FREE VARIATION SELECTOR TWO
2030  \xe1\xa0\x8d| # 180d MONGOLIAN FREE VARIATION SELECTOR THREE
2031  \xe2\x80\x8c| # 200c ZERO WIDTH NON-JOINER
2032  \xe2\x80\x8d| # 200d ZERO WIDTH JOINER
2033  [\xef\xb8\x80-\xef\xb8\x8f] # fe00-fe0f VARIATION SELECTOR-1-16
2034  /xuD";
2035 
2036  $host = preg_replace( $strip, '', $host );
2037 
2038  // IPv6 host names are bracketed with []. Url-decode these.
2039  if ( substr_compare( "//%5B", $host, 0, 5 ) === 0 &&
2040  preg_match( '!^//%5B([0-9A-Fa-f:.]+)%5D((:\d+)?)$!', $host, $matches )
2041  ) {
2042  $host = '//[' . $matches[1] . ']' . $matches[2];
2043  }
2044 
2045  // @todo FIXME: Validate hostnames here
2046 
2047  return $protocol . $host . $rest;
2048  } else {
2049  return $url;
2050  }
2051  }
2052 
2057  static function cleanUrlCallback( $matches ) {
2058  return urlencode( $matches[0] );
2059  }
2060 
2089  public static function validateEmail( $addr ) {
2090  $result = null;
2091  if ( !Hooks::run( 'isValidEmailAddr', [ $addr, &$result ] ) ) {
2092  return $result;
2093  }
2094 
2095  // Please note strings below are enclosed in brackets [], this make the
2096  // hyphen "-" a range indicator. Hence it is double backslashed below.
2097  // See T28948
2098  $rfc5322_atext = "a-z0-9!#$%&'*+\\-\/=?^_`{|}~";
2099  $rfc1034_ldh_str = "a-z0-9\\-";
2100 
2101  $html5_email_regexp = "/
2102  ^ # start of string
2103  [$rfc5322_atext\\.]+ # user part which is liberal :p
2104  @ # 'apostrophe'
2105  [$rfc1034_ldh_str]+ # First domain part
2106  (\\.[$rfc1034_ldh_str]+)* # Following part prefixed with a dot
2107  $ # End of string
2108  /ix"; // case Insensitive, eXtended
2109 
2110  return (bool)preg_match( $html5_email_regexp, $addr );
2111  }
2112 }
$wgExperimentalHtmlIds
$wgExperimentalHtmlIds
Abandoned experiment with HTML5-style ID escaping.
Definition: DefaultSettings.php:3362
$wgExternalInterwikiFragmentMode
$wgExternalInterwikiFragmentMode
Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragment...
Definition: DefaultSettings.php:3404
captcha-old.count
count
Definition: captcha-old.py:249
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1963
$params
$params
Definition: styleTest.css.php:40
$wgFragmentMode
$wgFragmentMode
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of...
Definition: DefaultSettings.php:3394
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
MWTidy\isEnabled
static isEnabled()
Definition: MWTidy.php:79
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$wgAllowImageTag
$wgAllowImageTag
A different approach to the above: simply allow the "<img>" tag to be used.
Definition: DefaultSettings.php:4278
codepointToUtf8
codepointToUtf8( $codepoint)
Return UTF-8 sequence for a given Unicode code point.
Definition: UtfNormalUtil.php:39
$html
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1965
MWException
MediaWiki exception.
Definition: MWException.php:26
a
</source > ! result< div class="mw-highlight mw-content-ltr" dir="ltr">< pre >< span ></span >< span class="kd"> var</span >< span class="nx"> a</span >< span class="p"></span ></pre ></div > ! end ! test Multiline< source/> in lists !input *< source > a b</source > *foo< source > a b</source > ! html< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! html tidy< ul >< li >< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul >< ul >< li > foo< div class="mw-highlight mw-content-ltr" dir="ltr">< pre > a b</pre ></div ></li ></ul > ! end ! test Custom attributes !input< source lang="javascript" id="foo" class="bar" dir="rtl" style="font-size: larger;"> var a
Definition: parserTests.txt:89
table
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition: deferred.txt:11
UtfNormal
Unicode normalization routines for working with UTF-8 strings.
Definition: UtfNormal.php:48
$matches
$matches
Definition: NoLocalSettings.php:24
in
null for the wiki Added in
Definition: hooks.txt:1581
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1965
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
$vars
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2198
by
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
Definition: APACHE-LICENSE-2.0.txt:49
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
will
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
Definition: All_system_messages.txt:914
wfUrlProtocols
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
Definition: GlobalFunctions.php:792
$value
$value
Definition: styleTest.css.php:45
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1965
UTF8_REPLACEMENT
const UTF8_REPLACEMENT
Definition: UtfNormalDefines.php:145
$args
if( $line===false) $args
Definition: cdb.php:63
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1965
used
you don t have to do a grep find to see where the $wgReverseTitle variable is used
Definition: hooks.txt:115
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:2981
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
StringUtils\delimiterReplace
static delimiterReplace( $startDelim, $endDelim, $replace, $subject, $flags='')
Perform an operation equivalent to preg_replace() with flags.
Definition: StringUtils.php:257
utf8ToCodepoint
utf8ToCodepoint( $char)
Determine the Unicode codepoint of a single-character UTF-8 sequence.
Definition: UtfNormalUtil.php:85
that
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if that
Definition: deferred.txt:11
$t
$t
Definition: testCompression.php:67
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56
them
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing them
Definition: hooks.txt:988
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:781