Partial fix of bug 12533
authorRoan Kattouw <catrope@users.mediawiki.org>
Tue, 8 Jan 2008 15:35:11 +0000 (15:35 +0000)
committerRoan Kattouw <catrope@users.mediawiki.org>
Tue, 8 Jan 2008 15:35:11 +0000 (15:35 +0000)
includes/api/ApiChangeRights.php

index 2bfcbf1..395f1c9 100644 (file)
-<?php\r
-\r
-/*\r
- * Created on Sep 11, 2007\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
-       // Eclipse helper - will be ignored in production\r
-       require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiChangeRights extends ApiBase {\r
-\r
-       public function __construct($main, $action) {\r
-               parent :: __construct($main, $action);\r
-       }\r
-\r
-       public function execute() {\r
-               global $wgUser, $wgRequest;\r
-               $this->getMain()->requestWriteMode();\r
-               \r
-               if(wfReadOnly())\r
-                       $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
-               $params = $this->extractRequestParams();\r
-\r
-               $ur = new UserrightsPage($wgRequest);\r
-               $allowed = $ur->changeableGroups();\r
-               $res = array();\r
-               \r
-               $u = $ur->fetchUser_real($params['user']);\r
-               if(is_array($u))\r
-                       switch($u[0])\r
-                       {\r
-                               case UserrightsPage::FETCHUSER_NO_INTERWIKI:\r
-                                       $this->dieUsage("You don't have permission to change users' rights on other wikis", 'nointerwiki');\r
-                               case UserrightsPage::FETCHUSER_NO_DATABASE:\r
-                                       $this->dieUsage("Database ``{$u[1]}'' does not exist or is not local", 'nosuchdatabase');\r
-                               case UserrightsPage::FETCHUSER_NO_USER:\r
-                                       $this->dieUsage("You specified an empty username, or none at all", 'emptyuser');\r
-                               case UserrightsPage::FETCHUSER_NOSUCH_USERID:\r
-                                       $this->dieUsage("There is no user with ID ``{$u[1]}''", 'nosuchuserid');\r
-                               case UserrightsPage::FETCHUSER_NOSUCH_USERNAME:\r
-                                       $this->dieUsage("There is no user with username ``{$u[1]}''", 'nosuchusername');\r
-                               default:\r
-                                       $this->dieDebug(__METHOD__, "UserrightsPage::fetchUser_real() returned an unknown error ({$u[0]})");\r
-                       }\r
-\r
-               $curgroups = $u->getGroups();\r
-               if($params['listgroups'])\r
-               {\r
-                       $res['user'] = $u->getName();\r
-                       $res['allowedgroups'] = $allowed;\r
-                       $res['ingroups'] = $curgroups;\r
-                       $this->getResult()->setIndexedTagName($res['ingroups'], 'group');\r
-                       $this->getResult()->setIndexedTagName($res['allowedgroups']['add'], 'group');\r
-                       $this->getResult()->setIndexedTagName($res['allowedgroups']['remove'], 'group');\r
-               }\r
-;\r
-               if($params['gettoken'])\r
-               {\r
-                       $res['changerightstoken'] = $wgUser->editToken($u->getName());\r
-                       $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
-                       return;\r
-               }\r
-\r
-               if(empty($params['addto']) && empty($params['rmfrom']))\r
-                       $this->dieUsage('At least one of the addto and rmfrom parameters must be set', 'noaddrm');\r
-               if(is_null($params['token']))\r
-                       $this->dieUsage('The token parameter must be set', 'notoken');\r
-               if(!$wgUser->matchEditToken($params['token'], $u->getName()))\r
-                       $this->dieUsage('Invalid token', 'badtoken');\r
-\r
-               $dbw = wfGetDb(DB_MASTER);\r
-               $dbw->begin();\r
-               $ur->saveUserGroups($u, $params['rmfrom'], $params['addto'], $params['reason']);\r
-               $dbw->commit();\r
-               $res['user'] = $u->getName();\r
-               $res['addedto'] = (array)$params['addto'];\r
-               $res['removedfrom'] = (array)$params['rmfrom'];\r
-               $res['reason'] = $params['reason'];\r
-\r
-               $this->getResult()->setIndexedTagName($res['addedto'], 'group');\r
-               $this->getResult()->setIndexedTagName($res['removedfrom'], 'group');\r
-               $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
-       }\r
-\r
-       protected function getAllowedParams() {\r
-               return array (\r
-                       'user' => null,\r
-                       'token' => null,\r
-                       'gettoken' => false,\r
-                       'listgroups' => false,\r
-                       'addto' => array(\r
-                               ApiBase :: PARAM_ISMULTI => true,\r
-                       ),\r
-                       'rmfrom' => array(\r
-                               ApiBase :: PARAM_ISMULTI => true,\r
-                       ),\r
-                       'reason' => ''\r
-               );\r
-       }\r
-\r
-       protected function getParamDescription() {\r
-               return array (\r
-                       'user' => 'The user you want to add to or remove from groups.',\r
-                       'token' => 'A changerights token previously obtained through the gettoken parameter.',\r
-                       'gettoken' => 'Output a token. Note that the user parameter still has to be set.',\r
-                       'listgroups' => 'List the groups the user is in, and the ones you can add them to and remove them from.',\r
-                       'addto' => 'Pipe-separated list of groups to add this user to',\r
-                       'rmfrom' => 'Pipe-separated list of groups to remove this user from',\r
-                       'reason' => 'Reason for change (optional)'\r
-               );\r
-       }\r
-\r
-       protected function getDescription() {\r
-               return array(\r
-                       'Add or remove a user from certain groups.'\r
-               );\r
-       }\r
-\r
-       protected function getExamples() {\r
-               return array (\r
-                       'api.php?action=changerights&user=Bob&gettoken&listgroups',\r
-                       'api.php?action=changerights&user=Bob&token=123ABC&addto=sysop&reason=Promoting%20per%20RFA'\r
-               );\r
-       }\r
-\r
-       public function getVersion() {\r
-               return __CLASS__ . ': $Id: ApiChangeRights.php 28216 2007-12-06 18:33:18Z vasilievvv $';\r
-       }\r
-}\r
+<?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");
+}
+
+/**
+ * @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);
+       }
+
+       protected 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' => ''
+               );
+       }
+
+       protected 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)'
+               );
+       }
+
+       protected 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 $';
+       }
+}