includes/HTMLForm.php

   1 <?php
   2 /**
   3  * Object handling generic submission, CSRF protection, layout and
   4  * other logic for UI forms. in a reusable manner.
   5  *
   6  * In order to generate the form, the HTMLForm object takes an array
   7  * structure detailing the form fields available. Each element of the
   8  * array is a basic property-list, including the type of field, the
   9  * label it is to be given in the form, callbacks for validation and
  10  * 'filtering', and other pertinent information.
  11  *
  12  * Field types are implemented as subclasses of the generic HTMLFormField
  13  * object, and typically implement at least getInputHTML, which generates
  14  * the HTML for the input field to be placed in the table.
  15  *
  16  * The constructor input is an associative array of $fieldname => $info,
  17  * where $info is an Associative Array with any of the following:
  18  *
  19  *      'class'               -- the subclass of HTMLFormField that will be used
  20  *                               to create the object.  *NOT* the CSS class!
  21  *      'type'                -- roughly translates into the <select> type attribute.
  22  *                               if 'class' is not specified, this is used as a map
  23  *                               through HTMLForm::$typeMappings to get the class name.
  24  *      'default'             -- default value when the form is displayed
  25  *      'id'                  -- HTML id attribute
  26  *      'cssclass'            -- CSS class
  27  *      'options'             -- varies according to the specific object.
  28  *      'label-message'       -- message key for a message to use as the label.
  29  *                               can be an array of msg key and then parameters to
  30  *                               the message.
  31  *      'label'               -- alternatively, a raw text message. Overridden by
  32  *                               label-message
  33  *      'help-message'        -- message key for a message to use as a help text.
  34  *                               can be an array of msg key and then parameters to
  35  *                               the message.
  36  *                               Overwrites 'help-messages'.
  37  *      'help-messages'       -- array of message key. As above, each item can
  38  *                               be an array of msg key and then parameters.
  39  *                               Overwrites 'help-message'.
  40  *      'required'            -- passed through to the object, indicating that it
  41  *                               is a required field.
  42  *      'size'                -- the length of text fields
  43  *      'filter-callback      -- a function name to give you the chance to
  44  *                               massage the inputted value before it's processed.
  45  *                               @see HTMLForm::filter()
  46  *      'validation-callback' -- a function name to give you the chance
  47  *                               to impose extra validation on the field input.
  48  *                               @see HTMLForm::validate()
  49  *      'name'                -- By default, the 'name' attribute of the input field
  50  *                               is "wp{$fieldname}".  If you want a different name
  51  *                               (eg one without the "wp" prefix), specify it here and
  52  *                               it will be used without modification.
  53  *
  54  * TODO: Document 'section' / 'subsection' stuff
  55  */
  56 class HTMLForm extends ContextSource {
  57
  58         # A mapping of 'type' inputs onto standard HTMLFormField subclasses
  59         static $typeMappings = array(
  60                 'text' => 'HTMLTextField',
  61                 'textarea' => 'HTMLTextAreaField',
  62                 'select' => 'HTMLSelectField',
  63                 'radio' => 'HTMLRadioField',
  64                 'multiselect' => 'HTMLMultiSelectField',
  65                 'check' => 'HTMLCheckField',
  66                 'toggle' => 'HTMLCheckField',
  67                 'int' => 'HTMLIntField',
  68                 'float' => 'HTMLFloatField',
  69                 'info' => 'HTMLInfoField',
  70                 'selectorother' => 'HTMLSelectOrOtherField',
  71                 'selectandother' => 'HTMLSelectAndOtherField',
  72                 'submit' => 'HTMLSubmitField',
  73                 'hidden' => 'HTMLHiddenField',
  74                 'edittools' => 'HTMLEditTools',
  75
  76                 # HTMLTextField will output the correct type="" attribute automagically.
  77                 # There are about four zillion other HTML5 input types, like url, but
  78                 # we don't use those at the moment, so no point in adding all of them.
  79                 'email' => 'HTMLTextField',
  80                 'password' => 'HTMLTextField',
  81         );
  82
  83         protected $mMessagePrefix;
  84
  85         /** @var HTMLFormField[] */
  86         protected $mFlatFields;
  87
  88         protected $mFieldTree;
  89         protected $mShowReset = false;
  90         public $mFieldData;
  91
  92         protected $mSubmitCallback;
  93         protected $mValidationErrorMessage;
  94
  95         protected $mPre = '';
  96         protected $mHeader = '';
  97         protected $mFooter = '';
  98         protected $mSectionHeaders = array();
  99         protected $mSectionFooters = array();
 100         protected $mPost = '';
 101         protected $mId;
 102
 103         protected $mSubmitID;
 104         protected $mSubmitName;
 105         protected $mSubmitText;
 106         protected $mSubmitTooltip;
 107
 108         protected $mTitle;
 109         protected $mMethod = 'post';
 110
 111         protected $mUseMultipart = false;
 112         protected $mHiddenFields = array();
 113         protected $mButtons = array();
 114
 115         protected $mWrapperLegend = false;
 116
 117         /**
 118          * If true, sections that contain both fields and subsections will
 119          * render their subsections before their fields.
 120          *
 121          * Subclasses may set this to false to render subsections after fields
 122          * instead.
 123          */
 124         protected $mSubSectionBeforeFields = true;
 125
 126         /**
 127          * Build a new HTMLForm from an array of field attributes
 128          * @param $descriptor Array of Field constructs, as described above
 129          * @param $context IContextSource available since 1.18, will become compulsory in 1.18.
 130          *     Obviates the need to call $form->setTitle()
 131          * @param $messagePrefix String a prefix to go in front of default messages
 132          */
 133         public function __construct( $descriptor, /*IContextSource*/ $context = null, $messagePrefix = '' ) {
 134                 if( $context instanceof IContextSource ){
 135                         $this->setContext( $context );
 136                         $this->mTitle = false; // We don't need them to set a title
 137                         $this->mMessagePrefix = $messagePrefix;
 138                 } else {
 139                         // B/C since 1.18
 140                         if( is_string( $context ) && $messagePrefix === '' ){
 141                                 // it's actually $messagePrefix
 142                                 $this->mMessagePrefix = $context;
 143                         }
 144                 }
 145
 146                 // Expand out into a tree.
 147                 $loadedDescriptor = array();
 148                 $this->mFlatFields = array();
 149
 150                 foreach ( $descriptor as $fieldname => $info ) {
 151                         $section = isset( $info['section'] )
 152                                 ? $info['section']
 153                                 : '';
 154
 155                         if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
 156                                 $this->mUseMultipart = true;
 157                         }
 158
 159                         $field = self::loadInputFromParameters( $fieldname, $info );
 160                         $field->mParent = $this;
 161
 162                         $setSection =& $loadedDescriptor;
 163                         if ( $section ) {
 164                                 $sectionParts = explode( '/', $section );
 165
 166                                 while ( count( $sectionParts ) ) {
 167                                         $newName = array_shift( $sectionParts );
 168
 169                                         if ( !isset( $setSection[$newName] ) ) {
 170                                                 $setSection[$newName] = array();
 171                                         }
 172
 173                                         $setSection =& $setSection[$newName];
 174                                 }
 175                         }
 176
 177                         $setSection[$fieldname] = $field;
 178                         $this->mFlatFields[$fieldname] = $field;
 179                 }
 180
 181                 $this->mFieldTree = $loadedDescriptor;
 182         }
 183
 184         /**
 185          * Add the HTMLForm-specific JavaScript, if it hasn't been
 186          * done already.
 187          * @deprecated since 1.18 load modules with ResourceLoader instead
 188          */
 189         static function addJS() { wfDeprecated( __METHOD__, '1.18' ); }
 190
 191         /**
 192          * Initialise a new Object for the field
 193          * @param $fieldname string
 194          * @param $descriptor string input Descriptor, as described above
 195          * @return HTMLFormField subclass
 196          */
 197         static function loadInputFromParameters( $fieldname, $descriptor ) {
 198                 if ( isset( $descriptor['class'] ) ) {
 199                         $class = $descriptor['class'];
 200                 } elseif ( isset( $descriptor['type'] ) ) {
 201                         $class = self::$typeMappings[$descriptor['type']];
 202                         $descriptor['class'] = $class;
 203                 } else {
 204                         $class = null;
 205                 }
 206
 207                 if ( !$class ) {
 208                         throw new MWException( "Descriptor with no class: " . print_r( $descriptor, true ) );
 209                 }
 210
 211                 $descriptor['fieldname'] = $fieldname;
 212
 213                 $obj = new $class( $descriptor );
 214
 215                 return $obj;
 216         }
 217
 218         /**
 219          * Prepare form for submission
 220          */
 221         function prepareForm() {
 222                 # Check if we have the info we need
 223                 if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
 224                         throw new MWException( "You must call setTitle() on an HTMLForm" );
 225                 }
 226
 227                 # Load data from the request.
 228                 $this->loadData();
 229         }
 230
 231         /**
 232          * Try submitting, with edit token check first
 233          * @return Status|boolean
 234          */
 235         function tryAuthorizedSubmit() {
 236                 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
 237
 238                 $result = false;
 239                 if ( $this->getMethod() != 'post' || $this->getUser()->matchEditToken( $editToken ) ) {
 240                         $result = $this->trySubmit();
 241                 }
 242                 return $result;
 243         }
 244
 245         /**
 246          * The here's-one-I-made-earlier option: do the submission if
 247          * posted, or display the form with or without funky valiation
 248          * errors
 249          * @return Bool or Status whether submission was successful.
 250          */
 251         function show() {
 252                 $this->prepareForm();
 253
 254                 $result = $this->tryAuthorizedSubmit();
 255                 if ( $result === true || ( $result instanceof Status && $result->isGood() ) ){
 256                         return $result;
 257                 }
 258
 259                 $this->displayForm( $result );
 260                 return false;
 261         }
 262
 263         /**
 264          * Validate all the fields, and call the submision callback
 265          * function if everything is kosher.
 266          * @return Mixed Bool true == Successful submission, Bool false
 267          *       == No submission attempted, anything else == Error to
 268          *       display.
 269          */
 270         function trySubmit() {
 271                 # Check for validation
 272                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 273                         if ( !empty( $field->mParams['nodata'] ) ) {
 274                                 continue;
 275                         }
 276                         if ( $field->validate(
 277                                         $this->mFieldData[$fieldname],
 278                                         $this->mFieldData )
 279                                 !== true
 280                         ) {
 281                                 return isset( $this->mValidationErrorMessage )
 282                                         ? $this->mValidationErrorMessage
 283                                         : array( 'htmlform-invalid-input' );
 284                         }
 285                 }
 286
 287                 $callback = $this->mSubmitCallback;
 288
 289                 $data = $this->filterDataForSubmit( $this->mFieldData );
 290
 291                 $res = call_user_func( $callback, $data, $this );
 292
 293                 return $res;
 294         }
 295
 296         /**
 297          * Set a callback to a function to do something with the form
 298          * once it's been successfully validated.
 299          * @param $cb String function name.  The function will be passed
 300          *       the output from HTMLForm::filterDataForSubmit, and must
 301          *       return Bool true on success, Bool false if no submission
 302          *       was attempted, or String HTML output to display on error.
 303          */
 304         function setSubmitCallback( $cb ) {
 305                 $this->mSubmitCallback = $cb;
 306         }
 307
 308         /**
 309          * Set a message to display on a validation error.
 310          * @param $msg Mixed String or Array of valid inputs to wfMsgExt()
 311          *       (so each entry can be either a String or Array)
 312          */
 313         function setValidationErrorMessage( $msg ) {
 314                 $this->mValidationErrorMessage = $msg;
 315         }
 316
 317         /**
 318          * Set the introductory message, overwriting any existing message.
 319          * @param $msg String complete text of message to display
 320          */
 321         function setIntro( $msg ) {
 322                 $this->setPreText( $msg );
 323         }
 324
 325         /**
 326          * Set the introductory message, overwriting any existing message.
 327          * @since 1.19
 328          * @param $msg String complete text of message to display
 329          */
 330         function setPreText( $msg ) { $this->mPre = $msg; }
 331
 332         /**
 333          * Add introductory text.
 334          * @param $msg String complete text of message to display
 335          */
 336         function addPreText( $msg ) { $this->mPre .= $msg; }
 337
 338         /**
 339          * Add header text, inside the form.
 340          * @param $msg String complete text of message to display
 341          * @param $section The section to add the header to
 342          */
 343         function addHeaderText( $msg, $section = null ) {
 344                 if ( is_null( $section ) ) {
 345                         $this->mHeader .= $msg;
 346                 } else {
 347                         if ( !isset( $this->mSectionHeaders[$section] ) ) {
 348                                 $this->mSectionHeaders[$section] = '';
 349                         }
 350                         $this->mSectionHeaders[$section] .= $msg;
 351                 }
 352         }
 353
 354         /**
 355          * Set header text, inside the form.
 356          * @since 1.19
 357          * @param $msg String complete text of message to display
 358          * @param $section The section to add the header to
 359          */
 360         function setHeaderText( $msg, $section = null ) {
 361                 if ( is_null( $section ) ) {
 362                         $this->mHeader = $msg;
 363                 } else {
 364                         $this->mSectionHeaders[$section] = $msg;
 365                 }
 366         }
 367
 368         /**
 369          * Add footer text, inside the form.
 370          * @param $msg String complete text of message to display
 371          * @param $section string The section to add the footer text to
 372          */
 373         function addFooterText( $msg, $section = null ) {
 374                 if ( is_null( $section ) ) {
 375                         $this->mFooter .= $msg;
 376                 } else {
 377                         if ( !isset( $this->mSectionFooters[$section] ) ) {
 378                                 $this->mSectionFooters[$section] = '';
 379                         }
 380                         $this->mSectionFooters[$section] .= $msg;
 381                 }
 382         }
 383
 384         /**
 385          * Set footer text, inside the form.
 386          * @since 1.19
 387          * @param $msg String complete text of message to display
 388          * @param $section string The section to add the footer text to
 389          */
 390         function setFooterText( $msg, $section = null ) {
 391                 if ( is_null( $section ) ) {
 392                         $this->mFooter = $msg;
 393                 } else {
 394                         $this->mSectionFooters[$section] = $msg;
 395                 }
 396         }
 397
 398         /**
 399          * Add text to the end of the display.
 400          * @param $msg String complete text of message to display
 401          */
 402         function addPostText( $msg ) { $this->mPost .= $msg; }
 403
 404         /**
 405          * Set text at the end of the display.
 406          * @param $msg String complete text of message to display
 407          */
 408         function setPostText( $msg ) { $this->mPost = $msg; }
 409
 410         /**
 411          * Add a hidden field to the output
 412          * @param $name String field name.  This will be used exactly as entered
 413          * @param $value String field value
 414          * @param $attribs Array
 415          */
 416         public function addHiddenField( $name, $value, $attribs = array() ) {
 417                 $attribs += array( 'name' => $name );
 418                 $this->mHiddenFields[] = array( $value, $attribs );
 419         }
 420
 421         public function addButton( $name, $value, $id = null, $attribs = null ) {
 422                 $this->mButtons[] = compact( 'name', 'value', 'id', 'attribs' );
 423         }
 424
 425         /**
 426          * Display the form (sending to wgOut), with an appropriate error
 427          * message or stack of messages, and any validation errors, etc.
 428          * @param $submitResult Mixed output from HTMLForm::trySubmit()
 429          */
 430         function displayForm( $submitResult ) {
 431                 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
 432         }
 433
 434         /**
 435          * Returns the raw HTML generated by the form
 436          * @param $submitResult Mixed output from HTMLForm::trySubmit()
 437          * @return string
 438          */
 439         function getHTML( $submitResult ) {
 440                 # For good measure (it is the default)
 441                 $this->getOutput()->preventClickjacking();
 442                 $this->getOutput()->addModules( 'mediawiki.htmlform' );
 443
 444                 $html = ''
 445                         . $this->getErrors( $submitResult )
 446                         . $this->mHeader
 447                         . $this->getBody()
 448                         . $this->getHiddenFields()
 449                         . $this->getButtons()
 450                         . $this->mFooter
 451                 ;
 452
 453                 $html = $this->wrapForm( $html );
 454
 455                 return '' . $this->mPre . $html . $this->mPost;
 456         }
 457
 458         /**
 459          * Wrap the form innards in an actual <form> element
 460          * @param $html String HTML contents to wrap.
 461          * @return String wrapped HTML.
 462          */
 463         function wrapForm( $html ) {
 464
 465                 # Include a <fieldset> wrapper for style, if requested.
 466                 if ( $this->mWrapperLegend !== false ) {
 467                         $html = Xml::fieldset( $this->mWrapperLegend, $html );
 468                 }
 469                 # Use multipart/form-data
 470                 $encType = $this->mUseMultipart
 471                         ? 'multipart/form-data'
 472                         : 'application/x-www-form-urlencoded';
 473                 # Attributes
 474                 $attribs = array(
 475                         'action'  => $this->getTitle()->getFullURL(),
 476                         'method'  => $this->mMethod,
 477                         'class'   => 'visualClear',
 478                         'enctype' => $encType,
 479                 );
 480                 if ( !empty( $this->mId ) ) {
 481                         $attribs['id'] = $this->mId;
 482                 }
 483
 484                 return Html::rawElement( 'form', $attribs, $html );
 485         }
 486
 487         /**
 488          * Get the hidden fields that should go inside the form.
 489          * @return String HTML.
 490          */
 491         function getHiddenFields() {
 492                 global $wgUsePathInfo;
 493
 494                 $html = '';
 495                 if( $this->getMethod() == 'post' ){
 496                         $html .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
 497                         $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
 498                 }
 499
 500                 if ( !$wgUsePathInfo && $this->getMethod() == 'get' ) {
 501                         $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
 502                 }
 503
 504                 foreach ( $this->mHiddenFields as $data ) {
 505                         list( $value, $attribs ) = $data;
 506                         $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
 507                 }
 508
 509                 return $html;
 510         }
 511
 512         /**
 513          * Get the submit and (potentially) reset buttons.
 514          * @return String HTML.
 515          */
 516         function getButtons() {
 517                 $html = '';
 518                 $attribs = array();
 519
 520                 if ( isset( $this->mSubmitID ) ) {
 521                         $attribs['id'] = $this->mSubmitID;
 522                 }
 523
 524                 if ( isset( $this->mSubmitName ) ) {
 525                         $attribs['name'] = $this->mSubmitName;
 526                 }
 527
 528                 if ( isset( $this->mSubmitTooltip ) ) {
 529                         $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
 530                 }
 531
 532                 $attribs['class'] = 'mw-htmlform-submit';
 533
 534                 $html .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
 535
 536                 if ( $this->mShowReset ) {
 537                         $html .= Html::element(
 538                                 'input',
 539                                 array(
 540                                         'type' => 'reset',
 541                                         'value' => wfMsg( 'htmlform-reset' )
 542                                 )
 543                         ) . "\n";
 544                 }
 545
 546                 foreach ( $this->mButtons as $button ) {
 547                         $attrs = array(
 548                                 'type'  => 'submit',
 549                                 'name'  => $button['name'],
 550                                 'value' => $button['value']
 551                         );
 552
 553                         if ( $button['attribs'] ) {
 554                                 $attrs += $button['attribs'];
 555                         }
 556
 557                         if ( isset( $button['id'] ) ) {
 558                                 $attrs['id'] = $button['id'];
 559                         }
 560
 561                         $html .= Html::element( 'input', $attrs );
 562                 }
 563
 564                 return $html;
 565         }
 566
 567         /**
 568          * Get the whole body of the form.
 569          * @return String
 570          */
 571         function getBody() {
 572                 return $this->displaySection( $this->mFieldTree );
 573         }
 574
 575         /**
 576          * Format and display an error message stack.
 577          * @param $errors String|Array|Status
 578          * @return String
 579          */
 580         function getErrors( $errors ) {
 581                 if ( $errors instanceof Status ) {
 582                         if ( $errors->isOK() ) {
 583                                 $errorstr = '';
 584                         } else {
 585                                 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
 586                         }
 587                 } elseif ( is_array( $errors ) ) {
 588                         $errorstr = $this->formatErrors( $errors );
 589                 } else {
 590                         $errorstr = $errors;
 591                 }
 592
 593                 return $errorstr
 594                         ? Html::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
 595                         : '';
 596         }
 597
 598         /**
 599          * Format a stack of error messages into a single HTML string
 600          * @param $errors Array of message keys/values
 601          * @return String HTML, a <ul> list of errors
 602          */
 603         public static function formatErrors( $errors ) {
 604                 $errorstr = '';
 605
 606                 foreach ( $errors as $error ) {
 607                         if ( is_array( $error ) ) {
 608                                 $msg = array_shift( $error );
 609                         } else {
 610                                 $msg = $error;
 611                                 $error = array();
 612                         }
 613
 614                         $errorstr .= Html::rawElement(
 615                                 'li',
 616                                 array(),
 617                                 wfMsgExt( $msg, array( 'parseinline' ), $error )
 618                         );
 619                 }
 620
 621                 $errorstr = Html::rawElement( 'ul', array(), $errorstr );
 622
 623                 return $errorstr;
 624         }
 625
 626         /**
 627          * Set the text for the submit button
 628          * @param $t String plaintext.
 629          */
 630         function setSubmitText( $t ) {
 631                 $this->mSubmitText = $t;
 632         }
 633
 634         /**
 635          * Set the text for the submit button to a message
 636          * @since 1.19
 637          * @param $msg String message key
 638          */
 639         public function setSubmitTextMsg( $msg ) {
 640                 return $this->setSubmitText( $this->msg( $msg )->escaped() );
 641         }
 642
 643         /**
 644          * Get the text for the submit button, either customised or a default.
 645          * @return unknown_type
 646          */
 647         function getSubmitText() {
 648                 return $this->mSubmitText
 649                         ? $this->mSubmitText
 650                         : wfMsg( 'htmlform-submit' );
 651         }
 652
 653         public function setSubmitName( $name ) {
 654                 $this->mSubmitName = $name;
 655         }
 656
 657         public function setSubmitTooltip( $name ) {
 658                 $this->mSubmitTooltip = $name;
 659         }
 660
 661         /**
 662          * Set the id for the submit button.
 663          * @param $t String.
 664          * @todo FIXME: Integrity of $t is *not* validated
 665          */
 666         function setSubmitID( $t ) {
 667                 $this->mSubmitID = $t;
 668         }
 669
 670         public function setId( $id ) {
 671                 $this->mId = $id;
 672         }
 673         /**
 674          * Prompt the whole form to be wrapped in a <fieldset>, with
 675          * this text as its <legend> element.
 676          * @param $legend String HTML to go inside the <legend> element.
 677          *       Will be escaped
 678          */
 679         public function setWrapperLegend( $legend ) { $this->mWrapperLegend = $legend; }
 680
 681         /**
 682          * Prompt the whole form to be wrapped in a <fieldset>, with
 683          * this message as its <legend> element.
 684          * @since 1.19
 685          * @param $msg String message key
 686          */
 687         public function setWrapperLegendMsg( $msg ) {
 688                 return $this->setWrapperLegend( $this->msg( $msg )->escaped() );
 689         }
 690
 691         /**
 692          * Set the prefix for various default messages
 693          * TODO: currently only used for the <fieldset> legend on forms
 694          * with multiple sections; should be used elsewhre?
 695          * @param $p String
 696          */
 697         function setMessagePrefix( $p ) {
 698                 $this->mMessagePrefix = $p;
 699         }
 700
 701         /**
 702          * Set the title for form submission
 703          * @param $t Title of page the form is on/should be posted to
 704          */
 705         function setTitle( $t ) {
 706                 $this->mTitle = $t;
 707         }
 708
 709         /**
 710          * Get the title
 711          * @return Title
 712          */
 713         function getTitle() {
 714                 return $this->mTitle === false
 715                         ? $this->getContext()->getTitle()
 716                         : $this->mTitle;
 717         }
 718
 719         /**
 720          * Set the method used to submit the form
 721          * @param $method String
 722          */
 723         public function setMethod( $method='post' ){
 724                 $this->mMethod = $method;
 725         }
 726
 727         public function getMethod(){
 728                 return $this->mMethod;
 729         }
 730
 731         /**
 732          * TODO: Document
 733          * @param $fields array[]|HTMLFormField[] array of fields (either arrays or objects)
 734          * @param $sectionName string ID attribute of the <table> tag for this section, ignored if empty
 735          * @param $fieldsetIDPrefix string ID prefix for the <fieldset> tag of each subsection, ignored if empty
 736          * @return String
 737          */
 738         function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) {
 739                 $tableHtml = '';
 740                 $subsectionHtml = '';
 741                 $hasLeftColumn = false;
 742
 743                 foreach ( $fields as $key => $value ) {
 744                         if ( is_object( $value ) ) {
 745                                 $v = empty( $value->mParams['nodata'] )
 746                                         ? $this->mFieldData[$key]
 747                                         : $value->getDefault();
 748                                 $tableHtml .= $value->getTableRow( $v );
 749
 750                                 if ( $value->getLabel() != '&#160;' ) {
 751                                         $hasLeftColumn = true;
 752                                 }
 753                         } elseif ( is_array( $value ) ) {
 754                                 $section = $this->displaySection( $value, $key );
 755                                 $legend = $this->getLegend( $key );
 756                                 if ( isset( $this->mSectionHeaders[$key] ) ) {
 757                                         $section = $this->mSectionHeaders[$key] . $section;
 758                                 }
 759                                 if ( isset( $this->mSectionFooters[$key] ) ) {
 760                                         $section .= $this->mSectionFooters[$key];
 761                                 }
 762                                 $attributes = array();
 763                                 if ( $fieldsetIDPrefix ) {
 764                                         $attributes['id'] = Sanitizer::escapeId( "$fieldsetIDPrefix$key" );
 765                                 }
 766                                 $subsectionHtml .= Xml::fieldset( $legend, $section, $attributes ) . "\n";
 767                         }
 768                 }
 769
 770                 $classes = array();
 771
 772                 if ( !$hasLeftColumn ) { // Avoid strange spacing when no labels exist
 773                         $classes[] = 'mw-htmlform-nolabel';
 774                 }
 775
 776                 $attribs = array(
 777                         'class' => implode( ' ', $classes ),
 778                 );
 779
 780                 if ( $sectionName ) {
 781                         $attribs['id'] = Sanitizer::escapeId( "mw-htmlform-$sectionName" );
 782                 }
 783
 784                 $tableHtml = Html::rawElement( 'table', $attribs,
 785                         Html::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n";
 786
 787                 if ( $this->mSubSectionBeforeFields ) {
 788                         return $subsectionHtml . "\n" . $tableHtml;
 789                 } else {
 790                         return $tableHtml . "\n" . $subsectionHtml;
 791                 }
 792         }
 793
 794         /**
 795          * Construct the form fields from the Descriptor array
 796          */
 797         function loadData() {
 798                 $fieldData = array();
 799
 800                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 801                         if ( !empty( $field->mParams['nodata'] ) ) {
 802                                 continue;
 803                         } elseif ( !empty( $field->mParams['disabled'] ) ) {
 804                                 $fieldData[$fieldname] = $field->getDefault();
 805                         } else {
 806                                 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
 807                         }
 808                 }
 809
 810                 # Filter data.
 811                 foreach ( $fieldData as $name => &$value ) {
 812                         $field = $this->mFlatFields[$name];
 813                         $value = $field->filter( $value, $this->mFlatFields );
 814                 }
 815
 816                 $this->mFieldData = $fieldData;
 817         }
 818
 819         /**
 820          * Stop a reset button being shown for this form
 821          * @param $suppressReset Bool set to false to re-enable the
 822          *       button again
 823          */
 824         function suppressReset( $suppressReset = true ) {
 825                 $this->mShowReset = !$suppressReset;
 826         }
 827
 828         /**
 829          * Overload this if you want to apply special filtration routines
 830          * to the form as a whole, after it's submitted but before it's
 831          * processed.
 832          * @param $data
 833          * @return unknown_type
 834          */
 835         function filterDataForSubmit( $data ) {
 836                 return $data;
 837         }
 838
 839         /**
 840          * Get a string to go in the <legend> of a section fieldset.  Override this if you
 841          * want something more complicated
 842          * @param $key String
 843          * @return String
 844          */
 845         public function getLegend( $key ) {
 846                 return wfMsg( "{$this->mMessagePrefix}-$key" );
 847         }
 848 }
 849
 850 /**
 851  * The parent class to generate form fields.  Any field type should
 852  * be a subclass of this.
 853  */
 854 abstract class HTMLFormField {
 855
 856         protected $mValidationCallback;
 857         protected $mFilterCallback;
 858         protected $mName;
 859         public $mParams;
 860         protected $mLabel;      # String label.  Set on construction
 861         protected $mID;
 862         protected $mClass = '';
 863         protected $mDefault;
 864
 865         /**
 866          * @var HTMLForm
 867          */
 868         public $mParent;
 869
 870         /**
 871          * This function must be implemented to return the HTML to generate
 872          * the input object itself.  It should not implement the surrounding
 873          * table cells/rows, or labels/help messages.
 874          * @param $value String the value to set the input to; eg a default
 875          *       text for a text input.
 876          * @return String valid HTML.
 877          */
 878         abstract function getInputHTML( $value );
 879
 880         /**
 881          * Override this function to add specific validation checks on the
 882          * field input.  Don't forget to call parent::validate() to ensure
 883          * that the user-defined callback mValidationCallback is still run
 884          * @param $value String the value the field was submitted with
 885          * @param $alldata Array the data collected from the form
 886          * @return Mixed Bool true on success, or String error to display.
 887          */
 888         function validate( $value, $alldata ) {
 889                 if ( isset( $this->mParams['required'] ) && $value === '' ) {
 890                         return wfMsgExt( 'htmlform-required', 'parseinline' );
 891                 }
 892
 893                 if ( isset( $this->mValidationCallback ) ) {
 894                         return call_user_func( $this->mValidationCallback, $value, $alldata, $this->mParent );
 895                 }
 896
 897                 return true;
 898         }
 899
 900         function filter( $value, $alldata ) {
 901                 if ( isset( $this->mFilterCallback ) ) {
 902                         $value = call_user_func( $this->mFilterCallback, $value, $alldata, $this->mParent );
 903                 }
 904
 905                 return $value;
 906         }
 907
 908         /**
 909          * Should this field have a label, or is there no input element with the
 910          * appropriate id for the label to point to?
 911          *
 912          * @return bool True to output a label, false to suppress
 913          */
 914         protected function needsLabel() {
 915                 return true;
 916         }
 917
 918         /**
 919          * Get the value that this input has been set to from a posted form,
 920          * or the input's default value if it has not been set.
 921          * @param $request WebRequest
 922          * @return String the value
 923          */
 924         function loadDataFromRequest( $request ) {
 925                 if ( $request->getCheck( $this->mName ) ) {
 926                         return $request->getText( $this->mName );
 927                 } else {
 928                         return $this->getDefault();
 929                 }
 930         }
 931
 932         /**
 933          * Initialise the object
 934          * @param $params array Associative Array. See HTMLForm doc for syntax.
 935          */
 936         function __construct( $params ) {
 937                 $this->mParams = $params;
 938
 939                 # Generate the label from a message, if possible
 940                 if ( isset( $params['label-message'] ) ) {
 941                         $msgInfo = $params['label-message'];
 942
 943                         if ( is_array( $msgInfo ) ) {
 944                                 $msg = array_shift( $msgInfo );
 945                         } else {
 946                                 $msg = $msgInfo;
 947                                 $msgInfo = array();
 948                         }
 949
 950                         $this->mLabel = wfMsgExt( $msg, 'parseinline', $msgInfo );
 951                 } elseif ( isset( $params['label'] ) ) {
 952                         $this->mLabel = $params['label'];
 953                 }
 954
 955                 $this->mName = "wp{$params['fieldname']}";
 956                 if ( isset( $params['name'] ) ) {
 957                         $this->mName = $params['name'];
 958                 }
 959
 960                 $validName = Sanitizer::escapeId( $this->mName );
 961                 if ( $this->mName != $validName && !isset( $params['nodata'] ) ) {
 962                         throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__ );
 963                 }
 964
 965                 $this->mID = "mw-input-{$this->mName}";
 966
 967                 if ( isset( $params['default'] ) ) {
 968                         $this->mDefault = $params['default'];
 969                 }
 970
 971                 if ( isset( $params['id'] ) ) {
 972                         $id = $params['id'];
 973                         $validId = Sanitizer::escapeId( $id );
 974
 975                         if ( $id != $validId ) {
 976                                 throw new MWException( "Invalid id '$id' passed to " . __METHOD__ );
 977                         }
 978
 979                         $this->mID = $id;
 980                 }
 981
 982                 if ( isset( $params['cssclass'] ) ) {
 983                         $this->mClass = $params['cssclass'];
 984                 }
 985
 986                 if ( isset( $params['validation-callback'] ) ) {
 987                         $this->mValidationCallback = $params['validation-callback'];
 988                 }
 989
 990                 if ( isset( $params['filter-callback'] ) ) {
 991                         $this->mFilterCallback = $params['filter-callback'];
 992                 }
 993         }
 994
 995         /**
 996          * Get the complete table row for the input, including help text,
 997          * labels, and whatever.
 998          * @param $value String the value to set the input to.
 999          * @return String complete HTML table row.
1000          */
1001         function getTableRow( $value ) {
1002                 # Check for invalid data.
1003
1004                 $errors = $this->validate( $value, $this->mParent->mFieldData );
1005
1006                 $cellAttributes = array();
1007                 $verticalLabel = false;
1008
1009                 if ( !empty($this->mParams['vertical-label']) ) {
1010                         $cellAttributes['colspan'] = 2;
1011                         $verticalLabel = true;
1012                 }
1013
1014                 if ( $errors === true || ( !$this->mParent->getRequest()->wasPosted() && ( $this->mParent->getMethod() == 'post' ) ) ) {
1015                         $errors = '';
1016                         $errorClass = '';
1017                 } else {
1018                         $errors = self::formatErrors( $errors );
1019                         $errorClass = 'mw-htmlform-invalid-input';
1020                 }
1021
1022                 $label = $this->getLabelHtml( $cellAttributes );
1023                 $field = Html::rawElement(
1024                         'td',
1025                         array( 'class' => 'mw-input' ) + $cellAttributes,
1026                         $this->getInputHTML( $value ) . "\n$errors"
1027                 );
1028
1029                 $fieldType = get_class( $this );
1030
1031                 if ( $verticalLabel ) {
1032                         $html = Html::rawElement( 'tr',
1033                                 array( 'class' => 'mw-htmlform-vertical-label' ), $label );
1034                         $html .= Html::rawElement( 'tr',
1035                                 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
1036                                 $field );
1037                 } else {
1038                         $html = Html::rawElement( 'tr',
1039                                 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
1040                                 $label . $field );
1041                 }
1042
1043                 $helptext = null;
1044
1045                 if ( isset( $this->mParams['help-message'] ) ) {
1046                         $msg = wfMessage( $this->mParams['help-message'] );
1047                         if ( $msg->exists() ) {
1048                                 $helptext = $msg->parse();
1049                         }
1050                 } elseif ( isset( $this->mParams['help-messages'] ) ) {
1051                         # help-message can be passed a message key (string) or an array containing
1052                         # a message key and additional parameters. This makes it impossible to pass
1053                         # an array of message key
1054                         foreach( $this->mParams['help-messages'] as $name ) {
1055                                 $msg = wfMessage( $name );
1056                                 if( $msg->exists() ) {
1057                                         $helptext .= $msg->parse(); // append message
1058                                 }
1059                         }
1060                 } elseif ( isset( $this->mParams['help'] ) ) {
1061                         $helptext = $this->mParams['help'];
1062                 }
1063
1064                 if ( !is_null( $helptext ) ) {
1065                         $row = Html::rawElement( 'td', array( 'colspan' => 2, 'class' => 'htmlform-tip' ),
1066                                 $helptext );
1067                         $row = Html::rawElement( 'tr', array(), $row );
1068                         $html .= "$row\n";
1069                 }
1070
1071                 return $html;
1072         }
1073
1074         function getLabel() {
1075                 return $this->mLabel;
1076         }
1077         function getLabelHtml( $cellAttributes = array() ) {
1078                 # Don't output a for= attribute for labels with no associated input.
1079                 # Kind of hacky here, possibly we don't want these to be <label>s at all.
1080                 $for = array();
1081
1082                 if ( $this->needsLabel() ) {
1083                         $for['for'] = $this->mID;
1084                 }
1085
1086                 return Html::rawElement( 'td', array( 'class' => 'mw-label' ) + $cellAttributes,
1087                         Html::rawElement( 'label', $for, $this->getLabel() )
1088                 );
1089         }
1090
1091         function getDefault() {
1092                 if ( isset( $this->mDefault ) ) {
1093                         return $this->mDefault;
1094                 } else {
1095                         return null;
1096                 }
1097         }
1098
1099         /**
1100          * Returns the attributes required for the tooltip and accesskey.
1101          *
1102          * @return array Attributes
1103          */
1104         public function getTooltipAndAccessKey() {
1105                 if ( empty( $this->mParams['tooltip'] ) ) {
1106                         return array();
1107                 }
1108                 return Linker::tooltipAndAccesskeyAttribs( $this->mParams['tooltip'] );
1109         }
1110
1111         /**
1112          * flatten an array of options to a single array, for instance,
1113          * a set of <options> inside <optgroups>.
1114          * @param $options Associative Array with values either Strings
1115          *       or Arrays
1116          * @return Array flattened input
1117          */
1118         public static function flattenOptions( $options ) {
1119                 $flatOpts = array();
1120
1121                 foreach ( $options as $value ) {
1122                         if ( is_array( $value ) ) {
1123                                 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1124                         } else {
1125                                 $flatOpts[] = $value;
1126                         }
1127                 }
1128
1129                 return $flatOpts;
1130         }
1131
1132         /**
1133          * Formats one or more errors as accepted by field validation-callback.
1134          * @param $errors String|Message|Array of strings or Message instances
1135          * @return String html
1136          * @since 1.18
1137          */
1138         protected static function formatErrors( $errors ) {
1139                 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1140                         $errors = array_shift( $errors );
1141                 }
1142
1143                 if ( is_array( $errors ) ) {
1144                         $lines = array();
1145                         foreach ( $errors as $error ) {
1146                                 if ( $error instanceof Message ) {
1147                                         $lines[] = Html::rawElement( 'li', array(), $error->parse() );
1148                                 } else {
1149                                         $lines[] = Html::rawElement( 'li', array(), $error );
1150                                 }
1151                         }
1152                         return Html::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1153                 } else {
1154                         if ( $errors instanceof Message ) {
1155                                 $errors = $errors->parse();
1156                         }
1157                         return Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
1158                 }
1159         }
1160 }
1161
1162 class HTMLTextField extends HTMLFormField {
1163         function getSize() {
1164                 return isset( $this->mParams['size'] )
1165                         ? $this->mParams['size']
1166                         : 45;
1167         }
1168
1169         function getInputHTML( $value ) {
1170                 $attribs = array(
1171                         'id' => $this->mID,
1172                         'name' => $this->mName,
1173                         'size' => $this->getSize(),
1174                         'value' => $value,
1175                 ) + $this->getTooltipAndAccessKey();
1176
1177                 if ( isset( $this->mParams['maxlength'] ) ) {
1178                         $attribs['maxlength'] = $this->mParams['maxlength'];
1179                 }
1180
1181                 if ( !empty( $this->mParams['disabled'] ) ) {
1182                         $attribs['disabled'] = 'disabled';
1183                 }
1184
1185                 # TODO: Enforce pattern, step, required, readonly on the server side as
1186                 # well
1187                 foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
1188                 'placeholder' ) as $param ) {
1189                         if ( isset( $this->mParams[$param] ) ) {
1190                                 $attribs[$param] = $this->mParams[$param];
1191                         }
1192                 }
1193
1194                 foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as $param ) {
1195                         if ( isset( $this->mParams[$param] ) ) {
1196                                 $attribs[$param] = '';
1197                         }
1198                 }
1199
1200                 # Implement tiny differences between some field variants
1201                 # here, rather than creating a new class for each one which
1202                 # is essentially just a clone of this one.
1203                 if ( isset( $this->mParams['type'] ) ) {
1204                         switch ( $this->mParams['type'] ) {
1205                                 case 'email':
1206                                         $attribs['type'] = 'email';
1207                                         break;
1208                                 case 'int':
1209                                         $attribs['type'] = 'number';
1210                                         break;
1211                                 case 'float':
1212                                         $attribs['type'] = 'number';
1213                                         $attribs['step'] = 'any';
1214                                         break;
1215                                 # Pass through
1216                                 case 'password':
1217                                 case 'file':
1218                                         $attribs['type'] = $this->mParams['type'];
1219                                         break;
1220                         }
1221                 }
1222
1223                 return Html::element( 'input', $attribs );
1224         }
1225 }
1226 class HTMLTextAreaField extends HTMLFormField {
1227         function getCols() {
1228                 return isset( $this->mParams['cols'] )
1229                         ? $this->mParams['cols']
1230                         : 80;
1231         }
1232
1233         function getRows() {
1234                 return isset( $this->mParams['rows'] )
1235                         ? $this->mParams['rows']
1236                         : 25;
1237         }
1238
1239         function getInputHTML( $value ) {
1240                 $attribs = array(
1241                         'id' => $this->mID,
1242                         'name' => $this->mName,
1243                         'cols' => $this->getCols(),
1244                         'rows' => $this->getRows(),
1245                 ) + $this->getTooltipAndAccessKey();
1246
1247
1248                 if ( !empty( $this->mParams['disabled'] ) ) {
1249                         $attribs['disabled'] = 'disabled';
1250                 }
1251
1252                 if ( !empty( $this->mParams['readonly'] ) ) {
1253                         $attribs['readonly'] = 'readonly';
1254                 }
1255
1256                 foreach ( array( 'required', 'autofocus' ) as $param ) {
1257                         if ( isset( $this->mParams[$param] ) ) {
1258                                 $attribs[$param] = '';
1259                         }
1260                 }
1261
1262                 return Html::element( 'textarea', $attribs, $value );
1263         }
1264 }
1265
1266 /**
1267  * A field that will contain a numeric value
1268  */
1269 class HTMLFloatField extends HTMLTextField {
1270         function getSize() {
1271                 return isset( $this->mParams['size'] )
1272                         ? $this->mParams['size']
1273                         : 20;
1274         }
1275
1276         function validate( $value, $alldata ) {
1277                 $p = parent::validate( $value, $alldata );
1278
1279                 if ( $p !== true ) {
1280                         return $p;
1281                 }
1282
1283                 $value = trim( $value );
1284
1285                 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#real-numbers
1286                 # with the addition that a leading '+' sign is ok.
1287                 if ( !preg_match( '/^((\+|\-)?\d+(\.\d+)?(E(\+|\-)?\d+)?)?$/i', $value ) ) {
1288                         return wfMsgExt( 'htmlform-float-invalid', 'parse' );
1289                 }
1290
1291                 # The "int" part of these message names is rather confusing.
1292                 # They make equal sense for all numbers.
1293                 if ( isset( $this->mParams['min'] ) ) {
1294                         $min = $this->mParams['min'];
1295
1296                         if ( $min > $value ) {
1297                                 return wfMsgExt( 'htmlform-int-toolow', 'parse', array( $min ) );
1298                         }
1299                 }
1300
1301                 if ( isset( $this->mParams['max'] ) ) {
1302                         $max = $this->mParams['max'];
1303
1304                         if ( $max < $value ) {
1305                                 return wfMsgExt( 'htmlform-int-toohigh', 'parse', array( $max ) );
1306                         }
1307                 }
1308
1309                 return true;
1310         }
1311 }
1312
1313 /**
1314  * A field that must contain a number
1315  */
1316 class HTMLIntField extends HTMLFloatField {
1317         function validate( $value, $alldata ) {
1318                 $p = parent::validate( $value, $alldata );
1319
1320                 if ( $p !== true ) {
1321                         return $p;
1322                 }
1323
1324                 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#signed-integers
1325                 # with the addition that a leading '+' sign is ok. Note that leading zeros
1326                 # are fine, and will be left in the input, which is useful for things like
1327                 # phone numbers when you know that they are integers (the HTML5 type=tel
1328                 # input does not require its value to be numeric).  If you want a tidier
1329                 # value to, eg, save in the DB, clean it up with intval().
1330                 if ( !preg_match( '/^((\+|\-)?\d+)?$/', trim( $value ) )
1331                 ) {
1332                         return wfMsgExt( 'htmlform-int-invalid', 'parse' );
1333                 }
1334
1335                 return true;
1336         }
1337 }
1338
1339 /**
1340  * A checkbox field
1341  */
1342 class HTMLCheckField extends HTMLFormField {
1343         function getInputHTML( $value ) {
1344                 if ( !empty( $this->mParams['invert'] ) ) {
1345                         $value = !$value;
1346                 }
1347
1348                 $attr = $this->getTooltipAndAccessKey();
1349                 $attr['id'] = $this->mID;
1350
1351                 if ( !empty( $this->mParams['disabled'] ) ) {
1352                         $attr['disabled'] = 'disabled';
1353                 }
1354
1355                 return Xml::check( $this->mName, $value, $attr ) . '&#160;' .
1356                         Html::rawElement( 'label', array( 'for' => $this->mID ), $this->mLabel );
1357         }
1358
1359         /**
1360          * For a checkbox, the label goes on the right hand side, and is
1361          * added in getInputHTML(), rather than HTMLFormField::getRow()
1362          * @return String
1363          */
1364         function getLabel() {
1365                 return '&#160;';
1366         }
1367
1368         /**
1369          * @param  $request WebRequest
1370          * @return String
1371          */
1372         function loadDataFromRequest( $request ) {
1373                 $invert = false;
1374                 if ( isset( $this->mParams['invert'] ) && $this->mParams['invert'] ) {
1375                         $invert = true;
1376                 }
1377
1378                 // GetCheck won't work like we want for checks.
1379                 // Fetch the value in either one of the two following case:
1380                 // - we have a valid token (form got posted or GET forged by the user)
1381                 // - checkbox name has a value (false or true), ie is not null
1382                 if ( $request->getCheck( 'wpEditToken' ) || $request->getVal( $this->mName )!== null ) {
1383                         // XOR has the following truth table, which is what we want
1384                         // INVERT VALUE | OUTPUT
1385                         // true   true  | false
1386                         // false  true  | true
1387                         // false  false | false
1388                         // true   false | true
1389                         return $request->getBool( $this->mName ) xor $invert;
1390                 } else {
1391                         return $this->getDefault();
1392                 }
1393         }
1394 }
1395
1396 /**
1397  * A select dropdown field.  Basically a wrapper for Xmlselect class
1398  */
1399 class HTMLSelectField extends HTMLFormField {
1400         function validate( $value, $alldata ) {
1401                 $p = parent::validate( $value, $alldata );
1402
1403                 if ( $p !== true ) {
1404                         return $p;
1405                 }
1406
1407                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1408
1409                 if ( in_array( $value, $validOptions ) )
1410                         return true;
1411                 else
1412                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1413         }
1414
1415         function getInputHTML( $value ) {
1416                 $select = new XmlSelect( $this->mName, $this->mID, strval( $value ) );
1417
1418                 # If one of the options' 'name' is int(0), it is automatically selected.
1419                 # because PHP sucks and thinks int(0) == 'some string'.
1420                 # Working around this by forcing all of them to strings.
1421                 foreach( $this->mParams['options'] as &$opt ){
1422                         if( is_int( $opt ) ){
1423                                 $opt = strval( $opt );
1424                         }
1425                 }
1426                 unset( $opt ); # PHP keeps $opt around as a reference, which is a bit scary
1427
1428                 if ( !empty( $this->mParams['disabled'] ) ) {
1429                         $select->setAttribute( 'disabled', 'disabled' );
1430                 }
1431
1432                 $select->addOptions( $this->mParams['options'] );
1433
1434                 return $select->getHTML();
1435         }
1436 }
1437
1438 /**
1439  * Select dropdown field, with an additional "other" textbox.
1440  */
1441 class HTMLSelectOrOtherField extends HTMLTextField {
1442         static $jsAdded = false;
1443
1444         function __construct( $params ) {
1445                 if ( !in_array( 'other', $params['options'], true ) ) {
1446                         $msg = isset( $params['other'] ) ? $params['other'] : wfMsg( 'htmlform-selectorother-other' );
1447                         $params['options'][$msg] = 'other';
1448                 }
1449
1450                 parent::__construct( $params );
1451         }
1452
1453         static function forceToStringRecursive( $array ) {
1454                 if ( is_array( $array ) ) {
1455                         return array_map( array( __CLASS__, 'forceToStringRecursive' ), $array );
1456                 } else {
1457                         return strval( $array );
1458                 }
1459         }
1460
1461         function getInputHTML( $value ) {
1462                 $valInSelect = false;
1463
1464                 if ( $value !== false ) {
1465                         $valInSelect = in_array(
1466                                 $value,
1467                                 HTMLFormField::flattenOptions( $this->mParams['options'] )
1468                         );
1469                 }
1470
1471                 $selected = $valInSelect ? $value : 'other';
1472
1473                 $opts = self::forceToStringRecursive( $this->mParams['options'] );
1474
1475                 $select = new XmlSelect( $this->mName, $this->mID, $selected );
1476                 $select->addOptions( $opts );
1477
1478                 $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
1479
1480                 $tbAttribs = array( 'id' => $this->mID . '-other', 'size' => $this->getSize() );
1481
1482                 if ( !empty( $this->mParams['disabled'] ) ) {
1483                         $select->setAttribute( 'disabled', 'disabled' );
1484                         $tbAttribs['disabled'] = 'disabled';
1485                 }
1486
1487                 $select = $select->getHTML();
1488
1489                 if ( isset( $this->mParams['maxlength'] ) ) {
1490                         $tbAttribs['maxlength'] = $this->mParams['maxlength'];
1491                 }
1492
1493                 $textbox = Html::input(
1494                         $this->mName . '-other',
1495                         $valInSelect ? '' : $value,
1496                         'text',
1497                         $tbAttribs
1498                 );
1499
1500                 return "$select<br />\n$textbox";
1501         }
1502
1503         /**
1504          * @param  $request WebRequest
1505          * @return String
1506          */
1507         function loadDataFromRequest( $request ) {
1508                 if ( $request->getCheck( $this->mName ) ) {
1509                         $val = $request->getText( $this->mName );
1510
1511                         if ( $val == 'other' ) {
1512                                 $val = $request->getText( $this->mName . '-other' );
1513                         }
1514
1515                         return $val;
1516                 } else {
1517                         return $this->getDefault();
1518                 }
1519         }
1520 }
1521
1522 /**
1523  * Multi-select field
1524  */
1525 class HTMLMultiSelectField extends HTMLFormField {
1526
1527         public function __construct( $params ){
1528                 parent::__construct( $params );
1529                 if( isset( $params['flatlist'] ) ){
1530                         $this->mClass .= ' mw-htmlform-multiselect-flatlist';
1531                 }
1532         }
1533
1534         function validate( $value, $alldata ) {
1535                 $p = parent::validate( $value, $alldata );
1536
1537                 if ( $p !== true ) {
1538                         return $p;
1539                 }
1540
1541                 if ( !is_array( $value ) ) {
1542                         return false;
1543                 }
1544
1545                 # If all options are valid, array_intersect of the valid options
1546                 # and the provided options will return the provided options.
1547                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1548
1549                 $validValues = array_intersect( $value, $validOptions );
1550                 if ( count( $validValues ) == count( $value ) ) {
1551                         return true;
1552                 } else {
1553                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1554                 }
1555         }
1556
1557         function getInputHTML( $value ) {
1558                 $html = $this->formatOptions( $this->mParams['options'], $value );
1559
1560                 return $html;
1561         }
1562
1563         function formatOptions( $options, $value ) {
1564                 $html = '';
1565
1566                 $attribs = array();
1567
1568                 if ( !empty( $this->mParams['disabled'] ) ) {
1569                         $attribs['disabled'] = 'disabled';
1570                 }
1571
1572                 foreach ( $options as $label => $info ) {
1573                         if ( is_array( $info ) ) {
1574                                 $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
1575                                 $html .= $this->formatOptions( $info, $value );
1576                         } else {
1577                                 $thisAttribs = array( 'id' => "{$this->mID}-$info", 'value' => $info );
1578
1579                                 $checkbox = Xml::check(
1580                                         $this->mName . '[]',
1581                                         in_array( $info, $value, true ),
1582                                         $attribs + $thisAttribs );
1583                                 $checkbox .= '&#160;' . Html::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label );
1584
1585                                 $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-multiselect-item' ), $checkbox );
1586                         }
1587                 }
1588
1589                 return $html;
1590         }
1591
1592         /**
1593          * @param  $request WebRequest
1594          * @return String
1595          */
1596         function loadDataFromRequest( $request ) {
1597                 if ( $this->mParent->getMethod() == 'post' ) {
1598                         if( $request->wasPosted() ){
1599                                 # Checkboxes are just not added to the request arrays if they're not checked,
1600                                 # so it's perfectly possible for there not to be an entry at all
1601                                 return $request->getArray( $this->mName, array() );
1602                         } else {
1603                                 # That's ok, the user has not yet submitted the form, so show the defaults
1604                                 return $this->getDefault();
1605                         }
1606                 } else {
1607                         # This is the impossible case: if we look at $_GET and see no data for our
1608                         # field, is it because the user has not yet submitted the form, or that they
1609                         # have submitted it with all the options unchecked? We will have to assume the
1610                         # latter, which basically means that you can't specify 'positive' defaults
1611                         # for GET forms.
1612                         # @todo FIXME...
1613                         return $request->getArray( $this->mName, array() );
1614                 }
1615         }
1616
1617         function getDefault() {
1618                 if ( isset( $this->mDefault ) ) {
1619                         return $this->mDefault;
1620                 } else {
1621                         return array();
1622                 }
1623         }
1624
1625         protected function needsLabel() {
1626                 return false;
1627         }
1628 }
1629
1630 /**
1631  * Double field with a dropdown list constructed from a system message in the format
1632  *     * Optgroup header
1633  *     ** <option value>
1634  *     * New Optgroup header
1635  * Plus a text field underneath for an additional reason.  The 'value' of the field is
1636  * ""<select>: <extra reason>"", or "<extra reason>" if nothing has been selected in the
1637  * select dropdown.
1638  * @todo FIXME: If made 'required', only the text field should be compulsory.
1639  */
1640 class HTMLSelectAndOtherField extends HTMLSelectField {
1641
1642         function __construct( $params ) {
1643                 if ( array_key_exists( 'other', $params ) ) {
1644                 } elseif( array_key_exists( 'other-message', $params ) ){
1645                         $params['other'] = wfMessage( $params['other-message'] )->plain();
1646                 } else {
1647                         $params['other'] = null;
1648                 }
1649
1650                 if ( array_key_exists( 'options', $params ) ) {
1651                         # Options array already specified
1652                 } elseif( array_key_exists( 'options-message', $params ) ){
1653                         # Generate options array from a system message
1654                         $params['options'] = self::parseMessage(
1655                                 wfMessage( $params['options-message'] )->inContentLanguage()->plain(),
1656                                 $params['other']
1657                         );
1658                 } else {
1659                         # Sulk
1660                         throw new MWException( 'HTMLSelectAndOtherField called without any options' );
1661                 }
1662                 $this->mFlatOptions = self::flattenOptions( $params['options'] );
1663
1664                 parent::__construct( $params );
1665         }
1666
1667         /**
1668          * Build a drop-down box from a textual list.
1669          * @param $string String message text
1670          * @param $otherName String name of "other reason" option
1671          * @return Array
1672          * TODO: this is copied from Xml::listDropDown(), deprecate/avoid duplication?
1673          */
1674         public static function parseMessage( $string, $otherName=null ) {
1675                 if( $otherName === null ){
1676                         $otherName = wfMessage( 'htmlform-selectorother-other' )->plain();
1677                 }
1678
1679                 $optgroup = false;
1680                 $options = array( $otherName => 'other' );
1681
1682                 foreach ( explode( "\n", $string ) as $option ) {
1683                         $value = trim( $option );
1684                         if ( $value == '' ) {
1685                                 continue;
1686                         } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
1687                                 # A new group is starting...
1688                                 $value = trim( substr( $value, 1 ) );
1689                                 $optgroup = $value;
1690                         } elseif ( substr( $value, 0, 2) == '**' ) {
1691                                 # groupmember
1692                                 $opt = trim( substr( $value, 2 ) );
1693                                 if( $optgroup === false ){
1694                                         $options[$opt] = $opt;
1695                                 } else {
1696                                         $options[$optgroup][$opt] = $opt;
1697                                 }
1698                         } else {
1699                                 # groupless reason list
1700                                 $optgroup = false;
1701                                 $options[$option] = $option;
1702                         }
1703                 }
1704
1705                 return $options;
1706         }
1707
1708         function getInputHTML( $value ) {
1709                 $select = parent::getInputHTML( $value[1] );
1710
1711                 $textAttribs = array(
1712                         'id' => $this->mID . '-other',
1713                         'size' => $this->getSize(),
1714                 );
1715
1716                 foreach ( array( 'required', 'autofocus', 'multiple', 'disabled' ) as $param ) {
1717                         if ( isset( $this->mParams[$param] ) ) {
1718                                 $textAttribs[$param] = '';
1719                         }
1720                 }
1721
1722                 $textbox = Html::input(
1723                         $this->mName . '-other',
1724                         $value[2],
1725                         'text',
1726                         $textAttribs
1727                 );
1728
1729                 return "$select<br />\n$textbox";
1730         }
1731
1732         /**
1733          * @param  $request WebRequest
1734          * @return Array( <overall message>, <select value>, <text field value> )
1735          */
1736         function loadDataFromRequest( $request ) {
1737                 if ( $request->getCheck( $this->mName ) ) {
1738
1739                         $list = $request->getText( $this->mName );
1740                         $text = $request->getText( $this->mName . '-other' );
1741
1742                         if ( $list == 'other' ) {
1743                                 $final = $text;
1744                         } elseif( !in_array( $list, $this->mFlatOptions ) ){
1745                                 # User has spoofed the select form to give an option which wasn't
1746                                 # in the original offer.  Sulk...
1747                                 $final = $text;
1748                         } elseif( $text == '' ) {
1749                                 $final = $list;
1750                         } else {
1751                                 $final = $list . wfMsgForContent( 'colon-separator' ) . $text;
1752                         }
1753
1754                 } else {
1755                         $final = $this->getDefault();
1756
1757                         $list = 'other';
1758                         $text = $final;
1759                         foreach ( $this->mFlatOptions as $option ) {
1760                                 $match = $option . wfMsgForContent( 'colon-separator' );
1761                                 if( strpos( $text, $match ) === 0 ) {
1762                                         $list = $option;
1763                                         $text = substr( $text, strlen( $match ) );
1764                                         break;
1765                                 }
1766                         }
1767                 }
1768                 return array( $final, $list, $text );
1769         }
1770
1771         function getSize() {
1772                 return isset( $this->mParams['size'] )
1773                         ? $this->mParams['size']
1774                         : 45;
1775         }
1776
1777         function validate( $value, $alldata ) {
1778                 # HTMLSelectField forces $value to be one of the options in the select
1779                 # field, which is not useful here.  But we do want the validation further up
1780                 # the chain
1781                 $p = parent::validate( $value[1], $alldata );
1782
1783                 if ( $p !== true ) {
1784                         return $p;
1785                 }
1786
1787                 if( isset( $this->mParams['required'] ) && $value[1] === '' ){
1788                         return wfMsgExt( 'htmlform-required', 'parseinline' );
1789                 }
1790
1791                 return true;
1792         }
1793 }
1794
1795 /**
1796  * Radio checkbox fields.
1797  */
1798 class HTMLRadioField extends HTMLFormField {
1799         function __construct( $params ) {
1800                 parent::__construct( $params );
1801                 if ( isset( $params['flatlist'] ) ) {
1802                         $this->mClass .= ' mw-htmlform-radio-flatlist';
1803                 }
1804         }
1805
1806
1807         function validate( $value, $alldata ) {
1808                 $p = parent::validate( $value, $alldata );
1809
1810                 if ( $p !== true ) {
1811                         return $p;
1812                 }
1813
1814                 if ( !is_string( $value ) && !is_int( $value ) ) {
1815                         return false;
1816                 }
1817
1818                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1819
1820                 if ( in_array( $value, $validOptions ) ) {
1821                         return true;
1822                 } else {
1823                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1824                 }
1825         }
1826
1827         /**
1828          * This returns a block of all the radio options, in one cell.
1829          * @see includes/HTMLFormField#getInputHTML()
1830          * @param $value String
1831          * @return String
1832          */
1833         function getInputHTML( $value ) {
1834                 $html = $this->formatOptions( $this->mParams['options'], $value );
1835
1836                 return $html;
1837         }
1838
1839         function formatOptions( $options, $value ) {
1840                 $html = '';
1841
1842                 $attribs = array();
1843                 if ( !empty( $this->mParams['disabled'] ) ) {
1844                         $attribs['disabled'] = 'disabled';
1845                 }
1846
1847                 # TODO: should this produce an unordered list perhaps?
1848                 foreach ( $options as $label => $info ) {
1849                         if ( is_array( $info ) ) {
1850                                 $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
1851                                 $html .= $this->formatOptions( $info, $value );
1852                         } else {
1853                                 $id = Sanitizer::escapeId( $this->mID . "-$info" );
1854                                 $radio = Xml::radio(
1855                                         $this->mName,
1856                                         $info,
1857                                         $info == $value,
1858                                         $attribs + array( 'id' => $id )
1859                                 );
1860                                 $radio .= '&#160;' .
1861                                                 Html::rawElement( 'label', array( 'for' => $id ), $label );
1862
1863                                 $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-radio-item' ), $radio );
1864                         }
1865                 }
1866
1867                 return $html;
1868         }
1869
1870         protected function needsLabel() {
1871                 return false;
1872         }
1873 }
1874
1875 /**
1876  * An information field (text blob), not a proper input.
1877  */
1878 class HTMLInfoField extends HTMLFormField {
1879         function __construct( $info ) {
1880                 $info['nodata'] = true;
1881
1882                 parent::__construct( $info );
1883         }
1884
1885         function getInputHTML( $value ) {
1886                 return !empty( $this->mParams['raw'] ) ? $value : htmlspecialchars( $value );
1887         }
1888
1889         function getTableRow( $value ) {
1890                 if ( !empty( $this->mParams['rawrow'] ) ) {
1891                         return $value;
1892                 }
1893
1894                 return parent::getTableRow( $value );
1895         }
1896
1897         protected function needsLabel() {
1898                 return false;
1899         }
1900 }
1901
1902 class HTMLHiddenField extends HTMLFormField {
1903         public function __construct( $params ) {
1904                 parent::__construct( $params );
1905
1906                 # Per HTML5 spec, hidden fields cannot be 'required'
1907                 # http://dev.w3.org/html5/spec/states-of-the-type-attribute.html#hidden-state
1908                 unset( $this->mParams['required'] );
1909         }
1910
1911         public function getTableRow( $value ) {
1912                 $params = array();
1913                 if ( $this->mID ) {
1914                         $params['id'] = $this->mID;
1915                 }
1916
1917                 $this->mParent->addHiddenField(
1918                         $this->mName,
1919                         $this->mDefault,
1920                         $params
1921                 );
1922
1923                 return '';
1924         }
1925
1926         public function getInputHTML( $value ) { return ''; }
1927 }
1928
1929 /**
1930  * Add a submit button inline in the form (as opposed to
1931  * HTMLForm::addButton(), which will add it at the end).
1932  */
1933 class HTMLSubmitField extends HTMLFormField {
1934
1935         function __construct( $info ) {
1936                 $info['nodata'] = true;
1937                 parent::__construct( $info );
1938         }
1939
1940         function getInputHTML( $value ) {
1941                 return Xml::submitButton(
1942                         $value,
1943                         array(
1944                                 'class' => 'mw-htmlform-submit',
1945                                 'name' => $this->mName,
1946                                 'id' => $this->mID,
1947                         )
1948                 );
1949         }
1950
1951         protected function needsLabel() {
1952                 return false;
1953         }
1954
1955         /**
1956          * Button cannot be invalid
1957          * @param $value String
1958          * @param $alldata Array
1959          * @return Bool
1960          */
1961         public function validate( $value, $alldata ){
1962                 return true;
1963         }
1964 }
1965
1966 class HTMLEditTools extends HTMLFormField {
1967         public function getInputHTML( $value ) {
1968                 return '';
1969         }
1970
1971         public function getTableRow( $value ) {
1972                 if ( empty( $this->mParams['message'] ) ) {
1973                         $msg = wfMessage( 'edittools' );
1974                 } else {
1975                         $msg = wfMessage( $this->mParams['message'] );
1976                         if ( $msg->isDisabled() ) {
1977                                 $msg = wfMessage( 'edittools' );
1978                         }
1979                 }
1980                 $msg->inContentLanguage();
1981
1982
1983                 return '<tr><td></td><td class="mw-input">'
1984                         . '<div class="mw-editTools">'
1985                         . $msg->parseAsBlock()
1986                         . "</div></td></tr>\n";
1987         }
1988 }