includes/HTMLForm.php

   1 <?php
   2 /**
   3  * Object handling generic submission, CSRF protection, layout and
   4  * other logic for UI forms. in a reusable manner.
   5  *
   6  * In order to generate the form, the HTMLForm object takes an array
   7  * structure detailing the form fields available. Each element of the
   8  * array is a basic property-list, including the type of field, the
   9  * label it is to be given in the form, callbacks for validation and
  10  * 'filtering', and other pertinent information.
  11  *
  12  * Field types are implemented as subclasses of the generic HTMLFormField
  13  * object, and typically implement at least getInputHTML, which generates
  14  * the HTML for the input field to be placed in the table.
  15  *
  16  * The constructor input is an associative array of $fieldname => $info,
  17  * where $info is an Associative Array with any of the following:
  18  *
  19  *      'class'               -- the subclass of HTMLFormField that will be used
  20  *                               to create the object.  *NOT* the CSS class!
  21  *      'type'                -- roughly translates into the <select> type attribute.
  22  *                               if 'class' is not specified, this is used as a map
  23  *                               through HTMLForm::$typeMappings to get the class name.
  24  *      'default'             -- default value when the form is displayed
  25  *      'id'                  -- HTML id attribute
  26  *      'cssclass'            -- CSS class
  27  *      'options'             -- varies according to the specific object.
  28  *      'label-message'       -- message key for a message to use as the label.
  29  *                               can be an array of msg key and then parameters to
  30  *                               the message.
  31  *      'label'               -- alternatively, a raw text message. Overridden by
  32  *                               label-message
  33  *      'help-message'        -- message key for a message to use as a help text.
  34  *                               can be an array of msg key and then parameters to
  35  *                               the message.
  36  *                           Overwrites 'help-messages'.
  37  *  'help-messages'       -- array of message key. As above, each item can
  38  *                           be an array of msg key and then parameters.
  39  *                           Overwrites 'help-message'.
  40  *      'required'            -- passed through to the object, indicating that it
  41  *                               is a required field.
  42  *      'size'                -- the length of text fields
  43  *      'filter-callback      -- a function name to give you the chance to
  44  *                               massage the inputted value before it's processed.
  45  *                               @see HTMLForm::filter()
  46  *      'validation-callback' -- a function name to give you the chance
  47  *                               to impose extra validation on the field input.
  48  *                               @see HTMLForm::validate()
  49  *      'name'                -- By default, the 'name' attribute of the input field
  50  *                               is "wp{$fieldname}".  If you want a different name
  51  *                               (eg one without the "wp" prefix), specify it here and
  52  *                               it will be used without modification.
  53  *
  54  * TODO: Document 'section' / 'subsection' stuff
  55  */
  56 class HTMLForm {
  57
  58         # A mapping of 'type' inputs onto standard HTMLFormField subclasses
  59         static $typeMappings = array(
  60                 'text' => 'HTMLTextField',
  61                 'textarea' => 'HTMLTextAreaField',
  62                 'select' => 'HTMLSelectField',
  63                 'radio' => 'HTMLRadioField',
  64                 'multiselect' => 'HTMLMultiSelectField',
  65                 'check' => 'HTMLCheckField',
  66                 'toggle' => 'HTMLCheckField',
  67                 'int' => 'HTMLIntField',
  68                 'float' => 'HTMLFloatField',
  69                 'info' => 'HTMLInfoField',
  70                 'selectorother' => 'HTMLSelectOrOtherField',
  71                 'selectandother' => 'HTMLSelectAndOtherField',
  72                 'submit' => 'HTMLSubmitField',
  73                 'hidden' => 'HTMLHiddenField',
  74                 'edittools' => 'HTMLEditTools',
  75
  76                 # HTMLTextField will output the correct type="" attribute automagically.
  77                 # There are about four zillion other HTML5 input types, like url, but
  78                 # we don't use those at the moment, so no point in adding all of them.
  79                 'email' => 'HTMLTextField',
  80                 'password' => 'HTMLTextField',
  81         );
  82
  83         protected $mMessagePrefix;
  84         protected $mFlatFields;
  85         protected $mFieldTree;
  86         protected $mShowReset = false;
  87         public $mFieldData;
  88
  89         protected $mSubmitCallback;
  90         protected $mValidationErrorMessage;
  91
  92         protected $mPre = '';
  93         protected $mHeader = '';
  94         protected $mFooter = '';
  95         protected $mSectionHeaders = array();
  96         protected $mSectionFooters = array();
  97         protected $mPost = '';
  98         protected $mId;
  99
 100         protected $mSubmitID;
 101         protected $mSubmitName;
 102         protected $mSubmitText;
 103         protected $mSubmitTooltip;
 104
 105         protected $mContext; // <! RequestContext
 106         protected $mTitle;
 107         protected $mMethod = 'post';
 108
 109         protected $mUseMultipart = false;
 110         protected $mHiddenFields = array();
 111         protected $mButtons = array();
 112
 113         protected $mWrapperLegend = false;
 114
 115         /**
 116          * Build a new HTMLForm from an array of field attributes
 117          * @param $descriptor Array of Field constructs, as described above
 118          * @param $context RequestContext available since 1.18, will become compulsory in 1.19.
 119          *     Obviates the need to call $form->setTitle()
 120          * @param $messagePrefix String a prefix to go in front of default messages
 121          */
 122         public function __construct( $descriptor, /*RequestContext*/ $context = null, $messagePrefix = '' ) {
 123                 if( $context instanceof RequestContext ){
 124                         $this->mContext = $context;
 125                         $this->mTitle = false; // We don't need them to set a title
 126                         $this->mMessagePrefix = $messagePrefix;
 127                 } else {
 128                         // B/C since 1.18
 129                         if( is_string( $context ) && $messagePrefix === '' ){
 130                                 // it's actually $messagePrefix
 131                                 $this->mMessagePrefix = $context;
 132                         }
 133                 }
 134
 135                 // Expand out into a tree.
 136                 $loadedDescriptor = array();
 137                 $this->mFlatFields = array();
 138
 139                 foreach ( $descriptor as $fieldname => $info ) {
 140                         $section = isset( $info['section'] )
 141                                 ? $info['section']
 142                                 : '';
 143
 144                         if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
 145                                 $this->mUseMultipart = true;
 146                         }
 147
 148                         $field = self::loadInputFromParameters( $fieldname, $info );
 149                         $field->mParent = $this;
 150
 151                         $setSection =& $loadedDescriptor;
 152                         if ( $section ) {
 153                                 $sectionParts = explode( '/', $section );
 154
 155                                 while ( count( $sectionParts ) ) {
 156                                         $newName = array_shift( $sectionParts );
 157
 158                                         if ( !isset( $setSection[$newName] ) ) {
 159                                                 $setSection[$newName] = array();
 160                                         }
 161
 162                                         $setSection =& $setSection[$newName];
 163                                 }
 164                         }
 165
 166                         $setSection[$fieldname] = $field;
 167                         $this->mFlatFields[$fieldname] = $field;
 168                 }
 169
 170                 $this->mFieldTree = $loadedDescriptor;
 171         }
 172
 173         /**
 174          * Add the HTMLForm-specific JavaScript, if it hasn't been
 175          * done already.
 176          * @deprecated since 1.18 load modules with ResourceLoader instead
 177          */
 178         static function addJS() { }
 179
 180         /**
 181          * Initialise a new Object for the field
 182          * @param $descriptor input Descriptor, as described above
 183          * @return HTMLFormField subclass
 184          */
 185         static function loadInputFromParameters( $fieldname, $descriptor ) {
 186                 if ( isset( $descriptor['class'] ) ) {
 187                         $class = $descriptor['class'];
 188                 } elseif ( isset( $descriptor['type'] ) ) {
 189                         $class = self::$typeMappings[$descriptor['type']];
 190                         $descriptor['class'] = $class;
 191                 } else {
 192                         $class = null;
 193                 }
 194
 195                 if ( !$class ) {
 196                         throw new MWException( "Descriptor with no class: " . print_r( $descriptor, true ) );
 197                 }
 198
 199                 $descriptor['fieldname'] = $fieldname;
 200
 201                 $obj = new $class( $descriptor );
 202
 203                 return $obj;
 204         }
 205
 206         /**
 207          * Prepare form for submission
 208          */
 209         function prepareForm() {
 210                 # Check if we have the info we need
 211                 if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
 212                         throw new MWException( "You must call setTitle() on an HTMLForm" );
 213                 }
 214
 215                 # Load data from the request.
 216                 $this->loadData();
 217         }
 218
 219         /**
 220          * Try submitting, with edit token check first
 221          * @return Status|boolean
 222          */
 223         function tryAuthorizedSubmit() {
 224                 $editToken = $this->getRequest()->getVal( 'wpEditToken' );
 225
 226                 $result = false;
 227                 if ( $this->getMethod() != 'post' || $this->getUser()->matchEditToken( $editToken ) ) {
 228                         $result = $this->trySubmit();
 229                 }
 230                 return $result;
 231         }
 232
 233         /**
 234          * The here's-one-I-made-earlier option: do the submission if
 235          * posted, or display the form with or without funky valiation
 236          * errors
 237          * @return Bool or Status whether submission was successful.
 238          */
 239         function show() {
 240                 $this->prepareForm();
 241
 242                 $result = $this->tryAuthorizedSubmit();
 243                 if ( $result === true || ( $result instanceof Status && $result->isGood() ) ){
 244                         return $result;
 245                 }
 246
 247                 $this->displayForm( $result );
 248                 return false;
 249         }
 250
 251         /**
 252          * Validate all the fields, and call the submision callback
 253          * function if everything is kosher.
 254          * @return Mixed Bool true == Successful submission, Bool false
 255          *       == No submission attempted, anything else == Error to
 256          *       display.
 257          */
 258         function trySubmit() {
 259                 # Check for validation
 260                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 261                         if ( !empty( $field->mParams['nodata'] ) ) {
 262                                 continue;
 263                         }
 264                         if ( $field->validate(
 265                                         $this->mFieldData[$fieldname],
 266                                         $this->mFieldData )
 267                                 !== true
 268                         ) {
 269                                 return isset( $this->mValidationErrorMessage )
 270                                         ? $this->mValidationErrorMessage
 271                                         : array( 'htmlform-invalid-input' );
 272                         }
 273                 }
 274
 275                 $callback = $this->mSubmitCallback;
 276
 277                 $data = $this->filterDataForSubmit( $this->mFieldData );
 278
 279                 $res = call_user_func( $callback, $data );
 280
 281                 return $res;
 282         }
 283
 284         /**
 285          * Set a callback to a function to do something with the form
 286          * once it's been successfully validated.
 287          * @param $cb String function name.  The function will be passed
 288          *       the output from HTMLForm::filterDataForSubmit, and must
 289          *       return Bool true on success, Bool false if no submission
 290          *       was attempted, or String HTML output to display on error.
 291          */
 292         function setSubmitCallback( $cb ) {
 293                 $this->mSubmitCallback = $cb;
 294         }
 295
 296         /**
 297          * Set a message to display on a validation error.
 298          * @param $msg Mixed String or Array of valid inputs to wfMsgExt()
 299          *       (so each entry can be either a String or Array)
 300          */
 301         function setValidationErrorMessage( $msg ) {
 302                 $this->mValidationErrorMessage = $msg;
 303         }
 304
 305         /**
 306          * Set the introductory message, overwriting any existing message.
 307          * @param $msg String complete text of message to display
 308          */
 309         function setIntro( $msg ) { $this->mPre = $msg; }
 310
 311         /**
 312          * Add introductory text.
 313          * @param $msg String complete text of message to display
 314          */
 315         function addPreText( $msg ) { $this->mPre .= $msg; }
 316
 317         /**
 318          * Add header text, inside the form.
 319          * @param $msg String complete text of message to display
 320          */
 321         function addHeaderText( $msg, $section = null ) {
 322                 if ( is_null( $section ) ) {
 323                         $this->mHeader .= $msg;
 324                 } else {
 325                         if ( !isset( $this->mSectionHeaders[$section] ) ) {
 326                                 $this->mSectionHeaders[$section] = '';
 327                         }
 328                         $this->mSectionHeaders[$section] .= $msg;
 329                 }
 330         }
 331
 332         /**
 333          * Add footer text, inside the form.
 334          * @param $msg String complete text of message to display
 335          */
 336         function addFooterText( $msg, $section = null ) {
 337                 if ( is_null( $section ) ) {
 338                         $this->mFooter .= $msg;
 339                 } else {
 340                         if ( !isset( $this->mSectionFooters[$section] ) ) {
 341                                 $this->mSectionFooters[$section] = '';
 342                         }
 343                         $this->mSectionFooters[$section] .= $msg;
 344                 }
 345         }
 346
 347         /**
 348          * Add text to the end of the display.
 349          * @param $msg String complete text of message to display
 350          */
 351         function addPostText( $msg ) { $this->mPost .= $msg; }
 352
 353         /**
 354          * Add a hidden field to the output
 355          * @param $name String field name.  This will be used exactly as entered
 356          * @param $value String field value
 357          * @param $attribs Array
 358          */
 359         public function addHiddenField( $name, $value, $attribs = array() ) {
 360                 $attribs += array( 'name' => $name );
 361                 $this->mHiddenFields[] = array( $value, $attribs );
 362         }
 363
 364         public function addButton( $name, $value, $id = null, $attribs = null ) {
 365                 $this->mButtons[] = compact( 'name', 'value', 'id', 'attribs' );
 366         }
 367
 368         /**
 369          * Display the form (sending to wgOut), with an appropriate error
 370          * message or stack of messages, and any validation errors, etc.
 371          * @param $submitResult Mixed output from HTMLForm::trySubmit()
 372          */
 373         function displayForm( $submitResult ) {
 374                 # For good measure (it is the default)
 375                 $this->getOutput()->preventClickjacking();
 376                 $this->getOutput()->addModules( 'mediawiki.htmlform' );
 377
 378                 $html = ''
 379                         . $this->getErrors( $submitResult )
 380                         . $this->mHeader
 381                         . $this->getBody()
 382                         . $this->getHiddenFields()
 383                         . $this->getButtons()
 384                         . $this->mFooter
 385                 ;
 386
 387                 $html = $this->wrapForm( $html );
 388
 389                 $this->getOutput()->addHTML( ''
 390                         . $this->mPre
 391                         . $html
 392                         . $this->mPost
 393                 );
 394         }
 395
 396         /**
 397          * Wrap the form innards in an actual <form> element
 398          * @param $html String HTML contents to wrap.
 399          * @return String wrapped HTML.
 400          */
 401         function wrapForm( $html ) {
 402
 403                 # Include a <fieldset> wrapper for style, if requested.
 404                 if ( $this->mWrapperLegend !== false ) {
 405                         $html = Xml::fieldset( $this->mWrapperLegend, $html );
 406                 }
 407                 # Use multipart/form-data
 408                 $encType = $this->mUseMultipart
 409                         ? 'multipart/form-data'
 410                         : 'application/x-www-form-urlencoded';
 411                 # Attributes
 412                 $attribs = array(
 413                         'action'  => $this->getTitle()->getFullURL(),
 414                         'method'  => $this->mMethod,
 415                         'class'   => 'visualClear',
 416                         'enctype' => $encType,
 417                 );
 418                 if ( !empty( $this->mId ) ) {
 419                         $attribs['id'] = $this->mId;
 420                 }
 421
 422                 return Html::rawElement( 'form', $attribs, $html );
 423         }
 424
 425         /**
 426          * Get the hidden fields that should go inside the form.
 427          * @return String HTML.
 428          */
 429         function getHiddenFields() {
 430                 $html = '';
 431                 if( $this->getMethod() == 'post' ){
 432                         $html .= Html::hidden( 'wpEditToken', $this->getUser()->editToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
 433                         $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
 434                 }
 435
 436                 foreach ( $this->mHiddenFields as $data ) {
 437                         list( $value, $attribs ) = $data;
 438                         $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
 439                 }
 440
 441                 return $html;
 442         }
 443
 444         /**
 445          * Get the submit and (potentially) reset buttons.
 446          * @return String HTML.
 447          */
 448         function getButtons() {
 449                 $html = '';
 450                 $attribs = array();
 451
 452                 if ( isset( $this->mSubmitID ) ) {
 453                         $attribs['id'] = $this->mSubmitID;
 454                 }
 455
 456                 if ( isset( $this->mSubmitName ) ) {
 457                         $attribs['name'] = $this->mSubmitName;
 458                 }
 459
 460                 if ( isset( $this->mSubmitTooltip ) ) {
 461                         $attribs += Linker::tooltipAndAccessKeyAttribs( $this->mSubmitTooltip );
 462                 }
 463
 464                 $attribs['class'] = 'mw-htmlform-submit';
 465
 466                 $html .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
 467
 468                 if ( $this->mShowReset ) {
 469                         $html .= Html::element(
 470                                 'input',
 471                                 array(
 472                                         'type' => 'reset',
 473                                         'value' => wfMsg( 'htmlform-reset' )
 474                                 )
 475                         ) . "\n";
 476                 }
 477
 478                 foreach ( $this->mButtons as $button ) {
 479                         $attrs = array(
 480                                 'type'  => 'submit',
 481                                 'name'  => $button['name'],
 482                                 'value' => $button['value']
 483                         );
 484
 485                         if ( $button['attribs'] ) {
 486                                 $attrs += $button['attribs'];
 487                         }
 488
 489                         if ( isset( $button['id'] ) ) {
 490                                 $attrs['id'] = $button['id'];
 491                         }
 492
 493                         $html .= Html::element( 'input', $attrs );
 494                 }
 495
 496                 return $html;
 497         }
 498
 499         /**
 500          * Get the whole body of the form.
 501          */
 502         function getBody() {
 503                 return $this->displaySection( $this->mFieldTree );
 504         }
 505
 506         /**
 507          * Format and display an error message stack.
 508          * @param $errors String|Array|Status
 509          * @return String
 510          */
 511         function getErrors( $errors ) {
 512                 if ( $errors instanceof Status ) {
 513                         if ( $errors->isOK() ) {
 514                                 $errorstr = '';
 515                         } else {
 516                                 $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
 517                         }
 518                 } elseif ( is_array( $errors ) ) {
 519                         $errorstr = $this->formatErrors( $errors );
 520                 } else {
 521                         $errorstr = $errors;
 522                 }
 523
 524                 return $errorstr
 525                         ? Html::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
 526                         : '';
 527         }
 528
 529         /**
 530          * Format a stack of error messages into a single HTML string
 531          * @param $errors Array of message keys/values
 532          * @return String HTML, a <ul> list of errors
 533          */
 534         public static function formatErrors( $errors ) {
 535                 $errorstr = '';
 536
 537                 foreach ( $errors as $error ) {
 538                         if ( is_array( $error ) ) {
 539                                 $msg = array_shift( $error );
 540                         } else {
 541                                 $msg = $error;
 542                                 $error = array();
 543                         }
 544
 545                         $errorstr .= Html::rawElement(
 546                                 'li',
 547                                 array(),
 548                                 wfMsgExt( $msg, array( 'parseinline' ), $error )
 549                         );
 550                 }
 551
 552                 $errorstr = Html::rawElement( 'ul', array(), $errorstr );
 553
 554                 return $errorstr;
 555         }
 556
 557         /**
 558          * Set the text for the submit button
 559          * @param $t String plaintext.
 560          */
 561         function setSubmitText( $t ) {
 562                 $this->mSubmitText = $t;
 563         }
 564
 565         /**
 566          * Get the text for the submit button, either customised or a default.
 567          * @return unknown_type
 568          */
 569         function getSubmitText() {
 570                 return $this->mSubmitText
 571                         ? $this->mSubmitText
 572                         : wfMsg( 'htmlform-submit' );
 573         }
 574
 575         public function setSubmitName( $name ) {
 576                 $this->mSubmitName = $name;
 577         }
 578
 579         public function setSubmitTooltip( $name ) {
 580                 $this->mSubmitTooltip = $name;
 581         }
 582
 583         /**
 584          * Set the id for the submit button.
 585          * @param $t String.  FIXME: Integrity is *not* validated
 586          */
 587         function setSubmitID( $t ) {
 588                 $this->mSubmitID = $t;
 589         }
 590
 591         public function setId( $id ) {
 592                 $this->mId = $id;
 593         }
 594         /**
 595          * Prompt the whole form to be wrapped in a <fieldset>, with
 596          * this text as its <legend> element.
 597          * @param $legend String HTML to go inside the <legend> element.
 598          *       Will be escaped
 599          */
 600         public function setWrapperLegend( $legend ) { $this->mWrapperLegend = $legend; }
 601
 602         /**
 603          * Set the prefix for various default messages
 604          * TODO: currently only used for the <fieldset> legend on forms
 605          * with multiple sections; should be used elsewhre?
 606          * @param $p String
 607          */
 608         function setMessagePrefix( $p ) {
 609                 $this->mMessagePrefix = $p;
 610         }
 611
 612         /**
 613          * Set the title for form submission
 614          * @param $t Title of page the form is on/should be posted to
 615          */
 616         function setTitle( $t ) {
 617                 $this->mTitle = $t;
 618         }
 619
 620         /**
 621          * Get the title
 622          * @return Title
 623          */
 624         function getTitle() {
 625                 return $this->mTitle === false
 626                         ? $this->getContext()->title
 627                         : $this->mTitle;
 628         }
 629
 630         /**
 631          * @return RequestContext
 632          */
 633         public function getContext(){
 634                 return $this->mContext instanceof RequestContext
 635                         ? $this->mContext
 636                         : RequestContext::getMain();
 637         }
 638
 639         /**
 640          * @return OutputPage
 641          */
 642         public function getOutput(){
 643                 return $this->getContext()->output;
 644         }
 645
 646         /**
 647          * @return WebRequest
 648          */
 649         public function getRequest(){
 650                 return $this->getContext()->request;
 651         }
 652
 653         /**
 654          * @return User
 655          */
 656         public function getUser(){
 657                 return $this->getContext()->user;
 658         }
 659
 660         /**
 661          * Set the method used to submit the form
 662          * @param $method String
 663          */
 664         public function setMethod( $method='post' ){
 665                 $this->mMethod = $method;
 666         }
 667
 668         public function getMethod(){
 669                 return $this->mMethod;
 670         }
 671
 672         /**
 673          * TODO: Document
 674          * @param $fields
 675          */
 676         function displaySection( $fields, $sectionName = '' ) {
 677                 $tableHtml = '';
 678                 $subsectionHtml = '';
 679                 $hasLeftColumn = false;
 680
 681                 foreach ( $fields as $key => $value ) {
 682                         if ( is_object( $value ) ) {
 683                                 $v = empty( $value->mParams['nodata'] )
 684                                         ? $this->mFieldData[$key]
 685                                         : $value->getDefault();
 686                                 $tableHtml .= $value->getTableRow( $v );
 687
 688                                 if ( $value->getLabel() != '&#160;' )
 689                                         $hasLeftColumn = true;
 690                         } elseif ( is_array( $value ) ) {
 691                                 $section = $this->displaySection( $value, $key );
 692                                 $legend = $this->getLegend( $key );
 693                                 if ( isset( $this->mSectionHeaders[$key] ) ) {
 694                                         $section = $this->mSectionHeaders[$key] . $section;
 695                                 }
 696                                 if ( isset( $this->mSectionFooters[$key] ) ) {
 697                                         $section .= $this->mSectionFooters[$key];
 698                                 }
 699                                 $subsectionHtml .= Xml::fieldset( $legend, $section ) . "\n";
 700                         }
 701                 }
 702
 703                 $classes = array();
 704
 705                 if ( !$hasLeftColumn ) { // Avoid strange spacing when no labels exist
 706                         $classes[] = 'mw-htmlform-nolabel';
 707                 }
 708
 709                 $attribs = array(
 710                         'class' => implode( ' ', $classes ),
 711                 );
 712
 713                 if ( $sectionName ) {
 714                         $attribs['id'] = Sanitizer::escapeId( "mw-htmlform-$sectionName" );
 715                 }
 716
 717                 $tableHtml = Html::rawElement( 'table', $attribs,
 718                         Html::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n";
 719
 720                 return $subsectionHtml . "\n" . $tableHtml;
 721         }
 722
 723         /**
 724          * Construct the form fields from the Descriptor array
 725          */
 726         function loadData() {
 727                 $fieldData = array();
 728
 729                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 730                         if ( !empty( $field->mParams['nodata'] ) ) {
 731                                 continue;
 732                         } elseif ( !empty( $field->mParams['disabled'] ) ) {
 733                                 $fieldData[$fieldname] = $field->getDefault();
 734                         } else {
 735                                 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
 736                         }
 737                 }
 738
 739                 # Filter data.
 740                 foreach ( $fieldData as $name => &$value ) {
 741                         $field = $this->mFlatFields[$name];
 742                         $value = $field->filter( $value, $this->mFlatFields );
 743                 }
 744
 745                 $this->mFieldData = $fieldData;
 746         }
 747
 748         /**
 749          * Stop a reset button being shown for this form
 750          * @param $suppressReset Bool set to false to re-enable the
 751          *       button again
 752          */
 753         function suppressReset( $suppressReset = true ) {
 754                 $this->mShowReset = !$suppressReset;
 755         }
 756
 757         /**
 758          * Overload this if you want to apply special filtration routines
 759          * to the form as a whole, after it's submitted but before it's
 760          * processed.
 761          * @param $data
 762          * @return unknown_type
 763          */
 764         function filterDataForSubmit( $data ) {
 765                 return $data;
 766         }
 767
 768         /**
 769          * Get a string to go in the <legend> of a section fieldset.  Override this if you
 770          * want something more complicated
 771          * @param $key String
 772          * @return String
 773          */
 774         public function getLegend( $key ) {
 775                 return wfMsg( "{$this->mMessagePrefix}-$key" );
 776         }
 777 }
 778
 779 /**
 780  * The parent class to generate form fields.  Any field type should
 781  * be a subclass of this.
 782  */
 783 abstract class HTMLFormField {
 784
 785         protected $mValidationCallback;
 786         protected $mFilterCallback;
 787         protected $mName;
 788         public $mParams;
 789         protected $mLabel;      # String label.  Set on construction
 790         protected $mID;
 791         protected $mClass = '';
 792         protected $mDefault;
 793
 794         /**
 795          * @var HTMLForm
 796          */
 797         public $mParent;
 798
 799         /**
 800          * This function must be implemented to return the HTML to generate
 801          * the input object itself.  It should not implement the surrounding
 802          * table cells/rows, or labels/help messages.
 803          * @param $value String the value to set the input to; eg a default
 804          *       text for a text input.
 805          * @return String valid HTML.
 806          */
 807         abstract function getInputHTML( $value );
 808
 809         /**
 810          * Override this function to add specific validation checks on the
 811          * field input.  Don't forget to call parent::validate() to ensure
 812          * that the user-defined callback mValidationCallback is still run
 813          * @param $value String the value the field was submitted with
 814          * @param $alldata Array the data collected from the form
 815          * @return Mixed Bool true on success, or String error to display.
 816          */
 817         function validate( $value, $alldata ) {
 818                 if ( isset( $this->mValidationCallback ) ) {
 819                         return call_user_func( $this->mValidationCallback, $value, $alldata );
 820                 }
 821
 822                 if ( isset( $this->mParams['required'] ) && $value === '' ) {
 823                         return wfMsgExt( 'htmlform-required', 'parseinline' );
 824                 }
 825
 826                 return true;
 827         }
 828
 829         function filter( $value, $alldata ) {
 830                 if ( isset( $this->mFilterCallback ) ) {
 831                         $value = call_user_func( $this->mFilterCallback, $value, $alldata );
 832                 }
 833
 834                 return $value;
 835         }
 836
 837         /**
 838          * Should this field have a label, or is there no input element with the
 839          * appropriate id for the label to point to?
 840          *
 841          * @return bool True to output a label, false to suppress
 842          */
 843         protected function needsLabel() {
 844                 return true;
 845         }
 846
 847         /**
 848          * Get the value that this input has been set to from a posted form,
 849          * or the input's default value if it has not been set.
 850          * @param $request WebRequest
 851          * @return String the value
 852          */
 853         function loadDataFromRequest( $request ) {
 854                 if ( $request->getCheck( $this->mName ) ) {
 855                         return $request->getText( $this->mName );
 856                 } else {
 857                         return $this->getDefault();
 858                 }
 859         }
 860
 861         /**
 862          * Initialise the object
 863          * @param $params Associative Array. See HTMLForm doc for syntax.
 864          */
 865         function __construct( $params ) {
 866                 $this->mParams = $params;
 867
 868                 # Generate the label from a message, if possible
 869                 if ( isset( $params['label-message'] ) ) {
 870                         $msgInfo = $params['label-message'];
 871
 872                         if ( is_array( $msgInfo ) ) {
 873                                 $msg = array_shift( $msgInfo );
 874                         } else {
 875                                 $msg = $msgInfo;
 876                                 $msgInfo = array();
 877                         }
 878
 879                         $this->mLabel = wfMsgExt( $msg, 'parseinline', $msgInfo );
 880                 } elseif ( isset( $params['label'] ) ) {
 881                         $this->mLabel = $params['label'];
 882                 }
 883
 884                 $this->mName = "wp{$params['fieldname']}";
 885                 if ( isset( $params['name'] ) ) {
 886                         $this->mName = $params['name'];
 887                 }
 888
 889                 $validName = Sanitizer::escapeId( $this->mName );
 890                 if ( $this->mName != $validName && !isset( $params['nodata'] ) ) {
 891                         throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__ );
 892                 }
 893
 894                 $this->mID = "mw-input-{$this->mName}";
 895
 896                 if ( isset( $params['default'] ) ) {
 897                         $this->mDefault = $params['default'];
 898                 }
 899
 900                 if ( isset( $params['id'] ) ) {
 901                         $id = $params['id'];
 902                         $validId = Sanitizer::escapeId( $id );
 903
 904                         if ( $id != $validId ) {
 905                                 throw new MWException( "Invalid id '$id' passed to " . __METHOD__ );
 906                         }
 907
 908                         $this->mID = $id;
 909                 }
 910
 911                 if ( isset( $params['cssclass'] ) ) {
 912                         $this->mClass = $params['cssclass'];
 913                 }
 914
 915                 if ( isset( $params['validation-callback'] ) ) {
 916                         $this->mValidationCallback = $params['validation-callback'];
 917                 }
 918
 919                 if ( isset( $params['filter-callback'] ) ) {
 920                         $this->mFilterCallback = $params['filter-callback'];
 921                 }
 922         }
 923
 924         /**
 925          * Get the complete table row for the input, including help text,
 926          * labels, and whatever.
 927          * @param $value String the value to set the input to.
 928          * @return String complete HTML table row.
 929          */
 930         function getTableRow( $value ) {
 931                 # Check for invalid data.
 932
 933                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 934
 935                 $cellAttributes = array();
 936                 $verticalLabel = false;
 937
 938                 if ( !empty($this->mParams['vertical-label']) ) {
 939                         $cellAttributes['colspan'] = 2;
 940                         $verticalLabel = true;
 941                 }
 942
 943                 if ( $errors === true || ( !$this->mParent->getRequest()->wasPosted() && ( $this->mParent->getMethod() == 'post' ) ) ) {
 944                         $errors = '';
 945                         $errorClass = '';
 946                 } else {
 947                         $errors = self::formatErrors( $errors );
 948                         $errorClass = 'mw-htmlform-invalid-input';
 949                 }
 950
 951                 $label = $this->getLabelHtml( $cellAttributes );
 952                 $field = Html::rawElement(
 953                         'td',
 954                         array( 'class' => 'mw-input' ) + $cellAttributes,
 955                         $this->getInputHTML( $value ) . "\n$errors"
 956                 );
 957
 958                 $fieldType = get_class( $this );
 959
 960                 if ( $verticalLabel ) {
 961                         $html = Html::rawElement( 'tr',
 962                                 array( 'class' => 'mw-htmlform-vertical-label' ), $label );
 963                         $html .= Html::rawElement( 'tr',
 964                                 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
 965                                 $field );
 966                 } else {
 967                         $html = Html::rawElement( 'tr',
 968                                 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
 969                                 $label . $field );
 970                 }
 971
 972                 $helptext = null;
 973
 974                 if ( isset( $this->mParams['help-message'] ) ) {
 975                         $msg = $this->mParams['help-message'];
 976                         $helptext = wfMsgExt( $msg, 'parseinline' );
 977                         if ( wfEmptyMsg( $msg ) ) {
 978                                 # Never mind
 979                                 $helptext = null;
 980                         }
 981                 } elseif ( isset( $this->mParams['help-messages'] ) ) {
 982                         # help-message can be passed a message key (string) or an array containing
 983                         # a message key and additional parameters. This makes it impossible to pass
 984                         # an array of message key
 985                         foreach( $this->mParams['help-messages'] as $msg ) {
 986                                 $candidate = wfMsgExt( $msg, 'parseinline' );
 987                                 if( wfEmptyMsg( $msg ) ) {
 988                                         $candidate = null;
 989                                 }
 990                                 $helptext .= $candidate; // append message
 991                         }
 992                 } elseif ( isset( $this->mParams['help'] ) ) {
 993                         $helptext = $this->mParams['help'];
 994                 }
 995
 996                 if ( !is_null( $helptext ) ) {
 997                         $row = Html::rawElement( 'td', array( 'colspan' => 2, 'class' => 'htmlform-tip' ),
 998                                 $helptext );
 999                         $row = Html::rawElement( 'tr', array(), $row );
1000                         $html .= "$row\n";
1001                 }
1002
1003                 return $html;
1004         }
1005
1006         function getLabel() {
1007                 return $this->mLabel;
1008         }
1009         function getLabelHtml( $cellAttributes = array() ) {
1010                 # Don't output a for= attribute for labels with no associated input.
1011                 # Kind of hacky here, possibly we don't want these to be <label>s at all.
1012                 $for = array();
1013
1014                 if ( $this->needsLabel() ) {
1015                         $for['for'] = $this->mID;
1016                 }
1017
1018                 return Html::rawElement( 'td', array( 'class' => 'mw-label' ) + $cellAttributes,
1019                         Html::rawElement( 'label', $for, $this->getLabel() )
1020                 );
1021         }
1022
1023         function getDefault() {
1024                 if ( isset( $this->mDefault ) ) {
1025                         return $this->mDefault;
1026                 } else {
1027                         return null;
1028                 }
1029         }
1030
1031         /**
1032          * Returns the attributes required for the tooltip and accesskey.
1033          *
1034          * @return array Attributes
1035          */
1036         public function getTooltipAndAccessKey() {
1037                 if ( empty( $this->mParams['tooltip'] ) ) {
1038                         return array();
1039                 }
1040                 return Linker::tooltipAndAccessKeyAttribs( $this->mParams['tooltip'] );
1041         }
1042
1043         /**
1044          * flatten an array of options to a single array, for instance,
1045          * a set of <options> inside <optgroups>.
1046          * @param $options Associative Array with values either Strings
1047          *       or Arrays
1048          * @return Array flattened input
1049          */
1050         public static function flattenOptions( $options ) {
1051                 $flatOpts = array();
1052
1053                 foreach ( $options as $value ) {
1054                         if ( is_array( $value ) ) {
1055                                 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1056                         } else {
1057                                 $flatOpts[] = $value;
1058                         }
1059                 }
1060
1061                 return $flatOpts;
1062         }
1063
1064         /**
1065          * Formats one or more errors as accepted by field validation-callback.
1066          * @param $errors String|Message|Array of strings or Message instances
1067          * @return String html
1068          * @since 1.18
1069          */
1070         protected static function formatErrors( $errors ) {
1071                 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1072                         $errors = array_shift( $errors );
1073                 }
1074
1075                 if ( is_array( $errors ) ) {
1076                         $lines = array();
1077                         foreach ( $errors as $error ) {
1078                                 if ( $error instanceof Message ) {
1079                                         $lines[] = Html::rawElement( 'li', array(), $error->parse() );
1080                                 } else {
1081                                         $lines[] = Html::rawElement( 'li', array(), $error );
1082                                 }
1083                         }
1084                         return Html::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1085                 } else {
1086                         if ( $errors instanceof Message ) {
1087                                 $errors = $errors->parse();
1088                         }
1089                         return Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
1090                 }
1091         }
1092 }
1093
1094 class HTMLTextField extends HTMLFormField {
1095         function getSize() {
1096                 return isset( $this->mParams['size'] )
1097                         ? $this->mParams['size']
1098                         : 45;
1099         }
1100
1101         function getInputHTML( $value ) {
1102                 $attribs = array(
1103                         'id' => $this->mID,
1104                         'name' => $this->mName,
1105                         'size' => $this->getSize(),
1106                         'value' => $value,
1107                 ) + $this->getTooltipAndAccessKey();
1108
1109                 if ( isset( $this->mParams['maxlength'] ) ) {
1110                         $attribs['maxlength'] = $this->mParams['maxlength'];
1111                 }
1112
1113                 if ( !empty( $this->mParams['disabled'] ) ) {
1114                         $attribs['disabled'] = 'disabled';
1115                 }
1116
1117                 # TODO: Enforce pattern, step, required, readonly on the server side as
1118                 # well
1119                 foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
1120                 'placeholder' ) as $param ) {
1121                         if ( isset( $this->mParams[$param] ) ) {
1122                                 $attribs[$param] = $this->mParams[$param];
1123                         }
1124                 }
1125
1126                 foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as $param ) {
1127                         if ( isset( $this->mParams[$param] ) ) {
1128                                 $attribs[$param] = '';
1129                         }
1130                 }
1131
1132                 # Implement tiny differences between some field variants
1133                 # here, rather than creating a new class for each one which
1134                 # is essentially just a clone of this one.
1135                 if ( isset( $this->mParams['type'] ) ) {
1136                         switch ( $this->mParams['type'] ) {
1137                                 case 'email':
1138                                         $attribs['type'] = 'email';
1139                                         break;
1140                                 case 'int':
1141                                         $attribs['type'] = 'number';
1142                                         break;
1143                                 case 'float':
1144                                         $attribs['type'] = 'number';
1145                                         $attribs['step'] = 'any';
1146                                         break;
1147                                 # Pass through
1148                                 case 'password':
1149                                 case 'file':
1150                                         $attribs['type'] = $this->mParams['type'];
1151                                         break;
1152                         }
1153                 }
1154
1155                 return Html::element( 'input', $attribs );
1156         }
1157 }
1158 class HTMLTextAreaField extends HTMLFormField {
1159         function getCols() {
1160                 return isset( $this->mParams['cols'] )
1161                         ? $this->mParams['cols']
1162                         : 80;
1163         }
1164
1165         function getRows() {
1166                 return isset( $this->mParams['rows'] )
1167                         ? $this->mParams['rows']
1168                         : 25;
1169         }
1170
1171         function getInputHTML( $value ) {
1172                 $attribs = array(
1173                         'id' => $this->mID,
1174                         'name' => $this->mName,
1175                         'cols' => $this->getCols(),
1176                         'rows' => $this->getRows(),
1177                 ) + $this->getTooltipAndAccessKey();
1178
1179
1180                 if ( !empty( $this->mParams['disabled'] ) ) {
1181                         $attribs['disabled'] = 'disabled';
1182                 }
1183
1184                 if ( !empty( $this->mParams['readonly'] ) ) {
1185                         $attribs['readonly'] = 'readonly';
1186                 }
1187
1188                 foreach ( array( 'required', 'autofocus' ) as $param ) {
1189                         if ( isset( $this->mParams[$param] ) ) {
1190                                 $attribs[$param] = '';
1191                         }
1192                 }
1193
1194                 return Html::element( 'textarea', $attribs, $value );
1195         }
1196 }
1197
1198 /**
1199  * A field that will contain a numeric value
1200  */
1201 class HTMLFloatField extends HTMLTextField {
1202         function getSize() {
1203                 return isset( $this->mParams['size'] )
1204                         ? $this->mParams['size']
1205                         : 20;
1206         }
1207
1208         function validate( $value, $alldata ) {
1209                 $p = parent::validate( $value, $alldata );
1210
1211                 if ( $p !== true ) {
1212                         return $p;
1213                 }
1214
1215                 $value = trim( $value );
1216
1217                 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#real-numbers
1218                 # with the addition that a leading '+' sign is ok.
1219                 if ( !preg_match( '/^((\+|\-)?\d+(\.\d+)?(E(\+|\-)?\d+)?)?$/i', $value ) ) {
1220                         return wfMsgExt( 'htmlform-float-invalid', 'parse' );
1221                 }
1222
1223                 # The "int" part of these message names is rather confusing.
1224                 # They make equal sense for all numbers.
1225                 if ( isset( $this->mParams['min'] ) ) {
1226                         $min = $this->mParams['min'];
1227
1228                         if ( $min > $value ) {
1229                                 return wfMsgExt( 'htmlform-int-toolow', 'parse', array( $min ) );
1230                         }
1231                 }
1232
1233                 if ( isset( $this->mParams['max'] ) ) {
1234                         $max = $this->mParams['max'];
1235
1236                         if ( $max < $value ) {
1237                                 return wfMsgExt( 'htmlform-int-toohigh', 'parse', array( $max ) );
1238                         }
1239                 }
1240
1241                 return true;
1242         }
1243 }
1244
1245 /**
1246  * A field that must contain a number
1247  */
1248 class HTMLIntField extends HTMLFloatField {
1249         function validate( $value, $alldata ) {
1250                 $p = parent::validate( $value, $alldata );
1251
1252                 if ( $p !== true ) {
1253                         return $p;
1254                 }
1255
1256                 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#signed-integers
1257                 # with the addition that a leading '+' sign is ok. Note that leading zeros
1258                 # are fine, and will be left in the input, which is useful for things like
1259                 # phone numbers when you know that they are integers (the HTML5 type=tel
1260                 # input does not require its value to be numeric).  If you want a tidier
1261                 # value to, eg, save in the DB, clean it up with intval().
1262                 if ( !preg_match( '/^((\+|\-)?\d+)?$/', trim( $value ) )
1263                 ) {
1264                         return wfMsgExt( 'htmlform-int-invalid', 'parse' );
1265                 }
1266
1267                 return true;
1268         }
1269 }
1270
1271 /**
1272  * A checkbox field
1273  */
1274 class HTMLCheckField extends HTMLFormField {
1275         function getInputHTML( $value ) {
1276                 if ( !empty( $this->mParams['invert'] ) ) {
1277                         $value = !$value;
1278                 }
1279
1280                 $attr = $this->getTooltipAndAccessKey();
1281                 $attr['id'] = $this->mID;
1282
1283                 if ( !empty( $this->mParams['disabled'] ) ) {
1284                         $attr['disabled'] = 'disabled';
1285                 }
1286
1287                 return Xml::check( $this->mName, $value, $attr ) . '&#160;' .
1288                         Html::rawElement( 'label', array( 'for' => $this->mID ), $this->mLabel );
1289         }
1290
1291         /**
1292          * For a checkbox, the label goes on the right hand side, and is
1293          * added in getInputHTML(), rather than HTMLFormField::getRow()
1294          */
1295         function getLabel() {
1296                 return '&#160;';
1297         }
1298
1299         /**
1300          * @param  $request WebRequest
1301          * @return String
1302          */
1303         function loadDataFromRequest( $request ) {
1304                 $invert = false;
1305                 if ( isset( $this->mParams['invert'] ) && $this->mParams['invert'] ) {
1306                         $invert = true;
1307                 }
1308
1309                 // GetCheck won't work like we want for checks.
1310                 if ( $request->getCheck( 'wpEditToken' ) || $this->mParent->getMethod() != 'post' ) {
1311                         // XOR has the following truth table, which is what we want
1312                         // INVERT VALUE | OUTPUT
1313                         // true   true  | false
1314                         // false  true  | true
1315                         // false  false | false
1316                         // true   false | true
1317                         return $request->getBool( $this->mName ) xor $invert;
1318                 } else {
1319                         return $this->getDefault();
1320                 }
1321         }
1322 }
1323
1324 /**
1325  * A select dropdown field.  Basically a wrapper for Xmlselect class
1326  */
1327 class HTMLSelectField extends HTMLFormField {
1328         function validate( $value, $alldata ) {
1329                 $p = parent::validate( $value, $alldata );
1330
1331                 if ( $p !== true ) {
1332                         return $p;
1333                 }
1334
1335                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1336
1337                 if ( in_array( $value, $validOptions ) )
1338                         return true;
1339                 else
1340                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1341         }
1342
1343         function getInputHTML( $value ) {
1344                 $select = new XmlSelect( $this->mName, $this->mID, strval( $value ) );
1345
1346                 # If one of the options' 'name' is int(0), it is automatically selected.
1347                 # because PHP sucks and thinks int(0) == 'some string'.
1348                 # Working around this by forcing all of them to strings.
1349                 foreach( $this->mParams['options'] as &$opt ){
1350                         if( is_int( $opt ) ){
1351                                 $opt = strval( $opt );
1352                         }
1353                 }
1354                 unset( $opt ); # PHP keeps $opt around as a reference, which is a bit scary
1355
1356                 if ( !empty( $this->mParams['disabled'] ) ) {
1357                         $select->setAttribute( 'disabled', 'disabled' );
1358                 }
1359
1360                 $select->addOptions( $this->mParams['options'] );
1361
1362                 return $select->getHTML();
1363         }
1364 }
1365
1366 /**
1367  * Select dropdown field, with an additional "other" textbox.
1368  */
1369 class HTMLSelectOrOtherField extends HTMLTextField {
1370         static $jsAdded = false;
1371
1372         function __construct( $params ) {
1373                 if ( !in_array( 'other', $params['options'], true ) ) {
1374                         $params['options'][wfMsg( 'htmlform-selectorother-other' )] = 'other';
1375                 }
1376
1377                 parent::__construct( $params );
1378         }
1379
1380         static function forceToStringRecursive( $array ) {
1381                 if ( is_array( $array ) ) {
1382                         return array_map( array( __CLASS__, 'forceToStringRecursive' ), $array );
1383                 } else {
1384                         return strval( $array );
1385                 }
1386         }
1387
1388         function getInputHTML( $value ) {
1389                 $valInSelect = false;
1390
1391                 if ( $value !== false ) {
1392                         $valInSelect = in_array(
1393                                 $value,
1394                                 HTMLFormField::flattenOptions( $this->mParams['options'] )
1395                         );
1396                 }
1397
1398                 $selected = $valInSelect ? $value : 'other';
1399
1400                 $opts = self::forceToStringRecursive( $this->mParams['options'] );
1401
1402                 $select = new XmlSelect( $this->mName, $this->mID, $selected );
1403                 $select->addOptions( $opts );
1404
1405                 $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
1406
1407                 $tbAttribs = array( 'id' => $this->mID . '-other', 'size' => $this->getSize() );
1408
1409                 if ( !empty( $this->mParams['disabled'] ) ) {
1410                         $select->setAttribute( 'disabled', 'disabled' );
1411                         $tbAttribs['disabled'] = 'disabled';
1412                 }
1413
1414                 $select = $select->getHTML();
1415
1416                 if ( isset( $this->mParams['maxlength'] ) ) {
1417                         $tbAttribs['maxlength'] = $this->mParams['maxlength'];
1418                 }
1419
1420                 $textbox = Html::input(
1421                         $this->mName . '-other',
1422                         $valInSelect ? '' : $value,
1423                         'text',
1424                         $tbAttribs
1425                 );
1426
1427                 return "$select<br />\n$textbox";
1428         }
1429
1430         /**
1431          * @param  $request WebRequest
1432          * @return String
1433          */
1434         function loadDataFromRequest( $request ) {
1435                 if ( $request->getCheck( $this->mName ) ) {
1436                         $val = $request->getText( $this->mName );
1437
1438                         if ( $val == 'other' ) {
1439                                 $val = $request->getText( $this->mName . '-other' );
1440                         }
1441
1442                         return $val;
1443                 } else {
1444                         return $this->getDefault();
1445                 }
1446         }
1447 }
1448
1449 /**
1450  * Multi-select field
1451  */
1452 class HTMLMultiSelectField extends HTMLFormField {
1453
1454         public function __construct( $params ){
1455                 parent::__construct( $params );
1456                 if( isset( $params['flatlist'] ) ){
1457                         $this->mClass .= ' mw-htmlform-multiselect-flatlist';
1458                 }
1459         }
1460
1461         function validate( $value, $alldata ) {
1462                 $p = parent::validate( $value, $alldata );
1463
1464                 if ( $p !== true ) {
1465                         return $p;
1466                 }
1467
1468                 if ( !is_array( $value ) ) {
1469                         return false;
1470                 }
1471
1472                 # If all options are valid, array_intersect of the valid options
1473                 # and the provided options will return the provided options.
1474                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1475
1476                 $validValues = array_intersect( $value, $validOptions );
1477                 if ( count( $validValues ) == count( $value ) ) {
1478                         return true;
1479                 } else {
1480                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1481                 }
1482         }
1483
1484         function getInputHTML( $value ) {
1485                 $html = $this->formatOptions( $this->mParams['options'], $value );
1486
1487                 return $html;
1488         }
1489
1490         function formatOptions( $options, $value ) {
1491                 $html = '';
1492
1493                 $attribs = array();
1494
1495                 if ( !empty( $this->mParams['disabled'] ) ) {
1496                         $attribs['disabled'] = 'disabled';
1497                 }
1498
1499                 foreach ( $options as $label => $info ) {
1500                         if ( is_array( $info ) ) {
1501                                 $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
1502                                 $html .= $this->formatOptions( $info, $value );
1503                         } else {
1504                                 $thisAttribs = array( 'id' => "{$this->mID}-$info", 'value' => $info );
1505
1506                                 $checkbox = Xml::check(
1507                                         $this->mName . '[]',
1508                                         in_array( $info, $value, true ),
1509                                         $attribs + $thisAttribs );
1510                                 $checkbox .= '&#160;' . Html::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label );
1511
1512                                 $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-multiselect-item' ), $checkbox );
1513                         }
1514                 }
1515
1516                 return $html;
1517         }
1518
1519         /**
1520          * @param  $request WebRequest
1521          * @return String
1522          */
1523         function loadDataFromRequest( $request ) {
1524                 if ( $this->mParent->getMethod() == 'post' ) {
1525                         if( $request->wasPosted() ){
1526                                 # Checkboxes are just not added to the request arrays if they're not checked,
1527                                 # so it's perfectly possible for there not to be an entry at all
1528                                 return $request->getArray( $this->mName, array() );
1529                         } else {
1530                                 # That's ok, the user has not yet submitted the form, so show the defaults
1531                                 return $this->getDefault();
1532                         }
1533                 } else {
1534                         # This is the impossible case: if we look at $_GET and see no data for our
1535                         # field, is it because the user has not yet submitted the form, or that they
1536                         # have submitted it with all the options unchecked? We will have to assume the
1537                         # latter, which basically means that you can't specify 'positive' defaults
1538                         # for GET forms.  FIXME...
1539                         return $request->getArray( $this->mName, array() );
1540                 }
1541         }
1542
1543         function getDefault() {
1544                 if ( isset( $this->mDefault ) ) {
1545                         return $this->mDefault;
1546                 } else {
1547                         return array();
1548                 }
1549         }
1550
1551         protected function needsLabel() {
1552                 return false;
1553         }
1554 }
1555
1556 /**
1557  * Double field with a dropdown list constructed from a system message in the format
1558  *     * Optgroup header
1559  *     ** <option value>|<option name>
1560  *     ** <option value == option name>
1561  *     * New Optgroup header
1562  * Plus a text field underneath for an additional reason.  The 'value' of the field is
1563  * ""<select>: <extra reason>"", or "<extra reason>" if nothing has been selected in the
1564  * select dropdown.
1565  * FIXME: If made 'required', only the text field should be compulsory.
1566  */
1567 class HTMLSelectAndOtherField extends HTMLSelectField {
1568
1569         function __construct( $params ) {
1570                 if ( array_key_exists( 'other', $params ) ) {
1571                 } elseif( array_key_exists( 'other-message', $params ) ){
1572                         $params['other'] = wfMsg( $params['other-message'] );
1573                 } else {
1574                         $params['other'] = wfMsg( 'htmlform-selectorother-other' );
1575                 }
1576
1577                 if ( array_key_exists( 'options', $params ) ) {
1578                         # Options array already specified
1579                 } elseif( array_key_exists( 'options-message', $params ) ){
1580                         # Generate options array from a system message
1581                         $params['options'] = self::parseMessage( wfMsg( $params['options-message'], $params['other'] ) );
1582                 } else {
1583                         # Sulk
1584                         throw new MWException( 'HTMLSelectAndOtherField called without any options' );
1585                 }
1586                 $this->mFlatOptions = self::flattenOptions( $params['options'] );
1587
1588                 parent::__construct( $params );
1589         }
1590
1591         /**
1592          * Build a drop-down box from a textual list.
1593          * @param $string String message text
1594          * @param $otherName String name of "other reason" option
1595          * @return Array
1596          * TODO: this is copied from Xml::listDropDown(), deprecate/avoid duplication?
1597          */
1598         public static function parseMessage( $string, $otherName=null ) {
1599                 if( $otherName === null ){
1600                         $otherName = wfMsg( 'htmlform-selectorother-other' );
1601                 }
1602
1603                 $optgroup = false;
1604                 $options = array( $otherName => 'other' );
1605
1606                 foreach ( explode( "\n", $string ) as $option ) {
1607                         $value = trim( $option );
1608                         if ( $value == '' ) {
1609                                 continue;
1610                         } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
1611                                 # A new group is starting...
1612                                 $value = trim( substr( $value, 1 ) );
1613                                 $optgroup = $value;
1614                         } elseif ( substr( $value, 0, 2) == '**' ) {
1615                                 # groupmember
1616                                 $opt = trim( substr( $value, 2 ) );
1617                                 $parts = array_map( 'trim', explode( '|', $opt, 2 ) );
1618                                 if( count( $parts ) === 1 ){
1619                                         $parts[1] = $parts[0];
1620                                 }
1621                                 if( $optgroup === false ){
1622                                         $options[$parts[1]] = $parts[0];
1623                                 } else {
1624                                         $options[$optgroup][$parts[1]] = $parts[0];
1625                                 }
1626                         } else {
1627                                 # groupless reason list
1628                                 $optgroup = false;
1629                                 $parts = array_map( 'trim', explode( '|', $option, 2 ) );
1630                                 if( count( $parts ) === 1 ){
1631                                         $parts[1] = $parts[0];
1632                                 }
1633                                 $options[$parts[1]] = $parts[0];
1634                         }
1635                 }
1636
1637                 return $options;
1638         }
1639
1640         function getInputHTML( $value ) {
1641                 $select = parent::getInputHTML( $value[1] );
1642
1643                 $textAttribs = array(
1644                         'id' => $this->mID . '-other',
1645                         'size' => $this->getSize(),
1646                 );
1647
1648                 foreach ( array( 'required', 'autofocus', 'multiple', 'disabled' ) as $param ) {
1649                         if ( isset( $this->mParams[$param] ) ) {
1650                                 $textAttribs[$param] = '';
1651                         }
1652                 }
1653
1654                 $textbox = Html::input(
1655                         $this->mName . '-other',
1656                         $value[2],
1657                         'text',
1658                         $textAttribs
1659                 );
1660
1661                 return "$select<br />\n$textbox";
1662         }
1663
1664         /**
1665          * @param  $request WebRequest
1666          * @return Array( <overall message>, <select value>, <text field value> )
1667          */
1668         function loadDataFromRequest( $request ) {
1669                 if ( $request->getCheck( $this->mName ) ) {
1670
1671                         $list = $request->getText( $this->mName );
1672                         $text = $request->getText( $this->mName . '-other' );
1673
1674                         if ( $list == 'other' ) {
1675                                 $final = $text;
1676                         } elseif( !in_array( $list, $this->mFlatOptions ) ){
1677                                 # User has spoofed the select form to give an option which wasn't
1678                                 # in the original offer.  Sulk...
1679                                 $final = $text;
1680                         } elseif( $text == '' ) {
1681                                 $final = $list;
1682                         } else {
1683                                 $final = $list . wfMsgForContent( 'colon-separator' ) . $text;
1684                         }
1685
1686                 } else {
1687                         $final = $this->getDefault();
1688                         $list = $text = '';
1689                 }
1690                 return array( $final, $list, $text );
1691         }
1692
1693         function getSize() {
1694                 return isset( $this->mParams['size'] )
1695                         ? $this->mParams['size']
1696                         : 45;
1697         }
1698
1699         function validate( $value, $alldata ) {
1700                 # HTMLSelectField forces $value to be one of the options in the select
1701                 # field, which is not useful here.  But we do want the validation further up
1702                 # the chain
1703                 $p = parent::validate( $value[1], $alldata );
1704
1705                 if ( $p !== true ) {
1706                         return $p;
1707                 }
1708
1709                 if( isset( $this->mParams['required'] ) && $value[1] === '' ){
1710                         return wfMsgExt( 'htmlform-required', 'parseinline' );
1711                 }
1712
1713                 return true;
1714         }
1715 }
1716
1717 /**
1718  * Radio checkbox fields.
1719  */
1720 class HTMLRadioField extends HTMLFormField {
1721         function validate( $value, $alldata ) {
1722                 $p = parent::validate( $value, $alldata );
1723
1724                 if ( $p !== true ) {
1725                         return $p;
1726                 }
1727
1728                 if ( !is_string( $value ) && !is_int( $value ) ) {
1729                         return false;
1730                 }
1731
1732                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1733
1734                 if ( in_array( $value, $validOptions ) ) {
1735                         return true;
1736                 } else {
1737                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1738                 }
1739         }
1740
1741         /**
1742          * This returns a block of all the radio options, in one cell.
1743          * @see includes/HTMLFormField#getInputHTML()
1744          */
1745         function getInputHTML( $value ) {
1746                 $html = $this->formatOptions( $this->mParams['options'], $value );
1747
1748                 return $html;
1749         }
1750
1751         function formatOptions( $options, $value ) {
1752                 $html = '';
1753
1754                 $attribs = array();
1755                 if ( !empty( $this->mParams['disabled'] ) ) {
1756                         $attribs['disabled'] = 'disabled';
1757                 }
1758
1759                 # TODO: should this produce an unordered list perhaps?
1760                 foreach ( $options as $label => $info ) {
1761                         if ( is_array( $info ) ) {
1762                                 $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
1763                                 $html .= $this->formatOptions( $info, $value );
1764                         } else {
1765                                 $id = Sanitizer::escapeId( $this->mID . "-$info" );
1766                                 $html .= Xml::radio(
1767                                         $this->mName,
1768                                         $info,
1769                                         $info == $value,
1770                                         $attribs + array( 'id' => $id )
1771                                 );
1772                                 $html .= '&#160;' .
1773                                                 Html::rawElement( 'label', array( 'for' => $id ), $label );
1774
1775                                 $html .= "<br />\n";
1776                         }
1777                 }
1778
1779                 return $html;
1780         }
1781
1782         protected function needsLabel() {
1783                 return false;
1784         }
1785 }
1786
1787 /**
1788  * An information field (text blob), not a proper input.
1789  */
1790 class HTMLInfoField extends HTMLFormField {
1791         function __construct( $info ) {
1792                 $info['nodata'] = true;
1793
1794                 parent::__construct( $info );
1795         }
1796
1797         function getInputHTML( $value ) {
1798                 return !empty( $this->mParams['raw'] ) ? $value : htmlspecialchars( $value );
1799         }
1800
1801         function getTableRow( $value ) {
1802                 if ( !empty( $this->mParams['rawrow'] ) ) {
1803                         return $value;
1804                 }
1805
1806                 return parent::getTableRow( $value );
1807         }
1808
1809         protected function needsLabel() {
1810                 return false;
1811         }
1812 }
1813
1814 class HTMLHiddenField extends HTMLFormField {
1815         public function __construct( $params ) {
1816                 parent::__construct( $params );
1817
1818                 # Per HTML5 spec, hidden fields cannot be 'required'
1819                 # http://dev.w3.org/html5/spec/states-of-the-type-attribute.html#hidden-state
1820                 unset( $this->mParams['required'] );
1821         }
1822
1823         public function getTableRow( $value ) {
1824                 $params = array();
1825                 if ( $this->mID ) {
1826                         $params['id'] = $this->mID;
1827                 }
1828
1829                 $this->mParent->addHiddenField(
1830                         $this->mName,
1831                         $this->mDefault,
1832                         $params
1833                 );
1834
1835                 return '';
1836         }
1837
1838         public function getInputHTML( $value ) { return ''; }
1839 }
1840
1841 /**
1842  * Add a submit button inline in the form (as opposed to
1843  * HTMLForm::addButton(), which will add it at the end).
1844  */
1845 class HTMLSubmitField extends HTMLFormField {
1846
1847         function __construct( $info ) {
1848                 $info['nodata'] = true;
1849                 parent::__construct( $info );
1850         }
1851
1852         function getInputHTML( $value ) {
1853                 return Xml::submitButton(
1854                         $value,
1855                         array(
1856                                 'class' => 'mw-htmlform-submit',
1857                                 'name' => $this->mName,
1858                                 'id' => $this->mID,
1859                         )
1860                 );
1861         }
1862
1863         protected function needsLabel() {
1864                 return false;
1865         }
1866
1867         /**
1868          * Button cannot be invalid
1869          */
1870         public function validate( $value, $alldata ){
1871                 return true;
1872         }
1873 }
1874
1875 class HTMLEditTools extends HTMLFormField {
1876         public function getInputHTML( $value ) {
1877                 return '';
1878         }
1879
1880         public function getTableRow( $value ) {
1881                 if ( empty( $this->mParams['message'] ) ) {
1882                         $msg = wfMessage( 'edittools' );
1883                 } else {
1884                         $msg = wfMessage( $this->mParams['message'] );
1885                         if ( $msg->isDisabled() ) {
1886                                 $msg = wfMessage( 'edittools' );
1887                         }
1888                 }
1889                 $msg->inContentLanguage();
1890
1891
1892                 return '<tr><td></td><td class="mw-input">'
1893                         . '<div class="mw-editTools">'
1894                         . $msg->parseAsBlock()
1895                         . "</div></td></tr>\n";
1896         }
1897 }