Merge "Remove equal duplicate array key and add FIXME for another one."
[lhc/web/wiklou.git] / includes / Html.php
index fcdecaa..23fead7 100644 (file)
@@ -101,11 +101,24 @@ class Html {
                '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
@@ -115,7 +128,7 @@ class Html {
         *
         * @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,28 @@ 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.
+        *
+        * @par Numerical array
+        * @code
+        *     Html::element( 'em', array(
+        *         'class' => array( 'foo', 'bar' )
+        *     ) );
+        *     // gives '<em class="foo bar"></em>'
+        * @endcode
+        *
+        * @par Associative array
+        * @code
+        *     Html::element( 'em', array(
+        *         'class' => array( 'foo', 'bar', 'foo' => false, 'quux' => true )
+        *     ) );
+        *     // gives '<em class="bar quux"></em>'
+        * @endcode
+        *
         * @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,
@@ -388,18 +423,8 @@ class Html {
                        $key = strtolower( $key );
 
                        # Here we're blacklisting some HTML5-only attributes...
-                       if ( !$wgHtml5 && in_array( $key, array(
-                                       'autocomplete',
-                                       'autofocus',
-                                       'max',
-                                       'min',
-                                       'multiple',
-                                       'pattern',
-                                       'placeholder',
-                                       'required',
-                                       'step',
-                                       'spellcheck',
-                       ) ) ) {
+                       if ( !$wgHtml5 && in_array( $key, self::$HTMLFiveOnlyAttribs )
+                        ) {
                                continue;
                        }
 
@@ -432,13 +457,31 @@ class Html {
                                // 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
-                                       $value = implode( ' ', $value );
+                                       
+                                       $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( '', ' ') );
+                               $value = array_diff( $value, array( '', ' ' ) );
 
                                // Remove duplicates and create the string
                                $value = implode( ' ', array_unique( $value ) );
@@ -497,6 +540,7 @@ class Html {
                                        # @todo FIXME: Is this really true?
                                        $map['<'] = '&lt;';
                                }
+                               
                                $ret .= " $key=$quote" . strtr( $value, $map ) . $quote;
                        }
                }
@@ -504,9 +548,10 @@ class Html {
        }
 
        /**
-        * Output a <script> tag with the given contents.  TODO: do some useful
-        * escaping as well, like if $contents contains literal '</script>' or (for
-        * XML) literal "]]>".
+        * Output a "<script>" tag with the given contents.
+        *
+        * @todo do some useful escaping as well, like if $contents contains
+        * literal "</script>" or (for XML) literal "]]>".
         *
         * @param $contents string JavaScript
         * @return string Raw HTML
@@ -528,8 +573,8 @@ class Html {
        }
 
        /**
-        * Output a <script> tag linking to the given URL, e.g.,
-        * <script src=foo.js></script>.
+        * Output a "<script>" tag linking to the given URL, e.g.,
+        * "<script src=foo.js></script>".
         *
         * @param $url string
         * @return string Raw HTML
@@ -547,9 +592,9 @@ class Html {
        }
 
        /**
-        * Output a <style> tag with the given contents for the given media type
+        * Output a "<style>" tag with the given contents for the given media type
         * (if any).  TODO: do some useful escaping as well, like if $contents
-        * contains literal '</style>' (admittedly unlikely).
+        * contains literal "</style>" (admittedly unlikely).
         *
         * @param $contents string CSS
         * @param $media mixed A media type string, like 'screen'
@@ -569,7 +614,7 @@ class Html {
        }
 
        /**
-        * Output a <link rel=stylesheet> linking to the given URL for the given
+        * Output a "<link rel=stylesheet>" linking to the given URL for the given
         * media type (if any).
         *
         * @param $url string
@@ -586,7 +631,7 @@ class Html {
        }
 
        /**
-        * Convenience function to produce an <input> element.  This supports the
+        * Convenience function to produce an "<input>" element.  This supports the
         * new HTML5 input types and attributes, and will silently strip them if
         * $wgHtml5 is false.
         *
@@ -619,11 +664,12 @@ class Html {
        }
 
        /**
-        * Convenience function to produce an <input> element.  This supports leaving
-        * out the cols= and rows= which Xml requires and are required by HTML4/XHTML
-        * but not required by HTML5 and will silently set cols="" and rows="" if
-        * $wgHtml5 is false and cols and rows are omitted (HTML4 validates present
-        * but empty cols="" and rows="" as valid).
+        * Convenience function to produce an "<input>" element.
+        *
+        * This supports leaving out the cols= and rows= which Xml requires and are
+        * required by HTML4/XHTML but not required by HTML5 and will silently set
+        * cols="" and rows="" if $wgHtml5 is false and cols and rows are omitted
+        * (HTML4 validates present but empty cols="" and rows="" as valid).
         *
         * @param $name    string name attribute
         * @param $value   string value attribute
@@ -646,7 +692,105 @@ 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 );
+       }
+       /**
+        * Build a drop-down box for selecting a namespace
+        *
+        * @param $params array:
+        * - selected: [optional] Id of namespace which should be pre-selected
+        * - all: [optional] Value of item for "all namespaces". If null or unset, no "<option>" is generated to select all namespaces
+        * - label: text for label to add before the field
+        * - exclude: [optional] Array of namespace ids to exclude
+        * - disable: [optional] Array of namespace ids for which the option should be disabled in the selector
+        * @param $selectAttribs array HTML attributes for the generated select element.
+        * - id:   [optional], default: 'namespace'
+        * - name: [optional], default: 'namespace'
+        * @return string HTML code to select a namespace.
+        */
+       public static function namespaceSelector( Array $params = array(), Array $selectAttribs = array() ) {
+               global $wgContLang;
+
+               ksort( $selectAttribs );
+
+               // Is a namespace selected?
+               if ( isset( $params['selected'] ) ) {
+                       // If string only contains digits, convert to clean int. Selected could also
+                       // be "all" or "" etc. which needs to be left untouched.
+                       // PHP is_numeric() has issues with large strings, PHP ctype_digit has other issues
+                       // and returns false for already clean ints. Use regex instead..
+                       if ( preg_match( '/^\d+$/', $params['selected'] ) ) {
+                               $params['selected'] = intval( $params['selected'] );
+                       }
+                       // else: leaves it untouched for later processing
+               } else {
+                       $params['selected'] = '';
+               }
+
+               if ( !isset( $params['exclude'] ) || !is_array( $params['exclude'] ) ) {
+                       $params['exclude'] = array();
+               }
+               if ( !isset( $params['disable'] ) || !is_array( $params['disable'] ) ) {
+                       $params['disable'] = array();
+               }
+
+               // Associative array between option-values and option-labels
+               $options = array();
+
+               if ( isset( $params['all'] ) ) {
+                       // add an option that would let the user select all namespaces.
+                       // Value is provided by user, the name shown is localized for the user.
+                       $options[$params['all']] = wfMessage( 'namespacesall' )->text();
+               }
+               // Add all namespaces as options (in the content langauge)
+               $options += $wgContLang->getFormattedNamespaces();
+
+               // Convert $options to HTML and filter out namespaces below 0
+               $optionsHtml = array();
+               foreach ( $options as $nsId => $nsName ) {
+                       if ( $nsId < NS_MAIN || in_array( $nsId, $params['exclude'] ) ) {
+                               continue;
+                       }
+                       if ( $nsId === 0 ) {
+                               // For other namespaces use use the namespace prefix as label, but for
+                               // main we don't use "" but the user message descripting it (e.g. "(Main)" or "(Article)")
+                               $nsName = wfMessage( 'blanknamespace' )->text();
+                       }
+                       $optionsHtml[] = Html::element(
+                               'option', array(
+                                       'disabled' => in_array( $nsId, $params['disable'] ),
+                                       'value' => $nsId,
+                                       'selected' => $nsId === $params['selected'],
+                               ), $nsName
+                       );
+               }
+
+               $ret = '';
+               if ( isset( $params['label'] ) ) {
+                       $ret .= Html::element(
+                               'label', array(
+                                       'for' => isset( $selectAttribs['id'] ) ? $selectAttribs['id'] : null,
+                               ), $params['label']
+                       ) . '&#160;';
+               }
+
+               // Wrap options in a <select>
+               $ret .= Html::openElement( 'select', $selectAttribs )
+                       . "\n"
+                       . implode( "\n", $optionsHtml )
+                       . "\n"
+                       . Html::closeElement( 'select' );
+
+               return $ret;
        }
 
        /**
@@ -715,7 +859,7 @@ class Html {
        /**
         * Get HTML for an info box with an icon.
         *
-        * @param $text String: wikitext, get this with wfMsgNoTrans()
+        * @param $text String: wikitext, get this with wfMessage()->plain()
         * @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