includes/specials/SpecialListgrouprights.php

   1 <?php
   2 /**
   3  * Implements Special:Listgrouprights
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * This special page lists all defined user groups and the associated rights.
  26  * See also @ref $wgGroupPermissions.
  27  *
  28  * @ingroup SpecialPage
  29  * @author Petr Kadlec <mormegil@centrum.cz>
  30  */
  31 class SpecialListGroupRights extends SpecialPage {
  32         function __construct() {
  33                 parent::__construct( 'Listgrouprights' );
  34         }
  35
  36         /**
  37          * Show the special page
  38          * @param string|null $par
  39          */
  40         public function execute( $par ) {
  41                 $this->setHeaders();
  42                 $this->outputHeader();
  43
  44                 $out = $this->getOutput();
  45                 $out->addModuleStyles( 'mediawiki.special' );
  46
  47                 $out->wrapWikiMsg( "<div class=\"mw-listgrouprights-key\">\n$1\n</div>", 'listgrouprights-key' );
  48
  49                 $out->addHTML(
  50                         Xml::openElement( 'table', [ 'class' => 'wikitable mw-listgrouprights-table' ] ) .
  51                                 '<tr>' .
  52                                 Xml::element( 'th', null, $this->msg( 'listgrouprights-group' )->text() ) .
  53                                 Xml::element( 'th', null, $this->msg( 'listgrouprights-rights' )->text() ) .
  54                                 '</tr>'
  55                 );
  56
  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 )
  71                 ) );
  72                 asort( $allGroups );
  73
  74                 $linkRenderer = $this->getLinkRenderer();
  75
  76                 foreach ( $allGroups as $group ) {
  77                         $permissions = isset( $groupPermissions[$group] )
  78                                 ? $groupPermissions[$group]
  79                                 : [];
  80                         $groupname = ( $group == '*' ) // Replace * with a more descriptive groupname
  81                                 ? 'all'
  82                                 : $group;
  83
  84                         $msg = $this->msg( 'group-' . $groupname );
  85                         $groupnameLocalized = !$msg->isBlank() ? $msg->text() : $groupname;
  86
  87                         $msg = $this->msg( 'grouppage-' . $groupname )->inContentLanguage();
  88                         $grouppageLocalized = !$msg->isBlank() ?
  89                                 $msg->text() :
  90                                 MWNamespace::getCanonicalName( NS_PROJECT ) . ':' . $groupname;
  91                         $grouppageLocalizedTitle = Title::newFromText( $grouppageLocalized );
  92
  93                         if ( $group == '*' || !$grouppageLocalizedTitle ) {
  94                                 // Do not make a link for the generic * group or group with invalid group page
  95                                 $grouppage = htmlspecialchars( $groupnameLocalized );
  96                         } else {
  97                                 $grouppage = $linkRenderer->makeLink(
  98                                         $grouppageLocalizedTitle,
  99                                         $groupnameLocalized
 100                                 );
 101                         }
 102
 103                         if ( $group === 'user' ) {
 104                                 // Link to Special:listusers for implicit group 'user'
 105                                 $grouplink = '<br />' . $linkRenderer->makeKnownLink(
 106                                         SpecialPage::getTitleFor( 'Listusers' ),
 107                                         $this->msg( 'listgrouprights-members' )->text()
 108                                 );
 109                         } elseif ( !in_array( $group, $config->get( 'ImplicitGroups' ) ) ) {
 110                                 $grouplink = '<br />' . $linkRenderer->makeKnownLink(
 111                                         SpecialPage::getTitleFor( 'Listusers' ),
 112                                         $this->msg( 'listgrouprights-members' )->text(),
 113                                         [],
 114                                         [ 'group' => $group ]
 115                                 );
 116                         } else {
 117                                 // No link to Special:listusers for other implicit groups as they are unlistable
 118                                 $grouplink = '';
 119                         }
 120
 121                         $revoke = isset( $revokePermissions[$group] ) ? $revokePermissions[$group] : [];
 122                         $addgroups = isset( $addGroups[$group] ) ? $addGroups[$group] : [];
 123                         $removegroups = isset( $removeGroups[$group] ) ? $removeGroups[$group] : [];
 124                         $addgroupsSelf = isset( $groupsAddToSelf[$group] ) ? $groupsAddToSelf[$group] : [];
 125                         $removegroupsSelf = isset( $groupsRemoveFromSelf[$group] )
 126                                 ? $groupsRemoveFromSelf[$group]
 127                                 : [];
 128
 129                         $id = $group == '*' ? false : Sanitizer::escapeId( $group );
 130                         $out->addHTML( Html::rawElement( 'tr', [ 'id' => $id ], "
 131                                 <td>$grouppage$grouplink</td>
 132                                         <td>" .
 133                                         $this->formatPermissions( $permissions, $revoke, $addgroups, $removegroups,
 134                                                 $addgroupsSelf, $removegroupsSelf ) .
 135                                         '</td>
 136                                 '
 137                         ) );
 138                 }
 139                 $out->addHTML( Xml::closeElement( 'table' ) );
 140                 $this->outputNamespaceProtectionInfo();
 141         }
 142
 143         private function outputNamespaceProtectionInfo() {
 144                 global $wgParser, $wgContLang;
 145                 $out = $this->getOutput();
 146                 $namespaceProtection = $this->getConfig()->get( 'NamespaceProtection' );
 147
 148                 if ( count( $namespaceProtection ) == 0 ) {
 149                         return;
 150                 }
 151
 152                 $header = $this->msg( 'listgrouprights-namespaceprotection-header' )->parse();
 153                 $out->addHTML(
 154                         Html::rawElement( 'h2', [], Html::element( 'span', [
 155                                 'class' => 'mw-headline',
 156                                 'id' => $wgParser->guessSectionNameFromWikiText( $header )
 157                         ], $header ) ) .
 158                         Xml::openElement( 'table', [ 'class' => 'wikitable' ] ) .
 159                         Html::element(
 160                                 'th',
 161                                 [],
 162                                 $this->msg( 'listgrouprights-namespaceprotection-namespace' )->text()
 163                         ) .
 164                         Html::element(
 165                                 'th',
 166                                 [],
 167                                 $this->msg( 'listgrouprights-namespaceprotection-restrictedto' )->text()
 168                         )
 169                 );
 170                 $linkRenderer = $this->getLinkRenderer();
 171                 ksort( $namespaceProtection );
 172                 foreach ( $namespaceProtection as $namespace => $rights ) {
 173                         if ( !in_array( $namespace, MWNamespace::getValidNamespaces() ) ) {
 174                                 continue;
 175                         }
 176
 177                         if ( $namespace == NS_MAIN ) {
 178                                 $namespaceText = $this->msg( 'blanknamespace' )->text();
 179                         } else {
 180                                 $namespaceText = $wgContLang->convertNamespace( $namespace );
 181                         }
 182
 183                         $out->addHTML(
 184                                 Xml::openElement( 'tr' ) .
 185                                 Html::rawElement(
 186                                         'td',
 187                                         [],
 188                                         $linkRenderer->makeLink(
 189                                                 SpecialPage::getTitleFor( 'Allpages' ),
 190                                                 $namespaceText,
 191                                                 [],
 192                                                 [ 'namespace' => $namespace ]
 193                                         )
 194                                 ) .
 195                                 Xml::openElement( 'td' ) . Xml::openElement( 'ul' )
 196                         );
 197
 198                         if ( !is_array( $rights ) ) {
 199                                 $rights = [ $rights ];
 200                         }
 201
 202                         foreach ( $rights as $right ) {
 203                                 $out->addHTML(
 204                                         Html::rawElement( 'li', [], $this->msg(
 205                                                 'listgrouprights-right-display',
 206                                                 User::getRightDescription( $right ),
 207                                                 Html::element(
 208                                                         'span',
 209                                                         [ 'class' => 'mw-listgrouprights-right-name' ],
 210                                                         $right
 211                                                 )
 212                                         )->parse() )
 213                                 );
 214                         }
 215
 216                         $out->addHTML(
 217                                 Xml::closeElement( 'ul' ) .
 218                                 Xml::closeElement( 'td' ) .
 219                                 Xml::closeElement( 'tr' )
 220                         );
 221                 }
 222                 $out->addHTML( Xml::closeElement( 'table' ) );
 223         }
 224
 225         /**
 226          * Create a user-readable list of permissions from the given array.
 227          *
 228          * @param array $permissions Array of permission => bool (from $wgGroupPermissions items)
 229          * @param array $revoke Array of permission => bool (from $wgRevokePermissions items)
 230          * @param array $add Array of groups this group is allowed to add or true
 231          * @param array $remove Array of groups this group is allowed to remove or true
 232          * @param array $addSelf Array of groups this group is allowed to add to self or true
 233          * @param array $removeSelf Array of group this group is allowed to remove from self or true
 234          * @return string List of all granted permissions, separated by comma separator
 235          */
 236         private function formatPermissions( $permissions, $revoke, $add, $remove, $addSelf, $removeSelf ) {
 237                 $r = [];
 238                 foreach ( $permissions as $permission => $granted ) {
 239                         // show as granted only if it isn't revoked to prevent duplicate display of permissions
 240                         if ( $granted && ( !isset( $revoke[$permission] ) || !$revoke[$permission] ) ) {
 241                                 $r[] = $this->msg( 'listgrouprights-right-display',
 242                                         User::getRightDescription( $permission ),
 243                                         '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
 244                                 )->parse();
 245                         }
 246                 }
 247                 foreach ( $revoke as $permission => $revoked ) {
 248                         if ( $revoked ) {
 249                                 $r[] = $this->msg( 'listgrouprights-right-revoked',
 250                                         User::getRightDescription( $permission ),
 251                                         '<span class="mw-listgrouprights-right-name">' . $permission . '</span>'
 252                                 )->parse();
 253                         }
 254                 }
 255
 256                 sort( $r );
 257
 258                 $lang = $this->getLanguage();
 259                 $allGroups = User::getAllGroups();
 260
 261                 $changeGroups = [
 262                         'addgroup' => $add,
 263                         'removegroup' => $remove,
 264                         'addgroup-self' => $addSelf,
 265                         'removegroup-self' => $removeSelf
 266                 ];
 267
 268                 foreach ( $changeGroups as $messageKey => $changeGroup ) {
 269                         if ( $changeGroup === true ) {
 270                                 // For grep: listgrouprights-addgroup-all, listgrouprights-removegroup-all,
 271                                 // listgrouprights-addgroup-self-all, listgrouprights-removegroup-self-all
 272                                 $r[] = $this->msg( 'listgrouprights-' . $messageKey . '-all' )->escaped();
 273                         } elseif ( is_array( $changeGroup ) ) {
 274                                 $changeGroup = array_intersect( array_values( array_unique( $changeGroup ) ), $allGroups );
 275                                 if ( count( $changeGroup ) ) {
 276                                         // For grep: listgrouprights-addgroup, listgrouprights-removegroup,
 277                                         // listgrouprights-addgroup-self, listgrouprights-removegroup-self
 278                                         $r[] = $this->msg( 'listgrouprights-' . $messageKey,
 279                                                 $lang->listToText( array_map( [ 'User', 'makeGroupLinkWiki' ], $changeGroup ) ),
 280                                                 count( $changeGroup )
 281                                         )->parse();
 282                                 }
 283                         }
 284                 }
 285
 286                 if ( empty( $r ) ) {
 287                         return '';
 288                 } else {
 289                         return '<ul><li>' . implode( "</li>\n<li>", $r ) . '</li></ul>';
 290                 }
 291         }
 292
 293         protected function getGroupName() {
 294                 return 'users';
 295         }
 296 }