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