I hate eol w/s
[lhc/web/wiklou.git] / includes / Html.php
index bdc4c15..fb3f167 100644 (file)
@@ -97,25 +97,38 @@ class Html {
                'selected',
                'truespeed',
                'typemustmatch',
+               # HTML5 Microdata
+               'itemscope',
+       );
+
+       private static $HTMLFiveOnlyAttribs = array(
+               'autocomplete',
+               'autofocus',
+               'max',
+               'min',
+               'multiple',
+               'pattern',
+               'placeholder',
+               'required',
+               'step',
+               'spellcheck',
        );
 
        /**
         * Returns an HTML element in a string.  The major advantage here over
         * manually typing out the HTML is that it will escape all attribute
         * values.  If you're hardcoding all the attributes, or there are none, you
-        * should probably type out the string yourself.
+        * should probably just type out the html element yourself.
         *
         * This is quite similar to Xml::tags(), but it implements some useful
         * HTML-specific logic.  For instance, there is no $allowShortTag
         * parameter: the closing tag is magically omitted if $element has an empty
         * content model.  If $wgWellFormedXml is false, then a few bytes will be
-        * shaved off the HTML output as well.  In the future, other HTML-specific
-        * features might be added, like allowing arrays for the values of
-        * attributes like class= and media=.
+        * shaved off the HTML output as well.
         *
         * @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
+        *   'href' => 'http://www.mediawiki.org/' ). See expandAttributes() for
         *   further documentation.
         * @param $contents string The raw HTML contents of the element: *not*
         *   escaped!
@@ -358,6 +371,26 @@ class Html {
         * For instance, it will omit quotation marks if $wgWellFormedXml is false,
         * and will treat boolean attributes specially.
         *
+        * Attributes that should contain space-separated lists (such as 'class') array
+        * values are allowed as well, which will automagically be normalized
+        * and converted to a space-separated string. In addition to a numerical
+        * array, the attribute value may also be an associative array. See the
+        * example below for how that works.
+        * @example Numerical array
+        * <code>
+        *     Html::element( 'em', array(
+        *         'class' => array( 'foo', 'bar' )
+        *     ) );
+        *     // gives '<em class="foo bar"></em>'
+        * </code>
+        * @example Associative array
+        * <code>
+        *     Html::element( 'em', array(
+        *         'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
+        *     ) );
+        *     // gives '<em class="bar quux"></em>'
+        * </code>
+        *
         * @param $attribs array Associative array of attributes, e.g., array(
         *   'href' => 'http://www.mediawiki.org/' ).  Values will be HTML-escaped.
         *   A value of false means to omit the attribute.  For boolean attributes,
@@ -387,6 +420,12 @@ class Html {
                        # and we'd like consistency and better compression anyway.
                        $key = strtolower( $key );
 
+                       # Here we're blacklisting some HTML5-only attributes...
+                       if ( !$wgHtml5 && in_array( $key, self::$HTMLFiveOnlyAttribs )
+                        ) {
+                               continue;
+                       }
+
                        # Bug 23769: Blacklist all form validation attributes for now.  Current
                        # (June 2010) WebKit has no UI, so the form just refuses to submit
                        # without telling the user why, which is much worse than failing
@@ -397,20 +436,53 @@ 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;
+                       // http://www.w3.org/TR/html401/index/attributes.html ("space-separated")
+                       // http://www.w3.org/TR/html5/index.html#attributes-1 ("space-separated")
+                       $spaceSeparatedListAttributes = array(
+                               'class', // html4, html5
+                               'accesskey', // as of html5, multiple space-separated values allowed
+                               // html4-spec doesn't document rel= as space-separated
+                               // but has been used like that and is now documented as such 
+                               // in the html5-spec.
+                               'rel',
+                       );
+
+                       # Specific features for attributes that allow a list of space-separated values
+                       if ( in_array( $key, $spaceSeparatedListAttributes ) ) {
+                               // Apply some normalization and remove duplicates
+
+                               // Convert into correct array. Array can contain space-seperated
+                               // values. Implode/explode to get those into the main array as well.
+                               if ( is_array( $value ) ) {
+                                       // If input wasn't an array, we can skip this step
+                                       
+                                       $newValue = array();
+                                       foreach ( $value as $k => $v ) {
+                                               if ( is_string( $v ) ) {
+                                                       // String values should be normal `array( 'foo' )`
+                                                       // Just append them
+                                                       if ( !isset( $value[$v] ) ) {
+                                                               // As a special case don't set 'foo' if a
+                                                               // separate 'foo' => true/false exists in the array
+                                                               // keys should be authoritive
+                                                               $newValue[] = $v;
+                                                       }
+                                               } elseif ( $v ) {
+                                                       // If the value is truthy but not a string this is likely
+                                                       // an array( 'foo' => true ), falsy values don't add strings
+                                                       $newValue[] = $k;
+                                               }
+                                       }
+                                       $value = implode( ' ', $newValue );
+                               }
+                               $value = explode( ' ', $value );
+
+                               // Normalize spacing by fixing up cases where people used
+                               // more than 1 space and/or a trailing/leading space
+                               $value = array_diff( $value, array( '', ' ' ) );
+
+                               // Remove duplicates and create the string
+                               $value = implode( ' ', array_unique( $value ) );
                        }
 
                        # See the "Attributes" section in the HTML syntax part of HTML5,
@@ -466,6 +538,7 @@ class Html {
                                        # @todo FIXME: Is this really true?
                                        $map['<'] = '&lt;';
                                }
+                               
                                $ret .= " $key=$quote" . strtr( $value, $map ) . $quote;
                        }
                }
@@ -615,7 +688,16 @@ class Html {
                        }
                }
 
-               return self::element( 'textarea', $attribs, $value );
+               if (substr($value, 0, 1) == "\n") {
+                       // Workaround for bug 12130: browsers eat the initial newline
+                       // assuming that it's just for show, but they do keep the later
+                       // newlines, which we may want to preserve during editing.
+                       // Prepending a single newline
+                       $spacedValue = "\n" . $value;
+               } else {
+                       $spacedValue = $value;
+               }
+               return self::element( 'textarea', $attribs, $spacedValue );
        }
 
        /**