SpecialUserrights.php

Go to the documentation of this file.

<?php
class UserrightsPage extends SpecialPage {
    protected $mTarget;
    /*
     * @var null|User $mFetchedUser The user object of the target username or null.
     */
    protected $mFetchedUser = null;
    protected $isself = false;

    public function __construct() {
        parent::__construct( 'Userrights' );
    }

    public function doesWrites() {
        return true;
    }

    public function isRestricted() {
        return true;
    }

    public function userCanExecute( User $user ) {
        return $this->userCanChangeRights( $user, false );
    }

    public function userCanChangeRights( $user, $checkIfSelf = true ) {
        $available = $this->changeableGroups();
        if ( $user->getId() == 0 ) {
            return false;
        }

        return !empty( $available['add'] )
            || !empty( $available['remove'] )
            || ( ( $this->isself || !$checkIfSelf ) &&
                ( !empty( $available['add-self'] )
                    || !empty( $available['remove-self'] ) ) );
    }

    public function execute( $par ) {
        // If the visitor doesn't have permissions to assign or remove
        // any groups, it's a bit silly to give them the user search prompt.

        $user = $this->getUser();
        $request = $this->getRequest();
        $out = $this->getOutput();

        /*
         * If the user is blocked and they only have "partial" access
         * (e.g. they don't have the userrights permission), then don't
         * allow them to use Special:UserRights.
         */
        if ( $user->isBlocked() && !$user->isAllowed( 'userrights' ) ) {
            throw new UserBlockedError( $user->getBlock() );
        }

        if ( $par !== null ) {
            $this->mTarget = $par;
        } else {
            $this->mTarget = $request->getVal( 'user' );
        }

        if ( is_string( $this->mTarget ) ) {
            $this->mTarget = trim( $this->mTarget );
        }

        $available = $this->changeableGroups();

        if ( $this->mTarget === null ) {
            /*
             * If the user specified no target, and they can only
             * edit their own groups, automatically set them as the
             * target.
             */
            if ( !count( $available['add'] ) && !count( $available['remove'] ) ) {
                $this->mTarget = $user->getName();
            }
        }

        if ( $this->mTarget !== null && User::getCanonicalName( $this->mTarget ) === $user->getName() ) {
            $this->isself = true;
        }

        $fetchedStatus = $this->fetchUser( $this->mTarget );
        if ( $fetchedStatus->isOK() ) {
            $this->mFetchedUser = $fetchedStatus->value;
            if ( $this->mFetchedUser instanceof User ) {
                // Set the 'relevant user' in the skin, so it displays links like Contributions,
                // User logs, UserRights, etc.
                $this->getSkin()->setRelevantUser( $this->mFetchedUser );
            }
        }

        if ( !$this->userCanChangeRights( $user, true ) ) {
            if ( $this->isself && $request->getCheck( 'success' ) ) {
                // bug 48609: if the user just removed its own rights, this would
                // leads it in a "permissions error" page. In that case, show a
                // message that it can't anymore use this page instead of an error
                $this->setHeaders();
                $out->wrapWikiMsg( "<div class=\"successbox\">\n$1\n</div>", 'userrights-removed-self' );
                $out->returnToMain();

                return;
            }

            // @todo FIXME: There may be intermediate groups we can mention.
            $msg = $user->isAnon() ? 'userrights-nologin' : 'userrights-notallowed';
            throw new PermissionsError( null, [ [ $msg ] ] );
        }

        // show a successbox, if the user rights was saved successfully
        if ( $request->getCheck( 'success' ) && $this->mFetchedUser !== null ) {
            $out->addModules( [ 'mediawiki.special.userrights' ] );
            $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
            $out->addHTML(
                Html::rawElement(
                    'div',
                    [
                        'class' => 'mw-notify-success successbox',
                        'id' => 'mw-preferences-success',
                        'data-mw-autohide' => 'false',
                    ],
                    Html::element(
                        'p',
                        [],
                        $this->msg( 'savedrights', $this->mFetchedUser->getName() )->text()
                    )
                )
            );
        }

        $this->checkReadOnly();

        $this->setHeaders();
        $this->outputHeader();

        $out->addModuleStyles( 'mediawiki.special' );
        $this->addHelpLink( 'Help:Assigning permissions' );

        // show the general form
        if ( count( $available['add'] ) || count( $available['remove'] ) ) {
            $this->switchForm();
        }

        if (
            $request->wasPosted() &&
            $request->getCheck( 'saveusergroups' ) &&
            $this->mTarget !== null &&
            $user->matchEditToken( $request->getVal( 'wpEditToken' ), $this->mTarget )
        ) {
            // save settings
            if ( !$fetchedStatus->isOK() ) {
                $this->getOutput()->addWikiText( $fetchedStatus->getWikiText() );

                return;
            }

            $targetUser = $this->mFetchedUser;
            if ( $targetUser instanceof User ) { // UserRightsProxy doesn't have this method (bug 61252)
                $targetUser->clearInstanceCache(); // bug 38989
            }

            if ( $request->getVal( 'conflictcheck-originalgroups' )
                !== implode( ',', $targetUser->getGroups() )
            ) {
                $out->addWikiMsg( 'userrights-conflict' );
            } else {
                $this->saveUserGroups(
                    $this->mTarget,
                    $request->getVal( 'user-reason' ),
                    $targetUser
                );

                $out->redirect( $this->getSuccessURL() );

                return;
            }
        }

        // show some more forms
        if ( $this->mTarget !== null ) {
            $this->editUserGroupsForm( $this->mTarget );
        }
    }

