includes/htmlform/HTMLForm.php

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