HTMLForm.php

Go to the documentation of this file.

<?php
class HTMLForm extends ContextSource {

        // A mapping of 'type' inputs onto standard HTMLFormField subclasses
        static $typeMappings = array(
                'api' => 'HTMLApiField',
                'text' => 'HTMLTextField',
                'textarea' => 'HTMLTextAreaField',
                'select' => 'HTMLSelectField',
                'radio' => 'HTMLRadioField',
                'multiselect' => 'HTMLMultiSelectField',
                'check' => 'HTMLCheckField',
                'toggle' => 'HTMLCheckField',
                'int' => 'HTMLIntField',
                'float' => 'HTMLFloatField',
                'info' => 'HTMLInfoField',
                'selectorother' => 'HTMLSelectOrOtherField',
                'selectandother' => 'HTMLSelectAndOtherField',
                'submit' => 'HTMLSubmitField',
                'hidden' => 'HTMLHiddenField',
                'edittools' => 'HTMLEditTools',

                // HTMLTextField will output the correct type="" attribute automagically.
                // There are about four zillion other HTML5 input types, like url, but
                // we don't use those at the moment, so no point in adding all of them.
                'email' => 'HTMLTextField',
                'password' => 'HTMLTextField',
        );

        protected $mMessagePrefix;

        protected $mFlatFields;

        protected $mFieldTree;
        protected $mShowReset = false;
        public $mFieldData;

        protected $mSubmitCallback;
        protected $mValidationErrorMessage;

        protected $mPre = '';
        protected $mHeader = '';
        protected $mFooter = '';
        protected $mSectionHeaders = array();
        protected $mSectionFooters = array();
        protected $mPost = '';
        protected $mId;

        protected $mSubmitID;
        protected $mSubmitName;
        protected $mSubmitText;
        protected $mSubmitTooltip;

        protected $mTitle;
        protected $mMethod = 'post';

        protected $mAction = false;

        protected $mUseMultipart = false;
        protected $mHiddenFields = array();
        protected $mButtons = array();

        protected $mWrapperLegend = false;
        
        protected $mSubSectionBeforeFields = true;

        public function __construct( $descriptor, /*IContextSource*/ $context = null, $messagePrefix = '' ) {
                if( $context instanceof IContextSource ){
                        $this->setContext( $context );
                        $this->mTitle = false; // We don't need them to set a title
                        $this->mMessagePrefix = $messagePrefix;
                } else {
                        // B/C since 1.18
                        if( is_string( $context ) && $messagePrefix === '' ){
                                // it's actually $messagePrefix
                                $this->mMessagePrefix = $context;
                        }
                }

                // Expand out into a tree.
                $loadedDescriptor = array();
                $this->mFlatFields = array();

                foreach ( $descriptor as $fieldname => $info ) {
                        $section = isset( $info['section'] )
                                ? $info['section']
                                : '';

                        if ( isset( $info['type'] ) && $info['type'] == 'file' ) {
                                $this->mUseMultipart = true;
                        }

                        $field = self::loadInputFromParameters( $fieldname, $info );
                        $field->mParent = $this;

                        $setSection =& $loadedDescriptor;
                        if ( $section ) {
                                $sectionParts = explode( '/', $section );

                                while ( count( $sectionParts ) ) {
                                        $newName = array_shift( $sectionParts );

                                        if ( !isset( $setSection[$newName] ) ) {
                                                $setSection[$newName] = array();
                                        }

                                        $setSection =& $setSection[$newName];
                                }
                        }

                        $setSection[$fieldname] = $field;
                        $this->mFlatFields[$fieldname] = $field;
                }

                $this->mFieldTree = $loadedDescriptor;
        }

        static function addJS() { wfDeprecated( __METHOD__, '1.18' ); }

        static function loadInputFromParameters( $fieldname, $descriptor ) {
                if ( isset( $descriptor['class'] ) ) {
                        $class = $descriptor['class'];
                } elseif ( isset( $descriptor['type'] ) ) {
                        $class = self::$typeMappings[$descriptor['type']];
                        $descriptor['class'] = $class;
                } else {
                        $class = null;
                }

                if ( !$class ) {
                        throw new MWException( "Descriptor with no class: " . print_r( $descriptor, true ) );
                }

                $descriptor['fieldname'] = $fieldname;

                $obj = new $class( $descriptor );

                return $obj;
        }

        function prepareForm() {
                # Check if we have the info we need
                if ( !$this->mTitle instanceof Title && $this->mTitle !== false ) {
                        throw new MWException( "You must call setTitle() on an HTMLForm" );
                }

                # Load data from the request.
                $this->loadData();
        }

        function tryAuthorizedSubmit() {
                $result = false;

                $submit = false;
                if ( $this->getMethod() != 'post' ) {
                        $submit = true; // no session check needed
                } elseif ( $this->getRequest()->wasPosted() ) {
                        $editToken = $this->getRequest()->getVal( 'wpEditToken' );
                        if ( $this->getUser()->isLoggedIn() || $editToken != null ) {
                                // Session tokens for logged-out users have no security value.
                                // However, if the user gave one, check it in order to give a nice 
                                // "session expired" error instead of "permission denied" or such.
                                $submit = $this->getUser()->matchEditToken( $editToken );
                        } else {
                                $submit = true;
                        }
                }

                if ( $submit ) {
                        $result = $this->trySubmit();
                }

                return $result;
        }

        function show() {
                $this->prepareForm();

                $result = $this->tryAuthorizedSubmit();
                if ( $result === true || ( $result instanceof Status && $result->isGood() ) ){
                        return $result;
                }

                $this->displayForm( $result );
                return false;
        }

