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 string $element The element's name, e.g., 'a'
 130          * @param array $attribs  Associative array of attributes, e.g., array(
 131          *   'href' => 'http://www.mediawiki.org/' ). See expandAttributes() for
 132          *   further documentation.
 133          * @param string $contents 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 invalid input types
 195                 if ( $element == 'input' ) {
 196                         $validTypes = array(
 197                                 'hidden',
 198                                 'text',
 199                                 'password',
 200                                 'checkbox',
 201                                 'radio',
 202                                 'file',
 203                                 'submit',
 204                                 'image',
 205                                 'reset',
 206                                 'button',
 207                         );
 208
 209                         // Allow more input types in HTML5 mode
 210                         if ( $wgHtml5 ) {
 211                                 $validTypes = array_merge( $validTypes, array(
 212                                         'datetime',
 213                                         'datetime-local',
 214                                         'date',
 215                                         'month',
 216                                         'time',
 217                                         'week',
 218                                         'number',
 219                                         'range',
 220                                         'email',
 221                                         'url',
 222                                         'search',
 223                                         'tel',
 224                                         'color',
 225                                 ) );
 226                         }
 227                         if ( isset( $attribs['type'] )
 228                         && !in_array( $attribs['type'], $validTypes ) ) {
 229                                 unset( $attribs['type'] );
 230                         }
 231                 }
 232
 233                 if ( !$wgHtml5 && $element == 'textarea' && isset( $attribs['maxlength'] ) ) {
 234                         unset( $attribs['maxlength'] );
 235                 }
 236
 237                 // According to standard the default type for <button> elements is "submit".
 238                 // Depending on compatibility mode IE might use "button", instead.
 239                 // We enforce the standard "submit".
 240                 if ( $element == 'button' && !isset( $attribs['type'] ) ) {
 241                         $attribs['type'] = 'submit';
 242                 }
 243
 244                 return "<$element" . self::expandAttributes(
 245                         self::dropDefaults( $element, $attribs ) ) . '>';
 246         }
 247
 248         /**
 249          * Returns "</$element>", except if $wgWellFormedXml is off, in which case
 250          * it returns the empty string when that's guaranteed to be safe.
 251          *
 252          * @since 1.17
 253          * @param string $element Name of the element, e.g., 'a'
 254          * @return string A closing tag, if required
 255          */
 256         public static function closeElement( $element ) {
 257                 global $wgWellFormedXml;
 258
 259                 $element = strtolower( $element );
 260
 261                 // Reference:
 262                 // http://www.whatwg.org/specs/web-apps/current-work/multipage/syntax.html#optional-tags
 263                 if ( !$wgWellFormedXml && in_array( $element, array(
 264                         'html',
 265                         'head',
 266                         'body',
 267                         'li',
 268                         'dt',
 269                         'dd',
 270                         'tr',
 271                         'td',
 272                         'th',
 273                 ) ) ) {
 274                         return '';
 275                 }
 276                 return "</$element>";
 277         }
 278
 279         /**
 280          * Given an element name and an associative array of element attributes,
 281          * return an array that is functionally identical to the input array, but
 282          * possibly smaller.  In particular, attributes might be stripped if they
 283          * are given their default values.
 284          *
 285          * This method is not guaranteed to remove all redundant attributes, only
 286          * some common ones and some others selected arbitrarily at random.  It
 287          * only guarantees that the output array should be functionally identical
 288          * to the input array (currently per the HTML 5 draft as of 2009-09-06).
 289          *
 290          * @param string $element Name of the element, e.g., 'a'
 291          * @param array $attribs  Associative array of attributes, e.g., array(
 292          *   'href' => 'http://www.mediawiki.org/' ).  See expandAttributes() for
 293          *   further documentation.
 294          * @return array An array of attributes functionally identical to $attribs
 295          */
 296         private static function dropDefaults( $element, $attribs ) {
 297                 // Don't bother doing anything if we aren't outputting HTML5; it's too
 298                 // much of a pain to maintain two sets of defaults.
 299                 global $wgHtml5;
 300                 if ( !$wgHtml5 ) {
 301                         return $attribs;
 302                 }
 303
 304                 // Whenever altering this array, please provide a covering test case
 305                 // in HtmlTest::provideElementsWithAttributesHavingDefaultValues
 306                 static $attribDefaults = array(
 307                         'area' => array( 'shape' => 'rect' ),
 308                         'button' => array(
 309                                 'formaction' => 'GET',
 310                                 'formenctype' => 'application/x-www-form-urlencoded',
 311                         ),
 312                         'canvas' => array(
 313                                 'height' => '150',
 314                                 'width' => '300',
 315                         ),
 316                         'command' => array( 'type' => 'command' ),
 317                         'form' => array(
 318                                 'action' => 'GET',
 319                                 'autocomplete' => 'on',
 320                                 'enctype' => 'application/x-www-form-urlencoded',
 321                         ),
 322                         'input' => array(
 323                                 'formaction' => 'GET',
 324                                 'type' => 'text',
 325                         ),
 326                         'keygen' => array( 'keytype' => 'rsa' ),
 327                         'link' => array( 'media' => 'all' ),
 328                         'menu' => array( 'type' => 'list' ),
 329                         // Note: the use of text/javascript here instead of other JavaScript
 330                         // MIME types follows the HTML5 spec.
 331                         'script' => array( 'type' => 'text/javascript' ),
 332                         'style' => array(
 333                                 'media' => 'all',
 334                                 'type' => 'text/css',
 335                         ),
 336                         'textarea' => array( 'wrap' => 'soft' ),
 337                 );
 338
 339                 $element = strtolower( $element );
 340
 341                 foreach ( $attribs as $attrib => $value ) {
 342                         $lcattrib = strtolower( $attrib );
 343                         if ( is_array( $value ) ) {
 344                                 $value = implode( ' ', $value );
 345                         } else {
 346                                 $value = strval( $value );
 347                         }
 348
 349                         // Simple checks using $attribDefaults
 350                         if ( isset( $attribDefaults[$element][$lcattrib] ) &&
 351                         $attribDefaults[$element][$lcattrib] == $value ) {
 352                                 unset( $attribs[$attrib] );
 353                         }
 354
 355                         if ( $lcattrib == 'class' && $value == '' ) {
 356                                 unset( $attribs[$attrib] );
 357                         }
 358                 }
 359
 360                 // More subtle checks
 361                 if ( $element === 'link' && isset( $attribs['type'] )
 362                 && strval( $attribs['type'] ) == 'text/css' ) {
 363                         unset( $attribs['type'] );
 364                 }
 365                 if ( $element === 'input' ) {
 366                         $type = isset( $attribs['type'] ) ? $attribs['type'] : null;
 367                         $value = isset( $attribs['value'] ) ? $attribs['value'] : null;
 368                         if ( $type === 'checkbox' || $type === 'radio' ) {
 369                                 // The default value for checkboxes and radio buttons is 'on'
 370                                 // not ''. By stripping value="" we break radio boxes that
 371                                 // actually wants empty values.
 372                                 if ( $value === 'on' ) {
 373                                         unset( $attribs['value'] );
 374                                 }
 375                         } elseif ( $type === 'submit' ) {
 376                                 // The default value for submit appears to be "Submit" but
 377                                 // let's not bother stripping out localized text that matches
 378                                 // that.
 379                         } else {
 380                                 // The default value for nearly every other field type is ''
 381                                 // The 'range' and 'color' types use different defaults but
 382                                 // stripping a value="" does not hurt them.
 383                                 if ( $value === '' ) {
 384                                         unset( $attribs['value'] );
 385                                 }
 386                         }
 387                 }
 388                 if ( $element === 'select' && isset( $attribs['size'] ) ) {
 389                         if ( in_array( 'multiple', $attribs )
 390                                 || ( isset( $attribs['multiple'] ) && $attribs['multiple'] !== false )
 391                         ) {
 392                                 // A multi-select
 393                                 if ( strval( $attribs['size'] ) == '4' ) {
 394                                         unset( $attribs['size'] );
 395                                 }
 396                         } else {
 397                                 // Single select
 398                                 if ( strval( $attribs['size'] ) == '1' ) {
 399                                         unset( $attribs['size'] );
 400                                 }
 401                         }
 402                 }
 403
 404                 return $attribs;
 405         }
 406
 407         /**
 408          * Given an associative array of element attributes, generate a string
 409          * to stick after the element name in HTML output.  Like array( 'href' =>
 410          * 'http://www.mediawiki.org/' ) becomes something like
 411          * ' href="http://www.mediawiki.org"'.  Again, this is like
 412          * Xml::expandAttributes(), but it implements some HTML-specific logic.
 413          * For instance, it will omit quotation marks if $wgWellFormedXml is false,
 414          * and will treat boolean attributes specially.
 415          *
 416          * Attributes that should contain space-separated lists (such as 'class') array
 417          * values are allowed as well, which will automagically be normalized
 418          * and converted to a space-separated string. In addition to a numerical
 419          * array, the attribute value may also be an associative array. See the
 420          * example below for how that works.
 421          *
 422          * @par Numerical array
 423          * @code
 424          *     Html::element( 'em', array(
 425          *         'class' => array( 'foo', 'bar' )
 426          *     ) );
 427          *     // gives '<em class="foo bar"></em>'
 428          * @endcode
 429          *
 430          * @par Associative array
 431          * @code
 432          *     Html::element( 'em', array(
 433          *         'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
 434          *     ) );
 435          *     // gives '<em class="bar quux"></em>'
 436          * @endcode
 437          *
 438          * @param array $attribs Associative array of attributes, e.g., array(
 439          *   'href' => 'http://www.mediawiki.org/' ).  Values will be HTML-escaped.
 440          *   A value of false means to omit the attribute.  For boolean attributes,
 441          *   you can omit the key, e.g., array( 'checked' ) instead of
 442          *   array( 'checked' => 'checked' ) or such.
 443          * @return string HTML fragment that goes between element name and '>'
 444          *   (starting with a space if at least one attribute is output)
 445          */
 446         public static function expandAttributes( $attribs ) {
 447                 global $wgHtml5, $wgWellFormedXml;
 448
 449                 $ret = '';
 450                 $attribs = (array)$attribs;
 451                 foreach ( $attribs as $key => $value ) {
 452                         if ( $value === false || is_null( $value ) ) {
 453                                 continue;
 454                         }
 455
 456                         // For boolean attributes, support array( 'foo' ) instead of
 457                         // requiring array( 'foo' => 'meaningless' ).
 458                         if ( is_int( $key )
 459                         && in_array( strtolower( $value ), self::$boolAttribs ) ) {
 460                                 $key = $value;
 461                         }
 462
 463                         // Not technically required in HTML5, but required in XHTML 1.0,
 464                         // and we'd like consistency and better compression anyway.
 465                         $key = strtolower( $key );
 466
 467                         // Here we're blacklisting some HTML5-only attributes...
 468                         if ( !$wgHtml5 && in_array( $key, self::$HTMLFiveOnlyAttribs ) ) {
 469                                 continue;
 470                         }
 471
 472                         // Bug 23769: Blacklist all form validation attributes for now.  Current
 473                         // (June 2010) WebKit has no UI, so the form just refuses to submit
 474                         // without telling the user why, which is much worse than failing
 475                         // server-side validation.  Opera is the only other implementation at
 476                         // this time, and has ugly UI, so just kill the feature entirely until
 477                         // we have at least one good implementation.
 478
 479                         // As the default value of "1" for "step" rejects decimal
 480                         // numbers to be entered in 'type="number"' fields, allow
 481                         // the special case 'step="any"'.
 482
 483                         if ( in_array( $key, array( 'max', 'min', 'pattern', 'required' ) ) ||
 484                                  $key === 'step' && $value !== 'any' ) {
 485                                 continue;
 486                         }
 487
 488                         // http://www.w3.org/TR/html401/index/attributes.html ("space-separated")
 489                         // http://www.w3.org/TR/html5/index.html#attributes-1 ("space-separated")
 490                         $spaceSeparatedListAttributes = array(
 491                                 'class', // html4, html5
 492                                 'accesskey', // as of html5, multiple space-separated values allowed
 493                                 // html4-spec doesn't document rel= as space-separated
 494                                 // but has been used like that and is now documented as such
 495                                 // in the html5-spec.
 496                                 'rel',
 497                         );
 498
 499                         // Specific features for attributes that allow a list of space-separated values
 500                         if ( in_array( $key, $spaceSeparatedListAttributes ) ) {
 501                                 // Apply some normalization and remove duplicates
 502
 503                                 // Convert into correct array. Array can contain space-separated
 504                                 // values. Implode/explode to get those into the main array as well.
 505                                 if ( is_array( $value ) ) {
 506                                         // If input wasn't an array, we can skip this step
 507                                         $newValue = array();
 508                                         foreach ( $value as $k => $v ) {
 509                                                 if ( is_string( $v ) ) {
 510                                                         // String values should be normal `array( 'foo' )`
 511                                                         // Just append them
 512                                                         if ( !isset( $value[$v] ) ) {
 513                                                                 // As a special case don't set 'foo' if a
 514                                                                 // separate 'foo' => true/false exists in the array
 515                                                                 // keys should be authoritative
 516                                                                 $newValue[] = $v;
 517                                                         }
 518                                                 } elseif ( $v ) {
 519                                                         // If the value is truthy but not a string this is likely
 520                                                         // an array( 'foo' => true ), falsy values don't add strings
 521                                                         $newValue[] = $k;
 522                                                 }
 523                                         }
 524                                         $value = implode( ' ', $newValue );
 525                                 }
 526                                 $value = explode( ' ', $value );
 527
 528                                 // Normalize spacing by fixing up cases where people used
 529                                 // more than 1 space and/or a trailing/leading space
 530                                 $value = array_diff( $value, array( '', ' ' ) );
 531
 532                                 // Remove duplicates and create the string
 533                                 $value = implode( ' ', array_unique( $value ) );
 534                         }
 535
 536                         // See the "Attributes" section in the HTML syntax part of HTML5,
 537                         // 9.1.2.3 as of 2009-08-10.  Most attributes can have quotation
 538                         // marks omitted, but not all.  (Although a literal " is not
 539                         // permitted, we don't check for that, since it will be escaped
 540                         // anyway.)
 541                         #
 542                         // See also research done on further characters that need to be
 543                         // escaped: http://code.google.com/p/html5lib/issues/detail?id=93
 544                         $badChars = "\\x00- '=<>`/\x{00a0}\x{1680}\x{180e}\x{180F}\x{2000}\x{2001}"
 545                                 . "\x{2002}\x{2003}\x{2004}\x{2005}\x{2006}\x{2007}\x{2008}\x{2009}"
 546                                 . "\x{200A}\x{2028}\x{2029}\x{202F}\x{205F}\x{3000}";
 547                         if ( $wgWellFormedXml || $value === ''
 548                         || preg_match( "![$badChars]!u", $value ) ) {
 549                                 $quote = '"';
 550                         } else {
 551                                 $quote = '';
 552                         }
 553
 554                         if ( in_array( $key, self::$boolAttribs ) ) {
 555                                 // In XHTML 1.0 Transitional, the value needs to be equal to the
 556                                 // key.  In HTML5, we can leave the value empty instead.  If we
 557                                 // don't need well-formed XML, we can omit the = entirely.
 558                                 if ( !$wgWellFormedXml ) {
 559                                         $ret .= " $key";
 560                                 } elseif ( $wgHtml5 ) {
 561                                         $ret .= " $key=\"\"";
 562                                 } else {
 563                                         $ret .= " $key=\"$key\"";
 564                                 }
 565                         } else {
 566                                 // Apparently we need to entity-encode \n, \r, \t, although the
 567                                 // spec doesn't mention that.  Since we're doing strtr() anyway,
 568                                 // and we don't need <> escaped here, we may as well not call
 569                                 // htmlspecialchars().
 570                                 // @todo FIXME: Verify that we actually need to
 571                                 // escape \n\r\t here, and explain why, exactly.
 572                                 #
 573                                 // We could call Sanitizer::encodeAttribute() for this, but we
 574                                 // don't because we're stubborn and like our marginal savings on
 575                                 // byte size from not having to encode unnecessary quotes.
 576                                 $map = array(
 577                                         '&' => '&amp;',
 578                                         '"' => '&quot;',
 579                                         "\n" => '&#10;',
 580                                         "\r" => '&#13;',
 581                                         "\t" => '&#9;'
 582                                 );
 583                                 if ( $wgWellFormedXml ) {
 584                                         // This is allowed per spec: <http://www.w3.org/TR/xml/#NT-AttValue>
 585                                         // But reportedly it breaks some XML tools?
 586                                         // @todo FIXME: Is this really true?
 587                                         $map['<'] = '&lt;';
 588                                 }
 589                                 $ret .= " $key=$quote" . strtr( $value, $map ) . $quote;
 590                         }
 591                 }
 592                 return $ret;
 593         }
 594
 595         /**
 596          * Output a "<script>" tag with the given contents.
 597          *
 598          * @todo do some useful escaping as well, like if $contents contains
 599          * literal "</script>" or (for XML) literal "]]>".
 600          *
 601          * @param string $contents JavaScript
 602          * @return string Raw HTML
 603          */
 604         public static function inlineScript( $contents ) {
 605                 global $wgHtml5, $wgJsMimeType, $wgWellFormedXml;
 606
 607                 $attrs = array();
 608
 609                 if ( !$wgHtml5 ) {
 610                         $attrs['type'] = $wgJsMimeType;
 611                 }
 612
 613                 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 614                         $contents = "/*<![CDATA[*/$contents/*]]>*/";
 615                 }
 616
 617                 return self::rawElement( 'script', $attrs, $contents );
 618         }
 619
 620         /**
 621          * Output a "<script>" tag linking to the given URL, e.g.,
 622          * "<script src=foo.js></script>".
 623          *
 624          * @param $url string
 625          * @return string Raw HTML
 626          */
 627         public static function linkedScript( $url ) {
 628                 global $wgHtml5, $wgJsMimeType;
 629
 630                 $attrs = array( 'src' => $url );
 631
 632                 if ( !$wgHtml5 ) {
 633                         $attrs['type'] = $wgJsMimeType;
 634                 }
 635
 636                 return self::element( 'script', $attrs );
 637         }
 638
 639         /**
 640          * Output a "<style>" tag with the given contents for the given media type
 641          * (if any).  TODO: do some useful escaping as well, like if $contents
 642          * contains literal "</style>" (admittedly unlikely).
 643          *
 644          * @param string $contents CSS
 645          * @param $media mixed A media type string, like 'screen'
 646          * @return string Raw HTML
 647          */
 648         public static function inlineStyle( $contents, $media = 'all' ) {
 649                 global $wgWellFormedXml;
 650
 651                 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 652                         $contents = "/*<![CDATA[*/$contents/*]]>*/";
 653                 }
 654
 655                 return self::rawElement( 'style', array(
 656                         'type' => 'text/css',
 657                         'media' => $media,
 658                 ), $contents );
 659         }
 660
 661         /**
 662          * Output a "<link rel=stylesheet>" linking to the given URL for the given
 663          * media type (if any).
 664          *
 665          * @param $url string
 666          * @param $media mixed A media type string, like 'screen'
 667          * @return string Raw HTML
 668          */
 669         public static function linkedStyle( $url, $media = 'all' ) {
 670                 return self::element( 'link', array(
 671                         'rel' => 'stylesheet',
 672                         'href' => $url,
 673                         'type' => 'text/css',
 674                         'media' => $media,
 675                 ) );
 676         }
 677
 678         /**
 679          * Convenience function to produce an "<input>" element.  This supports the
 680          * new HTML5 input types and attributes, and will silently strip them if
 681          * $wgHtml5 is false.
 682          *
 683          * @param $name    string name attribute
 684          * @param $value   mixed  value attribute
 685          * @param $type    string type attribute
 686          * @param array $attribs  Associative array of miscellaneous extra
 687          *   attributes, passed to Html::element()
 688          * @return string Raw HTML
 689          */
 690         public static function input( $name, $value = '', $type = 'text', $attribs = array() ) {
 691                 $attribs['type'] = $type;
 692                 $attribs['value'] = $value;
 693                 $attribs['name'] = $name;
 694
 695                 return self::element( 'input', $attribs );
 696         }
 697
 698         /**
 699          * Convenience function to produce an input element with type=hidden
 700          *
 701          * @param $name    string name attribute
 702          * @param $value   string value attribute
 703          * @param array $attribs  Associative array of miscellaneous extra
 704          *   attributes, passed to Html::element()
 705          * @return string Raw HTML
 706          */
 707         public static function hidden( $name, $value, $attribs = array() ) {
 708                 return self::input( $name, $value, 'hidden', $attribs );
 709         }
 710
 711         /**
 712          * Convenience function to produce an "<input>" element.
 713          *
 714          * This supports leaving out the cols= and rows= which Xml requires and are
 715          * required by HTML4/XHTML but not required by HTML5 and will silently set
 716          * cols="" and rows="" if $wgHtml5 is false and cols and rows are omitted
 717          * (HTML4 validates present but empty cols="" and rows="" as valid).
 718          *
 719          * @param $name    string name attribute
 720          * @param $value   string value attribute
 721          * @param array $attribs  Associative array of miscellaneous extra
 722          *   attributes, passed to Html::element()
 723          * @return string Raw HTML
 724          */
 725         public static function textarea( $name, $value = '', $attribs = array() ) {
 726                 global $wgHtml5;
 727
 728                 $attribs['name'] = $name;
 729
 730                 if ( !$wgHtml5 ) {
 731                         if ( !isset( $attribs['cols'] ) ) {
 732                                 $attribs['cols'] = "";
 733                         }
 734
 735                         if ( !isset( $attribs['rows'] ) ) {
 736                                 $attribs['rows'] = "";
 737                         }
 738                 }
 739
 740                 if ( substr( $value, 0, 1 ) == "\n" ) {
 741                         // Workaround for bug 12130: browsers eat the initial newline
 742                         // assuming that it's just for show, but they do keep the later
 743                         // newlines, which we may want to preserve during editing.
 744                         // Prepending a single newline
 745                         $spacedValue = "\n" . $value;
 746                 } else {
 747                         $spacedValue = $value;
 748                 }
 749                 return self::element( 'textarea', $attribs, $spacedValue );
 750         }
 751         /**
 752          * Build a drop-down box for selecting a namespace
 753          *
 754          * @param $params array:
 755          * - selected: [optional] Id of namespace which should be pre-selected
 756          * - all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces
 757          * - label: text for label to add before the field
 758          * - exclude: [optional] Array of namespace ids to exclude
 759          * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector
 760          * @param array $selectAttribs HTML attributes for the generated select element.
 761          * - id:   [optional], default: 'namespace'
 762          * - name: [optional], default: 'namespace'
 763          * @return string HTML code to select a namespace.
 764          */
 765         public static function namespaceSelector( array $params = array(), array $selectAttribs = array() ) {
 766                 global $wgContLang;
 767
 768                 ksort( $selectAttribs );
 769
 770                 // Is a namespace selected?
 771                 if ( isset( $params['selected'] ) ) {
 772                         // If string only contains digits, convert to clean int. Selected could also
 773                         // be "all" or "" etc. which needs to be left untouched.
 774                         // PHP is_numeric() has issues with large strings, PHP ctype_digit has other issues
 775                         // and returns false for already clean ints. Use regex instead..
 776                         if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
 777                                 $params['selected'] = intval( $params['selected'] );
 778                         }
 779                         // else: leaves it untouched for later processing
 780                 } else {
 781                         $params['selected'] = '';
 782                 }
 783
 784                 if ( !isset( $params['exclude'] ) || !is_array( $params['exclude'] ) ) {
 785                         $params['exclude'] = array();
 786                 }
 787                 if ( !isset( $params['disable'] ) || !is_array( $params['disable'] ) ) {
 788                         $params['disable'] = array();
 789                 }
 790
 791                 // Associative array between option-values and option-labels
 792                 $options = array();
 793
 794                 if ( isset( $params['all'] ) ) {
 795                         // add an option that would let the user select all namespaces.
 796                         // Value is provided by user, the name shown is localized for the user.
 797                         $options[$params['all']] = wfMessage( 'namespacesall' )->text();
 798                 }
 799                 // Add all namespaces as options (in the content language)
 800                 $options += $wgContLang->getFormattedNamespaces();
 801
 802                 // Convert $options to HTML and filter out namespaces below 0
 803                 $optionsHtml = array();
 804                 foreach ( $options as $nsId => $nsName ) {
 805                         if ( $nsId < NS_MAIN || in_array( $nsId, $params['exclude'] ) ) {
 806                                 continue;
 807                         }
 808                         if ( $nsId === NS_MAIN ) {
 809                                 // For other namespaces use use the namespace prefix as label, but for
 810                                 // main we don't use "" but the user message describing it (e.g. "(Main)" or "(Article)")
 811                                 $nsName = wfMessage( 'blanknamespace' )->text();
 812                         } elseif ( is_int( $nsId ) ) {
 813                                 $nsName = $wgContLang->convertNamespace( $nsId );
 814                         }
 815                         $optionsHtml[] = Html::element(
 816                                 'option', array(
 817                                         'disabled' => in_array( $nsId, $params['disable'] ),
 818                                         'value' => $nsId,
 819                                         'selected' => $nsId === $params['selected'],
 820                                 ), $nsName
 821                         );
 822                 }
 823
 824                 if ( !array_key_exists( 'id', $selectAttribs ) ) {
 825                         $selectAttribs['id'] = 'namespace';
 826                 }
 827
 828                 if ( !array_key_exists( 'name', $selectAttribs ) ) {
 829                         $selectAttribs['name'] = 'namespace';
 830                 }
 831
 832                 $ret = '';
 833                 if ( isset( $params['label'] ) ) {
 834                         $ret .= Html::element(
 835                                 'label', array(
 836                                         'for' => isset( $selectAttribs['id'] ) ? $selectAttribs['id'] : null,
 837                                 ), $params['label']
 838                         ) . '&#160;';
 839                 }
 840
 841                 // Wrap options in a <select>
 842                 $ret .= Html::openElement( 'select', $selectAttribs )
 843                         . "\n"
 844                         . implode( "\n", $optionsHtml )
 845                         . "\n"
 846                         . Html::closeElement( 'select' );
 847
 848                 return $ret;
 849         }
 850
 851         /**
 852          * Constructs the opening html-tag with necessary doctypes depending on
 853          * global variables.
 854          *
 855          * @param array $attribs  Associative array of miscellaneous extra
 856          *   attributes, passed to Html::element() of html tag.
 857          * @return string  Raw HTML
 858          */
 859         public static function htmlHeader( $attribs = array() ) {
 860                 $ret = '';
 861
 862                 global $wgMimeType;
 863
 864                 if ( self::isXmlMimeType( $wgMimeType ) ) {
 865                         $ret .= "<?xml version=\"1.0\" encoding=\"UTF-8\" ?" . ">\n";
 866                 }
 867
 868                 global $wgHtml5, $wgHtml5Version, $wgDocType, $wgDTD;
 869                 global $wgXhtmlNamespaces, $wgXhtmlDefaultNamespace;
 870
 871                 if ( $wgHtml5 ) {
 872                         $ret .= "<!DOCTYPE html>\n";
 873
 874                         if ( $wgHtml5Version ) {
 875                                 $attribs['version'] = $wgHtml5Version;
 876                         }
 877                 } else {
 878                         $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\" \"$wgDTD\">\n";
 879                         $attribs['xmlns'] = $wgXhtmlDefaultNamespace;
 880
 881                         foreach ( $wgXhtmlNamespaces as $tag => $ns ) {
 882                                 $attribs["xmlns:$tag"] = $ns;
 883                         }
 884                 }
 885
 886                 $html = Html::openElement( 'html', $attribs );
 887
 888                 if ( $html ) {
 889                         $html .= "\n";
 890                 }
 891
 892                 $ret .= $html;
 893
 894                 return $ret;
 895         }
 896
 897         /**
 898          * Determines if the given mime type is xml.
 899          *
 900          * @param $mimetype    string MimeType
 901          * @return Boolean
 902          */
 903         public static function isXmlMimeType( $mimetype ) {
 904                 switch ( $mimetype ) {
 905                         case 'text/xml':
 906                         case 'application/xhtml+xml':
 907                         case 'application/xml':
 908                                 return true;
 909                         default:
 910                                 return false;
 911                 }
 912         }
 913
 914         /**
 915          * Get HTML for an info box with an icon.
 916          *
 917          * @param string $text wikitext, get this with wfMessage()->plain()
 918          * @param string $icon icon name, file in skins/common/images
 919          * @param string $alt alternate text for the icon
 920          * @param string $class additional class name to add to the wrapper div
 921          * @param $useStylePath
 922          *
 923          * @return string
 924          */
 925         static function infoBox( $text, $icon, $alt, $class = false, $useStylePath = true ) {
 926                 global $wgStylePath;
 927
 928                 if ( $useStylePath ) {
 929                         $icon = $wgStylePath . '/common/images/' . $icon;
 930                 }
 931
 932                 $s = Html::openElement( 'div', array( 'class' => "mw-infobox $class" ) );
 933
 934                 $s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-left' ) ) .
 935                                 Html::element( 'img',
 936                                         array(
 937                                                 'src' => $icon,
 938                                                 'alt' => $alt,
 939                                         )
 940                                 ) .
 941                                 Html::closeElement( 'div' );
 942
 943                 $s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-right' ) ) .
 944                                 $text .
 945                                 Html::closeElement( 'div' );
 946                 $s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
 947
 948                 $s .= Html::closeElement( 'div' );
 949
 950                 $s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
 951
 952                 return $s;
 953         }
 954
 955         /**
 956          * Generate a srcset attribute value from an array mapping pixel densities
 957          * to URLs. Note that srcset supports width and height values as well, which
 958          * are not used here.
 959          *
 960          * @param array $urls
 961          * @return string
 962          */
 963         static function srcSet( $urls ) {
 964                 $candidates = array();
 965                 foreach ( $urls as $density => $url ) {
 966                         // Image candidate syntax per current whatwg live spec, 2012-09-23:
 967                         // http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded-content-1.html#attr-img-srcset
 968                         $candidates[] = "{$url} {$density}x";
 969                 }
 970                 return implode( ", ", $candidates );
 971         }
 972 }