mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-04-21 08:17:34 +00:00
Stop the server if any plugin failed to load or enable (#4951)
closes #3080 If plugins fail to load for some reason, it's highly likely that some critical functionality of the server is compromised. For example: - if an NPC plugin fails to load, all custom entities added by that plugin will be deleted from worlds - if a world protection plugin fails, players will be able to grief your otherwise immutable lobby map - if a worldgen plugin fails, worlds using custom generators won't load - if a permission plugin fails, players might have access to commands and features they aren't supposed to have - the list goes on... This change makes the server commit graceful suicide if any plugin fails to load for error-related reasons, including (but not limited to): - Incompatible API version - Missing dependencies - Invalid plugin.yml - Invalid main class Plugins prevented from loading by `plugin_list.yml` are not considered errors and **are not** included in this change. If a plugin is disallowed from loading due to the `plugin_list`, the server will continue to run as if the plugin was not present.
This commit is contained in:
Dylan T
GitHub
parent
3b7e274c34
commit
52e74296de
@ -1003,14 +1003,29 @@ class Server{
|
||||
|
||||
register_shutdown_function([$this, "crashDump"]);
|
||||
|
||||
$this->pluginManager->loadPlugins($this->pluginPath);
|
||||
$this->enablePlugins(PluginEnableOrder::STARTUP());
|
||||
$loadErrorCount = 0;
|
||||
$this->pluginManager->loadPlugins($this->pluginPath, $loadErrorCount);
|
||||
if($loadErrorCount > 0){
|
||||
$this->logger->emergency($this->language->translate(KnownTranslationFactory::pocketmine_plugin_someLoadErrors()));
|
||||
$this->forceShutdown();
|
||||
return;
|
||||
}
|
||||
if(!$this->enablePlugins(PluginEnableOrder::STARTUP())){
|
||||
$this->logger->emergency($this->language->translate(KnownTranslationFactory::pocketmine_plugin_someEnableErrors()));
|
||||
$this->forceShutdown();
|
||||
return;
|
||||
}
|
||||
|
||||
if(!$this->startupPrepareWorlds()){
|
||||
$this->forceShutdown();
|
||||
return;
|
||||
}
|
||||
$this->enablePlugins(PluginEnableOrder::POSTWORLD());
|
||||
|
||||
if(!$this->enablePlugins(PluginEnableOrder::POSTWORLD())){
|
||||
$this->logger->emergency($this->language->translate(KnownTranslationFactory::pocketmine_plugin_someEnableErrors()));
|
||||
$this->forceShutdown();
|
||||
return;
|
||||
}
|
||||
|
||||
if(!$this->startupPrepareNetworkInterfaces()){
|
||||
$this->forceShutdown();
|
||||
@ -1395,16 +1410,21 @@ class Server{
|
||||
}
|
||||
}
|
||||
|
||||
public function enablePlugins(PluginEnableOrder $type) : void{
|
||||
public function enablePlugins(PluginEnableOrder $type) : bool{
|
||||
$allSuccess = true;
|
||||
foreach($this->pluginManager->getPlugins() as $plugin){
|
||||
if(!$plugin->isEnabled() && $plugin->getDescription()->getOrder()->equals($type)){
|
||||
$this->pluginManager->enablePlugin($plugin);
|
||||
if(!$this->pluginManager->enablePlugin($plugin)){
|
||||
$allSuccess = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if($type->equals(PluginEnableOrder::POSTWORLD())){
|
||||
$this->commandMap->registerServerAliases();
|
||||
}
|
||||
|
||||
return $allSuccess;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -138,7 +138,7 @@ class PluginManager{
|
||||
|
||||
$dataFolder = $this->getDataDirectory($path, $description->getName());
|
||||
if(file_exists($dataFolder) && !is_dir($dataFolder)){
|
||||
$this->server->getLogger()->error($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$description->getName(),
|
||||
KnownTranslationFactory::pocketmine_plugin_badDataFolder($dataFolder)
|
||||
)));
|
||||
@ -153,14 +153,14 @@ class PluginManager{
|
||||
|
||||
$mainClass = $description->getMain();
|
||||
if(!class_exists($mainClass, true)){
|
||||
$this->server->getLogger()->error($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$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()->error($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$description->getName(),
|
||||
KnownTranslationFactory::pocketmine_plugin_mainClassWrongType(Plugin::class)
|
||||
)));
|
||||
@ -168,7 +168,7 @@ class PluginManager{
|
||||
}
|
||||
$reflect = new \ReflectionClass($mainClass); //this shouldn't throw; we already checked that it exists
|
||||
if(!$reflect->isInstantiable()){
|
||||
$this->server->getLogger()->error($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$description->getName(),
|
||||
KnownTranslationFactory::pocketmine_plugin_mainClassAbstract()
|
||||
)));
|
||||
@ -179,7 +179,7 @@ class PluginManager{
|
||||
foreach($description->getPermissions() as $permsGroup){
|
||||
foreach($permsGroup as $perm){
|
||||
if($permManager->getPermission($perm->getName()) !== null){
|
||||
$this->server->getLogger()->error($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$this->server->getLogger()->critical($language->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$description->getName(),
|
||||
KnownTranslationFactory::pocketmine_plugin_duplicatePermissionError($perm->getName())
|
||||
)));
|
||||
@ -229,7 +229,7 @@ class PluginManager{
|
||||
* @param string[]|null $newLoaders
|
||||
* @phpstan-param list<class-string<PluginLoader>> $newLoaders
|
||||
*/
|
||||
private function triagePlugins(string $path, PluginLoadTriage $triage, ?array $newLoaders = null) : void{
|
||||
private function triagePlugins(string $path, PluginLoadTriage $triage, int &$loadErrorCount, ?array $newLoaders = null) : void{
|
||||
if(is_array($newLoaders)){
|
||||
$loaders = [];
|
||||
foreach($newLoaders as $key){
|
||||
@ -261,14 +261,16 @@ class PluginManager{
|
||||
try{
|
||||
$description = $loader->getPluginDescription($file);
|
||||
}catch(PluginDescriptionParseException $e){
|
||||
$this->server->getLogger()->error($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError(
|
||||
$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()->error($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError($file, $e->getMessage())));
|
||||
$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){
|
||||
@ -278,12 +280,14 @@ class PluginManager{
|
||||
$name = $description->getName();
|
||||
|
||||
if(($loadabilityError = $loadabilityChecker->check($description)) !== null){
|
||||
$this->server->getLogger()->error($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_loadError($name, $loadabilityError)));
|
||||
$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()->error($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_duplicateError($name)));
|
||||
$this->server->getLogger()->critical($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_duplicateError($name)));
|
||||
$loadErrorCount++;
|
||||
continue;
|
||||
}
|
||||
|
||||
@ -296,6 +300,9 @@ class PluginManager{
|
||||
$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;
|
||||
}
|
||||
|
||||
@ -339,14 +346,14 @@ class PluginManager{
|
||||
/**
|
||||
* @return Plugin[]
|
||||
*/
|
||||
public function loadPlugins(string $path) : array{
|
||||
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);
|
||||
$this->triagePlugins($path, $triage, $loadErrorCount);
|
||||
|
||||
$loadedPlugins = [];
|
||||
|
||||
@ -372,10 +379,12 @@ class PluginManager{
|
||||
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, $diffLoaders);
|
||||
$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++;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -418,12 +427,14 @@ class PluginManager{
|
||||
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;
|
||||
}
|
||||
@ -437,7 +448,7 @@ class PluginManager{
|
||||
return isset($this->plugins[$plugin->getDescription()->getName()]) && $plugin->isEnabled();
|
||||
}
|
||||
|
||||
public function enablePlugin(Plugin $plugin) : void{
|
||||
public function enablePlugin(Plugin $plugin) : bool{
|
||||
if(!$plugin->isEnabled()){
|
||||
$this->server->getLogger()->info($this->server->getLanguage()->translate(KnownTranslationFactory::pocketmine_plugin_enable($plugin->getDescription()->getFullName())));
|
||||
|
||||
@ -447,6 +458,8 @@ class PluginManager{
|
||||
$this->enabledPlugins[$plugin->getDescription()->getName()] = $plugin;
|
||||
|
||||
(new PluginEnableEvent($plugin))->call();
|
||||
|
||||
return true;
|
||||
}else{
|
||||
$this->server->getLogger()->critical($this->server->getLanguage()->translate(
|
||||
KnownTranslationFactory::pocketmine_plugin_enableError(
|
||||
@ -454,8 +467,12 @@ class PluginManager{
|
||||
KnownTranslationFactory::pocketmine_plugin_suicide()
|
||||
)
|
||||
));
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true; //TODO: maybe this should be an error?
|
||||
}
|
||||
|
||||
public function disablePlugins() : void{
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user