includes/Html.php

   1 <?php
   2 /**
   3  * Collection of methods to generate HTML content
   4  *
   5  * Copyright © 2009 Aryeh Gregor
   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  */
  25
  26 /**
  27  * This class is a collection of static functions that serve two purposes:
  28  *
  29  * 1) Implement any algorithms specified by HTML5, or other HTML
  30  * specifications, in a convenient and self-contained way.
  31  *
  32  * 2) Allow HTML elements to be conveniently and safely generated, like the
  33  * current Xml class but a) less confused (Xml supports HTML-specific things,
  34  * but only sometimes!) and b) not necessarily confined to XML-compatible
  35  * output.
  36  *
  37  * There are two important configuration options this class uses:
  38  *
  39  * $wgHtml5: If this is set to false, then all output should be valid XHTML 1.0
  40  *     Transitional.
  41  * $wgWellFormedXml: If this is set to true, then all output should be
  42  *     well-formed XML (quotes on attributes, self-closing tags, etc.).
  43  *
  44  * This class is meant to be confined to utility functions that are called from
  45  * trusted code paths.  It does not do enforcement of policy like not allowing
  46  * <a> elements.
  47  *
  48  * @since 1.16
  49  */
  50 class Html {
  51         # List of void elements from HTML5, section 8.1.2 as of 2011-08-12
  52         private static $voidElements = array(
  53                 'area',
  54                 'base',
  55                 'br',
  56                 'col',
  57                 'command',
  58                 'embed',
  59                 'hr',
  60                 'img',
  61                 'input',
  62                 'keygen',
  63                 'link',
  64                 'meta',
  65                 'param',
  66                 'source',
  67                 'track',
  68                 'wbr',
  69         );
  70
  71         # Boolean attributes, which may have the value omitted entirely.  Manually
  72         # collected from the HTML5 spec as of 2011-08-12.
  73         private static $boolAttribs = array(
  74                 'async',
  75                 'autofocus',
  76                 'autoplay',
  77                 'checked',
  78                 'controls',
  79                 'default',
  80                 'defer',
  81                 'disabled',
  82                 'formnovalidate',
  83                 'hidden',
  84                 'ismap',
  85                 'itemscope',
  86                 'loop',
  87                 'multiple',
  88                 'muted',
  89                 'novalidate',
  90                 'open',
  91                 'pubdate',
  92                 'readonly',
  93                 'required',
  94                 'reversed',
  95                 'scoped',
  96                 'seamless',
  97                 'selected',
  98                 'truespeed',
  99                 'typemustmatch',
 100                 # HTML5 Microdata
 101                 'itemscope',
 102         );
 103
 104         private static $HTMLFiveOnlyAttribs = array(
 105                 'autocomplete',
 106                 'autofocus',
 107                 'max',
 108                 'min',
 109                 'multiple',
 110                 'pattern',
 111                 'placeholder',
 112                 'required',
 113                 'step',
 114                 'spellcheck',
 115         );
 116
 117         /**
 118          * Returns an HTML element in a string.  The major advantage here over
 119          * manually typing out the HTML is that it will escape all attribute
 120          * values.  If you're hardcoding all the attributes, or there are none, you
 121          * should probably just type out the html element yourself.
 122          *
 123          * This is quite similar to Xml::tags(), but it implements some useful
 124          * HTML-specific logic.  For instance, there is no $allowShortTag
 125          * parameter: the closing tag is magically omitted if $element has an empty
 126          * content model.  If $wgWellFormedXml is false, then a few bytes will be
 127          * shaved off the HTML output as well.
 128          *
 129          * @param $element string The element's name, e.g., 'a'
 130          * @param $attribs array  Associative array of attributes, e.g., array(
 131          *   'href' => 'http://www.mediawiki.org/' ). See expandAttributes() for
 132          *   further documentation.
 133          * @param $contents string The raw HTML contents of the element: *not*
 134          *   escaped!
 135          * @return string Raw HTML
 136          */
 137         public static function rawElement( $element, $attribs = array(), $contents = '' ) {
 138                 global $wgWellFormedXml;
 139                 $start = self::openElement( $element, $attribs );
 140                 if ( in_array( $element, self::$voidElements ) ) {
 141                         if ( $wgWellFormedXml ) {
 142                                 # Silly XML.
 143                                 return substr( $start, 0, -1 ) . ' />';
 144                         }
 145                         return $start;
 146                 } else {
 147                         return "$start$contents" . self::closeElement( $element );
 148                 }
 149         }
 150
 151         /**
 152          * Identical to rawElement(), but HTML-escapes $contents (like
 153          * Xml::element()).
 154          *
 155          * @param $element string
 156          * @param $attribs array
 157          * @param $contents string
 158          *
 159          * @return string
 160          */
 161         public static function element( $element, $attribs = array(), $contents = '' ) {
 162                 return self::rawElement( $element, $attribs, strtr( $contents, array(
 163                         # There's no point in escaping quotes, >, etc. in the contents of
 164                         # elements.
 165                         '&' => '&amp;',
 166                         '<' => '&lt;'
 167                 ) ) );
 168         }
 169
 170         /**
 171          * Identical to rawElement(), but has no third parameter and omits the end
 172          * tag (and the self-closing '/' in XML mode for empty elements).
 173          *
 174          * @param $element string
 175          * @param $attribs array
 176          *
 177          * @return string
 178          */
 179         public static function openElement( $element, $attribs = array() ) {
 180                 global $wgHtml5, $wgWellFormedXml;
 181                 $attribs = (array)$attribs;
 182                 # This is not required in HTML5, but let's do it anyway, for
 183                 # consistency and better compression.
 184                 $element = strtolower( $element );
 185
 186                 # In text/html, initial <html> and <head> tags can be omitted under
 187                 # pretty much any sane circumstances, if they have no attributes.  See:
 188                 # <http://www.whatwg.org/specs/web-apps/current-work/multipage/syntax.html#optional-tags>
 189                 if ( !$wgWellFormedXml && !$attribs
 190                 && in_array( $element, array( 'html', 'head' ) ) ) {
 191                         return '';
 192                 }
 193
 194                 # Remove HTML5-only attributes if we aren't doing HTML5, and disable
 195                 # form validation regardless (see bug 23769 and the more detailed
 196                 # comment in expandAttributes())
 197                 if ( $element == 'input' ) {
 198                         # Whitelist of types that don't cause validation.  All except
 199                         # 'search' are valid in XHTML1.
 200                         $validTypes = array(
 201                                 'hidden',
 202                                 'text',
 203                                 'password',
 204                                 'checkbox',
 205                                 'radio',
 206                                 'file',
 207                                 'submit',
 208                                 'image',
 209                                 'reset',
 210                                 'button',
 211                                 'search',
 212                         );
 213
 214                         if( $wgHtml5 ) {
 215                                 $validTypes = array_merge( $validTypes, array(
 216                                         'datetime',
 217                                         'datetime-local',
 218                                         'date',
 219                                         'month',
 220                                         'time',
 221                                         'week',
 222                                         'number',
 223                                         'range',
 224                                         'email',
 225                                         'url',
 226                                         'search',
 227                                         'tel',
 228                                         'color',
 229                                 ) );
 230                         }
 231                         if ( isset( $attribs['type'] )
 232                         && !in_array( $attribs['type'], $validTypes ) ) {
 233                                 unset( $attribs['type'] );
 234                         }
 235
 236                         if ( isset( $attribs['type'] ) && $attribs['type'] == 'search'
 237                         && !$wgHtml5 ) {
 238                                 unset( $attribs['type'] );
 239                         }
 240                 }
 241
 242                 if ( !$wgHtml5 && $element == 'textarea' && isset( $attribs['maxlength'] ) ) {
 243                         unset( $attribs['maxlength'] );
 244                 }
 245
 246                 return "<$element" . self::expandAttributes(
 247                         self::dropDefaults( $element, $attribs ) ) . '>';
 248         }
 249
 250         /**
 251          * Returns "</$element>", except if $wgWellFormedXml is off, in which case
 252          * it returns the empty string when that's guaranteed to be safe.
 253          *
 254          * @since 1.17
 255          * @param $element string Name of the element, e.g., 'a'
 256          * @return string A closing tag, if required
 257          */
 258         public static function closeElement( $element ) {
 259                 global $wgWellFormedXml;
 260
 261                 $element = strtolower( $element );
 262
 263                 # Reference:
 264                 # http://www.whatwg.org/specs/web-apps/current-work/multipage/syntax.html#optional-tags
 265                 if ( !$wgWellFormedXml && in_array( $element, array(
 266                         'html',
 267                         'head',
 268                         'body',
 269                         'li',
 270                         'dt',
 271                         'dd',
 272                         'tr',
 273                         'td',
 274                         'th',
 275                 ) ) ) {
 276                         return '';
 277                 }
 278                 return "</$element>";
 279         }
 280
 281         /**
 282          * Given an element name and an associative array of element attributes,
 283          * return an array that is functionally identical to the input array, but
 284          * possibly smaller.  In particular, attributes might be stripped if they
 285          * are given their default values.
 286          *
 287          * This method is not guaranteed to remove all redundant attributes, only
 288          * some common ones and some others selected arbitrarily at random.  It
 289          * only guarantees that the output array should be functionally identical
 290          * to the input array (currently per the HTML 5 draft as of 2009-09-06).
 291          *
 292          * @param $element string Name of the element, e.g., 'a'
 293          * @param $attribs array  Associative array of attributes, e.g., array(
 294          *   'href' => 'http://www.mediawiki.org/' ).  See expandAttributes() for
 295          *   further documentation.
 296          * @return array An array of attributes functionally identical to $attribs
 297          */
 298         private static function dropDefaults( $element, $attribs ) {
 299                 # Don't bother doing anything if we aren't outputting HTML5; it's too
 300                 # much of a pain to maintain two sets of defaults.
 301                 global $wgHtml5;
 302                 if ( !$wgHtml5 ) {
 303                         return $attribs;
 304                 }
 305
 306                 static $attribDefaults = array(
 307                         'area' => array( 'shape' => 'rect' ),
 308                         'button' => array(
 309                                 'formaction' => 'GET',
 310                                 'formenctype' => 'application/x-www-form-urlencoded',
 311                                 'type' => 'submit',
 312                         ),
 313                         'canvas' => array(
 314                                 'height' => '150',
 315                                 'width' => '300',
 316                         ),
 317                         'command' => array( 'type' => 'command' ),
 318                         'form' => array(
 319                                 'action' => 'GET',
 320                                 'autocomplete' => 'on',
 321                                 'enctype' => 'application/x-www-form-urlencoded',
 322                         ),
 323                         'input' => array(
 324                                 'formaction' => 'GET',
 325                                 'type' => 'text',
 326                                 'value' => '',
 327                         ),
 328                         'keygen' => array( 'keytype' => 'rsa' ),
 329                         'link' => array( 'media' => 'all' ),
 330                         'menu' => array( 'type' => 'list' ),
 331                         # Note: the use of text/javascript here instead of other JavaScript
 332                         # MIME types follows the HTML5 spec.
 333                         'script' => array( 'type' => 'text/javascript' ),
 334                         'style' => array(
 335                                 'media' => 'all',
 336                                 'type' => 'text/css',
 337                         ),
 338                         'textarea' => array( 'wrap' => 'soft' ),
 339                 );
 340
 341                 $element = strtolower( $element );
 342
 343                 foreach ( $attribs as $attrib => $value ) {
 344                         $lcattrib = strtolower( $attrib );
 345                         if( is_array( $value ) ) {
 346                                 $value = implode( ' ', $value );
 347                         } else {
 348                                 $value = strval( $value );
 349                         }
 350
 351                         # Simple checks using $attribDefaults
 352                         if ( isset( $attribDefaults[$element][$lcattrib] ) &&
 353                         $attribDefaults[$element][$lcattrib] == $value ) {
 354                                 unset( $attribs[$attrib] );
 355                         }
 356
 357                         if ( $lcattrib == 'class' && $value == '' ) {
 358                                 unset( $attribs[$attrib] );
 359                         }
 360                 }
 361
 362                 # More subtle checks
 363                 if ( $element === 'link' && isset( $attribs['type'] )
 364                 && strval( $attribs['type'] ) == 'text/css' ) {
 365                         unset( $attribs['type'] );
 366                 }
 367                 if ( $element === 'select' && isset( $attribs['size'] ) ) {
 368                         if ( in_array( 'multiple', $attribs )
 369                                 || ( isset( $attribs['multiple'] ) && $attribs['multiple'] !== false )
 370                         ) {
 371                                 # A multi-select
 372                                 if ( strval( $attribs['size'] ) == '4' ) {
 373                                         unset( $attribs['size'] );
 374                                 }
 375                         } else {
 376                                 # Single select
 377                                 if ( strval( $attribs['size'] ) == '1' ) {
 378                                         unset( $attribs['size'] );
 379                                 }
 380                         }
 381                 }
 382
 383                 return $attribs;
 384         }
 385
 386         /**
 387          * Given an associative array of element attributes, generate a string
 388          * to stick after the element name in HTML output.  Like array( 'href' =>
 389          * 'http://www.mediawiki.org/' ) becomes something like
 390          * ' href="http://www.mediawiki.org"'.  Again, this is like
 391          * Xml::expandAttributes(), but it implements some HTML-specific logic.
 392          * For instance, it will omit quotation marks if $wgWellFormedXml is false,
 393          * and will treat boolean attributes specially.
 394          *
 395          * Attributes that should contain space-separated lists (such as 'class') array
 396          * values are allowed as well, which will automagically be normalized
 397          * and converted to a space-separated string. In addition to a numerical
 398          * array, the attribute value may also be an associative array. See the
 399          * example below for how that works.
 400          *
 401          * @par Numerical array
 402          * @code
 403          *     Html::element( 'em', array(
 404          *         'class' => array( 'foo', 'bar' )
 405          *     ) );
 406          *     // gives '<em class="foo bar"></em>'
 407          * @endcode
 408          *
 409          * @par Associative array
 410          * @code
 411          *     Html::element( 'em', array(
 412          *         'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
 413          *     ) );
 414          *     // gives '<em class="bar quux"></em>'
 415          * @endcode
 416          *
 417          * @param $attribs array Associative array of attributes, e.g., array(
 418          *   'href' => 'http://www.mediawiki.org/' ).  Values will be HTML-escaped.
 419          *   A value of false means to omit the attribute.  For boolean attributes,
 420          *   you can omit the key, e.g., array( 'checked' ) instead of
 421          *   array( 'checked' => 'checked' ) or such.
 422          * @return string HTML fragment that goes between element name and '>'
 423          *   (starting with a space if at least one attribute is output)
 424          */
 425         public static function expandAttributes( $attribs ) {
 426                 global $wgHtml5, $wgWellFormedXml;
 427
 428                 $ret = '';
 429                 $attribs = (array)$attribs;
 430                 foreach ( $attribs as $key => $value ) {
 431                         if ( $value === false || is_null( $value ) ) {
 432                                 continue;
 433                         }
 434
 435                         # For boolean attributes, support array( 'foo' ) instead of
 436                         # requiring array( 'foo' => 'meaningless' ).
 437                         if ( is_int( $key )
 438                         && in_array( strtolower( $value ), self::$boolAttribs ) ) {
 439                                 $key = $value;
 440                         }
 441
 442                         # Not technically required in HTML5, but required in XHTML 1.0,
 443                         # and we'd like consistency and better compression anyway.
 444                         $key = strtolower( $key );
 445
 446                         # Here we're blacklisting some HTML5-only attributes...
 447                         if ( !$wgHtml5 && in_array( $key, self::$HTMLFiveOnlyAttribs )
 448                          ) {
 449                                 continue;
 450                         }
 451
 452                         # Bug 23769: Blacklist all form validation attributes for now.  Current
 453                         # (June 2010) WebKit has no UI, so the form just refuses to submit
 454                         # without telling the user why, which is much worse than failing
 455                         # server-side validation.  Opera is the only other implementation at
 456                         # this time, and has ugly UI, so just kill the feature entirely until
 457                         # we have at least one good implementation.
 458                         if ( in_array( $key, array( 'max', 'min', 'pattern', 'required', 'step' ) ) ) {
 459                                 continue;
 460                         }
 461
 462                         // http://www.w3.org/TR/html401/index/attributes.html ("space-separated")
 463                         // http://www.w3.org/TR/html5/index.html#attributes-1 ("space-separated")
 464                         $spaceSeparatedListAttributes = array(
 465                                 'class', // html4, html5
 466                                 'accesskey', // as of html5, multiple space-separated values allowed
 467                                 // html4-spec doesn't document rel= as space-separated
 468                                 // but has been used like that and is now documented as such
 469                                 // in the html5-spec.
 470                                 'rel',
 471                         );
 472
 473                         # Specific features for attributes that allow a list of space-separated values
 474                         if ( in_array( $key, $spaceSeparatedListAttributes ) ) {
 475                                 // Apply some normalization and remove duplicates
 476
 477                                 // Convert into correct array. Array can contain space-seperated
 478                                 // values. Implode/explode to get those into the main array as well.
 479                                 if ( is_array( $value ) ) {
 480                                         // If input wasn't an array, we can skip this step
 481
 482                                         $newValue = array();
 483                                         foreach ( $value as $k => $v ) {
 484                                                 if ( is_string( $v ) ) {
 485                                                         // String values should be normal `array( 'foo' )`
 486                                                         // Just append them
 487                                                         if ( !isset( $value[$v] ) ) {
 488                                                                 // As a special case don't set 'foo' if a
 489                                                                 // separate 'foo' => true/false exists in the array
 490                                                                 // keys should be authoritive
 491                                                                 $newValue[] = $v;
 492                                                         }
 493                                                 } elseif ( $v ) {
 494                                                         // If the value is truthy but not a string this is likely
 495                                                         // an array( 'foo' => true ), falsy values don't add strings
 496                                                         $newValue[] = $k;
 497                                                 }
 498                                         }
 499                                         $value = implode( ' ', $newValue );
 500                                 }
 501                                 $value = explode( ' ', $value );
 502
 503                                 // Normalize spacing by fixing up cases where people used
 504                                 // more than 1 space and/or a trailing/leading space
 505                                 $value = array_diff( $value, array( '', ' ' ) );
 506
 507                                 // Remove duplicates and create the string
 508                                 $value = implode( ' ', array_unique( $value ) );
 509                         }
 510
 511                         # See the "Attributes" section in the HTML syntax part of HTML5,
 512                         # 9.1.2.3 as of 2009-08-10.  Most attributes can have quotation
 513                         # marks omitted, but not all.  (Although a literal " is not
 514                         # permitted, we don't check for that, since it will be escaped
 515                         # anyway.)
 516                         #
 517                         # See also research done on further characters that need to be
 518                         # escaped: http://code.google.com/p/html5lib/issues/detail?id=93
 519                         $badChars = "\\x00- '=<>`/\x{00a0}\x{1680}\x{180e}\x{180F}\x{2000}\x{2001}"
 520                                 . "\x{2002}\x{2003}\x{2004}\x{2005}\x{2006}\x{2007}\x{2008}\x{2009}"
 521                                 . "\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}";
 522                         if ( $wgWellFormedXml || $value === ''
 523                         || preg_match( "![$badChars]!u", $value ) ) {
 524                                 $quote = '"';
 525                         } else {
 526                                 $quote = '';
 527                         }
 528
 529                         if ( in_array( $key, self::$boolAttribs ) ) {
 530                                 # In XHTML 1.0 Transitional, the value needs to be equal to the
 531                                 # key.  In HTML5, we can leave the value empty instead.  If we
 532                                 # don't need well-formed XML, we can omit the = entirely.
 533                                 if ( !$wgWellFormedXml ) {
 534                                         $ret .= " $key";
 535                                 } elseif ( $wgHtml5 ) {
 536                                         $ret .= " $key=\"\"";
 537                                 } else {
 538                                         $ret .= " $key=\"$key\"";
 539                                 }
 540                         } else {
 541                                 # Apparently we need to entity-encode \n, \r, \t, although the
 542                                 # spec doesn't mention that.  Since we're doing strtr() anyway,
 543                                 # and we don't need <> escaped here, we may as well not call
 544                                 # htmlspecialchars().
 545                                 # @todo FIXME: Verify that we actually need to
 546                                 # escape \n\r\t here, and explain why, exactly.
 547                                 #
 548                                 # We could call Sanitizer::encodeAttribute() for this, but we
 549                                 # don't because we're stubborn and like our marginal savings on
 550                                 # byte size from not having to encode unnecessary quotes.
 551                                 $map = array(
 552                                         '&' => '&amp;',
 553                                         '"' => '&quot;',
 554                                         "\n" => '&#10;',
 555                                         "\r" => '&#13;',
 556                                         "\t" => '&#9;'
 557                                 );
 558                                 if ( $wgWellFormedXml ) {
 559                                         # This is allowed per spec: <http://www.w3.org/TR/xml/#NT-AttValue>
 560                                         # But reportedly it breaks some XML tools?
 561                                         # @todo FIXME: Is this really true?
 562                                         $map['<'] = '&lt;';
 563                                 }
 564
 565                                 $ret .= " $key=$quote" . strtr( $value, $map ) . $quote;
 566                         }
 567                 }
 568                 return $ret;
 569         }
 570
 571         /**
 572          * Output a "<script>" tag with the given contents.
 573          *
 574          * @todo do some useful escaping as well, like if $contents contains
 575          * literal "</script>" or (for XML) literal "]]>".
 576          *
 577          * @param $contents string JavaScript
 578          * @return string Raw HTML
 579          */
 580         public static function inlineScript( $contents ) {
 581                 global $wgHtml5, $wgJsMimeType, $wgWellFormedXml;
 582
 583                 $attrs = array();
 584
 585                 if ( !$wgHtml5 ) {
 586                         $attrs['type'] = $wgJsMimeType;
 587                 }
 588
 589                 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 590                         $contents = "/*<![CDATA[*/$contents/*]]>*/";
 591                 }
 592
 593                 return self::rawElement( 'script', $attrs, $contents );
 594         }
 595
 596         /**
 597          * Output a "<script>" tag linking to the given URL, e.g.,
 598          * "<script src=foo.js></script>".
 599          *
 600          * @param $url string
 601          * @return string Raw HTML
 602          */
 603         public static function linkedScript( $url ) {
 604                 global $wgHtml5, $wgJsMimeType;
 605
 606                 $attrs = array( 'src' => $url );
 607
 608                 if ( !$wgHtml5 ) {
 609                         $attrs['type'] = $wgJsMimeType;
 610                 }
 611
 612                 return self::element( 'script', $attrs );
 613         }
 614
 615         /**
 616          * Output a "<style>" tag with the given contents for the given media type
 617          * (if any).  TODO: do some useful escaping as well, like if $contents
 618          * contains literal "</style>" (admittedly unlikely).
 619          *
 620          * @param $contents string CSS
 621          * @param $media mixed A media type string, like 'screen'
 622          * @return string Raw HTML
 623          */
 624         public static function inlineStyle( $contents, $media = 'all' ) {
 625                 global $wgWellFormedXml;
 626
 627                 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 628                         $contents = "/*<![CDATA[*/$contents/*]]>*/";
 629                 }
 630
 631                 return self::rawElement( 'style', array(
 632                         'type' => 'text/css',
 633                         'media' => $media,
 634                 ), $contents );
 635         }
 636
 637         /**
 638          * Output a "<link rel=stylesheet>" linking to the given URL for the given
 639          * media type (if any).
 640          *
 641          * @param $url string
 642          * @param $media mixed A media type string, like 'screen'
 643          * @return string Raw HTML
 644          */
 645         public static function linkedStyle( $url, $media = 'all' ) {
 646                 return self::element( 'link', array(
 647                         'rel' => 'stylesheet',
 648                         'href' => $url,
 649                         'type' => 'text/css',
 650                         'media' => $media,
 651                 ) );
 652         }
 653
 654         /**
 655          * Convenience function to produce an "<input>" element.  This supports the
 656          * new HTML5 input types and attributes, and will silently strip them if
 657          * $wgHtml5 is false.
 658          *
 659          * @param $name    string name attribute
 660          * @param $value   mixed  value attribute
 661          * @param $type    string type attribute
 662          * @param $attribs array  Associative array of miscellaneous extra
 663          *   attributes, passed to Html::element()
 664          * @return string Raw HTML
 665          */
 666         public static function input( $name, $value = '', $type = 'text', $attribs = array() ) {
 667                 $attribs['type'] = $type;
 668                 $attribs['value'] = $value;
 669                 $attribs['name'] = $name;
 670
 671                 return self::element( 'input', $attribs );
 672         }
 673
 674         /**
 675          * Convenience function to produce an input element with type=hidden
 676          *
 677          * @param $name    string name attribute
 678          * @param $value   string value attribute
 679          * @param $attribs array  Associative array of miscellaneous extra
 680          *   attributes, passed to Html::element()
 681          * @return string Raw HTML
 682          */
 683         public static function hidden( $name, $value, $attribs = array() ) {
 684                 return self::input( $name, $value, 'hidden', $attribs );
 685         }
 686
 687         /**
 688          * Convenience function to produce an "<input>" element.
 689          *
 690          * This supports leaving out the cols= and rows= which Xml requires and are
 691          * required by HTML4/XHTML but not required by HTML5 and will silently set
 692          * cols="" and rows="" if $wgHtml5 is false and cols and rows are omitted
 693          * (HTML4 validates present but empty cols="" and rows="" as valid).
 694          *
 695          * @param $name    string name attribute
 696          * @param $value   string value attribute
 697          * @param $attribs array  Associative array of miscellaneous extra
 698          *   attributes, passed to Html::element()
 699          * @return string Raw HTML
 700          */
 701         public static function textarea( $name, $value = '', $attribs = array() ) {
 702                 global $wgHtml5;
 703
 704                 $attribs['name'] = $name;
 705
 706                 if ( !$wgHtml5 ) {
 707                         if ( !isset( $attribs['cols'] ) ) {
 708                                 $attribs['cols'] = "";
 709                         }
 710
 711                         if ( !isset( $attribs['rows'] ) ) {
 712                                 $attribs['rows'] = "";
 713                         }
 714                 }
 715
 716                 if (substr($value, 0, 1) == "\n") {
 717                         // Workaround for bug 12130: browsers eat the initial newline
 718                         // assuming that it's just for show, but they do keep the later
 719                         // newlines, which we may want to preserve during editing.
 720                         // Prepending a single newline
 721                         $spacedValue = "\n" . $value;
 722                 } else {
 723                         $spacedValue = $value;
 724                 }
 725                 return self::element( 'textarea', $attribs, $spacedValue );
 726         }
 727         /**
 728          * Build a drop-down box for selecting a namespace
 729          *
 730          * @param $params array:
 731          * - selected: [optional] Id of namespace which should be pre-selected
 732          * - all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces
 733          * - label: text for label to add before the field
 734          * - exclude: [optional] Array of namespace ids to exclude
 735          * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector
 736          * @param $selectAttribs array HTML attributes for the generated select element.
 737          * - id:   [optional], default: 'namespace'
 738          * - name: [optional], default: 'namespace'
 739          * @return string HTML code to select a namespace.
 740          */
 741         public static function namespaceSelector( Array $params = array(), Array $selectAttribs = array() ) {
 742                 global $wgContLang;
 743
 744                 ksort( $selectAttribs );
 745
 746                 // Is a namespace selected?
 747                 if ( isset( $params['selected'] ) ) {
 748                         // If string only contains digits, convert to clean int. Selected could also
 749                         // be "all" or "" etc. which needs to be left untouched.
 750                         // PHP is_numeric() has issues with large strings, PHP ctype_digit has other issues
 751                         // and returns false for already clean ints. Use regex instead..
 752                         if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
 753                                 $params['selected'] = intval( $params['selected'] );
 754                         }
 755                         // else: leaves it untouched for later processing
 756                 } else {
 757                         $params['selected'] = '';
 758                 }
 759
 760                 if ( !isset( $params['exclude'] ) || !is_array( $params['exclude'] ) ) {
 761                         $params['exclude'] = array();
 762                 }
 763                 if ( !isset( $params['disable'] ) || !is_array( $params['disable'] ) ) {
 764                         $params['disable'] = array();
 765                 }
 766
 767                 // Associative array between option-values and option-labels
 768                 $options = array();
 769
 770                 if ( isset( $params['all'] ) ) {
 771                         // add an option that would let the user select all namespaces.
 772                         // Value is provided by user, the name shown is localized for the user.
 773                         $options[$params['all']] = wfMessage( 'namespacesall' )->text();
 774                 }
 775                 // Add all namespaces as options (in the content langauge)
 776                 $options += $wgContLang->getFormattedNamespaces();
 777
 778                 // Convert $options to HTML and filter out namespaces below 0
 779                 $optionsHtml = array();
 780                 foreach ( $options as $nsId => $nsName ) {
 781                         if ( $nsId < NS_MAIN || in_array( $nsId, $params['exclude'] ) ) {
 782                                 continue;
 783                         }
 784                         if ( $nsId === 0 ) {
 785                                 // For other namespaces use use the namespace prefix as label, but for
 786                                 // main we don't use "" but the user message descripting it (e.g. "(Main)" or "(Article)")
 787                                 $nsName = wfMessage( 'blanknamespace' )->text();
 788                         }
 789                         $optionsHtml[] = Html::element(
 790                                 'option', array(
 791                                         'disabled' => in_array( $nsId, $params['disable'] ),
 792                                         'value' => $nsId,
 793                                         'selected' => $nsId === $params['selected'],
 794                                 ), $nsName
 795                         );
 796                 }
 797
 798                 $ret = '';
 799                 if ( isset( $params['label'] ) ) {
 800                         $ret .= Html::element(
 801                                 'label', array(
 802                                         'for' => isset( $selectAttribs['id'] ) ? $selectAttribs['id'] : null,
 803                                 ), $params['label']
 804                         ) . '&#160;';
 805                 }
 806
 807                 // Wrap options in a <select>
 808                 $ret .= Html::openElement( 'select', $selectAttribs )
 809                         . "\n"
 810                         . implode( "\n", $optionsHtml )
 811                         . "\n"
 812                         . Html::closeElement( 'select' );
 813
 814                 return $ret;
 815         }
 816
 817         /**
 818          * Constructs the opening html-tag with necessary doctypes depending on
 819          * global variables.
 820          *
 821          * @param $attribs array  Associative array of miscellaneous extra
 822          *   attributes, passed to Html::element() of html tag.
 823          * @return string  Raw HTML
 824          */
 825         public static function htmlHeader( $attribs = array() ) {
 826                 $ret = '';
 827
 828                 global $wgMimeType;
 829
 830                 if ( self::isXmlMimeType( $wgMimeType ) ) {
 831                         $ret .= "<?xml version=\"1.0\" encoding=\"UTF-8\" ?" . ">\n";
 832                 }
 833
 834                 global $wgHtml5, $wgHtml5Version, $wgDocType, $wgDTD;
 835                 global $wgXhtmlNamespaces, $wgXhtmlDefaultNamespace;
 836
 837                 if ( $wgHtml5 ) {
 838                         $ret .= "<!DOCTYPE html>\n";
 839
 840                         if ( $wgHtml5Version ) {
 841                                 $attribs['version'] = $wgHtml5Version;
 842                         }
 843                 } else {
 844                         $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\" \"$wgDTD\">\n";
 845                         $attribs['xmlns'] = $wgXhtmlDefaultNamespace;
 846
 847                         foreach ( $wgXhtmlNamespaces as $tag => $ns ) {
 848                                 $attribs["xmlns:$tag"] = $ns;
 849                         }
 850                 }
 851
 852                 $html = Html::openElement( 'html', $attribs );
 853
 854                 if ( $html ) {
 855                         $html .= "\n";
 856                 }
 857
 858                 $ret .= $html;
 859
 860                 return $ret;
 861         }
 862
 863         /**
 864          * Determines if the given mime type is xml.
 865          *
 866          * @param $mimetype    string MimeType
 867          * @return Boolean
 868          */
 869         public static function isXmlMimeType( $mimetype ) {
 870                 switch ( $mimetype ) {
 871                         case 'text/xml':
 872                         case 'application/xhtml+xml':
 873                         case 'application/xml':
 874                                 return true;
 875                         default:
 876                                 return false;
 877                 }
 878         }
 879
 880         /**
 881          * Get HTML for an info box with an icon.
 882          *
 883          * @param $text String: wikitext, get this with wfMessage()->plain()
 884          * @param $icon String: icon name, file in skins/common/images
 885          * @param $alt String: alternate text for the icon
 886          * @param $class String: additional class name to add to the wrapper div
 887          * @param $useStylePath
 888          *
 889          * @return string
 890          */
 891         static function infoBox( $text, $icon, $alt, $class = false, $useStylePath = true ) {
 892                 global $wgStylePath;
 893
 894                 if ( $useStylePath ) {
 895                         $icon = $wgStylePath.'/common/images/'.$icon;
 896                 }
 897
 898                 $s  = Html::openElement( 'div', array( 'class' => "mw-infobox $class") );
 899
 900                 $s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-left' ) ).
 901                                 Html::element( 'img',
 902                                         array(
 903                                                 'src' => $icon,
 904                                                 'alt' => $alt,
 905                                         )
 906                                 ).
 907                                 Html::closeElement( 'div' );
 908
 909                 $s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-right' ) ).
 910                                 $text.
 911                                 Html::closeElement( 'div' );
 912                 $s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
 913
 914                 $s .= Html::closeElement( 'div' );
 915
 916                 $s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
 917
 918                 return $s;
 919         }
 920 }