PermissionParser.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\permission;
 
use pocketmine\utils\Utils;
use function is_bool;
use function strtolower;
 
class PermissionParser{
 
    public const DEFAULT_OP = "op";
    public const DEFAULT_NOT_OP = "notop";
    public const DEFAULT_TRUE = "true";
    public const DEFAULT_FALSE = "false";
 
    public const DEFAULT_STRING_MAP = [
        "op" => self::DEFAULT_OP,
        "isop" => self::DEFAULT_OP,
        "operator" => self::DEFAULT_OP,
        "isoperator" => self::DEFAULT_OP,
        "admin" => self::DEFAULT_OP,
        "isadmin" => self::DEFAULT_OP,
 
        "!op" => self::DEFAULT_NOT_OP,
        "notop" => self::DEFAULT_NOT_OP,
        "!operator" => self::DEFAULT_NOT_OP,
        "notoperator" => self::DEFAULT_NOT_OP,
        "!admin" => self::DEFAULT_NOT_OP,
        "notadmin" => self::DEFAULT_NOT_OP,
 
        "true" => self::DEFAULT_TRUE,
        "false" => self::DEFAULT_FALSE,
    ];
 
    private const KEY_DEFAULT = "default";
    private const KEY_CHILDREN = "children";
    private const KEY_DESCRIPTION = "description";
 
    public static function defaultFromString(bool|string $value) : string{
        if(is_bool($value)){
            return $value ? self::DEFAULT_TRUE : self::DEFAULT_FALSE;
        }
        $lower = strtolower($value);
        if(isset(self::DEFAULT_STRING_MAP[$lower])){
            return self::DEFAULT_STRING_MAP[$lower];
        }
 
        throw new PermissionParserException("Unknown permission default name \"$value\"");
    }
 
    public static function loadPermissions(array $data, string $default = self::DEFAULT_FALSE) : array{
        $result = [];
        foreach(Utils::stringifyKeys($data) as $name => $entry){
            $desc = null;
            if(isset($entry[self::KEY_DEFAULT])){
                $default = PermissionParser::defaultFromString($entry[self::KEY_DEFAULT]);
            }
 
            if(isset($entry[self::KEY_CHILDREN])){
                throw new PermissionParserException("Nested permission declarations are no longer supported. Declare each permission separately.");
            }
 
            if(isset($entry[self::KEY_DESCRIPTION])){
                $desc = $entry[self::KEY_DESCRIPTION];
            }
 
            $result[$default][] = new Permission($name, $desc);
        }
        return $result;
    }
}