diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2009-02-22 13:37:51 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2009-02-22 13:37:51 +0100 |
commit | b9b85843572bf283f48285001e276ba7e61b63f6 (patch) | |
tree | 4c6f4571552ada9ccfb4030481dcf77308f8b254 /includes/api/ApiPatrol.php | |
parent | d9a20acc4e789cca747ad360d87ee3f3e7aa58c1 (diff) |
updated to MediaWiki 1.14.0
Diffstat (limited to 'includes/api/ApiPatrol.php')
-rw-r--r-- | includes/api/ApiPatrol.php | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/includes/api/ApiPatrol.php b/includes/api/ApiPatrol.php new file mode 100644 index 00000000..08de87b0 --- /dev/null +++ b/includes/api/ApiPatrol.php @@ -0,0 +1,99 @@ +<?php + +/* + * Created on Sep 2, 2008 + * + * API for MediaWiki 1.14+ + * + * Copyright (C) 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., + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * http://www.gnu.org/copyleft/gpl.html + */ + +if (!defined('MEDIAWIKI')) { + require_once ('ApiBase.php'); +} + +/** + * 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() { + global $wgUser, $wgUseRCPatrol, $wgUseNPPatrol; + $this->getMain()->requestWriteMode(); + $params = $this->extractRequestParams(); + + if(!isset($params['token'])) + $this->dieUsageMsg(array('missingparam', 'token')); + if(!isset($params['rcid'])) + $this->dieUsageMsg(array('missingparam', 'rcid')); + if(!$wgUser->matchEditToken($params['token'])) + $this->dieUsageMsg(array('sessionfailure')); + + $rc = RecentChange::newFromID($params['rcid']); + if(!$rc instanceof RecentChange) + $this->dieUsageMsg(array('nosuchrcid', $params['rcid'])); + $retval = RecentChange::markPatrolled($params['rcid']); + + if($retval) + $this->dieUsageMsg(current($retval)); + + $result = array('rcid' => $rc->getAttribute('rc_id')); + ApiQueryBase::addTitleInfo($result, $rc->getTitle()); + $this->getResult()->addValue(null, $this->getModuleName(), $result); + } + + public function getAllowedParams() { + return array ( + 'token' => null, + 'rcid' => array( + ApiBase :: PARAM_TYPE => 'integer' + ), + ); + } + + public function getParamDescription() { + return array ( + 'token' => 'Patrol token obtained from list=recentchanges', + 'rcid' => 'Recentchanges ID to patrol', + ); + } + + public function getDescription() { + return array ( + 'Patrol a page or revision. ' + ); + } + + protected function getExamples() { + return array( + 'api.php?action=patrol&token=123abc&rcid=230672766' + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id: ApiPatrol.php 42548 2008-10-25 14:04:43Z tstarling $'; + } +} |