fdddf94570
The current token handling is a mess. This simplifies things greatly: * *All* tokens are obtained from action=query&meta=tokens, rather than being spread over action=tokens, action=query&prop=info, action=query&prop=revisions, action=query&prop=recentchanges, and action=query&prop=users. All these old methods are deprecated. * Similarly, there is only one hook to register new token types. All old hooks are deprecated. * All tokens are cacheable. * Most token types are dropped in favor of a 'csrf' token. They already were returning the same token anyway. * All token-using modules will document the required token type in a standard manner in action=help and are documented in machine-readable fashion in action=paraminfo. Note this will require updates to all extensions using tokens. Change-Id: I2793a3f2dd64a4bebb0b4d065e09af1e9f63fb89
114 lines
2.8 KiB
PHP
114 lines
2.8 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 {
|
|
|
|
/**
|
|
* 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(
|
|
'rcid' => array(
|
|
ApiBase::PARAM_TYPE => 'integer'
|
|
),
|
|
'revid' => array(
|
|
ApiBase::PARAM_TYPE => 'integer'
|
|
),
|
|
);
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
return array(
|
|
'rcid' => 'Recentchanges ID to patrol',
|
|
'revid' => 'Revision ID to patrol',
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Patrol a page or revision.';
|
|
}
|
|
|
|
public function needsToken() {
|
|
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';
|
|
}
|
|
}
|