includes/Xml.php

   1 <?php
   2
   3 /**
   4  * Module of static functions for generating XML
   5  */
   6
   7 class Xml {
   8         /**
   9          * Format an XML element with given attributes and, optionally, text content.
  10          * Element and attribute names are assumed to be ready for literal inclusion.
  11          * Strings are assumed to not contain XML-illegal characters; special
  12          * characters (<, >, &) are escaped but illegals are not touched.
  13          *
  14          * @param $element String: element name
  15          * @param $attribs Array: Name=>value pairs. Values will be escaped.
  16          * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
  17          * @param $allowShortTag Bool: whether '' in $contents will result in a contentless closed tag
  18          * @return string
  19          */
  20         public static function element( $element, $attribs = null, $contents = '', $allowShortTag = true ) {
  21                 $out = '<' . $element;
  22                 if( !is_null( $attribs ) ) {
  23                         $out .=  self::expandAttributes( $attribs );
  24                 }
  25                 if( is_null( $contents ) ) {
  26                         $out .= '>';
  27                 } else {
  28                         if( $allowShortTag && $contents === '' ) {
  29                                 $out .= ' />';
  30                         } else {
  31                                 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
  32                         }
  33                 }
  34                 return $out;
  35         }
  36
  37         /**
  38          * Given an array of ('attributename' => 'value'), it generates the code
  39          * to set the XML attributes : attributename="value".
  40          * The values are passed to Sanitizer::encodeAttribute.
  41          * Return null if no attributes given.
  42          * @param $attribs Array of attributes for an XML element
  43          */
  44         public static function expandAttributes( $attribs ) {
  45                 $out = '';
  46                 if( is_null( $attribs ) ) {
  47                         return null;
  48                 } elseif( is_array( $attribs ) ) {
  49                         foreach( $attribs as $name => $val )
  50                                 $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
  51                         return $out;
  52                 } else {
  53                         throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
  54                 }
  55         }
  56
  57         /**
  58          * Format an XML element as with self::element(), but run text through the
  59          * UtfNormal::cleanUp() validator first to ensure that no invalid UTF-8
  60          * is passed.
  61          *
  62          * @param $element String:
  63          * @param $attribs Array: Name=>value pairs. Values will be escaped.
  64          * @param $contents String: NULL to make an open tag only; '' for a contentless closed tag (default)
  65          * @return string
  66          */
  67         public static function elementClean( $element, $attribs = array(), $contents = '') {
  68                 if( $attribs ) {
  69                         $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
  70                 }
  71                 if( $contents ) {
  72                         wfProfileIn( __METHOD__ . '-norm' );
  73                         $contents = UtfNormal::cleanUp( $contents );
  74                         wfProfileOut( __METHOD__ . '-norm' );
  75                 }
  76                 return self::element( $element, $attribs, $contents );
  77         }
  78
  79         /**
  80          * This opens an XML element
  81          *
  82          * @param $element name of the element
  83          * @param $attribs array of attributes, see Xml::expandAttributes()
  84          * @return string
  85          */
  86         public static function openElement( $element, $attribs = null ) {
  87                 return '<' . $element . self::expandAttributes( $attribs ) . '>';
  88         }
  89
  90         /**
  91          * Shortcut to close an XML element
  92          * @param $element element name
  93          * @return string
  94          */
  95         public static function closeElement( $element ) { return "</$element>"; }
  96
  97         /**
  98          * Same as Xml::element(), but does not escape contents. Handy when the
  99          * content you have is already valid xml.
 100          *
 101          * @param $element element name
 102          * @param $attribs array of attributes
 103          * @param $contents content of the element
 104          * @return string
 105          */
 106         public static function tags( $element, $attribs = null, $contents ) {
 107                 return self::openElement( $element, $attribs ) . $contents . "</$element>";
 108         }
 109
 110         /**
 111          * Build a drop-down box for selecting a namespace
 112          *
 113          * @param $selected Mixed: Namespace which should be pre-selected
 114          * @param $all Mixed: Value of an item denoting all namespaces, or null to omit
 115          * @param $element_name String: value of the "name" attribute of the select tag
 116          * @param $label String: optional label to add to the field
 117          * @return string
 118          */
 119         public static function namespaceSelector( $selected = '', $all = null, $element_name = 'namespace', $label = null ) {
 120                 global $wgContLang;
 121                 $namespaces = $wgContLang->getFormattedNamespaces();
 122                 $options = array();
 123
 124                 // Godawful hack... we'll be frequently passed selected namespaces
 125                 // as strings since PHP is such a shithole.
 126                 // But we also don't want blanks and nulls and "all"s matching 0,
 127                 // so let's convert *just* string ints to clean ints.
 128                 if( preg_match( '/^\d+$/', $selected ) ) {
 129                         $selected = intval( $selected );
 130                 }
 131
 132                 if( !is_null( $all ) )
 133                         $namespaces = array( $all => wfMsg( 'namespacesall' ) ) + $namespaces;
 134                 foreach( $namespaces as $index => $name ) {
 135                         if( $index < NS_MAIN )
 136                                 continue;
 137                         if( $index === 0 )
 138                                 $name = wfMsg( 'blanknamespace' );
 139                         $options[] = self::option( $name, $index, $index === $selected );
 140                 }
 141
 142                 $ret = Xml::openElement( 'select', array( 'id' => 'namespace', 'name' => $element_name,
 143                         'class' => 'namespaceselector' ) )
 144                         . "\n"
 145                         . implode( "\n", $options )
 146                         . "\n"
 147                         . Xml::closeElement( 'select' );
 148                 if ( !is_null( $label ) ) {
 149                         $ret = Xml::label( $label, $element_name ) . '&nbsp;' . $ret;
 150                 }
 151                 return $ret;
 152         }
 153
 154         /**
 155          * Create a date selector
 156          *
 157          * @param $selected Mixed: the month which should be selected, default ''
 158          * @param $allmonths String: value of a special item denoting all month. Null to not include (default)
 159          * @param $id String: Element identifier
 160          * @return String: Html string containing the month selector
 161          */
 162         public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
 163                 global $wgLang;
 164                 $options = array();
 165             if( is_null( $selected ) )
 166                         $selected = '';
 167             if( !is_null( $allmonths ) )
 168                         $options[] = self::option( wfMsg( 'monthsall' ), $allmonths, $selected === $allmonths );
 169                 for( $i = 1; $i < 13; $i++ )
 170                                 $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
 171                 return self::openElement( 'select', array( 'id' => $id, 'name' => 'month', 'class' => 'mw-month-selector' ) )
 172                         . implode( "\n", $options )
 173                         . self::closeElement( 'select' );
 174         }
 175
 176         /**
 177          * @param $year Integer
 178          * @param $month Integer
 179          * @return string Formatted HTML
 180          */
 181         public static function dateMenu( $year, $month ) {
 182                 # Offset overrides year/month selection
 183                 if( $month && $month !== -1 ) {
 184                         $encMonth = intval( $month );
 185                 } else {
 186                         $encMonth = '';
 187                 }
 188                 if( $year ) {
 189                         $encYear = intval( $year );
 190                 } else if( $encMonth ) {
 191                         $thisMonth = intval( gmdate( 'n' ) );
 192                         $thisYear = intval( gmdate( 'Y' ) );
 193                         if( intval($encMonth) > $thisMonth ) {
 194                                 $thisYear--;
 195                         }
 196                         $encYear = $thisYear;
 197                 } else {
 198                         $encYear = '';
 199                 }
 200                 return Xml::label( wfMsg( 'year' ), 'year' ) . ' '.
 201                         Xml::input( 'year', 4, $encYear, array('id' => 'year', 'maxlength' => 4) ) . ' '.
 202                         Xml::label( wfMsg( 'month' ), 'month' ) . ' '.
 203                         Xml::monthSelector( $encMonth, -1 );
 204         }
 205
 206         /**
 207          *
 208          * @param $selected The language code of the selected language
 209          * @param $customisedOnly If true only languages which have some content are listed
 210          * @return array of label and select
 211          */
 212         public static function languageSelector( $selected, $customisedOnly = true ) {
 213                 global $wgContLanguageCode;
 214                 /**
 215                  * Make sure the site language is in the list; a custom language code
 216                  * might not have a defined name...
 217                  */
 218                 $languages = Language::getLanguageNames( $customisedOnly );
 219                 if( !array_key_exists( $wgContLanguageCode, $languages ) ) {
 220                         $languages[$wgContLanguageCode] = $wgContLanguageCode;
 221                 }
 222                 ksort( $languages );
 223
 224                 /**
 225                  * If a bogus value is set, default to the content language.
 226                  * Otherwise, no default is selected and the user ends up
 227                  * with an Afrikaans interface since it's first in the list.
 228                  */
 229                 $selected = isset( $languages[$selected] ) ? $selected : $wgContLanguageCode;
 230                 $options = "\n";
 231                 foreach( $languages as $code => $name ) {
 232                         $options .= Xml::option( "$code - $name", $code, ($code == $selected) ) . "\n";
 233                 }
 234
 235                 return array(
 236                         Xml::label( wfMsg('yourlanguage'), 'wpUserLanguage' ),
 237                         Xml::tags( 'select',
 238                                 array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' ),
 239                                 $options
 240                         )
 241                 );
 242
 243         }
 244
 245         /**
 246          * Shortcut to make a span element
 247          * @param $text content of the element, will be escaped
 248          * @param $class class name of the span element
 249          * @param $attribs other attributes
 250          * @return string
 251          */
 252         public static function span( $text, $class, $attribs=array() ) {
 253                 return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
 254         }
 255
 256         /**
 257          * Shortcut to make a specific element with a class attribute
 258          * @param $text content of the element, will be escaped
 259          * @param $class class name of the span element
 260          * @param $tag element name
 261          * @param $attribs other attributes
 262          * @return string
 263          */
 264         public static function wrapClass( $text, $class, $tag='span', $attribs=array() ) {
 265                 return self::tags( $tag, array( 'class' => $class ) + $attribs, $text );
 266         }
 267
 268         /**
 269          * Convenience function to build an HTML text input field
 270          * @param $name value of the name attribute
 271          * @param $size value of the size attribute
 272          * @param $value value of the value attribute
 273          * @param $attribs other attributes
 274          * @return string HTML
 275          */
 276         public static function input( $name, $size=false, $value=false, $attribs=array() ) {
 277                 return self::element( 'input', array(
 278                         'name' => $name,
 279                         'size' => $size,
 280                         'value' => $value ) + $attribs );
 281         }
 282
 283         /**
 284          * Convenience function to build an HTML password input field
 285          * @param $name value of the name attribute
 286          * @param $size value of the size attribute
 287          * @param $value value of the value attribute
 288          * @param $attribs other attributes
 289          * @return string HTML
 290          */
 291         public static function password( $name, $size=false, $value=false, $attribs=array() ) {
 292                 return self::input( $name, $size, $value, array_merge($attribs, array('type' => 'password')));
 293         }
 294
 295         /**
 296          * Internal function for use in checkboxes and radio buttons and such.
 297          * @return array
 298          */
 299         public static function attrib( $name, $present = true ) {
 300                 return $present ? array( $name => $name ) : array();
 301         }
 302
 303         /**
 304          * Convenience function to build an HTML checkbox
 305          * @param $name value of the name attribute
 306          * @param $checked Whether the checkbox is checked or not
 307          * @param $attribs other attributes
 308          * @return string HTML
 309          */
 310         public static function check( $name, $checked=false, $attribs=array() ) {
 311                 return self::element( 'input', array_merge(
 312                         array(
 313                                 'name' => $name,
 314                                 'type' => 'checkbox',
 315                                 'value' => 1 ),
 316                         self::attrib( 'checked', $checked ),
 317                         $attribs ) );
 318         }
 319
 320         /**
 321          * Convenience function to build an HTML radio button
 322          * @param $name value of the name attribute
 323          * @param $value value of the value attribute
 324          * @param $checked Whether the checkbox is checked or not
 325          * @param $attribs other attributes
 326          * @return string HTML
 327          */
 328         public static function radio( $name, $value, $checked=false, $attribs=array() ) {
 329                 return self::element( 'input', array(
 330                         'name' => $name,
 331                         'type' => 'radio',
 332                         'value' => $value ) + self::attrib( 'checked', $checked ) + $attribs );
 333         }
 334
 335         /**
 336          * Convenience function to build an HTML form label
 337          * @param $label text of the label
 338          * @param $id
 339          * @return string HTML
 340          */
 341         public static function label( $label, $id ) {
 342                 return self::element( 'label', array( 'for' => $id ), $label );
 343         }
 344
 345         /**
 346          * Convenience function to build an HTML text input field with a label
 347          * @param $label text of the label
 348          * @param $name value of the name attribute
 349          * @param $id id of the input
 350          * @param $size value of the size attribute
 351          * @param $value value of the value attribute
 352          * @param $attribs other attributes
 353          * @return string HTML
 354          */
 355         public static function inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
 356                 list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
 357                 return $label . '&nbsp;' . $input;
 358         }
 359
 360         /**
 361          * Same as Xml::inputLabel() but return input and label in an array
 362          */
 363         public static function inputLabelSep( $label, $name, $id, $size=false, $value=false, $attribs=array() ) {
 364                 return array(
 365                         Xml::label( $label, $id ),
 366                         self::input( $name, $size, $value, array( 'id' => $id ) + $attribs )
 367                 );
 368         }
 369
 370         /**
 371          * Convenience function to build an HTML checkbox with a label
 372          * @return string HTML
 373          */
 374         public static function checkLabel( $label, $name, $id, $checked=false, $attribs=array() ) {
 375                 return self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
 376                         '&nbsp;' .
 377                         self::label( $label, $id );
 378         }
 379
 380         /**
 381          * Convenience function to build an HTML radio button with a label
 382          * @return string HTML
 383          */
 384         public static function radioLabel( $label, $name, $value, $id, $checked=false, $attribs=array() ) {
 385                 return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
 386                         '&nbsp;' .
 387                         self::label( $label, $id );
 388         }
 389
 390         /**
 391          * Convenience function to build an HTML submit button
 392          * @param $value String: label text for the button
 393          * @param $attribs Array: optional custom attributes
 394          * @return string HTML
 395          */
 396         public static function submitButton( $value, $attribs=array() ) {
 397                 return self::element( 'input', array( 'type' => 'submit', 'value' => $value ) + $attribs );
 398         }
 399
 400         /**
 401          * Convenience function to build an HTML hidden form field.
 402          * @param $name String: name attribute for the field
 403          * @param $value String: value for the hidden field
 404          * @param $attribs Array: optional custom attributes
 405          * @return string HTML
 406          */
 407         public static function hidden( $name, $value, $attribs=array() ) {
 408                 return self::element( 'input', array(
 409                         'name' => $name,
 410                         'type' => 'hidden',
 411                         'value' => $value ) + $attribs );
 412         }
 413
 414         /**
 415          * Convenience function to build an HTML drop-down list item.
 416          * @param $text String: text for this item
 417          * @param $value String: form submission value; if empty, use text
 418          * @param $selected boolean: if true, will be the default selected item
 419          * @param $attribs array: optional additional HTML attributes
 420          * @return string HTML
 421          */
 422         public static function option( $text, $value=null, $selected=false,
 423                         $attribs=array() ) {
 424                 if( !is_null( $value ) ) {
 425                         $attribs['value'] = $value;
 426                 }
 427                 if( $selected ) {
 428                         $attribs['selected'] = 'selected';
 429                 }
 430                 return self::element( 'option', $attribs, $text );
 431         }
 432
 433         /**
 434          * Build a drop-down box from a textual list.
 435          *
 436          * @param $name Mixed: Name and id for the drop-down
 437          * @param $class Mixed: CSS classes for the drop-down
 438          * @param $other Mixed: Text for the "Other reasons" option
 439          * @param $list Mixed: Correctly formatted text to be used to generate the options
 440          * @param $selected Mixed: Option which should be pre-selected
 441          * @param $tabindex Mixed: Value of the tabindex attribute
 442          * @return string
 443          */
 444         public static function listDropDown( $name= '', $list = '', $other = '', $selected = '', $class = '', $tabindex = Null ) {
 445                 $options = '';
 446                 $optgroup = false;
 447
 448                 $options = self::option( $other, 'other', $selected === 'other' );
 449
 450                 foreach ( explode( "\n", $list ) as $option) {
 451                                 $value = trim( $option );
 452                                 if ( $value == '' ) {
 453                                         continue;
 454                                 } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
 455                                         // A new group is starting ...
 456                                         $value = trim( substr( $value, 1 ) );
 457                                         if( $optgroup ) $options .= self::closeElement('optgroup');
 458                                         $options .= self::openElement( 'optgroup', array( 'label' => $value ) );
 459                                         $optgroup = true;
 460                                 } elseif ( substr( $value, 0, 2) == '**' ) {
 461                                         // groupmember
 462                                         $value = trim( substr( $value, 2 ) );
 463                                         $options .= self::option( $value, $value, $selected === $value );
 464                                 } else {
 465                                         // groupless reason list
 466                                         if( $optgroup ) $options .= self::closeElement('optgroup');
 467                                         $options .= self::option( $value, $value, $selected === $value );
 468                                         $optgroup = false;
 469                                 }
 470                         }
 471                         if( $optgroup ) $options .= self::closeElement('optgroup');
 472
 473                 $attribs = array();
 474                 if( $name ) {
 475                         $attribs['id'] = $name;
 476                         $attribs['name'] = $name;
 477                 }
 478                 if( $class ) {
 479                         $attribs['class'] = $class;
 480                 }
 481                 if( $tabindex ) {
 482                         $attribs['tabindex'] = $tabindex;
 483                 }
 484                 return Xml::openElement( 'select', $attribs )
 485                         . "\n"
 486                         . $options
 487                         . "\n"
 488                         . Xml::closeElement( 'select' );
 489         }
 490
 491         /**
 492          * Shortcut for creating fieldsets.
 493          *
 494          * @param $legend Legend of the fieldset. If evaluates to false, legend is not added.
 495          * @param $content Pre-escaped content for the fieldset. If false, only open fieldset is returned.
 496          * @param $attribs Any attributes to fieldset-element.
 497          */
 498         public static function fieldset( $legend = false, $content = false, $attribs = array() ) {
 499                 $s = Xml::openElement( 'fieldset', $attribs ) . "\n";
 500                 if ( $legend ) {
 501                         $s .= Xml::element( 'legend', null, $legend ) . "\n";
 502                 }
 503                 if ( $content !== false ) {
 504                         $s .= $content . "\n";
 505                         $s .= Xml::closeElement( 'fieldset' ) . "\n";
 506                 }
 507
 508                 return $s;
 509         }
 510
 511         /**
 512          * Shortcut for creating textareas.
 513          *
 514          * @param $name The 'name' for the textarea
 515          * @param $content Content for the textarea
 516          * @param $cols The number of columns for the textarea
 517          * @param $rows The number of rows for the textarea
 518          * @param $attribs Any other attributes for the textarea
 519          */
 520         public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) {
 521                 return self::element( 'textarea',
 522                                         array(  'name' => $name,
 523                                                 'id' => $name,
 524                                                 'cols' => $cols,
 525                                                 'rows' => $rows
 526                                         ) + $attribs,
 527                                         $content, false );
 528         }
 529
 530         /**
 531          * Returns an escaped string suitable for inclusion in a string literal
 532          * for JavaScript source code.
 533          * Illegal control characters are assumed not to be present.
 534          *
 535          * @param $string String to escape
 536          * @return String
 537          */
 538         public static function escapeJsString( $string ) {
 539                 // See ECMA 262 section 7.8.4 for string literal format
 540                 $pairs = array(
 541                         "\\" => "\\\\",
 542                         "\"" => "\\\"",
 543                         '\'' => '\\\'',
 544                         "\n" => "\\n",
 545                         "\r" => "\\r",
 546
 547                         # To avoid closing the element or CDATA section
 548                         "<" => "\\x3c",
 549                         ">" => "\\x3e",
 550
 551                         # To avoid any complaints about bad entity refs
 552                         "&" => "\\x26",
 553
 554                         # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
 555                         # Encode certain Unicode formatting chars so affected
 556                         # versions of Gecko don't misinterpret our strings;
 557                         # this is a common problem with Farsi text.
 558                         "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
 559                         "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
 560                 );
 561                 return strtr( $string, $pairs );
 562         }
 563
 564         /**
 565          * Encode a variable of unknown type to JavaScript.
 566          * Arrays are converted to JS arrays, objects are converted to JS associative
 567          * arrays (objects). So cast your PHP associative arrays to objects before
 568          * passing them to here.
 569          */
 570         public static function encodeJsVar( $value ) {
 571                 if ( is_bool( $value ) ) {
 572                         $s = $value ? 'true' : 'false';
 573                 } elseif ( is_null( $value ) ) {
 574                         $s = 'null';
 575                 } elseif ( is_int( $value ) ) {
 576                         $s = $value;
 577                 } elseif ( is_array( $value ) ) {
 578                         $s = '[';
 579                         foreach ( $value as $elt ) {
 580                                 if ( $s != '[' ) {
 581                                         $s .= ', ';
 582                                 }
 583                                 $s .= self::encodeJsVar( $elt );
 584                         }
 585                         $s .= ']';
 586                 } elseif ( is_object( $value ) ) {
 587                         $s = '{';
 588                         foreach ( (array)$value as $name => $elt ) {
 589                                 if ( $s != '{' ) {
 590                                         $s .= ', ';
 591                                 }
 592                                 $s .= '"' . self::escapeJsString( $name ) . '": ' .
 593                                         self::encodeJsVar( $elt );
 594                         }
 595                         $s .= '}';
 596                 } else {
 597                         $s = '"' . self::escapeJsString( $value ) . '"';
 598                 }
 599                 return $s;
 600         }
 601
 602
 603         /**
 604          * Check if a string is well-formed XML.
 605          * Must include the surrounding tag.
 606          *
 607          * @param $text String: string to test.
 608          * @return bool
 609          *
 610          * @todo Error position reporting return
 611          */
 612         public static function isWellFormed( $text ) {
 613                 $parser = xml_parser_create( "UTF-8" );
 614
 615                 # case folding violates XML standard, turn it off
 616                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
 617
 618                 if( !xml_parse( $parser, $text, true ) ) {
 619                         //$err = xml_error_string( xml_get_error_code( $parser ) );
 620                         //$position = xml_get_current_byte_index( $parser );
 621                         //$fragment = $this->extractFragment( $html, $position );
 622                         //$this->mXmlError = "$err at byte $position:\n$fragment";
 623                         xml_parser_free( $parser );
 624                         return false;
 625                 }
 626                 xml_parser_free( $parser );
 627                 return true;
 628         }
 629
 630         /**
 631          * Check if a string is a well-formed XML fragment.
 632          * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
 633          * and can use HTML named entities.
 634          *
 635          * @param $text String:
 636          * @return bool
 637          */
 638         public static function isWellFormedXmlFragment( $text ) {
 639                 $html =
 640                         Sanitizer::hackDocType() .
 641                         '<html>' .
 642                         $text .
 643                         '</html>';
 644                 return Xml::isWellFormed( $html );
 645         }
 646
 647         /**
 648          * Replace " > and < with their respective HTML entities ( &quot;,
 649          * &gt;, &lt;)
 650          *
 651          * @param $in String: text that might contain HTML tags.
 652          * @return string Escaped string
 653          */
 654         public static function escapeTagsOnly( $in ) {
 655                 return str_replace(
 656                         array( '"', '>', '<' ),
 657                         array( '&quot;', '&gt;', '&lt;' ),
 658                         $in );
 659         }
 660
 661         /**
 662         * Generate a form (without the opening form element).
 663         * Output optionally includes a submit button.
 664         * @param $fields Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
 665         * @param $submitLabel A message containing a label for the submit button.
 666         * @return string HTML form.
 667         */
 668         public static function buildForm( $fields, $submitLabel = null ) {
 669                 $form = '';
 670                 $form .= "<table><tbody>";
 671
 672                 foreach( $fields as $labelmsg => $input ) {
 673                         $id = "mw-$labelmsg";
 674                         $form .= Xml::openElement( 'tr', array( 'id' => $id ) );
 675                         $form .= Xml::tags( 'td', array('class' => 'mw-label'), wfMsgExt( $labelmsg, array('parseinline') ) );
 676                         $form .= Xml::openElement( 'td', array( 'class' => 'mw-input' ) ) . $input . Xml::closeElement( 'td' );
 677                         $form .= Xml::closeElement( 'tr' );
 678                 }
 679
 680                 if( $submitLabel ) {
 681                         $form .= Xml::openElement( 'tr' );
 682                         $form .= Xml::tags( 'td', array(), '' );
 683                         $form .= Xml::openElement( 'td', array( 'class' => 'mw-submit' ) ) . Xml::submitButton( wfMsg( $submitLabel ) ) . Xml::closeElement( 'td' );
 684                         $form .= Xml::closeElement( 'tr' );
 685                 }
 686
 687                 $form .= "</tbody></table>";
 688
 689
 690                 return $form;
 691         }
 692
 693         /**
 694          * Build a table of data
 695          * @param $rows An array of arrays of strings, each to be a row in a table
 696          * @param $attribs An array of attributes to apply to the table tag [optional]
 697          * @param $headers An array of strings to use as table headers [optional]
 698          * @return string
 699          */
 700         public static function buildTable( $rows, $attribs = array(), $headers = null ) {
 701                 $s = Xml::openElement( 'table', $attribs );
 702                 if ( is_array( $headers ) ) {
 703                         foreach( $headers as $id => $header ) {
 704                                 $attribs = array();
 705                                 if ( is_string( $id ) ) $attribs['id'] = $id;
 706                                 $s .= Xml::element( 'th', $attribs, $header );
 707                         }
 708                 }
 709                 foreach( $rows as $id => $row ) {
 710                         $attribs = array();
 711                         if ( is_string( $id ) ) $attribs['id'] = $id;
 712                         $s .= Xml::buildTableRow( $attribs, $row );
 713                 }
 714                 $s .= Xml::closeElement( 'table' );
 715                 return $s;
 716         }
 717
 718         /**
 719          * Build a row for a table
 720          * @param $cells An array of strings to put in <td>
 721          * @return string
 722          */
 723         public static function buildTableRow( $attribs, $cells ) {
 724                 $s = Xml::openElement( 'tr', $attribs );
 725                 foreach( $cells as $id => $cell ) {
 726                         $attribs = array();
 727                         if ( is_string( $id ) ) $attribs['id'] = $id;
 728                         $s .= Xml::element( 'td', $attribs, $cell );
 729                 }
 730                 $s .= Xml::closeElement( 'tr' );
 731                 return $s;
 732         }
 733 }
 734
 735 class XmlSelect {
 736         protected $options = array();
 737         protected $default = false;
 738         protected $attributes = array();
 739
 740         public function __construct( $name = false, $id = false, $default = false ) {
 741                 if ( $name ) $this->setAttribute( 'name', $name );
 742                 if ( $id ) $this->setAttribute( 'id', $id );
 743                 if ( $default ) $this->default = $default;
 744         }
 745
 746         public function setDefault( $default ) {
 747                 $this->default = $default;
 748         }
 749
 750         public function setAttribute( $name, $value ) {
 751                 $this->attributes[$name] = $value;
 752         }
 753
 754         public function getAttribute( $name ) {
 755                 if ( isset($this->attributes[$name]) ) {
 756                         return $this->attributes[$name];
 757                 } else {
 758                         return null;
 759                 }
 760         }
 761
 762         public function addOption( $name, $value = false ) {
 763                 // Stab stab stab
 764                 $value = ($value !== false) ? $value : $name;
 765                 $this->options[] = Xml::option( $name, $value, $value === $this->default );
 766         }
 767
 768         // This accepts an array of form
 769         // label => value
 770         // label => ( label => value, label => value )
 771         public function addOptions( $options ) {
 772                 $this->options[] = trim(self::formatOptions( $options, $this->default ));
 773         }
 774
 775         // This accepts an array of form
 776         // label => value
 777         // label => ( label => value, label => value )
 778         static function formatOptions( $options, $default = false ) {
 779                 $data = '';
 780                 foreach( $options as $label => $value ) {
 781                         if ( is_array( $value ) ) {
 782                                 $contents = self::formatOptions( $value, $default );
 783                                 $data .= Xml::tags( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
 784                         } else {
 785                                 $data .= Xml::option( $label, $value, $value === $default ) . "\n";
 786                         }
 787                 }
 788
 789                 return $data;
 790         }
 791
 792         public function getHTML() {
 793                 return Xml::tags( 'select', $this->attributes, implode( "\n", $this->options ) );
 794         }
 795
 796 }