includes/specialpage/FormSpecialPage.php

   1 <?php
   2 /**
   3  * Special page which uses an HTMLForm to handle processing.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Special page which uses an HTMLForm to handle processing.  This is mostly a
  26  * clone of FormAction.  More special pages should be built this way; maybe this could be
  27  * a new structure for SpecialPages.
  28  *
  29  * @ingroup SpecialPage
  30  */
  31 abstract class FormSpecialPage extends SpecialPage {
  32         /**
  33          * The sub-page of the special page.
  34          * @var string
  35          */
  36         protected $par = null;
  37
  38         /**
  39          * Get an HTMLForm descriptor array
  40          * @return array
  41          */
  42         abstract protected function getFormFields();
  43
  44         /**
  45          * Add pre-text to the form
  46          * @return string HTML which will be sent to $form->addPreText()
  47          */
  48         protected function preText() {
  49                 return '';
  50         }
  51
  52         /**
  53          * Add post-text to the form
  54          * @return string HTML which will be sent to $form->addPostText()
  55          */
  56         protected function postText() {
  57                 return '';
  58         }
  59
  60         /**
  61          * Play with the HTMLForm if you need to more substantially
  62          * @param HTMLForm $form
  63          */
  64         protected function alterForm( HTMLForm $form ) {
  65         }
  66
  67         /**
  68          * Get message prefix for HTMLForm
  69          *
  70          * @since 1.21
  71          * @return string
  72          */
  73         protected function getMessagePrefix() {
  74                 return strtolower( $this->getName() );
  75         }
  76
  77         /**
  78          * Get display format for the form. See HTMLForm documentation for available values.
  79          *
  80          * @since 1.25
  81          * @return string
  82          */
  83         protected function getDisplayFormat() {
  84                 return 'table';
  85         }
  86
  87         /**
  88          * Get the HTMLForm to control behavior
  89          * @return HTMLForm|null
  90          */
  91         protected function getForm() {
  92                 $form = HTMLForm::factory(
  93                         $this->getDisplayFormat(),
  94                         $this->getFormFields(),
  95                         $this->getContext(),
  96                         $this->getMessagePrefix()
  97                 );
  98                 $form->setSubmitCallback( array( $this, 'onSubmit' ) );
  99                 $form->setWrapperLegendMsg( $this->getMessagePrefix() . '-legend' );
 100
 101                 $headerMsg = $this->msg( $this->getMessagePrefix() . '-text' );
 102                 if ( !$headerMsg->isDisabled() ) {
 103                         $form->addHeaderText( $headerMsg->parseAsBlock() );
 104                 }
 105
 106                 // Retain query parameters (uselang etc)
 107                 $params = array_diff_key(
 108                         $this->getRequest()->getQueryValues(), array( 'title' => null ) );
 109                 $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
 110
 111                 $form->addPreText( $this->preText() );
 112                 $form->addPostText( $this->postText() );
 113                 $this->alterForm( $form );
 114
 115                 // Give hooks a chance to alter the form, adding extra fields or text etc
 116                 Hooks::run( 'SpecialPageBeforeFormDisplay', array( $this->getName(), &$form ) );
 117
 118                 return $form;
 119         }
 120
 121         /**
 122          * Process the form on POST submission.
 123          * @param array $data
 124          * @param HTMLForm $form
 125          * @return bool|string|array|Status As documented for HTMLForm::trySubmit.
 126          */
 127         abstract public function onSubmit( array $data /* $form = null */ );
 128
 129         /**
 130          * Do something exciting on successful processing of the form, most likely to show a
 131          * confirmation message
 132          * @since 1.22 Default is to do nothing
 133          */
 134         public function onSuccess() {
 135         }
 136
 137         /**
 138          * Basic SpecialPage workflow: get a form, send it to the user; get some data back,
 139          *
 140          * @param string $par Subpage string if one was specified
 141          */
 142         public function execute( $par ) {
 143                 $this->setParameter( $par );
 144                 $this->setHeaders();
 145
 146                 // This will throw exceptions if there's a problem
 147                 $this->checkExecutePermissions( $this->getUser() );
 148
 149                 $form = $this->getForm();
 150                 if ( $form->show() ) {
 151                         $this->onSuccess();
 152                 }
 153         }
 154
 155         /**
 156          * Maybe do something interesting with the subpage parameter
 157          * @param string $par
 158          */
 159         protected function setParameter( $par ) {
 160                 $this->par = $par;
 161         }
 162
 163         /**
 164          * Called from execute() to check if the given user can perform this action.
 165          * Failures here must throw subclasses of ErrorPageError.
 166          * @param User $user
 167          * @throws UserBlockedError
 168          * @return bool True
 169          */
 170         protected function checkExecutePermissions( User $user ) {
 171                 $this->checkPermissions();
 172
 173                 if ( $this->requiresUnblock() && $user->isBlocked() ) {
 174                         $block = $user->getBlock();
 175                         throw new UserBlockedError( $block );
 176                 }
 177
 178                 if ( $this->requiresWrite() ) {
 179                         $this->checkReadOnly();
 180                 }
 181
 182                 return true;
 183         }
 184
 185         /**
 186          * Whether this action requires the wiki not to be locked
 187          * @return bool
 188          */
 189         public function requiresWrite() {
 190                 return true;
 191         }
 192
 193         /**
 194          * Whether this action cannot be executed by a blocked user
 195          * @return bool
 196          */
 197         public function requiresUnblock() {
 198                 return true;
 199         }
 200 }