HTMLForm.php

Go to the documentation of this file.

<?php

class HTMLForm extends ContextSource {
    // A mapping of 'type' inputs onto standard HTMLFormField subclasses
    public static $typeMappings = array(
        'api' => 'HTMLApiField',
        'text' => 'HTMLTextField',
        'textarea' => 'HTMLTextAreaField',
        'select' => 'HTMLSelectField',
        'radio' => 'HTMLRadioField',
        'multiselect' => 'HTMLMultiSelectField',
        'limitselect' => 'HTMLSelectLimitField',
        'check' => 'HTMLCheckField',
        'toggle' => 'HTMLCheckField',
        'int' => 'HTMLIntField',
        'float' => 'HTMLFloatField',
        'info' => 'HTMLInfoField',
        'selectorother' => 'HTMLSelectOrOtherField',
        'selectandother' => 'HTMLSelectAndOtherField',
        'submit' => 'HTMLSubmitField',
        'hidden' => 'HTMLHiddenField',
        'edittools' => 'HTMLEditTools',
        'checkmatrix' => 'HTMLCheckMatrix',
        'cloner' => 'HTMLFormFieldCloner',
        'autocompleteselect' => 'HTMLAutoCompleteSelectField',
        // HTMLTextField will output the correct type="" attribute automagically.
        // There are about four zillion other HTML5 input types, like range, but
        // we don't use those at the moment, so no point in adding all of them.
        'email' => 'HTMLTextField',
        'password' => 'HTMLTextField',
        'url' => 'HTMLTextField',
    );

    public $mFieldData;

    protected $mMessagePrefix;

    protected $mFlatFields;

    protected $mFieldTree;
    protected $mShowReset = false;
    protected $mShowSubmit = true;
    protected $mSubmitModifierClass = 'mw-ui-constructive';

    protected $mSubmitCallback;
    protected $mValidationErrorMessage;

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

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

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

    protected $mAction = false;

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

    protected $mWrapperLegend = false;

    protected $mTokenSalt = '';

    protected $mSubSectionBeforeFields = true;

    protected $displayFormat = 'table';

