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