MediaWiki 1.16.0

[autoinstallsdev/mediawiki.git] / includes / api / ApiUserrights.php

diff --git a/includes/api/ApiUserrights.php b/includes/api/ApiUserrights.php
new file mode 100644 (file)
index 0000000..6296a8f
--- /dev/null
+++ b/includes/api/ApiUserrights.php
@@ -0,0 +1,128 @@
+<?php
+
+/*
+ * Created on Mar 24, 2009
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2009 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" );
+}
+
+/**
+ * @ingroup API
+ */
+class ApiUserrights extends ApiBase {
+
+       public function __construct( $main, $action ) {
+               parent :: __construct( $main, $action );
+       }
+
+       public function execute() {
+               $params = $this->extractRequestParams();
+               
+               // User already validated in call to getTokenSalt from Main
+               $form = new UserrightsPage;
+               $user = $form->fetchUser( $params['user'] );
+               
+               $r['user'] = $user->getName();
+               list( $r['added'], $r['removed'] ) =
+                       $form->doSaveUserGroups(
+                               $user, (array)$params['add'],
+                               (array)$params['remove'], $params['reason'] );
+
+               $this->getResult()->setIndexedTagName( $r['added'], 'group' );
+               $this->getResult()->setIndexedTagName( $r['removed'], 'group' );
+               $this->getResult()->addValue( null, $this->getModuleName(), $r );
+       }
+
+       public function mustBePosted() {
+               return true;
+       }
+
+       public function isWriteMode() {
+               return true;
+       }
+
+       public function getAllowedParams() {
+               return array (
+                       'user' => null,
+                       'add' => array(
+                               ApiBase :: PARAM_TYPE => User::getAllGroups(),
+                               ApiBase :: PARAM_ISMULTI => true
+                       ),
+                       'remove' => array(
+                               ApiBase :: PARAM_TYPE => User::getAllGroups(),
+                               ApiBase :: PARAM_ISMULTI => true
+                       ),
+                       'token' => null,
+                       'reason' => array(
+                               ApiBase :: PARAM_DFLT => ''
+                       )
+               );
+       }
+
+       public function getParamDescription() {
+               return array (
+                       'user' => 'User name',
+                       'add' => 'Add the user to these groups',
+                       'remove' => 'Remove the user from these groups',
+                       'token' => 'A userrights token previously retrieved through list=users',
+                       'reason' => 'Reason for the change',
+               );
+       }
+
+       public function getDescription() {
+               return array(
+                       'Add/remove a user to/from groups',
+               );
+       }
+       
+    public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'missingparam', 'user' ),
+        ) );
+       }
+       
+       public function getTokenSalt() {
+               $params = $this->extractRequestParams();
+               if ( is_null( $params['user'] ) )
+                       $this->dieUsageMsg( array( 'missingparam', 'user' ) );
+
+               $form = new UserrightsPage;
+               $user = $form->fetchUser( $params['user'] );
+               if ( $user instanceof WikiErrorMsg )
+                       $this->dieUsageMsg( array_merge(
+                               (array)$user->getMessageKey(), $user->getMessageArgs() ) );
+
+               return $user->getName();
+       }
+
+       protected function getExamples() {
+               return array (
+                       'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
+               );
+       }
+
+       public function getVersion() {
+               return __CLASS__ . ': $Id: ApiUserrights.php 62686 2010-02-19 01:25:57Z reedy $';
+       }
+}