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 Mixed String or Array of message keys
 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         public function getContext(){
 631                 return $this->mContext instanceof RequestContext
 632                         ? $this->mContext
 633                         : RequestContext::getMain();
 634         }
 635
 636         public function getOutput(){
 637                 return $this->getContext()->output;
 638         }
 639
 640         public function getRequest(){
 641                 return $this->getContext()->request;
 642         }
 643
 644         public function getUser(){
 645                 return $this->getContext()->user;
 646         }
 647
 648         /**
 649          * Set the method used to submit the form
 650          * @param $method String
 651          */
 652         public function setMethod( $method='post' ){
 653                 $this->mMethod = $method;
 654         }
 655
 656         public function getMethod(){
 657                 return $this->mMethod;
 658         }
 659
 660         /**
 661          * TODO: Document
 662          * @param $fields
 663          */
 664         function displaySection( $fields, $sectionName = '' ) {
 665                 $tableHtml = '';
 666                 $subsectionHtml = '';
 667                 $hasLeftColumn = false;
 668
 669                 foreach ( $fields as $key => $value ) {
 670                         if ( is_object( $value ) ) {
 671                                 $v = empty( $value->mParams['nodata'] )
 672                                         ? $this->mFieldData[$key]
 673                                         : $value->getDefault();
 674                                 $tableHtml .= $value->getTableRow( $v );
 675
 676                                 if ( $value->getLabel() != '&#160;' )
 677                                         $hasLeftColumn = true;
 678                         } elseif ( is_array( $value ) ) {
 679                                 $section = $this->displaySection( $value, $key );
 680                                 $legend = $this->getLegend( $key );
 681                                 if ( isset( $this->mSectionHeaders[$key] ) ) {
 682                                         $section = $this->mSectionHeaders[$key] . $section;
 683                                 }
 684                                 if ( isset( $this->mSectionFooters[$key] ) ) {
 685                                         $section .= $this->mSectionFooters[$key];
 686                                 }
 687                                 $subsectionHtml .= Xml::fieldset( $legend, $section ) . "\n";
 688                         }
 689                 }
 690
 691                 $classes = array();
 692
 693                 if ( !$hasLeftColumn ) { // Avoid strange spacing when no labels exist
 694                         $classes[] = 'mw-htmlform-nolabel';
 695                 }
 696
 697                 $attribs = array(
 698                         'class' => implode( ' ', $classes ),
 699                 );
 700
 701                 if ( $sectionName ) {
 702                         $attribs['id'] = Sanitizer::escapeId( "mw-htmlform-$sectionName" );
 703                 }
 704
 705                 $tableHtml = Html::rawElement( 'table', $attribs,
 706                         Html::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n";
 707
 708                 return $subsectionHtml . "\n" . $tableHtml;
 709         }
 710
 711         /**
 712          * Construct the form fields from the Descriptor array
 713          */
 714         function loadData() {
 715                 $fieldData = array();
 716
 717                 foreach ( $this->mFlatFields as $fieldname => $field ) {
 718                         if ( !empty( $field->mParams['nodata'] ) ) {
 719                                 continue;
 720                         } elseif ( !empty( $field->mParams['disabled'] ) ) {
 721                                 $fieldData[$fieldname] = $field->getDefault();
 722                         } else {
 723                                 $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
 724                         }
 725                 }
 726
 727                 # Filter data.
 728                 foreach ( $fieldData as $name => &$value ) {
 729                         $field = $this->mFlatFields[$name];
 730                         $value = $field->filter( $value, $this->mFlatFields );
 731                 }
 732
 733                 $this->mFieldData = $fieldData;
 734         }
 735
 736         /**
 737          * Stop a reset button being shown for this form
 738          * @param $suppressReset Bool set to false to re-enable the
 739          *       button again
 740          */
 741         function suppressReset( $suppressReset = true ) {
 742                 $this->mShowReset = !$suppressReset;
 743         }
 744
 745         /**
 746          * Overload this if you want to apply special filtration routines
 747          * to the form as a whole, after it's submitted but before it's
 748          * processed.
 749          * @param $data
 750          * @return unknown_type
 751          */
 752         function filterDataForSubmit( $data ) {
 753                 return $data;
 754         }
 755
 756         /**
 757          * Get a string to go in the <legend> of a section fieldset.  Override this if you
 758          * want something more complicated
 759          * @param $key String
 760          * @return String
 761          */
 762         public function getLegend( $key ) {
 763                 return wfMsg( "{$this->mMessagePrefix}-$key" );
 764         }
 765 }
 766
 767 /**
 768  * The parent class to generate form fields.  Any field type should
 769  * be a subclass of this.
 770  */
 771 abstract class HTMLFormField {
 772
 773         protected $mValidationCallback;
 774         protected $mFilterCallback;
 775         protected $mName;
 776         public $mParams;
 777         protected $mLabel;      # String label.  Set on construction
 778         protected $mID;
 779         protected $mClass = '';
 780         protected $mDefault;
 781         public $mParent;
 782
 783         /**
 784          * This function must be implemented to return the HTML to generate
 785          * the input object itself.  It should not implement the surrounding
 786          * table cells/rows, or labels/help messages.
 787          * @param $value String the value to set the input to; eg a default
 788          *       text for a text input.
 789          * @return String valid HTML.
 790          */
 791         abstract function getInputHTML( $value );
 792
 793         /**
 794          * Override this function to add specific validation checks on the
 795          * field input.  Don't forget to call parent::validate() to ensure
 796          * that the user-defined callback mValidationCallback is still run
 797          * @param $value String the value the field was submitted with
 798          * @param $alldata Array the data collected from the form
 799          * @return Mixed Bool true on success, or String error to display.
 800          */
 801         function validate( $value, $alldata ) {
 802                 if ( isset( $this->mValidationCallback ) ) {
 803                         return call_user_func( $this->mValidationCallback, $value, $alldata );
 804                 }
 805
 806                 if ( isset( $this->mParams['required'] ) && $value === '' ) {
 807                         return wfMsgExt( 'htmlform-required', 'parseinline' );
 808                 }
 809
 810                 return true;
 811         }
 812
 813         function filter( $value, $alldata ) {
 814                 if ( isset( $this->mFilterCallback ) ) {
 815                         $value = call_user_func( $this->mFilterCallback, $value, $alldata );
 816                 }
 817
 818                 return $value;
 819         }
 820
 821         /**
 822          * Should this field have a label, or is there no input element with the
 823          * appropriate id for the label to point to?
 824          *
 825          * @return bool True to output a label, false to suppress
 826          */
 827         protected function needsLabel() {
 828                 return true;
 829         }
 830
 831         /**
 832          * Get the value that this input has been set to from a posted form,
 833          * or the input's default value if it has not been set.
 834          * @param $request WebRequest
 835          * @return String the value
 836          */
 837         function loadDataFromRequest( $request ) {
 838                 if ( $request->getCheck( $this->mName ) ) {
 839                         return $request->getText( $this->mName );
 840                 } else {
 841                         return $this->getDefault();
 842                 }
 843         }
 844
 845         /**
 846          * Initialise the object
 847          * @param $params Associative Array. See HTMLForm doc for syntax.
 848          */
 849         function __construct( $params ) {
 850                 $this->mParams = $params;
 851
 852                 # Generate the label from a message, if possible
 853                 if ( isset( $params['label-message'] ) ) {
 854                         $msgInfo = $params['label-message'];
 855
 856                         if ( is_array( $msgInfo ) ) {
 857                                 $msg = array_shift( $msgInfo );
 858                         } else {
 859                                 $msg = $msgInfo;
 860                                 $msgInfo = array();
 861                         }
 862
 863                         $this->mLabel = wfMsgExt( $msg, 'parseinline', $msgInfo );
 864                 } elseif ( isset( $params['label'] ) ) {
 865                         $this->mLabel = $params['label'];
 866                 }
 867
 868                 $this->mName = "wp{$params['fieldname']}";
 869                 if ( isset( $params['name'] ) ) {
 870                         $this->mName = $params['name'];
 871                 }
 872
 873                 $validName = Sanitizer::escapeId( $this->mName );
 874                 if ( $this->mName != $validName && !isset( $params['nodata'] ) ) {
 875                         throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__ );
 876                 }
 877
 878                 $this->mID = "mw-input-{$this->mName}";
 879
 880                 if ( isset( $params['default'] ) ) {
 881                         $this->mDefault = $params['default'];
 882                 }
 883
 884                 if ( isset( $params['id'] ) ) {
 885                         $id = $params['id'];
 886                         $validId = Sanitizer::escapeId( $id );
 887
 888                         if ( $id != $validId ) {
 889                                 throw new MWException( "Invalid id '$id' passed to " . __METHOD__ );
 890                         }
 891
 892                         $this->mID = $id;
 893                 }
 894
 895                 if ( isset( $params['cssclass'] ) ) {
 896                         $this->mClass = $params['cssclass'];
 897                 }
 898
 899                 if ( isset( $params['validation-callback'] ) ) {
 900                         $this->mValidationCallback = $params['validation-callback'];
 901                 }
 902
 903                 if ( isset( $params['filter-callback'] ) ) {
 904                         $this->mFilterCallback = $params['filter-callback'];
 905                 }
 906         }
 907
 908         /**
 909          * Get the complete table row for the input, including help text,
 910          * labels, and whatever.
 911          * @param $value String the value to set the input to.
 912          * @return String complete HTML table row.
 913          */
 914         function getTableRow( $value ) {
 915                 # Check for invalid data.
 916
 917                 $errors = $this->validate( $value, $this->mParent->mFieldData );
 918
 919                 $cellAttributes = array();
 920                 $verticalLabel = false;
 921
 922                 if ( !empty($this->mParams['vertical-label']) ) {
 923                         $cellAttributes['colspan'] = 2;
 924                         $verticalLabel = true;
 925                 }
 926
 927                 if ( $errors === true || ( !$this->mParent->getRequest()->wasPosted() && ( $this->mParent->getMethod() == 'post' ) ) ) {
 928                         $errors = '';
 929                         $errorClass = '';
 930                 } else {
 931                         $errors = self::formatErrors( $errors );
 932                         $errorClass = 'mw-htmlform-invalid-input';
 933                 }
 934
 935                 $label = $this->getLabelHtml( $cellAttributes );
 936                 $field = Html::rawElement(
 937                         'td',
 938                         array( 'class' => 'mw-input' ) + $cellAttributes,
 939                         $this->getInputHTML( $value ) . "\n$errors"
 940                 );
 941
 942                 $fieldType = get_class( $this );
 943
 944                 if ( $verticalLabel ) {
 945                         $html = Html::rawElement( 'tr',
 946                                 array( 'class' => 'mw-htmlform-vertical-label' ), $label );
 947                         $html .= Html::rawElement( 'tr',
 948                                 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
 949                                 $field );
 950                 } else {
 951                         $html = Html::rawElement( 'tr',
 952                                 array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
 953                                 $label . $field );
 954                 }
 955
 956                 $helptext = null;
 957
 958                 if ( isset( $this->mParams['help-message'] ) ) {
 959                         $msg = $this->mParams['help-message'];
 960                         $helptext = wfMsgExt( $msg, 'parseinline' );
 961                         if ( wfEmptyMsg( $msg ) ) {
 962                                 # Never mind
 963                                 $helptext = null;
 964                         }
 965                 } elseif ( isset( $this->mParams['help-messages'] ) ) {
 966                         # help-message can be passed a message key (string) or an array containing
 967                         # a message key and additional parameters. This makes it impossible to pass
 968                         # an array of message key
 969                         foreach( $this->mParams['help-messages'] as $msg ) {
 970                                 $candidate = wfMsgExt( $msg, 'parseinline' );
 971                                 if( wfEmptyMsg( $msg ) ) {
 972                                         $candidate = null;
 973                                 }
 974                                 $helptext .= $candidate; // append message
 975                         }
 976                 } elseif ( isset( $this->mParams['help'] ) ) {
 977                         $helptext = $this->mParams['help'];
 978                 }
 979
 980                 if ( !is_null( $helptext ) ) {
 981                         $row = Html::rawElement( 'td', array( 'colspan' => 2, 'class' => 'htmlform-tip' ),
 982                                 $helptext );
 983                         $row = Html::rawElement( 'tr', array(), $row );
 984                         $html .= "$row\n";
 985                 }
 986
 987                 return $html;
 988         }
 989
 990         function getLabel() {
 991                 return $this->mLabel;
 992         }
 993         function getLabelHtml( $cellAttributes = array() ) {
 994                 # Don't output a for= attribute for labels with no associated input.
 995                 # Kind of hacky here, possibly we don't want these to be <label>s at all.
 996                 $for = array();
 997
 998                 if ( $this->needsLabel() ) {
 999                         $for['for'] = $this->mID;
1000                 }
1001
1002                 return Html::rawElement( 'td', array( 'class' => 'mw-label' ) + $cellAttributes,
1003                         Html::rawElement( 'label', $for, $this->getLabel() )
1004                 );
1005         }
1006
1007         function getDefault() {
1008                 if ( isset( $this->mDefault ) ) {
1009                         return $this->mDefault;
1010                 } else {
1011                         return null;
1012                 }
1013         }
1014
1015         /**
1016          * Returns the attributes required for the tooltip and accesskey.
1017          *
1018          * @return array Attributes
1019          */
1020         public function getTooltipAndAccessKey() {
1021                 if ( empty( $this->mParams['tooltip'] ) ) {
1022                         return array();
1023                 }
1024                 return Linker::tooltipAndAccessKeyAttribs( $this->mParams['tooltip'] );
1025         }
1026
1027         /**
1028          * flatten an array of options to a single array, for instance,
1029          * a set of <options> inside <optgroups>.
1030          * @param $options Associative Array with values either Strings
1031          *       or Arrays
1032          * @return Array flattened input
1033          */
1034         public static function flattenOptions( $options ) {
1035                 $flatOpts = array();
1036
1037                 foreach ( $options as $value ) {
1038                         if ( is_array( $value ) ) {
1039                                 $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
1040                         } else {
1041                                 $flatOpts[] = $value;
1042                         }
1043                 }
1044
1045                 return $flatOpts;
1046         }
1047
1048         /**
1049          * Formats one or more errors as accepted by field validation-callback.
1050          * @param $errors String|Message|Array of strings or Message instances
1051          * @return String html
1052          * @since 1.18
1053          */
1054         protected static function formatErrors( $errors ) {
1055                 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1056                         $errors = array_shift( $errors );
1057                 }
1058
1059                 if ( is_array( $errors ) ) {
1060                         $lines = array();
1061                         foreach ( $errors as $error ) {
1062                                 if ( $error instanceof Message ) {
1063                                         $lines[] = Html::rawElement( 'li', array(), $error->parse() );
1064                                 } else {
1065                                         $lines[] = Html::rawElement( 'li', array(), $error );
1066                                 }
1067                         }
1068                         return Html::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
1069                 } else {
1070                         if ( $errors instanceof Message ) {
1071                                 $errors = $errors->parse();
1072                         }
1073                         return Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
1074                 }
1075         }
1076 }
1077
1078 class HTMLTextField extends HTMLFormField {
1079         function getSize() {
1080                 return isset( $this->mParams['size'] )
1081                         ? $this->mParams['size']
1082                         : 45;
1083         }
1084
1085         function getInputHTML( $value ) {
1086                 $attribs = array(
1087                         'id' => $this->mID,
1088                         'name' => $this->mName,
1089                         'size' => $this->getSize(),
1090                         'value' => $value,
1091                 ) + $this->getTooltipAndAccessKey();
1092
1093                 if ( isset( $this->mParams['maxlength'] ) ) {
1094                         $attribs['maxlength'] = $this->mParams['maxlength'];
1095                 }
1096
1097                 if ( !empty( $this->mParams['disabled'] ) ) {
1098                         $attribs['disabled'] = 'disabled';
1099                 }
1100
1101                 # TODO: Enforce pattern, step, required, readonly on the server side as
1102                 # well
1103                 foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
1104                 'placeholder' ) as $param ) {
1105                         if ( isset( $this->mParams[$param] ) ) {
1106                                 $attribs[$param] = $this->mParams[$param];
1107                         }
1108                 }
1109
1110                 foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as $param ) {
1111                         if ( isset( $this->mParams[$param] ) ) {
1112                                 $attribs[$param] = '';
1113                         }
1114                 }
1115
1116                 # Implement tiny differences between some field variants
1117                 # here, rather than creating a new class for each one which
1118                 # is essentially just a clone of this one.
1119                 if ( isset( $this->mParams['type'] ) ) {
1120                         switch ( $this->mParams['type'] ) {
1121                                 case 'email':
1122                                         $attribs['type'] = 'email';
1123                                         break;
1124                                 case 'int':
1125                                         $attribs['type'] = 'number';
1126                                         break;
1127                                 case 'float':
1128                                         $attribs['type'] = 'number';
1129                                         $attribs['step'] = 'any';
1130                                         break;
1131                                 # Pass through
1132                                 case 'password':
1133                                 case 'file':
1134                                         $attribs['type'] = $this->mParams['type'];
1135                                         break;
1136                         }
1137                 }
1138
1139                 return Html::element( 'input', $attribs );
1140         }
1141 }
1142 class HTMLTextAreaField extends HTMLFormField {
1143         function getCols() {
1144                 return isset( $this->mParams['cols'] )
1145                         ? $this->mParams['cols']
1146                         : 80;
1147         }
1148
1149         function getRows() {
1150                 return isset( $this->mParams['rows'] )
1151                         ? $this->mParams['rows']
1152                         : 25;
1153         }
1154
1155         function getInputHTML( $value ) {
1156                 $attribs = array(
1157                         'id' => $this->mID,
1158                         'name' => $this->mName,
1159                         'cols' => $this->getCols(),
1160                         'rows' => $this->getRows(),
1161                 ) + $this->getTooltipAndAccessKey();
1162
1163
1164                 if ( !empty( $this->mParams['disabled'] ) ) {
1165                         $attribs['disabled'] = 'disabled';
1166                 }
1167
1168                 if ( !empty( $this->mParams['readonly'] ) ) {
1169                         $attribs['readonly'] = 'readonly';
1170                 }
1171
1172                 foreach ( array( 'required', 'autofocus' ) as $param ) {
1173                         if ( isset( $this->mParams[$param] ) ) {
1174                                 $attribs[$param] = '';
1175                         }
1176                 }
1177
1178                 return Html::element( 'textarea', $attribs, $value );
1179         }
1180 }
1181
1182 /**
1183  * A field that will contain a numeric value
1184  */
1185 class HTMLFloatField extends HTMLTextField {
1186         function getSize() {
1187                 return isset( $this->mParams['size'] )
1188                         ? $this->mParams['size']
1189                         : 20;
1190         }
1191
1192         function validate( $value, $alldata ) {
1193                 $p = parent::validate( $value, $alldata );
1194
1195                 if ( $p !== true ) {
1196                         return $p;
1197                 }
1198
1199                 $value = trim( $value );
1200
1201                 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#real-numbers
1202                 # with the addition that a leading '+' sign is ok.
1203                 if ( !preg_match( '/^((\+|\-)?\d+(\.\d+)?(E(\+|\-)?\d+)?)?$/i', $value ) ) {
1204                         return wfMsgExt( 'htmlform-float-invalid', 'parse' );
1205                 }
1206
1207                 # The "int" part of these message names is rather confusing.
1208                 # They make equal sense for all numbers.
1209                 if ( isset( $this->mParams['min'] ) ) {
1210                         $min = $this->mParams['min'];
1211
1212                         if ( $min > $value ) {
1213                                 return wfMsgExt( 'htmlform-int-toolow', 'parse', array( $min ) );
1214                         }
1215                 }
1216
1217                 if ( isset( $this->mParams['max'] ) ) {
1218                         $max = $this->mParams['max'];
1219
1220                         if ( $max < $value ) {
1221                                 return wfMsgExt( 'htmlform-int-toohigh', 'parse', array( $max ) );
1222                         }
1223                 }
1224
1225                 return true;
1226         }
1227 }
1228
1229 /**
1230  * A field that must contain a number
1231  */
1232 class HTMLIntField extends HTMLFloatField {
1233         function validate( $value, $alldata ) {
1234                 $p = parent::validate( $value, $alldata );
1235
1236                 if ( $p !== true ) {
1237                         return $p;
1238                 }
1239
1240                 # http://dev.w3.org/html5/spec/common-microsyntaxes.html#signed-integers
1241                 # with the addition that a leading '+' sign is ok. Note that leading zeros
1242                 # are fine, and will be left in the input, which is useful for things like
1243                 # phone numbers when you know that they are integers (the HTML5 type=tel
1244                 # input does not require its value to be numeric).  If you want a tidier
1245                 # value to, eg, save in the DB, clean it up with intval().
1246                 if ( !preg_match( '/^((\+|\-)?\d+)?$/', trim( $value ) )
1247                 ) {
1248                         return wfMsgExt( 'htmlform-int-invalid', 'parse' );
1249                 }
1250
1251                 return true;
1252         }
1253 }
1254
1255 /**
1256  * A checkbox field
1257  */
1258 class HTMLCheckField extends HTMLFormField {
1259         function getInputHTML( $value ) {
1260                 if ( !empty( $this->mParams['invert'] ) ) {
1261                         $value = !$value;
1262                 }
1263
1264                 $attr = $this->getTooltipAndAccessKey();
1265                 $attr['id'] = $this->mID;
1266
1267                 if ( !empty( $this->mParams['disabled'] ) ) {
1268                         $attr['disabled'] = 'disabled';
1269                 }
1270
1271                 return Xml::check( $this->mName, $value, $attr ) . '&#160;' .
1272                         Html::rawElement( 'label', array( 'for' => $this->mID ), $this->mLabel );
1273         }
1274
1275         /**
1276          * For a checkbox, the label goes on the right hand side, and is
1277          * added in getInputHTML(), rather than HTMLFormField::getRow()
1278          */
1279         function getLabel() {
1280                 return '&#160;';
1281         }
1282
1283         function loadDataFromRequest( $request ) {
1284                 $invert = false;
1285                 if ( isset( $this->mParams['invert'] ) && $this->mParams['invert'] ) {
1286                         $invert = true;
1287                 }
1288
1289                 // GetCheck won't work like we want for checks.
1290                 if ( $request->getCheck( 'wpEditToken' ) || $this->mParent->getMethod() != 'post' ) {
1291                         // XOR has the following truth table, which is what we want
1292                         // INVERT VALUE | OUTPUT
1293                         // true   true  | false
1294                         // false  true  | true
1295                         // false  false | false
1296                         // true   false | true
1297                         return $request->getBool( $this->mName ) xor $invert;
1298                 } else {
1299                         return $this->getDefault();
1300                 }
1301         }
1302 }
1303
1304 /**
1305  * A select dropdown field.  Basically a wrapper for Xmlselect class
1306  */
1307 class HTMLSelectField extends HTMLFormField {
1308         function validate( $value, $alldata ) {
1309                 $p = parent::validate( $value, $alldata );
1310
1311                 if ( $p !== true ) {
1312                         return $p;
1313                 }
1314
1315                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1316
1317                 if ( in_array( $value, $validOptions ) )
1318                         return true;
1319                 else
1320                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1321         }
1322
1323         function getInputHTML( $value ) {
1324                 $select = new XmlSelect( $this->mName, $this->mID, strval( $value ) );
1325
1326                 # If one of the options' 'name' is int(0), it is automatically selected.
1327                 # because PHP sucks and thinks int(0) == 'some string'.
1328                 # Working around this by forcing all of them to strings.
1329                 foreach( $this->mParams['options'] as $key => &$opt ){
1330                         if( is_int( $opt ) ){
1331                                 $opt = strval( $opt );
1332                         }
1333                 }
1334                 unset( $opt ); # PHP keeps $opt around as a reference, which is a bit scary
1335
1336                 if ( !empty( $this->mParams['disabled'] ) ) {
1337                         $select->setAttribute( 'disabled', 'disabled' );
1338                 }
1339
1340                 $select->addOptions( $this->mParams['options'] );
1341
1342                 return $select->getHTML();
1343         }
1344 }
1345
1346 /**
1347  * Select dropdown field, with an additional "other" textbox.
1348  */
1349 class HTMLSelectOrOtherField extends HTMLTextField {
1350         static $jsAdded = false;
1351
1352         function __construct( $params ) {
1353                 if ( !in_array( 'other', $params['options'], true ) ) {
1354                         $params['options'][wfMsg( 'htmlform-selectorother-other' )] = 'other';
1355                 }
1356
1357                 parent::__construct( $params );
1358         }
1359
1360         static function forceToStringRecursive( $array ) {
1361                 if ( is_array( $array ) ) {
1362                         return array_map( array( __CLASS__, 'forceToStringRecursive' ), $array );
1363                 } else {
1364                         return strval( $array );
1365                 }
1366         }
1367
1368         function getInputHTML( $value ) {
1369                 $valInSelect = false;
1370
1371                 if ( $value !== false ) {
1372                         $valInSelect = in_array(
1373                                 $value,
1374                                 HTMLFormField::flattenOptions( $this->mParams['options'] )
1375                         );
1376                 }
1377
1378                 $selected = $valInSelect ? $value : 'other';
1379
1380                 $opts = self::forceToStringRecursive( $this->mParams['options'] );
1381
1382                 $select = new XmlSelect( $this->mName, $this->mID, $selected );
1383                 $select->addOptions( $opts );
1384
1385                 $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
1386
1387                 $tbAttribs = array( 'id' => $this->mID . '-other', 'size' => $this->getSize() );
1388
1389                 if ( !empty( $this->mParams['disabled'] ) ) {
1390                         $select->setAttribute( 'disabled', 'disabled' );
1391                         $tbAttribs['disabled'] = 'disabled';
1392                 }
1393
1394                 $select = $select->getHTML();
1395
1396                 if ( isset( $this->mParams['maxlength'] ) ) {
1397                         $tbAttribs['maxlength'] = $this->mParams['maxlength'];
1398                 }
1399
1400                 $textbox = Html::input(
1401                         $this->mName . '-other',
1402                         $valInSelect ? '' : $value,
1403                         'text',
1404                         $tbAttribs
1405                 );
1406
1407                 return "$select<br />\n$textbox";
1408         }
1409
1410         function loadDataFromRequest( $request ) {
1411                 if ( $request->getCheck( $this->mName ) ) {
1412                         $val = $request->getText( $this->mName );
1413
1414                         if ( $val == 'other' ) {
1415                                 $val = $request->getText( $this->mName . '-other' );
1416                         }
1417
1418                         return $val;
1419                 } else {
1420                         return $this->getDefault();
1421                 }
1422         }
1423 }
1424
1425 /**
1426  * Multi-select field
1427  */
1428 class HTMLMultiSelectField extends HTMLFormField {
1429
1430         public function __construct( $params ){
1431                 parent::__construct( $params );
1432                 if( isset( $params['flatlist'] ) ){
1433                         $this->mClass .= ' mw-htmlform-multiselect-flatlist';
1434                 }
1435         }
1436
1437         function validate( $value, $alldata ) {
1438                 $p = parent::validate( $value, $alldata );
1439
1440                 if ( $p !== true ) {
1441                         return $p;
1442                 }
1443
1444                 if ( !is_array( $value ) ) {
1445                         return false;
1446                 }
1447
1448                 # If all options are valid, array_intersect of the valid options
1449                 # and the provided options will return the provided options.
1450                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1451
1452                 $validValues = array_intersect( $value, $validOptions );
1453                 if ( count( $validValues ) == count( $value ) ) {
1454                         return true;
1455                 } else {
1456                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1457                 }
1458         }
1459
1460         function getInputHTML( $value ) {
1461                 $html = $this->formatOptions( $this->mParams['options'], $value );
1462
1463                 return $html;
1464         }
1465
1466         function formatOptions( $options, $value ) {
1467                 $html = '';
1468
1469                 $attribs = array();
1470
1471                 if ( !empty( $this->mParams['disabled'] ) ) {
1472                         $attribs['disabled'] = 'disabled';
1473                 }
1474
1475                 foreach ( $options as $label => $info ) {
1476                         if ( is_array( $info ) ) {
1477                                 $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
1478                                 $html .= $this->formatOptions( $info, $value );
1479                         } else {
1480                                 $thisAttribs = array( 'id' => "{$this->mID}-$info", 'value' => $info );
1481
1482                                 $checkbox = Xml::check(
1483                                         $this->mName . '[]',
1484                                         in_array( $info, $value, true ),
1485                                         $attribs + $thisAttribs );
1486                                 $checkbox .= '&#160;' . Html::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label );
1487
1488                                 $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-multiselect-item' ), $checkbox );
1489                         }
1490                 }
1491
1492                 return $html;
1493         }
1494
1495         function loadDataFromRequest( $request ) {
1496                 if ( $this->mParent->getMethod() == 'post' ) {
1497                         if( $request->wasPosted() ){
1498                                 # Checkboxes are just not added to the request arrays if they're not checked,
1499                                 # so it's perfectly possible for there not to be an entry at all
1500                                 return $request->getArray( $this->mName, array() );
1501                         } else {
1502                                 # That's ok, the user has not yet submitted the form, so show the defaults
1503                                 return $this->getDefault();
1504                         }
1505                 } else {
1506                         # This is the impossible case: if we look at $_GET and see no data for our
1507                         # field, is it because the user has not yet submitted the form, or that they
1508                         # have submitted it with all the options unchecked? We will have to assume the
1509                         # latter, which basically means that you can't specify 'positive' defaults
1510                         # for GET forms.  FIXME...
1511                         return $request->getArray( $this->mName, array() );
1512                 }
1513         }
1514
1515         function getDefault() {
1516                 if ( isset( $this->mDefault ) ) {
1517                         return $this->mDefault;
1518                 } else {
1519                         return array();
1520                 }
1521         }
1522
1523         protected function needsLabel() {
1524                 return false;
1525         }
1526 }
1527
1528 /**
1529  * Double field with a dropdown list constructed from a system message in the format
1530  *     * Optgroup header
1531  *     ** <option value>|<option name>
1532  *     ** <option value == option name>
1533  *     * New Optgroup header
1534  * Plus a text field underneath for an additional reason.  The 'value' of the field is
1535  * ""<select>: <extra reason>"", or "<extra reason>" if nothing has been selected in the
1536  * select dropdown.
1537  * FIXME: If made 'required', only the text field should be compulsory.
1538  */
1539 class HTMLSelectAndOtherField extends HTMLSelectField {
1540
1541         function __construct( $params ) {
1542                 if ( array_key_exists( 'other', $params ) ) {
1543                 } elseif( array_key_exists( 'other-message', $params ) ){
1544                         $params['other'] = wfMsg( $params['other-message'] );
1545                 } else {
1546                         $params['other'] = wfMsg( 'htmlform-selectorother-other' );
1547                 }
1548
1549                 if ( array_key_exists( 'options', $params ) ) {
1550                         # Options array already specified
1551                 } elseif( array_key_exists( 'options-message', $params ) ){
1552                         # Generate options array from a system message
1553                         $params['options'] = self::parseMessage( wfMsg( $params['options-message'], $params['other'] ) );
1554                 } else {
1555                         # Sulk
1556                         throw new MWException( 'HTMLSelectAndOtherField called without any options' );
1557                 }
1558                 $this->mFlatOptions = self::flattenOptions( $params['options'] );
1559
1560                 parent::__construct( $params );
1561         }
1562
1563         /**
1564          * Build a drop-down box from a textual list.
1565          * @param $string String message text
1566          * @param $otherName String name of "other reason" option
1567          * @return Array
1568          * TODO: this is copied from Xml::listDropDown(), deprecate/avoid duplication?
1569          */
1570         public static function parseMessage( $string, $otherName=null ) {
1571                 if( $otherName === null ){
1572                         $otherName = wfMsg( 'htmlform-selectorother-other' );
1573                 }
1574
1575                 $optgroup = false;
1576                 $options = array( $otherName => 'other' );
1577
1578                 foreach ( explode( "\n", $string ) as $option ) {
1579                         $value = trim( $option );
1580                         if ( $value == '' ) {
1581                                 continue;
1582                         } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
1583                                 # A new group is starting...
1584                                 $value = trim( substr( $value, 1 ) );
1585                                 $optgroup = $value;
1586                         } elseif ( substr( $value, 0, 2) == '**' ) {
1587                                 # groupmember
1588                                 $opt = trim( substr( $value, 2 ) );
1589                                 $parts = array_map( 'trim', explode( '|', $opt, 2 ) );
1590                                 if( count( $parts ) === 1 ){
1591                                         $parts[1] = $parts[0];
1592                                 }
1593                                 if( $optgroup === false ){
1594                                         $options[$parts[1]] = $parts[0];
1595                                 } else {
1596                                         $options[$optgroup][$parts[1]] = $parts[0];
1597                                 }
1598                         } else {
1599                                 # groupless reason list
1600                                 $optgroup = false;
1601                                 $parts = array_map( 'trim', explode( '|', $option, 2 ) );
1602                                 if( count( $parts ) === 1 ){
1603                                         $parts[1] = $parts[0];
1604                                 }
1605                                 $options[$parts[1]] = $parts[0];
1606                         }
1607                 }
1608
1609                 return $options;
1610         }
1611
1612         function getInputHTML( $value ) {
1613                 $select = parent::getInputHTML( $value[1] );
1614
1615                 $textAttribs = array(
1616                         'id' => $this->mID . '-other',
1617                         'size' => $this->getSize(),
1618                 );
1619
1620                 foreach ( array( 'required', 'autofocus', 'multiple', 'disabled' ) as $param ) {
1621                         if ( isset( $this->mParams[$param] ) ) {
1622                                 $textAttribs[$param] = '';
1623                         }
1624                 }
1625
1626                 $textbox = Html::input(
1627                         $this->mName . '-other',
1628                         $value[2],
1629                         'text',
1630                         $textAttribs
1631                 );
1632
1633                 return "$select<br />\n$textbox";
1634         }
1635
1636         /**
1637          * @param  $request WebRequest
1638          * @return Array( <overall message>, <select value>, <text field value> )
1639          */
1640         function loadDataFromRequest( $request ) {
1641                 if ( $request->getCheck( $this->mName ) ) {
1642
1643                         $list = $request->getText( $this->mName );
1644                         $text = $request->getText( $this->mName . '-other' );
1645
1646                         if ( $list == 'other' ) {
1647                                 $final = $text;
1648                         } elseif( !in_array( $list, $this->mFlatOptions ) ){
1649                                 # User has spoofed the select form to give an option which wasn't
1650                                 # in the original offer.  Sulk...
1651                                 $final = $text;
1652                         } elseif( $text == '' ) {
1653                                 $final = $list;
1654                         } else {
1655                                 $final = $list . wfMsgForContent( 'colon-separator' ) . $text;
1656                         }
1657
1658                 } else {
1659                         $final = $this->getDefault();
1660                         $list = $text = '';
1661                 }
1662                 return array( $final, $list, $text );
1663         }
1664
1665         function getSize() {
1666                 return isset( $this->mParams['size'] )
1667                         ? $this->mParams['size']
1668                         : 45;
1669         }
1670
1671         function validate( $value, $alldata ) {
1672                 # HTMLSelectField forces $value to be one of the options in the select
1673                 # field, which is not useful here.  But we do want the validation further up
1674                 # the chain
1675                 $p = parent::validate( $value[1], $alldata );
1676
1677                 if ( $p !== true ) {
1678                         return $p;
1679                 }
1680
1681                 if( isset( $this->mParams['required'] ) && $value[1] === '' ){
1682                         return wfMsgExt( 'htmlform-required', 'parseinline' );
1683                 }
1684
1685                 return true;
1686         }
1687 }
1688
1689 /**
1690  * Radio checkbox fields.
1691  */
1692 class HTMLRadioField extends HTMLFormField {
1693         function validate( $value, $alldata ) {
1694                 $p = parent::validate( $value, $alldata );
1695
1696                 if ( $p !== true ) {
1697                         return $p;
1698                 }
1699
1700                 if ( !is_string( $value ) && !is_int( $value ) ) {
1701                         return false;
1702                 }
1703
1704                 $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );
1705
1706                 if ( in_array( $value, $validOptions ) ) {
1707                         return true;
1708                 } else {
1709                         return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
1710                 }
1711         }
1712
1713         /**
1714          * This returns a block of all the radio options, in one cell.
1715          * @see includes/HTMLFormField#getInputHTML()
1716          */
1717         function getInputHTML( $value ) {
1718                 $html = $this->formatOptions( $this->mParams['options'], $value );
1719
1720                 return $html;
1721         }
1722
1723         function formatOptions( $options, $value ) {
1724                 $html = '';
1725
1726                 $attribs = array();
1727                 if ( !empty( $this->mParams['disabled'] ) ) {
1728                         $attribs['disabled'] = 'disabled';
1729                 }
1730
1731                 # TODO: should this produce an unordered list perhaps?
1732                 foreach ( $options as $label => $info ) {
1733                         if ( is_array( $info ) ) {
1734                                 $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
1735                                 $html .= $this->formatOptions( $info, $value );
1736                         } else {
1737                                 $id = Sanitizer::escapeId( $this->mID . "-$info" );
1738                                 $html .= Xml::radio(
1739                                         $this->mName,
1740                                         $info,
1741                                         $info == $value,
1742                                         $attribs + array( 'id' => $id )
1743                                 );
1744                                 $html .= '&#160;' .
1745                                                 Html::rawElement( 'label', array( 'for' => $id ), $label );
1746
1747                                 $html .= "<br />\n";
1748                         }
1749                 }
1750
1751                 return $html;
1752         }
1753
1754         protected function needsLabel() {
1755                 return false;
1756         }
1757 }
1758
1759 /**
1760  * An information field (text blob), not a proper input.
1761  */
1762 class HTMLInfoField extends HTMLFormField {
1763         function __construct( $info ) {
1764                 $info['nodata'] = true;
1765
1766                 parent::__construct( $info );
1767         }
1768
1769         function getInputHTML( $value ) {
1770                 return !empty( $this->mParams['raw'] ) ? $value : htmlspecialchars( $value );
1771         }
1772
1773         function getTableRow( $value ) {
1774                 if ( !empty( $this->mParams['rawrow'] ) ) {
1775                         return $value;
1776                 }
1777
1778                 return parent::getTableRow( $value );
1779         }
1780
1781         protected function needsLabel() {
1782                 return false;
1783         }
1784 }
1785
1786 class HTMLHiddenField extends HTMLFormField {
1787         public function __construct( $params ) {
1788                 parent::__construct( $params );
1789
1790                 # Per HTML5 spec, hidden fields cannot be 'required'
1791                 # http://dev.w3.org/html5/spec/states-of-the-type-attribute.html#hidden-state
1792                 unset( $this->mParams['required'] );
1793         }
1794
1795         public function getTableRow( $value ) {
1796                 $params = array();
1797                 if ( $this->mID ) {
1798                         $params['id'] = $this->mID;
1799                 }
1800
1801                 $this->mParent->addHiddenField(
1802                         $this->mName,
1803                         $this->mDefault,
1804                         $params
1805                 );
1806
1807                 return '';
1808         }
1809
1810         public function getInputHTML( $value ) { return ''; }
1811 }
1812
1813 /**
1814  * Add a submit button inline in the form (as opposed to
1815  * HTMLForm::addButton(), which will add it at the end).
1816  */
1817 class HTMLSubmitField extends HTMLFormField {
1818
1819         function __construct( $info ) {
1820                 $info['nodata'] = true;
1821                 parent::__construct( $info );
1822         }
1823
1824         function getInputHTML( $value ) {
1825                 return Xml::submitButton(
1826                         $value,
1827                         array(
1828                                 'class' => 'mw-htmlform-submit',
1829                                 'name' => $this->mName,
1830                                 'id' => $this->mID,
1831                         )
1832                 );
1833         }
1834
1835         protected function needsLabel() {
1836                 return false;
1837         }
1838
1839         /**
1840          * Button cannot be invalid
1841          */
1842         public function validate( $value, $alldata ){
1843                 return true;
1844         }
1845 }
1846
1847 class HTMLEditTools extends HTMLFormField {
1848         public function getInputHTML( $value ) {
1849                 return '';
1850         }
1851
1852         public function getTableRow( $value ) {
1853                 if ( empty( $this->mParams['message'] ) ) {
1854                         $msg = wfMessage( 'edittools' );
1855                 } else {
1856                         $msg = wfMessage( $this->mParams['message'] );
1857                         if ( $msg->isDisabled() ) {
1858                                 $msg = wfMessage( 'edittools' );
1859                         }
1860                 }
1861                 $msg->inContentLanguage();
1862
1863
1864                 return '<tr><td></td><td class="mw-input">'
1865                         . '<div class="mw-editTools">'
1866                         . $msg->parseAsBlock()
1867                         . "</div></td></tr>\n";
1868         }
1869 }