114 lines
2.7 KiB
PHP
114 lines
2.7 KiB
PHP
<?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 {
|
|
|
|
public function __construct( $main, $action ) {
|
|
parent::__construct( $main, $action );
|
|
}
|
|
|
|
/**
|
|
* Patrols the article or provides the reason the patrol failed.
|
|
*/
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
|
|
$rc = RecentChange::newFromID( $params['rcid'] );
|
|
if ( !$rc instanceof RecentChange ) {
|
|
$this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
|
|
}
|
|
$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' => null,
|
|
'rcid' => array(
|
|
ApiBase::PARAM_TYPE => 'integer',
|
|
ApiBase::PARAM_REQUIRED => true
|
|
),
|
|
);
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
return array(
|
|
'token' => 'Patrol token obtained from list=recentchanges',
|
|
'rcid' => 'Recentchanges ID to patrol',
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Patrol a page or revision';
|
|
}
|
|
|
|
public function getPossibleErrors() {
|
|
return array_merge( parent::getPossibleErrors(), array(
|
|
array( 'nosuchrcid', 'rcid' ),
|
|
) );
|
|
}
|
|
|
|
public function needsToken() {
|
|
return true;
|
|
}
|
|
|
|
public function getTokenSalt() {
|
|
return 'patrol';
|
|
}
|
|
|
|
public function getExamples() {
|
|
return array(
|
|
'api.php?action=patrol&token=123abc&rcid=230672766'
|
|
);
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/API:Patrol';
|
|
}
|
|
|
|
public function getVersion() {
|
|
return __CLASS__ . ': $Id$';
|
|
}
|
|
}
|