summaryrefslogtreecommitdiff
path: root/includes/api/ApiChangeRights.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/api/ApiChangeRights.php')
-rw-r--r--includes/api/ApiChangeRights.php155
1 files changed, 0 insertions, 155 deletions
diff --git a/includes/api/ApiChangeRights.php b/includes/api/ApiChangeRights.php
deleted file mode 100644
index 647a5194..00000000
--- a/includes/api/ApiChangeRights.php
+++ /dev/null
@@ -1,155 +0,0 @@
-<?php
-
-/*
- * Created on Sep 11, 2007
- * API for MediaWiki 1.8+
- *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
- *
- * 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')) {
- // Eclipse helper - will be ignored in production
- require_once ("ApiBase.php");
-}
-
-/**
- * API module that facilitates the changing of user rights. The API eqivalent of
- * Special:Userrights. Requires API write mode to be enabled.
- *
- * @addtogroup API
- */
-class ApiChangeRights extends ApiBase {
-
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
- }
-
- public function execute() {
- global $wgUser, $wgRequest;
- $this->getMain()->requestWriteMode();
-
- if(wfReadOnly())
- $this->dieUsage('The wiki is in read-only mode', 'readonly');
- $params = $this->extractRequestParams();
-
- $ur = new UserrightsPage($wgRequest);
- $allowed = $ur->changeableGroups();
- $res = array();
-
- $u = $ur->fetchUser_real($params['user']);
- if(is_array($u))
- switch($u[0])
- {
- case UserrightsPage::FETCHUSER_NO_INTERWIKI:
- $this->dieUsage("You don't have permission to change users' rights on other wikis", 'nointerwiki');
- case UserrightsPage::FETCHUSER_NO_DATABASE:
- $this->dieUsage("Database ``{$u[1]}'' does not exist or is not local", 'nosuchdatabase');
- case UserrightsPage::FETCHUSER_NO_USER:
- $this->dieUsage("You specified an empty username, or none at all", 'emptyuser');
- case UserrightsPage::FETCHUSER_NOSUCH_USERID:
- $this->dieUsage("There is no user with ID ``{$u[1]}''", 'nosuchuserid');
- case UserrightsPage::FETCHUSER_NOSUCH_USERNAME:
- $this->dieUsage("There is no user with username ``{$u[1]}''", 'nosuchusername');
- default:
- $this->dieDebug(__METHOD__, "UserrightsPage::fetchUser_real() returned an unknown error ({$u[0]})");
- }
-
- $curgroups = $u->getGroups();
- if($params['listgroups'])
- {
- $res['user'] = $u->getName();
- $res['allowedgroups'] = $allowed;
- $res['ingroups'] = $curgroups;
- $this->getResult()->setIndexedTagName($res['ingroups'], 'group');
- $this->getResult()->setIndexedTagName($res['allowedgroups']['add'], 'group');
- $this->getResult()->setIndexedTagName($res['allowedgroups']['remove'], 'group');
- }
-;
- if($params['gettoken'])
- {
- $res['changerightstoken'] = $wgUser->editToken($u->getName());
- $this->getResult()->addValue(null, $this->getModuleName(), $res);
- return;
- }
-
- if(empty($params['addto']) && empty($params['rmfrom']))
- $this->dieUsage('At least one of the addto and rmfrom parameters must be set', 'noaddrm');
- if(is_null($params['token']))
- $this->dieUsage('The token parameter must be set', 'notoken');
- if(!$wgUser->matchEditToken($params['token'], $u->getName()))
- $this->dieUsage('Invalid token', 'badtoken');
-
- $dbw = wfGetDb(DB_MASTER);
- $dbw->begin();
- $ur->saveUserGroups($u, $params['rmfrom'], $params['addto'], $params['reason']);
- $dbw->commit();
- $res['user'] = $u->getName();
- $res['addedto'] = (array)$params['addto'];
- $res['removedfrom'] = (array)$params['rmfrom'];
- $res['reason'] = $params['reason'];
-
- $this->getResult()->setIndexedTagName($res['addedto'], 'group');
- $this->getResult()->setIndexedTagName($res['removedfrom'], 'group');
- $this->getResult()->addValue(null, $this->getModuleName(), $res);
- }
-
- public function getAllowedParams() {
- return array (
- 'user' => null,
- 'token' => null,
- 'gettoken' => false,
- 'listgroups' => false,
- 'addto' => array(
- ApiBase :: PARAM_ISMULTI => true,
- ),
- 'rmfrom' => array(
- ApiBase :: PARAM_ISMULTI => true,
- ),
- 'reason' => ''
- );
- }
-
- public function getParamDescription() {
- return array (
- 'user' => 'The user you want to add to or remove from groups.',
- 'token' => 'A changerights token previously obtained through the gettoken parameter.',
- 'gettoken' => 'Output a token. Note that the user parameter still has to be set.',
- 'listgroups' => 'List the groups the user is in, and the ones you can add them to and remove them from.',
- 'addto' => 'Pipe-separated list of groups to add this user to',
- 'rmfrom' => 'Pipe-separated list of groups to remove this user from',
- 'reason' => 'Reason for change (optional)'
- );
- }
-
- public function getDescription() {
- return array(
- 'Add or remove a user from certain groups.'
- );
- }
-
- protected function getExamples() {
- return array (
- 'api.php?action=changerights&user=Bob&gettoken&listgroups',
- 'api.php?action=changerights&user=Bob&token=123ABC&addto=sysop&reason=Promoting%20per%20RFA'
- );
- }
-
- public function getVersion() {
- return __CLASS__ . ': $Id: ApiChangeRights.php 28216 2007-12-06 18:33:18Z vasilievvv $';
- }
-}