2 namespace Shaarli\Plugin
;
4 use Shaarli\Config\ConfigManager
;
5 use Shaarli\Plugin\Exception\PluginFileNotFoundException
;
10 * Use to manage, load and execute plugins.
15 * List of authorized plugins from configuration file.
17 * @var array $authorizedPlugins
19 private $authorizedPlugins = [];
22 * List of loaded plugins.
24 * @var array $loadedPlugins
26 private $loadedPlugins = array();
29 * @var ConfigManager Configuration Manager instance.
34 * @var array List of plugin errors.
39 * Plugins subdirectory.
41 * @var string $PLUGINS_PATH
43 public static $PLUGINS_PATH = 'plugins';
46 * Plugins meta files extension.
48 * @var string $META_EXT
50 public static $META_EXT = 'meta';
55 * @param ConfigManager $conf Configuration Manager instance.
57 public function __construct(&$conf)
60 $this->errors
= array();
64 * Load plugins listed in $authorizedPlugins.
66 * @param array $authorizedPlugins Names of plugin authorized to be loaded.
70 public function load($authorizedPlugins)
72 $this->authorizedPlugins
= $authorizedPlugins;
74 $dirs = glob(self
::$PLUGINS_PATH . '/*', GLOB_ONLYDIR
);
75 $dirnames = array_map('basename', $dirs);
76 foreach ($this->authorizedPlugins
as $plugin) {
77 $index = array_search($plugin, $dirnames);
79 // plugin authorized, but its folder isn't listed
80 if ($index === false) {
85 $this->loadPlugin($dirs[$index], $plugin);
86 } catch (PluginFileNotFoundException
$e) {
87 error_log($e->getMessage());
93 * Execute all plugins registered hook.
95 * @param string $hook name of the hook to trigger.
96 * @param array $data list of data to manipulate passed by reference.
97 * @param array $params additional parameters such as page target.
101 public function executeHooks($hook, &$data, $params = array())
103 $metadataParameters = [
104 'target' => '_PAGE_',
105 'loggedin' => '_LOGGEDIN_',
106 'basePath' => '_BASE_PATH_',
107 'rootPath' => '_ROOT_PATH_',
108 'bookmarkService' => '_BOOKMARK_SERVICE_',
111 foreach ($metadataParameters as $parameter => $metaKey) {
112 if (array_key_exists($parameter, $params)) {
113 $data[$metaKey] = $params[$parameter];
117 foreach ($this->loadedPlugins
as $plugin) {
118 $hookFunction = $this->buildHookName($hook, $plugin);
120 if (function_exists($hookFunction)) {
122 $data = call_user_func($hookFunction, $data, $this->conf
);
123 } catch (\Throwable
$e) {
124 $error = $plugin . t(' [plugin incompatibility]: ') . $e->getMessage();
125 $this->errors
= array_unique(array_merge($this->errors
, [$error]));
130 foreach ($metadataParameters as $metaKey) {
131 unset($data[$metaKey]);
136 * Load a single plugin from its files.
137 * Call the init function if it exists, and collect errors.
138 * Add them in $loadedPlugins if successful.
140 * @param string $dir plugin's directory.
141 * @param string $pluginName plugin's name.
144 * @throws \Shaarli\Plugin\Exception\PluginFileNotFoundException - plugin files not found.
146 private function loadPlugin($dir, $pluginName)
149 throw new PluginFileNotFoundException($pluginName);
152 $pluginFilePath = $dir . '/' . $pluginName . '.php';
153 if (!is_file($pluginFilePath)) {
154 throw new PluginFileNotFoundException($pluginName);
158 include_once $pluginFilePath;
160 $initFunction = $pluginName . '_init';
161 if (function_exists($initFunction)) {
162 $errors = call_user_func($initFunction, $this->conf
);
163 if (!empty($errors)) {
164 $this->errors
= array_merge($this->errors
, $errors);
168 $this->loadedPlugins
[] = $pluginName;
172 * Construct normalize hook name for a specific plugin.
175 * hook_<plugin_name>_<hook_name>
177 * @param string $hook hook name.
178 * @param string $pluginName plugin name.
180 * @return string - plugin's hook name.
182 public function buildHookName($hook, $pluginName)
184 return 'hook_' . $pluginName . '_' . $hook;
188 * Retrieve plugins metadata from *.meta (INI) files into an array.
190 * - plugin description [description]
191 * - parameters split with ';' [parameters]
193 * Respects plugins order from settings.
195 * @return array plugins metadata.
197 public function getPluginsMeta()
200 $dirs = glob(self
::$PLUGINS_PATH . '/*', GLOB_ONLYDIR
| GLOB_MARK
);
202 // Browse all plugin directories.
203 foreach ($dirs as $pluginDir) {
204 $plugin = basename($pluginDir);
205 $metaFile = $pluginDir . $plugin . '.' . self
::$META_EXT;
206 if (!is_file($metaFile) || !is_readable($metaFile)) {
210 $metaData[$plugin] = parse_ini_file($metaFile);
211 $metaData[$plugin]['order'] = array_search($plugin, $this->authorizedPlugins
);
213 if (isset($metaData[$plugin]['description'])) {
214 $metaData[$plugin]['description'] = t($metaData[$plugin]['description']);
216 // Read parameters and format them into an array.
217 if (isset($metaData[$plugin]['parameters'])) {
218 $params = explode(';', $metaData[$plugin]['parameters']);
222 $metaData[$plugin]['parameters'] = array();
223 foreach ($params as $param) {
228 $metaData[$plugin]['parameters'][$param]['value'] = '';
229 // Optional parameter description in parameter.PARAM_NAME=
230 if (isset($metaData[$plugin]['parameter.' . $param])) {
231 $metaData[$plugin]['parameters'][$param]['desc'] = t($metaData[$plugin]['parameter.' . $param]);
240 * Return the list of encountered errors.
242 * @return array List of errors (empty array if none exists).
244 public function getErrors()
246 return $this->errors
;