3 * Implements Special:Listgrouprights
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * This special page lists all defined user groups and the associated rights.
26 * See also @ref $wgGroupPermissions.
28 * @ingroup SpecialPage
29 * @author Petr Kadlec <mormegil@centrum.cz>
31 class SpecialListGroupRights
extends SpecialPage
{
38 function __construct() {
40 parent
::__construct( 'Listgrouprights' );
41 $this->skin
= $wgUser->getSkin();
45 * Show the special page
47 public function execute( $par ) {
48 global $wgOut, $wgImplicitGroups;
49 global $wgGroupPermissions, $wgRevokePermissions, $wgAddGroups, $wgRemoveGroups;
50 global $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
53 $this->outputHeader();
56 Xml
::openElement( 'table', array( 'class' => 'wikitable mw-listgrouprights-table' ) ) .
58 Xml
::element( 'th', null, wfMsg( 'listgrouprights-group' ) ) .
59 Xml
::element( 'th', null, wfMsg( 'listgrouprights-rights' ) ) .
63 foreach( $wgGroupPermissions as $group => $permissions ) {
64 $groupname = ( $group == '*' ) ?
'all' : $group; // Replace * with a more descriptive groupname
66 $msg = wfMsg( 'group-' . $groupname );
67 if ( wfEmptyMsg( 'group-' . $groupname, $msg ) ||
$msg == '' ) {
68 $groupnameLocalized = $groupname;
70 $groupnameLocalized = $msg;
73 $msg = wfMsgForContent( 'grouppage-' . $groupname );
74 if ( wfEmptyMsg( 'grouppage-' . $groupname, $msg ) ||
$msg == '' ) {
75 $grouppageLocalized = MWNamespace
::getCanonicalName( NS_PROJECT
) . ':' . $groupname;
77 $grouppageLocalized = $msg;
81 // Do not make a link for the generic * group
82 $grouppage = htmlspecialchars( $groupnameLocalized );
84 $grouppage = $this->skin
->link(
85 Title
::newFromText( $grouppageLocalized ),
86 htmlspecialchars( $groupnameLocalized )
90 if ( $group === 'user' ) {
91 // Link to Special:listusers for implicit group 'user'
92 $grouplink = '<br />' . $this->skin
->link(
93 SpecialPage
::getTitleFor( 'Listusers' ),
94 wfMsgHtml( 'listgrouprights-members' ),
97 array( 'known', 'noclasses' )
99 } elseif ( !in_array( $group, $wgImplicitGroups ) ) {
100 $grouplink = '<br />' . $this->skin
->link(
101 SpecialPage
::getTitleFor( 'Listusers' ),
102 wfMsgHtml( 'listgrouprights-members' ),
104 array( 'group' => $group ),
105 array( 'known', 'noclasses' )
108 // No link to Special:listusers for other implicit groups as they are unlistable
112 $revoke = isset( $wgRevokePermissions[$group] ) ?
$wgRevokePermissions[$group] : array();
113 $addgroups = isset( $wgAddGroups[$group] ) ?
$wgAddGroups[$group] : array();
114 $removegroups = isset( $wgRemoveGroups[$group] ) ?
$wgRemoveGroups[$group] : array();
115 $addgroupsSelf = isset( $wgGroupsAddToSelf[$group] ) ?
$wgGroupsAddToSelf[$group] : array();
116 $removegroupsSelf = isset( $wgGroupsRemoveFromSelf[$group] ) ?
$wgGroupsRemoveFromSelf[$group] : array();
118 $id = $group == '*' ?
false : Sanitizer
::escapeId( $group );
119 $wgOut->addHTML( Html
::rawElement( 'tr', array( 'id' => $id ),
121 <td>$grouppage$grouplink</td>
123 self
::formatPermissions( $permissions, $revoke, $addgroups, $removegroups, $addgroupsSelf, $removegroupsSelf ) .
129 Xml
::closeElement( 'table' ) . "\n<br /><hr />\n"
131 $wgOut->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );
135 * Create a user-readable list of permissions from the given array.
137 * @param $permissions Array of permission => bool (from $wgGroupPermissions items)
138 * @param $revoke Array of permission => bool (from $wgRevokePermissions items)
139 * @param $add Array of groups this group is allowed to add or true
140 * @param $remove Array of groups this group is allowed to remove or true
141 * @param $addSelf Array of groups this group is allowed to add to self or true
142 * @param $removeSelf Array of group this group is allowed to remove from self or true
143 * @return string List of all granted permissions, separated by comma separator
145 private static function formatPermissions( $permissions, $revoke, $add, $remove, $addSelf, $removeSelf ) {
149 foreach( $permissions as $permission => $granted ) {
150 //show as granted only if it isn't revoked to prevent duplicate display of permissions
151 if( $granted && ( !isset( $revoke[$permission] ) ||
!$revoke[$permission] ) ) {
152 $description = wfMsgExt( 'listgrouprights-right-display', array( 'parseinline' ),
153 User
::getRightDescription( $permission ),
154 '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
159 foreach( $revoke as $permission => $revoked ) {
161 $description = wfMsgExt( 'listgrouprights-right-revoked', array( 'parseinline' ),
162 User
::getRightDescription( $permission ),
163 '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
170 $r[] = wfMsgExt( 'listgrouprights-addgroup-all', array( 'escape' ) );
171 } else if( is_array( $add ) && count( $add ) ) {
172 $add = array_values( array_unique( $add ) );
173 $r[] = wfMsgExt( 'listgrouprights-addgroup', array( 'parseinline' ), $wgLang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $add ) ), count( $add ) );
175 if( $remove === true ){
176 $r[] = wfMsgExt( 'listgrouprights-removegroup-all', array( 'escape' ) );
177 } else if( is_array( $remove ) && count( $remove ) ) {
178 $remove = array_values( array_unique( $remove ) );
179 $r[] = wfMsgExt( 'listgrouprights-removegroup', array( 'parseinline' ), $wgLang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $remove ) ), count( $remove ) );
181 if( $addSelf === true ){
182 $r[] = wfMsgExt( 'listgrouprights-addgroup-self-all', array( 'escape' ) );
183 } else if( is_array( $addSelf ) && count( $addSelf ) ) {
184 $addSelf = array_values( array_unique( $addSelf ) );
185 $r[] = wfMsgExt( 'listgrouprights-addgroup-self', array( 'parseinline' ), $wgLang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $addSelf ) ), count( $addSelf ) );
187 if( $removeSelf === true ){
188 $r[] = wfMsgExt( 'listgrouprights-removegroup-self-all', array( 'escape' ) );
189 } else if( is_array( $removeSelf ) && count( $removeSelf ) ) {
190 $removeSelf = array_values( array_unique( $removeSelf ) );
191 $r[] = wfMsgExt( 'listgrouprights-removegroup-self', array( 'parseinline' ), $wgLang->listToText( array_map( array( 'User', 'makeGroupLinkWiki' ), $removeSelf ) ), count( $removeSelf ) );
196 return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';