SpecialSearch: Simplify result info

[mediawiki.git] / includes / specials / SpecialUserrights.php

<?php
/**
 * Implements Special:Userrights
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup SpecialPage
 */

/**
 * Special page to allow managing user group membership
 *
 * @ingroup SpecialPage
 */
class UserrightsPage extends SpecialPage {
        # The target of the local right-adjuster's interest.  Can be gotten from
        # either a GET parameter or a subpage-style parameter, so have a member
        # variable for it.
        protected $mTarget;
        protected $isself = false;

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

        public function isRestricted() {
                return true;
        }

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

        /**
         * @param User $user
         * @param bool $checkIfSelf
         * @return bool
         */
        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'] ) ) );
        }

        /**
         * Manage forms to be shown according to posted data.
         * Depending on the submit button used, call a form or a save function.
         *
         * @param string|null $par String if any subpage provided, else null
         * @throws UserBlockedError|PermissionsError
         */
        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();

                /*
                 * 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() );
                }

                $request = $this->getRequest();

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

                $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 ( User::getCanonicalName( $this->mTarget ) == $user->getName() ) {
                        $this->isself = true;
                }

                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 = $this->getOutput();
                                $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, array( array( $msg ) ) );
                }

                $this->checkReadOnly();

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

                $out = $this->getOutput();
                $out->addModuleStyles( 'mediawiki.special' );

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

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

                                return;
                        }

                        $targetUser = $status->value;
                        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( array( 'success' => 1 ) );
        }

        /**
         * Save user groups changes in the database.
         * Data comes from the editUserGroupsForm() form function
         *
         * @param string $username Username to apply changes to.
         * @param string $reason Reason for group change
         * @param User|UserRightsProxy $user Target user object.
         * @return null
         */
        function saveUserGroups( $username, $reason, $user ) {
                $allgroups = $this->getAllGroups();
                $addgroup = array();
                $removegroup = array();

                // 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 );
        }

        /**
         * Save user groups changes in the database.
         *
         * @param User $user
         * @param array $add Array of groups to add
         * @param array $remove Array of groups to remove
         * @param string $reason Reason for group change
         * @return array Tuple of added, then removed groups
         */
        function doSaveUserGroups( $user, $add, $remove, $reason = '' ) {
                global $wgAuth;

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

                $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 ) {
                        $newGroups = array_diff( $newGroups, $remove );
                        foreach ( $remove as $group ) {
                                $user->removeGroup( $group );
                        }
                }
                if ( $add ) {
                        $newGroups = array_merge( $newGroups, $add );
                        foreach ( $add as $group ) {
                                $user->addGroup( $group );
                        }
                }
                $newGroups = array_unique( $newGroups );

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

                // update groups in external authentication database
                $wgAuth->updateExternalDBGroups( $user, $add, $remove );

                wfDebug( 'oldGroups: ' . print_r( $oldGroups, true ) . "\n" );
                wfDebug( 'newGroups: ' . print_r( $newGroups, true ) . "\n" );
                wfRunHooks( 'UserRights', array( &$user, $add, $remove ) );

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

                return array( $add, $remove );
        }

        /**
         * Add a rights log entry for an action.
         * @param User $user
         * @param array $oldGroups
         * @param array $newGroups
         * @param array $reason
         */
        function addLogEntry( $user, $oldGroups, $newGroups, $reason ) {
                $logEntry = new ManualLogEntry( 'rights', 'rights' );
                $logEntry->setPerformer( $this->getUser() );
                $logEntry->setTarget( $user->getUserPage() );
                $logEntry->setComment( $reason );
                $logEntry->setParameters( array(
                        '4::oldgroups' => $oldGroups,
                        '5::newgroups' => $newGroups,
                ) );
                $logid = $logEntry->insert();
                $logEntry->publish( $logid );
        }

        /**
         * Edit user groups membership
         * @param string $username Name of the user.
         */
        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() );
        }

        /**
         * Normalize the input username, which may be local or remote, and
         * return a user (or proxy) object for manipulating it.
         *
         * Side effects: error output for invalid access
         * @param string $username
         * @return Status
         */
        public function fetchUser( $username ) {
                global $wgUserrightsInterwikiDelimiter;

                $parts = explode( $wgUserrightsInterwikiDelimiter, $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 );
        }

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

        /**
         * Make a list of group names to be stored as parameter for log entries
         *
         * @deprecated since 1.21; use LogFormatter instead.
         * @param array $ids
         * @return string
         */
        function makeGroupNameListForLog( $ids ) {
                wfDeprecated( __METHOD__, '1.21' );

                if ( empty( $ids ) ) {
                        return '';
                } else {
                        return $this->makeGroupNameList( $ids );
                }
        }

        /**
         * Output a form to allow searching for a user
         */
        function switchForm() {
                global $wgScript;
                $this->getOutput()->addHTML(
                        Html::openElement(
                                'form',
                                array(
                                        'method' => 'get',
                                        'action' => $wgScript,
                                        '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 ),
                                array( 'autofocus' => true )
                        ) . ' ' .
                        Xml::submitButton( $this->msg( 'editusergroup' )->text() ) .
                        Html::closeElement( 'fieldset' ) .
                        Html::closeElement( 'form' ) . "\n"
                );
        }

        /**
         * Go through used and available groups and return the ones that this
         * form will be able to manipulate based on the current user's system
         * permissions.
         *
         * @param array $groups List of groups the given user is in
         * @return array Tuple of addable, then removable groups
         */
        protected function splitGroups( $groups ) {
                list( $addable, $removable, $addself, $removeself ) = array_values( $this->changeableGroups() );

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

                return array( $addable, $removable );
        }

        /**
         * Show the form to edit group memberships.
         *
         * @param User|UserRightsProxy $user User or UserRightsProxy you're editing
         * @param array $groups Array of groups the user is in
         */
        protected function showEditUserGroupsForm( $user, $groups ) {
                $list = array();
                $membersList = array();
                foreach ( $groups as $group ) {
                        $list[] = self::buildGroupLink( $group );
                        $membersList[] = self::buildGroupMemberLink( $group );
                }

                $autoList = array();
                $autoMembersList = array();
                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',
                        $language->listToText( $list ),
                        $language->listToText( $membersList )
                )->plain();
                $displayedAutolist = $this->msg( 'userrights-groupsmember-type',
                        $language->listToText( $autoList ),
                        $language->listToText( $autoMembersList )
                )->plain();

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

                $count = count( $autoList );
                if ( $count > 0 ) {
                        $autogrouplistintro = $this->msg( 'userrights-groupsmember-auto', $count, $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',
                                array(
                                        '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',
                                array(),
                                $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', array( '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 ),
                                                        array( 'id' => 'wpReason', 'maxlength' => 255 ) ) .
                                        "</td>
                                </tr>
                                <tr>
                                        <td></td>
                                        <td class='mw-submit'>" .
                                                Xml::submitButton( $this->msg( 'saveusergroups' )->text(),
                                                        array( 'name' => 'saveusergroups' ) +
                                                                Linker::tooltipAndAccesskeyAttribs( 'userrights-set' )
                                                ) .
                                        "</td>
                                </tr>" .
                        Xml::closeElement( 'table' ) . "\n" .
                        Xml::closeElement( 'fieldset' ) .
                        Xml::closeElement( 'form' ) . "\n"
                );
        }

        /**
         * Format a link to a group description page
         *
         * @param string $group
         * @return string
         */
        private static function buildGroupLink( $group ) {
                return User::makeGroupLinkHtml( $group, User::getGroupName( $group ) );
        }

        /**
         * Format a link to a group member description page
         *
         * @param string $group
         * @return string
         */
        private static function buildGroupMemberLink( $group ) {
                return User::makeGroupLinkHtml( $group, User::getGroupMember( $group ) );
        }

        /**
         * Returns an array of all groups that may be edited
         * @return array Array of groups that may be edited.
         */
        protected static function getAllGroups() {
                return User::getAllGroups();
        }

        /**
         * Adds a table with checkboxes where you can select what groups to add/remove
         *
         * @todo Just pass the username string?
         * @param array $usergroups Groups the user belongs to
         * @param User $user
         * @return string XHTML table element with checkboxes
         */
        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 = array( 'unchangeable' => array(), 'changeable' => array() );

                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 = array(
                                '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', array( 'class' => 'mw-userrights-groups' ) ) .
                        "<tr>\n";
                foreach ( $columns as $name => $column ) {
                        if ( $column === array() ) {
                                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 === array() ) {
                                continue;
                        }
                        $ret .= "\t<td style='vertical-align:top;'>\n";
                        foreach ( $column as $group => $checkbox ) {
                                $attr = $checkbox['disabled'] ? array( 'disabled' => 'disabled' ) : array();

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

                return $ret;
        }

        /**
         * @param string $group The name of the group to check
         * @return bool Can we remove the group?
         */
        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'] )
                );
        }

        /**
         * @param string $group The name of the group to check
         * @return bool Can we add the group?
         */
        private function canAdd( $group ) {
                $groups = $this->changeableGroups();

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

        /**
         * Returns $this->getUser()->changeableGroups()
         *
         * @return array array(
         *   'add' => array( addablegroups ),
         *   'remove' => array( removablegroups ),
         *   'add-self' => array( addablegroups to self ),
         *   'remove-self' => array( removable groups from self )
         *  )
         */
        function changeableGroups() {
                return $this->getUser()->changeableGroups();
        }

        /**
         * Show a rights log fragment for the specified user
         *
         * @param User $user User to show log for
         * @param OutputPage $output OutputPage to use
         */
        protected function showLogFragment( $user, $output ) {
                $rightsLogPage = new LogPage( 'rights' );
                $output->addHTML( Xml::element( 'h2', null, $rightsLogPage->getName()->text() ) );
                LogEventsList::showLogExtract( $output, 'rights', $user->getUserPage() );
        }

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