        function trySubmit() {
                # Check for validation
                foreach ( $this->mFlatFields as $fieldname => $field ) {
                        if ( !empty( $field->mParams['nodata'] ) ) {
                                continue;
                        }
                        if ( $field->validate(
                                        $this->mFieldData[$fieldname],
                                        $this->mFieldData )
                                !== true
                        ) {
                                return isset( $this->mValidationErrorMessage )
                                        ? $this->mValidationErrorMessage
                                        : array( 'htmlform-invalid-input' );
                        }
                }

                $callback = $this->mSubmitCallback;

                $data = $this->filterDataForSubmit( $this->mFieldData );

                $res = call_user_func( $callback, $data, $this );

                return $res;
        }

        function setSubmitCallback( $cb ) {
                $this->mSubmitCallback = $cb;
        }

        function setValidationErrorMessage( $msg ) {
                $this->mValidationErrorMessage = $msg;
        }

        function setIntro( $msg ) {
                $this->setPreText( $msg );
        }

        function setPreText( $msg ) { $this->mPre = $msg; }

        function addPreText( $msg ) { $this->mPre .= $msg; }

        function addHeaderText( $msg, $section = null ) {
                if ( is_null( $section ) ) {
                        $this->mHeader .= $msg;
                } else {
                        if ( !isset( $this->mSectionHeaders[$section] ) ) {
                                $this->mSectionHeaders[$section] = '';
                        }
                        $this->mSectionHeaders[$section] .= $msg;
                }
        }

        function setHeaderText( $msg, $section = null ) {
                if ( is_null( $section ) ) {
                        $this->mHeader = $msg;
                } else {
                        $this->mSectionHeaders[$section] = $msg;
                }
        }

        function addFooterText( $msg, $section = null ) {
                if ( is_null( $section ) ) {
                        $this->mFooter .= $msg;
                } else {
                        if ( !isset( $this->mSectionFooters[$section] ) ) {
                                $this->mSectionFooters[$section] = '';
                        }
                        $this->mSectionFooters[$section] .= $msg;
                }
        }

        function setFooterText( $msg, $section = null ) {
                if ( is_null( $section ) ) {
                        $this->mFooter = $msg;
                } else {
                        $this->mSectionFooters[$section] = $msg;
                }
        }

        function addPostText( $msg ) { $this->mPost .= $msg; }

        function setPostText( $msg ) { $this->mPost = $msg; }

        public function addHiddenField( $name, $value, $attribs = array() ) {
                $attribs += array( 'name' => $name );
                $this->mHiddenFields[] = array( $value, $attribs );
        }

        public function addButton( $name, $value, $id = null, $attribs = null ) {
                $this->mButtons[] = compact( 'name', 'value', 'id', 'attribs' );
        }

        function displayForm( $submitResult ) {
                $this->getOutput()->addHTML( $this->getHTML( $submitResult ) );
        }

        function getHTML( $submitResult ) {
                # For good measure (it is the default)
                $this->getOutput()->preventClickjacking();
                $this->getOutput()->addModules( 'mediawiki.htmlform' );

                $html = ''
                        . $this->getErrors( $submitResult )
                        . $this->mHeader
                        . $this->getBody()
                        . $this->getHiddenFields()
                        . $this->getButtons()
                        . $this->mFooter
                ;

                $html = $this->wrapForm( $html );

                return '' . $this->mPre . $html . $this->mPost;
        }

        function wrapForm( $html ) {

                # Include a <fieldset> wrapper for style, if requested.
                if ( $this->mWrapperLegend !== false ) {
                        $html = Xml::fieldset( $this->mWrapperLegend, $html );
                }
                # Use multipart/form-data
                $encType = $this->mUseMultipart
                        ? 'multipart/form-data'
                        : 'application/x-www-form-urlencoded';
                # Attributes
                $attribs = array(
                        'action'  => $this->mAction === false ? $this->getTitle()->getFullURL() : $this->mAction,
                        'method'  => $this->mMethod,
                        'class'   => 'visualClear',
                        'enctype' => $encType,
                );
                if ( !empty( $this->mId ) ) {
                        $attribs['id'] = $this->mId;
                }

                return Html::rawElement( 'form', $attribs, $html );
        }

        function getHiddenFields() {
                global $wgUsePathInfo;

                $html = '';
                if( $this->getMethod() == 'post' ){
                        $html .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken(), array( 'id' => 'wpEditToken' ) ) . "\n";
                        $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
                }

                if ( !$wgUsePathInfo && $this->getMethod() == 'get' ) {
                        $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n";
                }

                foreach ( $this->mHiddenFields as $data ) {
                        list( $value, $attribs ) = $data;
                        $html .= Html::hidden( $attribs['name'], $value, $attribs ) . "\n";
                }

