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
{
32 public function __construct() {
33 parent
::__construct( 'Listgrouprights' );
37 * Show the special page
38 * @param string|null $par
40 public function execute( $par ) {
42 $this->outputHeader();
44 $out = $this->getOutput();
45 $out->addModuleStyles( 'mediawiki.special' );
47 $out->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );
50 Xml
::openElement( 'table', [ 'class' => 'wikitable mw-listgrouprights-table' ] ) .
52 Xml
::element( 'th', null, $this->msg( 'listgrouprights-group' )->text() ) .
53 Xml
::element( 'th', null, $this->msg( 'listgrouprights-rights' )->text() ) .
57 $config = $this->getConfig();
58 $groupPermissions = $config->get( 'GroupPermissions' );
59 $revokePermissions = $config->get( 'RevokePermissions' );
60 $addGroups = $config->get( 'AddGroups' );
61 $removeGroups = $config->get( 'RemoveGroups' );
62 $groupsAddToSelf = $config->get( 'GroupsAddToSelf' );
63 $groupsRemoveFromSelf = $config->get( 'GroupsRemoveFromSelf' );
64 $allGroups = array_unique( array_merge(
65 array_keys( $groupPermissions ),
66 array_keys( $revokePermissions ),
67 array_keys( $addGroups ),
68 array_keys( $removeGroups ),
69 array_keys( $groupsAddToSelf ),
70 array_keys( $groupsRemoveFromSelf )
74 $linkRenderer = $this->getLinkRenderer();
76 foreach ( $allGroups as $group ) {
77 $permissions = $groupPermissions[$group] ??
[];
78 $groupname = ( $group == '*' ) // Replace * with a more descriptive groupname
82 $groupnameLocalized = UserGroupMembership
::getGroupName( $groupname );
84 $grouppageLocalizedTitle = UserGroupMembership
::getGroupPage( $groupname )
85 ?
: Title
::newFromText( MWNamespace
::getCanonicalName( NS_PROJECT
) . ':' . $groupname );
87 if ( $group == '*' ||
!$grouppageLocalizedTitle ) {
88 // Do not make a link for the generic * group or group with invalid group page
89 $grouppage = htmlspecialchars( $groupnameLocalized );
91 $grouppage = $linkRenderer->makeLink(
92 $grouppageLocalizedTitle,
97 if ( $group === 'user' ) {
98 // Link to Special:listusers for implicit group 'user'
99 $grouplink = '<br />' . $linkRenderer->makeKnownLink(
100 SpecialPage
::getTitleFor( 'Listusers' ),
101 $this->msg( 'listgrouprights-members' )->text()
103 } elseif ( !in_array( $group, $config->get( 'ImplicitGroups' ) ) ) {
104 $grouplink = '<br />' . $linkRenderer->makeKnownLink(
105 SpecialPage
::getTitleFor( 'Listusers' ),
106 $this->msg( 'listgrouprights-members' )->text(),
108 [ 'group' => $group ]
111 // No link to Special:listusers for other implicit groups as they are unlistable
115 $revoke = $revokePermissions[$group] ??
[];
116 $addgroups = $addGroups[$group] ??
[];
117 $removegroups = $removeGroups[$group] ??
[];
118 $addgroupsSelf = $groupsAddToSelf[$group] ??
[];
119 $removegroupsSelf = $groupsRemoveFromSelf[$group] ??
[];
121 $id = $group == '*' ?
false : Sanitizer
::escapeIdForAttribute( $group );
122 $out->addHTML( Html
::rawElement( 'tr', [ 'id' => $id ], "
123 <td>$grouppage$grouplink</td>
125 $this->formatPermissions( $permissions, $revoke, $addgroups, $removegroups,
126 $addgroupsSelf, $removegroupsSelf ) .
131 $out->addHTML( Xml
::closeElement( 'table' ) );
132 $this->outputNamespaceProtectionInfo();
135 private function outputNamespaceProtectionInfo() {
137 $out = $this->getOutput();
138 $namespaceProtection = $this->getConfig()->get( 'NamespaceProtection' );
140 if ( count( $namespaceProtection ) == 0 ) {
144 $header = $this->msg( 'listgrouprights-namespaceprotection-header' )->text();
146 Html
::rawElement( 'h2', [], Html
::element( 'span', [
147 'class' => 'mw-headline',
148 'id' => substr( Parser
::guessSectionNameFromStrippedText( $header ), 1 )
150 Xml
::openElement( 'table', [ 'class' => 'wikitable' ] ) .
154 $this->msg( 'listgrouprights-namespaceprotection-namespace' )->text()
159 $this->msg( 'listgrouprights-namespaceprotection-restrictedto' )->text()
162 $linkRenderer = $this->getLinkRenderer();
163 ksort( $namespaceProtection );
164 foreach ( $namespaceProtection as $namespace => $rights ) {
165 if ( !in_array( $namespace, MWNamespace
::getValidNamespaces() ) ) {
169 if ( $namespace == NS_MAIN
) {
170 $namespaceText = $this->msg( 'blanknamespace' )->text();
172 $namespaceText = $wgContLang->convertNamespace( $namespace );
176 Xml
::openElement( 'tr' ) .
180 $linkRenderer->makeLink(
181 SpecialPage
::getTitleFor( 'Allpages' ),
184 [ 'namespace' => $namespace ]
187 Xml
::openElement( 'td' ) . Xml
::openElement( 'ul' )
190 if ( !is_array( $rights ) ) {
191 $rights = [ $rights ];
194 foreach ( $rights as $right ) {
196 Html
::rawElement( 'li', [], $this->msg(
197 'listgrouprights-right-display',
198 User
::getRightDescription( $right ),
201 [ 'class' => 'mw-listgrouprights-right-name' ],
209 Xml
::closeElement( 'ul' ) .
210 Xml
::closeElement( 'td' ) .
211 Xml
::closeElement( 'tr' )
214 $out->addHTML( Xml
::closeElement( 'table' ) );
218 * Create a user-readable list of permissions from the given array.
220 * @param array $permissions Array of permission => bool (from $wgGroupPermissions items)
221 * @param array $revoke Array of permission => bool (from $wgRevokePermissions items)
222 * @param array $add Array of groups this group is allowed to add or true
223 * @param array $remove Array of groups this group is allowed to remove or true
224 * @param array $addSelf Array of groups this group is allowed to add to self or true
225 * @param array $removeSelf Array of group this group is allowed to remove from self or true
226 * @return string HTML list of all granted permissions
228 private function formatPermissions( $permissions, $revoke, $add, $remove, $addSelf, $removeSelf ) {
230 foreach ( $permissions as $permission => $granted ) {
231 // show as granted only if it isn't revoked to prevent duplicate display of permissions
232 if ( $granted && ( !isset( $revoke[$permission] ) ||
!$revoke[$permission] ) ) {
233 $r[] = $this->msg( 'listgrouprights-right-display',
234 User
::getRightDescription( $permission ),
235 '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
239 foreach ( $revoke as $permission => $revoked ) {
241 $r[] = $this->msg( 'listgrouprights-right-revoked',
242 User
::getRightDescription( $permission ),
243 '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
250 $lang = $this->getLanguage();
251 $allGroups = User
::getAllGroups();
255 'removegroup' => $remove,
256 'addgroup-self' => $addSelf,
257 'removegroup-self' => $removeSelf
260 foreach ( $changeGroups as $messageKey => $changeGroup ) {
261 if ( $changeGroup === true ) {
262 // For grep: listgrouprights-addgroup-all, listgrouprights-removegroup-all,
263 // listgrouprights-addgroup-self-all, listgrouprights-removegroup-self-all
264 $r[] = $this->msg( 'listgrouprights-' . $messageKey . '-all' )->escaped();
265 } elseif ( is_array( $changeGroup ) ) {
266 $changeGroup = array_intersect( array_values( array_unique( $changeGroup ) ), $allGroups );
267 if ( count( $changeGroup ) ) {
269 foreach ( $changeGroup as $group ) {
270 $groupLinks[] = UserGroupMembership
::getLink( $group, $this->getContext(), 'wiki' );
272 // For grep: listgrouprights-addgroup, listgrouprights-removegroup,
273 // listgrouprights-addgroup-self, listgrouprights-removegroup-self
274 $r[] = $this->msg( 'listgrouprights-' . $messageKey,
275 $lang->listToText( $groupLinks ), count( $changeGroup ) )->parse();
283 return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';
287 protected function getGroupName() {