mirror of
https://github.com/wintercms/winter.git
synced 2024-06-28 05:33:29 +02:00
b564e3178d
Only add missing dependencies to the list of missing dependencies once per dependency. Credit to @gergo85
756 lines
19 KiB
PHP
756 lines
19 KiB
PHP
<?php namespace System\Classes;
|
|
|
|
use App;
|
|
use Str;
|
|
use File;
|
|
use Lang;
|
|
use View;
|
|
use Config;
|
|
use RecursiveIteratorIterator;
|
|
use RecursiveDirectoryIterator;
|
|
use ApplicationException;
|
|
|
|
/**
|
|
* Plugin manager
|
|
*
|
|
* @package october\system
|
|
* @author Alexey Bobkov, Samuel Georges
|
|
*/
|
|
class PluginManager
|
|
{
|
|
use \October\Rain\Support\Traits\Singleton;
|
|
|
|
/**
|
|
* The application instance, since Plugins are an extension of a Service Provider
|
|
*/
|
|
protected $app;
|
|
|
|
/**
|
|
* Container object used for storing plugin information objects.
|
|
*/
|
|
protected $plugins;
|
|
|
|
/**
|
|
* @var array A map of plugins and their directory paths.
|
|
*/
|
|
protected $pathMap = [];
|
|
|
|
/**
|
|
* @var bool Check if all plugins have had the register() method called.
|
|
*/
|
|
protected $registered = false;
|
|
|
|
/**
|
|
* @var bool Check if all plugins have had the boot() method called.
|
|
*/
|
|
protected $booted = false;
|
|
|
|
/**
|
|
* @var string Path to the disarm file.
|
|
*/
|
|
protected $metaFile;
|
|
|
|
/**
|
|
* @var array Collection of disabled plugins
|
|
*/
|
|
protected $disabledPlugins = [];
|
|
|
|
/**
|
|
* @var array Cache of registration method results.
|
|
*/
|
|
protected $registrationMethodCache = [];
|
|
|
|
/**
|
|
* @var boolean Prevent all plugins from registering or booting
|
|
*/
|
|
public static $noInit = false;
|
|
|
|
/**
|
|
* Initializes the plugin manager
|
|
*/
|
|
protected function init()
|
|
{
|
|
$this->bindContainerObjects();
|
|
$this->metaFile = storage_path('cms/disabled.json');
|
|
$this->loadDisabled();
|
|
$this->loadPlugins();
|
|
|
|
if ($this->app->runningInBackend()) {
|
|
$this->loadDependencies();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* These objects are "soft singletons" and may be lost when
|
|
* the IoC container reboots. This provides a way to rebuild
|
|
* for the purposes of unit testing.
|
|
*/
|
|
public function bindContainerObjects()
|
|
{
|
|
$this->app = App::make('app');
|
|
}
|
|
|
|
/**
|
|
* Finds all available plugins and loads them in to the $plugins array.
|
|
* @return array
|
|
*/
|
|
public function loadPlugins()
|
|
{
|
|
$this->plugins = [];
|
|
|
|
/**
|
|
* Locate all plugins and binds them to the container
|
|
*/
|
|
foreach ($this->getPluginNamespaces() as $namespace => $path) {
|
|
$this->loadPlugin($namespace, $path);
|
|
}
|
|
|
|
return $this->plugins;
|
|
}
|
|
|
|
/**
|
|
* Loads a single plugin in to the manager.
|
|
* @param string $namespace Eg: Acme\Blog
|
|
* @param string $path Eg: plugins_path().'/acme/blog';
|
|
* @return void
|
|
*/
|
|
public function loadPlugin($namespace, $path)
|
|
{
|
|
$className = $namespace.'\Plugin';
|
|
$classPath = $path.'/Plugin.php';
|
|
|
|
// Autoloader failed?
|
|
if (!class_exists($className)) {
|
|
include_once $classPath;
|
|
}
|
|
|
|
// Not a valid plugin!
|
|
if (!class_exists($className)) {
|
|
return;
|
|
}
|
|
|
|
$classObj = new $className($this->app);
|
|
$classId = $this->getIdentifier($classObj);
|
|
|
|
/*
|
|
* Check for disabled plugins
|
|
*/
|
|
if ($this->isDisabled($classId)) {
|
|
$classObj->disabled = true;
|
|
}
|
|
|
|
$this->plugins[$classId] = $classObj;
|
|
$this->pathMap[$classId] = $path;
|
|
|
|
return $classObj;
|
|
}
|
|
|
|
/**
|
|
* Runs the register() method on all plugins. Can only be called once.
|
|
* @return void
|
|
*/
|
|
public function registerAll($force = false)
|
|
{
|
|
if ($this->registered && !$force) {
|
|
return;
|
|
}
|
|
|
|
foreach ($this->plugins as $pluginId => $plugin) {
|
|
$this->registerPlugin($plugin, $pluginId);
|
|
}
|
|
|
|
$this->registered = true;
|
|
}
|
|
|
|
/**
|
|
* Unregisters all plugins: the negative of registerAll().
|
|
* @return void
|
|
*/
|
|
public function unregisterAll()
|
|
{
|
|
$this->registered = false;
|
|
$this->plugins = [];
|
|
}
|
|
|
|
/**
|
|
* Registers a single plugin object.
|
|
* @param PluginBase $plugin
|
|
* @param string $pluginId
|
|
* @return void
|
|
*/
|
|
public function registerPlugin($plugin, $pluginId = null)
|
|
{
|
|
if (!$pluginId) {
|
|
$pluginId = $this->getIdentifier($plugin);
|
|
}
|
|
|
|
if (!$plugin) {
|
|
return;
|
|
}
|
|
|
|
$pluginPath = $this->getPluginPath($plugin);
|
|
$pluginNamespace = strtolower($pluginId);
|
|
|
|
/*
|
|
* Register language namespaces
|
|
*/
|
|
$langPath = $pluginPath . '/lang';
|
|
if (File::isDirectory($langPath)) {
|
|
Lang::addNamespace($pluginNamespace, $langPath);
|
|
}
|
|
|
|
if ($plugin->disabled) {
|
|
return;
|
|
}
|
|
|
|
/*
|
|
* Register plugin class autoloaders
|
|
*/
|
|
$autoloadPath = $pluginPath . '/vendor/autoload.php';
|
|
if (File::isFile($autoloadPath)) {
|
|
ComposerManager::instance()->autoload($pluginPath . '/vendor');
|
|
}
|
|
|
|
if (!self::$noInit || $plugin->elevated) {
|
|
$plugin->register();
|
|
}
|
|
|
|
/*
|
|
* Register configuration path
|
|
*/
|
|
$configPath = $pluginPath . '/config';
|
|
if (File::isDirectory($configPath)) {
|
|
Config::package($pluginNamespace, $configPath, $pluginNamespace);
|
|
}
|
|
|
|
/*
|
|
* Register views path
|
|
*/
|
|
$viewsPath = $pluginPath . '/views';
|
|
if (File::isDirectory($viewsPath)) {
|
|
View::addNamespace($pluginNamespace, $viewsPath);
|
|
}
|
|
|
|
/*
|
|
* Add init, if available
|
|
*/
|
|
$initFile = $pluginPath . '/init.php';
|
|
if (!self::$noInit && File::exists($initFile)) {
|
|
require $initFile;
|
|
}
|
|
|
|
/*
|
|
* Add routes, if available
|
|
*/
|
|
$routesFile = $pluginPath . '/routes.php';
|
|
if (File::exists($routesFile)) {
|
|
require $routesFile;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Runs the boot() method on all plugins. Can only be called once.
|
|
*/
|
|
public function bootAll($force = false)
|
|
{
|
|
if ($this->booted && !$force) {
|
|
return;
|
|
}
|
|
|
|
foreach ($this->plugins as $plugin) {
|
|
$this->bootPlugin($plugin);
|
|
}
|
|
|
|
$this->booted = true;
|
|
}
|
|
|
|
/**
|
|
* Registers a single plugin object.
|
|
* @param PluginBase $plugin
|
|
* @return void
|
|
*/
|
|
public function bootPlugin($plugin)
|
|
{
|
|
if (!$plugin || $plugin->disabled) {
|
|
return;
|
|
}
|
|
|
|
if (!self::$noInit || $plugin->elevated) {
|
|
$plugin->boot();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the directory path to a plugin
|
|
*/
|
|
public function getPluginPath($id)
|
|
{
|
|
$classId = $this->getIdentifier($id);
|
|
if (!isset($this->pathMap[$classId])) {
|
|
return null;
|
|
}
|
|
|
|
return File::normalizePath($this->pathMap[$classId]);
|
|
}
|
|
|
|
/**
|
|
* Check if a plugin exists and is enabled.
|
|
* @param string $id Plugin identifier, eg: Namespace.PluginName
|
|
* @return boolean
|
|
*/
|
|
public function exists($id)
|
|
{
|
|
return (!$this->findByIdentifier($id) || $this->isDisabled($id))
|
|
? false
|
|
: true;
|
|
}
|
|
|
|
/**
|
|
* Returns an array with all registered plugins
|
|
* The index is the plugin namespace, the value is the plugin information object.
|
|
*/
|
|
public function getPlugins()
|
|
{
|
|
return array_diff_key($this->plugins, $this->disabledPlugins);
|
|
}
|
|
|
|
/**
|
|
* Returns a plugin registration class based on its namespace (Author\Plugin).
|
|
*/
|
|
public function findByNamespace($namespace)
|
|
{
|
|
if (!$this->hasPlugin($namespace)) {
|
|
return null;
|
|
}
|
|
|
|
$classId = $this->getIdentifier($namespace);
|
|
|
|
return $this->plugins[$classId];
|
|
}
|
|
|
|
/**
|
|
* Returns a plugin registration class based on its identifier (Author.Plugin).
|
|
*/
|
|
public function findByIdentifier($identifier)
|
|
{
|
|
if (!isset($this->plugins[$identifier])) {
|
|
$identifier = $this->normalizeIdentifier($identifier);
|
|
}
|
|
|
|
if (!isset($this->plugins[$identifier])) {
|
|
return null;
|
|
}
|
|
|
|
return $this->plugins[$identifier];
|
|
}
|
|
|
|
/**
|
|
* Checks to see if a plugin has been registered.
|
|
*/
|
|
public function hasPlugin($namespace)
|
|
{
|
|
$classId = $this->getIdentifier($namespace);
|
|
|
|
return isset($this->plugins[$classId]);
|
|
}
|
|
|
|
/**
|
|
* Returns a flat array of vendor plugin namespaces and their paths
|
|
*/
|
|
public function getPluginNamespaces()
|
|
{
|
|
$classNames = [];
|
|
|
|
foreach ($this->getVendorAndPluginNames() as $vendorName => $vendorList) {
|
|
foreach ($vendorList as $pluginName => $pluginPath) {
|
|
$namespace = '\\'.$vendorName.'\\'.$pluginName;
|
|
$namespace = Str::normalizeClassName($namespace);
|
|
$classNames[$namespace] = $pluginPath;
|
|
}
|
|
}
|
|
|
|
return $classNames;
|
|
}
|
|
|
|
/**
|
|
* Returns a 2 dimensional array of vendors and their plugins.
|
|
*/
|
|
public function getVendorAndPluginNames()
|
|
{
|
|
$plugins = [];
|
|
|
|
$dirPath = plugins_path();
|
|
if (!File::isDirectory($dirPath)) {
|
|
return $plugins;
|
|
}
|
|
|
|
$it = new RecursiveIteratorIterator(
|
|
new RecursiveDirectoryIterator($dirPath, RecursiveDirectoryIterator::FOLLOW_SYMLINKS)
|
|
);
|
|
$it->setMaxDepth(2);
|
|
$it->rewind();
|
|
|
|
while ($it->valid()) {
|
|
if (($it->getDepth() > 1) && $it->isFile() && (strtolower($it->getFilename()) == "plugin.php")) {
|
|
$filePath = dirname($it->getPathname());
|
|
$pluginName = basename($filePath);
|
|
$vendorName = basename(dirname($filePath));
|
|
$plugins[$vendorName][$pluginName] = $filePath;
|
|
}
|
|
|
|
$it->next();
|
|
}
|
|
|
|
return $plugins;
|
|
}
|
|
|
|
/**
|
|
* Resolves a plugin identifier from a plugin class name or object.
|
|
* @param mixed Plugin class name or object
|
|
* @return string Identifier in format of Vendor.Plugin
|
|
*/
|
|
public function getIdentifier($namespace)
|
|
{
|
|
$namespace = Str::normalizeClassName($namespace);
|
|
if (strpos($namespace, '\\') === null) {
|
|
return $namespace;
|
|
}
|
|
|
|
$parts = explode('\\', $namespace);
|
|
$slice = array_slice($parts, 1, 2);
|
|
$namespace = implode('.', $slice);
|
|
|
|
return $namespace;
|
|
}
|
|
|
|
/**
|
|
* Takes a human plugin code (acme.blog) and makes it authentic (Acme.Blog)
|
|
* @param string $id
|
|
* @return string
|
|
*/
|
|
public function normalizeIdentifier($identifier)
|
|
{
|
|
foreach ($this->plugins as $id => $object) {
|
|
if (strtolower($id) == strtolower($identifier)) {
|
|
return $id;
|
|
}
|
|
}
|
|
|
|
return $identifier;
|
|
}
|
|
|
|
/**
|
|
* Spins over every plugin object and collects the results of a method call.
|
|
* @param string $methodName
|
|
* @return array
|
|
*/
|
|
public function getRegistrationMethodValues($methodName)
|
|
{
|
|
if (isset($this->registrationMethodCache[$methodName])) {
|
|
return $this->registrationMethodCache[$methodName];
|
|
}
|
|
|
|
$results = [];
|
|
$plugins = $this->getPlugins();
|
|
|
|
foreach ($plugins as $id => $plugin) {
|
|
if (!method_exists($plugin, $methodName)) {
|
|
continue;
|
|
}
|
|
|
|
$results[$id] = $plugin->{$methodName}();
|
|
}
|
|
|
|
return $this->registrationMethodCache[$methodName] = $results;
|
|
}
|
|
|
|
//
|
|
// Disability
|
|
//
|
|
|
|
public function clearDisabledCache()
|
|
{
|
|
File::delete($this->metaFile);
|
|
$this->disabledPlugins = [];
|
|
}
|
|
|
|
/**
|
|
* Loads all disables plugins from the meta file.
|
|
*/
|
|
protected function loadDisabled()
|
|
{
|
|
$path = $this->metaFile;
|
|
|
|
if (($configDisabled = Config::get('cms.disablePlugins')) && is_array($configDisabled)) {
|
|
foreach ($configDisabled as $disabled) {
|
|
$this->disabledPlugins[$disabled] = true;
|
|
}
|
|
}
|
|
|
|
if (File::exists($path)) {
|
|
$disabled = json_decode(File::get($path), true) ?: [];
|
|
$this->disabledPlugins = array_merge($this->disabledPlugins, $disabled);
|
|
}
|
|
else {
|
|
$this->writeDisabled();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines if a plugin is disabled by looking at the meta information
|
|
* or the application configuration.
|
|
* @return boolean
|
|
*/
|
|
public function isDisabled($id)
|
|
{
|
|
$code = $this->getIdentifier($id);
|
|
|
|
if (array_key_exists($code, $this->disabledPlugins)) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Write the disabled plugins to a meta file.
|
|
*/
|
|
protected function writeDisabled()
|
|
{
|
|
File::put($this->metaFile, json_encode($this->disabledPlugins));
|
|
}
|
|
|
|
/**
|
|
* Disables a single plugin in the system.
|
|
* @param string $id Plugin code/namespace
|
|
* @param bool $isUser Set to true if disabled by the user
|
|
* @return bool
|
|
*/
|
|
public function disablePlugin($id, $isUser = false)
|
|
{
|
|
$code = $this->getIdentifier($id);
|
|
if (array_key_exists($code, $this->disabledPlugins)) {
|
|
return false;
|
|
}
|
|
|
|
$this->disabledPlugins[$code] = $isUser;
|
|
$this->writeDisabled();
|
|
|
|
if ($pluginObj = $this->findByIdentifier($code)) {
|
|
$pluginObj->disabled = true;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Enables a single plugin in the system.
|
|
* @param string $id Plugin code/namespace
|
|
* @param bool $isUser Set to true if enabled by the user
|
|
* @return bool
|
|
*/
|
|
public function enablePlugin($id, $isUser = false)
|
|
{
|
|
$code = $this->getIdentifier($id);
|
|
if (!array_key_exists($code, $this->disabledPlugins)) {
|
|
return false;
|
|
}
|
|
|
|
// Prevent system from enabling plugins disabled by the user
|
|
if (!$isUser && $this->disabledPlugins[$code] === true) {
|
|
return false;
|
|
}
|
|
|
|
unset($this->disabledPlugins[$code]);
|
|
$this->writeDisabled();
|
|
|
|
if ($pluginObj = $this->findByIdentifier($code)) {
|
|
$pluginObj->disabled = false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//
|
|
// Dependencies
|
|
//
|
|
|
|
/**
|
|
* Scans the system plugins to locate any dependencies that are not currently
|
|
* installed. Returns an array of plugin codes that are needed.
|
|
*
|
|
* PluginManager::instance()->findMissingDependencies();
|
|
*
|
|
* @return array
|
|
*/
|
|
public function findMissingDependencies()
|
|
{
|
|
$missing = [];
|
|
|
|
foreach ($this->plugins as $id => $plugin) {
|
|
if (!$required = $this->getDependencies($plugin)) {
|
|
continue;
|
|
}
|
|
|
|
foreach ($required as $require) {
|
|
if ($this->hasPlugin($require)) {
|
|
continue;
|
|
}
|
|
|
|
if (!in_array($require, $missing)) {
|
|
$missing[] = $require;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $missing;
|
|
}
|
|
|
|
/**
|
|
* Cross checks all plugins and their dependancies, if not met plugins
|
|
* are disabled and vice versa.
|
|
* @return void
|
|
*/
|
|
protected function loadDependencies()
|
|
{
|
|
foreach ($this->plugins as $id => $plugin) {
|
|
if (!$required = $this->getDependencies($plugin)) {
|
|
continue;
|
|
}
|
|
|
|
$disable = false;
|
|
|
|
foreach ($required as $require) {
|
|
if (!$pluginObj = $this->findByIdentifier($require)) {
|
|
$disable = true;
|
|
}
|
|
elseif ($pluginObj->disabled) {
|
|
$disable = true;
|
|
}
|
|
}
|
|
|
|
if ($disable) {
|
|
$this->disablePlugin($id);
|
|
}
|
|
else {
|
|
$this->enablePlugin($id);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the plugin identifiers that are required by the supplied plugin.
|
|
* @param string $plugin Plugin identifier, object or class
|
|
* @return array
|
|
*/
|
|
public function getDependencies($plugin)
|
|
{
|
|
if (is_string($plugin) && (!$plugin = $this->findByIdentifier($plugin))) {
|
|
return false;
|
|
}
|
|
|
|
if (!isset($plugin->require) || !$plugin->require) {
|
|
return null;
|
|
}
|
|
|
|
return is_array($plugin->require) ? $plugin->require : [$plugin->require];
|
|
}
|
|
|
|
/**
|
|
* Sorts a collection of plugins, in the order that they should be actioned,
|
|
* according to their given dependencies. Least dependent come first.
|
|
* @param array $plugins Object collection to sort, or null to sort all.
|
|
* @return array Collection of sorted plugin identifiers
|
|
*/
|
|
public function sortByDependencies($plugins = null)
|
|
{
|
|
if (!is_array($plugins)) {
|
|
$plugins = $this->getPlugins();
|
|
}
|
|
|
|
$result = [];
|
|
$checklist = $plugins;
|
|
|
|
$loopCount = 0;
|
|
while (count($checklist)) {
|
|
|
|
if (++$loopCount > 999) {
|
|
throw new ApplicationException('Too much recursion');
|
|
}
|
|
|
|
foreach ($checklist as $code => $plugin) {
|
|
|
|
/*
|
|
* Get dependencies and remove any aliens
|
|
*/
|
|
$depends = $this->getDependencies($plugin) ?: [];
|
|
$depends = array_filter($depends, function ($pluginCode) use ($plugins) {
|
|
return isset($plugins[$pluginCode]);
|
|
});
|
|
|
|
/*
|
|
* No dependencies
|
|
*/
|
|
if (!$depends) {
|
|
array_push($result, $code);
|
|
unset($checklist[$code]);
|
|
continue;
|
|
}
|
|
|
|
/*
|
|
* Find dependencies that have not been checked
|
|
*/
|
|
$depends = array_diff($depends, $result);
|
|
if (count($depends) > 0) {
|
|
continue;
|
|
}
|
|
|
|
/*
|
|
* All dependencies are checked
|
|
*/
|
|
array_push($result, $code);
|
|
unset($checklist[$code]);
|
|
}
|
|
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
//
|
|
// Management
|
|
//
|
|
|
|
/**
|
|
* Completely roll back and delete a plugin from the system.
|
|
* @param string $id Plugin code/namespace
|
|
* @return void
|
|
*/
|
|
public function deletePlugin($id)
|
|
{
|
|
/*
|
|
* Rollback plugin
|
|
*/
|
|
UpdateManager::instance()->rollbackPlugin($id);
|
|
|
|
/*
|
|
* Delete from file system
|
|
*/
|
|
if ($pluginPath = PluginManager::instance()->getPluginPath($id)) {
|
|
File::deleteDirectory($pluginPath);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tears down a plugin's database tables and rebuilds them.
|
|
* @param string $id Plugin code/namespace
|
|
* @return void
|
|
*/
|
|
public function refreshPlugin($id)
|
|
{
|
|
$manager = UpdateManager::instance();
|
|
$manager->rollbackPlugin($id);
|
|
$manager->updatePlugin($id);
|
|
}
|
|
}
|