                return $html;
        }

        function getButtons() {
                $html = '';
                $attribs = array();

                if ( isset( $this->mSubmitID ) ) {
                        $attribs['id'] = $this->mSubmitID;
                }

                if ( isset( $this->mSubmitName ) ) {
                        $attribs['name'] = $this->mSubmitName;
                }

                if ( isset( $this->mSubmitTooltip ) ) {
                        $attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
                }

                $attribs['class'] = 'mw-htmlform-submit';

                $html .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";

                if ( $this->mShowReset ) {
                        $html .= Html::element(
                                'input',
                                array(
                                        'type' => 'reset',
                                        'value' => wfMsg( 'htmlform-reset' )
                                )
                        ) . "\n";
                }

                foreach ( $this->mButtons as $button ) {
                        $attrs = array(
                                'type'  => 'submit',
                                'name'  => $button['name'],
                                'value' => $button['value']
                        );

                        if ( $button['attribs'] ) {
                                $attrs += $button['attribs'];
                        }

                        if ( isset( $button['id'] ) ) {
                                $attrs['id'] = $button['id'];
                        }

                        $html .= Html::element( 'input', $attrs );
                }

                return $html;
        }

        function getBody() {
                return $this->displaySection( $this->mFieldTree );
        }

        function getErrors( $errors ) {
                if ( $errors instanceof Status ) {
                        if ( $errors->isOK() ) {
                                $errorstr = '';
                        } else {
                                $errorstr = $this->getOutput()->parse( $errors->getWikiText() );
                        }
                } elseif ( is_array( $errors ) ) {
                        $errorstr = $this->formatErrors( $errors );
                } else {
                        $errorstr = $errors;
                }

                return $errorstr
                        ? Html::rawElement( 'div', array( 'class' => 'error' ), $errorstr )
                        : '';
        }

        public static function formatErrors( $errors ) {
                $errorstr = '';

                foreach ( $errors as $error ) {
                        if ( is_array( $error ) ) {
                                $msg = array_shift( $error );
                        } else {
                                $msg = $error;
                                $error = array();
                        }

                        $errorstr .= Html::rawElement(
                                'li',
                                array(),
                                wfMsgExt( $msg, array( 'parseinline' ), $error )
                        );
                }

                $errorstr = Html::rawElement( 'ul', array(), $errorstr );

                return $errorstr;
        }

        function setSubmitText( $t ) {
                $this->mSubmitText = $t;
        }

        public function setSubmitTextMsg( $msg ) {
                return $this->setSubmitText( $this->msg( $msg )->escaped() );
        }

        function getSubmitText() {
                return $this->mSubmitText
                        ? $this->mSubmitText
                        : wfMsg( 'htmlform-submit' );
        }

        public function setSubmitName( $name ) {
                $this->mSubmitName = $name;
        }

        public function setSubmitTooltip( $name ) {
                $this->mSubmitTooltip = $name;
        }

        function setSubmitID( $t ) {
                $this->mSubmitID = $t;
        }

        public function setId( $id ) {
                $this->mId = $id;
        }
        public function setWrapperLegend( $legend ) { $this->mWrapperLegend = $legend; }

        public function setWrapperLegendMsg( $msg ) {
                return $this->setWrapperLegend( $this->msg( $msg )->escaped() );
        }

        function setMessagePrefix( $p ) {
                $this->mMessagePrefix = $p;
        }

        function setTitle( $t ) {
                $this->mTitle = $t;
        }

        function getTitle() {
                return $this->mTitle === false
                        ? $this->getContext()->getTitle()
                        : $this->mTitle;
        }

        public function setMethod( $method='post' ){
                $this->mMethod = $method;
        }

        public function getMethod(){
                return $this->mMethod;
        }

        function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) {
                $tableHtml = '';
                $subsectionHtml = '';
                $hasLeftColumn = false;

                foreach ( $fields as $key => $value ) {
                        if ( is_object( $value ) ) {
                                $v = empty( $value->mParams['nodata'] )
                                        ? $this->mFieldData[$key]
                                        : $value->getDefault();
                                $tableHtml .= $value->getTableRow( $v );

                                if ( $value->getLabel() != '&#160;' ) {
                                        $hasLeftColumn = true;
                                }
                        } elseif ( is_array( $value ) ) {
                                $section = $this->displaySection( $value, $key );
                                $legend = $this->getLegend( $key );
                                if ( isset( $this->mSectionHeaders[$key] ) ) {
                                        $section = $this->mSectionHeaders[$key] . $section;
                                }
                                if ( isset( $this->mSectionFooters[$key] ) ) {
                                        $section .= $this->mSectionFooters[$key];
                                }
                                $attributes = array();
                                if ( $fieldsetIDPrefix ) {
                                        $attributes['id'] = Sanitizer::escapeId( "$fieldsetIDPrefix$key" );
                                }
                                $subsectionHtml .= Xml::fieldset( $legend, $section, $attributes ) . "\n";
                        }
                }

                $classes = array();

                if ( !$hasLeftColumn ) { // Avoid strange spacing when no labels exist
                        $classes[] = 'mw-htmlform-nolabel';
                }

                $attribs = array(
                        'class' => implode( ' ', $classes ),
                );

                if ( $sectionName ) {
                        $attribs['id'] = Sanitizer::escapeId( "mw-htmlform-$sectionName" );
                }

                $tableHtml = Html::rawElement( 'table', $attribs,
                        Html::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n";

                if ( $this->mSubSectionBeforeFields ) {
                        return $subsectionHtml . "\n" . $tableHtml;
                } else {
                        return $tableHtml . "\n" . $subsectionHtml;
                }
        }

        function loadData() {
                $fieldData = array();

                foreach ( $this->mFlatFields as $fieldname => $field ) {
                        if ( !empty( $field->mParams['nodata'] ) ) {
                                continue;
                        } elseif ( !empty( $field->mParams['disabled'] ) ) {
                                $fieldData[$fieldname] = $field->getDefault();
                        } else {
                                $fieldData[$fieldname] = $field->loadDataFromRequest( $this->getRequest() );
                        }
                }

                # Filter data.
                foreach ( $fieldData as $name => &$value ) {
                        $field = $this->mFlatFields[$name];
                        $value = $field->filter( $value, $this->mFlatFields );
                }

                $this->mFieldData = $fieldData;
        }

        function suppressReset( $suppressReset = true ) {
                $this->mShowReset = !$suppressReset;
        }

        function filterDataForSubmit( $data ) {
                return $data;
        }

        public function getLegend( $key ) {
                return wfMsg( "{$this->mMessagePrefix}-$key" );
        }

        public function setAction( $action ) {
                $this->mAction = $action;
        }

}

abstract class HTMLFormField {