    protected $availableDisplayFormats = array(
        'table',
        'div',
        'raw',
        'vform',
    );

    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;
        } elseif ( is_null( $context ) && $messagePrefix !== '' ) {
            $this->mMessagePrefix = $messagePrefix;
        } elseif ( is_string( $context ) && $messagePrefix === '' ) {
            // B/C since 1.18
            // 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 );
            // FIXME During field's construct, the parent form isn't available!
            // could add a 'parent' name-value to $info, could add a third parameter.
            $field->mParent = $this;

            // vform gets too much space if empty labels generate HTML.
            if ( $this->isVForm() ) {
                $field->setShowEmptyLabel( false );
            }

            $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;
    }

    public function setDisplayFormat( $format ) {
        if ( !in_array( $format, $this->availableDisplayFormats ) ) {
            throw new MWException( 'Display format must be one of ' .
                print_r( $this->availableDisplayFormats, true ) );
        }
        $this->displayFormat = $format;

        return $this;
    }

    public function getDisplayFormat() {
        $format = $this->displayFormat;
        if ( !$this->getConfig()->get( 'HTMLFormAllowTableFormat' ) && $format === 'table' ) {
            $format = 'div';
        }
        return $format;
    }

    public function isVForm() {
        return $this->displayFormat === 'vform';
    }

    public static function getClassFromDescriptor( $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 for $fieldname: "
                . print_r( $descriptor, true ) );
        }

        return $class;
    }

    public static function loadInputFromParameters( $fieldname, $descriptor ) {
        $class = self::getClassFromDescriptor( $fieldname, $descriptor );

        $descriptor['fieldname'] = $fieldname;

        # @todo This will throw a fatal error whenever someone try to use
        # 'class' to feed a CSS class instead of 'cssclass'. Would be
        # great to avoid the fatal error and show a nice error.
        $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();

        return $this;
    }

    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, $this->mTokenSalt );
            } else {
                $submit = true;
            }
        }

        if ( $submit ) {
            $this->mWasSubmitted = true;
            $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() {
        $this->mWasSubmitted = true;

        # Check for cancelled submission
        foreach ( $this->mFlatFields as $fieldname => $field ) {
            if ( !empty( $field->mParams['nodata'] ) ) {
                continue;
            }
            if ( $field->cancelSubmit( $this->mFieldData[$fieldname], $this->mFieldData ) ) {
                $this->mWasSubmitted = false;
                return false;
            }
        }

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

        $callback = $this->mSubmitCallback;
        if ( !is_callable( $callback ) ) {
            throw new MWException( 'HTMLForm: no submit callback provided. Use ' .
                'setSubmitCallback() to set one.' );
        }

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

        $res = call_user_func( $callback, $data, $this );
        if ( $res === false ) {
            $this->mWasSubmitted = false;
        }

        return $res;
    }

    function wasSubmitted() {
        return $this->mWasSubmitted;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    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;
        }

        return $this;
    }

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

        return $this;
    }

    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;
        }

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    public function addHiddenFields( array $fields ) {
        foreach ( $fields as $name => $value ) {
            $this->mHiddenFields[] = array( $value, array( 'name' => $name ) );
        }

        return $this;
    }

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

        return $this;
    }

    public function setTokenSalt( $salt ) {
        $this->mTokenSalt = $salt;

        return $this;
    }

    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' );
        if ( $this->isVForm() ) {
            $this->getOutput()->addModuleStyles( array(
                'mediawiki.ui',
                'mediawiki.ui.button',
            ) );
            // @todo Should vertical form set setWrapperLegend( false )
            // to hide ugly fieldsets?
        }

        $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->getAction(),
            'method' => $this->getMethod(),
            'class' => array( 'visualClear' ),
            'enctype' => $encType,
        );
        if ( !empty( $this->mId ) ) {
            $attribs['id'] = $this->mId;
        }

        if ( $this->isVForm() ) {
            array_push( $attribs['class'], 'mw-ui-vform', 'mw-ui-container' );
        }

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

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

        $articlePath = $this->getConfig()->get( 'ArticlePath' );
        if ( strpos( $articlePath, '?' ) !== false && $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() {
        $buttons = '';
        $useMediaWikiUIEverywhere = $this->getConfig()->get( 'UseMediaWikiUIEverywhere' );

        if ( $this->mShowSubmit ) {
            $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'] = array( 'mw-htmlform-submit' );

            if ( $this->isVForm() || $useMediaWikiUIEverywhere ) {
                array_push( $attribs['class'], 'mw-ui-button', $this->mSubmitModifierClass );
            }

            if ( $this->isVForm() ) {
                // mw-ui-block is necessary because the buttons aren't necessarily in an
                // immediate child div of the vform.
                // @todo Let client specify if the primary submit button is progressive or destructive
                array_push(
                    $attribs['class'],
                    'mw-ui-big',
                    'mw-ui-block'
                );
            }

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

        if ( $this->mShowReset ) {
            $buttons .= Html::element(
                'input',
                array(
                    'type' => 'reset',
                    'value' => $this->msg( 'htmlform-reset' )->text()
                )
            ) . "\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'];
            }

            if ( $this->isVForm() || $useMediaWikiUIEverywhere ) {
                if ( isset( $attrs['class'] ) ) {
                    $attrs['class'] .= ' mw-ui-button';
                } else {
                    $attrs['class'] = 'mw-ui-button';
                }
                if ( $this->isVForm() ) {
                    $attrs['class'] .= ' mw-ui-big mw-ui-block';
                }
            }

            $buttons .= Html::element( 'input', $attrs ) . "\n";
        }

        $html = Html::rawElement( 'span',
            array( 'class' => 'mw-htmlform-submit-buttons' ), "\n$buttons" ) . "\n";

        // Buttons are top-level form elements in table and div layouts,
        // but vform wants all elements inside divs to get spaced-out block
        // styling.
        if ( $this->mShowSubmit && $this->isVForm() ) {
            $html = Html::rawElement( 'div', null, "\n$html" ) . "\n";
        }

        return $html;
    }

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

    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(),
                wfMessage( $msg, $error )->parse()
            );
        }

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

        return $errorstr;
    }

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

        return $this;
    }

    public function setSubmitDestructive() {
        $this->mSubmitModifierClass = 'mw-ui-destructive';
    }

    public function setSubmitTextMsg( $msg ) {
        if ( !$msg instanceof Message ) {
            $msg = $this->msg( $msg );
        }
        $this->setSubmitText( $msg->text() );

        return $this;
    }

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

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    function suppressDefaultSubmit( $suppressSubmit = true ) {
        $this->mShowSubmit = !$suppressSubmit;

        return $this;
    }

    public function setTableId( $id ) {
        $this->mTableId = $id;

        return $this;
    }

    public function setId( $id ) {
        $this->mId = $id;

        return $this;
    }

    public function setWrapperLegend( $legend ) {
        $this->mWrapperLegend = $legend;

        return $this;
    }

    public function setWrapperLegendMsg( $msg ) {
        if ( !$msg instanceof Message ) {
            $msg = $this->msg( $msg );
        }
        $this->setWrapperLegend( $msg->text() );

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

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

        return $this;
    }

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

    public function displaySection( $fields,
        $sectionName = '',
        $fieldsetIDPrefix = '',
        &$hasUserVisibleFields = false ) {
        $displayFormat = $this->getDisplayFormat();

        $html = '';
        $subsectionHtml = '';
        $hasLabel = false;

        switch ( $displayFormat ) {
            case 'table':
                $getFieldHtmlMethod = 'getTableRow';
                break;
            case 'vform':
                // Close enough to a div.
                $getFieldHtmlMethod = 'getDiv';
                break;
            case 'div':
                $getFieldHtmlMethod = 'getDiv';
                break;
            default:
                $getFieldHtmlMethod = 'get' . ucfirst( $displayFormat );
        }

        foreach ( $fields as $key => $value ) {
            if ( $value instanceof HTMLFormField ) {
                $v = empty( $value->mParams['nodata'] )
                    ? $this->mFieldData[$key]
                    : $value->getDefault();
                $html .= $value->$getFieldHtmlMethod( $v );

                $labelValue = trim( $value->getLabel() );
                if ( $labelValue != '&#160;' && $labelValue !== '' ) {
                    $hasLabel = true;
                }

                if ( get_class( $value ) !== 'HTMLHiddenField' &&
                    get_class( $value ) !== 'HTMLApiField'
                ) {
                    $hasUserVisibleFields = true;
                }
            } elseif ( is_array( $value ) ) {
                $subsectionHasVisibleFields = false;
                $section =
                    $this->displaySection( $value,
                        "mw-htmlform-$key",
                        "$fieldsetIDPrefix$key-",
                        $subsectionHasVisibleFields );
                $legend = null;

                if ( $subsectionHasVisibleFields === true ) {
                    // Display the section with various niceties.
                    $hasUserVisibleFields = true;

                    $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";
                } else {
                    // Just return the inputs, nothing fancy.
                    $subsectionHtml .= $section;
                }
            }
        }

        if ( $displayFormat !== 'raw' ) {
            $classes = array();

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

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

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

            if ( $displayFormat === 'table' ) {
                $html = Html::rawElement( 'table',
                        $attribs,
                        Html::rawElement( 'tbody', array(), "\n$html\n" ) ) . "\n";
            } elseif ( $displayFormat === 'div' || $displayFormat === 'vform' ) {
                $html = Html::rawElement( 'div', $attribs, "\n$html\n" );
            }
        }

        if ( $this->mSubSectionBeforeFields ) {
            return $subsectionHtml . "\n" . $html;
        } else {
            return $html . "\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;

        return $this;
    }

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

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

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

        return $this;
    }

    public function getAction() {
        // If an action is alredy provided, return it
        if ( $this->mAction !== false ) {
            return $this->mAction;
        }

        $articlePath = $this->getConfig()->get( 'ArticlePath' );
        // Check whether we are in GET mode and the ArticlePath contains a "?"
        // meaning that getLocalURL() would return something like "index.php?title=...".
        // As browser remove the query string before submitting GET forms,
        // it means that the title would be lost. In such case use wfScript() instead
        // and put title in an hidden field (see getHiddenFields()).
        if ( strpos( $articlePath, '?' ) !== false && $this->getMethod() === 'get' ) {
            return wfScript();
        }

        return $this->getTitle()->getLocalURL();
    }
}