SpecialListGroupRights.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\Html\Html;
use MediaWiki\Language\ILanguageConverter;
use MediaWiki\Language\LanguageConverterFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\Message\Message;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Permissions\GroupPermissionsLookup;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Specials\Helpers\UserRequirementsConditionFormatterTrait;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\RestrictedUserGroupConfigReader;
use MediaWiki\User\User;
use MediaWiki\User\UserGroupManager;
use MediaWiki\User\UserGroupMembership;
 
class SpecialListGroupRights extends SpecialPage {
 
    use UserRequirementsConditionFormatterTrait;
 
    public const RESTRICTED_GROUPS_SECTION_ID = 'restricted_groups';
    private const RESTRICTED_GROUPS_ID_PREFIX = 'group_restrictions-';
 
    private readonly ILanguageConverter $languageConverter;
 
    public function __construct(
        private readonly NamespaceInfo $nsInfo,
        private readonly UserGroupManager $userGroupManager,
        LanguageConverterFactory $languageConverterFactory,
        private readonly GroupPermissionsLookup $groupPermissionsLookup,
        private readonly RestrictedUserGroupConfigReader $restrictedUserGroupConfigReader,
    ) {
        parent::__construct( 'Listgrouprights' );
        $this->languageConverter = $languageConverterFactory->getLanguageConverter( $this->getContentLanguage() );
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
 
        $out = $this->getOutput();
        $out->addModuleStyles( 'mediawiki.special' );
        $this->addHelpLink( 'Help:User_rights_and_groups' );
 
        $out->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );
 
        $out->addHTML(
            Html::openElement( 'table', [ 'class' => [ 'wikitable', 'mw-listgrouprights-table' ] ] ) .
                '<tr>' .
                Html::element( 'th', [], $this->msg( 'listgrouprights-group' )->text() ) .
                Html::element( 'th', [], $this->msg( 'listgrouprights-rights' )->text() ) .
                '</tr>'
        );
 
        $config = $this->getConfig();
        $addGroups = $config->get( MainConfigNames::AddGroups );
        $removeGroups = $config->get( MainConfigNames::RemoveGroups );
        $groupsAddToSelf = $config->get( MainConfigNames::GroupsAddToSelf );
        $groupsRemoveFromSelf = $config->get( MainConfigNames::GroupsRemoveFromSelf );
        $allGroups = array_merge(
            $this->userGroupManager->listAllGroups(),
            $this->userGroupManager->listAllImplicitGroups()
        );
        asort( $allGroups );
 
        $linkRenderer = $this->getLinkRenderer();
        $lang = $this->getLanguage();
        $restrictedGroups = $this->restrictedUserGroupConfigReader->getConfig();
 