        protected $mValidationCallback;
        protected $mFilterCallback;
        protected $mName;
        public $mParams;
        protected $mLabel;      # String label.  Set on construction
        protected $mID;
        protected $mClass = '';
        protected $mDefault;

        public $mParent;

        abstract function getInputHTML( $value );

        function validate( $value, $alldata ) {
                if ( isset( $this->mParams['required'] ) && $value === '' ) {
                        return wfMsgExt( 'htmlform-required', 'parseinline' );
                }

                if ( isset( $this->mValidationCallback ) ) {
                        return call_user_func( $this->mValidationCallback, $value, $alldata, $this->mParent );
                }

                return true;
        }

        function filter( $value, $alldata ) {
                if ( isset( $this->mFilterCallback ) ) {
                        $value = call_user_func( $this->mFilterCallback, $value, $alldata, $this->mParent );
                }

                return $value;
        }

        protected function needsLabel() {
                return true;
        }

        function loadDataFromRequest( $request ) {
                if ( $request->getCheck( $this->mName ) ) {
                        return $request->getText( $this->mName );
                } else {
                        return $this->getDefault();
                }
        }

        function __construct( $params ) {
                $this->mParams = $params;

                # Generate the label from a message, if possible
                if ( isset( $params['label-message'] ) ) {
                        $msgInfo = $params['label-message'];

                        if ( is_array( $msgInfo ) ) {
                                $msg = array_shift( $msgInfo );
                        } else {
                                $msg = $msgInfo;
                                $msgInfo = array();
                        }

                        $this->mLabel = wfMsgExt( $msg, 'parseinline', $msgInfo );
                } elseif ( isset( $params['label'] ) ) {
                        $this->mLabel = $params['label'];
                }

                $this->mName = "wp{$params['fieldname']}";
                if ( isset( $params['name'] ) ) {
                        $this->mName = $params['name'];
                }

                $validName = Sanitizer::escapeId( $this->mName );
                if ( $this->mName != $validName && !isset( $params['nodata'] ) ) {
                        throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__ );
                }

                $this->mID = "mw-input-{$this->mName}";

                if ( isset( $params['default'] ) ) {
                        $this->mDefault = $params['default'];
                }

                if ( isset( $params['id'] ) ) {
                        $id = $params['id'];
                        $validId = Sanitizer::escapeId( $id );

                        if ( $id != $validId ) {
                                throw new MWException( "Invalid id '$id' passed to " . __METHOD__ );
                        }

                        $this->mID = $id;
                }

                if ( isset( $params['cssclass'] ) ) {
                        $this->mClass = $params['cssclass'];
                }

                if ( isset( $params['validation-callback'] ) ) {
                        $this->mValidationCallback = $params['validation-callback'];
                }

                if ( isset( $params['filter-callback'] ) ) {
                        $this->mFilterCallback = $params['filter-callback'];
                }

                if ( isset( $params['flatlist'] ) ){
                        $this->mClass .= ' mw-htmlform-flatlist';
                }
        }

        function getTableRow( $value ) {
                # Check for invalid data.

                $errors = $this->validate( $value, $this->mParent->mFieldData );

                $cellAttributes = array();
                $verticalLabel = false;

                if ( !empty($this->mParams['vertical-label']) ) {
                        $cellAttributes['colspan'] = 2;
                        $verticalLabel = true;
                }

                if ( $errors === true || ( !$this->mParent->getRequest()->wasPosted() && ( $this->mParent->getMethod() == 'post' ) ) ) {
                        $errors = '';
                        $errorClass = '';
                } else {
                        $errors = self::formatErrors( $errors );
                        $errorClass = 'mw-htmlform-invalid-input';
                }

                $label = $this->getLabelHtml( $cellAttributes );
                $field = Html::rawElement(
                        'td',
                        array( 'class' => 'mw-input' ) + $cellAttributes,
                        $this->getInputHTML( $value ) . "\n$errors"
                );

                $fieldType = get_class( $this );

                if ( $verticalLabel ) {
                        $html = Html::rawElement( 'tr',
                                array( 'class' => 'mw-htmlform-vertical-label' ), $label );
                        $html .= Html::rawElement( 'tr',
                                array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
                                $field );
                } else {
                        $html = Html::rawElement( 'tr',
                                array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
                                $label . $field );
                }

                $helptext = null;

                if ( isset( $this->mParams['help-message'] ) ) {
                        $msg = wfMessage( $this->mParams['help-message'] );
                        if ( $msg->exists() ) {
                                $helptext = $msg->parse();
                        }
                } elseif ( isset( $this->mParams['help-messages'] ) ) {
                        # help-message can be passed a message key (string) or an array containing
                        # a message key and additional parameters. This makes it impossible to pass
                        # an array of message key
                        foreach( $this->mParams['help-messages'] as $name ) {
                                $msg = wfMessage( $name );
                                if( $msg->exists() ) {
                                        $helptext .= $msg->parse(); // append message
                                }
                        }
                } elseif ( isset( $this->mParams['help'] ) ) {
                        $helptext = $this->mParams['help'];
                }

                if ( !is_null( $helptext ) ) {
                        $row = Html::rawElement( 'td', array( 'colspan' => 2, 'class' => 'htmlform-tip' ),
                                $helptext );
                        $row = Html::rawElement( 'tr', array(), $row );
                        $html .= "$row\n";
                }

                return $html;
        }

        function getLabel() {
                return $this->mLabel;
        }
        function getLabelHtml( $cellAttributes = array() ) {
                # Don't output a for= attribute for labels with no associated input.
                # Kind of hacky here, possibly we don't want these to be <label>s at all.
                $for = array();

                if ( $this->needsLabel() ) {
                        $for['for'] = $this->mID;
                }

                return Html::rawElement( 'td', array( 'class' => 'mw-label' ) + $cellAttributes,
                        Html::rawElement( 'label', $for, $this->getLabel() )
                );
        }

        function getDefault() {
                if ( isset( $this->mDefault ) ) {
                        return $this->mDefault;
                } else {
                        return null;
                }
        }

        public function getTooltipAndAccessKey() {
                if ( empty( $this->mParams['tooltip'] ) ) {
                        return array();
                }
                return Linker::tooltipAndAccesskeyAttribs( $this->mParams['tooltip'] );
        }

        public static function flattenOptions( $options ) {
                $flatOpts = array();

                foreach ( $options as $value ) {
                        if ( is_array( $value ) ) {
                                $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
                        } else {
                                $flatOpts[] = $value;
                        }
                }

                return $flatOpts;
        }

        protected static function formatErrors( $errors ) {
                if ( is_array( $errors ) && count( $errors ) === 1 ) {
                        $errors = array_shift( $errors );
                }

                if ( is_array( $errors ) ) {
                        $lines = array();
                        foreach ( $errors as $error ) {
                                if ( $error instanceof Message ) {
                                        $lines[] = Html::rawElement( 'li', array(), $error->parse() );
                                } else {
                                        $lines[] = Html::rawElement( 'li', array(), $error );
                                }
                        }
                        return Html::rawElement( 'ul', array( 'class' => 'error' ), implode( "\n", $lines ) );
                } else {
                        if ( $errors instanceof Message ) {
                                $errors = $errors->parse();
                        }
                        return Html::rawElement( 'span', array( 'class' => 'error' ), $errors );
                }
        }
}

