User::isSafeToLoad() should return false if MW_NO_SESSION
[mediawiki.git] / includes / api / ApiPatrol.php
blob1230babb9b80997324ad2f11f6c15c891b2aa385
1 <?php
2 /**
3 * API for MediaWiki 1.14+
5 * Created on Sep 2, 2008
7 * Copyright © 2008 Soxred93 soxred93@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 * Allows user to patrol pages
29 * @ingroup API
31 class ApiPatrol extends ApiBase {
33 /**
34 * Patrols the article or provides the reason the patrol failed.
36 public function execute() {
37 $params = $this->extractRequestParams();
38 $this->requireOnlyOneParameter( $params, 'rcid', 'revid' );
40 if ( isset( $params['rcid'] ) ) {
41 $rc = RecentChange::newFromId( $params['rcid'] );
42 if ( !$rc ) {
43 $this->dieUsageMsg( [ 'nosuchrcid', $params['rcid'] ] );
45 } else {
46 $rev = Revision::newFromId( $params['revid'] );
47 if ( !$rev ) {
48 $this->dieUsageMsg( [ 'nosuchrevid', $params['revid'] ] );
50 $rc = $rev->getRecentChange();
51 if ( !$rc ) {
52 $this->dieUsage(
53 'The revision ' . $params['revid'] . " can't be patrolled as it's too old",
54 'notpatrollable'
59 $retval = $rc->doMarkPatrolled( $this->getUser() );
61 if ( $retval ) {
62 $this->dieUsageMsg( reset( $retval ) );
65 $result = [ 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) ];
66 ApiQueryBase::addTitleInfo( $result, $rc->getTitle() );
67 $this->getResult()->addValue( null, $this->getModuleName(), $result );
70 public function mustBePosted() {
71 return true;
74 public function isWriteMode() {
75 return true;
78 public function getAllowedParams() {
79 return [
80 'rcid' => [
81 ApiBase::PARAM_TYPE => 'integer'
83 'revid' => [
84 ApiBase::PARAM_TYPE => 'integer'
89 public function needsToken() {
90 return 'patrol';
93 protected function getExamplesMessages() {
94 return [
95 'action=patrol&token=123ABC&rcid=230672766'
96 => 'apihelp-patrol-example-rcid',
97 'action=patrol&token=123ABC&revid=230672766'
98 => 'apihelp-patrol-example-revid',
102 public function getHelpUrls() {
103 return 'https://www.mediawiki.org/wiki/API:Patrol';