includes/Html.php

   1 <?php
   2 # Copyright (C) 2009 Aryeh Gregor
   3 # http://www.mediawiki.org/
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with this program; if not, write to the Free Software Foundation, Inc.,
  17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18 # http://www.gnu.org/copyleft/gpl.html
  19
  20 /**
  21  * This class is a collection of static functions that serve two purposes:
  22  *
  23  * 1) Implement any algorithms specified by HTML 5, or other HTML
  24  * specifications, in a convenient and self-contained way.
  25  *
  26  * 2) Allow HTML elements to be conveniently and safely generated, like the
  27  * current Xml class but a) less confused (Xml supports HTML-specific things,
  28  * but only sometimes!) and b) not necessarily confined to XML-compatible
  29  * output.
  30  *
  31  * There are two important configuration options this class uses:
  32  *
  33  * $wgHtml5: If this is set to false, then all output should be valid XHTML 1.0
  34  *     Transitional.
  35  * $wgWellFormedXml: If this is set to true, then all output should be
  36  *     well-formed XML (quotes on attributes, self-closing tags, etc.).
  37  *
  38  * This class is meant to be confined to utility functions that are called from
  39  * trusted code paths.  It does not do enforcement of policy like not allowing
  40  * <a> elements.
  41  */
  42 class Html {
  43         # List of void elements from HTML 5, section 9.1.2 as of 2009-08-10
  44         private static $voidElements = array(
  45                 'area',
  46                 'base',
  47                 'br',
  48                 'col',
  49                 'command',
  50                 'embed',
  51                 'hr',
  52                 'img',
  53                 'input',
  54                 'keygen',
  55                 'link',
  56                 'meta',
  57                 'param',
  58                 'source',
  59         );
  60
  61         # Boolean attributes, which may have the value omitted entirely.  Manually
  62         # collected from the HTML 5 spec as of 2009-08-10.
  63         private static $boolAttribs = array(
  64                 'async',
  65                 'autobuffer',
  66                 'autofocus',
  67                 'autoplay',
  68                 'checked',
  69                 'controls',
  70                 'defer',
  71                 'disabled',
  72                 'formnovalidate',
  73                 'hidden',
  74                 'ismap',
  75                 'loop',
  76                 'multiple',
  77                 'novalidate',
  78                 'open',
  79                 'readonly',
  80                 'required',
  81                 'reversed',
  82                 'scoped',
  83                 'seamless',
  84         );
  85
  86         /**
  87          * Returns an HTML element in a string.  The major advantage here over
  88          * manually typing out the HTML is that it will escape all attribute
  89          * values.  If you're hardcoding all the attributes, or there are none, you
  90          * should probably type out the string yourself.
  91          *
  92          * This is quite similar to Xml::tags(), but it implements some useful
  93          * HTML-specific logic.  For instance, there is no $allowShortTag
  94          * parameter: the closing tag is magically omitted if $element has an empty
  95          * content model.  If $wgWellFormedXml is false, then a few bytes will be
  96          * shaved off the HTML output as well.  In the future, other HTML-specific
  97          * features might be added, like allowing arrays for the values of
  98          * attributes like class= and media=.
  99          *
 100          * @param $element  string The element's name, e.g., 'a'
 101          * @param $attribs  array  Associative array of attributes, e.g., array(
 102          *   'href' => 'http://www.mediawiki.org/' ).  Values will be HTML-escaped.
 103          *   A value of false means to omit the attribute.
 104          * @param $contents string The raw HTML contents of the element: *not*
 105          *   escaped!
 106          * @return string Raw HTML
 107          */
 108         public static function rawElement( $element, $attribs = array(), $contents = '' ) {
 109                 global $wgHtml5, $wgWellFormedXml;
 110                 # This is not required in HTML 5, but let's do it anyway, for
 111                 # consistency and better compression.
 112                 $element = strtolower( $element );
 113
 114                 # Element-specific hacks to slim down output and ensure validity
 115                 if ( $element == 'input' ) {
 116                         if ( !$wgHtml5 ) {
 117                                 # With $wgHtml5 off we want to validate as XHTML 1, so we
 118                                 # strip out any fancy HTML 5-only input types for now.
 119                                 #
 120                                 # Whitelist of valid types:
 121                                 $validTypes = array(
 122                                         'hidden',
 123                                         'text',
 124                                         'password',
 125                                         'checkbox',
 126                                         'radio',
 127                                         'file',
 128                                         'submit',
 129                                         'image',
 130                                         'reset',
 131                                         'button',
 132                                 );
 133                                 if ( isset( $attribs['type'] )
 134                                 && !in_array( $attribs['type'], $validTypes ) ) {
 135                                         # Fall back to type=text, the default
 136                                         unset( $attribs['type'] );
 137                                 }
 138                                 # Here we're blacklisting some HTML5-only attributes...
 139                                 $html5attribs = array(
 140                                         'autocomplete',
 141                                         'autofocus',
 142                                         'max',
 143                                         'min',
 144                                         'multiple',
 145                                         'pattern',
 146                                         'placeholder',
 147                                         'required',
 148                                         'step',
 149                                 );
 150                                 foreach ( $html5attribs as $badAttr ) {
 151                                         unset( $attribs[$badAttr] );
 152                                 }
 153                         }
 154                 }
 155
 156                 $start = "<$element" . self::expandAttributes(
 157                         self::dropDefaults( $element, $attribs ) );
 158                 if ( in_array( $element, self::$voidElements ) ) {
 159                         if ( $wgWellFormedXml ) {
 160                                 return "$start />";
 161                         }
 162                         return "$start>";
 163                 } else {
 164                         return "$start>$contents</$element>";
 165                 }
 166         }
 167
 168         /**
 169          * Identical to rawElement(), but HTML-escapes $contents (like
 170          * Xml::element()).
 171          */
 172         public static function element( $element, $attribs = array(), $contents = '' ) {
 173                 return self::rawElement( $element, $attribs, strtr( $contents, array(
 174                         # There's no point in escaping quotes, >, etc. in the contents of
 175                         # elements.
 176                         '&' => '&amp;',
 177                         '<' => '&lt;'
 178                 ) ) );
 179         }
 180
 181         /**
 182          * Given an element name and an associative array of element attributes,
 183          * return an array that is functionally identical to the input array, but
 184          * possibly smaller.  In particular, attributes might be stripped if they
 185          * are given their default values.
 186          *
 187          * This method is not guaranteed to remove all redundant attributes, only
 188          * some common ones and some others selected arbitrarily at random.  It
 189          * only guarantees that the output array should be functionally identical
 190          * to the input array (currently per the HTML 5 draft as of 2009-09-06).
 191          *
 192          * @param $element string Name of the element, e.g., 'a'
 193          * @param $attribs array  Associative array of attributes, e.g., array(
 194          *   'href' => 'http://www.mediawiki.org/' ).
 195          * @return array An array of attributes functionally identical to $attribs
 196          */
 197         private static function dropDefaults( $element, $attribs ) {
 198                 static $attribDefaults = array(
 199                         'area' => array( 'shape' => 'rect' ),
 200                         'button' => array(
 201                                 'formaction' => 'GET',
 202                                 'formenctype' => 'application/x-www-form-urlencoded',
 203                                 'type' => 'submit',
 204                         ),
 205                         'canvas' => array(
 206                                 'height' => '150',
 207                                 'width' => '300',
 208                         ),
 209                         'command' => array( 'type' => 'command' ),
 210                         'form' => array(
 211                                 'action' => 'GET',
 212                                 'autocomplete' => 'on',
 213                                 'enctype' => 'application/x-www-form-urlencoded',
 214                         ),
 215                         'input' => array(
 216                                 'formaction' => 'GET',
 217                                 'type' => 'text',
 218                                 'value' => '',
 219                         ),
 220                         'keygen' => array( 'keytype' => 'rsa' ),
 221                         'link' => array( 'media' => 'all' ),
 222                         'menu' => array( 'type' => 'list' ),
 223                         # Note: the use of text/javascript here instead of other JavaScript
 224                         # MIME types follows the HTML 5 spec.
 225                         'script' => array( 'type' => 'text/javascript' ),
 226                         'style' => array(
 227                                 'media' => 'all',
 228                                 'type' => 'text/css',
 229                         ),
 230                         'textarea' => array( 'wrap' => 'soft' ),
 231                 );
 232
 233                 $element = strtolower( $element );
 234
 235                 foreach ( $attribs as $attrib => $value ) {
 236                         $lcattrib = strtolower( $attrib );
 237                         $value = strval( $value );
 238
 239                         # Simple checks using $attribDefaults
 240                         if ( isset( $attribDefaults[$element][$lcattrib] ) &&
 241                         $attribDefaults[$element][$lcattrib] == $value ) {
 242                                 unset( $attribs[$attrib] );
 243                         }
 244
 245                         if ( $lcattrib == 'class' && $value == '' ) {
 246                                 unset( $attribs[$attrib] );
 247                         }
 248                 }
 249
 250                 # More subtle checks
 251                 if ( $element === 'link' && isset( $attribs['type'] )
 252                 && strval( $attribs['type'] ) == 'text/css' ) {
 253                         unset( $attribs['type'] );
 254                 }
 255                 if ( $element === 'select' && isset( $attribs['size'] ) ) {
 256                         if ( in_array( 'multiple', $attribs )
 257                                 || ( isset( $attribs['multiple'] ) && $attribs['multiple'] !== false )
 258                         ) {
 259                                 # A multi-select
 260                                 if ( strval( $attribs['size'] ) == '4' ) {
 261                                         unset( $attribs['size'] );
 262                                 }
 263                         } else {
 264                                 # Single select
 265                                 if ( strval( $attribs['size'] ) == '1' ) {
 266                                         unset( $attribs['size'] );
 267                                 }
 268                         }
 269                 }
 270
 271                 return $attribs;
 272         }
 273
 274         /**
 275          * Given an associative array of element attributes, generate a string
 276          * to stick after the element name in HTML output.  Like array( 'href' =>
 277          * 'http://www.mediawiki.org/' ) becomes something like
 278          * ' href="http://www.mediawiki.org"'.  Again, this is like
 279          * Xml::expandAttributes(), but it implements some HTML-specific logic.
 280          * For instance, it will omit quotation marks if $wgWellFormedXml is false,
 281          * and will treat boolean attributes specially.
 282          *
 283          * @param $attribs array Associative array of attributes, e.g., array(
 284          *   'href' => 'http://www.mediawiki.org/' ).  Values will be HTML-escaped.
 285          *   A value of false means to omit the attribute.
 286          * @return string HTML fragment that goes between element name and '>'
 287          *   (starting with a space if at least one attribute is output)
 288          */
 289         public static function expandAttributes( $attribs = array() ) {
 290                 global $wgHtml5, $wgWellFormedXml;
 291
 292                 $ret = '';
 293                 foreach ( $attribs as $key => $value ) {
 294                         if ( $value === false ) {
 295                                 continue;
 296                         }
 297
 298                         # For boolean attributes, support array( 'foo' ) instead of
 299                         # requiring array( 'foo' => 'meaningless' ).
 300                         if ( is_int( $key )
 301                         && in_array( strtolower( $value ), self::$boolAttribs ) ) {
 302                                 $key = $value;
 303                         }
 304
 305                         # Not technically required in HTML 5, but required in XHTML 1.0,
 306                         # and we'd like consistency and better compression anyway.
 307                         $key = strtolower( $key );
 308
 309                         # See the "Attributes" section in the HTML syntax part of HTML 5,
 310                         # 9.1.2.3 as of 2009-08-10.  Most attributes can have quotation
 311                         # marks omitted, but not all.  (Although a literal " is not
 312                         # permitted, we don't check for that, since it will be escaped
 313                         # anyway.)
 314                         if ( $wgWellFormedXml || $value === ''
 315                         || preg_match( "/[ '=<>]/", $value ) ) {
 316                                 $quote = '"';
 317                         } else {
 318                                 $quote = '';
 319                         }
 320
 321                         if ( in_array( $key, self::$boolAttribs ) ) {
 322                                 # In XHTML 1.0 Transitional, the value needs to be equal to the
 323                                 # key.  In HTML 5, we can leave the value empty instead.  If we
 324                                 # don't need well-formed XML, we can omit the = entirely.
 325                                 if ( !$wgWellFormedXml ) {
 326                                         $ret .= " $key";
 327                                 } elseif ( $wgHtml5 ) {
 328                                         $ret .= " $key=\"\"";
 329                                 } else {
 330                                         $ret .= " $key=\"$key\"";
 331                                 }
 332                         } else {
 333                                 # Apparently we need to entity-encode \n, \r, \t, although the
 334                                 # spec doesn't mention that.  Since we're doing strtr() anyway,
 335                                 # and we don't need <> escaped here, we may as well not call
 336                                 # htmlspecialchars().  FIXME: verify that we actually need to
 337                                 # escape \n\r\t here, and explain why, exactly.
 338                                 if ( $wgHtml5 ) {
 339                                         $ret .= " $key=$quote" . strtr( $value, array(
 340                                                 '&' => '&amp;',
 341                                                 '"' => '&quot;',
 342                                                 "\n" => '&#10;',
 343                                                 "\r" => '&#13;',
 344                                                 "\t" => '&#9;'
 345                                         ) ) . $quote;
 346                                 } else {
 347                                         $ret .= " $key=$quote" . Sanitizer::encodeAttribute( $value ) . $quote;
 348                                 }
 349                         }
 350                 }
 351                 return $ret;
 352         }
 353
 354         /**
 355          * Output a <script> tag with the given contents.  TODO: do some useful
 356          * escaping as well, like if $contents contains literal '</script>' or (for
 357          * XML) literal "]]>".
 358          *
 359          * @param $contents string JavaScript
 360          * @return string Raw HTML
 361          */
 362         public static function inlineScript( $contents ) {
 363                 global $wgHtml5, $wgJsMimeType, $wgWellFormedXml;
 364
 365                 $attrs = array();
 366                 if ( !$wgHtml5 ) {
 367                         $attrs['type'] = $wgJsMimeType;
 368                 }
 369                 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 370                         $contents = "/*<![CDATA[*/$contents/*]]>*/";
 371                 }
 372                 return self::rawElement( 'script', $attrs, $contents );
 373         }
 374
 375         /**
 376          * Output a <script> tag linking to the given URL, e.g.,
 377          * <script src=foo.js></script>.
 378          *
 379          * @param $url string
 380          * @return string Raw HTML
 381          */
 382         public static function linkedScript( $url ) {
 383                 global $wgHtml5, $wgJsMimeType;
 384
 385                 $attrs = array( 'src' => $url );
 386                 if ( !$wgHtml5 ) {
 387                         $attrs['type'] = $wgJsMimeType;
 388                 }
 389                 return self::element( 'script', $attrs );
 390         }
 391
 392         /**
 393          * Output a <style> tag with the given contents for the given media type
 394          * (if any).  TODO: do some useful escaping as well, like if $contents
 395          * contains literal '</style>' (admittedly unlikely).
 396          *
 397          * @param $contents string CSS
 398          * @param $media mixed A media type string, like 'screen'
 399          * @return string Raw HTML
 400          */
 401         public static function inlineStyle( $contents, $media = 'all' ) {
 402                 global $wgWellFormedXml;
 403
 404                 if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
 405                         $contents = "/*<![CDATA[*/$contents/*]]>*/";
 406                 }
 407                 return self::rawElement( 'style', array(
 408                         'type' => 'text/css',
 409                         'media' => $media,
 410                 ), $contents );
 411         }
 412
 413         /**
 414          * Output a <link rel=stylesheet> linking to the given URL for the given
 415          * media type (if any).
 416          *
 417          * @param $url string
 418          * @param $media mixed A media type string, like 'screen'
 419          * @return string Raw HTML
 420          */
 421         public static function linkedStyle( $url, $media = 'all' ) {
 422                 return self::element( 'link', array(
 423                         'rel' => 'stylesheet',
 424                         'href' => $url,
 425                         'type' => 'text/css',
 426                         'media' => $media,
 427                 ) );
 428         }
 429
 430         /**
 431          * Convenience function to produce an <input> element.  This supports the
 432          * new HTML 5 input types and attributes, and will silently strip them if
 433          * $wgHtml5 is false.
 434          *
 435          * @param $name    string name attribute
 436          * @param $value   mixed  value attribute
 437          * @param $type    string type attribute
 438          * @param $attribs array  Associative array of miscellaneous extra
 439          *   attributes, passed to Html::element()
 440          * @return string Raw HTML
 441          */
 442         public static function input( $name, $value = '', $type = 'text', $attribs = array() ) {
 443                 $attribs['type'] = $type;
 444                 $attribs['value'] = $value;
 445                 $attribs['name'] = $name;
 446
 447                 return self::element( 'input', $attribs );
 448         }
 449
 450         /**
 451          * Convenience function to produce an input element with type=hidden, like
 452          * Xml::hidden.
 453          *
 454          * @param $name    string name attribute
 455          * @param $value   string value attribute
 456          * @param $attribs array  Associative array of miscellaneous extra
 457          *   attributes, passed to Html::element()
 458          * @return string Raw HTML
 459          */
 460         public static function hidden( $name, $value, $attribs = array() ) {
 461                 return self::input( $name, $value, 'hidden', $attribs );
 462         }
 463 }