wiki.techinc.nl/includes/api/ApiPatrol.php
Brad Jorsch 4e6810e4a2 API: i18n for warnings and errors
API warnings and error messages are currently hard-coded English
strings. This patch changes that.

With a few exceptions, this patch should be compatible with non-updated
extensions:
* The change to ApiBase::$messageMap will blow up anything trying to
  mess with it.
* The changes to the 'ApiCheckCanExecute' hook will cause a wrong
  (probably unparsed) error message to be emitted for extensions not
  already using an ApiMessage. Unless they're currently broken like
  Wikibase.

Bug: T37074
Bug: T47843
Depends-On: Ia2b66b57cd4eaddc30b3ffdd7b97d6ca3e02d898
Depends-On: I2e1bb975bb0045476c03ebe6cdec00259bae22ec
Depends-On: I53987bf87c48f6c00deec17a8e957d24fcc3eaa6
Depends-On: Ibf93a459eb62d30f7c70d20e91ec9faeb80d10ed
Depends-On: I3cf889811f44a15935e454dd42f081164d4a098c
Depends-On: Ieae527de86735ddcba34724730e8730fb277b99b
Depends-On: I535344c29d51521147c2a26c341dae38cec3e931
Change-Id: Iae0e2ce3bd42dd4776a9779664086119ac188412
2016-12-06 10:20:48 -05:00

117 lines
3 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->dieWithError( [ 'apierror-nosuchrcid', $params['rcid'] ] );
}
} else {
$rev = Revision::newFromId( $params['revid'] );
if ( !$rev ) {
$this->dieWithError( [ 'apierror-nosuchrevid', $params['revid'] ] );
}
$rc = $rev->getRecentChange();
if ( !$rc ) {
$this->dieWithError( [ 'apierror-notpatrollable', $params['revid'] ] );
}
}
$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->dieStatus( $this->errorArrayToStatus( $retval, $user ) );
}
$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';
}
}