Command.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\command;
 
use pocketmine\command\utils\CommandException;
use pocketmine\lang\KnownTranslationFactory;
use pocketmine\lang\Translatable;
use pocketmine\permission\PermissionManager;
use pocketmine\Server;
use pocketmine\utils\BroadcastLoggerForwarder;
use pocketmine\utils\TextFormat;
use function array_values;
use function explode;
use function implode;
use function str_replace;
use const PHP_INT_MAX;
 
abstract class Command{
 
    private string $name;
 
    private string $nextLabel;
    private string $label;
 
    private array $aliases = [];
 
    private array $activeAliases = [];
 
    private ?CommandMap $commandMap = null;
 
    protected Translatable|string $description = "";
 
    protected Translatable|string $usageMessage;
 
    private array $permission = [];
    private Translatable|string|null $permissionMessage = null;
 
    public function __construct(string $name, Translatable|string $description = "", Translatable|string|null $usageMessage = null, array $aliases = []){
        $this->name = $name;
        $this->setLabel($name);
        $this->setDescription($description);
        $this->usageMessage = $usageMessage ?? ("/" . $name);
        $this->setAliases($aliases);
    }
 
    abstract public function execute(CommandSender $sender, string $commandLabel, array $args);
 
    public function getName() : string{
        return $this->name;
    }
 
    public function getPermissions() : array{
        return $this->permission;
    }
 
    public function setPermissions(array $permissions) : void{
        $permissionManager = PermissionManager::getInstance();
        foreach($permissions as $perm){
            if($permissionManager->getPermission($perm) === null){
                throw new \InvalidArgumentException("Cannot use non-existing permission \"$perm\"");
            }
        }
        $this->permission = $permissions;
    }
 
    public function setPermission(?string $permission) : void{
        $this->setPermissions($permission === null ? [] : explode(";", $permission, limit: PHP_INT_MAX));
    }
 
    public function testPermission(CommandSender $target, ?string $permission = null) : bool{
        if($this->testPermissionSilent($target, $permission)){
            return true;
        }
 
        $message = $this->permissionMessage ?? KnownTranslationFactory::pocketmine_command_error_permission($this->name);
        if($message instanceof Translatable){
            $target->sendMessage($message->prefix(TextFormat::RED));
        }elseif($message !== ""){
            $target->sendMessage(str_replace("<permission>", $permission ?? implode(";", $this->permission), $message));
        }
 
        return false;
    }
 
    public function testPermissionSilent(CommandSender $target, ?string $permission = null) : bool{
        $list = $permission !== null ? [$permission] : $this->permission;
        foreach($list as $p){
            if($target->hasPermission($p)){
                return true;
            }
        }
 
        return false;
    }
 
    public function getLabel() : string{
        return $this->label;
    }
 
    public function setLabel(string $name) : bool{
        $this->nextLabel = $name;
        if(!$this->isRegistered()){
            $this->label = $name;
 
            return true;
        }
 
        return false;
    }
 
    public function register(CommandMap $commandMap) : bool{
        if($this->allowChangesFrom($commandMap)){
            $this->commandMap = $commandMap;
 
            return true;
        }
 
        return false;
    }
 
    public function unregister(CommandMap $commandMap) : bool{
        if($this->allowChangesFrom($commandMap)){
            $this->commandMap = null;
            $this->activeAliases = $this->aliases;
            $this->label = $this->nextLabel;
 
            return true;
        }
 
        return false;
    }
 
    private function allowChangesFrom(CommandMap $commandMap) : bool{
        return $this->commandMap === null || $this->commandMap === $commandMap;
    }
 
    public function isRegistered() : bool{
        return $this->commandMap !== null;
    }
 
    public function getAliases() : array{
        return $this->activeAliases;
    }
 
    public function getPermissionMessage() : Translatable|string|null{
        return $this->permissionMessage;
    }
 
    public function getDescription() : Translatable|string{
        return $this->description;
    }
 
    public function getUsage() : Translatable|string{
        return $this->usageMessage;
    }
 
    public function setAliases(array $aliases) : void{
        $aliases = array_values($aliases); //because plugins can and will pass crap
        $this->aliases = $aliases;
        if(!$this->isRegistered()){
            $this->activeAliases = $aliases;
        }
    }
 
    public function setDescription(Translatable|string $description) : void{
        $this->description = $description;
    }
 
    public function setPermissionMessage(Translatable|string $permissionMessage) : void{
        $this->permissionMessage = $permissionMessage;
    }
 
    public function setUsage(Translatable|string $usage) : void{
        $this->usageMessage = $usage;
    }
 
    public static function broadcastCommandMessage(CommandSender $source, Translatable|string $message, bool $sendToSource = true) : void{
        $users = $source->getServer()->getBroadcastChannelSubscribers(Server::BROADCAST_CHANNEL_ADMINISTRATIVE);
        $result = KnownTranslationFactory::chat_type_admin($source->getName(), $message);
        $colored = $result->prefix(TextFormat::GRAY . TextFormat::ITALIC);
 
        if($sendToSource){
            $source->sendMessage($message);
        }
 
        foreach($users as $user){
            if($user instanceof BroadcastLoggerForwarder){
                $user->sendMessage($result);
            }elseif($user !== $source){
                $user->sendMessage($colored);
            }
        }
    }
 
    public function __toString() : string{
        return $this->name;
    }
}