Replace my old e-mail address with my new one in API comments. A bit outdated (droppe...

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

diff --git a/includes/api/ApiUndelete.php b/includes/api/ApiUndelete.php
index 470bfe8..be2bcd4 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
+ * 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
@@ -18,8 +18,10 @@
  *
  * 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -39,15 +41,6 @@ class ApiUndelete extends ApiBase {
        public function execute() {
                global $wgUser;
                $params = $this->extractRequestParams();
-               
-               if ( isset( $params['watch'] ) && params( $show['unwatch'] ) ) {
-                       $this->dieUsageMsg( array( 'show' ) );
-               }
-
-               $titleObj = null;
-               if ( !isset( $params['title'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'title' ) );
-               }
 
                if ( !$wgUser->isAllowed( 'undelete' ) ) {
                        $this->dieUsageMsg( array( 'permdenied-undelete' ) );
@@ -74,26 +67,18 @@ 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' ) );
                }
 
-               if ( $params['watch'] ) {
-                       $articleObj = new Article( $titleObj );
-                       $articleObj->doWatch();
-               } elseif ( $params['unwatch'] ) {
-                       $articleObj = new Article( $titleObj );
-                       $articleObj->doUnwatch();
-               }
-
                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] );
@@ -111,25 +96,34 @@ class ApiUndelete extends ApiBase {
 
        public function getAllowedParams() {
                return array(
-                       'title' => null,
+                       'title' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'token' => null,
                        'reason' => '',
                        'timestamps' => array(
                                ApiBase::PARAM_ISMULTI => true
                        ),
-                       'watch' => false,
-                       'unwatch' => false,
+                       '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.',
+                       '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.'
-                       'watch' => 'Add the page to your watchlist',
-                       'unwatch' => 'Remove the page from your watchlist',
+                       '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',
                );
        }
 
@@ -142,7 +136,6 @@ class ApiUndelete extends ApiBase {
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'title' ),
                        array( 'permdenied-undelete' ),
                        array( 'blockedtext' ),
                        array( 'invalidtitle', 'title' ),
@@ -150,6 +143,10 @@ class ApiUndelete extends ApiBase {
                ) );
        }
 
+       public function needsToken() {
+               return true;
+       }
+
        public function getTokenSalt() {
                return '';
        }