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(wfReadOnly())
  55                         $this->dieUsageMsg(array('readonlytext'));
  56                 if(!$wgUser->matchEditToken($params['token']))
  57                         $this->dieUsageMsg(array('sessionfailure'));
  58
  59                 $titleObj = Title::newFromText($params['title']);
  60                 if(!$titleObj)
  61                         $this->dieUsageMsg(array('invalidtitle', $params['title']));
  62
  63                 // Convert timestamps
  64                 if(!isset($params['timestamps']))
  65                         $params['timestamps'] = array();
  66                 if(!is_array($params['timestamps']))
  67                         $params['timestamps'] = array($params['timestamps']);
  68                 foreach($params['timestamps'] as $i => $ts)
  69                         $params['timestamps'][$i] = wfTimestamp(TS_MW, $ts);
  70
  71                 $pa = new PageArchive($titleObj);
  72                 $dbw = wfGetDb(DB_MASTER);
  73                 $dbw->begin();
  74                 $retval = $pa->undelete((isset($params['timestamps']) ? $params['timestamps'] : array()), $params['reason']);
  75                 if(!is_array($retval))
  76                         $this->dieUsageMsg(array('cannotundelete'));
  77
  78                 if($retval[1])
  79                         wfRunHooks( 'FileUndeleteComplete',
  80                                 array($titleObj, array(), $wgUser, $params['reason']) );
  81
  82                 $info['title'] = $titleObj->getPrefixedText();
  83                 $info['revisions'] = $retval[0];
  84                 $info['fileversions'] = $retval[1];
  85                 $info['reason'] = $retval[2];
  86                 $this->getResult()->addValue(null, $this->getModuleName(), $info);
  87         }
  88
  89         public function mustBePosted() { return true; }
  90
  91         public function getAllowedParams() {
  92                 return array (
  93                         'title' => null,
  94                         'token' => null,
  95                         'reason' => "",
  96                         'timestamps' => array(
  97                                 ApiBase :: PARAM_ISMULTI => true
  98                         )
  99                 );
 100         }
 101
 102         public function getParamDescription() {
 103                 return array (
 104                         'title' => 'Title of the page you want to restore.',
 105                         'token' => 'An undelete token previously retrieved through list=deletedrevs',
 106                         'reason' => 'Reason for restoring (optional)',
 107                         'timestamps' => 'Timestamps of the revisions to restore. If not set, all revisions will be restored.'
 108                 );
 109         }
 110
 111         public function getDescription() {
 112                 return array(
 113                         'Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be',
 114                         'retrieved through list=deletedrevs'
 115                 );
 116         }
 117
 118         protected function getExamples() {
 119                 return array (
 120                         'api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page',
 121                         'api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=20070703220045|20070702194856'
 122                 );
 123         }
 124
 125         public function getVersion() {
 126                 return __CLASS__ . ': $Id$';
 127         }
 128 }