PluginManager.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\plugin;
 
use pocketmine\event\Cancellable;
use pocketmine\event\Event;
use pocketmine\event\EventPriority;
use pocketmine\event\HandlerListManager;
use pocketmine\event\Listener;
use pocketmine\event\ListenerMethodTags;
use pocketmine\event\plugin\PluginDisableEvent;
use pocketmine\event\plugin\PluginEnableEvent;
use pocketmine\event\RegisteredListener;
use pocketmine\lang\KnownTranslationFactory;
use pocketmine\permission\DefaultPermissions;
use pocketmine\permission\PermissionManager;
use pocketmine\permission\PermissionParser;
use pocketmine\Server;
use pocketmine\timings\Timings;
use pocketmine\utils\AssumptionFailedError;
use pocketmine\utils\Utils;
use Symfony\Component\Filesystem\Path;
use function array_diff_key;
use function array_key_exists;
use function array_keys;
use function array_merge;
use function class_exists;
use function count;
use function dirname;
use function file_exists;
use function get_class;
use function implode;
use function is_a;
use function is_array;
use function is_dir;
use function is_file;
use function is_string;
use function is_subclass_of;
use function iterator_to_array;
use function mkdir;
use function realpath;
use function shuffle;
use function sprintf;
use function str_contains;
use function strtolower;
 
class PluginManager{
    protected array $plugins = [];
 
    protected array $enabledPlugins = [];
 
    private array $pluginDependents = [];
 
    private bool $loadPluginsGuard = false;
 
    protected array $fileAssociations = [];
 
    public function __construct(
        private Server $server,
        private ?string $pluginDataDirectory,
        private ?PluginGraylist $graylist = null
    ){
        if($this->pluginDataDirectory !== null){
            if(!file_exists($this->pluginDataDirectory)){
                @mkdir($this->pluginDataDirectory, 0777, true);
            }elseif(!is_dir($this->pluginDataDirectory)){
                throw new \RuntimeException("Plugin data path $this->pluginDataDirectory exists and is not a directory");
            }
        }
    }
 
    public function getPlugin(string $name) : ?Plugin{
        if(isset($this->plugins[$name])){
            return $this->plugins[$name];
        }
 
        return null;
    }
 
    public function registerInterface(PluginLoader $loader) : void{
        $this->fileAssociations[get_class($loader)] = $loader;
    }
 
    public function getPlugins() : array{
        return $this->plugins;
    }
 
    private function getDataDirectory(string $pluginPath, string $pluginName) : string{
        if($this->pluginDataDirectory !== null){
            return Path::join($this->pluginDataDirectory, $pluginName);
        }
        return Path::join(dirname($pluginPath), $pluginName);
    }
 
    private function internalLoadPlugin(string $path, PluginLoader $loader, PluginDescription $description) : ?Plugin{
        $language = $this->server->getLanguage();
        $this->server->getLogger()->info($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_load($description->getFullName())));
 