    function getSuccessURL() {
        return $this->getPageTitle( $this->mTarget )->getFullURL( [ 'success' => 1 ] );
    }

    function saveUserGroups( $username, $reason, $user ) {
        $allgroups = $this->getAllGroups();
        $addgroup = [];
        $removegroup = [];

        // This could possibly create a highly unlikely race condition if permissions are changed between
        //  when the form is loaded and when the form is saved. Ignoring it for the moment.
        foreach ( $allgroups as $group ) {
            // We'll tell it to remove all unchecked groups, and add all checked groups.
            // Later on, this gets filtered for what can actually be removed
            if ( $this->getRequest()->getCheck( "wpGroup-$group" ) ) {
                $addgroup[] = $group;
            } else {
                $removegroup[] = $group;
            }
        }

        $this->doSaveUserGroups( $user, $addgroup, $removegroup, $reason );
    }

    function doSaveUserGroups( $user, $add, $remove, $reason = '' ) {
        // Validate input set...
        $isself = $user->getName() == $this->getUser()->getName();
        $groups = $user->getGroups();
        $changeable = $this->changeableGroups();
        $addable = array_merge( $changeable['add'], $isself ? $changeable['add-self'] : [] );
        $removable = array_merge( $changeable['remove'], $isself ? $changeable['remove-self'] : [] );

        $remove = array_unique(
            array_intersect( (array)$remove, $removable, $groups ) );
        $add = array_unique( array_diff(
            array_intersect( (array)$add, $addable ),
            $groups )
        );

        $oldGroups = $user->getGroups();
        $newGroups = $oldGroups;

        // Remove then add groups
        if ( $remove ) {
            foreach ( $remove as $index => $group ) {
                if ( !$user->removeGroup( $group ) ) {
                    unset( $remove[$index] );
                }
            }
            $newGroups = array_diff( $newGroups, $remove );
        }
        if ( $add ) {
            foreach ( $add as $index => $group ) {
                if ( !$user->addGroup( $group ) ) {
                    unset( $add[$index] );
                }
            }
            $newGroups = array_merge( $newGroups, $add );
        }
        $newGroups = array_unique( $newGroups );

        // Ensure that caches are cleared
        $user->invalidateCache();

        // update groups in external authentication database
        Hooks::run( 'UserGroupsChanged', [ $user, $add, $remove, $this->getUser(), $reason ] );
        MediaWiki\Auth\AuthManager::callLegacyAuthPlugin(
            'updateExternalDBGroups', [ $user, $add, $remove ]
        );

        wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) . "\n" );
        wfDebug( 'newGroups: ' . print_r( $newGroups, true ) . "\n" );
        // Deprecated in favor of UserGroupsChanged hook
        Hooks::run( 'UserRights', [ &$user, $add, $remove ], '1.26' );

        if ( $newGroups != $oldGroups ) {
            $this->addLogEntry( $user, $oldGroups, $newGroups, $reason );
        }

        return [ $add, $remove ];
    }

    function addLogEntry( $user, $oldGroups, $newGroups, $reason ) {
        $logEntry = new ManualLogEntry( 'rights', 'rights' );
        $logEntry->setPerformer( $this->getUser() );
        $logEntry->setTarget( $user->getUserPage() );
        $logEntry->setComment( $reason );
        $logEntry->setParameters( [
            '4::oldgroups' => $oldGroups,
            '5::newgroups' => $newGroups,
        ] );
        $logid = $logEntry->insert();
        $logEntry->publish( $logid );
    }

    function editUserGroupsForm( $username ) {
        $status = $this->fetchUser( $username );
        if ( !$status->isOK() ) {
            $this->getOutput()->addWikiText( $status->getWikiText() );

            return;
        } else {
            $user = $status->value;
        }

        $groups = $user->getGroups();

        $this->showEditUserGroupsForm( $user, $groups );

        // This isn't really ideal logging behavior, but let's not hide the
        // interwiki logs if we're using them as is.
        $this->showLogFragment( $user, $this->getOutput() );
    }

    public function fetchUser( $username ) {
        $parts = explode( $this->getConfig()->get( 'UserrightsInterwikiDelimiter' ), $username );
        if ( count( $parts ) < 2 ) {
            $name = trim( $username );
            $database = '';
        } else {
            list( $name, $database ) = array_map( 'trim', $parts );

            if ( $database == wfWikiID() ) {
                $database = '';
            } else {
                if ( !$this->getUser()->isAllowed( 'userrights-interwiki' ) ) {
                    return Status::newFatal( 'userrights-no-interwiki' );
                }
                if ( !UserRightsProxy::validDatabase( $database ) ) {
                    return Status::newFatal( 'userrights-nodatabase', $database );
                }
            }
        }

        if ( $name === '' ) {
            return Status::newFatal( 'nouserspecified' );
        }

        if ( $name[0] == '#' ) {
            // Numeric ID can be specified...
            // We'll do a lookup for the name internally.
            $id = intval( substr( $name, 1 ) );

            if ( $database == '' ) {
                $name = User::whoIs( $id );
            } else {
                $name = UserRightsProxy::whoIs( $database, $id );
            }

            if ( !$name ) {
                return Status::newFatal( 'noname' );
            }
        } else {
            $name = User::getCanonicalName( $name );
            if ( $name === false ) {
                // invalid name
                return Status::newFatal( 'nosuchusershort', $username );
            }
        }

        if ( $database == '' ) {
            $user = User::newFromName( $name );
        } else {
            $user = UserRightsProxy::newFromName( $database, $name );
        }

        if ( !$user || $user->isAnon() ) {
            return Status::newFatal( 'nosuchusershort', $username );
        }

        return Status::newGood( $user );
    }

    public function makeGroupNameList( $ids ) {
        if ( empty( $ids ) ) {
            return $this->msg( 'rightsnone' )->inContentLanguage()->text();
        } else {
            return implode( ', ', $ids );
        }
    }

    function switchForm() {
        $this->getOutput()->addModules( 'mediawiki.userSuggest' );

        $this->getOutput()->addHTML(
            Html::openElement(
                'form',
                [
                    'method' => 'get',
                    'action' => wfScript(),
                    'name' => 'uluser',
                    'id' => 'mw-userrights-form1'
                ]
            ) .
            Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
            Xml::fieldset( $this->msg( 'userrights-lookup-user' )->text() ) .
            Xml::inputLabel(
                $this->msg( 'userrights-user-editname' )->text(),
                'user',
                'username',
                30,
                str_replace( '_', ' ', $this->mTarget ),
                [
                    'class' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
                ] + (
                    // Set autofocus on blank input and error input
                    $this->mFetchedUser === null ? [ 'autofocus' => '' ] : []
                )
            ) . ' ' .
            Xml::submitButton(
                $this->msg(
                    'editusergroup',
                    $this->mFetchedUser === null ? '[]' : $this->mFetchedUser->getName()
                )->text()
            ) .
            Html::closeElement( 'fieldset' ) .
            Html::closeElement( 'form' ) . "\n"
        );
    }

    protected function splitGroups( $groups ) {
        list( $addable, $removable, $addself, $removeself ) = array_values( $this->changeableGroups() );

        $removable = array_intersect(
            array_merge( $this->isself ? $removeself : [], $removable ),
            $groups
        ); // Can't remove groups the user doesn't have
        $addable = array_diff(
            array_merge( $this->isself ? $addself : [], $addable ),
            $groups
        ); // Can't add groups the user does have

        return [ $addable, $removable ];
    }

    protected function showEditUserGroupsForm( $user, $groups ) {
        $list = [];
        $membersList = [];
        foreach ( $groups as $group ) {
            $list[] = self::buildGroupLink( $group );
            $membersList[] = self::buildGroupMemberLink( $group );
        }

        $autoList = [];
        $autoMembersList = [];
        if ( $user instanceof User ) {
            foreach ( Autopromote::getAutopromoteGroups( $user ) as $group ) {
                $autoList[] = self::buildGroupLink( $group );
                $autoMembersList[] = self::buildGroupMemberLink( $group );
            }
        }

        $language = $this->getLanguage();
        $displayedList = $this->msg( 'userrights-groupsmember-type' )
            ->rawParams(
                $language->listToText( $list ),
                $language->listToText( $membersList )
            )->escaped();
        $displayedAutolist = $this->msg( 'userrights-groupsmember-type' )
            ->rawParams(
                $language->listToText( $autoList ),
                $language->listToText( $autoMembersList )
            )->escaped();

        $grouplist = '';
        $count = count( $list );
        if ( $count > 0 ) {
            $grouplist = $this->msg( 'userrights-groupsmember' )
                ->numParams( $count )
                ->params( $user->getName() )
                ->parse();
            $grouplist = '<p>' . $grouplist . ' ' . $displayedList . "</p>\n";
        }

        $count = count( $autoList );
        if ( $count > 0 ) {
            $autogrouplistintro = $this->msg( 'userrights-groupsmember-auto' )
                ->numParams( $count )
                ->params( $user->getName() )
                ->parse();
            $grouplist .= '<p>' . $autogrouplistintro . ' ' . $displayedAutolist . "</p>\n";
        }

        $userToolLinks = Linker::userToolLinks(
            $user->getId(),
            $user->getName(),
            false, /* default for redContribsWhenNoEdits */
            Linker::TOOL_LINKS_EMAIL /* Add "send e-mail" link */
        );

        $this->getOutput()->addHTML(
            Xml::openElement(
                'form',
                [
                    'method' => 'post',
                    'action' => $this->getPageTitle()->getLocalURL(),
                    'name' => 'editGroup',
                    'id' => 'mw-userrights-form2'
                ]
            ) .
            Html::hidden( 'user', $this->mTarget ) .
            Html::hidden( 'wpEditToken', $this->getUser()->getEditToken( $this->mTarget ) ) .
            Html::hidden(
                'conflictcheck-originalgroups',
                implode( ',', $user->getGroups() )
            ) . // Conflict detection
            Xml::openElement( 'fieldset' ) .
            Xml::element(
                'legend',
                [],
                $this->msg( 'userrights-editusergroup', $user->getName() )->text()
            ) .
            $this->msg( 'editinguser' )->params( wfEscapeWikiText( $user->getName() ) )
                ->rawParams( $userToolLinks )->parse() .
            $this->msg( 'userrights-groups-help', $user->getName() )->parse() .
            $grouplist .
            $this->groupCheckboxes( $groups, $user ) .
            Xml::openElement( 'table', [ 'id' => 'mw-userrights-table-outer' ] ) .
                "<tr>
                    <td class='mw-label'>" .
                        Xml::label( $this->msg( 'userrights-reason' )->text(), 'wpReason' ) .
                    "</td>
                    <td class='mw-input'>" .
                        Xml::input( 'user-reason', 60, $this->getRequest()->getVal( 'user-reason', false ),
                            [ 'id' => 'wpReason', 'maxlength' => 255 ] ) .
                    "</td>
                </tr>
                <tr>
                    <td></td>
                    <td class='mw-submit'>" .
                        Xml::submitButton( $this->msg( 'saveusergroups', $user->getName() )->text(),
                            [ 'name' => 'saveusergroups' ] +
                                Linker::tooltipAndAccesskeyAttribs( 'userrights-set' )
                        ) .
                    "</td>
                </tr>" .
            Xml::closeElement( 'table' ) . "\n" .
            Xml::closeElement( 'fieldset' ) .
            Xml::closeElement( 'form' ) . "\n"
        );
    }

    private static function buildGroupLink( $group ) {
        return User::makeGroupLinkHTML( $group, User::getGroupName( $group ) );
    }

    private static function buildGroupMemberLink( $group ) {
        return User::makeGroupLinkHTML( $group, User::getGroupMember( $group ) );
    }

    protected static function getAllGroups() {
        return User::getAllGroups();
    }

    private function groupCheckboxes( $usergroups, $user ) {
        $allgroups = $this->getAllGroups();
        $ret = '';

        // Put all column info into an associative array so that extensions can
        // more easily manage it.
        $columns = [ 'unchangeable' => [], 'changeable' => [] ];

        foreach ( $allgroups as $group ) {
            $set = in_array( $group, $usergroups );
            // Should the checkbox be disabled?
            $disabled = !(
                ( $set && $this->canRemove( $group ) ) ||
                ( !$set && $this->canAdd( $group ) ) );
            // Do we need to point out that this action is irreversible?
            $irreversible = !$disabled && (
                ( $set && !$this->canAdd( $group ) ) ||
                ( !$set && !$this->canRemove( $group ) ) );

            $checkbox = [
                'set' => $set,
                'disabled' => $disabled,
                'irreversible' => $irreversible
            ];

            if ( $disabled ) {
                $columns['unchangeable'][$group] = $checkbox;
            } else {
                $columns['changeable'][$group] = $checkbox;
            }
        }

        // Build the HTML table
        $ret .= Xml::openElement( 'table', [ 'class' => 'mw-userrights-groups' ] ) .
            "<tr>\n";
        foreach ( $columns as $name => $column ) {
            if ( $column === [] ) {
                continue;
            }
            // Messages: userrights-changeable-col, userrights-unchangeable-col
            $ret .= Xml::element(
                'th',
                null,
                $this->msg( 'userrights-' . $name . '-col', count( $column ) )->text()
            );
        }

        $ret .= "</tr>\n<tr>\n";
        foreach ( $columns as $column ) {
            if ( $column === [] ) {
                continue;
            }
            $ret .= "\t<td style='vertical-align:top;'>\n";
            foreach ( $column as $group => $checkbox ) {
                $attr = $checkbox['disabled'] ? [ 'disabled' => 'disabled' ] : [];

                $member = User::getGroupMember( $group, $user->getName() );
                if ( $checkbox['irreversible'] ) {
                    $text = $this->msg( 'userrights-irreversible-marker', $member )->text();
                } else {
                    $text = $member;
                }
                $checkboxHtml = Xml::checkLabel( $text, "wpGroup-" . $group,
                    "wpGroup-" . $group, $checkbox['set'], $attr );
                $ret .= "\t\t" . ( $checkbox['disabled']
                    ? Xml::tags( 'span', [ 'class' => 'mw-userrights-disabled' ], $checkboxHtml )
                    : $checkboxHtml
                ) . "<br />\n";
            }
            $ret .= "\t</td>\n";
        }
        $ret .= Xml::closeElement( 'tr' ) . Xml::closeElement( 'table' );

        return $ret;
    }

    private function canRemove( $group ) {
        // $this->changeableGroups()['remove'] doesn't work, of course. Thanks, PHP.
        $groups = $this->changeableGroups();

        return in_array(
            $group,
            $groups['remove'] ) || ( $this->isself && in_array( $group, $groups['remove-self'] )
        );
    }

    private function canAdd( $group ) {
        $groups = $this->changeableGroups();

        return in_array(
            $group,
            $groups['add'] ) || ( $this->isself && in_array( $group, $groups['add-self'] )
        );
    }

    function changeableGroups() {
        return $this->getUser()->changeableGroups();
    }

    protected function showLogFragment( $user, $output ) {
        $rightsLogPage = new LogPage( 'rights' );
        $output->addHTML( Xml::element( 'h2', null, $rightsLogPage->getName()->text() ) );
        LogEventsList::showLogExtract( $output, 'rights', $user->getUserPage() );
    }

    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $user = User::newFromName( $search );
        if ( !$user ) {
            // No prefix suggestion for invalid user
            return [];
        }
        // Autocomplete subpage as user list - public to allow caching
        return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
    }

    protected function getGroupName() {
        return 'users';
    }
}