Added parser test about brackets and for bug 21261

[lhc/web/wiklou.git] / includes / api / ApiUserrights.php

diff --git a/includes/api/ApiUserrights.php b/includes/api/ApiUserrights.php
index 377fd74..6b6bbf8 100644 (file)
--- a/includes/api/ApiUserrights.php
+++ b/includes/api/ApiUserrights.php
@@ -1,10 +1,11 @@
 <?php
 
-/*
+/**
+ *
+ *
  * Created on Mar 24, 2009
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@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
@@ -18,40 +19,62 @@
  *
  * 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.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-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 );
+               parent::__construct( $main, $action );
        }
 
+       private $mUser = null;
+
        public function execute() {
                $params = $this->extractRequestParams();
-               
-               // User already validated in call to getTokenSalt from Main
+
+               $user = $this->getUrUser();
+
                $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 );
+               $result = $this->getResult();
+               $result->setIndexedTagName( $r['added'], 'group' );
+               $result->setIndexedTagName( $r['removed'], 'group' );
+               $result->addValue( null, $this->getModuleName(), $r );
+       }
+
+       /**
+        * @return User
+        */
+       private function getUrUser() {
+               if ( $this->mUser !== null ) {
+                       return $this->mUser;
+               }
+
+               $params = $this->extractRequestParams();
+
+               $form = new UserrightsPage;
+               $status = $form->fetchUser( $params['user'] );
+               if ( !$status->isOK() ) {
+                       $errors = $status->getErrorsArray();
+                       $this->dieUsageMsg( $errors[0] );
+               } else {
+                       $user = $status->value;
+               }
+
+               $this->mUser = $user;
+               return $user;
        }
 
        public function mustBePosted() {
@@ -64,24 +87,27 @@ class ApiUserrights extends ApiBase {
 
        public function getAllowedParams() {
                return array (
-                       'user' => null,
+                       'user' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'add' => array(
-                               ApiBase :: PARAM_TYPE => User::getAllGroups(),
-                               ApiBase :: PARAM_ISMULTI => true
+                               ApiBase::PARAM_TYPE => User::getAllGroups(),
+                               ApiBase::PARAM_ISMULTI => true
                        ),
                        'remove' => array(
-                               ApiBase :: PARAM_TYPE => User::getAllGroups(),
-                               ApiBase :: PARAM_ISMULTI => true
+                               ApiBase::PARAM_TYPE => User::getAllGroups(),
+                               ApiBase::PARAM_ISMULTI => true
                        ),
                        'token' => null,
                        'reason' => array(
-                               ApiBase :: PARAM_DFLT => ''
+                               ApiBase::PARAM_DFLT => ''
                        )
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'user' => 'User name',
                        'add' => 'Add the user to these groups',
                        'remove' => 'Remove the user from these groups',
@@ -91,37 +117,27 @@ class ApiUserrights extends ApiBase {
        }
 
        public function getDescription() {
-               return array(
-                       'Add/remove a user to/from groups',
-               );
-       }
-       
-    public function getPossibleErrors() {
-               return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'user' ),
-        ) );
+               return 'Add/remove a user to/from groups';
        }
-       
-       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() ) );
+       public function needsToken() {
+               return true;
+       }
 
-               return $user->getName();
+       public function getTokenSalt() {
+               return $this->getUrUser()->getName();
        }
 
-       protected function getExamples() {
-               return array (
+       public function getExamples() {
+               return array(
                        'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
                );
        }
 
+       public function getHelpUrls() {
+               return 'http://www.mediawiki.org/wiki/API:User_group_membership';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }