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