Merge "Deprecate no longer used Skin::getCommonStylePath."

[lhc/web/wiklou.git] / includes / api / ApiUndelete.php

diff --git a/includes/api/ApiUndelete.php b/includes/api/ApiUndelete.php
index a317adf..c89f49a 100644 (file)
--- a/includes/api/ApiUndelete.php
+++ b/includes/api/ApiUndelete.php
@@ -1,10 +1,10 @@
 <?php
-
-/*
+/**
+ *
+ *
  * Created on Jul 3, 2007
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * 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
@@ -20,13 +20,10 @@
  * 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
  */
@@ -37,17 +34,14 @@ class ApiUndelete extends ApiBase {
        }
 
        public function execute() {
-               global $wgUser;
                $params = $this->extractRequestParams();
 
-               $titleObj = null;
-
-               if ( !$wgUser->isAllowed( 'undelete' ) ) {
-                       $this->dieUsageMsg( array( 'permdenied-undelete' ) );
+               if ( !$this->getUser()->isAllowed( 'undelete' ) ) {
+                       $this->dieUsageMsg( 'permdenied-undelete' );
                }
 
-               if ( $wgUser->isBlocked() ) {
-                       $this->dieUsageMsg( array( 'blockedtext' ) );
+               if ( $this->getUser()->isBlocked() ) {
+                       $this->dieUsageMsg( 'blockedtext' );
                }
 
                $titleObj = Title::newFromText( $params['title'] );
@@ -67,16 +61,14 @@ class ApiUndelete extends ApiBase {
                }
 
                $pa = new PageArchive( $titleObj );
-               $dbw = wfGetDB( DB_MASTER );
-               $dbw->begin();
                $retval = $pa->undelete( ( isset( $params['timestamps'] ) ? $params['timestamps'] : array() ), $params['reason'] );
                if ( !is_array( $retval ) ) {
-                       $this->dieUsageMsg( array( 'cannotundelete' ) );
+                       $this->dieUsageMsg( 'cannotundelete' );
                }
 
                if ( $retval[1] ) {
                        wfRunHooks( 'FileUndeleteComplete',
-                               array( $titleObj, array(), $wgUser, $params['reason'] ) );
+                               array( $titleObj, array(), $this->getUser(), $params['reason'] ) );
                }
 
                $this->setWatch( $params['watchlist'], $titleObj );
@@ -84,7 +76,7 @@ class ApiUndelete extends ApiBase {
                $info['title'] = $titleObj->getPrefixedText();
                $info['revisions'] = intval( $retval[0] );
                $info['fileversions'] = intval( $retval[1] );
-               $info['reason'] = intval( $retval[2] );
+               $info['reason'] = $retval[2];
                $this->getResult()->addValue( null, $this->getModuleName(), $info );
        }
 
@@ -105,7 +97,8 @@ class ApiUndelete extends ApiBase {
                        'token' => null,
                        'reason' => '',
                        'timestamps' => array(
-                               ApiBase::PARAM_ISMULTI => true
+                               ApiBase::PARAM_TYPE => 'timestamp',
+                               ApiBase::PARAM_ISMULTI => true,
                        ),
                        'watchlist' => array(
                                ApiBase::PARAM_DFLT => 'preferences',
@@ -129,6 +122,17 @@ class ApiUndelete extends ApiBase {
                );
        }
 
+       public function getResultProperties() {
+               return array(
+                       '' => array(
+                               'title' => 'string',
+                               'revisions' => 'integer',
+                               'filerevisions' => 'integer',
+                               'reason' => 'string'
+                       )
+               );
+       }
+
        public function getDescription() {
                return array(
                        'Restore certain revisions of a deleted page. A list of deleted revisions (including timestamps) can be',
@@ -145,17 +149,25 @@ class ApiUndelete extends ApiBase {
                ) );
        }
 
+       public function needsToken() {
+               return true;
+       }
+
        public function getTokenSalt() {
                return '';
        }
 
-       protected function getExamples() {
+       public 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 getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Undelete';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }