1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<?php
/*
* Created on Oct 31, 2007
* API for MediaWiki 1.8+
*
* Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
*
* 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ("ApiBase.php");
}
/**
* @ingroup API
*/
class ApiMove extends ApiBase {
public function __construct($main, $action) {
parent :: __construct($main, $action);
}
public function execute() {
global $wgUser;
$params = $this->extractRequestParams();
if(is_null($params['reason']))
$params['reason'] = '';
$this->requireOnlyOneParameter($params, 'from', 'fromid');
if(!isset($params['to']))
$this->dieUsageMsg(array('missingparam', 'to'));
if(!isset($params['token']))
$this->dieUsageMsg(array('missingparam', 'token'));
if(!$wgUser->matchEditToken($params['token']))
$this->dieUsageMsg(array('sessionfailure'));
if(isset($params['from']))
{
$fromTitle = Title::newFromText($params['from']);
if(!$fromTitle)
$this->dieUsageMsg(array('invalidtitle', $params['from']));
}
else if(isset($params['fromid']))
{
$fromTitle = Title::newFromID($params['fromid']);
if(!$fromTitle)
$this->dieUsageMsg(array('nosuchpageid', $params['fromid']));
}
if(!$fromTitle->exists())
$this->dieUsageMsg(array('notanarticle'));
$fromTalk = $fromTitle->getTalkPage();
$toTitle = Title::newFromText($params['to']);
if(!$toTitle)
$this->dieUsageMsg(array('invalidtitle', $params['to']));
$toTalk = $toTitle->getTalkPage();
# Move the page
$hookErr = null;
$retval = $fromTitle->moveTo($toTitle, true, $params['reason'], !$params['noredirect']);
if($retval !== true)
$this->dieUsageMsg(reset($retval));
$r = array('from' => $fromTitle->getPrefixedText(), 'to' => $toTitle->getPrefixedText(), 'reason' => $params['reason']);
if(!$params['noredirect'] || !$wgUser->isAllowed('suppressredirect'))
$r['redirectcreated'] = '';
# Move the talk page
if($params['movetalk'] && $fromTalk->exists() && !$fromTitle->isTalkPage())
{
$retval = $fromTalk->moveTo($toTalk, true, $params['reason'], !$params['noredirect']);
if($retval === true)
{
$r['talkfrom'] = $fromTalk->getPrefixedText();
$r['talkto'] = $toTalk->getPrefixedText();
}
// We're not gonna dieUsage() on failure, since we already changed something
else
{
$parsed = $this->parseMsg(reset($retval));
$r['talkmove-error-code'] = $parsed['code'];
$r['talkmove-error-info'] = $parsed['info'];
}
}
# Move subpages
if($params['movesubpages'])
{
$r['subpages'] = $this->moveSubpages($fromTitle, $toTitle,
$params['reason'], $params['noredirect']);
$this->getResult()->setIndexedTagName($r['subpages'], 'subpage');
if($params['movetalk'])
{
$r['subpages-talk'] = $this->moveSubpages($fromTalk, $toTalk,
$params['reason'], $params['noredirect']);
$this->getResult()->setIndexedTagName($r['subpages-talk'], 'subpage');
}
}
# Watch pages
if($params['watch'] || $wgUser->getOption('watchmoves'))
{
$wgUser->addWatch($fromTitle);
$wgUser->addWatch($toTitle);
}
else if($params['unwatch'])
{
$wgUser->removeWatch($fromTitle);
$wgUser->removeWatch($toTitle);
}
$this->getResult()->addValue(null, $this->getModuleName(), $r);
}
public function moveSubpages($fromTitle, $toTitle, $reason, $noredirect)
{
$retval = array();
$success = $fromTitle->moveSubpages($toTitle, true, $reason, !$noredirect);
if(isset($success[0]))
return array('error' => $this->parseMsg($success));
else
{
// At least some pages could be moved
// Report each of them separately
foreach($success as $oldTitle => $newTitle)
{
$r = array('from' => $oldTitle);
if(is_array($newTitle))
$r['error'] = $this->parseMsg(reset($newTitle));
else
// Success
$r['to'] = $newTitle;
$retval[] = $r;
}
}
return $retval;
}
public function mustBePosted() { return true; }
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array (
'from' => null,
'fromid' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'to' => null,
'token' => null,
'reason' => null,
'movetalk' => false,
'movesubpages' => false,
'noredirect' => false,
'watch' => false,
'unwatch' => false
);
}
public function getParamDescription() {
return array (
'from' => 'Title of the page you want to move. Cannot be used together with fromid.',
'fromid' => 'Page ID of the page you want to move. Cannot be used together with from.',
'to' => 'Title you want to rename the page to.',
'token' => 'A move token previously retrieved through prop=info',
'reason' => 'Reason for the move (optional).',
'movetalk' => 'Move the talk page, if it exists.',
'movesubpages' => 'Move subpages, if applicable',
'noredirect' => 'Don\'t create a redirect',
'watch' => 'Add the page and the redirect to your watchlist',
'unwatch' => 'Remove the page and the redirect from your watchlist'
);
}
public function getDescription() {
return array(
'Move a page.'
);
}
protected function getExamples() {
return array (
'api.php?action=move&from=Exampel&to=Example&token=123ABC&reason=Misspelled%20title&movetalk&noredirect'
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiMove.php 48091 2009-03-06 13:49:44Z catrope $';
}
}
|
