includes/htmlform/HTMLForm.php

   1 <?php
   2
   3 /**
   4  * HTML form generation and submission handling.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Object handling generic submission, CSRF protection, layout and
  26  * other logic for UI forms. in a reusable manner.
  27  *
  28  * In order to generate the form, the HTMLForm object takes an array
  29  * structure detailing the form fields available. Each element of the
  30  * array is a basic property-list, including the type of field, the
  31  * label it is to be given in the form, callbacks for validation and
  32  * 'filtering', and other pertinent information.
  33  *
  34  * Field types are implemented as subclasses of the generic HTMLFormField
  35  * object, and typically implement at least getInputHTML, which generates
  36  * the HTML for the input field to be placed in the table.
  37  *
  38  * You can find extensive documentation on the www.mediawiki.org wiki:
  39  *  - https://www.mediawiki.org/wiki/HTMLForm
  40  *  - https://www.mediawiki.org/wiki/HTMLForm/tutorial
  41  *
  42  * The constructor input is an associative array of $fieldname => $info,
  43  * where $info is an Associative Array with any of the following:
  44  *
  45  *    'class'               -- the subclass of HTMLFormField that will be used
  46  *                             to create the object.  *NOT* the CSS class!
  47  *    'type'                -- roughly translates into the <select> type attribute.
  48  *                             if 'class' is not specified, this is used as a map
  49  *                             through HTMLForm::$typeMappings to get the class name.
  50  *    'default'             -- default value when the form is displayed
  51  *    'id'                  -- HTML id attribute
  52  *    'cssclass'            -- CSS class
  53  *    'csshelpclass'        -- CSS class used to style help text
  54  *    'dir'                 -- Direction of the element.
  55  *    'options'             -- associative array mapping labels to values.
  56  *                             Some field types support multi-level arrays.
  57  *    'options-messages'    -- associative array mapping message keys to values.
  58  *                             Some field types support multi-level arrays.
  59  *    'options-message'     -- message key or object to be parsed to extract the list of
  60  *                             options (like 'ipbreason-dropdown').
  61  *    'label-message'       -- message key or object for a message to use as the label.
  62  *                             can be an array of msg key and then parameters to
  63  *                             the message.
  64  *    'label'               -- alternatively, a raw text message. Overridden by
  65  *                             label-message
  66  *    'help'                -- message text for a message to use as a help text.
  67  *    'help-message'        -- message key or object for a message to use as a help text.
  68  *                             can be an array of msg key and then parameters to
  69  *                             the message.
  70  *                             Overwrites 'help-messages' and 'help'.
  71  *    'help-messages'       -- array of message keys/objects. As above, each item can
  72  *                             be an array of msg key and then parameters.
  73  *                             Overwrites 'help'.
  74  *    'required'            -- passed through to the object, indicating that it
  75  *                             is a required field.
  76  *    'size'                -- the length of text fields
  77  *    'filter-callback'     -- a function name to give you the chance to
  78  *                             massage the inputted value before it's processed.
  79  *                             @see HTMLFormField::filter()
  80  *    'validation-callback' -- a function name to give you the chance
  81  *                             to impose extra validation on the field input.
  82  *                             @see HTMLFormField::validate()
  83  *    'name'                -- By default, the 'name' attribute of the input field
  84  *                             is "wp{$fieldname}".  If you want a different name
  85  *                             (eg one without the "wp" prefix), specify it here and
  86  *                             it will be used without modification.
  87  *    'hide-if'             -- expression given as an array stating when the field
  88  *                             should be hidden. The first array value has to be the
  89  *                             expression's logic operator. Supported expressions:
  90  *                               'NOT'
  91  *                                 [ 'NOT', array $expression ]
  92  *                                 To hide a field if a given expression is not true.
  93  *                               '==='
  94  *                                 [ '===', string $fieldName, string $value ]
  95  *                                 To hide a field if another field identified by
  96  *                                 $field has the value $value.
  97  *                               '!=='
  98  *                                 [ '!==', string $fieldName, string $value ]
  99  *                                 Same as [ 'NOT', [ '===', $fieldName, $value ]
 100  *                               'OR', 'AND', 'NOR', 'NAND'
 101  *                                 [ 'XXX', array $expression1, ..., array $expressionN ]
 102  *                                 To hide a field if one or more (OR), all (AND),
 103  *                                 neither (NOR) or not all (NAND) given expressions
 104  *                                 are evaluated as true.
 105  *                             The expressions will be given to a JavaScript frontend
 106  *                             module which will continually update the field's
 107  *                             visibility.
 108  *
 109  * Since 1.20, you can chain mutators to ease the form generation:
 110  * @par Example:
 111  * @code
 112  * $form = new HTMLForm( $someFields );
 113  * $form->setMethod( 'get' )
 114  *      ->setWrapperLegendMsg( 'message-key' )
 115  *      ->prepareForm()
 116  *      ->displayForm( '' );
 117  * @endcode
 118  * Note that you will have prepareForm and displayForm at the end. Other
 119  * methods call done after that would simply not be part of the form :(
 120  *
 121  * @todo Document 'section' / 'subsection' stuff
 122  */
 123 class HTMLForm extends ContextSource {
 124         // A mapping of 'type' inputs onto standard HTMLFormField subclasses
 125         public static $typeMappings = [
 126                 'api' => 'HTMLApiField',
 127                 'text' => 'HTMLTextField',
 128                 'textwithbutton' => 'HTMLTextFieldWithButton',
 129                 'textarea' => 'HTMLTextAreaField',
 130                 'select' => 'HTMLSelectField',
 131                 'combobox' => 'HTMLComboboxField',
 132                 'radio' => 'HTMLRadioField',
 133                 'multiselect' => 'HTMLMultiSelectField',
 134                 'limitselect' => 'HTMLSelectLimitField',
 135                 'check' => 'HTMLCheckField',
 136                 'toggle' => 'HTMLCheckField',
 137                 'int' => 'HTMLIntField',
 138                 'float' => 'HTMLFloatField',
 139                 'info' => 'HTMLInfoField',
 140                 'selectorother' => 'HTMLSelectOrOtherField',
 141                 'selectandother' => 'HTMLSelectAndOtherField',
 142                 'namespaceselect' => 'HTMLSelectNamespace',
 143                 'namespaceselectwithbutton' => 'HTMLSelectNamespaceWithButton',
 144                 'tagfilter' => 'HTMLTagFilter',
 145                 'submit' => 'HTMLSubmitField',
 146                 'hidden' => 'HTMLHiddenField',
 147                 'edittools' => 'HTMLEditTools',
 148                 'checkmatrix' => 'HTMLCheckMatrix',
 149                 'cloner' => 'HTMLFormFieldCloner',
 150                 'autocompleteselect' => 'HTMLAutoCompleteSelectField',
 151                 // HTMLTextField will output the correct type="" attribute automagically.
 152                 // There are about four zillion other HTML5 input types, like range, but
 153                 // we don't use those at the moment, so no point in adding all of them.
 154                 'email' => 'HTMLTextField',
 155                 'password' => 'HTMLTextField',
 156                 'url' => 'HTMLTextField',
 157                 'title' => 'HTMLTitleTextField',
 158                 'user' => 'HTMLUserTextField',
 159         ];
 160
 161         public $mFieldData;
 162
 163         protected $mMessagePrefix;
 164
 165         /** @var HTMLFormField[] */
 166         protected $mFlatFields;
 167
 168         protected $mFieldTree;
 169         protected $mShowReset = false;
 170         protected $mShowSubmit = true;
 171         protected $mSubmitFlags = [ 'constructive', 'primary' ];
 172
 173         protected $mSubmitCallback;
 174         protected $mValidationErrorMessage;
 175
 176         protected $mPre = '';
 177         protected $mHeader = '';
 178         protected $mFooter = '';
 179         protected $mSectionHeaders = [];
 180         protected $mSectionFooters = [];
 181         protected $mPost = '';
 182         protected $mId;
 183         protected $mName;
 184         protected $mTableId = '';
 185
 186         protected $mSubmitID;
 187         protected $mSubmitName;
 188         protected $mSubmitText;
 189         protected $mSubmitTooltip;
 190
 191         protected $mTitle;
 192         protected $mMethod = 'post';
 193         protected $mWasSubmitted = false;
 194
 195         /**
 196          * Form action URL. false means we will use the URL to set Title
 197          * @since 1.19
 198          * @var bool|string
 199          */
 200         protected $mAction = false;
 201
 202         /**
 203          * Form attribute autocomplete. false does not set the attribute
 204          * @since 1.27
 205          * @var bool|string
 206          */
 207         protected $mAutocomplete = false;
 208
 209         protected $mUseMultipart = false;
 210         protected $mHiddenFields = [];
 211         protected $mButtons = [];
 212
 213         protected $mWrapperLegend = false;
 214
 215         /**
 216          * Salt for the edit token.
 217          * @var string|array
 218          */
 219         protected $mTokenSalt = '';
 220
 221         /**
 222          * If true, sections that contain both fields and subsections will
 223          * render their subsections before their fields.
 224          *
 225          * Subclasses may set this to false to render subsections after fields
 226          * instead.
 227          */
 228         protected $mSubSectionBeforeFields = true;
 229
 230         /**
 231          * Format in which to display form. For viable options,
 232          * @see $availableDisplayFormats
 233          * @var string
 234          */
 235         protected $displayFormat = 'table';
 236
 237         /**
 238          * Available formats in which to display the form
 239          * @var array
 240          */
 241         protected $availableDisplayFormats = [
 242                 'table',
 243                 'div',
 244                 'raw',
 245                 'inline',
 246         ];
 247
 248         /**
 249          * Available formats in which to display the form
 250          * @var array
 251          */
 252         protected $availableSubclassDisplayFormats = [
 253                 'vform',
 254                 'ooui',
 255         ];
 256
 257         /**
 258          * Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
 259          *
 260          * @param string $displayFormat
 261          * @param mixed $arguments... Additional arguments to pass to the constructor.
 262          * @return HTMLForm
 263          */
 264         public static function factory( $displayFormat/*, $arguments...*/ ) {
 265                 $arguments = func_get_args();
 266                 array_shift( $arguments );
 267
 268                 switch ( $displayFormat ) {
 269                         case 'vform':
 270                                 $reflector = new ReflectionClass( 'VFormHTMLForm' );
 271                                 return $reflector->newInstanceArgs( $arguments );
 272                         case 'ooui':
 273                                 $reflector = new ReflectionClass( 'OOUIHTMLForm' );
 274                                 return $reflector->newInstanceArgs( $arguments );
 275                         default:
 276                                 $reflector = new ReflectionClass( 'HTMLForm' );
 277                                 $form = $reflector->newInstanceArgs( $arguments );
 278                                 $form->setDisplayFormat( $displayFormat );
 279                                 return $form;
 280                 }
 281         }
 282
 283         /**
 284          * Build a new HTMLForm from an array of field attributes
 285          *
 286          * @param array $descriptor Array of Field constructs, as described above
 287          * @param IContextSource $context Available since 1.18, will become compulsory in 1.18.
 288          *     Obviates the need to call $form->setTitle()
 289          * @param string $messagePrefix A prefix to go in front of default messages
 290          */
 291         public function __construct( $descriptor, /*IContextSource*/ $context = null,
 292                 $messagePrefix = ''
 293         ) {
 294                 if ( $context instanceof IContextSource ) {
 295                         $this->setContext( $context );
 296                         $this->mTitle = false; // We don't need them to set a title
 297                         $this->mMessagePrefix = $messagePrefix;
 298                 } elseif ( $context === null && $messagePrefix !== '' ) {
 299                         $this->mMessagePrefix = $messagePrefix;
 300                 } elseif ( is_string( $context ) && $messagePrefix === '' ) {
 301                         // B/C since 1.18
 302                         // it's actually $messagePrefix
 303                         $this->mMessagePrefix = $context;
 304                 }
 305
 306                 // Evil hack for mobile :(
 307                 if (
 308                         !$this->getConfig()->get( 'HTMLFormAllowTableFormat' )
 309                         && $this->displayFormat === 'table'
 310                 ) {
 311                         $this->displayFormat = 'div';
 312                 }
 313
 314                 // Expand out into a tree.
 315                 $loadedDescriptor = [];
 316                 $this->mFlatFields = [];
 317
 318                 foreach ( $descriptor as $fieldname => $info ) {
 319                         $section = isset( $info['section'] )
 320                                 ? $info['section']
 321                                 : '';
 322
 323                         if ( isset( $info['type'] ) && $info['type'] === 'file' ) {
 324                                 $this->mUseMultipart = true;
 325                         }
 326
 327                         $field = static::loadInputFromParameters( $fieldname, $info, $this );
 328
 329                         $setSection =& $loadedDescriptor;
 330                         if ( $section ) {
 331                                 $sectionParts = explode( '/', $section );
 332
 333                                 while ( count( $sectionParts ) ) {
 334                                         $newName = array_shift( $sectionParts );
 335
 336                                         if ( !isset( $setSection[$newName] ) ) {
 337                                                 $setSection[$newName] = [];
 338                                         }
 339
 340                                         $setSection =& $setSection[$newName];
 341                                 }
 342                         }
 343
 344                         $setSection[$fieldname] = $field;
 345                         $this->mFlatFields[$fieldname] = $field;
 346                 }
 347
 348                 $this->mFieldTree = $loadedDescriptor;
 349         }
 350
 351         /**
 352          * Set format in which to display the form
 353          *
 354          * @param string $format The name of the format to use, must be one of
 355          *   $this->availableDisplayFormats
 356          *
 357          * @throws MWException
 358          * @since 1.20
 359          * @return HTMLForm $this for chaining calls (since 1.20)
 360          */
 361         public function setDisplayFormat( $format ) {
 362                 if (
 363                         in_array( $format, $this->availableSubclassDisplayFormats, true ) ||
 364                         in_array( $this->displayFormat, $this->availableSubclassDisplayFormats, true )
 365                 ) {
 366                         throw new MWException( 'Cannot change display format after creation, ' .
 367                                 'use HTMLForm::factory() instead' );
 368                 }
 369
 370                 if ( !in_array( $format, $this->availableDisplayFormats, true ) ) {
 371                         throw new MWException( 'Display format must be one of ' .
 372                                 print_r( $this->availableDisplayFormats, true ) );
 373                 }
 374
 375                 // Evil hack for mobile :(
 376                 if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
 377                         $format = 'div';
 378                 }
 379
 380                 $this->displayFormat = $format;
 381
 382                 return $this;
 383         }
 384
 385         /**
 386          * Getter for displayFormat
 387          * @since 1.20
 388          * @return string
 389          */
 390         public function getDisplayFormat() {
 391                 return $this->displayFormat;
 392         }
 393
 394         /**
 395          * Test if displayFormat is 'vform'
 396          * @since 1.22
 397          * @deprecated since 1.25
 398          * @return bool
 399          */
 400         public function isVForm() {
 401                 wfDeprecated( __METHOD__, '1.25' );
 402                 return false;
 403         }
 404
 405         /**
 406          * Get the HTMLFormField subclass for this descriptor.
 407          *
 408          * The descriptor can be passed either 'class' which is the name of
 409          * a HTMLFormField subclass, or a shorter 'type' which is an alias.
 410          * This makes sure the 'class' is always set, and also is returned by
 411          * this function for ease.
 412          *
 413          * @since 1.23
 414          *
 415          * @param string $fieldname Name of the field
 416          * @param array $descriptor Input Descriptor, as described above
 417          *
 418          * @throws MWException
 419          * @return string Name of a HTMLFormField subclass
 420          */
 421         public static function getClassFromDescriptor( $fieldname, &$descriptor ) {
 422                 if ( isset( $descriptor['class'] ) ) {
 423                         $class = $descriptor['class'];
 424                 } elseif ( isset( $descriptor['type'] ) ) {
 425                         $class = static::$typeMappings[$descriptor['type']];
 426                         $descriptor['class'] = $class;
 427                 } else {
 428                         $class = null;
 429                 }
 430
 431                 if ( !$class ) {
 432                         throw new MWException( "Descriptor with no class for $fieldname: "
 433                                 . print_r( $descriptor, true ) );
 434                 }
 435
 436                 return $class;
 437         }
 438
 439         /**
 440          * Initialise a new Object for the field
 441          *
 442          * @param string $fieldname Name of the field
 443          * @param array $descriptor Input Descriptor, as described above
 444          * @param HTMLForm|null $parent Parent instance of HTMLForm
 445          *
 446          * @throws MWException
 447          * @return HTMLFormField Instance of a subclass of HTMLFormField
 448          */
 449         public static function loadInputFromParameters( $fieldname, $descriptor,
 450                 HTMLForm $parent = null
 451         ) {
 452                 $class = static::getClassFromDescriptor( $fieldname, $descriptor );
 453
 454                 $descriptor['fieldname'] = $fieldname;
 455                 if ( $parent ) {
 456                         $descriptor['parent'] = $parent;
 457                 }
 458
 459                 # @todo This will throw a fatal error whenever someone try to use
 460                 # 'class' to feed a CSS class instead of 'cssclass'. Would be
 461                 # great to avoid the fatal error and show a nice error.
 462                 return new $class( $descriptor );
 463         }
 464
 465         /**
 466          * Prepare form for submission.
 467          *
 468          * @attention When doing method chaining, that should be the very last
 469          * method call before displayForm().
 470          *
 471          * @throws MWException
 472          * @return HTMLForm $this for chaining calls (since 1.20)
 473          */
 474         public function prepareForm() {
 475                 # Check if we have the info we need
 476                 if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
 477                         throw new MWException( 'You must call setTitle() on an HTMLForm' );
 478                 }
 479
 480                 # Load data from the request.
 481                 $this->loadData();
 482
 483                 return $this;
 484         }
 485
 486         /**
 487          * Try submitting, with edit token check first
 488          * @return Status|bool
 489          */
 490         public function tryAuthorizedSubmit() {
 491                 $result = false;
 492
 493                 $submit = false;
 494                 if ( $this->getMethod() !== 'post' ) {
 495                         $submit = true; // no session check needed
 496                 } elseif ( $this->getRequest()->wasPosted() ) {
 497                         $editToken = $this->getRequest()->getVal( 'wpEditToken' );
 498                         if ( $this->getUser()->isLoggedIn() || $editToken !== null ) {
 499                                 // Session tokens for logged-out users have no security value.
 500                                 // However, if the user gave one, check it in order to give a nice
 501                                 // "session expired" error instead of "permission denied" or such.
 502                                 $submit = $this->getUser()->matchEditToken( $editToken, $this->mTokenSalt );
 503                         } else {
 504                                 $submit = true;
 505                         }
 506                 }
 507
 508                 if ( $submit ) {
 509                         $this->mWasSubmitted = true;
 510                         $result = $this->trySubmit();
 511                 }
 512
 513                 return $result;
 514         }
 515
 516         /**
 517          * The here's-one-I-made-earlier option: do the submission if
 518          * posted, or display the form with or without funky validation
 519          * errors
 520          * @return bool|Status Whether submission was successful.
 521          */
 522         public function show() {
 523                 $this->prepareForm();
 524
 525                 $result = $this->tryAuthorizedSubmit();
 526                 if ( $result === true || ( $result instanceof Status && $result->isGood() ) ) {
 527                         return $result;
 528                 }
 529
 530                 $this->displayForm( $result );
 531
 532                 return false;
 533         }
 534
 535         /**
 536          * Same as self::show with the difference, that the form will be
 537          * added to the output, no matter, if the validation was good or not.
 538          * @return bool|Status Whether submission was successful.
 539          */
 540         public function showAlways() {
 541                 $this->prepareForm();
 542
 543                 $result = $this->tryAuthorizedSubmit();
 544
 545                 $this->displayForm( $result );
 546
 547                 return $result;
 548         }
 549
 550         /**
 551          * Validate all the fields, and call the submission callback
 552          * function if everything is kosher.
 553          * @throws MWException
 554          * @return bool|string|array|Status
 555          *     - Bool true or a good Status object indicates success,
 556          *     - Bool false indicates no submission was attempted,
 557          *     - Anything else indicates failure. The value may be a fatal Status
 558          *       object, an HTML string, or an array of arrays (message keys and
 559          *       params) or strings (message keys)
 560          */
 561         public function trySubmit() {
 562                 $valid = true;
 563                 $hoistedErrors = [];
 564                 $hoistedErrors[] = isset( $this->mValidationErrorMessage )
 565                         ? $this->mValidationErrorMessage
 566                         : [ 'htmlform-invalid-input' ];
 567
 568                 $this->mWasSubmitted = true;
 569
 570                 # Check for cancelled submission
 571                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 572                         if ( !empty( $field->mParams['nodata'] ) ) {
 573                                 continue;
 574                         }
 575                         if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
 576                                 $this->mWasSubmitted = false;
 577                                 return false;
 578                         }
 579                 }
 580
 581                 # Check for validation
 582                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 583                         if ( !empty( $field->mParams['nodata'] ) ) {
 584                                 continue;
 585                         }
 586                         if ( $field->isHidden( $this->mFieldData ) ) {
 587                                 continue;
 588                         }
 589                         $res = $field->validate( $this->mFieldData[$fieldname], $this->mFieldData );
 590                         if ( $res !== true ) {
 591                                 $valid = false;
 592                                 if ( $res !== false && !$field->canDisplayErrors() ) {
 593                                         $hoistedErrors[] = [ 'rawmessage', $res ];
 594                                 }
 595                         }
 596                 }
 597
 598                 if ( !$valid ) {
 599                         if ( count( $hoistedErrors ) === 1 ) {
 600                                 $hoistedErrors = $hoistedErrors[0];
 601                         }
 602                         return $hoistedErrors;
 603                 }
 604
 605                 $callback = $this->mSubmitCallback;
 606                 if ( !is_callable( $callback ) ) {
 607                         throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
 608                                 'setSubmitCallback() to set one.' );
 609                 }
 610
 611                 $data = $this->filterDataForSubmit( $this->mFieldData );
 612
 613                 $res = call_user_func( $callback, $data, $this );
 614                 if ( $res === false ) {
 615                         $this->mWasSubmitted = false;
 616                 }
 617
 618                 return $res;
 619         }
 620
 621         /**
 622          * Test whether the form was considered to have been submitted or not, i.e.
 623          * whether the last call to tryAuthorizedSubmit or trySubmit returned
 624          * non-false.
 625          *
 626          * This will return false until HTMLForm::tryAuthorizedSubmit or
 627          * HTMLForm::trySubmit is called.
 628          *
 629          * @since 1.23
 630          * @return bool
 631          */
 632         public function wasSubmitted() {
 633                 return $this->mWasSubmitted;
 634         }
 635
 636         /**
 637          * Set a callback to a function to do something with the form
 638          * once it's been successfully validated.
 639          *
 640          * @param callable $cb The function will be passed the output from
 641          *   HTMLForm::filterDataForSubmit and this HTMLForm object, and must
 642          *   return as documented for HTMLForm::trySubmit
 643          *
 644          * @return HTMLForm $this for chaining calls (since 1.20)
 645          */
 646         public function setSubmitCallback( $cb ) {
 647                 $this->mSubmitCallback = $cb;
 648
 649                 return $this;
 650         }
 651
 652         /**
 653          * Set a message to display on a validation error.
 654          *
 655          * @param string|array $msg String or Array of valid inputs to wfMessage()
 656          *     (so each entry can be either a String or Array)
 657          *
 658          * @return HTMLForm $this for chaining calls (since 1.20)
 659          */
 660         public function setValidationErrorMessage( $msg ) {
 661                 $this->mValidationErrorMessage = $msg;
 662
 663                 return $this;
 664         }
 665
 666         /**
 667          * Set the introductory message, overwriting any existing message.
 668          *
 669          * @param string $msg Complete text of message to display
 670          *
 671          * @return HTMLForm $this for chaining calls (since 1.20)
 672          */
 673         public function setIntro( $msg ) {
 674                 $this->setPreText( $msg );
 675
 676                 return $this;
 677         }
 678
 679         /**
 680          * Set the introductory message HTML, overwriting any existing message.
 681          * @since 1.19
 682          *
 683          * @param string $msg Complete HTML of message to display
 684          *
 685          * @return HTMLForm $this for chaining calls (since 1.20)
 686          */
 687         public function setPreText( $msg ) {
 688                 $this->mPre = $msg;
 689
 690                 return $this;
 691         }
 692
 693         /**
 694          * Add HTML to introductory message.
 695          *
 696          * @param string $msg Complete HTML of message to display
 697          *
 698          * @return HTMLForm $this for chaining calls (since 1.20)
 699          */
 700         public function addPreText( $msg ) {
 701                 $this->mPre .= $msg;
 702
 703                 return $this;
 704         }
 705
 706         /**
 707          * Add HTML to the header, inside the form.
 708          *
 709          * @param string $msg Additional HTML to display in header
 710          * @param string|null $section The section to add the header to
 711          *
 712          * @return HTMLForm $this for chaining calls (since 1.20)
 713          */
 714         public function addHeaderText( $msg, $section = null ) {
 715                 if ( $section === null ) {
 716                         $this->mHeader .= $msg;
 717                 } else {
 718                         if ( !isset( $this->mSectionHeaders[$section] ) ) {
 719                                 $this->mSectionHeaders[$section] = '';
 720                         }
 721                         $this->mSectionHeaders[$section] .= $msg;
 722                 }
 723
 724                 return $this;
 725         }
 726
 727         /**
 728          * Set header text, inside the form.
 729          * @since 1.19
 730          *
 731          * @param string $msg Complete HTML of header to display
 732          * @param string|null $section The section to add the header to
 733          *
 734          * @return HTMLForm $this for chaining calls (since 1.20)
 735          */
 736         public function setHeaderText( $msg, $section = null ) {
 737                 if ( $section === null ) {
 738                         $this->mHeader = $msg;
 739                 } else {
 740                         $this->mSectionHeaders[$section] = $msg;
 741                 }
 742
 743                 return $this;
 744         }
 745
 746         /**
 747          * Get header text.
 748          *
 749          * @param string|null $section The section to get the header text for
 750          * @since 1.26
 751          * @return string HTML
 752          */
 753         public function getHeaderText( $section = null ) {
 754                 if ( $section === null ) {
 755                         return $this->mHeader;
 756                 } else {
 757                         return isset( $this->mSectionHeaders[$section] ) ? $this->mSectionHeaders[$section] : '';
 758                 }
 759         }
 760
 761         /**
 762          * Add footer text, inside the form.
 763          *
 764          * @param string $msg Complete text of message to display
 765          * @param string|null $section The section to add the footer text to
 766          *
 767          * @return HTMLForm $this for chaining calls (since 1.20)
 768          */
 769         public function addFooterText( $msg, $section = null ) {
 770                 if ( $section === null ) {
 771                         $this->mFooter .= $msg;
 772                 } else {
 773                         if ( !isset( $this->mSectionFooters[$section] ) ) {
 774                                 $this->mSectionFooters[$section] = '';
 775                         }
 776                         $this->mSectionFooters[$section] .= $msg;
 777                 }
 778
 779                 return $this;
 780         }
 781
 782         /**
 783          * Set footer text, inside the form.
 784          * @since 1.19
 785          *
 786          * @param string $msg Complete text of message to display
 787          * @param string|null $section The section to add the footer text to
 788          *
 789          * @return HTMLForm $this for chaining calls (since 1.20)
 790          */
 791         public function setFooterText( $msg, $section = null ) {
 792                 if ( $section === null ) {
 793                         $this->mFooter = $msg;
 794                 } else {
 795                         $this->mSectionFooters[$section] = $msg;
 796                 }
 797
 798                 return $this;
 799         }
 800
 801         /**
 802          * Get footer text.
 803          *
 804          * @param string|null $section The section to get the footer text for
 805          * @since 1.26
 806          * @return string
 807          */
 808         public function getFooterText( $section = null ) {
 809                 if ( $section === null ) {
 810                         return $this->mFooter;
 811                 } else {
 812                         return isset( $this->mSectionFooters[$section] ) ? $this->mSectionFooters[$section] : '';
 813                 }
 814         }
 815
 816         /**
 817          * Add text to the end of the display.
 818          *
 819          * @param string $msg Complete text of message to display
 820          *
 821          * @return HTMLForm $this for chaining calls (since 1.20)
 822          */
 823         public function addPostText( $msg ) {
 824                 $this->mPost .= $msg;
 825
 826                 return $this;
 827         }
 828
 829         /**
 830          * Set text at the end of the display.
 831          *
 832          * @param string $msg Complete text of message to display
 833          *
 834          * @return HTMLForm $this for chaining calls (since 1.20)
 835          */
 836         public function setPostText( $msg ) {
 837                 $this->mPost = $msg;
 838
 839                 return $this;
 840         }
 841
 842         /**
 843          * Add a hidden field to the output
 844          *
 845          * @param string $name Field name.  This will be used exactly as entered
 846          * @param string $value Field value
 847          * @param array $attribs
 848          *
 849          * @return HTMLForm $this for chaining calls (since 1.20)
 850          */
 851         public function addHiddenField( $name, $value, array $attribs = [] ) {
 852                 $attribs += [ 'name' => $name ];
 853                 $this->mHiddenFields[] = [ $value, $attribs ];
 854
 855                 return $this;
 856         }
 857
 858         /**
 859          * Add an array of hidden fields to the output
 860          *
 861          * @since 1.22
 862          *
 863          * @param array $fields Associative array of fields to add;
 864          *        mapping names to their values
 865          *
 866          * @return HTMLForm $this for chaining calls
 867          */
 868         public function addHiddenFields( array $fields ) {
 869                 foreach ( $fields as $name => $value ) {
 870                         $this->mHiddenFields[] = [ $value, [ 'name' => $name ] ];
 871                 }
 872
 873                 return $this;
 874         }
 875
 876         /**
 877          * Add a button to the form
 878          *
 879          * @since 1.27 takes an array as shown. Earlier versions accepted
 880          *  'name', 'value', 'id', and 'attribs' as separate parameters in that
 881          *  order.
 882          * @note Custom labels ('label', 'label-message', 'label-raw') are not
 883          *  supported for IE6 and IE7 due to bugs in those browsers. If detected,
 884          *  they will be served buttons using 'value' as the button label.
 885          * @param array $data Data to define the button:
 886          *  - name: (string) Button name.
 887          *  - value: (string) Button value.
 888          *  - label-message: (string, optional) Button label message key to use
 889          *    instead of 'value'. Overrides 'label' and 'label-raw'.
 890          *  - label: (string, optional) Button label text to use instead of
 891          *    'value'. Overrides 'label-raw'.
 892          *  - label-raw: (string, optional) Button label HTML to use instead of
 893          *    'value'.
 894          *  - id: (string, optional) DOM id for the button.
 895          *  - attribs: (array, optional) Additional HTML attributes.
 896          *  - flags: (string|string[], optional) OOUI flags.
 897          * @return HTMLForm $this for chaining calls (since 1.20)
 898          */
 899         public function addButton( $data ) {
 900                 if ( !is_array( $data ) ) {
 901                         $args = func_get_args();
 902                         if ( count( $args ) < 2 || count( $args ) > 4 ) {
 903                                 throw new InvalidArgumentException(
 904                                         'Incorrect number of arguments for deprecated calling style'
 905                                 );
 906                         }
 907                         $data = [
 908                                 'name' => $args[0],
 909                                 'value' => $args[1],
 910                                 'id' => isset( $args[2] ) ? $args[2] : null,
 911                                 'attribs' => isset( $args[3] ) ? $args[3] : null,
 912                         ];
 913                 } else {
 914                         if ( !isset( $data['name'] ) ) {
 915                                 throw new InvalidArgumentException( 'A name is required' );
 916                         }
 917                         if ( !isset( $data['value'] ) ) {
 918                                 throw new InvalidArgumentException( 'A value is required' );
 919                         }
 920                 }
 921                 $this->mButtons[] = $data + [
 922                         'id' => null,
 923                         'attribs' => null,
 924                         'flags' => null,
 925                 ];
 926
 927                 return $this;
 928         }
 929
 930         /**
 931          * Set the salt for the edit token.
 932          *
 933          * Only useful when the method is "post".
 934          *
 935          * @since 1.24
 936          * @param string|array $salt Salt to use
 937          * @return HTMLForm $this For chaining calls
 938          */
 939         public function setTokenSalt( $salt ) {
 940                 $this->mTokenSalt = $salt;
 941
 942                 return $this;
 943         }
 944
 945         /**
 946          * Display the form (sending to the context's OutputPage object), with an
 947          * appropriate error message or stack of messages, and any validation errors, etc.
 948          *
 949          * @attention You should call prepareForm() before calling this function.
 950          * Moreover, when doing method chaining this should be the very last method
 951          * call just after prepareForm().
 952          *
 953          * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
 954          *
 955          * @return void Nothing, should be last call
 956          */
 957         public function displayForm( $submitResult ) {
 958                 $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
 959         }
 960
 961         /**
 962          * Returns the raw HTML generated by the form
 963          *
 964          * @param bool|string|array|Status $submitResult Output from HTMLForm::trySubmit()
 965          *
 966          * @return string HTML
 967          */
 968         public function getHTML( $submitResult ) {
 969                 # For good measure (it is the default)
 970                 $this->getOutput()->preventClickjacking();
 971                 $this->getOutput()->addModules( 'mediawiki.htmlform' );
 972                 $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.styles' );
 973
 974                 $html = ''
 975                         . $this->getErrors( $submitResult )
 976                         . $this->getHeaderText()
 977                         . $this->getBody()
 978                         . $this->getHiddenFields()
 979                         . $this->getButtons()
 980                         . $this->getFooterText();
 981
 982                 $html = $this->wrapForm( $html );
 983
 984                 return '' . $this->mPre . $html . $this->mPost;
 985         }
 986
 987         /**
 988          * Get HTML attributes for the `<form>` tag.
 989          * @return array
 990          */
 991         protected function getFormAttributes() {
 992                 # Use multipart/form-data
 993                 $encType = $this->mUseMultipart
 994                         ? 'multipart/form-data'
 995                         : 'application/x-www-form-urlencoded';
 996                 # Attributes
 997                 $attribs = [
 998                         'action' => $this->getAction(),
 999                         'method' => $this->getMethod(),
1000                         'enctype' => $encType,
1001                 ];
1002                 if ( $this->mId ) {
1003                         $attribs['id'] = $this->mId;
1004                 }
1005                 if ( $this->mAutocomplete ) {
1006                         $attribs['autocomplete'] = $this->mAutocomplete;
1007                 }
1008                 if ( $this->mName ) {
1009                         $attribs['name'] = $this->mName;
1010                 }
1011                 return $attribs;
1012         }
1013
1014         /**
1015          * Wrap the form innards in an actual "<form>" element
1016          *
1017          * @param string $html HTML contents to wrap.
1018          *
1019          * @return string Wrapped HTML.
1020          */
1021         public function wrapForm( $html ) {
1022                 # Include a <fieldset> wrapper for style, if requested.
1023                 if ( $this->mWrapperLegend !== false ) {
1024                         $legend = is_string( $this->mWrapperLegend ) ? $this->mWrapperLegend : false;
1025                         $html = Xml::fieldset( $legend, $html );
1026                 }
1027
1028                 return Html::rawElement(
1029                         'form',
1030                         $this->getFormAttributes() + [ 'class' => 'visualClear' ],
1031                         $html
1032                 );
1033         }
1034
1035         /**
1036          * Get the hidden fields that should go inside the form.
1037          * @return string HTML.
1038          */
1039         public function getHiddenFields() {
1040                 $html = '';
1041                 if ( $this->getMethod() === 'post' ) {
1042                         $html .= Html::hidden(
1043                                 'wpEditToken',
1044                                 $this->getUser()->getEditToken( $this->mTokenSalt ),
1045                                 [ 'id' => 'wpEditToken' ]
1046                         ) . "\n";
1047                         $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1048                 }
1049
1050                 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1051                 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1052                         $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
1053                 }
1054
1055                 foreach ( $this->mHiddenFields as $data ) {
1056                         list( $value, $attribs ) = $data;
1057                         $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
1058                 }
1059
1060                 return $html;
1061         }
1062
1063         /**
1064          * Get the submit and (potentially) reset buttons.
1065          * @return string HTML.
1066          */
1067         public function getButtons() {
1068                 $buttons = '';
1069                 $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );
1070
1071                 if ( $this->mShowSubmit ) {
1072                         $attribs = [];
1073
1074                         if ( isset( $this->mSubmitID ) ) {
1075                                 $attribs['id'] = $this->mSubmitID;
1076                         }
1077
1078                         if ( isset( $this->mSubmitName ) ) {
1079                                 $attribs['name'] = $this->mSubmitName;
1080                         }
1081
1082                         if ( isset( $this->mSubmitTooltip ) ) {
1083                                 $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
1084                         }
1085
1086                         $attribs['class'] = [ 'mw-htmlform-submit' ];
1087
1088                         if ( $useMediaWikiUIEverywhere ) {
1089                                 foreach ( $this->mSubmitFlags as $flag ) {
1090                                         $attribs['class'][] = 'mw-ui-' . $flag;
1091                                 }
1092                                 $attribs['class'][] = 'mw-ui-button';
1093                         }
1094
1095                         $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
1096                 }
1097
1098                 if ( $this->mShowReset ) {
1099                         $buttons .= Html::element(
1100                                 'input',
1101                                 [
1102                                         'type' => 'reset',
1103                                         'value' => $this->msg( 'htmlform-reset' )->text(),
1104                                         'class' => $useMediaWikiUIEverywhere ? 'mw-ui-button' : null,
1105                                 ]
1106                         ) . "\n";
1107                 }
1108
1109                 // IE<8 has bugs with <button>, so we'll need to avoid them.
1110                 $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
1111
1112                 foreach ( $this->mButtons as $button ) {
1113                         $attrs = [
1114                                 'type' => 'submit',
1115                                 'name' => $button['name'],
1116                                 'value' => $button['value']
1117                         ];
1118
1119                         if ( isset( $button['label-message'] ) ) {
1120                                 $label = $this->msg( $button['label-message'] )->parse();
1121                         } elseif ( isset( $button['label'] ) ) {
1122                                 $label = htmlspecialchars( $button['label'] );
1123                         } elseif ( isset( $button['label-raw'] ) ) {
1124                                 $label = $button['label-raw'];
1125                         } else {
1126                                 $label = htmlspecialchars( $button['value'] );
1127                         }
1128
1129                         if ( $button['attribs'] ) {
1130                                 $attrs += $button['attribs'];
1131                         }
1132
1133                         if ( isset( $button['id'] ) ) {
1134                                 $attrs['id'] = $button['id'];
1135                         }
1136
1137                         if ( $useMediaWikiUIEverywhere ) {
1138                                 $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
1139                                 $attrs['class'][] = 'mw-ui-button';
1140                         }
1141
1142                         if ( $isBadIE ) {
1143                                 $buttons .= Html::element( 'input', $attrs ) . "\n";
1144                         } else {
1145                                 $buttons .= Html::rawElement( 'button', $attrs, $label ) . "\n";
1146                         }
1147                 }
1148
1149                 $html = Html::rawElement( 'span',
1150                         [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
1151
1152                 return $html;
1153         }
1154
1155         /**
1156          * Get the whole body of the form.
1157          * @return string
1158          */
1159         public function getBody() {
1160                 return $this->displaySection( $this->mFieldTree, $this->mTableId );
1161         }
1162
1163         /**
1164          * Format and display an error message stack.
1165          *
1166          * @param string|array|Status $errors
1167          *
1168          * @return string
1169          */
1170         public function getErrors( $errors ) {
1171                 if ( $errors instanceof Status ) {
1172                         if ( $errors->isOK() ) {
1173                                 $errorstr = '';
1174                         } else {
1175                                 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
1176                         }
1177                 } elseif ( is_array( $errors ) ) {
1178                         $errorstr = $this->formatErrors( $errors );
1179                 } else {
1180                         $errorstr = $errors;
1181                 }
1182
1183                 return $errorstr
1184                         ? Html::rawElement( 'div', [ 'class' => 'error' ], $errorstr )
1185                         : '';
1186         }
1187
1188         /**
1189          * Format a stack of error messages into a single HTML string
1190          *
1191          * @param array $errors Array of message keys/values
1192          *
1193          * @return string HTML, a "<ul>" list of errors
1194          */
1195         public function formatErrors( $errors ) {
1196                 $errorstr = '';
1197
1198                 foreach ( $errors as $error ) {
1199                         if ( is_array( $error ) ) {
1200                                 $msg = array_shift( $error );
1201                         } else {
1202                                 $msg = $error;
1203                                 $error = [];
1204                         }
1205
1206                         $errorstr .= Html::rawElement(
1207                                 'li',
1208                                 [],
1209                                 $this->msg( $msg, $error )->parse()
1210                         );
1211                 }
1212
1213                 $errorstr = Html::rawElement( 'ul', [], $errorstr );
1214
1215                 return $errorstr;
1216         }
1217
1218         /**
1219          * Set the text for the submit button
1220          *
1221          * @param string $t Plaintext
1222          *
1223          * @return HTMLForm $this for chaining calls (since 1.20)
1224          */
1225         public function setSubmitText( $t ) {
1226                 $this->mSubmitText = $t;
1227
1228                 return $this;
1229         }
1230
1231         /**
1232          * Identify that the submit button in the form has a destructive action
1233          * @since 1.24
1234          */
1235         public function setSubmitDestructive() {
1236                 $this->mSubmitFlags = [ 'destructive', 'primary' ];
1237         }
1238
1239         /**
1240          * Identify that the submit button in the form has a progressive action
1241          * @since 1.25
1242          */
1243         public function setSubmitProgressive() {
1244                 $this->mSubmitFlags = [ 'progressive', 'primary' ];
1245         }
1246
1247         /**
1248          * Set the text for the submit button to a message
1249          * @since 1.19
1250          *
1251          * @param string|Message $msg Message key or Message object
1252          *
1253          * @return HTMLForm $this for chaining calls (since 1.20)
1254          */
1255         public function setSubmitTextMsg( $msg ) {
1256                 if ( !$msg instanceof Message ) {
1257                         $msg = $this->msg( $msg );
1258                 }
1259                 $this->setSubmitText( $msg->text() );
1260
1261                 return $this;
1262         }
1263
1264         /**
1265          * Get the text for the submit button, either customised or a default.
1266          * @return string
1267          */
1268         public function getSubmitText() {
1269                 return $this->mSubmitText ?: $this->msg( 'htmlform-submit' )->text();
1270         }
1271
1272         /**
1273          * @param string $name Submit button name
1274          *
1275          * @return HTMLForm $this for chaining calls (since 1.20)
1276          */
1277         public function setSubmitName( $name ) {
1278                 $this->mSubmitName = $name;
1279
1280                 return $this;
1281         }
1282
1283         /**
1284          * @param string $name Tooltip for the submit button
1285          *
1286          * @return HTMLForm $this for chaining calls (since 1.20)
1287          */
1288         public function setSubmitTooltip( $name ) {
1289                 $this->mSubmitTooltip = $name;
1290
1291                 return $this;
1292         }
1293
1294         /**
1295          * Set the id for the submit button.
1296          *
1297          * @param string $t
1298          *
1299          * @todo FIXME: Integrity of $t is *not* validated
1300          * @return HTMLForm $this for chaining calls (since 1.20)
1301          */
1302         public function setSubmitID( $t ) {
1303                 $this->mSubmitID = $t;
1304
1305                 return $this;
1306         }
1307
1308         /**
1309          * Stop a default submit button being shown for this form. This implies that an
1310          * alternate submit method must be provided manually.
1311          *
1312          * @since 1.22
1313          *
1314          * @param bool $suppressSubmit Set to false to re-enable the button again
1315          *
1316          * @return HTMLForm $this for chaining calls
1317          */
1318         public function suppressDefaultSubmit( $suppressSubmit = true ) {
1319                 $this->mShowSubmit = !$suppressSubmit;
1320
1321                 return $this;
1322         }
1323
1324         /**
1325          * Set the id of the \<table\> or outermost \<div\> element.
1326          *
1327          * @since 1.22
1328          *
1329          * @param string $id New value of the id attribute, or "" to remove
1330          *
1331          * @return HTMLForm $this for chaining calls
1332          */
1333         public function setTableId( $id ) {
1334                 $this->mTableId = $id;
1335
1336                 return $this;
1337         }
1338
1339         /**
1340          * @param string $id DOM id for the form
1341          *
1342          * @return HTMLForm $this for chaining calls (since 1.20)
1343          */
1344         public function setId( $id ) {
1345                 $this->mId = $id;
1346
1347                 return $this;
1348         }
1349
1350         /**
1351          * @param string $name 'name' attribute for the form
1352          * @return HTMLForm $this for chaining calls
1353          */
1354         public function setName( $name ) {
1355                 $this->mName = $name;
1356
1357                 return $this;
1358         }
1359
1360         /**
1361          * Prompt the whole form to be wrapped in a "<fieldset>", with
1362          * this text as its "<legend>" element.
1363          *
1364          * @param string|bool $legend If false, no wrapper or legend will be displayed.
1365          *     If true, a wrapper will be displayed, but no legend.
1366          *     If a string, a wrapper will be displayed with that string as a legend.
1367          *     The string will be escaped before being output (this doesn't support HTML).
1368          *
1369          * @return HTMLForm $this for chaining calls (since 1.20)
1370          */
1371         public function setWrapperLegend( $legend ) {
1372                 $this->mWrapperLegend = $legend;
1373
1374                 return $this;
1375         }
1376
1377         /**
1378          * Prompt the whole form to be wrapped in a "<fieldset>", with
1379          * this message as its "<legend>" element.
1380          * @since 1.19
1381          *
1382          * @param string|Message $msg Message key or Message object
1383          *
1384          * @return HTMLForm $this for chaining calls (since 1.20)
1385          */
1386         public function setWrapperLegendMsg( $msg ) {
1387                 if ( !$msg instanceof Message ) {
1388                         $msg = $this->msg( $msg );
1389                 }
1390                 $this->setWrapperLegend( $msg->text() );
1391
1392                 return $this;
1393         }
1394
1395         /**
1396          * Set the prefix for various default messages
1397          * @todo Currently only used for the "<fieldset>" legend on forms
1398          * with multiple sections; should be used elsewhere?
1399          *
1400          * @param string $p
1401          *
1402          * @return HTMLForm $this for chaining calls (since 1.20)
1403          */
1404         public function setMessagePrefix( $p ) {
1405                 $this->mMessagePrefix = $p;
1406
1407                 return $this;
1408         }
1409
1410         /**
1411          * Set the title for form submission
1412          *
1413          * @param Title $t Title of page the form is on/should be posted to
1414          *
1415          * @return HTMLForm $this for chaining calls (since 1.20)
1416          */
1417         public function setTitle( $t ) {
1418                 $this->mTitle = $t;
1419
1420                 return $this;
1421         }
1422
1423         /**
1424          * Get the title
1425          * @return Title
1426          */
1427         public function getTitle() {
1428                 return $this->mTitle === false
1429                         ? $this->getContext()->getTitle()
1430                         : $this->mTitle;
1431         }
1432
1433         /**
1434          * Set the method used to submit the form
1435          *
1436          * @param string $method
1437          *
1438          * @return HTMLForm $this for chaining calls (since 1.20)
1439          */
1440         public function setMethod( $method = 'post' ) {
1441                 $this->mMethod = strtolower( $method );
1442
1443                 return $this;
1444         }
1445
1446         /**
1447          * @return string Always lowercase
1448          */
1449         public function getMethod() {
1450                 return $this->mMethod;
1451         }
1452
1453         /**
1454          * Wraps the given $section into an user-visible fieldset.
1455          *
1456          * @param string $legend Legend text for the fieldset
1457          * @param string $section The section content in plain Html
1458          * @param array $attributes Additional attributes for the fieldset
1459          * @return string The fieldset's Html
1460          */
1461         protected function wrapFieldSetSection( $legend, $section, $attributes ) {
1462                 return Xml::fieldset( $legend, $section, $attributes ) . "\n";
1463         }
1464
1465         /**
1466          * @todo Document
1467          *
1468          * @param array[]|HTMLFormField[] $fields Array of fields (either arrays or
1469          *   objects).
1470          * @param string $sectionName ID attribute of the "<table>" tag for this
1471          *   section, ignored if empty.
1472          * @param string $fieldsetIDPrefix ID prefix for the "<fieldset>" tag of
1473          *   each subsection, ignored if empty.
1474          * @param bool &$hasUserVisibleFields Whether the section had user-visible fields.
1475          *
1476          * @return string
1477          */
1478         public function displaySection( $fields,
1479                 $sectionName = '',
1480                 $fieldsetIDPrefix = '',
1481                 &$hasUserVisibleFields = false ) {
1482                 $displayFormat = $this->getDisplayFormat();
1483
1484                 $html = [];
1485                 $subsectionHtml = '';
1486                 $hasLabel = false;
1487
1488                 // Conveniently, PHP method names are case-insensitive.
1489                 // For grep: this can call getDiv, getRaw, getInline, getVForm, getOOUI
1490                 $getFieldHtmlMethod = $displayFormat === 'table' ? 'getTableRow' : ( 'get' . $displayFormat );
1491
1492                 foreach ( $fields as $key => $value ) {
1493                         if ( $value instanceof HTMLFormField ) {
1494                                 $v = empty( $value->mParams['nodata'] )
1495                                         ? $this->mFieldData[$key]
1496                                         : $value->getDefault();
1497
1498                                 $retval = $value->$getFieldHtmlMethod( $v );
1499
1500                                 // check, if the form field should be added to
1501                                 // the output.
1502                                 if ( $value->hasVisibleOutput() ) {
1503                                         $html[] = $retval;
1504
1505                                         $labelValue = trim( $value->getLabel() );
1506                                         if ( $labelValue !== '&#160;' && $labelValue !== '' ) {
1507                                                 $hasLabel = true;
1508                                         }
1509
1510                                         $hasUserVisibleFields = true;
1511                                 }
1512                         } elseif ( is_array( $value ) ) {
1513                                 $subsectionHasVisibleFields = false;
1514                                 $section =
1515                                         $this->displaySection( $value,
1516                                                 "mw-htmlform-$key",
1517                                                 "$fieldsetIDPrefix$key-",
1518                                                 $subsectionHasVisibleFields );
1519                                 $legend = null;
1520
1521                                 if ( $subsectionHasVisibleFields === true ) {
1522                                         // Display the section with various niceties.
1523                                         $hasUserVisibleFields = true;
1524
1525                                         $legend = $this->getLegend( $key );
1526
1527                                         $section = $this->getHeaderText( $key ) .
1528                                                 $section .
1529                                                 $this->getFooterText( $key );
1530
1531                                         $attributes = [];
1532                                         if ( $fieldsetIDPrefix ) {
1533                                                 $attributes['id'] = Sanitizer::escapeId( "$fieldsetIDPrefix$key" );
1534                                         }
1535                                         $subsectionHtml .= $this->wrapFieldSetSection( $legend, $section, $attributes );
1536                                 } else {
1537                                         // Just return the inputs, nothing fancy.
1538                                         $subsectionHtml .= $section;
1539                                 }
1540                         }
1541                 }
1542
1543                 $html = $this->formatSection( $html, $sectionName, $hasLabel );
1544
1545                 if ( $subsectionHtml ) {
1546                         if ( $this->mSubSectionBeforeFields ) {
1547                                 return $subsectionHtml . "\n" . $html;
1548                         } else {
1549                                 return $html . "\n" . $subsectionHtml;
1550                         }
1551                 } else {
1552                         return $html;
1553                 }
1554         }
1555
1556         /**
1557          * Put a form section together from the individual fields' HTML, merging it and wrapping.
1558          * @param array $fieldsHtml
1559          * @param string $sectionName
1560          * @param bool $anyFieldHasLabel
1561          * @return string HTML
1562          */
1563         protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
1564                 $displayFormat = $this->getDisplayFormat();
1565                 $html = implode( '', $fieldsHtml );
1566
1567                 if ( $displayFormat === 'raw' ) {
1568                         return $html;
1569                 }
1570
1571                 $classes = [];
1572
1573                 if ( !$anyFieldHasLabel ) { // Avoid strange spacing when no labels exist
1574                         $classes[] = 'mw-htmlform-nolabel';
1575                 }
1576
1577                 $attribs = [
1578                         'class' => implode( ' ', $classes ),
1579                 ];
1580
1581                 if ( $sectionName ) {
1582                         $attribs['id'] = Sanitizer::escapeId( $sectionName );
1583                 }
1584
1585                 if ( $displayFormat === 'table' ) {
1586                         return Html::rawElement( 'table',
1587                                         $attribs,
1588                                         Html::rawElement( 'tbody', [], "\n$html\n" ) ) . "\n";
1589                 } elseif ( $displayFormat === 'inline' ) {
1590                         return Html::rawElement( 'span', $attribs, "\n$html\n" );
1591                 } else {
1592                         return Html::rawElement( 'div', $attribs, "\n$html\n" );
1593                 }
1594         }
1595
1596         /**
1597          * Construct the form fields from the Descriptor array
1598          */
1599         public function loadData() {
1600                 $fieldData = [];
1601
1602                 foreach ( $this->mFlatFields as $fieldname => $field ) {
1603                         if ( !empty( $field->mParams['nodata'] ) ) {
1604                                 continue;
1605                         } elseif ( !empty( $field->mParams['disabled'] ) ) {
1606                                 $fieldData[$fieldname] = $field->getDefault();
1607                         } else {
1608                                 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
1609                         }
1610                 }
1611
1612                 # Filter data.
1613                 foreach ( $fieldData as $name => &$value ) {
1614                         $field = $this->mFlatFields[$name];
1615                         $value = $field->filter( $value, $this->mFlatFields );
1616                 }
1617
1618                 $this->mFieldData = $fieldData;
1619         }
1620
1621         /**
1622          * Stop a reset button being shown for this form
1623          *
1624          * @param bool $suppressReset Set to false to re-enable the button again
1625          *
1626          * @return HTMLForm $this for chaining calls (since 1.20)
1627          */
1628         public function suppressReset( $suppressReset = true ) {
1629                 $this->mShowReset = !$suppressReset;
1630
1631                 return $this;
1632         }
1633
1634         /**
1635          * Overload this if you want to apply special filtration routines
1636          * to the form as a whole, after it's submitted but before it's
1637          * processed.
1638          *
1639          * @param array $data
1640          *
1641          * @return array
1642          */
1643         public function filterDataForSubmit( $data ) {
1644                 return $data;
1645         }
1646
1647         /**
1648          * Get a string to go in the "<legend>" of a section fieldset.
1649          * Override this if you want something more complicated.
1650          *
1651          * @param string $key
1652          *
1653          * @return string
1654          */
1655         public function getLegend( $key ) {
1656                 return $this->msg( "{$this->mMessagePrefix}-$key" )->text();
1657         }
1658
1659         /**
1660          * Set the value for the action attribute of the form.
1661          * When set to false (which is the default state), the set title is used.
1662          *
1663          * @since 1.19
1664          *
1665          * @param string|bool $action
1666          *
1667          * @return HTMLForm $this for chaining calls (since 1.20)
1668          */
1669         public function setAction( $action ) {
1670                 $this->mAction = $action;
1671
1672                 return $this;
1673         }
1674
1675         /**
1676          * Get the value for the action attribute of the form.
1677          *
1678          * @since 1.22
1679          *
1680          * @return string
1681          */
1682         public function getAction() {
1683                 // If an action is alredy provided, return it
1684                 if ( $this->mAction !== false ) {
1685                         return $this->mAction;
1686                 }
1687
1688                 $articlePath = $this->getConfig()->get( 'ArticlePath' );
1689                 // Check whether we are in GET mode and the ArticlePath contains a "?"
1690                 // meaning that getLocalURL() would return something like "index.php?title=...".
1691                 // As browser remove the query string before submitting GET forms,
1692                 // it means that the title would be lost. In such case use wfScript() instead
1693                 // and put title in an hidden field (see getHiddenFields()).
1694                 if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
1695                         return wfScript();
1696                 }
1697
1698                 return $this->getTitle()->getLocalURL();
1699         }
1700
1701         /**
1702          * Set the value for the autocomplete attribute of the form.
1703          * When set to false (which is the default state), the attribute get not set.
1704          *
1705          * @since 1.27
1706          *
1707          * @param string|bool $autocomplete
1708          *
1709          * @return HTMLForm $this for chaining calls
1710          */
1711         public function setAutocomplete( $autocomplete ) {
1712                 $this->mAutocomplete = $autocomplete;
1713
1714                 return $this;
1715         }
1716 }