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