includes/actions/RollbackAction.php

   1 <?php
   2 /**
   3  * Edit rollback user interface
   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
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  18  *
  19  * @file
  20  * @ingroup Actions
  21  */
  22
  23 /**
  24  * User interface for the rollback action
  25  *
  26  * @ingroup Actions
  27  */
  28 class RollbackAction extends FormAction {
  29
  30         public function getName() {
  31                 return 'rollback';
  32         }
  33
  34         public function getRestriction() {
  35                 return 'rollback';
  36         }
  37
  38         protected function usesOOUI() {
  39                 return true;
  40         }
  41
  42         protected function getDescription() {
  43                 return '';
  44         }
  45
  46         public function doesWrites() {
  47                 return true;
  48         }
  49
  50         public function onSuccess() {
  51                 return false;
  52         }
  53
  54         public function onSubmit( $data ) {
  55                 return false;
  56         }
  57
  58         protected function alterForm( HTMLForm $form ) {
  59                 $form->setWrapperLegendMsg( 'confirm-rollback-top' );
  60                 $form->setSubmitTextMsg( 'confirm-rollback-button' );
  61                 $form->setTokenSalt( 'rollback' );
  62
  63                 $from = $this->getRequest()->getVal( 'from' );
  64                 if ( $from === null ) {
  65                         throw new BadRequestError( 'rollbackfailed', 'rollback-missingparam' );
  66                 }
  67                 foreach ( [ 'from', 'bot', 'hidediff', 'summary', 'token' ] as $param ) {
  68                         $val = $this->getRequest()->getVal( $param );
  69                         if ( $val !== null ) {
  70                                 $form->addHiddenField( $param, $val );
  71                         }
  72                 }
  73         }
  74
  75         /**
  76          * @throws ErrorPageError
  77          * @throws ReadOnlyError
  78          * @throws ThrottledError
  79          */
  80         public function show() {
  81                 if ( $this->getUser()->getOption( 'showrollbackconfirmation' ) == false ||
  82                          $this->getRequest()->wasPosted() ) {
  83                         $this->handleRollbackRequest();
  84                 } else {
  85                         $this->showRollbackConfirmationForm();
  86                 }
  87         }
  88
  89         public function handleRollbackRequest() {
  90                 $this->enableTransactionalTimelimit();
  91
  92                 $request = $this->getRequest();
  93                 $user = $this->getUser();
  94                 $from = $request->getVal( 'from' );
  95                 $rev = $this->page->getRevision();
  96                 if ( $from === null ) {
  97                         throw new ErrorPageError( 'rollbackfailed', 'rollback-missingparam' );
  98                 }
  99                 if ( !$rev ) {
 100                         throw new ErrorPageError( 'rollbackfailed', 'rollback-missingrevision' );
 101                 }
 102                 if ( $from !== $rev->getUserText() ) {
 103                         throw new ErrorPageError( 'rollbackfailed', 'alreadyrolled', [
 104                                 $this->getTitle()->getPrefixedText(),
 105                                 $from,
 106                                 $rev->getUserText()
 107                         ] );
 108                 }
 109
 110                 $data = null;
 111                 $errors = $this->page->doRollback(
 112                         $from,
 113                         $request->getText( 'summary' ),
 114                         $request->getVal( 'token' ),
 115                         $request->getBool( 'bot' ),
 116                         $data,
 117                         $this->getUser()
 118                 );
 119
 120                 if ( in_array( [ 'actionthrottledtext' ], $errors ) ) {
 121                         throw new ThrottledError;
 122                 }
 123
 124                 if ( $this->hasRollbackRelatedErrors( $errors ) ) {
 125                         $this->getOutput()->setPageTitle( $this->msg( 'rollbackfailed' ) );
 126                         $errArray = $errors[0];
 127                         $errMsg = array_shift( $errArray );
 128                         $this->getOutput()->addWikiMsgArray( $errMsg, $errArray );
 129
 130                         if ( isset( $data['current'] ) ) {
 131                                 /** @var Revision $current */
 132                                 $current = $data['current'];
 133
 134                                 if ( $current->getComment() != '' ) {
 135                                         $this->getOutput()->addWikiMsg(
 136                                                 'editcomment',
 137                                                 Message::rawParam(
 138                                                         Linker::formatComment( $current->getComment() )
 139                                                 )
 140                                         );
 141                                 }
 142                         }
 143
 144                         return;
 145                 }
 146
 147                 # NOTE: Permission errors already handled by Action::checkExecute.
 148                 if ( $errors == [ [ 'readonlytext' ] ] ) {
 149                         throw new ReadOnlyError;
 150                 }
 151
 152                 # XXX: Would be nice if ErrorPageError could take multiple errors, and/or a status object.
 153                 #      Right now, we only show the first error
 154                 foreach ( $errors as $error ) {
 155                         throw new ErrorPageError( 'rollbackfailed', $error[0], array_slice( $error, 1 ) );
 156                 }
 157
 158                 /** @var Revision $current */
 159                 $current = $data['current'];
 160                 $target = $data['target'];
 161                 $newId = $data['newid'];
 162                 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
 163                 $this->getOutput()->setRobotPolicy( 'noindex,nofollow' );
 164
 165                 $old = Linker::revUserTools( $current );
 166                 $new = Linker::revUserTools( $target );
 167                 $this->getOutput()->addHTML(
 168                         $this->msg( 'rollback-success' )
 169                                 ->rawParams( $old, $new )
 170                                 ->params( $current->getUserText( Revision::FOR_THIS_USER, $user ) )
 171                                 ->params( $target->getUserText( Revision::FOR_THIS_USER, $user ) )
 172                                 ->parseAsBlock()
 173                 );
 174
 175                 if ( $user->getBoolOption( 'watchrollback' ) ) {
 176                         $user->addWatch( $this->page->getTitle(), User::IGNORE_USER_RIGHTS );
 177                 }
 178
 179                 $this->getOutput()->returnToMain( false, $this->getTitle() );
 180
 181                 if ( !$request->getBool( 'hidediff', false ) &&
 182                         !$this->getUser()->getBoolOption( 'norollbackdiff' )
 183                 ) {
 184                         $contentHandler = $current->getContentHandler();
 185                         $de = $contentHandler->createDifferenceEngine(
 186                                 $this->getContext(),
 187                                 $current->getId(),
 188                                 $newId,
 189                                 false,
 190                                 true
 191                         );
 192                         $de->showDiff( '', '' );
 193                 }
 194         }
 195
 196         /**
 197          * Enables transactional time limit for POST and GET requests to RollbackAction
 198          * @throws ConfigException
 199          */
 200         private function enableTransactionalTimelimit() {
 201                 // If Rollbacks are made POST-only, use $this->useTransactionalTimeLimit()
 202                 wfTransactionalTimeLimit();
 203                 if ( !$this->getRequest()->wasPosted() ) {
 204                         /**
 205                          * We apply the higher POST limits on GET requests
 206                          * to prevent logstash.wikimedia.org from being spammed
 207                          */
 208                         $fname = __METHOD__;
 209                         $trxLimits = $this->context->getConfig()->get( 'TrxProfilerLimits' );
 210                         $trxProfiler = Profiler::instance()->getTransactionProfiler();
 211                         $trxProfiler->redefineExpectations( $trxLimits['POST'], $fname );
 212                         DeferredUpdates::addCallableUpdate( function () use ( $trxProfiler, $trxLimits, $fname
 213                         ) {
 214                                 $trxProfiler->redefineExpectations( $trxLimits['PostSend-POST'], $fname );
 215                         } );
 216                 }
 217         }
 218
 219         private function showRollbackConfirmationForm() {
 220                 $form = $this->getForm();
 221                 if ( $form->show() ) {
 222                         $this->onSuccess();
 223                 }
 224         }
 225
 226         protected function getFormFields() {
 227                 return [
 228                         'intro' => [
 229                                 'type' => 'info',
 230                                 'vertical-label' => true,
 231                                 'raw' => true,
 232                                 'default' => $this->msg( 'confirm-rollback-bottom' )->parse()
 233                         ]
 234                 ];
 235         }
 236
 237         private function hasRollbackRelatedErrors( array $errors ) {
 238                 return isset( $errors[0][0] ) &&
 239                         ( $errors[0][0] == 'alreadyrolled' ||
 240                                 $errors[0][0] == 'cantrollback'
 241                         );
 242         }
 243 }