class HTMLTextField extends HTMLFormField {
        function getSize() {
                return isset( $this->mParams['size'] )
                        ? $this->mParams['size']
                        : 45;
        }

        function getInputHTML( $value ) {
                $attribs = array(
                        'id' => $this->mID,
                        'name' => $this->mName,
                        'size' => $this->getSize(),
                        'value' => $value,
                ) + $this->getTooltipAndAccessKey();

                if ( $this->mClass !== '' ) {
                        $attribs['class'] = $this->mClass;
                }
                
                if ( isset( $this->mParams['maxlength'] ) ) {
                        $attribs['maxlength'] = $this->mParams['maxlength'];
                }

                if ( !empty( $this->mParams['disabled'] ) ) {
                        $attribs['disabled'] = 'disabled';
                }

                # TODO: Enforce pattern, step, required, readonly on the server side as
                # well
                foreach ( array( 'min', 'max', 'pattern', 'title', 'step',
                'placeholder' ) as $param ) {
                        if ( isset( $this->mParams[$param] ) ) {
                                $attribs[$param] = $this->mParams[$param];
                        }
                }

                foreach ( array( 'required', 'autofocus', 'multiple', 'readonly' ) as $param ) {
                        if ( isset( $this->mParams[$param] ) ) {
                                $attribs[$param] = '';
                        }
                }

                # Implement tiny differences between some field variants
                # here, rather than creating a new class for each one which
                # is essentially just a clone of this one.
                if ( isset( $this->mParams['type'] ) ) {
                        switch ( $this->mParams['type'] ) {
                                case 'email':
                                        $attribs['type'] = 'email';
                                        break;
                                case 'int':
                                        $attribs['type'] = 'number';
                                        break;
                                case 'float':
                                        $attribs['type'] = 'number';
                                        $attribs['step'] = 'any';
                                        break;
                                # Pass through
                                case 'password':
                                case 'file':
                                        $attribs['type'] = $this->mParams['type'];
                                        break;
                        }
                }

                return Html::element( 'input', $attribs );
        }
}
class HTMLTextAreaField extends HTMLFormField {
        function getCols() {
                return isset( $this->mParams['cols'] )
                        ? $this->mParams['cols']
                        : 80;
        }

        function getRows() {
                return isset( $this->mParams['rows'] )
                        ? $this->mParams['rows']
                        : 25;
        }

        function getInputHTML( $value ) {
                $attribs = array(
                        'id' => $this->mID,
                        'name' => $this->mName,
                        'cols' => $this->getCols(),
                        'rows' => $this->getRows(),
                ) + $this->getTooltipAndAccessKey();

                if ( $this->mClass !== '' ) {
                        $attribs['class'] = $this->mClass;
                }
                
                if ( !empty( $this->mParams['disabled'] ) ) {
                        $attribs['disabled'] = 'disabled';
                }

                if ( !empty( $this->mParams['readonly'] ) ) {
                        $attribs['readonly'] = 'readonly';
                }

                foreach ( array( 'required', 'autofocus' ) as $param ) {
                        if ( isset( $this->mParams[$param] ) ) {
                                $attribs[$param] = '';
                        }
                }

                return Html::element( 'textarea', $attribs, $value );
        }
}

class HTMLFloatField extends HTMLTextField {
        function getSize() {
                return isset( $this->mParams['size'] )
                        ? $this->mParams['size']
                        : 20;
        }

        function validate( $value, $alldata ) {
                $p = parent::validate( $value, $alldata );

                if ( $p !== true ) {
                        return $p;
                }

                $value = trim( $value );

                # http://dev.w3.org/html5/spec/common-microsyntaxes.html#real-numbers
                # with the addition that a leading '+' sign is ok.
                if ( !preg_match( '/^((\+|\-)?\d+(\.\d+)?(E(\+|\-)?\d+)?)?$/i', $value ) ) {
                        return wfMsgExt( 'htmlform-float-invalid', 'parse' );
                }

                # The "int" part of these message names is rather confusing.
                # They make equal sense for all numbers.
                if ( isset( $this->mParams['min'] ) ) {
                        $min = $this->mParams['min'];

                        if ( $min > $value ) {
                                return wfMsgExt( 'htmlform-int-toolow', 'parse', array( $min ) );
                        }
                }

                if ( isset( $this->mParams['max'] ) ) {
                        $max = $this->mParams['max'];

                        if ( $max < $value ) {
                                return wfMsgExt( 'htmlform-int-toohigh', 'parse', array( $max ) );
                        }
                }

                return true;
        }
}

