4 * Created on Jul 3, 2007
5 * API for MediaWiki 1.8+
7 * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
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.
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.
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
25 if ( !defined( 'MEDIAWIKI' ) ) {
26 // Eclipse helper - will be ignored in production
27 require_once( "ApiBase.php" );
33 class ApiUndelete
extends ApiBase
{
35 public function __construct( $main, $action ) {
36 parent
::__construct( $main, $action );
39 public function execute() {
41 $params = $this->extractRequestParams();
44 if ( !isset( $params['title'] ) ) {
45 $this->dieUsageMsg( array( 'missingparam', 'title' ) );
48 if ( !$wgUser->isAllowed( 'undelete' ) ) {
49 $this->dieUsageMsg( array( 'permdenied-undelete' ) );
52 if ( $wgUser->isBlocked() ) {
53 $this->dieUsageMsg( array( 'blockedtext' ) );
56 $titleObj = Title
::newFromText( $params['title'] );
58 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
62 if ( !isset( $params['timestamps'] ) ) {
63 $params['timestamps'] = array();
65 if ( !is_array( $params['timestamps'] ) ) {
66 $params['timestamps'] = array( $params['timestamps'] );
68 foreach ( $params['timestamps'] as $i => $ts ) {
69 $params['timestamps'][$i] = wfTimestamp( TS_MW
, $ts );
72 $pa = new PageArchive( $titleObj );
73 $dbw = wfGetDB( DB_MASTER
);
75 $retval = $pa->undelete( ( isset( $params['timestamps'] ) ?
$params['timestamps'] : array() ), $params['reason'] );
76 if ( !is_array( $retval ) ) {
77 $this->dieUsageMsg( array( 'cannotundelete' ) );
81 wfRunHooks( 'FileUndeleteComplete',
82 array( $titleObj, array(), $wgUser, $params['reason'] ) );
85 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
87 if ( $params['watch'] ||
$watch ) {
88 $wgUser->addWatch( $titleObj );
89 } else if ( !$watch ) {
90 $wgUser->removeWatch( $titleObj );
93 $info['title'] = $titleObj->getPrefixedText();
94 $info['revisions'] = intval( $retval[0] );
95 $info['fileversions'] = intval( $retval[1] );
96 $info['reason'] = intval( $retval[2] );
97 $this->getResult()->addValue( null, $this->getModuleName(), $info );
100 public function mustBePosted() {
104 public function isWriteMode() {
108 public function getAllowedParams() {
113 'timestamps' => array(
114 ApiBase
::PARAM_ISMULTI
=> true
116 'watchlist' => array(
117 ApiBase
::PARAM_DFLT
=> 'preferences',
118 ApiBase
::PARAM_TYPE
=> array(
128 public function getParamDescription() {
130 'title' => 'Title of the page you want to restore.',
131 'token' => 'An undelete token previously retrieved through list=deletedrevs',
132 'reason' => 'Reason for restoring (optional)',
133 'timestamps' => 'Timestamps of the revisions to restore. If not set, all revisions will be restored.',
134 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
138 public function getDescription() {
140 'Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be',
141 'retrieved through list=deletedrevs'
145 public function getPossibleErrors() {
146 return array_merge( parent
::getPossibleErrors(), array(
147 array( 'missingparam', 'title' ),
148 array( 'permdenied-undelete' ),
149 array( 'blockedtext' ),
150 array( 'invalidtitle', 'title' ),
151 array( 'cannotundelete' ),
155 public function getTokenSalt() {
159 protected function getExamples() {
161 'api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page',
162 'api.php?action=undelete&title=Main%20Page&token=123ABC×tamps=20070703220045|20070702194856'
166 public function getVersion() {
167 return __CLASS__
. ': $Id$';