* (bug 27479) API error when using both prop=pageprops and prop=info&inprop=displaytitle
[lhc/web/wiklou.git] / includes / api / ApiUndelete.php
index 62497cc..a027b7f 100644 (file)
-<?php\r
-\r
-/*\r
- * Created on Jul 3, 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
- * @addtogroup API\r
- */\r
-class ApiUndelete 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
-               \r
-               $titleObj = NULL;\r
-               if(!isset($params['title']))\r
-                       $this->dieUsage('The title parameter must be set', 'notitle');\r
-               if(!isset($params['token']))\r
-                       $this->dieUsage('The token parameter must be set', 'notoken');\r
-\r
-               if(!$wgUser->isAllowed('undelete'))\r
-                       $this->dieUsage('You don\'t have permission to restore deleted revisions', 'permissiondenied');\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(!$wgUser->matchEditToken($params['token']))\r
-                       $this->dieUsage('Invalid token', 'badtoken');\r
-\r
-               $titleObj = Title::newFromText($params['title']);\r
-               if(!$titleObj)\r
-                       $this->dieUsage("Bad title ``{$params['title']}''", 'invalidtitle');\r
-\r
-               // Convert timestamps\r
-               if(!is_array($params['timestamps']))\r
-                       $params['timestamps'] = array($params['timestamps']);\r
-               foreach($params['timestamps'] as $i => $ts)\r
-                       $params['timestamps'][$i] = wfTimestamp(TS_MW, $ts);\r
-\r
-               $pa = new PageArchive($titleObj);\r
-               $dbw = wfGetDb(DB_MASTER);\r
-               $dbw->begin();\r
-               $retval = $pa->undelete((isset($params['timestamps']) ? $params['timestamps'] : array()), $params['reason']);\r
-               if(!is_array($retval))\r
-                       switch($retval)\r
-                       {\r
-                               case PageArchive::UNDELETE_NOTHINGRESTORED:\r
-                                       $this->dieUsage('No revisions could be restored', 'norevs');\r
-                               case PageArchive::UNDELETE_NOTAVAIL:\r
-                                       $this->dieUsage('Not all requested revisions could be found', 'revsnotfound');\r
-                               case PageArchive::UNDELETE_UNKNOWNERR:\r
-                                       $this->dieUsage('Undeletion failed with unknown error', 'unknownerror');\r
-                       }\r
-               $dbw->commit();\r
-               \r
-               $info['title'] = $titleObj->getPrefixedText();\r
-               $info['revisions'] = $retval[0];\r
-               $info['fileversions'] = $retval[1];\r
-               $info['reason'] = $retval[2];\r
-               $this->getResult()->addValue(null, $this->getModuleName(), $info);\r
-       }\r
-       \r
-       protected function getAllowedParams() {\r
-               return array (\r
-                       'title' => null,\r
-                       'token' => null,\r
-                       'reason' => "",\r
-                       'timestamps' => array(\r
-                               ApiBase :: PARAM_ISMULTI => true\r
-                       )\r
-               );\r
-       }\r
-\r
-       protected function getParamDescription() {\r
-               return array (\r
-                       'title' => 'Title of the page you want to restore.',\r
-                       'token' => 'An undelete token previously retrieved through list=deletedrevs',\r
-                       'reason' => 'Reason for restoring (optional)',\r
-                       'timestamps' => 'Timestamps of the revisions to restore. If not set, all revisions will be restored.'\r
-               );\r
-       }\r
-\r
-       protected function getDescription() {\r
-               return array(\r
-                       'Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be',\r
-                       'retrieved through list=deletedrevs'\r
-               );\r
-       }\r
-\r
-       protected function getExamples() {\r
-               return array (\r
-                       'api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page',\r
-                       'api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=20070703220045|20070702194856'\r
-               );\r
-       }\r
-\r
-       public function getVersion() {\r
-               return __CLASS__ . ': $Id: ApiUndelete.php 22289 2007-05-20 23:31:44Z yurik $';\r
-       }\r
-}\r
+<?php
+/**
+ *
+ *
+ * Created on Jul 3, 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" );
+}
+
+/**
+ * @ingroup API
+ */
+class ApiUndelete extends ApiBase {
+
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
+       }
+
+       public function execute() {
+               global $wgUser;
+               $params = $this->extractRequestParams();
+
+               if ( !$wgUser->isAllowed( 'undelete' ) ) {
+                       $this->dieUsageMsg( array( 'permdenied-undelete' ) );
+               }
+
+               if ( $wgUser->isBlocked() ) {
+                       $this->dieUsageMsg( array( 'blockedtext' ) );
+               }
+
+               $titleObj = Title::newFromText( $params['title'] );
+               if ( !$titleObj ) {
+                       $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
+               }
+
+               // Convert timestamps
+               if ( !isset( $params['timestamps'] ) ) {
+                       $params['timestamps'] = array();
+               }
+               if ( !is_array( $params['timestamps'] ) ) {
+                       $params['timestamps'] = array( $params['timestamps'] );
+               }
+               foreach ( $params['timestamps'] as $i => $ts ) {
+                       $params['timestamps'][$i] = wfTimestamp( TS_MW, $ts );
+               }
+
+               $pa = new PageArchive( $titleObj );
+               $retval = $pa->undelete( ( isset( $params['timestamps'] ) ? $params['timestamps'] : array() ), $params['reason'] );
+               if ( !is_array( $retval ) ) {
+                       $this->dieUsageMsg( array( 'cannotundelete' ) );
+               }
+
+               if ( $retval[1] ) {
+                       wfRunHooks( 'FileUndeleteComplete',
+                               array( $titleObj, array(), $wgUser, $params['reason'] ) );
+               }
+
+               $this->setWatch( $params['watchlist'], $titleObj );
+
+               $info['title'] = $titleObj->getPrefixedText();
+               $info['revisions'] = intval( $retval[0] );
+               $info['fileversions'] = intval( $retval[1] );
+               $info['reason'] = intval( $retval[2] );
+               $this->getResult()->addValue( null, $this->getModuleName(), $info );
+       }
+
+       public function mustBePosted() {
+               return true;
+       }
+
+       public function isWriteMode() {
+               return true;
+       }
+
+       public function getAllowedParams() {
+               return array(
+                       'title' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
+                       'token' => null,
+                       'reason' => '',
+                       'timestamps' => array(
+                               ApiBase::PARAM_ISMULTI => true
+                       ),
+                       'watchlist' => array(
+                               ApiBase::PARAM_DFLT => 'preferences',
+                               ApiBase::PARAM_TYPE => array(
+                                       'watch',
+                                       'unwatch',
+                                       'preferences',
+                                       'nochange'
+                               ),
+                       ),
+               );
+       }
+
+       public function getParamDescription() {
+               return array(
+                       'title' => 'Title of the page you want to restore',
+                       'token' => 'An undelete token previously retrieved through list=deletedrevs',
+                       'reason' => 'Reason for restoring (optional)',
+                       'timestamps' => 'Timestamps of the revisions to restore. If not set, all revisions will be restored.',
+                       'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
+               );
+       }
+
+       public function getDescription() {
+               return array(
+                       'Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be',
+                       'retrieved through list=deletedrevs'
+               );
+       }
+
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'permdenied-undelete' ),
+                       array( 'blockedtext' ),
+                       array( 'invalidtitle', 'title' ),
+                       array( 'cannotundelete' ),
+               ) );
+       }
+
+       public function needsToken() {
+               return true;
+       }
+
+       public function getTokenSalt() {
+               return '';
+       }
+
+       protected function getExamples() {
+               return array(
+                       'api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page',
+                       'api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=20070703220045|20070702194856'
+               );
+       }
+
+       public function getVersion() {
+               return __CLASS__ . ': $Id$';
+       }
+}