ApiUserrights.php

Go to the documentation of this file.

<?php

class ApiUserrights extends ApiBase {

    private $mUser = null;

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

        $user = $this->getUrUser( $params );

        $form = new UserrightsPage;
        $form->setContext( $this->getContext() );
        $r['user'] = $user->getName();
        $r['userid'] = $user->getId();
        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( array $params ) {
        if ( $this->mUser !== null ) {
            return $this->mUser;
        }

        $this->requireOnlyOneParameter( $params, 'user', 'userid' );

        $user = isset( $params['user'] ) ? $params['user'] : '#' . $params['userid'];

        $form = new UserrightsPage;
        $form->setContext( $this->getContext() );
        $status = $form->fetchUser( $user );
        if ( !$status->isOK() ) {
            $this->dieStatus( $status );
        }

        $this->mUser = $status->value;

        return $status->value;
    }

    public function mustBePosted() {
        return true;
    }

    public function isWriteMode() {
        return true;
    }

    public function getAllowedParams() {
        return array(
            'user' => array(
                ApiBase::PARAM_TYPE => 'string',
            ),
            'userid' => array(
                ApiBase::PARAM_TYPE => 'integer',
            ),
            'add' => array(
                ApiBase::PARAM_TYPE => User::getAllGroups(),
                ApiBase::PARAM_ISMULTI => true
            ),
            'remove' => array(
                ApiBase::PARAM_TYPE => User::getAllGroups(),
                ApiBase::PARAM_ISMULTI => true
            ),
            'reason' => array(
                ApiBase::PARAM_DFLT => ''
            )
        );
    }

    public function getParamDescription() {
        return array(
            'user' => 'User name',
            'userid' => 'User id',
            'add' => 'Add the user to these groups',
            'remove' => 'Remove the user from these groups',
            'token' => array(
                /* Standard description automatically prepended */
                'For compatibility, the token used in the web UI is also accepted.'
            ),
            'reason' => 'Reason for the change',
        );
    }

    public function getDescription() {
        return 'Add/remove a user to/from groups.';
    }

    public function needsToken() {
        return 'userrights';
    }

    protected function getWebUITokenSalt( array $params ) {
        return $this->getUrUser( $params )->getName();
    }

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

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