Localisation updates for core and extension messages from translatewiki.net (2010...
[lhc/web/wiklou.git] / includes / api / ApiRollback.php
index 0f938bc..27ce389 100644 (file)
@@ -24,7 +24,7 @@
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( "ApiBase.php" );
+       require_once( "ApiBase.php" );
 }
 
 /**
@@ -33,41 +33,27 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiRollback extends ApiBase {
 
        public function __construct( $main, $action ) {
-               parent :: __construct( $main, $action );
+               parent::__construct( $main, $action );
        }
 
+       private $mTitleObj = null, $mUser = null;
+
        public function execute() {
                $params = $this->extractRequestParams();
 
-               $titleObj = null;
-               if ( !isset( $params['title'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'title' ) );
-               if ( !isset( $params['user'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'user' ) );
-               if ( !isset( $params['token'] ) )
-                       $this->dieUsageMsg( array( 'missingparam', 'token' ) );
-
-               $titleObj = Title::newFromText( $params['title'] );
-               if ( !$titleObj )
-                       $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
-               if ( !$titleObj->exists() )
-                       $this->dieUsageMsg( array( 'notanarticle' ) );
-
-               # We need to be able to revert IPs, but getCanonicalName rejects them
-               $username = User::isIP( $params['user'] )
-                       ? $params['user']
-                       : User::getCanonicalName( $params['user'] );
-               if ( !$username )
-                       $this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
-
+               // User and title already validated in call to getTokenSalt from Main
+               $titleObj = $this->getTitle();
                $articleObj = new Article( $titleObj );
-               $summary = ( isset( $params['summary'] ) ? $params['summary'] : "" );
+               $summary = ( isset( $params['summary'] ) ? $params['summary'] : '' );
                $details = null;
-               $retval = $articleObj->doRollback( $username, $summary, $params['token'], $params['markbot'], $details );
+               $retval = $articleObj->doRollback( $this->getUser(), $summary, $params['token'], $params['markbot'], $details );
 
-               if ( $retval )
+               if ( $retval ) {
                        // We don't care about multiple errors, just report one of them
                        $this->dieUsageMsg( reset( $retval ) );
+               }
+
+               $this->setWatch( $params['watchlist'], $titleObj );
 
                $info = array(
                        'title' => $titleObj->getPrefixedText(),
@@ -81,41 +67,111 @@ class ApiRollback extends ApiBase {
                $this->getResult()->addValue( null, $this->getModuleName(), $info );
        }
 
-       public function mustBePosted() { return true; }
+       public function mustBePosted() {
+               return true;
+       }
 
        public function isWriteMode() {
                return true;
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'title' => null,
                        'user' => null,
                        'token' => null,
                        'summary' => null,
-                       'markbot' => false
+                       'markbot' => false,
+                       'watchlist' => array(
+                               ApiBase::PARAM_DFLT => 'preferences',
+                               ApiBase::PARAM_TYPE => array(
+                                       'watch',
+                                       'unwatch',
+                                       'preferences',
+                                       'nochange'
+                               ),
+                       ),
                );
        }
 
        public function getParamDescription() {
-               return array (
+               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.',
-                       'markbot' => 'Mark the reverted edits and the revert as bot edits'
+                       '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',
                );
        }
 
        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.'
-                       );
+                       '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.'
+               );
+       }
+
+       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 getTokenSalt() {
+               return array( $this->getTitle()->getPrefixedText(), $this->getUser() );
+       }
+
+       private function getUser() {
+               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']
+                       : User::getCanonicalName( $params['user'] );
+               if ( !$this->mUser ) {
+                       $this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
+               }
+
+               return $this->mUser;
+       }
+
+       private function getTitle() {
+               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'] );
+
+               if ( !$this->mTitleObj ) {
+                       $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
+               }
+               if ( !$this->mTitleObj->exists() ) {
+                       $this->dieUsageMsg( array( 'notanarticle' ) );
+               }
+               
+               return $this->mTitleObj;
        }
 
        protected function getExamples() {
-               return array (
+               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'
                );