class HTMLIntField extends HTMLFloatField {
        function validate( $value, $alldata ) {
                $p = parent::validate( $value, $alldata );

                if ( $p !== true ) {
                        return $p;
                }

                # http://dev.w3.org/html5/spec/common-microsyntaxes.html#signed-integers
                # with the addition that a leading '+' sign is ok. Note that leading zeros
                # are fine, and will be left in the input, which is useful for things like
                # phone numbers when you know that they are integers (the HTML5 type=tel
                # input does not require its value to be numeric).  If you want a tidier
                # value to, eg, save in the DB, clean it up with intval().
                if ( !preg_match( '/^((\+|\-)?\d+)?$/', trim( $value ) )
                ) {
                        return wfMsgExt( 'htmlform-int-invalid', 'parse' );
                }

                return true;
        }
}

class HTMLCheckField extends HTMLFormField {
        function getInputHTML( $value ) {
                if ( !empty( $this->mParams['invert'] ) ) {
                        $value = !$value;
                }

                $attr = $this->getTooltipAndAccessKey();
                $attr['id'] = $this->mID;

                if ( !empty( $this->mParams['disabled'] ) ) {
                        $attr['disabled'] = 'disabled';
                }
                
                if ( $this->mClass !== '' ) {
                        $attr['class'] = $this->mClass;
                }

                return Xml::check( $this->mName, $value, $attr ) . '&#160;' .
                        Html::rawElement( 'label', array( 'for' => $this->mID ), $this->mLabel );
        }

        function getLabel() {
                return '&#160;';
        }

        function loadDataFromRequest( $request ) {
                $invert = false;
                if ( isset( $this->mParams['invert'] ) && $this->mParams['invert'] ) {
                        $invert = true;
                }

                // GetCheck won't work like we want for checks.
                // Fetch the value in either one of the two following case:
                // - we have a valid token (form got posted or GET forged by the user)
                // - checkbox name has a value (false or true), ie is not null
                if ( $request->getCheck( 'wpEditToken' ) || $request->getVal( $this->mName )!== null ) {
                        // XOR has the following truth table, which is what we want
                        // INVERT VALUE | OUTPUT
                        // true   true  | false
                        // false  true  | true
                        // false  false | false
                        // true   false | true
                        return $request->getBool( $this->mName ) xor $invert;
                } else {
                        return $this->getDefault();
                }
        }
}

class HTMLSelectField extends HTMLFormField {
        function validate( $value, $alldata ) {
                $p = parent::validate( $value, $alldata );

                if ( $p !== true ) {
                        return $p;
                }

                $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );

                if ( in_array( $value, $validOptions ) )
                        return true;
                else
                        return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
        }

        function getInputHTML( $value ) {
                $select = new XmlSelect( $this->mName, $this->mID, strval( $value ) );

                # If one of the options' 'name' is int(0), it is automatically selected.
                # because PHP sucks and thinks int(0) == 'some string'.
                # Working around this by forcing all of them to strings.
                foreach( $this->mParams['options'] as &$opt ){
                        if( is_int( $opt ) ){
                                $opt = strval( $opt );
                        }
                }
                unset( $opt ); # PHP keeps $opt around as a reference, which is a bit scary

                if ( !empty( $this->mParams['disabled'] ) ) {
                        $select->setAttribute( 'disabled', 'disabled' );
                }
                
                if ( $this->mClass !== '' ) {
                        $select->setAttribute( 'class', $this->mClass );
                }

                $select->addOptions( $this->mParams['options'] );

                return $select->getHTML();
        }
}

class HTMLSelectOrOtherField extends HTMLTextField {
        static $jsAdded = false;

        function __construct( $params ) {
                if ( !in_array( 'other', $params['options'], true ) ) {
                        $msg = isset( $params['other'] ) ? $params['other'] : wfMsg( 'htmlform-selectorother-other' );
                        $params['options'][$msg] = 'other';
                }

                parent::__construct( $params );
        }

        static function forceToStringRecursive( $array ) {
                if ( is_array( $array ) ) {
                        return array_map( array( __CLASS__, 'forceToStringRecursive' ), $array );
                } else {
                        return strval( $array );
                }
        }

        function getInputHTML( $value ) {
                $valInSelect = false;

                if ( $value !== false ) {
                        $valInSelect = in_array(
                                $value,
                                HTMLFormField::flattenOptions( $this->mParams['options'] )
                        );
                }

                $selected = $valInSelect ? $value : 'other';

                $opts = self::forceToStringRecursive( $this->mParams['options'] );

                $select = new XmlSelect( $this->mName, $this->mID, $selected );
                $select->addOptions( $opts );

                $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );

                $tbAttribs = array( 'id' => $this->mID . '-other', 'size' => $this->getSize() );

                if ( !empty( $this->mParams['disabled'] ) ) {
                        $select->setAttribute( 'disabled', 'disabled' );
                        $tbAttribs['disabled'] = 'disabled';
                }

                $select = $select->getHTML();

                if ( isset( $this->mParams['maxlength'] ) ) {
                        $tbAttribs['maxlength'] = $this->mParams['maxlength'];
                }
                
                if ( $this->mClass !== '' ) {
                        $tbAttribs['class'] = $this->mClass;
                }

                $textbox = Html::input(
                        $this->mName . '-other',
                        $valInSelect ? '' : $value,
                        'text',
                        $tbAttribs
                );

                return "$select<br />\n$textbox";
        }

        function loadDataFromRequest( $request ) {
                if ( $request->getCheck( $this->mName ) ) {
                        $val = $request->getText( $this->mName );

                        if ( $val == 'other' ) {
                                $val = $request->getText( $this->mName . '-other' );
                        }

                        return $val;
                } else {
                        return $this->getDefault();
                }
        }
}

class HTMLMultiSelectField extends HTMLFormField {

        function validate( $value, $alldata ) {
                $p = parent::validate( $value, $alldata );

                if ( $p !== true ) {
                        return $p;
                }

                if ( !is_array( $value ) ) {
                        return false;
                }

                # If all options are valid, array_intersect of the valid options
                # and the provided options will return the provided options.
                $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );

                $validValues = array_intersect( $value, $validOptions );
                if ( count( $validValues ) == count( $value ) ) {
                        return true;
                } else {
                        return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
                }
        }

        function getInputHTML( $value ) {
                $html = $this->formatOptions( $this->mParams['options'], $value );

                return $html;
        }

        function formatOptions( $options, $value ) {
                $html = '';

                $attribs = array();

                if ( !empty( $this->mParams['disabled'] ) ) {
                        $attribs['disabled'] = 'disabled';
                }

                foreach ( $options as $label => $info ) {
                        if ( is_array( $info ) ) {
                                $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
                                $html .= $this->formatOptions( $info, $value );
                        } else {
                                $thisAttribs = array( 'id' => "{$this->mID}-$info", 'value' => $info );

                                $checkbox = Xml::check(
                                        $this->mName . '[]',
                                        in_array( $info, $value, true ),
                                        $attribs + $thisAttribs );
                                $checkbox .= '&#160;' . Html::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label );

                                $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-flatlist-item' ), $checkbox );
                        }
                }

                return $html;
        }

        function loadDataFromRequest( $request ) {
                if ( $this->mParent->getMethod() == 'post' ) {
                        if( $request->wasPosted() ){
                                # Checkboxes are just not added to the request arrays if they're not checked,
                                # so it's perfectly possible for there not to be an entry at all
                                return $request->getArray( $this->mName, array() );
                        } else {
                                # That's ok, the user has not yet submitted the form, so show the defaults
                                return $this->getDefault();
                        }
                } else {
                        # This is the impossible case: if we look at $_GET and see no data for our
                        # field, is it because the user has not yet submitted the form, or that they
                        # have submitted it with all the options unchecked? We will have to assume the
                        # latter, which basically means that you can't specify 'positive' defaults
                        # for GET forms.
                        # @todo FIXME...
                        return $request->getArray( $this->mName, array() );
                }
        }

        function getDefault() {
                if ( isset( $this->mDefault ) ) {
                        return $this->mDefault;
                } else {
                        return array();
                }
        }

        protected function needsLabel() {
                return false;
        }
}

class HTMLSelectAndOtherField extends HTMLSelectField {

        function __construct( $params ) {
                if ( array_key_exists( 'other', $params ) ) {
                } elseif( array_key_exists( 'other-message', $params ) ){
                        $params['other'] = wfMessage( $params['other-message'] )->plain();
                } else {
                        $params['other'] = null;
                }

                if ( array_key_exists( 'options', $params ) ) {
                        # Options array already specified
                } elseif( array_key_exists( 'options-message', $params ) ){
                        # Generate options array from a system message
                        $params['options'] = self::parseMessage(
                                wfMessage( $params['options-message'] )->inContentLanguage()->plain(),
                                $params['other']
                        );
                } else {
                        # Sulk
                        throw new MWException( 'HTMLSelectAndOtherField called without any options' );
                }
                $this->mFlatOptions = self::flattenOptions( $params['options'] );

                parent::__construct( $params );
        }

        public static function parseMessage( $string, $otherName=null ) {
                if( $otherName === null ){
                        $otherName = wfMessage( 'htmlform-selectorother-other' )->plain();
                }

                $optgroup = false;
                $options = array( $otherName => 'other' );

                foreach ( explode( "\n", $string ) as $option ) {
                        $value = trim( $option );
                        if ( $value == '' ) {
                                continue;
                        } elseif ( substr( $value, 0, 1) == '*' && substr( $value, 1, 1) != '*' ) {
                                # A new group is starting...
                                $value = trim( substr( $value, 1 ) );
                                $optgroup = $value;
                        } elseif ( substr( $value, 0, 2) == '**' ) {
                                # groupmember
                                $opt = trim( substr( $value, 2 ) );
                                if( $optgroup === false ){
                                        $options[$opt] = $opt;
                                } else {
                                        $options[$optgroup][$opt] = $opt;
                                }
                        } else {
                                # groupless reason list
                                $optgroup = false;
                                $options[$option] = $option;
                        }
                }

                return $options;
        }

        function getInputHTML( $value ) {
                $select = parent::getInputHTML( $value[1] );

                $textAttribs = array(
                        'id' => $this->mID . '-other',
                        'size' => $this->getSize(),
                );
                
                if ( $this->mClass !== '' ) {
                        $textAttribs['class'] = $this->mClass;
                }

                foreach ( array( 'required', 'autofocus', 'multiple', 'disabled' ) as $param ) {
                        if ( isset( $this->mParams[$param] ) ) {
                                $textAttribs[$param] = '';
                        }
                }

                $textbox = Html::input(
                        $this->mName . '-other',
                        $value[2],
                        'text',
                        $textAttribs
                );

                return "$select<br />\n$textbox";
        }

