includes/exception/PermissionsError.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use MediaWiki\MediaWikiServices;
  22
  23 /**
  24  * Show an error when a user tries to do something they do not have the necessary
  25  * permissions for.
  26  *
  27  * @since 1.18
  28  * @ingroup Exception
  29  */
  30 class PermissionsError extends ErrorPageError {
  31         public $permission, $errors;
  32
  33         /**
  34          * @param string|null $permission A permission name or null if unknown
  35          * @param array $errors Error message keys or [key, param...] arrays; must not be empty if
  36          *   $permission is null
  37          * @throws \InvalidArgumentException
  38          */
  39         public function __construct( $permission, $errors = [] ) {
  40                 global $wgLang;
  41
  42                 if ( $permission === null && !$errors ) {
  43                         throw new \InvalidArgumentException( __METHOD__ .
  44                                 ': $permission and $errors cannot both be empty' );
  45                 }
  46
  47                 $this->permission = $permission;
  48
  49                 if ( !count( $errors ) ) {
  50                         $groups = [];
  51                         foreach ( MediaWikiServices::getInstance()
  52                                                   ->getPermissionManager()
  53                                                   ->getGroupsWithPermission( $this->permission ) as $group ) {
  54                                 $groups[] = UserGroupMembership::getLink( $group, RequestContext::getMain(), 'wiki' );
  55                         }
  56
  57                         if ( $groups ) {
  58                                 $errors[] = [ 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) ];
  59                         } else {
  60                                 $errors[] = [ 'badaccess-group0' ];
  61                         }
  62                 }
  63
  64                 $this->errors = $errors;
  65
  66                 // Give the parent class something to work with
  67                 parent::__construct( 'permissionserrors', Message::newFromSpecifier( $errors[0] ) );
  68         }
  69
  70         public function report() {
  71                 global $wgOut;
  72
  73                 $wgOut->showPermissionsErrorPage( $this->errors, $this->permission );
  74                 $wgOut->output();
  75         }
  76 }