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