-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
-> Added plugins cron function
- Loading branch information
Showing
5 changed files
with
327 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ | |
| "Bethropolis", | ||
| "ccaches", | ||
| "configpath", | ||
| "cronfile", | ||
| "dbconfigure", | ||
| "doesinfoexist", | ||
| "ealready", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,284 @@ | ||
| <?php | ||
|
|
||
| namespace MythicalSystemsFramework\Plugins; | ||
|
|
||
| use MythicalSystemsFramework\Kernel\Logger; | ||
| use MythicalSystemsFramework\Kernel\LoggerTypes; | ||
| use MythicalSystemsFramework\Kernel\LoggerLevels; | ||
|
|
||
| class PluginCompilerHelper | ||
| { | ||
| public static string $plugins_path = __DIR__ . '/../../storage/addons'; | ||
|
|
||
| /** | ||
| * Ensure the plugin path exists. | ||
| * | ||
| * @return void | ||
| */ | ||
| public static function ensurePluginPathExists(): void | ||
| { | ||
| if (!file_exists(self::$plugins_path)) { | ||
| mkdir(self::$plugins_path, 0777, true); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Check the requirements of a plugin. | ||
| * | ||
| * @param string $plugin | ||
| * @param array $plugin_info | ||
| * @return void | ||
| */ | ||
| public static function checkPluginRequirements(string $plugin, array $plugin_info): void | ||
| { | ||
| if (isset($plugin_info['require'])) { | ||
| $requirements = $plugin_info['require']; | ||
| foreach ($requirements as $requirement) { | ||
| // Skip default plugin | ||
| if ($requirement == 'MythicalSystemsFramework') { | ||
| continue; | ||
| } | ||
|
|
||
| // Check if the requirement is a composer package | ||
| if (strpos($requirement, 'composer=') === 0) { | ||
| $composerVersion = substr($requirement, strlen('composer=')); | ||
| if (\Composer\InstalledVersions::isInstalled($composerVersion, true)) { | ||
| continue; | ||
| } else { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, "Plugin $plugin requires composer package $composerVersion to be installed."); | ||
| } | ||
| } | ||
|
|
||
| // Check if the requirement is a php version | ||
| if (strpos($requirement, 'php=') === 0) { | ||
| $phpVersion = substr($requirement, strlen('php=')); | ||
| if (version_compare(PHP_VERSION, $phpVersion, '<')) { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, "Plugin $plugin requires PHP version $phpVersion or higher."); | ||
| } else { | ||
| continue; | ||
| } | ||
| } | ||
|
|
||
| // Check if the requirement is a php extension | ||
| if (strpos($requirement, 'php-ext=') === 0) { | ||
| $ext = substr($requirement, strlen('php-ext=')); | ||
| if (!extension_loaded($ext)) { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, "Plugin $plugin requires PHP extension $ext to be installed."); | ||
| } else { | ||
| continue; | ||
| } | ||
| } | ||
|
|
||
| // Check if the requirement is a plugin | ||
| $isInstalled = self::readPluginFile($requirement); | ||
| if ($isInstalled) { | ||
| continue; | ||
| } else { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, "Plugin $plugin requires $requirement to be installed."); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Register a plugin if it is not already registered. | ||
| * | ||
| * @param array $plugin_info | ||
| * @return void | ||
| */ | ||
| public static function registerPluginIfNotRegistered(array $plugin_info): void | ||
| { | ||
| if (!Database::doesInfoExist('name', $plugin_info['name']) == true) { | ||
| $p = $plugin_info; | ||
|
|
||
| $p_homepage = $p['homepage'] ?? null; | ||
| $p_license = $p['license'] ?? null; | ||
| $p_support = $p['support'] ?? null; | ||
| $p_funding = $p['funding'] ?? null; | ||
| $p_require = $p['require'] ?? 'MythicalSystemsFramework'; | ||
| Database::registerNewPlugin($p['name'], $p['description'], $p_homepage, $p_require, $p_license, $p['stability'], $p['authors'], $p_support, $p_funding, $p['version'], false); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Update a plugin if it is outdated. | ||
| * | ||
| * @param array $plugin_info | ||
| * @return void | ||
| */ | ||
| public static function updatePluginIfOutdated(array $plugin_info): void | ||
| { | ||
| $plugin_info_db = Database::getPlugin($plugin_info['name']); | ||
| if ($plugin_info_db['enabled'] == 'true') { | ||
| $version_db = $plugin_info_db['version']; | ||
| $version_filesystem = $plugin_info['version']; | ||
|
|
||
| if ($version_db != $version_filesystem) { | ||
| $plugin_db_info_enabled = $plugin_info_db['enabled']; | ||
| Database::unRegisterPlugin($plugin_info['name']); | ||
| $p = $plugin_info; | ||
|
|
||
| $p_homepage = $p['homepage'] ?? null; | ||
| $p_license = $p['license'] ?? null; | ||
| $p_support = $p['support'] ?? null; | ||
| $p_funding = $p['funding'] ?? null; | ||
| $p_require = $p['require'] ?? 'MythicalSystemsFramework'; | ||
| Database::registerNewPlugin($p['name'], $p['description'], $p_homepage, $p_require, $p_license, $p['stability'], $p['authors'], $p_support, $p_funding, $p['version'], false); | ||
| Database::updatePlugin($plugin_info['name'], 'enabled', $plugin_db_info_enabled); | ||
| Logger::log(LoggerLevels::INFO, LoggerTypes::PLUGIN, 'Plugin ' . $plugin_info['name'] . ' has been updated to version ' . $plugin_info['version']); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Enable a plugin. | ||
| * | ||
| * @param string $plugin | ||
| * @param array $plugin_info | ||
| * @param PluginEvent $eventHandler | ||
| * @param bool $skipEventEnable | ||
| * | ||
| * @return void | ||
| */ | ||
| public static function enablePlugin(string $plugin, array $plugin_info, PluginEvent $eventHandler, bool $skipEventEnable = false): void | ||
| { | ||
| $plugin_info_db = Database::getPlugin($plugin_info['name']); | ||
| $plugin_home_dir = self::$plugins_path . '/' . $plugin_info['name']; | ||
| $main_class = $plugin_home_dir . '/' . $plugin_info_db['name'] . '.php'; | ||
| if (file_exists($main_class)) { | ||
| try { | ||
| require_once $main_class; | ||
| $plugin_class = new $plugin_info_db['name'](); | ||
| $plugin_class->Main(); | ||
| try { | ||
| if (!$skipEventEnable) { | ||
| $plugin_class->Event($eventHandler); | ||
| } | ||
| } catch (\Exception $e) { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, 'Failed to add events for plugin' . $plugin_info_db['name'] . '' . $e->getMessage()); | ||
| } | ||
| } catch (\Exception $e) { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, "Something failed while we tried to enable the plugin '" . $plugin_info_db['name'] . "'. " . $e->getMessage()); | ||
| } | ||
| } else { | ||
| Logger::log(LoggerLevels::CRITICAL, LoggerTypes::PLUGIN, "The main class for plugin '$plugin' does not exist."); | ||
| } | ||
| } | ||
| /** | ||
| * Get all plugins. | ||
| */ | ||
| public static function getAllPlugins(): array | ||
| { | ||
| self::ensurePluginPathExists(); | ||
| $plugins = []; | ||
| foreach (scandir(self::$plugins_path) as $plugin) { | ||
| if ($plugin == '.' || $plugin == '..') { | ||
| continue; | ||
| } | ||
| $pluginPath = self::$plugins_path . '/' . $plugin; | ||
| if (is_dir($pluginPath)) { | ||
| $json_file = $pluginPath . '/MythicalFramework.json'; | ||
| if (file_exists($json_file)) { | ||
| $json = json_decode(file_get_contents($json_file), true); | ||
| if (isset($json['name']) && $json['name'] === $plugin) { | ||
| $plugins[] = $plugin; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $plugins; | ||
| } | ||
|
|
||
| /** | ||
| * Get plugin info. | ||
| */ | ||
| public static function readPluginFile(string $plugin_name): array | ||
| { | ||
| self::ensurePluginPathExists(); | ||
| if (!self::doesPluginExist($plugin_name)) { | ||
| return []; | ||
| } | ||
| if (!self::isPluginConfigValid($plugin_name)) { | ||
| return []; | ||
| } | ||
| $json_file = self::$plugins_path . '/' . $plugin_name . '/MythicalFramework.json'; | ||
|
|
||
| return json_decode(file_get_contents($json_file), true); | ||
| } | ||
|
|
||
| /** | ||
| * Does a plugin exist? | ||
| * | ||
| * @param string $plugin_name The name of the plugin | ||
| */ | ||
| public static function doesPluginExist(string $plugin_name): bool | ||
| { | ||
| self::ensurePluginPathExists(); | ||
| $plugin_folder = self::$plugins_path . '/' . $plugin_name . '/MythicalFramework.json'; | ||
|
|
||
| return file_exists($plugin_folder); | ||
| } | ||
|
|
||
| /** | ||
| * Is the plugin config valid? | ||
| * | ||
| * @param string $plugin_name The name of the plugin | ||
| */ | ||
| public static function isPluginConfigValid(string $plugin_name): bool | ||
| { | ||
| self::ensurePluginPathExists(); | ||
| if (!self::doesPluginExist($plugin_name)) { | ||
| return false; | ||
| } | ||
| $json_file = self::$plugins_path . '/' . $plugin_name . '/MythicalFramework.json'; | ||
| if (file_exists($json_file)) { | ||
| $json = json_decode(file_get_contents($json_file), true); | ||
| if (isset($json['name']) && isset($json['description']) && isset($json['stability']) && isset($json['authors']) && isset($json['version']) && isset($json['require'])) { | ||
| return true; | ||
| } else { | ||
| return false; | ||
| } | ||
| } else { | ||
| return false; | ||
| } | ||
| } | ||
| /** | ||
| * Does a plugin have a cron job folder? | ||
| * | ||
| * @param string $plugin_name | ||
| * | ||
| * @return bool | ||
| */ | ||
| public static function doesPluginHaveCron(string $plugin_name) { | ||
| self::ensurePluginPathExists(); | ||
| if (!self::doesPluginExist($plugin_name)) { | ||
| return false; | ||
| } | ||
| $plugin_folder = self::$plugins_path . '/' . $plugin_name . '/crons'; | ||
| return file_exists($plugin_folder); | ||
| } | ||
| /** | ||
| * | ||
| * Get all cron files for a plugin. | ||
| * | ||
| * @param string $plugin_name | ||
| * @return array | ||
| */ | ||
| public static function getPluginCronFiles(string $plugin_name) { | ||
| self::ensurePluginPathExists(); | ||
| if (!self::doesPluginExist($plugin_name)) { | ||
| return []; | ||
| } | ||
| $plugin_folder = self::$plugins_path . '/' . $plugin_name . '/crons'; | ||
| $files = []; | ||
| foreach (scandir($plugin_folder) as $file) { | ||
| if ($file == '.' || $file == '..') { | ||
| continue; | ||
| } | ||
| $files[] = $file; | ||
| } | ||
| return $files; | ||
| } | ||
| } |
Oops, something went wrong.