includes/Sanitizer.php

   1 <?php
   2 /**
   3  * XHTML sanitizer for MediaWiki
   4  *
   5  * Copyright (C) 2002-2005 Brion Vibber <brion@pobox.com> et al
   6  * http://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Parser
  25  */
  26
  27 /**
  28  * Regular expression to match various types of character references in
  29  * Sanitizer::normalizeCharReferences and Sanitizer::decodeCharReferences
  30  */
  31 define( 'MW_CHAR_REFS_REGEX',
  32         '/&([A-Za-z0-9\x80-\xff]+);
  33          |&\#([0-9]+);
  34          |&\#x([0-9A-Za-z]+);
  35          |&\#X([0-9A-Za-z]+);
  36          |(&)/x' );
  37
  38 /**
  39  * Regular expression to match HTML/XML attribute pairs within a tag.
  40  * Allows some... latitude.
  41  * Used in Sanitizer::fixTagAttributes and Sanitizer::decodeTagAttributes
  42  */
  43 $attrib = '[A-Za-z0-9]';
  44 $space = '[\x09\x0a\x0d\x20]';
  45 define( 'MW_ATTRIBS_REGEX',
  46         "/(?:^|$space)((?:xml:|xmlns:)?$attrib+)
  47           ($space*=$space*
  48                 (?:
  49                  # The attribute value: quoted or alone
  50                   \"([^<\"]*)\"
  51                  | '([^<']*)'
  52                  |  ([a-zA-Z0-9!#$%&()*,\\-.\\/:;<>?@[\\]^_`{|}~]+)
  53                  |  (\#[0-9a-fA-F]+) # Technically wrong, but lots of
  54                                                          # colors are specified like this.
  55                                                          # We'll be normalizing it.
  56                 )
  57            )?(?=$space|\$)/sx" );
  58
  59 /**
  60  * Regular expression to match URIs that could trigger script execution
  61  */
  62 define( 'MW_EVIL_URI_PATTERN', '!(^|\s|\*/\s*)(javascript|vbscript)([^\w]|$)!i' );
  63
  64 /**
  65  * Regular expression to match namespace attributes
  66  */
  67 define( 'MW_XMLNS_ATTRIBUTE_PATTRN', "/^xmlns:$attrib+$/" );
  68
  69 /**
  70  * List of all named character entities defined in HTML 4.01
  71  * http://www.w3.org/TR/html4/sgml/entities.html
  72  * @private
  73  */
  74 global $wgHtmlEntities;
  75 $wgHtmlEntities = array(
  76         'Aacute'   => 193,
  77         'aacute'   => 225,
  78         'Acirc'    => 194,
  79         'acirc'    => 226,
  80         'acute'    => 180,
  81         'AElig'    => 198,
  82         'aelig'    => 230,
  83         'Agrave'   => 192,
  84         'agrave'   => 224,
  85         'alefsym'  => 8501,
  86         'Alpha'    => 913,
  87         'alpha'    => 945,
  88         'amp'      => 38,
  89         'and'      => 8743,
  90         'ang'      => 8736,
  91         'Aring'    => 197,
  92         'aring'    => 229,
  93         'asymp'    => 8776,
  94         'Atilde'   => 195,
  95         'atilde'   => 227,
  96         'Auml'     => 196,
  97         'auml'     => 228,
  98         'bdquo'    => 8222,
  99         'Beta'     => 914,
 100         'beta'     => 946,
 101         'brvbar'   => 166,
 102         'bull'     => 8226,
 103         'cap'      => 8745,
 104         'Ccedil'   => 199,
 105         'ccedil'   => 231,
 106         'cedil'    => 184,
 107         'cent'     => 162,
 108         'Chi'      => 935,
 109         'chi'      => 967,
 110         'circ'     => 710,
 111         'clubs'    => 9827,
 112         'cong'     => 8773,
 113         'copy'     => 169,
 114         'crarr'    => 8629,
 115         'cup'      => 8746,
 116         'curren'   => 164,
 117         'dagger'   => 8224,
 118         'Dagger'   => 8225,
 119         'darr'     => 8595,
 120         'dArr'     => 8659,
 121         'deg'      => 176,
 122         'Delta'    => 916,
 123         'delta'    => 948,
 124         'diams'    => 9830,
 125         'divide'   => 247,
 126         'Eacute'   => 201,
 127         'eacute'   => 233,
 128         'Ecirc'    => 202,
 129         'ecirc'    => 234,
 130         'Egrave'   => 200,
 131         'egrave'   => 232,
 132         'empty'    => 8709,
 133         'emsp'     => 8195,
 134         'ensp'     => 8194,
 135         'Epsilon'  => 917,
 136         'epsilon'  => 949,
 137         'equiv'    => 8801,
 138         'Eta'      => 919,
 139         'eta'      => 951,
 140         'ETH'      => 208,
 141         'eth'      => 240,
 142         'Euml'     => 203,
 143         'euml'     => 235,
 144         'euro'     => 8364,
 145         'exist'    => 8707,
 146         'fnof'     => 402,
 147         'forall'   => 8704,
 148         'frac12'   => 189,
 149         'frac14'   => 188,
 150         'frac34'   => 190,
 151         'frasl'    => 8260,
 152         'Gamma'    => 915,
 153         'gamma'    => 947,
 154         'ge'       => 8805,
 155         'gt'       => 62,
 156         'harr'     => 8596,
 157         'hArr'     => 8660,
 158         'hearts'   => 9829,
 159         'hellip'   => 8230,
 160         'Iacute'   => 205,
 161         'iacute'   => 237,
 162         'Icirc'    => 206,
 163         'icirc'    => 238,
 164         'iexcl'    => 161,
 165         'Igrave'   => 204,
 166         'igrave'   => 236,
 167         'image'    => 8465,
 168         'infin'    => 8734,
 169         'int'      => 8747,
 170         'Iota'     => 921,
 171         'iota'     => 953,
 172         'iquest'   => 191,
 173         'isin'     => 8712,
 174         'Iuml'     => 207,
 175         'iuml'     => 239,
 176         'Kappa'    => 922,
 177         'kappa'    => 954,
 178         'Lambda'   => 923,
 179         'lambda'   => 955,
 180         'lang'     => 9001,
 181         'laquo'    => 171,
 182         'larr'     => 8592,
 183         'lArr'     => 8656,
 184         'lceil'    => 8968,
 185         'ldquo'    => 8220,
 186         'le'       => 8804,
 187         'lfloor'   => 8970,
 188         'lowast'   => 8727,
 189         'loz'      => 9674,
 190         'lrm'      => 8206,
 191         'lsaquo'   => 8249,
 192         'lsquo'    => 8216,
 193         'lt'       => 60,
 194         'macr'     => 175,
 195         'mdash'    => 8212,
 196         'micro'    => 181,
 197         'middot'   => 183,
 198         'minus'    => 8722,
 199         'Mu'       => 924,
 200         'mu'       => 956,
 201         'nabla'    => 8711,
 202         'nbsp'     => 160,
 203         'ndash'    => 8211,
 204         'ne'       => 8800,
 205         'ni'       => 8715,
 206         'not'      => 172,
 207         'notin'    => 8713,
 208         'nsub'     => 8836,
 209         'Ntilde'   => 209,
 210         'ntilde'   => 241,
 211         'Nu'       => 925,
 212         'nu'       => 957,
 213         'Oacute'   => 211,
 214         'oacute'   => 243,
 215         'Ocirc'    => 212,
 216         'ocirc'    => 244,
 217         'OElig'    => 338,
 218         'oelig'    => 339,
 219         'Ograve'   => 210,
 220         'ograve'   => 242,
 221         'oline'    => 8254,
 222         'Omega'    => 937,
 223         'omega'    => 969,
 224         'Omicron'  => 927,
 225         'omicron'  => 959,
 226         'oplus'    => 8853,
 227         'or'       => 8744,
 228         'ordf'     => 170,
 229         'ordm'     => 186,
 230         'Oslash'   => 216,
 231         'oslash'   => 248,
 232         'Otilde'   => 213,
 233         'otilde'   => 245,
 234         'otimes'   => 8855,
 235         'Ouml'     => 214,
 236         'ouml'     => 246,
 237         'para'     => 182,
 238         'part'     => 8706,
 239         'permil'   => 8240,
 240         'perp'     => 8869,
 241         'Phi'      => 934,
 242         'phi'      => 966,
 243         'Pi'       => 928,
 244         'pi'       => 960,
 245         'piv'      => 982,
 246         'plusmn'   => 177,
 247         'pound'    => 163,
 248         'prime'    => 8242,
 249         'Prime'    => 8243,
 250         'prod'     => 8719,
 251         'prop'     => 8733,
 252         'Psi'      => 936,
 253         'psi'      => 968,
 254         'quot'     => 34,
 255         'radic'    => 8730,
 256         'rang'     => 9002,
 257         'raquo'    => 187,
 258         'rarr'     => 8594,
 259         'rArr'     => 8658,
 260         'rceil'    => 8969,
 261         'rdquo'    => 8221,
 262         'real'     => 8476,
 263         'reg'      => 174,
 264         'rfloor'   => 8971,
 265         'Rho'      => 929,
 266         'rho'      => 961,
 267         'rlm'      => 8207,
 268         'rsaquo'   => 8250,
 269         'rsquo'    => 8217,
 270         'sbquo'    => 8218,
 271         'Scaron'   => 352,
 272         'scaron'   => 353,
 273         'sdot'     => 8901,
 274         'sect'     => 167,
 275         'shy'      => 173,
 276         'Sigma'    => 931,
 277         'sigma'    => 963,
 278         'sigmaf'   => 962,
 279         'sim'      => 8764,
 280         'spades'   => 9824,
 281         'sub'      => 8834,
 282         'sube'     => 8838,
 283         'sum'      => 8721,
 284         'sup'      => 8835,
 285         'sup1'     => 185,
 286         'sup2'     => 178,
 287         'sup3'     => 179,
 288         'supe'     => 8839,
 289         'szlig'    => 223,
 290         'Tau'      => 932,
 291         'tau'      => 964,
 292         'there4'   => 8756,
 293         'Theta'    => 920,
 294         'theta'    => 952,
 295         'thetasym' => 977,
 296         'thinsp'   => 8201,
 297         'THORN'    => 222,
 298         'thorn'    => 254,
 299         'tilde'    => 732,
 300         'times'    => 215,
 301         'trade'    => 8482,
 302         'Uacute'   => 218,
 303         'uacute'   => 250,
 304         'uarr'     => 8593,
 305         'uArr'     => 8657,
 306         'Ucirc'    => 219,
 307         'ucirc'    => 251,
 308         'Ugrave'   => 217,
 309         'ugrave'   => 249,
 310         'uml'      => 168,
 311         'upsih'    => 978,
 312         'Upsilon'  => 933,
 313         'upsilon'  => 965,
 314         'Uuml'     => 220,
 315         'uuml'     => 252,
 316         'weierp'   => 8472,
 317         'Xi'       => 926,
 318         'xi'       => 958,
 319         'Yacute'   => 221,
 320         'yacute'   => 253,
 321         'yen'      => 165,
 322         'Yuml'     => 376,
 323         'yuml'     => 255,
 324         'Zeta'     => 918,
 325         'zeta'     => 950,
 326         'zwj'      => 8205,
 327         'zwnj'     => 8204 );
 328
 329 /**
 330  * Character entity aliases accepted by MediaWiki
 331  */
 332 global $wgHtmlEntityAliases;
 333 $wgHtmlEntityAliases = array(
 334         'רלמ' => 'rlm',
 335         'رلم' => 'rlm',
 336 );
 337
 338
 339 /**
 340  * XHTML sanitizer for MediaWiki
 341  * @ingroup Parser
 342  */
 343 class Sanitizer {
 344         /**
 345          * Cleans up HTML, removes dangerous tags and attributes, and
 346          * removes HTML comments
 347          * @private
 348          * @param $text String
 349          * @param $processCallback Callback to do any variable or parameter replacements in HTML attribute values
 350          * @param $args Array for the processing callback
 351          * @param $extratags Array for any extra tags to include
 352          * @param $removetags Array for any tags (default or extra) to exclude
 353          * @return string
 354          */
 355         static function removeHTMLtags( $text, $processCallback = null, $args = array(), $extratags = array(), $removetags = array() ) {
 356                 global $wgUseTidy;
 357
 358                 static $htmlpairsStatic, $htmlsingle, $htmlsingleonly, $htmlnest, $tabletags,
 359                         $htmllist, $listtags, $htmlsingleallowed, $htmlelementsStatic, $staticInitialised;
 360
 361                 wfProfileIn( __METHOD__ );
 362
 363                 if ( !$staticInitialised ) {
 364
 365                         $htmlpairsStatic = array( # Tags that must be closed
 366                                 'b', 'del', 'i', 'ins', 'u', 'font', 'big', 'small', 'sub', 'sup', 'h1',
 367                                 'h2', 'h3', 'h4', 'h5', 'h6', 'cite', 'code', 'em', 's',
 368                                 'strike', 'strong', 'tt', 'var', 'div', 'center',
 369                                 'blockquote', 'ol', 'ul', 'dl', 'table', 'caption', 'pre',
 370                                 'ruby', 'rt' , 'rb' , 'rp', 'p', 'span', 'u', 'abbr'
 371                         );
 372                         $htmlsingle = array(
 373                                 'br', 'hr', 'li', 'dt', 'dd'
 374                         );
 375                         $htmlsingleonly = array( # Elements that cannot have close tags
 376                                 'br', 'hr'
 377                         );
 378                         $htmlnest = array( # Tags that can be nested--??
 379                                 'table', 'tr', 'td', 'th', 'div', 'blockquote', 'ol', 'ul',
 380                                 'dl', 'font', 'big', 'small', 'sub', 'sup', 'span'
 381                         );
 382                         $tabletags = array( # Can only appear inside table, we will close them
 383                                 'td', 'th', 'tr',
 384                         );
 385                         $htmllist = array( # Tags used by list
 386                                 'ul','ol',
 387                         );
 388                         $listtags = array( # Tags that can appear in a list
 389                                 'li',
 390                         );
 391
 392                         $htmlsingleallowed = array_unique( array_merge( $htmlsingle, $tabletags ) );
 393                         $htmlelementsStatic = array_unique( array_merge( $htmlsingle, $htmlpairsStatic, $htmlnest ) );
 394
 395                         # Convert them all to hashtables for faster lookup
 396                         $vars = array( 'htmlpairsStatic', 'htmlsingle', 'htmlsingleonly', 'htmlnest', 'tabletags',
 397                                 'htmllist', 'listtags', 'htmlsingleallowed', 'htmlelementsStatic' );
 398                         foreach ( $vars as $var ) {
 399                                 $$var = array_flip( $$var );
 400                         }
 401                         $staticInitialised = true;
 402                 }
 403                 # Populate $htmlpairs and $htmlelements with the $extratags and $removetags arrays
 404                 $extratags = array_flip( $extratags );
 405                 $removetags = array_flip( $removetags );
 406                 $htmlpairs = array_merge( $extratags, $htmlpairsStatic );
 407                 $htmlelements = array_diff_key( array_merge( $extratags, $htmlelementsStatic ) , $removetags );
 408
 409                 # Remove HTML comments
 410                 $text = Sanitizer::removeHTMLcomments( $text );
 411                 $bits = explode( '<', $text );
 412                 $text = str_replace( '>', '&gt;', array_shift( $bits ) );
 413                 if ( !$wgUseTidy ) {
 414                         $tagstack = $tablestack = array();
 415                         foreach ( $bits as $x ) {
 416                                 $regs = array();
 417                                 # $slash: Does the current element start with a '/'?
 418                                 # $t: Current element name
 419                                 # $params: String between element name and >
 420                                 # $brace: Ending '>' or '/>'
 421                                 # $rest: Everything until the next element of $bits
 422                                 if( preg_match( '!^(/?)(\\w+)([^>]*?)(/{0,1}>)([^<]*)$!', $x, $regs ) ) {
 423                                         list( /* $qbar */, $slash, $t, $params, $brace, $rest ) = $regs;
 424                                 } else {
 425                                         $slash = $t = $params = $brace = $rest = null;
 426                                 }
 427
 428                                 $badtag = false;
 429                                 if ( isset( $htmlelements[$t = strtolower( $t )] ) ) {
 430                                         # Check our stack
 431                                         if ( $slash && isset( $htmlsingleonly[$t] ) ) {
 432                                                 $badtag = true;
 433                                         } elseif ( $slash ) {
 434                                                 # Closing a tag... is it the one we just opened?
 435                                                 $ot = @array_pop( $tagstack );
 436                                                 if ( $ot != $t ) {
 437                                                         if ( isset( $htmlsingleallowed[$ot] ) ) {
 438                                                                 # Pop all elements with an optional close tag
 439                                                                 # and see if we find a match below them
 440                                                                 $optstack = array();
 441                                                                 array_push( $optstack, $ot );
 442                                                                 $ot = @array_pop( $tagstack );
 443                                                                 while ( $ot != $t && isset( $htmlsingleallowed[$ot] ) ) {
 444                                                                         array_push( $optstack, $ot );
 445                                                                         $ot = @array_pop( $tagstack );
 446                                                                 }
 447                                                                 if ( $t != $ot ) {
 448                                                                         # No match. Push the optional elements back again
 449                                                                         $badtag = true;
 450                                                                         while ( $ot = @array_pop( $optstack ) ) {
 451                                                                                 array_push( $tagstack, $ot );
 452                                                                         }
 453                                                                 }
 454                                                         } else {
 455                                                                 @array_push( $tagstack, $ot );
 456                                                                 # <li> can be nested in <ul> or <ol>, skip those cases:
 457                                                                 if ( !isset( $htmllist[$ot] ) || !isset( $listtags[$t] ) ) {
 458                                                                         $badtag = true;
 459                                                                 }
 460                                                         }
 461                                                 } else {
 462                                                         if ( $t == 'table' ) {
 463                                                                 $tagstack = array_pop( $tablestack );
 464                                                         }
 465                                                 }
 466                                                 $newparams = '';
 467                                         } else {
 468                                                 # Keep track for later
 469                                                 if ( isset( $tabletags[$t] ) &&
 470                                                 !in_array( 'table', $tagstack ) ) {
 471                                                         $badtag = true;
 472                                                 } elseif ( in_array( $t, $tagstack ) &&
 473                                                 !isset( $htmlnest [$t ] ) ) {
 474                                                         $badtag = true;
 475                                                 # Is it a self closed htmlpair ? (bug 5487)
 476                                                 } elseif ( $brace == '/>' &&
 477                                                 isset( $htmlpairs[$t] ) ) {
 478                                                         $badtag = true;
 479                                                 } elseif ( isset( $htmlsingleonly[$t] ) ) {
 480                                                         # Hack to force empty tag for uncloseable elements
 481                                                         $brace = '/>';
 482                                                 } elseif ( isset( $htmlsingle[$t] ) ) {
 483                                                         # Hack to not close $htmlsingle tags
 484                                                         $brace = null;
 485                                                 } elseif ( isset( $tabletags[$t] )
 486                                                 && in_array( $t, $tagstack ) ) {
 487                                                         // New table tag but forgot to close the previous one
 488                                                         $text .= "</$t>";
 489                                                 } else {
 490                                                         if ( $t == 'table' ) {
 491                                                                 array_push( $tablestack, $tagstack );
 492                                                                 $tagstack = array();
 493                                                         }
 494                                                         array_push( $tagstack, $t );
 495                                                 }
 496
 497                                                 # Replace any variables or template parameters with
 498                                                 # plaintext results.
 499                                                 if( is_callable( $processCallback ) ) {
 500                                                         call_user_func_array( $processCallback, array( &$params, $args ) );
 501                                                 }
 502
 503                                                 # Strip non-approved attributes from the tag
 504                                                 $newparams = Sanitizer::fixTagAttributes( $params, $t );
 505                                         }
 506                                         if ( !$badtag ) {
 507                                                 $rest = str_replace( '>', '&gt;', $rest );
 508                                                 $close = ( $brace == '/>' && !$slash ) ? ' /' : '';
 509                                                 $text .= "<$slash$t$newparams$close>$rest";
 510                                                 continue;
 511                                         }
 512                                 }
 513                                 $text .= '&lt;' . str_replace( '>', '&gt;', $x);
 514                         }
 515                         # Close off any remaining tags
 516                         while ( is_array( $tagstack ) && ($t = array_pop( $tagstack )) ) {
 517                                 $text .= "</$t>\n";
 518                                 if ( $t == 'table' ) { $tagstack = array_pop( $tablestack ); }
 519                         }
 520                 } else {
 521                         # this might be possible using tidy itself
 522                         foreach ( $bits as $x ) {
 523                                 preg_match( '/^(\\/?)(\\w+)([^>]*?)(\\/{0,1}>)([^<]*)$/',
 524                                 $x, $regs );
 525                                 @list( /* $qbar */, $slash, $t, $params, $brace, $rest ) = $regs;
 526                                 if ( isset( $htmlelements[$t = strtolower( $t )] ) ) {
 527                                         if( is_callable( $processCallback ) ) {
 528                                                 call_user_func_array( $processCallback, array( &$params, $args ) );
 529                                         }
 530                                         $newparams = Sanitizer::fixTagAttributes( $params, $t );
 531                                         $rest = str_replace( '>', '&gt;', $rest );
 532                                         $text .= "<$slash$t$newparams$brace$rest";
 533                                 } else {
 534                                         $text .= '&lt;' . str_replace( '>', '&gt;', $x);
 535                                 }
 536                         }
 537                 }
 538                 wfProfileOut( __METHOD__ );
 539                 return $text;
 540         }
 541
 542         /**
 543          * Remove '<!--', '-->', and everything between.
 544          * To avoid leaving blank lines, when a comment is both preceded
 545          * and followed by a newline (ignoring spaces), trim leading and
 546          * trailing spaces and one of the newlines.
 547          *
 548          * @private
 549          * @param $text String
 550          * @return string
 551          */
 552         static function removeHTMLcomments( $text ) {
 553                 wfProfileIn( __METHOD__ );
 554                 while (($start = strpos($text, '<!--')) !== false) {
 555                         $end = strpos($text, '-->', $start + 4);
 556                         if ($end === false) {
 557                                 # Unterminated comment; bail out
 558                                 break;
 559                         }
 560
 561                         $end += 3;
 562
 563                         # Trim space and newline if the comment is both
 564                         # preceded and followed by a newline
 565                         $spaceStart = max($start - 1, 0);
 566                         $spaceLen = $end - $spaceStart;
 567                         while (substr($text, $spaceStart, 1) === ' ' && $spaceStart > 0) {
 568                                 $spaceStart--;
 569                                 $spaceLen++;
 570                         }
 571                         while (substr($text, $spaceStart + $spaceLen, 1) === ' ')
 572                                 $spaceLen++;
 573                         if (substr($text, $spaceStart, 1) === "\n" and substr($text, $spaceStart + $spaceLen, 1) === "\n") {
 574                                 # Remove the comment, leading and trailing
 575                                 # spaces, and leave only one newline.
 576                                 $text = substr_replace($text, "\n", $spaceStart, $spaceLen + 1);
 577                         }
 578                         else {
 579                                 # Remove just the comment.
 580                                 $text = substr_replace($text, '', $start, $end - $start);
 581                         }
 582                 }
 583                 wfProfileOut( __METHOD__ );
 584                 return $text;
 585         }
 586
 587         /**
 588          * Take an array of attribute names and values and normalize or discard
 589          * illegal values for the given element type.
 590          *
 591          * - Discards attributes not on a whitelist for the given element
 592          * - Unsafe style attributes are discarded
 593          * - Invalid id attributes are reencoded
 594          *
 595          * @param $attribs Array
 596          * @param $element String
 597          * @return Array
 598          *
 599          * @todo Check for legal values where the DTD limits things.
 600          * @todo Check for unique id attribute :P
 601          */
 602         static function validateTagAttributes( $attribs, $element ) {
 603                 return Sanitizer::validateAttributes( $attribs,
 604                         Sanitizer::attributeWhitelist( $element ) );
 605         }
 606
 607         /**
 608          * Take an array of attribute names and values and normalize or discard
 609          * illegal values for the given whitelist.
 610          *
 611          * - Discards attributes not the given whitelist
 612          * - Unsafe style attributes are discarded
 613          * - Invalid id attributes are reencoded
 614          *
 615          * @param $attribs Array
 616          * @param $whitelist Array: list of allowed attribute names
 617          * @return Array
 618          *
 619          * @todo Check for legal values where the DTD limits things.
 620          * @todo Check for unique id attribute :P
 621          */
 622         static function validateAttributes( $attribs, $whitelist ) {
 623                 global $wgAllowRdfaAttributes, $wgAllowMicrodataAttributes;
 624
 625                 $whitelist = array_flip( $whitelist );
 626                 $hrefExp = '/^(' . wfUrlProtocols() . ')[^\s]+$/';
 627
 628                 $out = array();
 629                 foreach( $attribs as $attribute => $value ) {
 630                         #allow XML namespace declaration if RDFa is enabled
 631                         if ( $wgAllowRdfaAttributes && preg_match( MW_XMLNS_ATTRIBUTE_PATTRN, $attribute ) ) {
 632                                 if ( !preg_match( MW_EVIL_URI_PATTERN, $value ) ) {
 633                                         $out[$attribute] = $value;
 634                                 }
 635
 636                                 continue;
 637                         }
 638
 639                         if( !isset( $whitelist[$attribute] ) ) {
 640                                 continue;
 641                         }
 642
 643                         # Strip javascript "expression" from stylesheets.
 644                         # http://msdn.microsoft.com/workshop/author/dhtml/overview/recalc.asp
 645                         if( $attribute == 'style' ) {
 646                                 $value = Sanitizer::checkCss( $value );
 647                         }
 648
 649                         if ( $attribute === 'id' ) {
 650                                 $value = Sanitizer::escapeId( $value, 'noninitial' );
 651                         }
 652
 653                         //RDFa and microdata properties allow URLs, URIs and/or CURIs. check them for sanity
 654                         if ( $attribute === 'rel' || $attribute === 'rev' ||
 655                                 $attribute === 'about' || $attribute === 'property' || $attribute === 'resource' || #RDFa
 656                                 $attribute === 'datatype' || $attribute === 'typeof' ||                             #RDFa
 657                                 $attribute === 'itemid' || $attribute === 'itemprop' || $attribute === 'itemref' || #HTML5 microdata
 658                                 $attribute === 'itemscope' || $attribute === 'itemtype' ) {                         #HTML5 microdata
 659
 660                                 //Paranoia. Allow "simple" values but suppress javascript
 661                                 if ( preg_match( MW_EVIL_URI_PATTERN, $value ) ) {
 662                                         continue;
 663                                 }
 664                         }
 665
 666                         # NOTE: even though elements using href/src are not allowed directly, supply
 667                         #       validation code that can be used by tag hook handlers, etc
 668                         if ( $attribute === 'href' || $attribute === 'src' ) {
 669                                 if ( !preg_match( $hrefExp, $value ) ) {
 670                                         continue; //drop any href or src attributes not using an allowed protocol.
 671                                                   //NOTE: this also drops all relative URLs
 672                                 }
 673                         }
 674
 675                         // If this attribute was previously set, override it.
 676                         // Output should only have one attribute of each name.
 677                         $out[$attribute] = $value;
 678                 }
 679
 680                 if ( $wgAllowMicrodataAttributes ) {
 681                         # There are some complicated validity constraints we need to
 682                         # enforce here.  First of all, we don't want to allow non-standard
 683                         # itemtypes.
 684                         $allowedTypes = array(
 685                                 'http://microformats.org/profile/hcard',
 686                                 'http://microformats.org/profile/hcalendar#vevent',
 687                                 'http://n.whatwg.org/work',
 688                         );
 689                         if ( isset( $out['itemtype'] ) && !in_array( $out['itemtype'],
 690                         $allowedTypes ) ) {
 691                                 # Kill everything
 692                                 unset( $out['itemscope'] );
 693                         }
 694                         # itemtype, itemid, itemref don't make sense without itemscope
 695                         if ( !array_key_exists( 'itemscope', $out ) ) {
 696                                 unset( $out['itemtype'] );
 697                                 unset( $out['itemid'] );
 698                                 unset( $out['itemref'] );
 699                         }
 700                         # TODO: Strip itemprop if we aren't descendants of an itemscope.
 701                 }
 702                 return $out;
 703         }
 704
 705         /**
 706          * Merge two sets of HTML attributes.  Conflicting items in the second set
 707          * will override those in the first, except for 'class' attributes which
 708          * will be combined (if they're both strings).
 709          *
 710          * @todo implement merging for other attributes such as style
 711          * @param $a Array
 712          * @param $b Array
 713          * @return array
 714          */
 715         static function mergeAttributes( $a, $b ) {
 716                 $out = array_merge( $a, $b );
 717                 if( isset( $a['class'] ) && isset( $b['class'] )
 718                 && is_string( $a['class'] ) && is_string( $b['class'] )
 719                 && $a['class'] !== $b['class'] ) {
 720                         $classes = preg_split( '/\s+/', "{$a['class']} {$b['class']}",
 721                                 -1, PREG_SPLIT_NO_EMPTY );
 722                         $out['class'] = implode( ' ', array_unique( $classes ) );
 723                 }
 724                 return $out;
 725         }
 726
 727         /**
 728          * Pick apart some CSS and check it for forbidden or unsafe structures.
 729          * Returns a sanitized string, or false if it was just too evil.
 730          *
 731          * Currently URL references, 'expression', 'tps' are forbidden.
 732          *
 733          * @param $value String
 734          * @return Mixed
 735          */
 736         static function checkCss( $value ) {
 737                 $value = Sanitizer::decodeCharReferences( $value );
 738
 739                 // Remove any comments; IE gets token splitting wrong
 740                 $value = StringUtils::delimiterReplace( '/*', '*/', ' ', $value );
 741
 742                 // Remove anything after a comment-start token, to guard against
 743                 // incorrect client implementations.
 744                 $commentPos = strpos( $value, '/*' );
 745                 if ( $commentPos !== false ) {
 746                         $value = substr( $value, 0, $commentPos );
 747                 }
 748
 749                 // Decode escape sequences and line continuation
 750                 // See the grammar in the CSS 2 spec, appendix D.
 751                 static $decodeRegex, $reencodeTable;
 752                 if ( !$decodeRegex ) {
 753                         $space = '[\\x20\\t\\r\\n\\f]';
 754                         $nl = '(?:\\n|\\r\\n|\\r|\\f)';
 755                         $backslash = '\\\\';
 756                         $decodeRegex = "/ $backslash
 757                                 (?:
 758                                         ($nl) |  # 1. Line continuation
 759                                         ([0-9A-Fa-f]{1,6})$space? |  # 2. character number
 760                                         (.) | # 3. backslash cancelling special meaning
 761                                         () | # 4. backslash at end of string
 762                                 )/xu";
 763                 }
 764                 $value = preg_replace_callback( $decodeRegex,
 765                         array( __CLASS__, 'cssDecodeCallback' ), $value );
 766
 767                 // Reject problematic keywords and control characters
 768                 if ( preg_match( '/[\000-\010\016-\037\177]/', $value ) ) {
 769                         return '/* invalid control char */';
 770                 } elseif ( preg_match( '! expression | filter\s*: | accelerator\s*: | url\s*\( !ix', $value ) ) {
 771                         return '/* insecure input */';
 772                 }
 773                 return $value;
 774         }
 775
 776         static function cssDecodeCallback( $matches ) {
 777                 if ( $matches[1] !== '' ) {
 778                         // Line continuation
 779                         return '';
 780                 } elseif ( $matches[2] !== '' ) {
 781                         $char = codepointToUtf8( hexdec( $matches[2] ) );
 782                 } elseif ( $matches[3] !== '' ) {
 783                         $char = $matches[3];
 784                 } else {
 785                         $char = '\\';
 786                 }
 787                 if ( $char == "\n" || $char == '"' || $char == "'" || $char == '\\' ) {
 788                         // These characters need to be escaped in strings
 789                         // Clean up the escape sequence to avoid parsing errors by clients
 790                         return '\\' . dechex( ord( $char ) ) . ' ';
 791                 } else {
 792                         // Decode unnecessary escape
 793                         return $char;
 794                 }
 795         }
 796
 797         /**
 798          * Take a tag soup fragment listing an HTML element's attributes
 799          * and normalize it to well-formed XML, discarding unwanted attributes.
 800          * Output is safe for further wikitext processing, with escaping of
 801          * values that could trigger problems.
 802          *
 803          * - Normalizes attribute names to lowercase
 804          * - Discards attributes not on a whitelist for the given element
 805          * - Turns broken or invalid entities into plaintext
 806          * - Double-quotes all attribute values
 807          * - Attributes without values are given the name as attribute
 808          * - Double attributes are discarded
 809          * - Unsafe style attributes are discarded
 810          * - Prepends space if there are attributes.
 811          *
 812          * @param $text String
 813          * @param $element String
 814          * @return String
 815          */
 816         static function fixTagAttributes( $text, $element ) {
 817                 if( trim( $text ) == '' ) {
 818                         return '';
 819                 }
 820
 821                 $stripped = Sanitizer::validateTagAttributes(
 822                         Sanitizer::decodeTagAttributes( $text ), $element );
 823
 824                 $attribs = array();
 825                 foreach( $stripped as $attribute => $value ) {
 826                         $encAttribute = htmlspecialchars( $attribute );
 827                         $encValue = Sanitizer::safeEncodeAttribute( $value );
 828
 829                         $attribs[] = "$encAttribute=\"$encValue\"";
 830                 }
 831                 return count( $attribs ) ? ' ' . implode( ' ', $attribs ) : '';
 832         }
 833
 834         /**
 835          * Encode an attribute value for HTML output.
 836          * @param $text String
 837          * @return HTML-encoded text fragment
 838          */
 839         static function encodeAttribute( $text ) {
 840                 $encValue = htmlspecialchars( $text, ENT_QUOTES );
 841
 842                 // Whitespace is normalized during attribute decoding,
 843                 // so if we've been passed non-spaces we must encode them
 844                 // ahead of time or they won't be preserved.
 845                 $encValue = strtr( $encValue, array(
 846                         "\n" => '&#10;',
 847                         "\r" => '&#13;',
 848                         "\t" => '&#9;',
 849                 ) );
 850
 851                 return $encValue;
 852         }
 853
 854         /**
 855          * Encode an attribute value for HTML tags, with extra armoring
 856          * against further wiki processing.
 857          * @param $text String
 858          * @return HTML-encoded text fragment
 859          */
 860         static function safeEncodeAttribute( $text ) {
 861                 $encValue = Sanitizer::encodeAttribute( $text );
 862
 863                 # Templates and links may be expanded in later parsing,
 864                 # creating invalid or dangerous output. Suppress this.
 865                 $encValue = strtr( $encValue, array(
 866                         '<'    => '&lt;',   // This should never happen,
 867                         '>'    => '&gt;',   // we've received invalid input
 868                         '"'    => '&quot;', // which should have been escaped.
 869                         '{'    => '&#123;',
 870                         '['    => '&#91;',
 871                         "''"   => '&#39;&#39;',
 872                         'ISBN' => '&#73;SBN',
 873                         'RFC'  => '&#82;FC',
 874                         'PMID' => '&#80;MID',
 875                         '|'    => '&#124;',
 876                         '__'   => '&#95;_',
 877                 ) );
 878
 879                 # Stupid hack
 880                 $encValue = preg_replace_callback(
 881                         '/(' . wfUrlProtocols() . ')/',
 882                         array( 'Sanitizer', 'armorLinksCallback' ),
 883                         $encValue );
 884                 return $encValue;
 885         }
 886
 887         /**
 888          * Given a value, escape it so that it can be used in an id attribute and
 889          * return it.  This will use HTML5 validation if $wgExperimentalHtmlIds is
 890          * true, allowing anything but ASCII whitespace.  Otherwise it will use
 891          * HTML 4 rules, which means a narrow subset of ASCII, with bad characters
 892          * escaped with lots of dots.
 893          *
 894          * To ensure we don't have to bother escaping anything, we also strip ', ",
 895          * & even if $wgExperimentalIds is true.  TODO: Is this the best tactic?
 896          * We also strip # because it upsets IE6.
 897          *
 898          * @see http://www.w3.org/TR/html401/types.html#type-name Valid characters
 899          *                                                          in the id and
 900          *                                                          name attributes
 901          * @see http://www.w3.org/TR/html401/struct/links.html#h-12.2.3 Anchors with the id attribute
 902          * @see http://www.whatwg.org/specs/web-apps/current-work/multipage/elements.html#the-id-attribute
 903          *   HTML5 definition of id attribute
 904          *
 905          * @param $id String: id to escape
 906          * @param $options Mixed: string or array of strings (default is array()):
 907          *   'noninitial': This is a non-initial fragment of an id, not a full id,
 908          *       so don't pay attention if the first character isn't valid at the
 909          *       beginning of an id.  Only matters if $wgExperimentalHtmlIds is
 910          *       false.
 911          *   'legacy': Behave the way the old HTML 4-based ID escaping worked even
 912          *       if $wgExperimentalHtmlIds is used, so we can generate extra
 913          *       anchors and links won't break.
 914          * @return String
 915          */
 916         static function escapeId( $id, $options = array() ) {
 917                 global $wgHtml5, $wgExperimentalHtmlIds;
 918                 $options = (array)$options;
 919
 920                 if ( $wgHtml5 && $wgExperimentalHtmlIds && !in_array( 'legacy', $options ) ) {
 921                         $id = Sanitizer::decodeCharReferences( $id );
 922                         $id = preg_replace( '/[ \t\n\r\f_\'"&#]+/', '_', $id );
 923                         $id = trim( $id, '_' );
 924                         if ( $id === '' ) {
 925                                 # Must have been all whitespace to start with.
 926                                 return '_';
 927                         } else {
 928                                 return $id;
 929                         }
 930                 }
 931
 932                 # HTML4-style escaping
 933                 static $replace = array(
 934                         '%3A' => ':',
 935                         '%' => '.'
 936                 );
 937
 938                 $id = urlencode( Sanitizer::decodeCharReferences( strtr( $id, ' ', '_' ) ) );
 939                 $id = str_replace( array_keys( $replace ), array_values( $replace ), $id );
 940
 941                 if ( !preg_match( '/^[a-zA-Z]/', $id )
 942                 && !in_array( 'noninitial', $options ) )  {
 943                         // Initial character must be a letter!
 944                         $id = "x$id";
 945                 }
 946                 return $id;
 947         }
 948
 949         /**
 950          * Given a value, escape it so that it can be used as a CSS class and
 951          * return it.
 952          *
 953          * @todo For extra validity, input should be validated UTF-8.
 954          *
 955          * @see http://www.w3.org/TR/CSS21/syndata.html Valid characters/format
 956          *
 957          * @param $class String
 958          * @return String
 959          */
 960         static function escapeClass( $class ) {
 961                 // Convert ugly stuff to underscores and kill underscores in ugly places
 962                 return rtrim(preg_replace(
 963                         array('/(^[0-9\\-])|[\\x00-\\x20!"#$%&\'()*+,.\\/:;<=>?@[\\]^`{|}~]|\\xC2\\xA0/','/_+/'),
 964                         '_',
 965                         $class ), '_');
 966         }
 967
 968         /**
 969          * Given HTML input, escape with htmlspecialchars but un-escape entites.
 970          * This allows (generally harmless) entities like &nbsp; to survive.
 971          *
 972          * @param $html String to escape
 973          * @return String: escaped input
 974          */
 975         static function escapeHtmlAllowEntities( $html ) {
 976                 # It seems wise to escape ' as well as ", as a matter of course.  Can't
 977                 # hurt.
 978                 $html = htmlspecialchars( $html, ENT_QUOTES );
 979                 $html = str_replace( '&amp;', '&', $html );
 980                 $html = Sanitizer::normalizeCharReferences( $html );
 981                 return $html;
 982         }
 983
 984         /**
 985          * Regex replace callback for armoring links against further processing.
 986          * @param $matches Array
 987          * @return string
 988          */
 989         private static function armorLinksCallback( $matches ) {
 990                 return str_replace( ':', '&#58;', $matches[1] );
 991         }
 992
 993         /**
 994          * Return an associative array of attribute names and values from
 995          * a partial tag string. Attribute names are forces to lowercase,
 996          * character references are decoded to UTF-8 text.
 997          *
 998          * @param $text String
 999          * @return Array
1000          */
1001         public static function decodeTagAttributes( $text ) {
1002                 if( trim( $text ) == '' ) {
1003                         return array();
1004                 }
1005
1006                 $attribs = array();
1007                 $pairs = array();
1008                 if( !preg_match_all(
1009                         MW_ATTRIBS_REGEX,
1010                         $text,
1011                         $pairs,
1012                         PREG_SET_ORDER ) ) {
1013                         return $attribs;
1014                 }
1015
1016                 foreach( $pairs as $set ) {
1017                         $attribute = strtolower( $set[1] );
1018                         $value = Sanitizer::getTagAttributeCallback( $set );
1019
1020                         // Normalize whitespace
1021                         $value = preg_replace( '/[\t\r\n ]+/', ' ', $value );
1022                         $value = trim( $value );
1023
1024                         // Decode character references
1025                         $attribs[$attribute] = Sanitizer::decodeCharReferences( $value );
1026                 }
1027                 return $attribs;
1028         }
1029
1030         /**
1031          * Pick the appropriate attribute value from a match set from the
1032          * MW_ATTRIBS_REGEX matches.
1033          *
1034          * @param $set Array
1035          * @return String
1036          */
1037         private static function getTagAttributeCallback( $set ) {
1038                 if( isset( $set[6] ) ) {
1039                         # Illegal #XXXXXX color with no quotes.
1040                         return $set[6];
1041                 } elseif( isset( $set[5] ) ) {
1042                         # No quotes.
1043                         return $set[5];
1044                 } elseif( isset( $set[4] ) ) {
1045                         # Single-quoted
1046                         return $set[4];
1047                 } elseif( isset( $set[3] ) ) {
1048                         # Double-quoted
1049                         return $set[3];
1050                 } elseif( !isset( $set[2] ) ) {
1051                         # In XHTML, attributes must have a value.
1052                         # For 'reduced' form, return explicitly the attribute name here.
1053                         return $set[1];
1054                 } else {
1055                         throw new MWException( "Tag conditions not met. This should never happen and is a bug." );
1056                 }
1057         }
1058
1059         /**
1060          * Normalize whitespace and character references in an XML source-
1061          * encoded text for an attribute value.
1062          *
1063          * See http://www.w3.org/TR/REC-xml/#AVNormalize for background,
1064          * but note that we're not returning the value, but are returning
1065          * XML source fragments that will be slapped into output.
1066          *
1067          * @param $text String
1068          * @return String
1069          */
1070         private static function normalizeAttributeValue( $text ) {
1071                 return str_replace( '"', '&quot;',
1072                         self::normalizeWhitespace(
1073                                 Sanitizer::normalizeCharReferences( $text ) ) );
1074         }
1075
1076         private static function normalizeWhitespace( $text ) {
1077                 return preg_replace(
1078                         '/\r\n|[\x20\x0d\x0a\x09]/',
1079                         ' ',
1080                         $text );
1081         }
1082
1083         /**
1084          * Ensure that any entities and character references are legal
1085          * for XML and XHTML specifically. Any stray bits will be
1086          * &amp;-escaped to result in a valid text fragment.
1087          *
1088          * a. any named char refs must be known in XHTML
1089          * b. any numeric char refs must be legal chars, not invalid or forbidden
1090          * c. use &#x, not &#X
1091          * d. fix or reject non-valid attributes
1092          *
1093          * @param $text String
1094          * @return String
1095          * @private
1096          */
1097         static function normalizeCharReferences( $text ) {
1098                 return preg_replace_callback(
1099                         MW_CHAR_REFS_REGEX,
1100                         array( 'Sanitizer', 'normalizeCharReferencesCallback' ),
1101                         $text );
1102         }
1103         /**
1104          * @param $matches String
1105          * @return String
1106          */
1107         static function normalizeCharReferencesCallback( $matches ) {
1108                 $ret = null;
1109                 if( $matches[1] != '' ) {
1110                         $ret = Sanitizer::normalizeEntity( $matches[1] );
1111                 } elseif( $matches[2] != '' ) {
1112                         $ret = Sanitizer::decCharReference( $matches[2] );
1113                 } elseif( $matches[3] != ''  ) {
1114                         $ret = Sanitizer::hexCharReference( $matches[3] );
1115                 } elseif( $matches[4] != '' ) {
1116                         $ret = Sanitizer::hexCharReference( $matches[4] );
1117                 }
1118                 if( is_null( $ret ) ) {
1119                         return htmlspecialchars( $matches[0] );
1120                 } else {
1121                         return $ret;
1122                 }
1123         }
1124
1125         /**
1126          * If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD,
1127          * return the named entity reference as is. If the entity is a
1128          * MediaWiki-specific alias, returns the HTML equivalent. Otherwise,
1129          * returns HTML-escaped text of pseudo-entity source (eg &amp;foo;)
1130          *
1131          * @param $name String
1132          * @return String
1133          */
1134         static function normalizeEntity( $name ) {
1135                 global $wgHtmlEntities, $wgHtmlEntityAliases;
1136                 if ( isset( $wgHtmlEntityAliases[$name] ) ) {
1137                         return "&{$wgHtmlEntityAliases[$name]};";
1138                 } elseif( isset( $wgHtmlEntities[$name] ) ) {
1139                         return "&$name;";
1140                 } else {
1141                         return "&amp;$name;";
1142                 }
1143         }
1144
1145         static function decCharReference( $codepoint ) {
1146                 $point = intval( $codepoint );
1147                 if( Sanitizer::validateCodepoint( $point ) ) {
1148                         return sprintf( '&#%d;', $point );
1149                 } else {
1150                         return null;
1151                 }
1152         }
1153
1154         static function hexCharReference( $codepoint ) {
1155                 $point = hexdec( $codepoint );
1156                 if( Sanitizer::validateCodepoint( $point ) ) {
1157                         return sprintf( '&#x%x;', $point );
1158                 } else {
1159                         return null;
1160                 }
1161         }
1162
1163         /**
1164          * Returns true if a given Unicode codepoint is a valid character in XML.
1165          * @param $codepoint Integer
1166          * @return Boolean
1167          */
1168         private static function validateCodepoint( $codepoint ) {
1169                 return ($codepoint ==    0x09)
1170                         || ($codepoint ==    0x0a)
1171                         || ($codepoint ==    0x0d)
1172                         || ($codepoint >=    0x20 && $codepoint <=   0xd7ff)
1173                         || ($codepoint >=  0xe000 && $codepoint <=   0xfffd)
1174                         || ($codepoint >= 0x10000 && $codepoint <= 0x10ffff);
1175         }
1176
1177         /**
1178          * Decode any character references, numeric or named entities,
1179          * in the text and return a UTF-8 string.
1180          *
1181          * @param $text String
1182          * @return String
1183          */
1184         public static function decodeCharReferences( $text ) {
1185                 return preg_replace_callback(
1186                         MW_CHAR_REFS_REGEX,
1187                         array( 'Sanitizer', 'decodeCharReferencesCallback' ),
1188                         $text );
1189         }
1190
1191         /**
1192          * @param $matches String
1193          * @return String
1194          */
1195         static function decodeCharReferencesCallback( $matches ) {
1196                 if( $matches[1] != '' ) {
1197                         return Sanitizer::decodeEntity( $matches[1] );
1198                 } elseif( $matches[2] != '' ) {
1199                         return  Sanitizer::decodeChar( intval( $matches[2] ) );
1200                 } elseif( $matches[3] != ''  ) {
1201                         return  Sanitizer::decodeChar( hexdec( $matches[3] ) );
1202                 } elseif( $matches[4] != '' ) {
1203                         return  Sanitizer::decodeChar( hexdec( $matches[4] ) );
1204                 }
1205                 # Last case should be an ampersand by itself
1206                 return $matches[0];
1207         }
1208
1209         /**
1210          * Return UTF-8 string for a codepoint if that is a valid
1211          * character reference, otherwise U+FFFD REPLACEMENT CHARACTER.
1212          * @param $codepoint Integer
1213          * @return String
1214          * @private
1215          */
1216         static function decodeChar( $codepoint ) {
1217                 if( Sanitizer::validateCodepoint( $codepoint ) ) {
1218                         return codepointToUtf8( $codepoint );
1219                 } else {
1220                         return UTF8_REPLACEMENT;
1221                 }
1222         }
1223
1224         /**
1225          * If the named entity is defined in the HTML 4.0/XHTML 1.0 DTD,
1226          * return the UTF-8 encoding of that character. Otherwise, returns
1227          * pseudo-entity source (eg &foo;)
1228          *
1229          * @param $name Strings
1230          * @return String
1231          */
1232         static function decodeEntity( $name ) {
1233                 global $wgHtmlEntities, $wgHtmlEntityAliases;
1234                 if ( isset( $wgHtmlEntityAliases[$name] ) ) {
1235                         $name = $wgHtmlEntityAliases[$name];
1236                 }
1237                 if( isset( $wgHtmlEntities[$name] ) ) {
1238                         return codepointToUtf8( $wgHtmlEntities[$name] );
1239                 } else {
1240                         return "&$name;";
1241                 }
1242         }
1243
1244         /**
1245          * Fetch the whitelist of acceptable attributes for a given element name.
1246          *
1247          * @param $element String
1248          * @return Array
1249          */
1250         static function attributeWhitelist( $element ) {
1251                 static $list;
1252                 if( !isset( $list ) ) {
1253                         $list = Sanitizer::setupAttributeWhitelist();
1254                 }
1255                 return isset( $list[$element] )
1256                         ? $list[$element]
1257                         : array();
1258         }
1259
1260         /**
1261          * Foreach array key (an allowed HTML element), return an array
1262          * of allowed attributes
1263          * @return Array
1264          */
1265         static function setupAttributeWhitelist() {
1266                 global $wgAllowRdfaAttributes, $wgHtml5, $wgAllowMicrodataAttributes;
1267
1268                 $common = array( 'id', 'class', 'lang', 'dir', 'title', 'style' );
1269
1270                 if ( $wgAllowRdfaAttributes ) {
1271                         #RDFa attributes as specified in section 9 of http://www.w3.org/TR/2008/REC-rdfa-syntax-20081014
1272                         $common = array_merge( $common, array(
1273                             'about', 'property', 'resource', 'datatype', 'typeof',
1274                         ) );
1275                 }
1276
1277                 if ( $wgHtml5 && $wgAllowMicrodataAttributes ) {
1278                         # add HTML5 microdata tages as pecified by http://www.whatwg.org/specs/web-apps/current-work/multipage/microdata.html#the-microdata-model
1279                         $common = array_merge( $common, array(
1280                             'itemid', 'itemprop', 'itemref', 'itemscope', 'itemtype'
1281                         ) );
1282                 }
1283
1284                 $block = array_merge( $common, array( 'align' ) );
1285                 $tablealign = array( 'align', 'char', 'charoff', 'valign' );
1286                 $tablecell = array( 'abbr',
1287                                     'axis',
1288                                     'headers',
1289                                     'scope',
1290                                     'rowspan',
1291                                     'colspan',
1292                                     'nowrap', # deprecated
1293                                     'width',  # deprecated
1294                                     'height', # deprecated
1295                                     'bgcolor' # deprecated
1296                                     );
1297
1298                 # Numbers refer to sections in HTML 4.01 standard describing the element.
1299                 # See: http://www.w3.org/TR/html4/
1300                 $whitelist = array (
1301                         # 7.5.4
1302                         'div'        => $block,
1303                         'center'     => $common, # deprecated
1304                         'span'       => $block, # ??
1305
1306                         # 7.5.5
1307                         'h1'         => $block,
1308                         'h2'         => $block,
1309                         'h3'         => $block,
1310                         'h4'         => $block,
1311                         'h5'         => $block,
1312                         'h6'         => $block,
1313
1314                         # 7.5.6
1315                         # address
1316
1317                         # 8.2.4
1318                         # bdo
1319
1320                         # 9.2.1
1321                         'em'         => $common,
1322                         'strong'     => $common,
1323                         'cite'       => $common,
1324                         # dfn
1325                         'code'       => $common,
1326                         # samp
1327                         # kbd
1328                         'var'        => $common,
1329                         'abbr'       => $common,
1330                         # acronym
1331
1332                         # 9.2.2
1333                         'blockquote' => array_merge( $common, array( 'cite' ) ),
1334                         # q
1335
1336                         # 9.2.3
1337                         'sub'        => $common,
1338                         'sup'        => $common,
1339
1340                         # 9.3.1
1341                         'p'          => $block,
1342
1343                         # 9.3.2
1344                         'br'         => array( 'id', 'class', 'title', 'style', 'clear' ),
1345
1346                         # 9.3.4
1347                         'pre'        => array_merge( $common, array( 'width' ) ),
1348
1349                         # 9.4
1350                         'ins'        => array_merge( $common, array( 'cite', 'datetime' ) ),
1351                         'del'        => array_merge( $common, array( 'cite', 'datetime' ) ),
1352
1353                         # 10.2
1354                         'ul'         => array_merge( $common, array( 'type' ) ),
1355                         'ol'         => array_merge( $common, array( 'type', 'start' ) ),
1356                         'li'         => array_merge( $common, array( 'type', 'value' ) ),
1357
1358                         # 10.3
1359                         'dl'         => $common,
1360                         'dd'         => $common,
1361                         'dt'         => $common,
1362
1363                         # 11.2.1
1364                         'table'      => array_merge( $common,
1365                                                                 array( 'summary', 'width', 'border', 'frame',
1366                                                                                 'rules', 'cellspacing', 'cellpadding',
1367                                                                                 'align', 'bgcolor',
1368                                                                 ) ),
1369
1370                         # 11.2.2
1371                         'caption'    => array_merge( $common, array( 'align' ) ),
1372
1373                         # 11.2.3
1374                         'thead'      => array_merge( $common, $tablealign ),
1375                         'tfoot'      => array_merge( $common, $tablealign ),
1376                         'tbody'      => array_merge( $common, $tablealign ),
1377
1378                         # 11.2.4
1379                         'colgroup'   => array_merge( $common, array( 'span', 'width' ), $tablealign ),
1380                         'col'        => array_merge( $common, array( 'span', 'width' ), $tablealign ),
1381
1382                         # 11.2.5
1383                         'tr'         => array_merge( $common, array( 'bgcolor' ), $tablealign ),
1384
1385                         # 11.2.6
1386                         'td'         => array_merge( $common, $tablecell, $tablealign ),
1387                         'th'         => array_merge( $common, $tablecell, $tablealign ),
1388
1389                         # 12.2 # NOTE: <a> is not allowed directly, but the attrib whitelist is used from the Parser object
1390                         'a'          => array_merge( $common, array( 'href', 'rel', 'rev' ) ), # rel/rev esp. for RDFa
1391
1392                         # 13.2
1393                         # Not usually allowed, but may be used for extension-style hooks
1394                         # such as <math> when it is rasterized
1395                         'img'        => array_merge( $common, array( 'alt' ) ),
1396
1397                         # 15.2.1
1398                         'tt'         => $common,
1399                         'b'          => $common,
1400                         'i'          => $common,
1401                         'big'        => $common,
1402                         'small'      => $common,
1403                         'strike'     => $common,
1404                         's'          => $common,
1405                         'u'          => $common,
1406
1407                         # 15.2.2
1408                         'font'       => array_merge( $common, array( 'size', 'color', 'face' ) ),
1409                         # basefont
1410
1411                         # 15.3
1412                         'hr'         => array_merge( $common, array( 'noshade', 'size', 'width' ) ),
1413
1414                         # XHTML Ruby annotation text module, simple ruby only.
1415                         # http://www.w3c.org/TR/ruby/
1416                         'ruby'       => $common,
1417                         # rbc
1418                         # rtc
1419                         'rb'         => $common,
1420                         'rt'         => $common, #array_merge( $common, array( 'rbspan' ) ),
1421                         'rp'         => $common,
1422
1423                         # MathML root element, where used for extensions
1424                         # 'title' may not be 100% valid here; it's XHTML
1425                         # http://www.w3.org/TR/REC-MathML/
1426                         'math'       => array( 'class', 'style', 'id', 'title' ),
1427                         );
1428                 return $whitelist;
1429         }
1430
1431         /**
1432          * Take a fragment of (potentially invalid) HTML and return
1433          * a version with any tags removed, encoded as plain text.
1434          *
1435          * Warning: this return value must be further escaped for literal
1436          * inclusion in HTML output as of 1.10!
1437          *
1438          * @param $text String: HTML fragment
1439          * @return String
1440          */
1441         static function stripAllTags( $text ) {
1442                 # Actual <tags>
1443                 $text = StringUtils::delimiterReplace( '<', '>', '', $text );
1444
1445                 # Normalize &entities and whitespace
1446                 $text = self::decodeCharReferences( $text );
1447                 $text = self::normalizeWhitespace( $text );
1448
1449                 return $text;
1450         }
1451
1452         /**
1453          * Hack up a private DOCTYPE with HTML's standard entity declarations.
1454          * PHP 4 seemed to know these if you gave it an HTML doctype, but
1455          * PHP 5.1 doesn't.
1456          *
1457          * Use for passing XHTML fragments to PHP's XML parsing functions
1458          *
1459          * @return String
1460          */
1461         static function hackDocType() {
1462                 global $wgHtmlEntities;
1463                 $out = "<!DOCTYPE html [\n";
1464                 foreach( $wgHtmlEntities as $entity => $codepoint ) {
1465                         $out .= "<!ENTITY $entity \"&#$codepoint;\">";
1466                 }
1467                 $out .= "]>\n";
1468                 return $out;
1469         }
1470
1471         static function cleanUrl( $url ) {
1472                 # Normalize any HTML entities in input. They will be
1473                 # re-escaped by makeExternalLink().
1474                 $url = Sanitizer::decodeCharReferences( $url );
1475
1476                 # Escape any control characters introduced by the above step
1477                 $url = preg_replace( '/[\][<>"\\x00-\\x20\\x7F]/e', "urlencode('\\0')", $url );
1478
1479                 # Validate hostname portion
1480                 $matches = array();
1481                 if( preg_match( '!^([^:]+:)(//[^/]+)?(.*)$!iD', $url, $matches ) ) {
1482                         list( /* $whole */, $protocol, $host, $rest ) = $matches;
1483
1484                         // Characters that will be ignored in IDNs.
1485                         // http://tools.ietf.org/html/3454#section-3.1
1486                         // Strip them before further processing so blacklists and such work.
1487                         $strip = "/
1488                                 \\s|          # general whitespace
1489                                 \xc2\xad|     # 00ad SOFT HYPHEN
1490                                 \xe1\xa0\x86| # 1806 MONGOLIAN TODO SOFT HYPHEN
1491                                 \xe2\x80\x8b| # 200b ZERO WIDTH SPACE
1492                                 \xe2\x81\xa0| # 2060 WORD JOINER
1493                                 \xef\xbb\xbf| # feff ZERO WIDTH NO-BREAK SPACE
1494                                 \xcd\x8f|     # 034f COMBINING GRAPHEME JOINER
1495                                 \xe1\xa0\x8b| # 180b MONGOLIAN FREE VARIATION SELECTOR ONE
1496                                 \xe1\xa0\x8c| # 180c MONGOLIAN FREE VARIATION SELECTOR TWO
1497                                 \xe1\xa0\x8d| # 180d MONGOLIAN FREE VARIATION SELECTOR THREE
1498                                 \xe2\x80\x8c| # 200c ZERO WIDTH NON-JOINER
1499                                 \xe2\x80\x8d| # 200d ZERO WIDTH JOINER
1500                                 [\xef\xb8\x80-\xef\xb8\x8f] # fe00-fe00f VARIATION SELECTOR-1-16
1501                                 /xuD";
1502
1503                         $host = preg_replace( $strip, '', $host );
1504
1505                         // @todo Fixme: validate hostnames here
1506
1507                         return $protocol . $host . $rest;
1508                 } else {
1509                         return $url;
1510                 }
1511         }
1512
1513 }