Call Linker methods statically
[lhc/web/wiklou.git] / includes / api / ApiMove.php
index f122a29..7ee0c42 100644 (file)
-<?php\r
-\r
-/*\r
- * Created on Oct 31, 2007\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
-       // Eclipse helper - will be ignored in production\r
-       require_once ("ApiBase.php");\r
-}\r
-\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiMove extends ApiBase {\r
-\r
-       public function __construct($main, $action) {\r
-                       parent :: __construct($main, $action);\r
-       }\r
-       \r
-       public function execute() {\r
-               global $wgUser;\r
-               $this->getMain()->requestWriteMode();\r
-               $params = $this->extractRequestParams();\r
-               if(is_null($params['reason']))\r
-                               $params['reason'] = '';\r
-               \r
-               $titleObj = NULL;\r
-               if(!isset($params['from']))\r
-                               $this->dieUsage('The from parameter must be set', 'nofrom');\r
-               if(!isset($params['to']))\r
-                               $this->dieUsage('The to parameter must be set', 'noto');\r
-               if(!isset($params['token']))\r
-                               $this->dieUsage('The token parameter must be set', 'notoken');\r
-               if(!$wgUser->matchEditToken($params['token']))\r
-                               $this->dieUsage('Invalid token', 'badtoken');\r
-\r
-               if($wgUser->isBlocked())\r
-                               $this->dieUsage('You have been blocked from editing', 'blocked');\r
-               if(wfReadOnly())\r
-                               $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
-               if($params['noredirect'] && !$wgUser->isAllowed('suppressredirect'))\r
-                               $this->dieUsage("You don't have permission to suppress redirect creation", 'nosuppress');\r
-\r
-               $fromTitle = Title::newFromText($params['from']);\r
-               if(!$fromTitle)\r
-                               $this->dieUsage("Bad title ``{$params['from']}''", 'invalidtitle');\r
-               if(!$fromTitle->exists())\r
-                               $this->dieUsage("``{$params['from']}'' doesn't exist", 'missingtitle');\r
-               $fromTalk = $fromTitle->getTalkPage();\r
-\r
-                       \r
-               $toTitle = Title::newFromText($params['to']);\r
-               if(!$toTitle)\r
-                               $this->dieUsage("Bad title ``{$params['to']}''", 'invalidtitle');\r
-               $toTalk = $toTitle->getTalkPage();\r
-\r
-               $dbw = wfGetDB(DB_MASTER);\r
-               $dbw->begin();                          \r
-               $retval = $fromTitle->moveTo($toTitle, true, $params['reason'], !$params['noredirect']);\r
-               if($retval !== true)\r
-                               switch($retval)\r
-                               {\r
-                                               // case 'badtitletext': Can't happen\r
-                                               // case 'badarticleerror': Can't happen\r
-                                               case 'selfmove':\r
-                                                               $this->dieUsage("Can't move ``{$params['from']}'' to itself", 'selfmove');\r
-                                               case 'immobile_namespace':\r
-                                                               if($fromTitle->isMovable())\r
-                                                                               $this->dieUsage("Pages in the ``{$fromTitle->getNsText()}'' namespace can't be moved", 'immobilenamespace-from');\r
-                                                               $this->dieUsage("Pages in the ``{$toTitle->getNsText()}'' namespace can't be moved", 'immobilenamespace-to');\r
-                                               case 'articleexists':\r
-                                                               $this->dieUsage("``{$toTitle->getPrefixedText()}'' already exists and is not a redirect to ``{$fromTitle->getPrefixedText()}''", 'targetexists');\r
-                                               case 'protectedpage':\r
-                                                               $this->dieUsage("You don't have permission to move ``{$fromTitle->getPrefixedText()}'' to ``{$toTitle->getPrefixedText()}''", 'permissiondenied');\r
-                                               default:\r
-                                                               throw new MWException( "Title::moveTo: Unknown return value ``{$retval}''" );\r
-                               }\r
-               $r = array('from' => $fromTitle->getPrefixedText(), 'to' => $toTitle->getPrefixedText(), 'reason' => $params['reason']);\r
-               if(!$params['noredirect'])\r
-                               $r['redirectcreated'] = '';\r
-               \r
-               if($params['movetalk'] && $fromTalk->exists() && !$fromTitle->isTalkPage())\r
-               {\r
-                               // We need to move the talk page as well\r
-                               $toTalk = $toTitle->getTalkPage();\r
-                               $retval = $fromTalk->moveTo($toTalk, true, $params['reason'], !$params['noredirect']);\r
-                               if($retval === true)\r
-                               {\r
-                                               $r['talkfrom'] = $fromTalk->getPrefixedText();\r
-                                               $r['talkto'] = $toTalk->getPrefixedText();\r
-                               }\r
-                               // We're not gonna dieUsage() on failure, since we already changed something\r
-                               else\r
-                                               switch($retval)\r
-                                               {\r
-                                                               case 'immobile_namespace':\r
-                                                                               if($fromTalk->isMovable())\r
-                                                                               {\r
-                                                                                               $r['talkmove-error-code'] = 'immobilenamespace-from';\r
-                                                                                               $r['talkmove-error-info'] = "Pages in the ``{$fromTalk->getNsText()}'' namespace can't be moved";\r
-                                                                               }\r
-                                                                               else\r
-                                                                               {\r
-                                                                                               $r['talkmove-error-code'] = 'immobilenamespace-to';\r
-                                                                                               $r['talkmove-error-info'] = "Pages in the ``{$toTalk->getNsText()}'' namespace can't be moved";\r
-                                                                               }\r
-                                                                               break;\r
-                                                               case 'articleexists':\r
-                                                                               $r['talkmove-error-code'] = 'targetexists';\r
-                                                                               $r['talkmove-error-info'] = "``{$toTalk->getPrefixedText()}'' already exists and is not a redirect to ``{$fromTalk->getPrefixedText()}''";\r
-                                                                               break;\r
-                                                               case 'protectedpage':\r
-                                                                               $r['talkmove-error-code'] = 'permissiondenied';\r
-                                                                               $r['talkmove-error-info'] = "You don't have permission to move ``{$fromTalk->getPrefixedText()}'' to ``{$toTalk->getPrefixedText()}''";\r
-                                                               default:\r
-                                                                               $r['talkmove-error-code'] = 'unknownerror';\r
-                                                                               $r['talkmove-error-info'] = "Unknown error ``$retval''";\r
-                                               }                               \r
-               }\r
-               $dbw->commit(); // Make sure all changes are really written to the DB\r
-               $this->getResult()->addValue(null, $this->getModuleName(), $r);\r
-       }\r
-       \r
-       protected function getAllowedParams() {\r
-               return array (\r
-                       'from' => null,\r
-                       'to' => null,\r
-                       'token' => null,\r
-                       'reason' => null,\r
-                       'movetalk' => false,\r
-                       'noredirect' => false\r
-               );\r
-       }\r
-\r
-       protected function getParamDescription() {\r
-               return array (\r
-                       'from' => 'Title of the page you want to move.',\r
-                       'to' => 'Title you want to rename the page to.',\r
-                       'token' => 'A move token previously retrieved through prop=info',\r
-                       'reason' => 'Reason for the move (optional).',\r
-                       'movetalk' => 'Move the talk page, if it exists.',\r
-                       'noredirect' => 'Don\'t create a redirect'\r
-               );\r
-       }\r
-\r
-       protected function getDescription() {\r
-               return array(\r
-                       'Moves a page.'\r
-               );\r
-       }\r
-\r
-       protected function getExamples() {\r
-               return array (\r
-                       'api.php?action=move&from=Exampel&to=Example&token=123ABC&reason=Misspelled%20title&movetalk&noredirect'\r
-               );\r
-       }\r
-\r
-       public function getVersion() {\r
-               return __CLASS__ . ': $Id$';\r
-       }\r
-}\r
-\r
+<?php
+/**
+ *
+ *
+ * Created on Oct 31, 2007
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 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" );
+}
+
+/**
+ * API Module to move pages
+ * @ingroup API
+ */
+class ApiMove extends ApiBase {
+
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
+       }
+
+       public function execute() {
+               global $wgUser;
+               $params = $this->extractRequestParams();
+               if ( is_null( $params['reason'] ) ) {
+                       $params['reason'] = '';
+               }
+
+               $this->requireOnlyOneParameter( $params, 'from', 'fromid' );
+
+               if ( isset( $params['from'] ) ) {
+                       $fromTitle = Title::newFromText( $params['from'] );
+                       if ( !$fromTitle ) {
+                               $this->dieUsageMsg( array( 'invalidtitle', $params['from'] ) );
+                       }
+               } elseif ( isset( $params['fromid'] ) ) {
+                       $fromTitle = Title::newFromID( $params['fromid'] );
+                       if ( !$fromTitle ) {
+                               $this->dieUsageMsg( array( 'nosuchpageid', $params['fromid'] ) );
+                       }
+               }
+
+               if ( !$fromTitle->exists() ) {
+                       $this->dieUsageMsg( 'notanarticle' );
+               }
+               $fromTalk = $fromTitle->getTalkPage();
+
+               $toTitle = Title::newFromText( $params['to'] );
+               if ( !$toTitle ) {
+                       $this->dieUsageMsg( array( 'invalidtitle', $params['to'] ) );
+               }
+               $toTalk = $toTitle->getTalkPage();
+
+               if ( $toTitle->getNamespace() == NS_FILE
+                       && !RepoGroup::singleton()->getLocalRepo()->findFile( $toTitle )
+                       && wfFindFile( $toTitle ) )
+               {
+                       if ( !$params['ignorewarnings'] && $wgUser->isAllowed( 'reupload-shared' ) ) {
+                               $this->dieUsageMsg( 'sharedfile-exists' );
+                       } elseif ( !$wgUser->isAllowed( 'reupload-shared' ) ) {
+                               $this->dieUsageMsg( 'cantoverwrite-sharedfile' );
+                       }
+               }
+
+               // Move the page
+               $retval = $fromTitle->moveTo( $toTitle, true, $params['reason'], !$params['noredirect'] );
+               if ( $retval !== true ) {
+                       $this->dieUsageMsg( reset( $retval ) );
+               }
+
+               $r = array( 'from' => $fromTitle->getPrefixedText(), 'to' => $toTitle->getPrefixedText(), 'reason' => $params['reason'] );
+               if ( !$params['noredirect'] || !$wgUser->isAllowed( 'suppressredirect' ) ) {
+                       $r['redirectcreated'] = '';
+               }
+
+               // Move the talk page
+               if ( $params['movetalk'] && $fromTalk->exists() && !$fromTitle->isTalkPage() ) {
+                       $retval = $fromTalk->moveTo( $toTalk, true, $params['reason'], !$params['noredirect'] );
+                       if ( $retval === true ) {
+                               $r['talkfrom'] = $fromTalk->getPrefixedText();
+                               $r['talkto'] = $toTalk->getPrefixedText();
+                       } else {
+                               // We're not gonna dieUsage() on failure, since we already changed something
+                               $parsed = $this->parseMsg( reset( $retval ) );
+                               $r['talkmove-error-code'] = $parsed['code'];
+                               $r['talkmove-error-info'] = $parsed['info'];
+                       }
+               }
+
+               $result = $this->getResult();
+
+               // Move subpages
+               if ( $params['movesubpages'] ) {
+                       $r['subpages'] = $this->moveSubpages( $fromTitle, $toTitle,
+                                       $params['reason'], $params['noredirect'] );
+                       $result->setIndexedTagName( $r['subpages'], 'subpage' );
+
+                       if ( $params['movetalk'] ) {
+                               $r['subpages-talk'] = $this->moveSubpages( $fromTalk, $toTalk,
+                                       $params['reason'], $params['noredirect'] );
+                               $result->setIndexedTagName( $r['subpages-talk'], 'subpage' );
+                       }
+               }
+
+               $watch = "preferences";
+               if ( isset( $params['watchlist'] ) ) {
+                       $watch = $params['watchlist'];
+               } elseif ( $params['watch'] ) {
+                       $watch = 'watch';
+               } elseif ( $params['unwatch'] ) {
+                       $watch = 'unwatch';
+               }
+
+               // Watch pages
+               $this->setWatch( $watch, $fromTitle, 'watchmoves' );
+               $this->setWatch( $watch, $toTitle, 'watchmoves' );
+
+               $result->addValue( null, $this->getModuleName(), $r );
+       }
+
+       /**
+        * @param Title $fromTitle
+        * @param Title $toTitle
+        * @param  $reason
+        * @param  $noredirect
+        * @return array
+        */
+       public function moveSubpages( $fromTitle, $toTitle, $reason, $noredirect ) {
+               $retval = array();
+               $success = $fromTitle->moveSubpages( $toTitle, true, $reason, !$noredirect );
+               if ( isset( $success[0] ) ) {
+                       return array( 'error' => $this->parseMsg( $success ) );
+               } else {
+                       // At least some pages could be moved
+                       // Report each of them separately
+                       foreach ( $success as $oldTitle => $newTitle ) {
+                               $r = array( 'from' => $oldTitle );
+                               if ( is_array( $newTitle ) ) {
+                                       $r['error'] = $this->parseMsg( reset( $newTitle ) );
+                               } else {
+                                       // Success
+                                       $r['to'] = $newTitle;
+                               }
+                               $retval[] = $r;
+                       }
+               }
+               return $retval;
+       }
+
+       public function mustBePosted() {
+               return true;
+       }
+
+       public function isWriteMode() {
+               return true;
+       }
+
+       public function getAllowedParams() {
+               return array(
+                       'from' => null,
+                       'fromid' => array(
+                               ApiBase::PARAM_TYPE => 'integer'
+                       ),
+                       'to' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
+                       'token' => null,
+                       'reason' => null,
+                       'movetalk' => false,
+                       'movesubpages' => false,
+                       'noredirect' => false,
+                       'watch' => array(
+                               ApiBase::PARAM_DFLT => false,
+                               ApiBase::PARAM_DEPRECATED => true,
+                       ),
+                       'unwatch' => array(
+                               ApiBase::PARAM_DFLT => false,
+                               ApiBase::PARAM_DEPRECATED => true,
+                       ),
+                       'watchlist' => array(
+                               ApiBase::PARAM_DFLT => 'preferences',
+                               ApiBase::PARAM_TYPE => array(
+                                       'watch',
+                                       'unwatch',
+                                       'preferences',
+                                       'nochange'
+                               ),
+                       ),
+                       'ignorewarnings' => false
+               );
+       }
+
+       public function getParamDescription() {
+               $p = $this->getModulePrefix();
+               return array(
+                       'from' => "Title of the page you want to move. Cannot be used together with {$p}fromid",
+                       'fromid' => "Page ID of the page you want to move. Cannot be used together with {$p}from",
+                       'to' => 'Title you want to rename the page to',
+                       'token' => 'A move token previously retrieved through prop=info',
+                       'reason' => 'Reason for the move (optional)',
+                       'movetalk' => 'Move the talk page, if it exists',
+                       'movesubpages' => 'Move subpages, if applicable',
+                       'noredirect' => 'Don\'t create a redirect',
+                       'watch' => 'Add the page and the redirect to your watchlist',
+                       'unwatch' => 'Remove the page and the redirect from your watchlist',
+                       'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
+                       'ignorewarnings' => 'Ignore any warnings'
+               );
+       }
+
+       public function getDescription() {
+               return 'Move a page';
+       }
+
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(),
+                       $this->getRequireOnlyOneParameterErrorMessages( array( 'from', 'fromid' ) ),
+                       array(
+                               array( 'invalidtitle', 'from' ),
+                               array( 'nosuchpageid', 'fromid' ),
+                               array( 'notanarticle' ),
+                               array( 'invalidtitle', 'to' ),
+                               array( 'sharedfile-exists' ),
+                       )
+               );
+       }
+
+       public function needsToken() {
+               return true;
+       }
+
+       public function getTokenSalt() {
+               return '';
+       }
+
+       public function getExamples() {
+               return array(
+                       'api.php?action=move&from=Exampel&to=Example&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect='
+               );
+       }
+
+       public function getHelpUrls() {
+               return 'http://www.mediawiki.org/wiki/API:Move';
+       }
+
+       public function getVersion() {
+               return __CLASS__ . ': $Id$';
+       }
+}