X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FHTMLForm.php;h=7326bf5c1e045c988a43f691df22ddebc8b39a00;hb=55cb51e4c05b477cda4e3baa1b8351c54239cc9e;hp=da84fc30e23574e2efc6d3a7c8bbbbc05061934c;hpb=b295b9e1e1d48fb0c63bef43ee515721813f2d47;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/HTMLForm.php b/includes/HTMLForm.php index da84fc30e2..7326bf5c1e 100644 --- a/includes/HTMLForm.php +++ b/includes/HTMLForm.php @@ -33,10 +33,10 @@ * 'help-message' -- message key for a message to use as a help text. * can be an array of msg key and then parameters to * the message. - * Overwrites 'help-messages'. - * 'help-messages' -- array of message key. As above, each item can - * be an array of msg key and then parameters. - * Overwrites 'help-message'. + * Overwrites 'help-messages'. + * 'help-messages' -- array of message key. As above, each item can + * be an array of msg key and then parameters. + * Overwrites 'help-message'. * 'required' -- passed through to the object, indicating that it * is a required field. * 'size' -- the length of text fields @@ -53,9 +53,9 @@ * * TODO: Document 'section' / 'subsection' stuff */ -class HTMLForm { +class HTMLForm extends ContextSource { - # A mapping of 'type' inputs onto standard HTMLFormField subclasses + // A mapping of 'type' inputs onto standard HTMLFormField subclasses static $typeMappings = array( 'text' => 'HTMLTextField', 'textarea' => 'HTMLTextAreaField', @@ -73,15 +73,18 @@ class HTMLForm { '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. + // 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; + + /** @var HTMLFormField[] */ protected $mFlatFields; + protected $mFieldTree; protected $mShowReset = false; public $mFieldData; @@ -102,26 +105,41 @@ class HTMLForm { protected $mSubmitText; protected $mSubmitTooltip; - protected $mContext; // setTitle() * @param $messagePrefix String a prefix to go in front of default messages */ - public function __construct( $descriptor, /*RequestContext*/ $context = null, $messagePrefix = '' ) { - if( $context instanceof RequestContext ){ - $this->mContext = $context; + 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 { @@ -175,7 +193,7 @@ class HTMLForm { * done already. * @deprecated since 1.18 load modules with ResourceLoader instead */ - static function addJS() { } + static function addJS() { wfDeprecated( __METHOD__, '1.18' ); } /** * Initialise a new Object for the field @@ -222,12 +240,27 @@ class HTMLForm { * @return Status|boolean */ function tryAuthorizedSubmit() { - $editToken = $this->getRequest()->getVal( 'wpEditToken' ); - $result = false; - if ( $this->getMethod() != 'post' || $this->getUser()->matchEditToken( $editToken ) ) { + + $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; } @@ -277,7 +310,7 @@ class HTMLForm { $data = $this->filterDataForSubmit( $this->mFieldData ); - $res = call_user_func( $callback, $data ); + $res = call_user_func( $callback, $data, $this ); return $res; } @@ -307,7 +340,16 @@ class HTMLForm { * Set the introductory message, overwriting any existing message. * @param $msg String complete text of message to display */ - function setIntro( $msg ) { $this->mPre = $msg; } + function setIntro( $msg ) { + $this->setPreText( $msg ); + } + + /** + * Set the introductory message, overwriting any existing message. + * @since 1.19 + * @param $msg String complete text of message to display + */ + function setPreText( $msg ) { $this->mPre = $msg; } /** * Add introductory text. @@ -318,7 +360,7 @@ class HTMLForm { /** * Add header text, inside the form. * @param $msg String complete text of message to display - * @param $section The section to add the header to + * @param $section string The section to add the header to */ function addHeaderText( $msg, $section = null ) { if ( is_null( $section ) ) { @@ -331,6 +373,20 @@ class HTMLForm { } } + /** + * Set header text, inside the form. + * @since 1.19 + * @param $msg String complete text of message to display + * @param $section The section to add the header to + */ + function setHeaderText( $msg, $section = null ) { + if ( is_null( $section ) ) { + $this->mHeader = $msg; + } else { + $this->mSectionHeaders[$section] = $msg; + } + } + /** * Add footer text, inside the form. * @param $msg String complete text of message to display @@ -347,12 +403,32 @@ class HTMLForm { } } + /** + * Set footer text, inside the form. + * @since 1.19 + * @param $msg String complete text of message to display + * @param $section string The section to add the footer text to + */ + function setFooterText( $msg, $section = null ) { + if ( is_null( $section ) ) { + $this->mFooter = $msg; + } else { + $this->mSectionFooters[$section] = $msg; + } + } + /** * Add text to the end of the display. * @param $msg String complete text of message to display */ function addPostText( $msg ) { $this->mPost .= $msg; } + /** + * Set text at the end of the display. + * @param $msg String complete text of message to display + */ + function setPostText( $msg ) { $this->mPost = $msg; } + /** * Add a hidden field to the output * @param $name String field name. This will be used exactly as entered @@ -369,11 +445,20 @@ class HTMLForm { } /** - * Display the form (sending to wgOut), with an appropriate error + * Display the form (sending to $wgOut), with an appropriate error * message or stack of messages, and any validation errors, etc. * @param $submitResult Mixed output from HTMLForm::trySubmit() */ function displayForm( $submitResult ) { + $this->getOutput()->addHTML( $this->getHTML( $submitResult ) ); + } + + /** + * Returns the raw HTML generated by the form + * @param $submitResult Mixed output from HTMLForm::trySubmit() + * @return string + */ + function getHTML( $submitResult ) { # For good measure (it is the default) $this->getOutput()->preventClickjacking(); $this->getOutput()->addModules( 'mediawiki.htmlform' ); @@ -389,11 +474,7 @@ class HTMLForm { $html = $this->wrapForm( $html ); - $this->getOutput()->addHTML( '' - . $this->mPre - . $html - . $this->mPost - ); + return '' . $this->mPre . $html . $this->mPost; } /** @@ -413,7 +494,7 @@ class HTMLForm { : 'application/x-www-form-urlencoded'; # Attributes $attribs = array( - 'action' => $this->getTitle()->getFullURL(), + 'action' => $this->mAction === false ? $this->getTitle()->getFullURL() : $this->mAction, 'method' => $this->mMethod, 'class' => 'visualClear', 'enctype' => $encType, @@ -434,7 +515,7 @@ class HTMLForm { $html = ''; if( $this->getMethod() == 'post' ){ - $html .= Html::hidden( 'wpEditToken', $this->getUser()->editToken(), array( 'id' => 'wpEditToken' ) ) . "\n"; + $html .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken(), array( 'id' => 'wpEditToken' ) ) . "\n"; $html .= Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) . "\n"; } @@ -507,6 +588,7 @@ class HTMLForm { /** * Get the whole body of the form. + * @return String */ function getBody() { return $this->displaySection( $this->mFieldTree ); @@ -571,6 +653,15 @@ class HTMLForm { $this->mSubmitText = $t; } + /** + * Set the text for the submit button to a message + * @since 1.19 + * @param $msg String message key + */ + public function setSubmitTextMsg( $msg ) { + return $this->setSubmitText( $this->msg( $msg )->escaped() ); + } + /** * Get the text for the submit button, either customised or a default. * @return unknown_type @@ -609,6 +700,16 @@ class HTMLForm { */ public function setWrapperLegend( $legend ) { $this->mWrapperLegend = $legend; } + /** + * Prompt the whole form to be wrapped in a
, with + * this message as its element. + * @since 1.19 + * @param $msg String message key + */ + public function setWrapperLegendMsg( $msg ) { + return $this->setWrapperLegend( $this->msg( $msg )->escaped() ); + } + /** * Set the prefix for various default messages * TODO: currently only used for the
legend on forms @@ -637,36 +738,6 @@ class HTMLForm { : $this->mTitle; } - /** - * @return RequestContext - */ - public function getContext(){ - return $this->mContext instanceof RequestContext - ? $this->mContext - : RequestContext::getMain(); - } - - /** - * @return OutputPage - */ - public function getOutput(){ - return $this->getContext()->getOutput(); - } - - /** - * @return WebRequest - */ - public function getRequest(){ - return $this->getContext()->getRequest(); - } - - /** - * @return User - */ - public function getUser(){ - return $this->getContext()->getUser(); - } - /** * Set the method used to submit the form * @param $method String @@ -681,9 +752,10 @@ class HTMLForm { /** * TODO: Document - * @param $fields array of fields (either arrays or objects) + * @param $fields array[]|HTMLFormField[] array of fields (either arrays or objects) * @param $sectionName string ID attribute of the tag for this section, ignored if empty * @param $fieldsetIDPrefix string ID prefix for the
tag of each subsection, ignored if empty + * @return String */ function displaySection( $fields, $sectionName = '', $fieldsetIDPrefix = '' ) { $tableHtml = ''; @@ -734,7 +806,11 @@ class HTMLForm { $tableHtml = Html::rawElement( 'table', $attribs, Html::rawElement( 'tbody', array(), "\n$tableHtml\n" ) ) . "\n"; - return $subsectionHtml . "\n" . $tableHtml; + if ( $this->mSubSectionBeforeFields ) { + return $subsectionHtml . "\n" . $tableHtml; + } else { + return $tableHtml . "\n" . $subsectionHtml; + } } /** @@ -791,6 +867,19 @@ class HTMLForm { public function getLegend( $key ) { return wfMsg( "{$this->mMessagePrefix}-$key" ); } + + /** + * Set the value for the action attribute of the form. + * When set to false (which is the default state), the set title is used. + * + * @since 1.19 + * + * @param string|false $action + */ + public function setAction( $action ) { + $this->mAction = $action; + } + } /** @@ -832,20 +921,20 @@ abstract class HTMLFormField { * @return Mixed Bool true on success, or String error to display. */ function validate( $value, $alldata ) { - if ( isset( $this->mValidationCallback ) ) { - return call_user_func( $this->mValidationCallback, $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 ); + $value = call_user_func( $this->mFilterCallback, $value, $alldata, $this->mParent ); } return $value; @@ -936,6 +1025,10 @@ abstract class HTMLFormField { if ( isset( $params['filter-callback'] ) ) { $this->mFilterCallback = $params['filter-callback']; } + + if ( isset( $params['flatlist'] ) ){ + $this->mClass .= ' mw-htmlform-flatlist'; + } } /** @@ -1057,7 +1150,7 @@ abstract class HTMLFormField { /** * flatten an array of options to a single array, for instance, * a set of inside . - * @param $options Associative Array with values either Strings + * @param $options array Associative Array with values either Strings * or Arrays * @return Array flattened input */ @@ -1120,6 +1213,10 @@ class HTMLTextField extends HTMLFormField { 'value' => $value, ) + $this->getTooltipAndAccessKey(); + if ( $this->mClass !== '' ) { + $attribs['class'] = $this->mClass; + } + if ( isset( $this->mParams['maxlength'] ) ) { $attribs['maxlength'] = $this->mParams['maxlength']; } @@ -1190,7 +1287,10 @@ class HTMLTextAreaField extends HTMLFormField { 'rows' => $this->getRows(), ) + $this->getTooltipAndAccessKey(); - + if ( $this->mClass !== '' ) { + $attribs['class'] = $this->mClass; + } + if ( !empty( $this->mParams['disabled'] ) ) { $attribs['disabled'] = 'disabled'; } @@ -1297,6 +1397,10 @@ class HTMLCheckField extends HTMLFormField { if ( !empty( $this->mParams['disabled'] ) ) { $attr['disabled'] = 'disabled'; } + + if ( $this->mClass !== '' ) { + $attr['class'] = $this->mClass; + } return Xml::check( $this->mName, $value, $attr ) . ' ' . Html::rawElement( 'label', array( 'for' => $this->mID ), $this->mLabel ); @@ -1305,6 +1409,7 @@ class HTMLCheckField extends HTMLFormField { /** * For a checkbox, the label goes on the right hand side, and is * added in getInputHTML(), rather than HTMLFormField::getRow() + * @return String */ function getLabel() { return ' '; @@ -1321,7 +1426,10 @@ class HTMLCheckField extends HTMLFormField { } // GetCheck won't work like we want for checks. - if ( $request->getCheck( 'wpEditToken' ) || $this->mParent->getMethod() != 'post' ) { + // 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 @@ -1370,6 +1478,10 @@ class HTMLSelectField extends HTMLFormField { if ( !empty( $this->mParams['disabled'] ) ) { $select->setAttribute( 'disabled', 'disabled' ); } + + if ( $this->mClass !== '' ) { + $select->setAttribute( 'class', $this->mClass ); + } $select->addOptions( $this->mParams['options'] ); @@ -1431,6 +1543,10 @@ class HTMLSelectOrOtherField extends HTMLTextField { if ( isset( $this->mParams['maxlength'] ) ) { $tbAttribs['maxlength'] = $this->mParams['maxlength']; } + + if ( $this->mClass !== '' ) { + $tbAttribs['class'] = $this->mClass; + } $textbox = Html::input( $this->mName . '-other', @@ -1466,13 +1582,6 @@ class HTMLSelectOrOtherField extends HTMLTextField { */ class HTMLMultiSelectField extends HTMLFormField { - public function __construct( $params ){ - parent::__construct( $params ); - if( isset( $params['flatlist'] ) ){ - $this->mClass .= ' mw-htmlform-multiselect-flatlist'; - } - } - function validate( $value, $alldata ) { $p = parent::validate( $value, $alldata ); @@ -1524,7 +1633,7 @@ class HTMLMultiSelectField extends HTMLFormField { $attribs + $thisAttribs ); $checkbox .= ' ' . Html::rawElement( 'label', array( 'for' => "{$this->mID}-$info" ), $label ); - $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-multiselect-item' ), $checkbox ); + $html .= ' ' . Html::rawElement( 'div', array( 'class' => 'mw-htmlform-flatlist-item' ), $checkbox ); } } @@ -1572,8 +1681,7 @@ class HTMLMultiSelectField extends HTMLFormField { /** * Double field with a dropdown list constructed from a system message in the format * * Optgroup header - * **