includes/api/ApiUndelete.php

   1 <?php
   2
   3 /*
   4  * Created on Jul 3, 2007
   5  * API for MediaWiki 1.8+
   6  *
   7  * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  */
  24
  25 if (!defined('MEDIAWIKI')) {
  26         // Eclipse helper - will be ignored in production
  27         require_once ("ApiBase.php");
  28 }
  29
  30 /**
  31  * @ingroup API
  32  */
  33 class ApiUndelete extends ApiBase {
  34
  35         public function __construct($main, $action) {
  36                 parent :: __construct($main, $action);
  37         }
  38
  39         public function execute() {
  40                 global $wgUser;
  41                 $this->getMain()->requestWriteMode();
  42                 $params = $this->extractRequestParams();
  43
  44                 $titleObj = NULL;
  45                 if(!isset($params['title']))
  46                         $this->dieUsageMsg(array('missingparam', 'title'));
  47                 if(!isset($params['token']))
  48                         $this->dieUsageMsg(array('missingparam', 'token'));
  49
  50                 if(!$wgUser->isAllowed('undelete'))
  51                         $this->dieUsageMsg(array('permdenied-undelete'));
  52                 if($wgUser->isBlocked())
  53                         $this->dieUsageMsg(array('blockedtext'));
  54                 if(!$wgUser->matchEditToken($params['token']))
  55                         $this->dieUsageMsg(array('sessionfailure'));
  56
  57                 $titleObj = Title::newFromText($params['title']);
  58                 if(!$titleObj)
  59                         $this->dieUsageMsg(array('invalidtitle', $params['title']));
  60
  61                 // Convert timestamps
  62                 if(!isset($params['timestamps']))
  63                         $params['timestamps'] = array();
  64                 if(!is_array($params['timestamps']))
  65                         $params['timestamps'] = array($params['timestamps']);
  66                 foreach($params['timestamps'] as $i => $ts)
  67                         $params['timestamps'][$i] = wfTimestamp(TS_MW, $ts);
  68
  69                 $pa = new PageArchive($titleObj);
  70                 $dbw = wfGetDb(DB_MASTER);
  71                 $dbw->begin();
  72                 $retval = $pa->undelete((isset($params['timestamps']) ? $params['timestamps'] : array()), $params['reason']);
  73                 if(!is_array($retval))
  74                         $this->dieUsageMsg(array('cannotundelete'));
  75
  76                 if($retval[1])
  77                         wfRunHooks( 'FileUndeleteComplete',
  78                                 array($titleObj, array(), $wgUser, $params['reason']) );
  79
  80                 $info['title'] = $titleObj->getPrefixedText();
  81                 $info['revisions'] = $retval[0];
  82                 $info['fileversions'] = $retval[1];
  83                 $info['reason'] = $retval[2];
  84                 $this->getResult()->addValue(null, $this->getModuleName(), $info);
  85         }
  86
  87         public function mustBePosted() { return true; }
  88
  89         public function getAllowedParams() {
  90                 return array (
  91                         'title' => null,
  92                         'token' => null,
  93                         'reason' => "",
  94                         'timestamps' => array(
  95                                 ApiBase :: PARAM_ISMULTI => true
  96                         )
  97                 );
  98         }
  99
 100         public function getParamDescription() {
 101                 return array (
 102                         'title' => 'Title of the page you want to restore.',
 103                         'token' => 'An undelete token previously retrieved through list=deletedrevs',
 104                         'reason' => 'Reason for restoring (optional)',
 105                         'timestamps' => 'Timestamps of the revisions to restore. If not set, all revisions will be restored.'
 106                 );
 107         }
 108
 109         public function getDescription() {
 110                 return array(
 111                         'Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be',
 112                         'retrieved through list=deletedrevs'
 113                 );
 114         }
 115
 116         protected function getExamples() {
 117                 return array (
 118                         'api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page',
 119                         'api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=20070703220045|20070702194856'
 120                 );
 121         }
 122
 123         public function getVersion() {
 124                 return __CLASS__ . ': $Id$';
 125         }
 126 }