SpecialListgrouprights.php

Go to the documentation of this file.

<?php
class SpecialListGroupRights extends SpecialPage {
    function __construct() {
        parent::__construct( 'Listgrouprights' );
    }

    public function execute( $par ) {
        global $wgImplicitGroups;
        global $wgGroupPermissions, $wgRevokePermissions, $wgAddGroups, $wgRemoveGroups;
        global $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;

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

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

        $out->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );

        $out->addHTML(
            Xml::openElement( 'table', array( 'class' => 'wikitable mw-listgrouprights-table' ) ) .
                '<tr>' .
                Xml::element( 'th', null, $this->msg( 'listgrouprights-group' )->text() ) .
                Xml::element( 'th', null, $this->msg( 'listgrouprights-rights' )->text() ) .
                '</tr>'
        );

        $allGroups = array_unique( array_merge(
            array_keys( $wgGroupPermissions ),
            array_keys( $wgRevokePermissions ),
            array_keys( $wgAddGroups ),
            array_keys( $wgRemoveGroups ),
            array_keys( $wgGroupsAddToSelf ),
            array_keys( $wgGroupsRemoveFromSelf )
        ) );
        asort( $allGroups );

        foreach ( $allGroups as $group ) {
            $permissions = isset( $wgGroupPermissions[$group] )
                ? $wgGroupPermissions[$group]
                : array();
            $groupname = ( $group == '*' ) // Replace * with a more descriptive groupname
                ? 'all'
                : $group;

            $msg = $this->msg( 'group-' . $groupname );
            $groupnameLocalized = !$msg->isBlank() ? $msg->text() : $groupname;

            $msg = $this->msg( 'grouppage-' . $groupname )->inContentLanguage();
            $grouppageLocalized = !$msg->isBlank() ?
                $msg->text() :
                MWNamespace::getCanonicalName( NS_PROJECT ) . ':' . $groupname;

            if ( $group == '*' ) {
                // Do not make a link for the generic * group
                $grouppage = htmlspecialchars( $groupnameLocalized );
            } else {
                $grouppage = Linker::link(
                    Title::newFromText( $grouppageLocalized ),
                    htmlspecialchars( $groupnameLocalized )
                );
            }

            if ( $group === 'user' ) {
                // Link to Special:listusers for implicit group 'user'
                $grouplink = '<br />' . Linker::linkKnown(
                    SpecialPage::getTitleFor( 'Listusers' ),
                    $this->msg( 'listgrouprights-members' )->escaped()
                );
            } elseif ( !in_array( $group, $wgImplicitGroups ) ) {
                $grouplink = '<br />' . Linker::linkKnown(
                    SpecialPage::getTitleFor( 'Listusers' ),
                    $this->msg( 'listgrouprights-members' )->escaped(),
                    array(),
                    array( 'group' => $group )
                );
            } else {
                // No link to Special:listusers for other implicit groups as they are unlistable
                $grouplink = '';
            }

            $revoke = isset( $wgRevokePermissions[$group] ) ? $wgRevokePermissions[$group] : array();
            $addgroups = isset( $wgAddGroups[$group] ) ? $wgAddGroups[$group] : array();
            $removegroups = isset( $wgRemoveGroups[$group] ) ? $wgRemoveGroups[$group] : array();
            $addgroupsSelf = isset( $wgGroupsAddToSelf[$group] ) ? $wgGroupsAddToSelf[$group] : array();
            $removegroupsSelf = isset( $wgGroupsRemoveFromSelf[$group] ) ? $wgGroupsRemoveFromSelf[$group] : array();

            $id = $group == '*' ? false : Sanitizer::escapeId( $group );
            $out->addHTML( Html::rawElement( 'tr', array( 'id' => $id ),
                "
                <td>$grouppage$grouplink</td>
                    <td>" .
                    $this->formatPermissions( $permissions, $revoke, $addgroups, $removegroups,
                        $addgroupsSelf, $removegroupsSelf ) .
                    '</td>
                '
            ) );
        }
        $out->addHTML( Xml::closeElement( 'table' ) );
    }

    private function formatPermissions( $permissions, $revoke, $add, $remove, $addSelf, $removeSelf ) {
        $r = array();
        foreach ( $permissions as $permission => $granted ) {
            //show as granted only if it isn't revoked to prevent duplicate display of permissions
            if ( $granted && ( !isset( $revoke[$permission] ) || !$revoke[$permission] ) ) {
                $description = $this->msg( 'listgrouprights-right-display',
                    User::getRightDescription( $permission ),
                    '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
                )->parse();
                $r[] = $description;
            }
        }
        foreach ( $revoke as $permission => $revoked ) {
            if ( $revoked ) {
                $description = $this->msg( 'listgrouprights-right-revoked',
                    User::getRightDescription( $permission ),
                    '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
                )->parse();
                $r[] = $description;
            }
        }

        sort( $r );

        $lang = $this->getLanguage();

        if ( $add === true ) {
            $r[] = $this->msg( 'listgrouprights-addgroup-all' )->escaped();
        } elseif ( is_array( $add ) && count( $add ) ) {
            $add = array_values( array_unique( $add ) );
            $r[] = $this->msg( 'listgrouprights-addgroup',
                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $add ) ),
                count( $add )
            )->parse();
        }

        if ( $remove === true ) {
            $r[] = $this->msg( 'listgrouprights-removegroup-all' )->escaped();
        } elseif ( is_array( $remove ) && count( $remove ) ) {
            $remove = array_values( array_unique( $remove ) );
            $r[] = $this->msg( 'listgrouprights-removegroup',
                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $remove ) ),
                count( $remove )
            )->parse();
        }

        if ( $addSelf === true ) {
            $r[] = $this->msg( 'listgrouprights-addgroup-self-all' )->escaped();
        } elseif ( is_array( $addSelf ) && count( $addSelf ) ) {
            $addSelf = array_values( array_unique( $addSelf ) );
            $r[] = $this->msg( 'listgrouprights-addgroup-self',
                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $addSelf ) ),
                count( $addSelf )
            )->parse();
        }

        if ( $removeSelf === true ) {
            $r[] = $this->msg( 'listgrouprights-removegroup-self-all' )->parse();
        } elseif ( is_array( $removeSelf ) && count( $removeSelf ) ) {
            $removeSelf = array_values( array_unique( $removeSelf ) );
            $r[] = $this->msg( 'listgrouprights-removegroup-self',
                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $removeSelf ) ),
                count( $removeSelf )
            )->parse();
        }

        if ( empty( $r ) ) {
            return '';
        } else {
            return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';
        }
    }

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