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
|
<?php
/**
* API for MediaWiki 1.14+
*
* Created on Sep 2, 2008
*
* Copyright © 2008 Soxred93 soxred93@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
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Allows user to patrol pages
* @ingroup API
*/
class ApiPatrol extends ApiBase {
/**
* Patrols the article or provides the reason the patrol failed.
*/
public function execute() {
$params = $this->extractRequestParams();
$this->requireOnlyOneParameter( $params, 'rcid', 'revid' );
if ( isset( $params['rcid'] ) ) {
$rc = RecentChange::newFromID( $params['rcid'] );
if ( !$rc ) {
$this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
}
} else {
$rev = Revision::newFromId( $params['revid'] );
if ( !$rev ) {
$this->dieUsageMsg( array( 'nosuchrevid', $params['revid'] ) );
}
$rc = $rev->getRecentChange();
if ( !$rc ) {
$this->dieUsage(
'The revision ' . $params['revid'] . " can't be patrolled as it's too old",
'notpatrollable'
);
}
}
$retval = $rc->doMarkPatrolled( $this->getUser() );
if ( $retval ) {
$this->dieUsageMsg( reset( $retval ) );
}
$result = array( 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) );
ApiQueryBase::addTitleInfo( $result, $rc->getTitle() );
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array(
'token' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true
),
'rcid' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'revid' => array(
ApiBase::PARAM_TYPE => 'integer'
),
);
}
public function getParamDescription() {
return array(
'token' => 'Patrol token obtained from list=recentchanges',
'rcid' => 'Recentchanges ID to patrol',
'revid' => 'Revision ID to patrol',
);
}
public function getResultProperties() {
return array(
'' => array(
'rcid' => 'integer',
'ns' => 'namespace',
'title' => 'string'
)
);
}
public function getDescription() {
return 'Patrol a page or revision';
}
public function getPossibleErrors() {
return array_merge(
parent::getPossibleErrors(),
parent::getRequireOnlyOneParameterErrorMessages( array( 'rcid', 'revid' ) ),
array(
array( 'nosuchrcid', 'rcid' ),
array( 'nosuchrevid', 'revid' ),
array(
'code' => 'notpatrollable',
'info' => "The revision can't be patrolled as it's too old"
)
) );
}
public function needsToken() {
return true;
}
public function getTokenSalt() {
return 'patrol';
}
public function getExamples() {
return array(
'api.php?action=patrol&token=123abc&rcid=230672766',
'api.php?action=patrol&token=123abc&revid=230672766'
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Patrol';
}
}
|
