includes/api/ApiRollback.php

   1 <?php
   2
   3 /*
   4  * Created on Jun 20, 2007
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  */
  24
  25 if ( !defined( 'MEDIAWIKI' ) ) {
  26         // Eclipse helper - will be ignored in production
  27         require_once( "ApiBase.php" );
  28 }
  29
  30 /**
  31  * @ingroup API
  32  */
  33 class ApiRollback extends ApiBase {
  34
  35         public function __construct( $main, $action ) {
  36                 parent::__construct( $main, $action );
  37         }
  38
  39         public function execute() {
  40                 $params = $this->extractRequestParams();
  41
  42                 $titleObj = null;
  43                 if ( !isset( $params['title'] ) ) {
  44                         $this->dieUsageMsg( array( 'missingparam', 'title' ) );
  45                 }
  46                 if ( !isset( $params['user'] ) ) {
  47                         $this->dieUsageMsg( array( 'missingparam', 'user' ) );
  48                 }
  49
  50                 $titleObj = Title::newFromText( $params['title'] );
  51                 if ( !$titleObj ) {
  52                         $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
  53                 }
  54                 if ( !$titleObj->exists() ) {
  55                         $this->dieUsageMsg( array( 'notanarticle' ) );
  56                 }
  57
  58                 // We need to be able to revert IPs, but getCanonicalName rejects them
  59                 $username = User::isIP( $params['user'] )
  60                         ? $params['user']
  61                         : User::getCanonicalName( $params['user'] );
  62                 if ( !$username ) {
  63                         $this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
  64                 }
  65
  66                 $articleObj = new Article( $titleObj );
  67                 $summary = ( isset( $params['summary'] ) ? $params['summary'] : '' );
  68                 $details = null;
  69                 $retval = $articleObj->doRollback( $username, $summary, $params['token'], $params['markbot'], $details );
  70
  71                 if ( $retval ) {
  72                         // We don't care about multiple errors, just report one of them
  73                         $this->dieUsageMsg( reset( $retval ) );
  74                 }
  75
  76                 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
  77
  78                 if ( $watch !== null) {
  79                         if ( $watch ) {
  80                                 $articleObj->doWatch();
  81                         } else {
  82                                 $articleObj->doUnwatch();
  83                         }
  84                 }
  85
  86                 $info = array(
  87                         'title' => $titleObj->getPrefixedText(),
  88                         'pageid' => intval( $details['current']->getPage() ),
  89                         'summary' => $details['summary'],
  90                         'revid' => intval( $details['newid'] ),
  91                         'old_revid' => intval( $details['current']->getID() ),
  92                         'last_revid' => intval( $details['target']->getID() )
  93                 );
  94
  95                 $this->getResult()->addValue( null, $this->getModuleName(), $info );
  96         }
  97
  98         public function mustBePosted() {
  99                 return true;
 100         }
 101
 102         public function isWriteMode() {
 103                 return true;
 104         }
 105
 106         public function getAllowedParams() {
 107                 return array(
 108                         'title' => null,
 109                         'user' => null,
 110                         'token' => null,
 111                         'summary' => null,
 112                         'markbot' => false,
 113                         'watchlist' => array(
 114                                 ApiBase::PARAM_DFLT => 'preferences',
 115                                 ApiBase::PARAM_TYPE => array(
 116                                         'watch',
 117                                         'unwatch',
 118                                         'preferences',
 119                                         'nochange'
 120                                 ),
 121                         ),
 122                 );
 123         }
 124
 125         public function getParamDescription() {
 126                 return array(
 127                         'title' => 'Title of the page you want to rollback.',
 128                         'user' => 'Name of the user whose edits are to be rolled back. If set incorrectly, you\'ll get a badtoken error.',
 129                         'token' => 'A rollback token previously retrieved through prop=revisions',
 130                         'summary' => 'Custom edit summary. If not set, default summary will be used.',
 131                         'markbot' => 'Mark the reverted edits and the revert as bot edits',
 132                         'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
 133                 );
 134         }
 135
 136         public function getDescription() {
 137                 return array(
 138                         'Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,',
 139                         'they will all be rolled back.'
 140                 );
 141         }
 142
 143         public function getPossibleErrors() {
 144                 return array_merge( parent::getPossibleErrors(), array(
 145                         array( 'missingparam', 'title' ),
 146                         array( 'missingparam', 'user' ),
 147                         array( 'invalidtitle', 'title' ),
 148                         array( 'notanarticle' ),
 149                         array( 'invaliduser', 'user' ),
 150                 ) );
 151         }
 152
 153         public function getTokenSalt() {
 154                 return '';
 155         }
 156
 157         protected function getExamples() {
 158                 return array(
 159                         'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
 160                         'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1'
 161                 );
 162         }
 163
 164         public function getVersion() {
 165                 return __CLASS__ . ': $Id$';
 166         }
 167 }