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