        function loadDataFromRequest( $request ) {
                if ( $request->getCheck( $this->mName ) ) {

                        $list = $request->getText( $this->mName );
                        $text = $request->getText( $this->mName . '-other' );

                        if ( $list == 'other' ) {
                                $final = $text;
                        } elseif( !in_array( $list, $this->mFlatOptions ) ){
                                # User has spoofed the select form to give an option which wasn't
                                # in the original offer.  Sulk...
                                $final = $text;
                        } elseif( $text == '' ) {
                                $final = $list;
                        } else {
                                $final = $list . wfMsgForContent( 'colon-separator' ) . $text;
                        }

                } else {
                        $final = $this->getDefault();

                        $list = 'other';
                        $text = $final;
                        foreach ( $this->mFlatOptions as $option ) {
                                $match = $option . wfMsgForContent( 'colon-separator' );
                                if( strpos( $text, $match ) === 0 ) {
                                        $list = $option;
                                        $text = substr( $text, strlen( $match ) );
                                        break;
                                }
                        }
                }
                return array( $final, $list, $text );
        }

        function getSize() {
                return isset( $this->mParams['size'] )
                        ? $this->mParams['size']
                        : 45;
        }

        function validate( $value, $alldata ) {
                # HTMLSelectField forces $value to be one of the options in the select
                # field, which is not useful here.  But we do want the validation further up
                # the chain
                $p = parent::validate( $value[1], $alldata );

                if ( $p !== true ) {
                        return $p;
                }

                if( isset( $this->mParams['required'] ) && $value[1] === '' ){
                        return wfMsgExt( 'htmlform-required', 'parseinline' );
                }

                return true;
        }
}

class HTMLRadioField extends HTMLFormField {


        function validate( $value, $alldata ) {
                $p = parent::validate( $value, $alldata );

                if ( $p !== true ) {
                        return $p;
                }

                if ( !is_string( $value ) && !is_int( $value ) ) {
                        return false;
                }

                $validOptions = HTMLFormField::flattenOptions( $this->mParams['options'] );

                if ( in_array( $value, $validOptions ) ) {
                        return true;
                } else {
                        return wfMsgExt( 'htmlform-select-badoption', 'parseinline' );
                }
        }

        function getInputHTML( $value ) {
                $html = $this->formatOptions( $this->mParams['options'], $value );

                return $html;
        }

        function formatOptions( $options, $value ) {
                $html = '';

                $attribs = array();
                if ( !empty( $this->mParams['disabled'] ) ) {
                        $attribs['disabled'] = 'disabled';
                }

                # TODO: should this produce an unordered list perhaps?
                foreach ( $options as $label => $info ) {
                        if ( is_array( $info ) ) {
                                $html .= Html::rawElement( 'h1', array(), $label ) . "\n";
                                $html .= $this->formatOptions( $info, $value );
                        } else {
                                $id = Sanitizer::escapeId( $this->mID . "-$info" );
                                $radio = Xml::radio(
                                        $this->mName,
                                        $info,
                                        $info == $value,
                                        $attribs + array( 'id' => $id )
                                );
                                $radio .= '&#160;' .
                                                Html::rawElement( 'label', array( 'for' => $id ), $label );

                                $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-flatlist-item' ), $radio );
                        }
                }

                return $html;
        }

        protected function needsLabel() {
                return false;
        }
}

class HTMLInfoField extends HTMLFormField {
        function __construct( $info ) {
                $info['nodata'] = true;

                parent::__construct( $info );
        }

        function getInputHTML( $value ) {
                return !empty( $this->mParams['raw'] ) ? $value : htmlspecialchars( $value );
        }

        function getTableRow( $value ) {
                if ( !empty( $this->mParams['rawrow'] ) ) {
                        return $value;
                }

                return parent::getTableRow( $value );
        }

        protected function needsLabel() {
                return false;
        }
}

class HTMLHiddenField extends HTMLFormField {
        public function __construct( $params ) {
                parent::__construct( $params );

                # Per HTML5 spec, hidden fields cannot be 'required'
                # http://dev.w3.org/html5/spec/states-of-the-type-attribute.html#hidden-state
                unset( $this->mParams['required'] );
        }

        public function getTableRow( $value ) {
                $params = array();
                if ( $this->mID ) {
                        $params['id'] = $this->mID;
                }

                $this->mParent->addHiddenField(
                        $this->mName,
                        $this->mDefault,
                        $params
                );

                return '';
        }

        public function getInputHTML( $value ) { return ''; }
}

class HTMLSubmitField extends HTMLFormField {

        function __construct( $info ) {
                $info['nodata'] = true;
                parent::__construct( $info );
        }

        function getInputHTML( $value ) {
                return Xml::submitButton(
                        $value,
                        array(
                                'class' => 'mw-htmlform-submit ' . $this->mClass,
                                'name' => $this->mName,
                                'id' => $this->mID,
                        )
                );
        }

        protected function needsLabel() {
                return false;
        }

        public function validate( $value, $alldata ){
                return true;
        }
}

class HTMLEditTools extends HTMLFormField {
        public function getInputHTML( $value ) {
                return '';
        }

        public function getTableRow( $value ) {
                if ( empty( $this->mParams['message'] ) ) {
                        $msg = wfMessage( 'edittools' );
                } else {
                        $msg = wfMessage( $this->mParams['message'] );
                        if ( $msg->isDisabled() ) {
                                $msg = wfMessage( 'edittools' );
                        }
                }
                $msg->inContentLanguage();


                return '<tr><td></td><td class="mw-input">'
                        . '<div class="mw-editTools">'
                        . $msg->parseAsBlock()
                        . "</div></td></tr>\n";
        }
}

class HTMLApiField extends HTMLFormField {
        public function getTableRow( $value ) {
                return '';
        }

        public function getDiv( $value ) {
                return $this->getTableRow( $value );
        }

        public function getRaw( $value ) {
                return $this->getTableRow( $value );
        }

        public function getInputHTML( $value ) {
                return '';
        }
}