ApiUserrights.php

Go to the documentation of this file.

<?php

class ApiUserrights extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        private $mUser = null;

        public function execute() {
                $params = $this->extractRequestParams();

                $user = $this->getUrUser();

                $form = new UserrightsPage;
                $r['user'] = $user->getName();
                list( $r['added'], $r['removed'] ) =
                        $form->doSaveUserGroups(
                                $user, (array)$params['add'],
                                (array)$params['remove'], $params['reason'] );

                $result = $this->getResult();
                $result->setIndexedTagName( $r['added'], 'group' );
                $result->setIndexedTagName( $r['removed'], 'group' );
                $result->addValue( null, $this->getModuleName(), $r );
        }

        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() {
                return true;
        }

        public function isWriteMode() {
                return true;
        }

        public function getAllowedParams() {
                return array (
                        'user' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        '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 'Add/remove a user to/from groups';
        }

        public function needsToken() {
                return true;
        }

        public function getTokenSalt() {
                return $this->getUrUser()->getName();
        }

        public function getExamples() {
                return array(
                        'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:User_group_membership';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}