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
24 use MediaWiki\MediaWikiServices
;
27 * This special page lists all defined user groups and the associated rights.
28 * See also @ref $wgGroupPermissions.
30 * @ingroup SpecialPage
31 * @author Petr Kadlec <mormegil@centrum.cz>
33 class SpecialListGroupRights
extends SpecialPage
{
34 public function __construct() {
35 parent
::__construct( 'Listgrouprights' );
39 * Show the special page
40 * @param string|null $par
42 public function execute( $par ) {
44 $this->outputHeader();
46 $out = $this->getOutput();
47 $out->addModuleStyles( 'mediawiki.special' );
49 $out->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );
52 Xml
::openElement( 'table', [ 'class' => 'wikitable mw-listgrouprights-table' ] ) .
54 Xml
::element( 'th', null, $this->msg( 'listgrouprights-group' )->text() ) .
55 Xml
::element( 'th', null, $this->msg( 'listgrouprights-rights' )->text() ) .
59 $config = $this->getConfig();
60 $groupPermissions = $config->get( 'GroupPermissions' );
61 $revokePermissions = $config->get( 'RevokePermissions' );
62 $addGroups = $config->get( 'AddGroups' );
63 $removeGroups = $config->get( 'RemoveGroups' );
64 $groupsAddToSelf = $config->get( 'GroupsAddToSelf' );
65 $groupsRemoveFromSelf = $config->get( 'GroupsRemoveFromSelf' );
66 $allGroups = array_unique( array_merge(
67 array_keys( $groupPermissions ),
68 array_keys( $revokePermissions ),
69 array_keys( $addGroups ),
70 array_keys( $removeGroups ),
71 array_keys( $groupsAddToSelf ),
72 array_keys( $groupsRemoveFromSelf )
76 $linkRenderer = $this->getLinkRenderer();
78 foreach ( $allGroups as $group ) {
79 $permissions = $groupPermissions[$group] ??
[];
80 $groupname = ( $group == '*' ) // Replace * with a more descriptive groupname
84 $groupnameLocalized = UserGroupMembership
::getGroupName( $groupname );
86 $grouppageLocalizedTitle = UserGroupMembership
::getGroupPage( $groupname )
87 ?
: Title
::newFromText( MWNamespace
::getCanonicalName( NS_PROJECT
) . ':' . $groupname );
89 if ( $group == '*' ||
!$grouppageLocalizedTitle ) {
90 // Do not make a link for the generic * group or group with invalid group page
91 $grouppage = htmlspecialchars( $groupnameLocalized );
93 $grouppage = $linkRenderer->makeLink(
94 $grouppageLocalizedTitle,
99 if ( $group === 'user' ) {
100 // Link to Special:listusers for implicit group 'user'
101 $grouplink = '<br />' . $linkRenderer->makeKnownLink(
102 SpecialPage
::getTitleFor( 'Listusers' ),
103 $this->msg( 'listgrouprights-members' )->text()
105 } elseif ( !in_array( $group, $config->get( 'ImplicitGroups' ) ) ) {
106 $grouplink = '<br />' . $linkRenderer->makeKnownLink(
107 SpecialPage
::getTitleFor( 'Listusers' ),
108 $this->msg( 'listgrouprights-members' )->text(),
110 [ 'group' => $group ]
113 // No link to Special:listusers for other implicit groups as they are unlistable
117 $revoke = $revokePermissions[$group] ??
[];
118 $addgroups = $addGroups[$group] ??
[];
119 $removegroups = $removeGroups[$group] ??
[];
120 $addgroupsSelf = $groupsAddToSelf[$group] ??
[];
121 $removegroupsSelf = $groupsRemoveFromSelf[$group] ??
[];
123 $id = $group == '*' ?
false : Sanitizer
::escapeIdForAttribute( $group );
124 $out->addHTML( Html
::rawElement( 'tr', [ 'id' => $id ], "
125 <td>$grouppage$grouplink</td>
127 $this->formatPermissions( $permissions, $revoke, $addgroups, $removegroups,
128 $addgroupsSelf, $removegroupsSelf ) .
133 $out->addHTML( Xml
::closeElement( 'table' ) );
134 $this->outputNamespaceProtectionInfo();
137 private function outputNamespaceProtectionInfo() {
138 $out = $this->getOutput();
139 $namespaceProtection = $this->getConfig()->get( 'NamespaceProtection' );
141 if ( count( $namespaceProtection ) == 0 ) {
145 $header = $this->msg( 'listgrouprights-namespaceprotection-header' )->text();
147 Html
::rawElement( 'h2', [], Html
::element( 'span', [
148 'class' => 'mw-headline',
149 'id' => substr( Parser
::guessSectionNameFromStrippedText( $header ), 1 )
151 Xml
::openElement( 'table', [ 'class' => 'wikitable' ] ) .
155 $this->msg( 'listgrouprights-namespaceprotection-namespace' )->text()
160 $this->msg( 'listgrouprights-namespaceprotection-restrictedto' )->text()
163 $linkRenderer = $this->getLinkRenderer();
164 ksort( $namespaceProtection );
165 $validNamespaces = MWNamespace
::getValidNamespaces();
166 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
167 foreach ( $namespaceProtection as $namespace => $rights ) {
168 if ( !in_array( $namespace, $validNamespaces ) ) {
172 if ( $namespace == NS_MAIN
) {
173 $namespaceText = $this->msg( 'blanknamespace' )->text();
175 $namespaceText = $contLang->convertNamespace( $namespace );
179 Xml
::openElement( 'tr' ) .
183 $linkRenderer->makeLink(
184 SpecialPage
::getTitleFor( 'Allpages' ),
187 [ 'namespace' => $namespace ]
190 Xml
::openElement( 'td' ) . Xml
::openElement( 'ul' )
193 if ( !is_array( $rights ) ) {
194 $rights = [ $rights ];
197 foreach ( $rights as $right ) {
199 Html
::rawElement( 'li', [], $this->msg(
200 'listgrouprights-right-display',
201 User
::getRightDescription( $right ),
204 [ 'class' => 'mw-listgrouprights-right-name' ],
212 Xml
::closeElement( 'ul' ) .
213 Xml
::closeElement( 'td' ) .
214 Xml
::closeElement( 'tr' )
217 $out->addHTML( Xml
::closeElement( 'table' ) );
221 * Create a user-readable list of permissions from the given array.
223 * @param array $permissions Array of permission => bool (from $wgGroupPermissions items)
224 * @param array $revoke Array of permission => bool (from $wgRevokePermissions items)
225 * @param array $add Array of groups this group is allowed to add or true
226 * @param array $remove Array of groups this group is allowed to remove or true
227 * @param array $addSelf Array of groups this group is allowed to add to self or true
228 * @param array $removeSelf Array of group this group is allowed to remove from self or true
229 * @return string HTML list of all granted permissions
231 private function formatPermissions( $permissions, $revoke, $add, $remove, $addSelf, $removeSelf ) {
233 foreach ( $permissions as $permission => $granted ) {
234 // show as granted only if it isn't revoked to prevent duplicate display of permissions
235 if ( $granted && ( !isset( $revoke[$permission] ) ||
!$revoke[$permission] ) ) {
236 $r[] = $this->msg( 'listgrouprights-right-display',
237 User
::getRightDescription( $permission ),
238 '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
242 foreach ( $revoke as $permission => $revoked ) {
244 $r[] = $this->msg( 'listgrouprights-right-revoked',
245 User
::getRightDescription( $permission ),
246 '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
253 $lang = $this->getLanguage();
254 $allGroups = User
::getAllGroups();
258 'removegroup' => $remove,
259 'addgroup-self' => $addSelf,
260 'removegroup-self' => $removeSelf
263 foreach ( $changeGroups as $messageKey => $changeGroup ) {
264 if ( $changeGroup === true ) {
265 // For grep: listgrouprights-addgroup-all, listgrouprights-removegroup-all,
266 // listgrouprights-addgroup-self-all, listgrouprights-removegroup-self-all
267 $r[] = $this->msg( 'listgrouprights-' . $messageKey . '-all' )->escaped();
268 } elseif ( is_array( $changeGroup ) ) {
269 $changeGroup = array_intersect( array_values( array_unique( $changeGroup ) ), $allGroups );
270 if ( count( $changeGroup ) ) {
272 foreach ( $changeGroup as $group ) {
273 $groupLinks[] = UserGroupMembership
::getLink( $group, $this->getContext(), 'wiki' );
275 // For grep: listgrouprights-addgroup, listgrouprights-removegroup,
276 // listgrouprights-addgroup-self, listgrouprights-removegroup-self
277 $r[] = $this->msg( 'listgrouprights-' . $messageKey,
278 $lang->listToText( $groupLinks ), count( $changeGroup ) )->parse();
286 return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';
290 protected function getGroupName() {