        foreach ( $allGroups as $group ) {
            $permissions = $this->groupPermissionsLookup->getGrantedPermissions( $group );
            $groupname = ( $group == '*' ) // Replace * with a more descriptive groupname
                ? 'all'
                : $group;
 
            $groupnameLocalized = $lang->getGroupName( $groupname );
 
            $grouppageLocalizedTitle = UserGroupMembership::getGroupPage( $groupname )
                ?: Title::makeTitleSafe( NS_PROJECT, $groupname );
 
            if ( $group == '*' || !$grouppageLocalizedTitle ) {
                // Do not make a link for the generic * group or group with invalid group page
                $grouppage = htmlspecialchars( $groupnameLocalized );
            } else {
                $grouppage = $linkRenderer->makeLink(
                    $grouppageLocalizedTitle,
                    $groupnameLocalized
                );
            }
 
            $groupWithParentheses = $this->msg( 'parentheses' )->rawParams( $group )->escaped();
            $groupname = "<br /><code>$groupWithParentheses</code>";
 
            if ( $group === 'user' ) {
                // Link to Special:listusers for implicit group 'user'
                $grouplink = '<br />' . $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'Listusers' ),
                    $this->msg( 'listgrouprights-members' )->text()
                );
            } elseif ( !in_array( $group, $config->get( MainConfigNames::ImplicitGroups ) ) ) {
                $grouplink = '<br />' . $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'Listusers' ),
                    $this->msg( 'listgrouprights-members' )->text(),
                    [],
                    [ 'group' => $group ]
                );
            } else {
                // No link to Special:listusers for other implicit groups as they are unlistable
                $grouplink = '';
            }
 
            $restrictionsLink = '';
            if ( array_key_exists( $group, $restrictedGroups ) && $restrictedGroups[$group]->hasAnyConditions() ) {
                $restrictionsSection = Sanitizer::escapeIdForAttribute( self::RESTRICTED_GROUPS_ID_PREFIX . $group );
                $restrictionsLink = Html::rawElement( 'p', [],
                    $this->msg( 'listgrouprights-restricted' )
                        ->params( '#' . $restrictionsSection )
                        ->parse()
                );
            }
 
            $revoke = $this->groupPermissionsLookup->getRevokedPermissions( $group );
            $addgroups = $addGroups[$group] ?? [];
            $removegroups = $removeGroups[$group] ?? [];
            $addgroupsSelf = $groupsAddToSelf[$group] ?? [];
            $removegroupsSelf = $groupsRemoveFromSelf[$group] ?? [];
 
            $id = $group == '*' ? false : Sanitizer::escapeIdForAttribute( $group );
            $out->addHTML( Html::rawElement( 'tr', [ 'id' => $id ], "
                <td>$grouppage$groupname$grouplink$restrictionsLink</td>
                    <td>" .
                    $this->formatPermissions( $permissions, $revoke, $addgroups, $removegroups,
                        $addgroupsSelf, $removegroupsSelf ) .
                    '</td>
                '
            ) );
        }
        $out->addHTML( Html::closeElement( 'table' ) );
        $this->outputRestrictedGroupsConfig();
        $this->outputNamespaceProtectionInfo();
    }
 
    private function outputNamespaceProtectionInfo() {
        $out = $this->getOutput();
        $namespaceProtection = $this->getConfig()->get( MainConfigNames::NamespaceProtection );
 
        if ( count( $namespaceProtection ) == 0 ) {
            return;
        }
 
        $header = $this->msg( 'listgrouprights-namespaceprotection-header' )->text();
        $out->addHTML(
            Html::element( 'h2', [
                'id' => Sanitizer::escapeIdForAttribute( $header )
            ], $header ) .
            Html::openElement( 'table', [ 'class' => 'wikitable' ] ) .
            Html::element(
                'th',
                [],
                $this->msg( 'listgrouprights-namespaceprotection-namespace' )->text()
            ) .
            Html::element(
                'th',
                [],
                $this->msg( 'listgrouprights-namespaceprotection-restrictedto' )->text()
            )
        );
        $linkRenderer = $this->getLinkRenderer();
        ksort( $namespaceProtection );
        $validNamespaces = $this->nsInfo->getValidNamespaces();
        foreach ( $namespaceProtection as $namespace => $rights ) {
            if ( !in_array( $namespace, $validNamespaces ) ) {
                continue;
            }
 
            if ( $namespace == NS_MAIN ) {
                $namespaceText = $this->msg( 'blanknamespace' )->text();
            } else {
                $namespaceText = $this->languageConverter->convertNamespace( $namespace );
            }
 
            $out->addHTML(
                Html::openElement( 'tr' ) .
                Html::rawElement(
                    'td',
                    [],
                    $linkRenderer->makeLink(
                        SpecialPage::getTitleFor( 'Allpages' ),
                        $namespaceText,
                        [],
                        [ 'namespace' => $namespace ]
                    )
                ) .
                Html::openElement( 'td' ) . Html::openElement( 'ul' )
            );
 
            if ( !is_array( $rights ) ) {
                $rights = [ $rights ];
            }
 
            foreach ( $rights as $right ) {
                $out->addHTML( Html::rawElement( 'li', [],
                    $this->msg( 'listgrouprights-right-display' )
                        ->params( User::getRightDescription( $right ) )
                        ->rawParams( Html::element(
                            'span',
                            [ 'class' => 'mw-listgrouprights-right-name' ],
                            $right
                        ) )->parse()
                ) );
            }
 
            $out->addHTML(
                Html::closeElement( 'ul' ) .
                Html::closeElement( 'td' ) .
                Html::closeElement( 'tr' )
            );
        }
        $out->addHTML( Html::closeElement( 'table' ) );
    }
 
    private function outputRestrictedGroupsConfig() {
        $out = $this->getOutput();
        $restrictedGroups = $this->restrictedUserGroupConfigReader->getConfig();
 
        $allGroups = array_merge(
            $this->userGroupManager->listAllGroups(),
            $this->userGroupManager->listAllImplicitGroups()
        );
        $restrictedGroups = array_filter(
            $restrictedGroups,
            static fn ( $restriction, $group ) => in_array( $group, $allGroups ) && $restriction->hasAnyConditions(),
            ARRAY_FILTER_USE_BOTH
        );
 
        if ( !$restrictedGroups ) {
            return;
        }
 
        $header = $this->msg( 'listgrouprights-restrictedgroups-header' )->text();
        $out->addHTML(
            Html::element( 'h2', [
                'id' => Sanitizer::escapeIdForAttribute( self::RESTRICTED_GROUPS_SECTION_ID )
            ], $header ) .
            Html::openElement( 'table', [ 'class' => 'wikitable mw-listgrouprights-table' ] ) .
            Html::rawElement( 'tr', [],
                Html::element(
                    'th',
                    [],
                    $this->msg( 'listgrouprights-group' )->text()
                ) .
                Html::element(
                    'th',
                    [],
                    $this->msg( 'listgrouprights-restrictedgroups-config' )->text()
                )
            )
        );
        ksort( $restrictedGroups );
 
        $lang = $this->getLanguage();
        $linkRenderer = $this->getLinkRenderer();
        foreach ( $restrictedGroups as $group => $groupConfig ) {
            $out->addHTML(
                Html::openElement(
                    'tr',
                    [ 'id' => Sanitizer::escapeIdForAttribute( self::RESTRICTED_GROUPS_ID_PREFIX . $group ) ]
                ) .
                Html::rawElement(
                    'td',
                    [],
                    $linkRenderer->makeKnownLink(
                        new TitleValue( NS_SPECIAL, $this->getLocalName(), $group ),
                        $lang->getGroupName( $group )
                    )
                ) .
                Html::openElement( 'td' )
            );
 
            $conditionsParts = [];
            $memberConditions = $groupConfig->getMemberConditions();
            if ( $memberConditions ) {
                $memberHtml = $this->msg( 'listgrouprights-restrictedgroups-memberconditions' )->parse();
                $memberHtml .= Html::rawElement( 'ul', [],
                    Html::rawElement( 'li', [], $this->formatCondition( $memberConditions ) )
                );
                $conditionsParts[] = $memberHtml;
            }
            $updaterConditions = $groupConfig->getUpdaterConditions();
            if ( $updaterConditions ) {
                $updaterHtml = $this->msg( 'listgrouprights-restrictedgroups-updaterconditions' )->parse();
                $updaterHtml .= Html::rawElement( 'ul', [],
                    Html::rawElement( 'li', [], $this->formatCondition( $updaterConditions ) )
                );
                $conditionsParts[] = $updaterHtml;
            }
            if ( $groupConfig->canBeIgnored() ) {
                $conditionsParts[] = $this->msg( 'listgrouprights-restrictedgroups-bypassable' )
                    ->params( User::getRightDescription( 'ignore-restricted-groups' ) )
                    ->rawParams( Html::element( 'code', [], 'ignore-restricted-groups' ) )
                    ->parse();
            }
            if ( $groupConfig->allowsAutomaticDemotion() ) {
                $conditionsParts[] = $this->msg( 'listgrouprights-restrictedgroups-autodemotion' )->parse();
            }
            $out->addHTML( implode( '', $conditionsParts ) );
 
            $out->addHTML(
                Html::closeElement( 'td' ) .
                Html::closeElement( 'tr' )
            );
        }
        $out->addHTML( Html::closeElement( 'table' ) );
    }
 
    private function formatPermissions( $permissions, $revoke, $add, $remove, $addSelf, $removeSelf ) {
        $r = [];
        foreach ( $permissions as $permission ) {
            // show as granted only if it isn't revoked to prevent duplicate display of permissions
            if ( !isset( $revoke[$permission] ) || !$revoke[$permission] ) {
                $r[] = $this->msg( 'listgrouprights-right-display' )
                    ->params( User::getRightDescription( $permission ) )
                    ->rawParams( Html::element(
                        'span',
                        [ 'class' => 'mw-listgrouprights-right-name' ],
                        $permission
                    ) )->parse();
            }
        }
        foreach ( $revoke as $permission ) {
            $r[] = $this->msg( 'listgrouprights-right-revoked' )
                ->params( User::getRightDescription( $permission ) )
                ->rawParams( Html::element(
                    'span',
                    [ 'class' => 'mw-listgrouprights-right-name' ],
                    $permission
                ) )->parse();
        }
 
        sort( $r );
 
        $allGroups = $this->userGroupManager->listAllGroups();
 
        $changeGroups = [
            'addgroup' => $add,
            'removegroup' => $remove,
            'addgroup-self' => $addSelf,
            'removegroup-self' => $removeSelf
        ];
 
        foreach ( $changeGroups as $messageKey => $changeGroup ) {
            // @phan-suppress-next-line PhanTypeComparisonFromArray
            if ( $changeGroup === true ) {
                // For grep: listgrouprights-addgroup-all, listgrouprights-removegroup-all,
                // listgrouprights-addgroup-self-all, listgrouprights-removegroup-self-all
                $r[] = $this->msg( 'listgrouprights-' . $messageKey . '-all' )->escaped();
            } elseif ( is_array( $changeGroup ) ) {
                $changeGroup = array_intersect( array_values( array_unique( $changeGroup ) ), $allGroups );
                if ( count( $changeGroup ) ) {
                    $groupLinks = [];
                    foreach ( $changeGroup as $group ) {
                        $groupLinks[] = UserGroupMembership::getLinkWiki( $group, $this->getContext() );
                    }
                    // For grep: listgrouprights-addgroup, listgrouprights-removegroup,
                    // listgrouprights-addgroup-self, listgrouprights-removegroup-self
                    $r[] = $this->msg( 'listgrouprights-' . $messageKey,
                        Message::listParam( $groupLinks ), count( $changeGroup ) )->parse();
                }
            }
        }
 
        if ( !$r ) {
            return '';
        } else {
            return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';
        }
    }
 
    protected function getGroupName() {
        return 'users';
    }
}
 
class_alias( SpecialListGroupRights::class, 'SpecialListGroupRights' );