PermissionAttachment.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\plugin\Plugin;
use pocketmine\plugin\PluginException;
use function spl_object_id;
 
class PermissionAttachment{
    private array $permissions = [];
 
    private array $subscribers = [];
 
    public function __construct(
        private Plugin $plugin
    ){
        if(!$plugin->isEnabled()){
            throw new PluginException("Plugin " . $plugin->getDescription()->getName() . " is disabled");
        }
    }
 
    public function getPlugin() : Plugin{
        return $this->plugin;
    }
 
    public function getSubscribers() : array{ return $this->subscribers; }
 
    public function getPermissions() : array{
        return $this->permissions;
    }
 
    private function recalculatePermissibles() : void{
        foreach($this->subscribers as $permissible){
            $permissible->recalculatePermissions();
        }
    }
 
    public function clearPermissions() : void{
        $this->permissions = [];
        $this->recalculatePermissibles();
    }
 
    public function setPermissions(array $permissions) : void{
        foreach($permissions as $key => $value){
            $this->permissions[$key] = $value;
        }
        $this->recalculatePermissibles();
    }
 
    public function unsetPermissions(array $permissions) : void{
        foreach($permissions as $node){
            unset($this->permissions[$node]);
        }
        $this->recalculatePermissibles();
    }
 
    public function setPermission(Permission|string $name, bool $value) : void{
        $name = $name instanceof Permission ? $name->getName() : $name;
        if(isset($this->permissions[$name])){
            if($this->permissions[$name] === $value){
                return;
            }
            /* Because of the way child permissions are calculated, permissions which were set later in time are
             * preferred over earlier ones when conflicts in inherited permission values occur.
             * Here's the kicker: This behaviour depends on PHP's internal array ordering, which maintains insertion
             * order -- BUT -- assigning to an existing index replaces the old value WITHOUT changing the order.
             * (what crazy person thought relying on this this was a good idea?!?!?!?!?!)
             *
             * This removes the old value so that the new value will be added at the end of the array's internal order
             * instead of directly taking the place of the older value.
             */
            unset($this->permissions[$name]);
        }
        $this->permissions[$name] = $value;
        $this->recalculatePermissibles();
    }
 
    public function unsetPermission(Permission|string $name) : void{
        $name = $name instanceof Permission ? $name->getName() : $name;
        if(isset($this->permissions[$name])){
            unset($this->permissions[$name]);
            $this->recalculatePermissibles();
        }
    }
 
    public function subscribePermissible(PermissibleInternal $permissible) : void{
        $this->subscribers[spl_object_id($permissible)] = $permissible;
    }
 
    public function unsubscribePermissible(PermissibleInternal $permissible) : void{
        unset($this->subscribers[spl_object_id($permissible)]);
    }
}