bug fixes:
[lhc/web/wiklou.git] / includes / Xml.php
index aeb9d5a..d72f49d 100644 (file)
@@ -19,9 +19,7 @@ class Xml {
        public static function element( $element, $attribs = null, $contents = '') {
                $out = '<' . $element;
                if( !is_null( $attribs ) ) {
-                       foreach( $attribs as $name => $val ) {
-                               $out .= ' ' . $name . '="' . Sanitizer::encodeAttribute( $val ) . '"';
-                       }
+                       $out .=  self::expandAttributes( $attribs );
                }
                if( is_null( $contents ) ) {
                        $out .= '>';
@@ -35,6 +33,26 @@ class Xml {
                return $out;
        }
 
+       /**
+        * Given an array of ('attributename' => 'value'), it generates the code
+        * to set the XML attributes : attributename="value".
+        * The values are passed to Sanitizer::encodeAttribute.
+        * Return null if no attributes given.
+        * @param $attribs Array of attributes for an XML element
+        */
+       private static function expandAttributes( $attribs ) {
+               $out = '';
+               if( is_null( $attribs ) ) {
+                       return null;
+               } elseif( is_array( $attribs ) ) {
+                       foreach( $attribs as $name => $val )
+                               $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
+                       return $out;
+               } else {
+                       throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
+               }
+       }
+
        /**
         * Format an XML element as with self::element(), but run text through the
         * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
@@ -57,8 +75,12 @@ class Xml {
                return self::element( $element, $attribs, $contents );
        }
 
-       // Shortcuts
-       public static function openElement( $element, $attribs = null ) { return self::element( $element, $attribs, null ); }
+       /** This open an XML element */
+       public static function openElement( $element, $attribs = null ) {
+               return '<' . $element . self::expandAttributes( $attribs ) . '>';
+       }
+
+       // Shortcut
        public static function closeElement( $element ) { return "</$element>"; }
 
        /**
@@ -66,48 +88,68 @@ class Xml {
         * content you have is already valid xml.
         */
        public static function tags( $element, $attribs = null, $contents ) {
-               return self::element( $element, $attribs, null ) . $contents . "</$element>";
+               return self::openElement( $element, $attribs ) . $contents . "</$element>";
        }
 
        /**
-        * Create a namespace selector
+        * Build a drop-down box for selecting a namespace
         *
-        * @param $selected Mixed: the namespace which should be selected, default ''
-        * @param $allnamespaces String: value of a special item denoting all namespaces. Null to not include (default)
-        * @param $includehidden Bool: include hidden namespaces?
-        * @return String: Html string containing the namespace selector
+        * @param mixed $selected Namespace which should be pre-selected
+        * @param mixed $all Value of an item denoting all namespaces, or null to omit
+        * @param bool $hidden Include hidden namespaces? [WTF? --RC]
+        * @return string
         */
-       public static function namespaceSelector($selected = '', $allnamespaces = null, $includehidden=false) {
+       public static function namespaceSelector( $selected = '', $all = null, $hidden = false, $element_name = 'namespace' ) {
                global $wgContLang;
-               if( $selected !== '' ) {
-                       if( is_null( $selected ) ) {
-                               // No namespace selected; let exact match work without hitting Main
-                               $selected = '';
-                       } else {
-                               // Let input be numeric strings without breaking the empty match.
-                               $selected = intval( $selected );
-                       }
+               $namespaces = $wgContLang->getFormattedNamespaces();
+               $options = array();
+
+               // Godawful hack... we'll be frequently passed selected namespaces
+               // as strings since PHP is such a shithole.
+               // But we also don't want blanks and nulls and "all"s matching 0,
+               // so let's convert *just* string ints to clean ints.
+               if( preg_match( '/^\d+$/', $selected ) ) {
+                       $selected = intval( $selected );
                }
-               $s = "\n<select id='namespace' name='namespace' class='namespaceselector'>\n";
-               $arr = $wgContLang->getFormattedNamespaces();
-               if( !is_null($allnamespaces) ) {
-                       $arr = array($allnamespaces => wfMsg('namespacesall')) + $arr;
+
+               if( !is_null( $all ) )
+                       $namespaces = array( $all => wfMsg( 'namespacesall' ) ) + $namespaces;
+               foreach( $namespaces as $index => $name ) {
+                       if( $index < NS_MAIN )
+                               continue;
+                       if( $index === 0 )
+                               $name = wfMsg( 'blanknamespace' );
+                       $options[] = self::option( $name, $index, $index === $selected );
                }
-               foreach ($arr as $index => $name) {
-                       if ($index < NS_MAIN) continue;
 
-                       $name = $index !== 0 ? $name : wfMsg('blanknamespace');
+               return Xml::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name,
+                       'class' => 'namespaceselector' ) )
+                       . "\n"
+                       . implode( "\n", $options )
+                       . "\n"
+                       . Xml::closeElement( 'select' );
+       }
 
-                       if ($index === $selected) {
-                               $s .= "\t" . self::element("option",
-                                               array("value" => $index, "selected" => "selected"),
-                                               $name) . "\n";
-                       } else {
-                               $s .= "\t" . self::element("option", array("value" => $index), $name) . "\n";
-                       }
-               }
-               $s .= "</select>\n";
-               return $s;
+       /**
+       * Create a date selector
+       *
+       * @param $selected Mixed: the month which should be selected, default ''
+       * @param $allmonths String: value of a special item denoting all month. Null to not include (default)
+       * @param string $id Element identifier
+       * @return String: Html string containing the month selector
+       */
+       public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
+               global $wgLang;
+               $options = array();
+           if( is_null( $selected ) )
+                       $selected = '';
+           if( !is_null( $allmonths ) )
+                       $options[] = self::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
+               for( $i = 1; $i < 13; $i++ )
+                               $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
+               return self::openElement( 'select', array( 'id' => $id, 'name' => 'month', 'class' => 'mw-month-selector' ) )
+                       . implode( "\n", $options )
+                       . self::closeElement( 'select' );
        }
 
        /**
@@ -153,6 +195,10 @@ class Xml {
                return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
        }
 
+       public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) {
+               return self::tags( $tag, array( 'class' => $class ) + $attribs, $text );
+       }
+
        /**
         * Convenience function to build an HTML text input field
         * @return string HTML
@@ -267,7 +313,7 @@ class Xml {
                        'type' => 'hidden',
                        'value' => $value ) + $attribs );
        }
-       
+
        /**
         * Convenience function to build an HTML drop-down list item.
         * @param $text String: text for this item
@@ -287,6 +333,63 @@ class Xml {
                return self::element( 'option', $attribs, $text );
        }
 
+       /**
+        * Build a drop-down box from a textual list.
+        *
+        * @param mixed $name Name and id for the drop-down
+        * @param mixed $class CSS classes for the drop-down
+        * @param mixed $other Text for the "Other reasons" option
+        * @param mixed $list Correctly formatted text to be used to generate the options
+        * @param mixed $selected Option which should be pre-selected
+        * @return string
+        */
+       public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = Null ) {
+               $options = '';
+               $optgroup = false;
+
+               $options = self::option( $other, 'other', $selected === 'other' );
+
+               foreach ( explode( "\n", $list ) as $option) {
+                               $value = trim( $option );
+                               if ( $value == '' ) {
+                                       continue;
+                               } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
+                                       // A new group is starting ...
+                                       $value = trim( substr( $value, 1 ) );
+                                       if( $optgroup ) $options .= self::closeElement('optgroup');
+                                       $options .= self::openElement( 'optgroup', array( 'label' => $value ) );
+                                       $optgroup = true;
+                               } elseif ( substr( $value, 0, 2) == '**' ) {
+                                       // groupmember
+                                       $value = trim( substr( $value, 2 ) );
+                                       $options .= self::option( $value, $value, $selected === $value );
+                               } else {
+                                       // groupless reason list
+                                       if( $optgroup ) $options .= self::closeElement('optgroup');
+                                       $options .= self::option( $value, $value, $selected === $value );
+                                       $optgroup = false;
+                               }
+                       }
+                       if( $optgroup ) $options .= self::closeElement('optgroup');
+
+               $attribs = array();
+               if( $name ) {
+                       $attribs['id'] = $name;
+                       $attribs['name'] = $name;
+               }
+               if( $class ) {
+                       $attribs['class'] = $class;
+               }
+               if( $tabindex ) {
+                       $attribs['tabindex'] = $tabindex;
+               }
+               return Xml::openElement( 'select', $attribs )
+                       . "\n"
+                       . $options
+                       . "\n"
+                       . Xml::closeElement( 'select' );
+       }
+
        /**
         * Returns an escaped string suitable for inclusion in a string literal
         * for JavaScript source code.
@@ -308,15 +411,24 @@ class Xml {
                        "<" => "\\x3c",
                        ">" => "\\x3e",
 
-                       # To avoid any complaints about bad entity refs                        
+                       # To avoid any complaints about bad entity refs
                        "&" => "\\x26",
+
+                       # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
+                       # Encode certain Unicode formatting chars so affected
+                       # versions of Gecko don't misinterpret our strings;
+                       # this is a common problem with Farsi text.
+                       "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
+                       "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
                );
                return strtr( $string, $pairs );
        }
 
        /**
         * Encode a variable of unknown type to JavaScript.
-        * Doesn't support hashtables just yet.
+        * Arrays are converted to JS arrays, objects are converted to JS associative
+        * arrays (objects). So cast your PHP associative arrays to objects before
+        * passing them to here.
         */
        public static function encodeJsVar( $value ) {
                if ( is_bool( $value ) ) {
@@ -327,19 +439,29 @@ class Xml {
                        $s = $value;
                } elseif ( is_array( $value ) ) {
                        $s = '[';
-                       foreach ( $value as $name => $elt ) {
+                       foreach ( $value as $elt ) {
                                if ( $s != '[' ) {
                                        $s .= ', ';
                                }
                                $s .= self::encodeJsVar( $elt );
                        }
                        $s .= ']';
+               } elseif ( is_object( $value ) ) {
+                       $s = '{';
+                       foreach ( (array)$value as $name => $elt ) {
+                               if ( $s != '{' ) {
+                                       $s .= ', ';
+                               }
+                               $s .= '"' . self::escapeJsString( $name ) . '": ' .
+                                       self::encodeJsVar( $elt );
+                       }
+                       $s .= '}';
                } else {
                        $s = '"' . self::escapeJsString( $value ) . '"';
                }
                return $s;
        }
-       
+
 
        /**
         * Check if a string is well-formed XML.
@@ -398,5 +520,33 @@ class Xml {
                        array( '&quot;', '&gt;', '&lt;' ),
                        $in );
        }
+       
+       /**
+       * Generate a form (without the opening form element).
+       * Output DOES include a submit button.
+       * @param array $fields Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
+       * @param string $submitLabel A message containing a label for the submit button.
+       * @return string HTML form.
+       */
+       public static function buildForm( $fields, $submitLabel ) {
+               $form = '';
+               $form .= "<table><tbody>";
+       
+               foreach( $fields as $labelmsg => $input ) {
+                       $id = "mw-$labelmsg";
+                       $form .= Xml::openElement( 'tr', array( 'id' => $id ) );
+       
+                       $form .= Xml::element( 'td', array('valign' => 'top'), wfMsg( $labelmsg ) );
+       
+                       $form .= Xml::openElement( 'td' ) . $input . Xml::closeElement( 'td' );
+       
+                       $form .= Xml::closeElement( 'tr' );
+               }
+       
+               $form .= "</tbody></table>";
+       
+               $form .= Xml::submitButton( wfMsg($submitLabel) );
+       
+               return $form;
+       }
 }
-?>