MWGrants.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class MWGrants {
 
    public static function getValidGrants() {
        global $wgGrantPermissions;
 
        return array_keys( $wgGrantPermissions );
    }
 
    public static function getRightsByGrant() {
        global $wgGrantPermissions;
 
        $res = [];
        foreach ( $wgGrantPermissions as $grant => $rights ) {
            $res[$grant] = array_keys( array_filter( $rights ) );
        }
        return $res;
    }
 
    public static function grantName( $grant, $lang = null ) {
        // Give grep a chance to find the usages:
        // grant-blockusers, grant-createeditmovepage, grant-delete,
        // grant-editinterface, grant-editmycssjs, grant-editmywatchlist,
        // grant-editsiteconfig, grant-editpage, grant-editprotected,
        // grant-highvolume, grant-oversight, grant-patrol, grant-protect,
        // grant-rollback, grant-sendemail, grant-uploadeditmovefile,
        // grant-uploadfile, grant-basic, grant-viewdeleted,
        // grant-viewmywatchlist, grant-createaccount
        $msg = wfMessage( "grant-$grant" );
        if ( $lang !== null ) {
            if ( is_string( $lang ) ) {
                $lang = Language::factory( $lang );
            }
            $msg->inLanguage( $lang );
        }
        if ( !$msg->exists() ) {
            $msg = wfMessage( 'grant-generic', $grant );
            if ( $lang ) {
                $msg->inLanguage( $lang );
            }
        }
        return $msg->text();
    }
 
    public static function grantNames( array $grants, $lang = null ) {
        if ( $lang !== null && is_string( $lang ) ) {
            $lang = Language::factory( $lang );
        }
 
        $ret = [];
        foreach ( $grants as $grant ) {
            $ret[] = self::grantName( $grant, $lang );
        }
        return $ret;
    }
 
    public static function getGrantRights( $grants ) {
        global $wgGrantPermissions;
 
        $rights = [];
        foreach ( (array)$grants as $grant ) {
            if ( isset( $wgGrantPermissions[$grant] ) ) {
                $rights = array_merge( $rights, array_keys( array_filter( $wgGrantPermissions[$grant] ) ) );
            }
        }
        return array_unique( $rights );
    }
 
    public static function grantsAreValid( array $grants ) {
        return array_diff( $grants, self::getValidGrants() ) === [];
    }
 
    public static function getGrantGroups( $grantsFilter = null ) {
        global $wgGrantPermissions, $wgGrantPermissionGroups;
 
        if ( is_array( $grantsFilter ) ) {
            $grantsFilter = array_flip( $grantsFilter );
        }
 
        $groups = [];
        foreach ( $wgGrantPermissions as $grant => $rights ) {
            if ( $grantsFilter !== null && !isset( $grantsFilter[$grant] ) ) {
                continue;
            }
            if ( isset( $wgGrantPermissionGroups[$grant] ) ) {
                $groups[$wgGrantPermissionGroups[$grant]][] = $grant;
            } else {
                $groups['other'][] = $grant;
            }
        }
 
        return $groups;
    }
 
    public static function getHiddenGrants() {
        global $wgGrantPermissionGroups;
 
        $grants = [];
        foreach ( $wgGrantPermissionGroups as $grant => $group ) {
            if ( $group === 'hidden' ) {
                $grants[] = $grant;
            }
        }
        return $grants;
    }
 
    public static function getGrantsLink( $grant, $lang = null ) {
        $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
        return $linkRenderer->makeKnownLink(
            \SpecialPage::getTitleFor( 'Listgrants', false, $grant ),
            self::grantName( $grant, $lang )
        );
    }
 
    public static function getGrantsWikiText( $grantsFilter, $lang = null ) {
        if ( is_string( $lang ) ) {
            $lang = Language::factory( $lang );
        } elseif ( $lang === null ) {
            $lang = MediaWikiServices::getInstance()->getContentLanguage();
        }
 
        $s = '';
        foreach ( self::getGrantGroups( $grantsFilter ) as $group => $grants ) {
            if ( $group === 'hidden' ) {
                continue; // implicitly granted
            }
            $s .= "*<span class=\"mw-grantgroup\">" .
                wfMessage( "grant-group-$group" )->inLanguage( $lang )->text() . "</span>\n";
            $s .= ":" . $lang->semicolonList( self::grantNames( $grants, $lang ) ) . "\n";
        }
        return "$s\n";
    }
 
}