        $dataFolder = $this->getDataDirectory($path, $description->getName());
        if(file_exists($dataFolder) && !is_dir($dataFolder)){
            $this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                $description->getName(),
                KnownTranslationFactory::pocketmine_plugin_badDataFolder($dataFolder)
            )));
            return null;
        }
        if(!file_exists($dataFolder)){
            mkdir($dataFolder, 0777, true);
        }
 
        $prefixed = $loader->getAccessProtocol() . $path;
        $loader->loadPlugin($prefixed);
 
        $mainClass = $description->getMain();
        if(!class_exists($mainClass, true)){
            $this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                $description->getName(),
                KnownTranslationFactory::pocketmine_plugin_mainClassNotFound()
            )));
            return null;
        }
        if(!is_a($mainClass, Plugin::class, true)){
            $this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                $description->getName(),
                KnownTranslationFactory::pocketmine_plugin_mainClassWrongType(Plugin::class)
            )));
            return null;
        }
        $reflect = new \ReflectionClass($mainClass); //this shouldn't throw; we already checked that it exists
        if(!$reflect->isInstantiable()){
            $this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                $description->getName(),
                KnownTranslationFactory::pocketmine_plugin_mainClassAbstract()
            )));
            return null;
        }
 
        $permManager = PermissionManager::getInstance();
        foreach($description->getPermissions() as $permsGroup){
            foreach($permsGroup as $perm){
                if($permManager->getPermission($perm->getName()) !== null){
                    $this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                        $description->getName(),
                        KnownTranslationFactory::pocketmine_plugin_duplicatePermissionError($perm->getName())
                    )));
                    return null;
                }
            }
        }
        $opRoot = $permManager->getPermission(DefaultPermissions::ROOT_OPERATOR);
        $everyoneRoot = $permManager->getPermission(DefaultPermissions::ROOT_USER);
        foreach(Utils::stringifyKeys($description->getPermissions()) as $default => $perms){
            foreach($perms as $perm){
                $permManager->addPermission($perm);
                switch($default){
                    case PermissionParser::DEFAULT_TRUE:
                        $everyoneRoot->addChild($perm->getName(), true);
                        break;
                    case PermissionParser::DEFAULT_OP:
                        $opRoot->addChild($perm->getName(), true);
                        break;
                    case PermissionParser::DEFAULT_NOT_OP:
                        //TODO: I don't think anyone uses this, and it currently relies on some magic inside PermissibleBase
                        //to ensure that the operator override actually applies.
                        //Explore getting rid of this.
                        //The following grants this permission to anyone who has the "everyone" root permission.
                        //However, if the operator root node (which has higher priority) is present, the
                        //permission will be denied instead.
                        $everyoneRoot->addChild($perm->getName(), true);
                        $opRoot->addChild($perm->getName(), false);
                        break;
                    default:
                        break;
                }
            }
        }
 
        $plugin = new $mainClass($loader, $this->server, $description, $dataFolder, $prefixed, $prefixed . "/resources/");
        $this->plugins[$plugin->getDescription()->getName()] = $plugin;
 
        return $plugin;
    }
 
    private function triagePlugins(string $path, PluginLoadTriage $triage, int &$loadErrorCount, ?array $newLoaders = null) : void{
        if(is_array($newLoaders)){
            $loaders = [];
            foreach($newLoaders as $key){
                if(isset($this->fileAssociations[$key])){
                    $loaders[$key] = $this->fileAssociations[$key];
                }
            }
        }else{
            $loaders = $this->fileAssociations;
        }
 
        if(is_dir($path)){
            $files = iterator_to_array(new \FilesystemIterator($path, \FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS));
            shuffle($files); //this prevents plugins implicitly relying on the filesystem name order when they should be using dependency properties
        }elseif(is_file($path)){
            $realPath = Utils::assumeNotFalse(realpath($path), "realpath() should not return false on an accessible, existing file");
            $files = [$realPath];
        }else{
            return;
        }
 
        $loadabilityChecker = new PluginLoadabilityChecker($this->server->getApiVersion());
        foreach($loaders as $loader){
            foreach($files as $file){
                if(!is_string($file)) throw new AssumptionFailedError("FilesystemIterator current should be string when using CURRENT_AS_PATHNAME");
                if(!$loader->canLoadPlugin($file)){
                    continue;
                }
                try{
                    $description = $loader->getPluginDescription($file);
                }catch(PluginDescriptionParseException $e){
                    $this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                        $file,
                        KnownTranslationFactory::pocketmine_plugin_invalidManifest($e->getMessage())
                    )));
                    $loadErrorCount++;
                    continue;
                }catch(\RuntimeException $e){ //TODO: more specific exception handling
                    $this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError($file, $e->getMessage())));
                    $this->server->getLogger()->logException($e);
                    $loadErrorCount++;
                    continue;
                }
                if($description === null){
                    continue;
                }
 
                $name = $description->getName();
 
                if($this->graylist !== null && !$this->graylist->isAllowed($name)){
                    $this->server->getLogger()->notice($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                        $name,
                        $this->graylist->isWhitelist() ? KnownTranslationFactory::pocketmine_plugin_disallowedByWhitelist() : KnownTranslationFactory::pocketmine_plugin_disallowedByBlacklist()
                    )));
                    //this does NOT increment loadErrorCount, because using the graylist to prevent a plugin from
                    //loading is not considered accidental; this is the same as if the plugin were manually removed
                    //this means that the server will continue to boot even if some plugins were blocked by graylist
                    continue;
                }
 
                if(($loadabilityError = $loadabilityChecker->check($description)) !== null){
                    $this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError($name, $loadabilityError)));
                    $loadErrorCount++;
                    continue;
                }
 
                if(isset($triage->plugins[$name]) || $this->getPlugin($name) instanceof Plugin){
                    $this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_duplicateError($name)));
                    $loadErrorCount++;
                    continue;
                }
 
                if(str_contains($name, " ")){
                    $this->server->getLogger()->warning($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_spacesDiscouraged($name)));
                }
 
                $triage->plugins[$name] = new PluginLoadTriageEntry($file, $loader, $description);
 
                $triage->softDependencies[$name] = array_merge($triage->softDependencies[$name] ?? [], $description->getSoftDepend());
                $triage->dependencies[$name] = $description->getDepend();
 
                foreach($description->getLoadBefore() as $before){
                    if(isset($triage->softDependencies[$before])){
                        $triage->softDependencies[$before][] = $name;
                    }else{
                        $triage->softDependencies[$before] = [$name];
                    }
                }
            }
        }
    }
 
    private function checkDepsForTriage(string $pluginName, string $dependencyType, array &$dependencyLists, array $loadedPlugins, PluginLoadTriage $triage) : void{
        if(isset($dependencyLists[$pluginName])){
            foreach(Utils::promoteKeys($dependencyLists[$pluginName]) as $key => $dependency){
                if(isset($loadedPlugins[$dependency]) || $this->getPlugin($dependency) instanceof Plugin){
                    $this->server->getLogger()->debug("Successfully resolved $dependencyType dependency \"$dependency\" for plugin \"$pluginName\"");
                    unset($dependencyLists[$pluginName][$key]);
                }elseif(array_key_exists($dependency, $triage->plugins)){
                    $this->server->getLogger()->debug("Deferring resolution of $dependencyType dependency \"$dependency\" for plugin \"$pluginName\" (found but not loaded yet)");
                }
            }
 
            if(count($dependencyLists[$pluginName]) === 0){
                unset($dependencyLists[$pluginName]);
            }
        }
    }
 
    public function loadPlugins(string $path, int &$loadErrorCount = 0) : array{
        if($this->loadPluginsGuard){
            throw new \LogicException(__METHOD__ . "() cannot be called from within itself");
        }
        $this->loadPluginsGuard = true;
 
        $triage = new PluginLoadTriage();
        $this->triagePlugins($path, $triage, $loadErrorCount);
 
        $loadedPlugins = [];
 
        while(count($triage->plugins) > 0){
            $loadedThisLoop = 0;
            foreach(Utils::stringifyKeys($triage->plugins) as $name => $entry){
                $this->checkDepsForTriage($name, "hard", $triage->dependencies, $loadedPlugins, $triage);
                $this->checkDepsForTriage($name, "soft", $triage->softDependencies, $loadedPlugins, $triage);
 
                if(!isset($triage->dependencies[$name]) && !isset($triage->softDependencies[$name])){
                    unset($triage->plugins[$name]);
                    $loadedThisLoop++;
 
                    $oldRegisteredLoaders = $this->fileAssociations;
                    if(($plugin = $this->internalLoadPlugin($entry->getFile(), $entry->getLoader(), $entry->getDescription())) instanceof Plugin){
                        $loadedPlugins[$name] = $plugin;
                        $diffLoaders = [];
                        foreach($this->fileAssociations as $k => $loader){
                            if(!array_key_exists($k, $oldRegisteredLoaders)){
                                $diffLoaders[] = $k;
                            }
                        }
                        if(count($diffLoaders) !== 0){
                            $this->server->getLogger()->debug("Plugin $name registered a new plugin loader during load, scanning for new plugins");
                            $plugins = $triage->plugins;
                            $this->triagePlugins($path, $triage, $loadErrorCount, $diffLoaders);
                            $diffPlugins = array_diff_key($triage->plugins, $plugins);
                            $this->server->getLogger()->debug("Re-triage found plugins: " . implode(", ", array_keys($diffPlugins)));
                        }
                    }else{
                        $loadErrorCount++;
                    }
                }
            }
 
            if($loadedThisLoop === 0){
                //No plugins loaded :(
 
                //check for skippable soft dependencies first, in case the dependents could resolve hard dependencies
                foreach(Utils::stringifyKeys($triage->plugins) as $name => $file){
                    if(isset($triage->softDependencies[$name]) && !isset($triage->dependencies[$name])){
                        foreach(Utils::promoteKeys($triage->softDependencies[$name]) as $k => $dependency){
                            if($this->getPlugin($dependency) === null && !array_key_exists($dependency, $triage->plugins)){
                                $this->server->getLogger()->debug("Skipping resolution of missing soft dependency \"$dependency\" for plugin \"$name\"");
                                unset($triage->softDependencies[$name][$k]);
                            }
                        }
                        if(count($triage->softDependencies[$name]) === 0){
                            unset($triage->softDependencies[$name]);
                            continue 2; //go back to the top and try again
                        }
                    }
                }
 
                foreach(Utils::stringifyKeys($triage->plugins) as $name => $file){
                    if(isset($triage->dependencies[$name])){
                        $unknownDependencies = [];
 
                        foreach($triage->dependencies[$name] as $dependency){
                            if($this->getPlugin($dependency) === null && !array_key_exists($dependency, $triage->plugins)){
                                //assume that the plugin is never going to be loaded
                                //by this point all soft dependencies have been ignored if they were able to be, so
                                //there's no chance of this dependency ever being resolved
                                $unknownDependencies[$dependency] = $dependency;
                            }
                        }
 
                        if(count($unknownDependencies) > 0){
                            $this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
                                $name,
                                KnownTranslationFactory::pocketmine_plugin_unknownDependency(implode(", ", $unknownDependencies))
                            )));
                            unset($triage->plugins[$name]);
                            $loadErrorCount++;
                        }
                    }
                }
 
                foreach(Utils::stringifyKeys($triage->plugins) as $name => $file){
                    $this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError($name, KnownTranslationFactory::pocketmine_plugin_circularDependency())));
                    $loadErrorCount++;
                }
                break;
            }
        }
 
        $this->loadPluginsGuard = false;
        return $loadedPlugins;
    }
 
    public function isPluginEnabled(Plugin $plugin) : bool{
        return isset($this->plugins[$plugin->getDescription()->getName()]) && $plugin->isEnabled();
    }
 
    public function enablePlugin(Plugin $plugin) : bool{
        if(!$plugin->isEnabled()){
            $this->server->getLogger()->info($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_enable($plugin->getDescription()->getFullName())));
 
            $plugin->getScheduler()->setEnabled(true);
            try{
                $plugin->onEnableStateChange(true);
            }catch(DisablePluginException){
                $this->disablePlugin($plugin);
            }
 
            if($plugin->isEnabled()){ //the plugin may have disabled itself during onEnable()
                $this->enabledPlugins[$plugin->getDescription()->getName()] = $plugin;
 
                foreach($plugin->getDescription()->getDepend() as $dependency){
                    $this->pluginDependents[$dependency][$plugin->getDescription()->getName()] = true;
                }
                foreach($plugin->getDescription()->getSoftDepend() as $dependency){
                    if(isset($this->plugins[$dependency])){
                        $this->pluginDependents[$dependency][$plugin->getDescription()->getName()] = true;
                    }
                }
 
                (new PluginEnableEvent($plugin))->call();
 
                return true;
            }else{
                $this->server->getLogger()->critical($this->server->getLanguage()->translate(
                    KnownTranslationFactory::pocketmine_plugin_enableError(
                        $plugin->getName(),
                        KnownTranslationFactory::pocketmine_plugin_suicide()
                    )
                ));
 
                return false;
            }
        }
 
        return true; //TODO: maybe this should be an error?
    }
 
    public function disablePlugins() : void{
        while(count($this->enabledPlugins) > 0){
            foreach($this->enabledPlugins as $plugin){
                $name = $plugin->getDescription()->getName();
                if(isset($this->pluginDependents[$name]) && count($this->pluginDependents[$name]) > 0){
                    $this->server->getLogger()->debug("Deferring disable of plugin $name due to dependent plugins still enabled: " . implode(", ", array_keys($this->pluginDependents[$name])));
                    continue;
                }
 
                $this->disablePlugin($plugin);
            }
        }
    }
 
    private function disablePlugin(Plugin $plugin) : void{
        if($plugin->isEnabled()){
            $this->server->getLogger()->info($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_disable($plugin->getDescription()->getFullName())));
            (new PluginDisableEvent($plugin))->call();
 
            unset($this->enabledPlugins[$plugin->getDescription()->getName()]);
            foreach(Utils::stringifyKeys($this->pluginDependents) as $dependency => $dependentList){
                if(isset($this->pluginDependents[$dependency][$plugin->getDescription()->getName()])){
                    if(count($this->pluginDependents[$dependency]) === 1){
                        unset($this->pluginDependents[$dependency]);
                    }else{
                        unset($this->pluginDependents[$dependency][$plugin->getDescription()->getName()]);
                    }
                }
            }
 
            $plugin->onEnableStateChange(false);
            $plugin->getScheduler()->shutdown();
            HandlerListManager::global()->unregisterAll($plugin);
        }
    }
 
    public function tickSchedulers(int $currentTick) : void{
        foreach($this->enabledPlugins as $p){
            $p->getScheduler()->mainThreadHeartbeat($currentTick);
        }
    }
 
    private function getEventsHandledBy(\ReflectionMethod $method) : ?string{
        if($method->isStatic() || !$method->getDeclaringClass()->implementsInterface(Listener::class)){
            return null;
        }
        $tags = Utils::parseDocComment((string) $method->getDocComment());
        if(isset($tags[ListenerMethodTags::NOT_HANDLER])){
            return null;
        }
 
        $parameters = $method->getParameters();
        if(count($parameters) !== 1){
            return null;
        }
 
        $paramType = $parameters[0]->getType();
        //isBuiltin() returns false for builtin classes ..................
        if(!$paramType instanceof \ReflectionNamedType || $paramType->isBuiltin()){
            return null;
        }
 
        $paramClass = $paramType->getName();
        $eventClass = new \ReflectionClass($paramClass);
        if(!$eventClass->isSubclassOf(Event::class)){
            return null;
        }
 
        return $eventClass->getName();
    }
 
    public function registerEvents(Listener $listener, Plugin $plugin) : void{
        if(!$plugin->isEnabled()){
            throw new PluginException("Plugin attempted to register " . get_class($listener) . " while not enabled");
        }
 
        $reflection = new \ReflectionClass(get_class($listener));
        foreach($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method){
            $tags = Utils::parseDocComment((string) $method->getDocComment());
            if(isset($tags[ListenerMethodTags::NOT_HANDLER]) || ($eventClass = $this->getEventsHandledBy($method)) === null){
                continue;
            }
            $handlerClosure = $method->getClosure($listener);
            if($handlerClosure === null) throw new AssumptionFailedError("This should never happen");
 
            try{
                $priority = isset($tags[ListenerMethodTags::PRIORITY]) ? EventPriority::fromString($tags[ListenerMethodTags::PRIORITY]) : EventPriority::NORMAL;
            }catch(\InvalidArgumentException $e){
                throw new PluginException("Event handler " . Utils::getNiceClosureName($handlerClosure) . "() declares invalid/unknown priority \"" . $tags[ListenerMethodTags::PRIORITY] . "\"");
            }
 
            $handleCancelled = false;
            if(isset($tags[ListenerMethodTags::HANDLE_CANCELLED])){
                if(!is_a($eventClass, Cancellable::class, true)){
                    throw new PluginException(sprintf(
                        "Event handler %s() declares @%s for non-cancellable event of type %s",
                        Utils::getNiceClosureName($handlerClosure),
                        ListenerMethodTags::HANDLE_CANCELLED,
                        $eventClass
                    ));
                }
                switch(strtolower($tags[ListenerMethodTags::HANDLE_CANCELLED])){
                    case "true":
                    case "":
                        $handleCancelled = true;
                        break;
                    case "false":
                        break;
                    default:
                        throw new PluginException("Event handler " . Utils::getNiceClosureName($handlerClosure) . "() declares invalid @" . ListenerMethodTags::HANDLE_CANCELLED . " value \"" . $tags[ListenerMethodTags::HANDLE_CANCELLED] . "\"");
                }
            }
 
            $this->registerEvent($eventClass, $handlerClosure, $priority, $plugin, $handleCancelled);
        }
    }
 
    public function registerEvent(string $event, \Closure $handler, int $priority, Plugin $plugin, bool $handleCancelled = false) : RegisteredListener{
        if(!is_subclass_of($event, Event::class)){
            throw new PluginException($event . " is not an Event");
        }
 
        $handlerName = Utils::getNiceClosureName($handler);
 
        $reflect = new \ReflectionFunction($handler);
        if($reflect->isGenerator()){
            throw new PluginException("Generator function $handlerName cannot be used as an event handler");
        }
 
        if(!$plugin->isEnabled()){
            throw new PluginException("Plugin attempted to register event handler " . $handlerName . "() to event " . $event . " while not enabled");
        }
 
        $timings = Timings::getEventHandlerTimings($event, $handlerName, $plugin->getDescription()->getFullName());
 
        $registeredListener = new RegisteredListener($handler, $priority, $plugin, $handleCancelled, $timings);
        HandlerListManager::global()->getListFor($event)->register($registeredListener);
        return $registeredListener;
    }
}