1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* |
4
|
|
|
* |
5
|
|
|
* Created on Jul 3, 2007 |
6
|
|
|
* |
7
|
|
|
* Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com" |
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
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
22
|
|
|
* http://www.gnu.org/copyleft/gpl.html |
23
|
|
|
* |
24
|
|
|
* @file |
25
|
|
|
*/ |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* @ingroup API |
29
|
|
|
*/ |
30
|
|
|
class ApiUndelete extends ApiBase { |
31
|
|
|
|
32
|
|
|
public function execute() { |
33
|
|
|
$this->useTransactionalTimeLimit(); |
34
|
|
|
|
35
|
|
|
$params = $this->extractRequestParams(); |
36
|
|
|
$user = $this->getUser(); |
37
|
|
|
if ( !$user->isAllowed( 'undelete' ) ) { |
38
|
|
|
$this->dieUsageMsg( 'permdenied-undelete' ); |
39
|
|
|
} |
40
|
|
|
|
41
|
|
|
if ( $user->isBlocked() ) { |
42
|
|
|
$this->dieBlocked( $user->getBlock() ); |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
$titleObj = Title::newFromText( $params['title'] ); |
46
|
|
|
if ( !$titleObj || $titleObj->isExternal() ) { |
47
|
|
|
$this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] ); |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
// Check if user can add tags |
51
|
|
View Code Duplication |
if ( !is_null( $params['tags'] ) ) { |
52
|
|
|
$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user ); |
53
|
|
|
if ( !$ableToTag->isOK() ) { |
54
|
|
|
$this->dieStatus( $ableToTag ); |
55
|
|
|
} |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
// Convert timestamps |
59
|
|
|
if ( !isset( $params['timestamps'] ) ) { |
60
|
|
|
$params['timestamps'] = []; |
61
|
|
|
} |
62
|
|
|
if ( !is_array( $params['timestamps'] ) ) { |
63
|
|
|
$params['timestamps'] = [ $params['timestamps'] ]; |
64
|
|
|
} |
65
|
|
|
foreach ( $params['timestamps'] as $i => $ts ) { |
66
|
|
|
$params['timestamps'][$i] = wfTimestamp( TS_MW, $ts ); |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
$pa = new PageArchive( $titleObj, $this->getConfig() ); |
70
|
|
|
$retval = $pa->undelete( |
71
|
|
|
( isset( $params['timestamps'] ) ? $params['timestamps'] : [] ), |
72
|
|
|
$params['reason'], |
73
|
|
|
$params['fileids'], |
74
|
|
|
false, |
75
|
|
|
$user, |
76
|
|
|
$params['tags'] |
77
|
|
|
); |
78
|
|
|
if ( !is_array( $retval ) ) { |
79
|
|
|
$this->dieUsageMsg( 'cannotundelete' ); |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
if ( $retval[1] ) { |
83
|
|
|
Hooks::run( 'FileUndeleteComplete', |
84
|
|
|
[ $titleObj, $params['fileids'], $this->getUser(), $params['reason'] ] ); |
85
|
|
|
} |
86
|
|
|
|
87
|
|
|
$this->setWatch( $params['watchlist'], $titleObj ); |
|
|
|
|
88
|
|
|
|
89
|
|
|
$info['title'] = $titleObj->getPrefixedText(); |
90
|
|
|
$info['revisions'] = intval( $retval[0] ); |
91
|
|
|
$info['fileversions'] = intval( $retval[1] ); |
92
|
|
|
$info['reason'] = $retval[2]; |
93
|
|
|
$this->getResult()->addValue( null, $this->getModuleName(), $info ); |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
public function mustBePosted() { |
97
|
|
|
return true; |
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
public function isWriteMode() { |
101
|
|
|
return true; |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
public function getAllowedParams() { |
105
|
|
|
return [ |
106
|
|
|
'title' => [ |
107
|
|
|
ApiBase::PARAM_TYPE => 'string', |
108
|
|
|
ApiBase::PARAM_REQUIRED => true |
109
|
|
|
], |
110
|
|
|
'reason' => '', |
111
|
|
|
'tags' => [ |
112
|
|
|
ApiBase::PARAM_TYPE => 'tags', |
113
|
|
|
ApiBase::PARAM_ISMULTI => true, |
114
|
|
|
], |
115
|
|
|
'timestamps' => [ |
116
|
|
|
ApiBase::PARAM_TYPE => 'timestamp', |
117
|
|
|
ApiBase::PARAM_ISMULTI => true, |
118
|
|
|
], |
119
|
|
|
'fileids' => [ |
120
|
|
|
ApiBase::PARAM_TYPE => 'integer', |
121
|
|
|
ApiBase::PARAM_ISMULTI => true, |
122
|
|
|
], |
123
|
|
|
'watchlist' => [ |
124
|
|
|
ApiBase::PARAM_DFLT => 'preferences', |
125
|
|
|
ApiBase::PARAM_TYPE => [ |
126
|
|
|
'watch', |
127
|
|
|
'unwatch', |
128
|
|
|
'preferences', |
129
|
|
|
'nochange' |
130
|
|
|
], |
131
|
|
|
], |
132
|
|
|
]; |
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
public function needsToken() { |
136
|
|
|
return 'csrf'; |
137
|
|
|
} |
138
|
|
|
|
139
|
|
|
protected function getExamplesMessages() { |
140
|
|
|
return [ |
141
|
|
|
'action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page' |
142
|
|
|
=> 'apihelp-undelete-example-page', |
143
|
|
|
'action=undelete&title=Main%20Page&token=123ABC' . |
144
|
|
|
'×tamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z' |
145
|
|
|
=> 'apihelp-undelete-example-revisions', |
146
|
|
|
]; |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
public function getHelpUrls() { |
150
|
|
|
return 'https://www.mediawiki.org/wiki/API:Undelete'; |
151
|
|
|
} |
152
|
|
|
} |
153
|
|
|
|
Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: