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
|
<?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( [ 'nosuchrcid', $params['rcid'] ] );
}
} else {
$rev = Revision::newFromId( $params['revid'] );
if ( !$rev ) {
$this->dieUsageMsg( [ 'nosuchrevid', $params['revid'] ] );
}
$rc = $rev->getRecentChange();
if ( !$rc ) {
$this->dieUsage(
'The revision ' . $params['revid'] . " can't be patrolled as it's too old",
'notpatrollable'
);
}
}
$user = $this->getUser();
$tags = $params['tags'];
// Check if user can add tags
if ( !is_null( $tags ) ) {
$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $tags, $user );
if ( !$ableToTag->isOK() ) {
$this->dieStatus( $ableToTag );
}
}
$retval = $rc->doMarkPatrolled( $user, false, $tags );
if ( $retval ) {
$this->dieUsageMsg( reset( $retval ) );
}
$result = [ '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 [
'rcid' => [
ApiBase::PARAM_TYPE => 'integer'
],
'revid' => [
ApiBase::PARAM_TYPE => 'integer'
],
'tags' => [
ApiBase::PARAM_TYPE => 'tags',
ApiBase::PARAM_ISMULTI => true,
],
];
}
public function needsToken() {
return 'patrol';
}
protected function getExamplesMessages() {
return [
'action=patrol&token=123ABC&rcid=230672766'
=> 'apihelp-patrol-example-rcid',
'action=patrol&token=123ABC&revid=230672766'
=> 'apihelp-patrol-example-revid',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Patrol';
}
}
|
