() are valid in URLs, not sure why we're using them as a finishing point in ApiFormatBase

[lhc/web/wiklou.git] / includes / api / ApiRollback.php

diff --git a/includes/api/ApiRollback.php b/includes/api/ApiRollback.php
index 2301e3a..436c392 100644 (file)
--- a/includes/api/ApiRollback.php
+++ b/includes/api/ApiRollback.php
@@ -1,10 +1,10 @@
 <?php
-
-/*
+/**
+ *
+ *
  * Created on Jun 20, 2007
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,15 +18,12 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( "ApiBase.php" );
-}
-
 /**
  * @ingroup API
  */
@@ -36,17 +33,25 @@ class ApiRollback extends ApiBase {
                parent::__construct( $main, $action );
        }
 
-       private $mTitleObj = null, $mUser = null;
+       /**
+        * @var Title
+        */
+       private $mTitleObj = null;
+
+       /**
+        * @var User
+        */
+       private $mUser = null;
 
        public function execute() {
                $params = $this->extractRequestParams();
 
                // User and title already validated in call to getTokenSalt from Main
-               $titleObj = $this->getTitle();
-               $articleObj = new Article( $titleObj );
+               $titleObj = $this->getRbTitle();
+               $pageObj = WikiPage::factory( $titleObj );
                $summary = ( isset( $params['summary'] ) ? $params['summary'] : '' );
-               $details = null;
-               $retval = $articleObj->doRollback( $this->getUser(), $summary, $params['token'], $params['markbot'], $details );
+               $details = array();
+               $retval = $pageObj->doRollback( $this->getRbUser(), $summary, $params['token'], $params['markbot'], $details, $this->getUser() );
 
                if ( $retval ) {
                        // We don't care about multiple errors, just report one of them
@@ -77,8 +82,14 @@ class ApiRollback extends ApiBase {
 
        public function getAllowedParams() {
                return array(
-                       'title' => null,
-                       'user' => null,
+                       'title' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
+                       'user' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'token' => null,
                        'summary' => null,
                        'markbot' => false,
@@ -98,8 +109,8 @@ class ApiRollback extends ApiBase {
                return array(
                        'title' => 'Title of the page you want to rollback.',
                        'user' => 'Name of the user whose edits are to be rolled back. If set incorrectly, you\'ll get a badtoken error.',
-                       'token' => 'A rollback token previously retrieved through prop=revisions',
-                       'summary' => 'Custom edit summary. If not set, default summary will be used.',
+                       'token' => "A rollback token previously retrieved through {$this->getModulePrefix()}prop=revisions",
+                       'summary' => 'Custom edit summary. If not set, default summary will be used',
                        'markbot' => 'Mark the reverted edits and the revert as bot edits',
                        'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
                );
@@ -108,35 +119,33 @@ class ApiRollback extends ApiBase {
        public function getDescription() {
                return array(
                        'Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,',
-                       'they will all be rolled back.'
+                       'they will all be rolled back'
                );
        }
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'title' ),
-                       array( 'missingparam', 'user' ),
                        array( 'invalidtitle', 'title' ),
                        array( 'notanarticle' ),
                        array( 'invaliduser', 'user' ),
                ) );
        }
 
+       public function needsToken() {
+               return true;
+       }
+
        public function getTokenSalt() {
-               return array( $this->getTitle()->getPrefixedText(), $this->getUser() );
+               return array( $this->getRbTitle()->getPrefixedText(), $this->getRbUser() );
        }
 
-       private function getUser() {
+       private function getRbUser() {
                if ( $this->mUser !== null ) {
                        return $this->mUser;
                }
 
                $params = $this->extractRequestParams();
 
-               if ( !isset( $params['user'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'user' ) );
-               }
-               
                // We need to be able to revert IPs, but getCanonicalName rejects them
                $this->mUser = User::isIP( $params['user'] )
                        ? $params['user']
@@ -148,15 +157,15 @@ class ApiRollback extends ApiBase {
                return $this->mUser;
        }
 
-       private function getTitle() {
+       /**
+        * @return Title
+        */
+       private function getRbTitle() {
                if ( $this->mTitleObj !== null ) {
                        return $this->mTitleObj;
                }
 
                $params = $this->extractRequestParams();
-               if ( !isset( $params['title'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'title' ) );
-               }
 
                $this->mTitleObj = Title::newFromText( $params['title'] );
 
@@ -164,19 +173,23 @@ class ApiRollback extends ApiBase {
                        $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
                }
                if ( !$this->mTitleObj->exists() ) {
-                       $this->dieUsageMsg( array( 'notanarticle' ) );
+                       $this->dieUsageMsg( 'notanarticle' );
                }
-               
+
                return $this->mTitleObj;
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
                        'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1'
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Rollback';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }