Swap and for &&
[mediawiki.git] / includes / api / ApiUndelete.php
blob39b63f4f4dac6c0fb72c21590ce7d19edfba7bac
1 <?php
2 /**
5 * Created on Jul 3, 2007
7 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
24 * @file
27 /**
28 * @ingroup API
30 class ApiUndelete extends ApiBase {
32 public function execute() {
33 $params = $this->extractRequestParams();
35 if ( !$this->getUser()->isAllowed( 'undelete' ) ) {
36 $this->dieUsageMsg( 'permdenied-undelete' );
39 if ( $this->getUser()->isBlocked() ) {
40 $this->dieUsageMsg( 'blockedtext' );
43 $titleObj = Title::newFromText( $params['title'] );
44 if ( !$titleObj || $titleObj->isExternal() ) {
45 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
48 // Convert timestamps
49 if ( !isset( $params['timestamps'] ) ) {
50 $params['timestamps'] = array();
52 if ( !is_array( $params['timestamps'] ) ) {
53 $params['timestamps'] = array( $params['timestamps'] );
55 foreach ( $params['timestamps'] as $i => $ts ) {
56 $params['timestamps'][$i] = wfTimestamp( TS_MW, $ts );
59 $pa = new PageArchive( $titleObj, $this->getConfig() );
60 $retval = $pa->undelete(
61 ( isset( $params['timestamps'] ) ? $params['timestamps'] : array() ),
62 $params['reason'],
63 $params['fileids'],
64 false,
65 $this->getUser()
67 if ( !is_array( $retval ) ) {
68 $this->dieUsageMsg( 'cannotundelete' );
71 if ( $retval[1] ) {
72 wfRunHooks( 'FileUndeleteComplete',
73 array( $titleObj, $params['fileids'], $this->getUser(), $params['reason'] ) );
76 $this->setWatch( $params['watchlist'], $titleObj );
78 $info['title'] = $titleObj->getPrefixedText();
79 $info['revisions'] = intval( $retval[0] );
80 $info['fileversions'] = intval( $retval[1] );
81 $info['reason'] = $retval[2];
82 $this->getResult()->addValue( null, $this->getModuleName(), $info );
85 public function mustBePosted() {
86 return true;
89 public function isWriteMode() {
90 return true;
93 public function getAllowedParams() {
94 return array(
95 'title' => array(
96 ApiBase::PARAM_TYPE => 'string',
97 ApiBase::PARAM_REQUIRED => true
99 'reason' => '',
100 'timestamps' => array(
101 ApiBase::PARAM_TYPE => 'timestamp',
102 ApiBase::PARAM_ISMULTI => true,
104 'fileids' => array(
105 ApiBase::PARAM_TYPE => 'integer',
106 ApiBase::PARAM_ISMULTI => true,
108 'watchlist' => array(
109 ApiBase::PARAM_DFLT => 'preferences',
110 ApiBase::PARAM_TYPE => array(
111 'watch',
112 'unwatch',
113 'preferences',
114 'nochange'
120 public function needsToken() {
121 return 'csrf';
124 public function getExamplesMessages() {
125 return array(
126 'action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page'
127 => 'apihelp-undelete-example-page',
128 'action=undelete&title=Main%20Page&token=123ABC' .
129 '&timestamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z'
130 => 'apihelp-undelete-example-revisions',
134 public function getHelpUrls() {
135 return 'https://www.mediawiki.org/wiki/API:Undelete';