includes/Xml.php

   1 <?php
   2 /**
   3  * Methods to generate XML.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Module of static functions for generating XML
  25  */
  26 class Xml {
  27         /**
  28          * Format an XML element with given attributes and, optionally, text content.
  29          * Element and attribute names are assumed to be ready for literal inclusion.
  30          * Strings are assumed to not contain XML-illegal characters; special
  31          * characters (<, >, &) are escaped but illegals are not touched.
  32          *
  33          * @param string $element Element name
  34          * @param array $attribs Name=>value pairs. Values will be escaped.
  35          * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
  36          * @param bool $allowShortTag Whether '' in $contents will result in a contentless closed tag
  37          * @return string
  38          */
  39         public static function element( $element, $attribs = null, $contents = '',
  40                 $allowShortTag = true
  41         ) {
  42                 $out = '<' . $element;
  43                 if ( !is_null( $attribs ) ) {
  44                         $out .= self::expandAttributes( $attribs );
  45                 }
  46                 if ( is_null( $contents ) ) {
  47                         $out .= '>';
  48                 } else {
  49                         if ( $allowShortTag && $contents === '' ) {
  50                                 $out .= ' />';
  51                         } else {
  52                                 $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
  53                         }
  54                 }
  55                 return $out;
  56         }
  57
  58         /**
  59          * Given an array of ('attributename' => 'value'), it generates the code
  60          * to set the XML attributes : attributename="value".
  61          * The values are passed to Sanitizer::encodeAttribute.
  62          * Return null if no attributes given.
  63          * @param array $attribs Array of attributes for an XML element
  64          * @throws MWException
  65          * @return null|string
  66          */
  67         public static function expandAttributes( $attribs ) {
  68                 $out = '';
  69                 if ( is_null( $attribs ) ) {
  70                         return null;
  71                 } elseif ( is_array( $attribs ) ) {
  72                         foreach ( $attribs as $name => $val ) {
  73                                 $out .= " {$name}=\"" . Sanitizer::encodeAttribute( $val ) . '"';
  74                         }
  75                         return $out;
  76                 } else {
  77                         throw new MWException( 'Expected attribute array, got something else in ' . __METHOD__ );
  78                 }
  79         }
  80
  81         /**
  82          * Format an XML element as with self::element(), but run text through the
  83          * $wgContLang->normalize() validator first to ensure that no invalid UTF-8
  84          * is passed.
  85          *
  86          * @param string $element
  87          * @param array $attribs Name=>value pairs. Values will be escaped.
  88          * @param string $contents Null to make an open tag only; '' for a contentless closed tag (default)
  89          * @return string
  90          */
  91         public static function elementClean( $element, $attribs = array(), $contents = '' ) {
  92                 global $wgContLang;
  93                 if ( $attribs ) {
  94                         $attribs = array_map( array( 'UtfNormal', 'cleanUp' ), $attribs );
  95                 }
  96                 if ( $contents ) {
  97                         wfProfileIn( __METHOD__ . '-norm' );
  98                         $contents = $wgContLang->normalize( $contents );
  99                         wfProfileOut( __METHOD__ . '-norm' );
 100                 }
 101                 return self::element( $element, $attribs, $contents );
 102         }
 103
 104         /**
 105          * This opens an XML element
 106          *
 107          * @param string $element Name of the element
 108          * @param array $attribs Array of attributes, see Xml::expandAttributes()
 109          * @return string
 110          */
 111         public static function openElement( $element, $attribs = null ) {
 112                 return '<' . $element . self::expandAttributes( $attribs ) . '>';
 113         }
 114
 115         /**
 116          * Shortcut to close an XML element
 117          * @param string $element Element name
 118          * @return string
 119          */
 120         public static function closeElement( $element ) {
 121                 return "</$element>";
 122         }
 123
 124         /**
 125          * Same as Xml::element(), but does not escape contents. Handy when the
 126          * content you have is already valid xml.
 127          *
 128          * @param string $element Element name
 129          * @param array $attribs Array of attributes
 130          * @param string $contents Content of the element
 131          * @return string
 132          */
 133         public static function tags( $element, $attribs = null, $contents ) {
 134                 return self::openElement( $element, $attribs ) . $contents . "</$element>";
 135         }
 136
 137         /**
 138          * Create a date selector
 139          *
 140          * @param string $selected The month which should be selected, default ''.
 141          * @param string $allmonths Value of a special item denoting all month.
 142          *   Null to not include (default).
 143          * @param string $id Element identifier
 144          * @return string Html string containing the month selector
 145          */
 146         public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
 147                 global $wgLang;
 148                 $options = array();
 149                 if ( is_null( $selected ) ) {
 150                         $selected = '';
 151                 }
 152                 if ( !is_null( $allmonths ) ) {
 153                         $options[] = self::option(
 154                                 wfMessage( 'monthsall' )->text(),
 155                                 $allmonths,
 156                                 $selected === $allmonths
 157                         );
 158                 }
 159                 for ( $i = 1; $i < 13; $i++ ) {
 160                         $options[] = self::option( $wgLang->getMonthName( $i ), $i, $selected === $i );
 161                 }
 162                 return self::openElement( 'select', array(
 163                         'id' => $id,
 164                         'name' => 'month',
 165                         'class' => 'mw-month-selector'
 166                 ) )
 167                         . implode( "\n", $options )
 168                         . self::closeElement( 'select' );
 169         }
 170
 171         /**
 172          * @param int $year
 173          * @param int $month
 174          * @return string Formatted HTML
 175          */
 176         public static function dateMenu( $year, $month ) {
 177                 # Offset overrides year/month selection
 178                 if ( $month && $month !== -1 ) {
 179                         $encMonth = intval( $month );
 180                 } else {
 181                         $encMonth = '';
 182                 }
 183                 if ( $year ) {
 184                         $encYear = intval( $year );
 185                 } elseif ( $encMonth ) {
 186                         $timestamp = MWTimestamp::getInstance();
 187                         $thisMonth = intval( $timestamp->format( 'n' ) );
 188                         $thisYear = intval( $timestamp->format( 'Y' ) );
 189                         if ( intval( $encMonth ) > $thisMonth ) {
 190                                 $thisYear--;
 191                         }
 192                         $encYear = $thisYear;
 193                 } else {
 194                         $encYear = '';
 195                 }
 196                 $inputAttribs = array( 'id' => 'year', 'maxlength' => 4, 'size' => 7 );
 197                 return self::label( wfMessage( 'year' )->text(), 'year' ) . ' ' .
 198                         Html::input( 'year', $encYear, 'number', $inputAttribs ) . ' ' .
 199                         self::label( wfMessage( 'month' )->text(), 'month' ) . ' ' .
 200                         self::monthSelector( $encMonth, -1 );
 201         }
 202
 203         /**
 204          * Construct a language selector appropriate for use in a form or preferences
 205          *
 206          * @param string $selected The language code of the selected language
 207          * @param bool $customisedOnly If true only languages which have some content are listed
 208          * @param string $inLanguage The ISO code of the language to display the select list in (optional)
 209          * @param array $overrideAttrs Override the attributes of the select tag (since 1.20)
 210          * @param Message|null $msg Label message key (since 1.20)
 211          * @return array Array containing 2 items: label HTML and select list HTML
 212          */
 213         public static function languageSelector( $selected, $customisedOnly = true,
 214                 $inLanguage = null, $overrideAttrs = array(), Message $msg = null
 215         ) {
 216                 global $wgLanguageCode;
 217
 218                 $include = $customisedOnly ? 'mwfile' : 'mw';
 219                 $languages = Language::fetchLanguageNames( $inLanguage, $include );
 220
 221                 // Make sure the site language is in the list;
 222                 // a custom language code might not have a defined name...
 223                 if ( !array_key_exists( $wgLanguageCode, $languages ) ) {
 224                         $languages[$wgLanguageCode] = $wgLanguageCode;
 225                 }
 226
 227                 ksort( $languages );
 228
 229                 /**
 230                  * If a bogus value is set, default to the content language.
 231                  * Otherwise, no default is selected and the user ends up
 232                  * with Afrikaans since it's first in the list.
 233                  */
 234                 $selected = isset( $languages[$selected] ) ? $selected : $wgLanguageCode;
 235                 $options = "\n";
 236                 foreach ( $languages as $code => $name ) {
 237                         $options .= Xml::option( "$code - $name", $code, $code == $selected ) . "\n";
 238                 }
 239
 240                 $attrs = array( 'id' => 'wpUserLanguage', 'name' => 'wpUserLanguage' );
 241                 $attrs = array_merge( $attrs, $overrideAttrs );
 242
 243                 if ( $msg === null ) {
 244                         $msg = wfMessage( 'yourlanguage' );
 245                 }
 246                 return array(
 247                         Xml::label( $msg->text(), $attrs['id'] ),
 248                         Xml::tags( 'select', $attrs, $options )
 249                 );
 250
 251         }
 252
 253         /**
 254          * Shortcut to make a span element
 255          * @param string $text Content of the element, will be escaped
 256          * @param string $class Class name of the span element
 257          * @param array $attribs Other attributes
 258          * @return string
 259          */
 260         public static function span( $text, $class, $attribs = array() ) {
 261                 return self::element( 'span', array( 'class' => $class ) + $attribs, $text );
 262         }
 263
 264         /**
 265          * Shortcut to make a specific element with a class attribute
 266          * @param string $text Content of the element, will be escaped
 267          * @param string $class Class name of the span element
 268          * @param string $tag Element name
 269          * @param array $attribs Other attributes
 270          * @return string
 271          */
 272         public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) {
 273                 return self::tags( $tag, array( 'class' => $class ) + $attribs, $text );
 274         }
 275
 276         /**
 277          * Convenience function to build an HTML text input field
 278          * @param string $name Value of the name attribute
 279          * @param int $size Value of the size attribute
 280          * @param mixed $value Value of the value attribute
 281          * @param array $attribs Other attributes
 282          * @return string HTML
 283          */
 284         public static function input( $name, $size = false, $value = false, $attribs = array() ) {
 285                 $attributes = array( 'name' => $name );
 286
 287                 if ( $size ) {
 288                         $attributes['size'] = $size;
 289                 }
 290
 291                 if ( $value !== false ) { // maybe 0
 292                         $attributes['value'] = $value;
 293                 }
 294
 295                 return self::element( 'input',
 296                         Html::getTextInputAttributes( $attributes + $attribs ) );
 297         }
 298
 299         /**
 300          * Convenience function to build an HTML password input field
 301          * @param string $name Value of the name attribute
 302          * @param int $size Value of the size attribute
 303          * @param mixed $value Value of the value attribute
 304          * @param array $attribs Other attributes
 305          * @return string HTML
 306          */
 307         public static function password( $name, $size = false, $value = false,
 308                 $attribs = array()
 309         ) {
 310                 return self::input( $name, $size, $value,
 311                         array_merge( $attribs, array( 'type' => 'password' ) ) );
 312         }
 313
 314         /**
 315          * Internal function for use in checkboxes and radio buttons and such.
 316          *
 317          * @param string $name
 318          * @param bool $present
 319          *
 320          * @return array
 321          */
 322         public static function attrib( $name, $present = true ) {
 323                 return $present ? array( $name => $name ) : array();
 324         }
 325
 326         /**
 327          * Convenience function to build an HTML checkbox
 328          * @param string $name Value of the name attribute
 329          * @param bool $checked Whether the checkbox is checked or not
 330          * @param array $attribs Array other attributes
 331          * @return string HTML
 332          */
 333         public static function check( $name, $checked = false, $attribs = array() ) {
 334                 return self::element( 'input', array_merge(
 335                         array(
 336                                 'name' => $name,
 337                                 'type' => 'checkbox',
 338                                 'value' => 1 ),
 339                         self::attrib( 'checked', $checked ),
 340                         $attribs ) );
 341         }
 342
 343         /**
 344          * Convenience function to build an HTML radio button
 345          * @param string $name Value of the name attribute
 346          * @param string $value Value of the value attribute
 347          * @param bool $checked Whether the checkbox is checked or not
 348          * @param array $attribs Other attributes
 349          * @return string HTML
 350          */
 351         public static function radio( $name, $value, $checked = false, $attribs = array() ) {
 352                 return self::element( 'input', array(
 353                         'name' => $name,
 354                         'type' => 'radio',
 355                         'value' => $value ) + self::attrib( 'checked', $checked ) + $attribs );
 356         }
 357
 358         /**
 359          * Convenience function to build an HTML form label
 360          * @param string $label Text of the label
 361          * @param string $id
 362          * @param array $attribs An attribute array.  This will usually be
 363          *     the same array as is passed to the corresponding input element,
 364          *     so this function will cherry-pick appropriate attributes to
 365          *     apply to the label as well; only class and title are applied.
 366          * @return string HTML
 367          */
 368         public static function label( $label, $id, $attribs = array() ) {
 369                 $a = array( 'for' => $id );
 370
 371                 foreach ( array( 'class', 'title' ) as $attr ) {
 372                         if ( isset( $attribs[$attr] ) ) {
 373                                 $a[$attr] = $attribs[$attr];
 374                         }
 375                 }
 376
 377                 return self::element( 'label', $a, $label );
 378         }
 379
 380         /**
 381          * Convenience function to build an HTML text input field with a label
 382          * @param string $label Text of the label
 383          * @param string $name Value of the name attribute
 384          * @param string $id Id of the input
 385          * @param int|bool $size Value of the size attribute
 386          * @param string|bool $value Value of the value attribute
 387          * @param array $attribs Other attributes
 388          * @return string HTML
 389          */
 390         public static function inputLabel( $label, $name, $id, $size = false,
 391                 $value = false, $attribs = array()
 392         ) {
 393                 list( $label, $input ) = self::inputLabelSep( $label, $name, $id, $size, $value, $attribs );
 394                 return $label . '&#160;' . $input;
 395         }
 396
 397         /**
 398          * Same as Xml::inputLabel() but return input and label in an array
 399          *
 400          * @param string $label
 401          * @param string $name
 402          * @param string $id
 403          * @param int|bool $size
 404          * @param string|bool $value
 405          * @param array $attribs
 406          *
 407          * @return array
 408          */
 409         public static function inputLabelSep( $label, $name, $id, $size = false,
 410                 $value = false, $attribs = array()
 411         ) {
 412                 return array(
 413                         Xml::label( $label, $id, $attribs ),
 414                         self::input( $name, $size, $value, array( 'id' => $id ) + $attribs )
 415                 );
 416         }
 417
 418         /**
 419          * Convenience function to build an HTML checkbox with a label
 420          *
 421          * @param string $label
 422          * @param string $name
 423          * @param string $id
 424          * @param bool $checked
 425          * @param array $attribs
 426          *
 427          * @return string HTML
 428          */
 429         public static function checkLabel( $label, $name, $id, $checked = false, $attribs = array() ) {
 430                 global $wgUseMediaWikiUIEverywhere;
 431                 $chkLabel = self::check( $name, $checked, array( 'id' => $id ) + $attribs ) .
 432                         '&#160;' .
 433                         self::label( $label, $id, $attribs );
 434
 435                 if ( $wgUseMediaWikiUIEverywhere ) {
 436                         $chkLabel = self::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
 437                                 $chkLabel . self::closeElement( 'div' );
 438                 }
 439                 return $chkLabel;
 440         }
 441
 442         /**
 443          * Convenience function to build an HTML radio button with a label
 444          *
 445          * @param string $label
 446          * @param string $name
 447          * @param string $value
 448          * @param string $id
 449          * @param bool $checked
 450          * @param array $attribs
 451          *
 452          * @return string HTML
 453          */
 454         public static function radioLabel( $label, $name, $value, $id,
 455                 $checked = false, $attribs = array()
 456         ) {
 457                 return self::radio( $name, $value, $checked, array( 'id' => $id ) + $attribs ) .
 458                         '&#160;' .
 459                         self::label( $label, $id, $attribs );
 460         }
 461
 462         /**
 463          * Convenience function to build an HTML submit button
 464          * When $wgUseMediaWikiUIEverywhere is true it will default to a constructive button
 465          * @param string $value Label text for the button
 466          * @param array $attribs Optional custom attributes
 467          * @return string HTML
 468          */
 469         public static function submitButton( $value, $attribs = array() ) {
 470                 global $wgUseMediaWikiUIEverywhere;
 471                 $baseAttrs = array(
 472                         'type' => 'submit',
 473                         'value' => $value,
 474                 );
 475                 // Done conditionally for time being as it is possible
 476                 // some submit forms
 477                 // might need to be mw-ui-destructive (e.g. delete a page)
 478                 if ( $wgUseMediaWikiUIEverywhere ) {
 479                         $baseAttrs['class'] = 'mw-ui-button mw-ui-constructive';
 480                 }
 481                 // Any custom attributes will take precendence of anything in baseAttrs e.g. override the class
 482                 $attribs = $attribs + $baseAttrs;
 483                 return Html::element( 'input', $attribs );
 484         }
 485
 486         /**
 487          * Convenience function to build an HTML drop-down list item.
 488          * @param string $text Text for this item. Will be HTML escaped
 489          * @param string $value Form submission value; if empty, use text
 490          * @param bool $selected If true, will be the default selected item
 491          * @param array $attribs Optional additional HTML attributes
 492          * @return string HTML
 493          */
 494         public static function option( $text, $value = null, $selected = false,
 495                         $attribs = array() ) {
 496                 if ( !is_null( $value ) ) {
 497                         $attribs['value'] = $value;
 498                 }
 499                 if ( $selected ) {
 500                         $attribs['selected'] = 'selected';
 501                 }
 502                 return Html::element( 'option', $attribs, $text );
 503         }
 504
 505         /**
 506          * Build a drop-down box from a textual list.
 507          *
 508          * @param string $name Name and id for the drop-down
 509          * @param string $list Correctly formatted text (newline delimited) to be
 510          *   used to generate the options.
 511          * @param string $other Text for the "Other reasons" option
 512          * @param string $selected Option which should be pre-selected
 513          * @param string $class CSS classes for the drop-down
 514          * @param int $tabindex Value of the tabindex attribute
 515          * @return string
 516          */
 517         public static function listDropDown( $name = '', $list = '', $other = '',
 518                 $selected = '', $class = '', $tabindex = null
 519         ) {
 520                 $optgroup = false;
 521
 522                 $options = self::option( $other, 'other', $selected === 'other' );
 523
 524                 foreach ( explode( "\n", $list ) as $option ) {
 525                         $value = trim( $option );
 526                         if ( $value == '' ) {
 527                                 continue;
 528                         } elseif ( substr( $value, 0, 1 ) == '*' && substr( $value, 1, 1 ) != '*' ) {
 529                                 // A new group is starting ...
 530                                 $value = trim( substr( $value, 1 ) );
 531                                 if ( $optgroup ) {
 532                                         $options .= self::closeElement( 'optgroup' );
 533                                 }
 534                                 $options .= self::openElement( 'optgroup', array( 'label' => $value ) );
 535                                 $optgroup = true;
 536                         } elseif ( substr( $value, 0, 2 ) == '**' ) {
 537                                 // groupmember
 538                                 $value = trim( substr( $value, 2 ) );
 539                                 $options .= self::option( $value, $value, $selected === $value );
 540                         } else {
 541                                 // groupless reason list
 542                                 if ( $optgroup ) {
 543                                         $options .= self::closeElement( 'optgroup' );
 544                                 }
 545                                 $options .= self::option( $value, $value, $selected === $value );
 546                                 $optgroup = false;
 547                         }
 548                 }
 549
 550                 if ( $optgroup ) {
 551                         $options .= self::closeElement( 'optgroup' );
 552                 }
 553
 554                 $attribs = array();
 555
 556                 if ( $name ) {
 557                         $attribs['id'] = $name;
 558                         $attribs['name'] = $name;
 559                 }
 560
 561                 if ( $class ) {
 562                         $attribs['class'] = $class;
 563                 }
 564
 565                 if ( $tabindex ) {
 566                         $attribs['tabindex'] = $tabindex;
 567                 }
 568
 569                 return Xml::openElement( 'select', $attribs )
 570                         . "\n"
 571                         . $options
 572                         . "\n"
 573                         . Xml::closeElement( 'select' );
 574         }
 575
 576         /**
 577          * Shortcut for creating fieldsets.
 578          *
 579          * @param string|bool $legend Legend of the fieldset. If evaluates to false,
 580          *   legend is not added.
 581          * @param string $content Pre-escaped content for the fieldset. If false,
 582          *   only open fieldset is returned.
 583          * @param array $attribs Any attributes to fieldset-element.
 584          *
 585          * @return string
 586          */
 587         public static function fieldset( $legend = false, $content = false, $attribs = array() ) {
 588                 $s = Xml::openElement( 'fieldset', $attribs ) . "\n";
 589
 590                 if ( $legend ) {
 591                         $s .= Xml::element( 'legend', null, $legend ) . "\n";
 592                 }
 593
 594                 if ( $content !== false ) {
 595                         $s .= $content . "\n";
 596                         $s .= Xml::closeElement( 'fieldset' ) . "\n";
 597                 }
 598
 599                 return $s;
 600         }
 601
 602         /**
 603          * Shortcut for creating textareas.
 604          *
 605          * @param string $name The 'name' for the textarea
 606          * @param string $content Content for the textarea
 607          * @param int $cols The number of columns for the textarea
 608          * @param int $rows The number of rows for the textarea
 609          * @param array $attribs Any other attributes for the textarea
 610          *
 611          * @return string
 612          */
 613         public static function textarea( $name, $content, $cols = 40, $rows = 5, $attribs = array() ) {
 614                 return self::element( 'textarea',
 615                                         Html::getTextInputAttributes(
 616                                                 array(
 617                                                         'name' => $name,
 618                                                         'id' => $name,
 619                                                         'cols' => $cols,
 620                                                         'rows' => $rows
 621                                                 ) + $attribs
 622                                         ),
 623                                         $content, false );
 624         }
 625
 626         /**
 627          * Returns an escaped string suitable for inclusion in a string literal
 628          * for JavaScript source code.
 629          * Illegal control characters are assumed not to be present.
 630          *
 631          * @deprecated since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
 632          * @param string $string String to escape
 633          * @return string
 634          */
 635         public static function escapeJsString( $string ) {
 636                 // See ECMA 262 section 7.8.4 for string literal format
 637                 $pairs = array(
 638                         "\\" => "\\\\",
 639                         "\"" => "\\\"",
 640                         '\'' => '\\\'',
 641                         "\n" => "\\n",
 642                         "\r" => "\\r",
 643
 644                         # To avoid closing the element or CDATA section
 645                         "<" => "\\x3c",
 646                         ">" => "\\x3e",
 647
 648                         # To avoid any complaints about bad entity refs
 649                         "&" => "\\x26",
 650
 651                         # Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
 652                         # Encode certain Unicode formatting chars so affected
 653                         # versions of Gecko don't misinterpret our strings;
 654                         # this is a common problem with Farsi text.
 655                         "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
 656                         "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
 657                 );
 658
 659                 return strtr( $string, $pairs );
 660         }
 661
 662         /**
 663          * Encode a variable of arbitrary type to JavaScript.
 664          * If the value is an XmlJsCode object, pass through the object's value verbatim.
 665          *
 666          * @note Only use this function for generating JavaScript code. If generating output
 667          *       for a proper JSON parser, just call FormatJson::encode() directly.
 668          *
 669          * @param mixed $value The value being encoded. Can be any type except a resource.
 670          * @param bool $pretty If true, add non-significant whitespace to improve readability.
 671          * @return string|bool String if successful; false upon failure
 672          */
 673         public static function encodeJsVar( $value, $pretty = false ) {
 674                 if ( $value instanceof XmlJsCode ) {
 675                         return $value->value;
 676                 }
 677                 return FormatJson::encode( $value, $pretty, FormatJson::UTF8_OK );
 678         }
 679
 680         /**
 681          * Create a call to a JavaScript function. The supplied arguments will be
 682          * encoded using Xml::encodeJsVar().
 683          *
 684          * @since 1.17
 685          * @param string $name The name of the function to call, or a JavaScript expression
 686          *    which evaluates to a function object which is called.
 687          * @param array $args The arguments to pass to the function.
 688          * @param bool $pretty If true, add non-significant whitespace to improve readability.
 689          * @return string|bool String if successful; false upon failure
 690          */
 691         public static function encodeJsCall( $name, $args, $pretty = false ) {
 692                 foreach ( $args as &$arg ) {
 693                         $arg = Xml::encodeJsVar( $arg, $pretty );
 694                         if ( $arg === false ) {
 695                                 return false;
 696                         }
 697                 }
 698
 699                 return "$name(" . ( $pretty
 700                         ? ( ' ' . implode( ', ', $args ) . ' ' )
 701                         : implode( ',', $args )
 702                 ) . ");";
 703         }
 704
 705         /**
 706          * Check if a string is well-formed XML.
 707          * Must include the surrounding tag.
 708          *
 709          * @param string $text String to test.
 710          * @return bool
 711          *
 712          * @todo Error position reporting return
 713          */
 714         public static function isWellFormed( $text ) {
 715                 $parser = xml_parser_create( "UTF-8" );
 716
 717                 # case folding violates XML standard, turn it off
 718                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
 719
 720                 if ( !xml_parse( $parser, $text, true ) ) {
 721                         //$err = xml_error_string( xml_get_error_code( $parser ) );
 722                         //$position = xml_get_current_byte_index( $parser );
 723                         //$fragment = $this->extractFragment( $html, $position );
 724                         //$this->mXmlError = "$err at byte $position:\n$fragment";
 725                         xml_parser_free( $parser );
 726                         return false;
 727                 }
 728
 729                 xml_parser_free( $parser );
 730
 731                 return true;
 732         }
 733
 734         /**
 735          * Check if a string is a well-formed XML fragment.
 736          * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
 737          * and can use HTML named entities.
 738          *
 739          * @param string $text
 740          * @return bool
 741          */
 742         public static function isWellFormedXmlFragment( $text ) {
 743                 $html =
 744                         Sanitizer::hackDocType() .
 745                         '<html>' .
 746                         $text .
 747                         '</html>';
 748
 749                 return Xml::isWellFormed( $html );
 750         }
 751
 752         /**
 753          * Replace " > and < with their respective HTML entities ( &quot;,
 754          * &gt;, &lt;)
 755          *
 756          * @param string $in Text that might contain HTML tags.
 757          * @return string Escaped string
 758          */
 759         public static function escapeTagsOnly( $in ) {
 760                 return str_replace(
 761                         array( '"', '>', '<' ),
 762                         array( '&quot;', '&gt;', '&lt;' ),
 763                         $in );
 764         }
 765
 766         /**
 767          * Generate a form (without the opening form element).
 768          * Output optionally includes a submit button.
 769          * @param array $fields Associative array, key is the name of a message that
 770          *   contains a description for the field, value is an HTML string
 771          *   containing the appropriate input.
 772          * @param string $submitLabel The name of a message containing a label for
 773          *   the submit button.
 774          * @param array $submitAttribs The attributes to add to the submit button
 775          * @return string HTML form.
 776          */
 777         public static function buildForm( $fields, $submitLabel = null, $submitAttribs = array() ) {
 778                 $form = '';
 779                 $form .= "<table><tbody>";
 780
 781                 foreach ( $fields as $labelmsg => $input ) {
 782                         $id = "mw-$labelmsg";
 783                         $form .= Xml::openElement( 'tr', array( 'id' => $id ) );
 784
 785                         // TODO use a <label> here for accessibility purposes - will need
 786                         // to either not use a table to build the form, or find the ID of
 787                         // the input somehow.
 788
 789                         $form .= Xml::tags( 'td', array( 'class' => 'mw-label' ), wfMessage( $labelmsg )->parse() );
 790                         $form .= Xml::openElement( 'td', array( 'class' => 'mw-input' ) )
 791                                 . $input . Xml::closeElement( 'td' );
 792                         $form .= Xml::closeElement( 'tr' );
 793                 }
 794
 795                 if ( $submitLabel ) {
 796                         $form .= Xml::openElement( 'tr' );
 797                         $form .= Xml::tags( 'td', array(), '' );
 798                         $form .= Xml::openElement( 'td', array( 'class' => 'mw-submit' ) )
 799                                 . Xml::submitButton( wfMessage( $submitLabel )->text(), $submitAttribs )
 800                                 . Xml::closeElement( 'td' );
 801                         $form .= Xml::closeElement( 'tr' );
 802                 }
 803
 804                 $form .= "</tbody></table>";
 805
 806                 return $form;
 807         }
 808
 809         /**
 810          * Build a table of data
 811          * @param array $rows An array of arrays of strings, each to be a row in a table
 812          * @param array $attribs An array of attributes to apply to the table tag [optional]
 813          * @param array $headers An array of strings to use as table headers [optional]
 814          * @return string
 815          */
 816         public static function buildTable( $rows, $attribs = array(), $headers = null ) {
 817                 $s = Xml::openElement( 'table', $attribs );
 818
 819                 if ( is_array( $headers ) ) {
 820                         $s .= Xml::openElement( 'thead', $attribs );
 821
 822                         foreach ( $headers as $id => $header ) {
 823                                 $attribs = array();
 824
 825                                 if ( is_string( $id ) ) {
 826                                         $attribs['id'] = $id;
 827                                 }
 828
 829                                 $s .= Xml::element( 'th', $attribs, $header );
 830                         }
 831                         $s .= Xml::closeElement( 'thead' );
 832                 }
 833
 834                 foreach ( $rows as $id => $row ) {
 835                         $attribs = array();
 836
 837                         if ( is_string( $id ) ) {
 838                                 $attribs['id'] = $id;
 839                         }
 840
 841                         $s .= Xml::buildTableRow( $attribs, $row );
 842                 }
 843
 844                 $s .= Xml::closeElement( 'table' );
 845
 846                 return $s;
 847         }
 848
 849         /**
 850          * Build a row for a table
 851          * @param array $attribs An array of attributes to apply to the tr tag
 852          * @param array $cells An array of strings to put in <td>
 853          * @return string
 854          */
 855         public static function buildTableRow( $attribs, $cells ) {
 856                 $s = Xml::openElement( 'tr', $attribs );
 857
 858                 foreach ( $cells as $id => $cell ) {
 859                         $attribs = array();
 860
 861                         if ( is_string( $id ) ) {
 862                                 $attribs['id'] = $id;
 863                         }
 864
 865                         $s .= Xml::element( 'td', $attribs, $cell );
 866                 }
 867
 868                 $s .= Xml::closeElement( 'tr' );
 869
 870                 return $s;
 871         }
 872 }
 873
 874 class XmlSelect {
 875         protected $options = array();
 876         protected $default = false;
 877         protected $attributes = array();
 878
 879         public function __construct( $name = false, $id = false, $default = false ) {
 880                 if ( $name ) {
 881                         $this->setAttribute( 'name', $name );
 882                 }
 883
 884                 if ( $id ) {
 885                         $this->setAttribute( 'id', $id );
 886                 }
 887
 888                 if ( $default !== false ) {
 889                         $this->default = $default;
 890                 }
 891         }
 892
 893         /**
 894          * @param string $default
 895          */
 896         public function setDefault( $default ) {
 897                 $this->default = $default;
 898         }
 899
 900         /**
 901          * @param string $name
 902          * @param array $value
 903          */
 904         public function setAttribute( $name, $value ) {
 905                 $this->attributes[$name] = $value;
 906         }
 907
 908         /**
 909          * @param string $name
 910          * @return array|null
 911          */
 912         public function getAttribute( $name ) {
 913                 if ( isset( $this->attributes[$name] ) ) {
 914                         return $this->attributes[$name];
 915                 } else {
 916                         return null;
 917                 }
 918         }
 919
 920         /**
 921          * @param string $name
 922          * @param bool $value
 923          */
 924         public function addOption( $name, $value = false ) {
 925                 // Stab stab stab
 926                 $value = $value !== false ? $value : $name;
 927
 928                 $this->options[] = array( $name => $value );
 929         }
 930
 931         /**
 932          * This accepts an array of form
 933          * label => value
 934          * label => ( label => value, label => value )
 935          *
 936          * @param array $options
 937          */
 938         public function addOptions( $options ) {
 939                 $this->options[] = $options;
 940         }
 941
 942         /**
 943          * This accepts an array of form
 944          * label => value
 945          * label => ( label => value, label => value )
 946          *
 947          * @param array $options
 948          * @param bool $default
 949          * @return string
 950          */
 951         static function formatOptions( $options, $default = false ) {
 952                 $data = '';
 953
 954                 foreach ( $options as $label => $value ) {
 955                         if ( is_array( $value ) ) {
 956                                 $contents = self::formatOptions( $value, $default );
 957                                 $data .= Html::rawElement( 'optgroup', array( 'label' => $label ), $contents ) . "\n";
 958                         } else {
 959                                 $data .= Xml::option( $label, $value, $value === $default ) . "\n";
 960                         }
 961                 }
 962
 963                 return $data;
 964         }
 965
 966         /**
 967          * @return string
 968          */
 969         public function getHTML() {
 970                 $contents = '';
 971
 972                 foreach ( $this->options as $options ) {
 973                         $contents .= self::formatOptions( $options, $this->default );
 974                 }
 975
 976                 return Html::rawElement( 'select', $this->attributes, rtrim( $contents ) );
 977         }
 978 }
 979
 980 /**
 981  * A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to
 982  * interpret a given string as being a JavaScript expression, instead of string
 983  * data.
 984  *
 985  * Example:
 986  *
 987  *    Xml::encodeJsVar( new XmlJsCode( 'a + b' ) );
 988  *
 989  * Returns "a + b".
 990  *
 991  * @note As of 1.21, XmlJsCode objects cannot be nested inside objects or arrays. The sole
 992  *       exception is the $args argument to Xml::encodeJsCall() because Xml::encodeJsVar() is
 993  *       called for each individual element in that array.
 994  *
 995  * @since 1.17
 996  */
 997 class XmlJsCode {
 998         public $value;
 999
1000         function __construct( $value ) {
1001                 $this->value = $value;
1002         }
1003 }