* Unbroke Special:Userrights for wikis without pretty URLs
authorRoan Kattouw <catrope@users.mediawiki.org>
Fri, 4 Jan 2008 11:50:22 +0000 (11:50 +0000)
committerRoan Kattouw <catrope@users.mediawiki.org>
Fri, 4 Jan 2008 11:50:22 +0000 (11:50 +0000)
** This probably shouldn't be hard-coded the way I did it
* UserrightsPage::saveUserGroups() now takes $removegroup and $addgroup parameters by reference. Parameters are changed to reflect what was actually added and removed.
* Re-adding ApiChangeRights module, which now handles permission denied errors more gracefully

includes/AutoLoader.php
includes/SpecialUserrights.php
includes/api/ApiChangeRights.php [new file with mode: 0644]
includes/api/ApiMain.php

index 0d1c751..1b328d5 100644 (file)
@@ -349,6 +349,7 @@ function __autoload($className) {
 
                # apiedit branch
                'ApiBlock' => 'includes/api/ApiBlock.php',
+               'ApiChangeRights' => 'includes/api/ApiChangeRights.php',
                'ApiDelete' => 'includes/api/ApiDelete.php',
                'ApiMove' => 'includes/api/ApiMove.php',
                'ApiProtect' => 'includes/api/ApiProtect.php',
index 639ed3a..fb4af20 100644 (file)
@@ -94,7 +94,7 @@ class UserrightsPage extends SpecialPage {
         * @param string $reason Reason for group change
         * @return null
         */
-       function saveUserGroups( $username, $removegroup, $addgroup, $reason = '') {
+       function saveUserGroups( $username, &$removegroup, &$addgroup, $reason = '') {
                $user = $this->fetchUser( $username );
                if( !$user ) {
                        return;
@@ -106,7 +106,11 @@ class UserrightsPage extends SpecialPage {
                        array_intersect( (array)$removegroup, $changeable['remove'] ) );
                $addgroup = array_unique(
                        array_intersect( (array)$addgroup, $changeable['add'] ) );
-
+               
+               // If nothing is changed, no log entry should be created
+               if($removegroup == $addgroup)
+                       return;
+               
                $oldGroups = $user->getGroups();
                $newGroups = $oldGroups;
                // remove then add groups
@@ -241,6 +245,7 @@ class UserrightsPage extends SpecialPage {
        function switchForm() {
                global $wgOut;
                $form  = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $this->getTitle()->escapeLocalURL(), 'name' => 'uluser' ) );
+               $form .= Xml::hidden( 'title',  'Special:Userrights' );
                $form .= '<fieldset><legend>' . wfMsgHtml( 'userrights-lookup-user' ) . '</legend>';
                $form .= '<p>' . Xml::inputLabel( wfMsg( 'userrights-user-editname' ), 'user', 'username', 30, $this->mTarget ) . '</p>';
                $form .= '<p>' . Xml::submitButton( wfMsg( 'editusergroup' ) ) . '</p>';
@@ -288,6 +293,7 @@ class UserrightsPage extends SpecialPage {
                $wgOut->addHTML(
                        Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getTitle()->escapeLocalURL(), 'name' => 'editGroup' ) ) .
                        Xml::hidden( 'user', $user->getName() ) .
+                       Xml::hidden( 'title', 'Special:Userrights' ) .
                        Xml::hidden( 'wpEditToken', $wgUser->editToken( $user->getName() ) ) .
                        Xml::openElement( 'fieldset' ) .
                        Xml::element( 'legend', array(), wfMsg( 'userrights-editusergroup' ) ) .
diff --git a/includes/api/ApiChangeRights.php b/includes/api/ApiChangeRights.php
new file mode 100644 (file)
index 0000000..6d349f8
--- /dev/null
@@ -0,0 +1,145 @@
+<?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
+               if(is_null($params['user']))\r
+                       $this->dieUsage('The user parameter must be set', 'nouser');\r
+\r
+               $uName = User::getCanonicalName($params['user']);\r
+               $u = User::newFromName($uName);\r
+               if(!$u)\r
+                       $this->dieUsage("Invalid username ``{$params['user']}''", 'invaliduser');\r
+               if($u->getId() == 0) // Anon or non-existent\r
+                       $this->dieUsage("User ``{$params['user']}'' doesn't exist", 'nosuchuser');\r
+\r
+               $curgroups = $u->getGroups();\r
+\r
+               if($params['listgroups'])\r
+               {\r
+                       $res['user'] = $uName;\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($uName);\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'], $uName))\r
+                       $this->dieUsage('Invalid token', 'badtoken');\r
+\r
+               $dbw = wfGetDb(DB_MASTER);\r
+               $dbw->begin();\r
+               $ur->saveUserGroups($uName, $params['rmfrom'], $params['addto'], $params['reason']);\r
+               $dbw->commit();\r
+               $res['user'] = $uName;\r
+               $res['addedto'] = $params['addto'];\r
+               $res['removedfrom'] = $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
index 5509c31..9c9ce5c 100644 (file)
@@ -69,7 +69,8 @@ class ApiMain extends ApiBase {
                'protect' => 'ApiProtect',
                'block' => 'ApiBlock',
                'unblock' => 'ApiUnblock',
-               'move' => 'ApiMove'
+               'move' => 'ApiMove',
+               'changerights' => 'ApiChangeRights'
        );
 
        /**