(Bug 19725) Do not include suppressed edits in the "View X deleted edits" message...
[lhc/web/wiklou.git] / includes / Html.php
index ccd1787..bf72dff 100644 (file)
@@ -1,21 +1,27 @@
 <?php
-# Copyright © 2009 Aryeh Gregor
-# http://www.mediawiki.org/
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-# http://www.gnu.org/copyleft/gpl.html
+/**
+ * Collection of methods to generate HTML content
+ *
+ * Copyright © 2009 Aryeh Gregor
+ * http://www.mediawiki.org/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * This class is a collection of static functions that serve two purposes:
@@ -61,10 +67,9 @@ class Html {
        );
 
        # Boolean attributes, which may have the value omitted entirely.  Manually
-       # collected from the HTML5 spec as of 2009-08-10.
+       # collected from the HTML5 spec as of 2010-06-07.
        private static $boolAttribs = array(
                'async',
-               'autobuffer',
                'autofocus',
                'autoplay',
                'checked',
@@ -74,10 +79,12 @@ class Html {
                'formnovalidate',
                'hidden',
                'ismap',
+               'itemscope',
                'loop',
                'multiple',
                'novalidate',
                'open',
+               'pubdate',
                'readonly',
                'required',
                'reversed',
@@ -100,8 +107,8 @@ class Html {
         * features might be added, like allowing arrays for the values of
         * attributes like class= and media=.
         *
-        * @param $element  string The element's name, e.g., 'a'
-        * @param $attribs  array  Associative array of attributes, e.g., array(
+        * @param $element string The element's name, e.g., 'a'
+        * @param $attribs array  Associative array of attributes, e.g., array(
         *   'href' => 'http://www.mediawiki.org/' ).  See expandAttributes() for
         *   further documentation.
         * @param $contents string The raw HTML contents of the element: *not*
@@ -125,6 +132,12 @@ class Html {
        /**
         * Identical to rawElement(), but HTML-escapes $contents (like
         * Xml::element()).
+        *
+        * @param $element string
+        * @param $attribs array
+        * @param $contents string
+        *
+        * @return string
         */
        public static function element( $element, $attribs = array(), $contents = '' ) {
                return self::rawElement( $element, $attribs, strtr( $contents, array(
@@ -138,6 +151,11 @@ class Html {
        /**
         * Identical to rawElement(), but has no third parameter and omits the end
         * tag (and the self-closing '/' in XML mode for empty elements).
+        *
+        * @param $element string
+        * @param $attribs array
+        *
+        * @return string
         */
        public static function openElement( $element, $attribs = array() ) {
                global $wgHtml5, $wgWellFormedXml;
@@ -154,49 +172,41 @@ class Html {
                        return '';
                }
 
-               # Remove HTML5-only attributes if we aren't doing HTML5
-               if ( !$wgHtml5 ) {
-                       if ( $element == 'input' ) {
-                               # Whitelist of valid XHTML1 types
-                               $validTypes = array(
-                                       'hidden',
-                                       'text',
-                                       'password',
-                                       'checkbox',
-                                       'radio',
-                                       'file',
-                                       'submit',
-                                       'image',
-                                       'reset',
-                                       'button',
-                               );
-                               if ( isset( $attribs['type'] )
-                               && !in_array( $attribs['type'], $validTypes ) ) {
-                                       # Fall back to type=text, the default
-                                       unset( $attribs['type'] );
-                               }
-                       }
-                       if ( $element == 'textarea' && isset( $attribs['maxlength'] ) ) {
-                               unset( $attribs['maxlength'] );
-                       }
-                       # Here we're blacklisting some HTML5-only attributes...
-                       $html5attribs = array(
-                               'autocomplete',
-                               'autofocus',
-                               'max',
-                               'min',
-                               'multiple',
-                               'pattern',
-                               'placeholder',
-                               'required',
-                               'step',
-                               'spellcheck',
+               # Remove HTML5-only attributes if we aren't doing HTML5, and disable
+               # form validation regardless (see bug 23769 and the more detailed
+               # comment in expandAttributes())
+               if ( $element == 'input' ) {
+                       # Whitelist of types that don't cause validation.  All except
+                       # 'search' are valid in XHTML1.
+                       $validTypes = array(
+                               'hidden',
+                               'text',
+                               'password',
+                               'checkbox',
+                               'radio',
+                               'file',
+                               'submit',
+                               'image',
+                               'reset',
+                               'button',
+                               'search',
                        );
-                       foreach ( $html5attribs as $badAttr ) {
-                               unset( $attribs[$badAttr] );
+
+                       if ( isset( $attribs['type'] )
+                       && !in_array( $attribs['type'], $validTypes ) ) {
+                               unset( $attribs['type'] );
+                       }
+
+                       if ( isset( $attribs['type'] ) && $attribs['type'] == 'search'
+                       && !$wgHtml5 ) {
+                               unset( $attribs['type'] );
                        }
                }
 
+               if ( !$wgHtml5 && $element == 'textarea' && isset( $attribs['maxlength'] ) ) {
+                       unset( $attribs['maxlength'] );
+               }
+
                return "<$element" . self::expandAttributes(
                        self::dropDefaults( $element, $attribs ) ) . '>';
        }
@@ -205,6 +215,7 @@ class Html {
         * Returns "</$element>", except if $wgWellFormedXml is off, in which case
         * it returns the empty string when that's guaranteed to be safe.
         *
+        * @since 1.17
         * @param $element string Name of the element, e.g., 'a'
         * @return string A closing tag, if required
         */
@@ -355,7 +366,7 @@ class Html {
                $ret = '';
                $attribs = (array)$attribs;
                foreach ( $attribs as $key => $value ) {
-                       if ( $value === false ) {
+                       if ( $value === false || is_null( $value ) ) {
                                continue;
                        }
 
@@ -380,6 +391,22 @@ class Html {
                                continue;
                        }
 
+                       # Here we're blacklisting some HTML5-only attributes...
+                       if ( !$wgHtml5 && in_array( $key, array(
+                                       'autocomplete',
+                                       'autofocus',
+                                       'max',
+                                       'min',
+                                       'multiple',
+                                       'pattern',
+                                       'placeholder',
+                                       'required',
+                                       'step',
+                                       'spellcheck',
+                       ) ) ) {
+                               continue;
+                       }
+
                        # See the "Attributes" section in the HTML syntax part of HTML5,
                        # 9.1.2.3 as of 2009-08-10.  Most attributes can have quotation
                        # marks omitted, but not all.  (Although a literal " is not
@@ -413,7 +440,8 @@ class Html {
                                # Apparently we need to entity-encode \n, \r, \t, although the
                                # spec doesn't mention that.  Since we're doing strtr() anyway,
                                # and we don't need <> escaped here, we may as well not call
-                               # htmlspecialchars().  FIXME: verify that we actually need to
+                               # htmlspecialchars().
+                               # @todo FIXME: Verify that we actually need to
                                # escape \n\r\t here, and explain why, exactly.
                                #
                                # We could call Sanitizer::encodeAttribute() for this, but we
@@ -428,8 +456,8 @@ class Html {
                                );
                                if ( $wgWellFormedXml ) {
                                        # This is allowed per spec: <http://www.w3.org/TR/xml/#NT-AttValue>
-                                       # But reportedly it breaks some XML tools?  FIXME: is this
-                                       # really true?
+                                       # But reportedly it breaks some XML tools?
+                                       # @todo FIXME: Is this really true?
                                        $map['<'] = '&lt;';
                                }
                                $ret .= " $key=$quote" . strtr( $value, $map ) . $quote;
@@ -450,12 +478,15 @@ class Html {
                global $wgHtml5, $wgJsMimeType, $wgWellFormedXml;
 
                $attrs = array();
+
                if ( !$wgHtml5 ) {
                        $attrs['type'] = $wgJsMimeType;
                }
+
                if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
                        $contents = "/*<![CDATA[*/$contents/*]]>*/";
                }
+
                return self::rawElement( 'script', $attrs, $contents );
        }
 
@@ -470,9 +501,11 @@ class Html {
                global $wgHtml5, $wgJsMimeType;
 
                $attrs = array( 'src' => $url );
+
                if ( !$wgHtml5 ) {
                        $attrs['type'] = $wgJsMimeType;
                }
+
                return self::element( 'script', $attrs );
        }
 
@@ -491,6 +524,7 @@ class Html {
                if ( $wgWellFormedXml && preg_match( '/[<&]/', $contents ) ) {
                        $contents = "/*<![CDATA[*/$contents/*]]>*/";
                }
+
                return self::rawElement( 'style', array(
                        'type' => 'text/css',
                        'media' => $media,
@@ -535,8 +569,7 @@ class Html {
        }
 
        /**
-        * Convenience function to produce an input element with type=hidden, like
-        * Xml::hidden.
+        * Convenience function to produce an input element with type=hidden
         *
         * @param $name    string name attribute
         * @param $value   string value attribute
@@ -563,13 +596,19 @@ class Html {
         */
        public static function textarea( $name, $value = '', $attribs = array() ) {
                global $wgHtml5;
+
                $attribs['name'] = $name;
+
                if ( !$wgHtml5 ) {
-                       if ( !isset( $attribs['cols'] ) )
+                       if ( !isset( $attribs['cols'] ) ) {
                                $attribs['cols'] = "";
-                       if ( !isset( $attribs['rows'] ) )
+                       }
+
+                       if ( !isset( $attribs['rows'] ) ) {
                                $attribs['rows'] = "";
+                       }
                }
+
                return self::element( 'textarea', $attribs, $value );
        }
 
@@ -584,38 +623,39 @@ class Html {
        public static function htmlHeader( $attribs = array() ) {
                $ret = '';
 
-               global $wgMimeType, $wgOutputEncoding;
+               global $wgMimeType;
+
                if ( self::isXmlMimeType( $wgMimeType ) ) {
-                       $ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?" . ">\n";
+                       $ret .= "<?xml version=\"1.0\" encoding=\"UTF-8\" ?" . ">\n";
                }
 
-               global $wgHtml5, $wgHtml5Version, $wgWellFormedXml, $wgDocType, $wgDTD;
+               global $wgHtml5, $wgHtml5Version, $wgDocType, $wgDTD;
                global $wgXhtmlNamespaces, $wgXhtmlDefaultNamespace;
+
                if ( $wgHtml5 ) {
-                       if ( $wgWellFormedXml ) {
-                               # Unknown elements and attributes are okay in XML, but unknown
-                               # named entities are well-formedness errors and will break XML
-                               # parsers.  Thus we need a doctype that gives us appropriate
-                               # entity definitions.  The HTML5 spec permits four legacy
-                               # doctypes as obsolete but conforming, so let's pick one of
-                               # those, although it makes our pages look like XHTML1 Strict.
-                               # Isn't compatibility great?
-                               $ret .= "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
-                       } else {
-                               # Much saner.
-                               $ret .= "<!doctype html>\n";
-                       }
+                       $ret .= "<!DOCTYPE html>\n";
+
                        if ( $wgHtml5Version ) {
                                $attribs['version'] = $wgHtml5Version;
                        }
                } else {
                        $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\" \"$wgDTD\">\n";
                        $attribs['xmlns'] = $wgXhtmlDefaultNamespace;
+
                        foreach ( $wgXhtmlNamespaces as $tag => $ns ) {
                                $attribs["xmlns:$tag"] = $ns;
                        }
                }
-               return $ret . Html::openElement( 'html', $attribs ) . "\n";
+
+               $html = Html::openElement( 'html', $attribs );
+
+               if ( $html ) {
+                       $html .= "\n";
+               }
+
+               $ret .= $html;
+
+               return $ret;
        }
 
        /**
@@ -626,12 +666,53 @@ class Html {
         */
        public static function isXmlMimeType( $mimetype ) {
                switch ( $mimetype ) {
-               case 'text/xml':
-               case 'application/xhtml+xml':
-               case 'application/xml':
-                       return true;
-               default:
-                       return false;
+                       case 'text/xml':
+                       case 'application/xhtml+xml':
+                       case 'application/xml':
+                               return true;
+                       default:
+                               return false;
+               }
+       }
+
+       /**
+        * Get HTML for an info box with an icon.
+        *
+        * @param $text String: wikitext, get this with wfMsgNoTrans()
+        * @param $icon String: icon name, file in skins/common/images
+        * @param $alt String: alternate text for the icon
+        * @param $class String: additional class name to add to the wrapper div
+        * @param $useStylePath
+        *
+        * @return string
+        */
+       static function infoBox( $text, $icon, $alt, $class = false, $useStylePath = true ) {
+               global $wgStylePath;
+
+               if ( $useStylePath ) {
+                       $icon = $wgStylePath.'/common/images/'.$icon;
                }
+
+               $s  = Html::openElement( 'div', array( 'class' => "mw-infobox $class") );
+
+               $s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-left' ) ).
+                               Html::element( 'img',
+                                       array(
+                                               'src' => $icon,
+                                               'alt' => $alt,
+                                       )
+                               ).
+                               Html::closeElement( 'div' );
+
+               $s .= Html::openElement( 'div', array( 'class' => 'mw-infobox-right' ) ).
+                               $text.
+                               Html::closeElement( 'div' );
+               $s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
+
+               $s .= Html::closeElement( 'div' );
+
+               $s .= Html::element( 'div', array( 'style' => 'clear: left;' ), ' ' );
+
+               return $s;
        }
 }