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->addHTML(
                        Xml::openElement( 'table', array( 'class' => 'wikitable mw-listgrouprights-table' ) ) .
                                '<tr>' .
                                        Xml::element( 'th', null, wfMsg( 'listgrouprights-group' ) ) .
                                        Xml::element( 'th', null, wfMsg( 'listgrouprights-rights' ) ) .
                                '</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 = wfMessage( 'group-' . $groupname );
                        $groupnameLocalized = !$msg->isBlank() ? $msg->text() : $groupname;

                        $msg = wfMessage( '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' ),
                                        wfMsgHtml( 'listgrouprights-members' )
                                );
                        } elseif ( !in_array( $group, $wgImplicitGroups ) ) {
                                $grouplink = '<br />' . Linker::linkKnown(
                                        SpecialPage::getTitleFor( 'Listusers' ),
                                        wfMsgHtml( 'listgrouprights-members' ),
                                        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' ) . "\n<br /><hr />\n"
                );
                $out->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );
        }

         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 = wfMsgExt( 'listgrouprights-right-display', array( 'parseinline' ),
                                        User::getRightDescription( $permission ),
                                        '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
                                );
                                $r[] = $description;
                        }
                }
                foreach( $revoke as $permission => $revoked ) {
                        if( $revoked ) {
                                $description = wfMsgExt( 'listgrouprights-right-revoked', array( 'parseinline' ),
                                        User::getRightDescription( $permission ),
                                        '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
                                );
                                $r[] = $description;
                        }
                }
                sort( $r );
                $lang = $this->getLanguage();
                if( $add === true ){
                        $r[] = wfMsgExt( 'listgrouprights-addgroup-all', array( 'escape' ) );
                } elseif( is_array( $add ) && count( $add ) ) {
                        $add = array_values( array_unique( $add ) );
                        $r[] = wfMsgExt( 'listgrouprights-addgroup', array( 'parseinline' ),
                                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $add ) ),
                                count( $add )
                        );
                }
                if( $remove === true ){
                        $r[] = wfMsgExt( 'listgrouprights-removegroup-all', array( 'escape' ) );
                } elseif( is_array( $remove ) && count( $remove ) ) {
                        $remove = array_values( array_unique( $remove ) );
                        $r[] = wfMsgExt( 'listgrouprights-removegroup', array( 'parseinline' ),
                                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $remove ) ),
                                count( $remove )
                        );
                }
                if( $addSelf === true ){
                        $r[] = wfMsgExt( 'listgrouprights-addgroup-self-all', array( 'escape' ) );
                } elseif( is_array( $addSelf ) && count( $addSelf ) ) {
                        $addSelf = array_values( array_unique( $addSelf ) );
                        $r[] = wfMsgExt( 'listgrouprights-addgroup-self', array( 'parseinline' ),
                                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $addSelf ) ),
                                count( $addSelf )
                        );
                }
                if( $removeSelf === true ){
                        $r[] = wfMsgExt( 'listgrouprights-removegroup-self-all', array( 'escape' ) );
                } elseif( is_array( $removeSelf ) && count( $removeSelf ) ) {
                        $removeSelf = array_values( array_unique( $removeSelf ) );
                        $r[] = wfMsgExt( 'listgrouprights-removegroup-self', array( 'parseinline' ),
                                $lang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $removeSelf ) ),
                                count( $removeSelf )
                        );
                }
                if( empty( $r ) ) {
                        return '';
                } else {
                        return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';
                }
        }
}