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 if (!empty($params['target'])) {
104 $data['_PAGE_'] = $params['target'];
107 if (isset($params['loggedin'])) {
108 $data['_LOGGEDIN_'] = $params['loggedin'];
111 if (isset($params['basePath'])) {
112 $data['_BASE_PATH_'] = $params['basePath'];
115 if (isset($params['bookmarkService'])) {
116 $data['_BOOKMARK_SERVICE_'] = $params['bookmarkService'];
119 foreach ($this->loadedPlugins
as $plugin) {
120 $hookFunction = $this->buildHookName($hook, $plugin);
122 if (function_exists($hookFunction)) {
124 $data = call_user_func($hookFunction, $data, $this->conf
);
125 } catch (\Throwable
$e) {
126 $error = $plugin . t(' [plugin incompatibility]: ') . $e->getMessage();
127 $this->errors
= array_unique(array_merge($this->errors
, [$error]));
134 * Load a single plugin from its files.
135 * Call the init function if it exists, and collect errors.
136 * Add them in $loadedPlugins if successful.
138 * @param string $dir plugin's directory.
139 * @param string $pluginName plugin's name.
142 * @throws \Shaarli\Plugin\Exception\PluginFileNotFoundException - plugin files not found.
144 private function loadPlugin($dir, $pluginName)
147 throw new PluginFileNotFoundException($pluginName);
150 $pluginFilePath = $dir . '/' . $pluginName . '.php';
151 if (!is_file($pluginFilePath)) {
152 throw new PluginFileNotFoundException($pluginName);
156 include_once $pluginFilePath;
158 $initFunction = $pluginName . '_init';
159 if (function_exists($initFunction)) {
160 $errors = call_user_func($initFunction, $this->conf
);
161 if (!empty($errors)) {
162 $this->errors
= array_merge($this->errors
, $errors);
166 $this->loadedPlugins
[] = $pluginName;
170 * Construct normalize hook name for a specific plugin.
173 * hook_<plugin_name>_<hook_name>
175 * @param string $hook hook name.
176 * @param string $pluginName plugin name.
178 * @return string - plugin's hook name.
180 public function buildHookName($hook, $pluginName)
182 return 'hook_' . $pluginName . '_' . $hook;
186 * Retrieve plugins metadata from *.meta (INI) files into an array.
188 * - plugin description [description]
189 * - parameters split with ';' [parameters]
191 * Respects plugins order from settings.
193 * @return array plugins metadata.
195 public function getPluginsMeta()
198 $dirs = glob(self
::$PLUGINS_PATH . '/*', GLOB_ONLYDIR
| GLOB_MARK
);
200 // Browse all plugin directories.
201 foreach ($dirs as $pluginDir) {
202 $plugin = basename($pluginDir);
203 $metaFile = $pluginDir . $plugin . '.' . self
::$META_EXT;
204 if (!is_file($metaFile) || !is_readable($metaFile)) {
208 $metaData[$plugin] = parse_ini_file($metaFile);
209 $metaData[$plugin]['order'] = array_search($plugin, $this->authorizedPlugins
);
211 if (isset($metaData[$plugin]['description'])) {
212 $metaData[$plugin]['description'] = t($metaData[$plugin]['description']);
214 // Read parameters and format them into an array.
215 if (isset($metaData[$plugin]['parameters'])) {
216 $params = explode(';', $metaData[$plugin]['parameters']);
220 $metaData[$plugin]['parameters'] = array();
221 foreach ($params as $param) {
226 $metaData[$plugin]['parameters'][$param]['value'] = '';
227 // Optional parameter description in parameter.PARAM_NAME=
228 if (isset($metaData[$plugin]['parameter.' . $param])) {
229 $metaData[$plugin]['parameters'][$param]['desc'] = t($metaData[$plugin]['parameter.' . $param]);
238 * Return the list of encountered errors.
240 * @return array List of errors (empty array if none exists).
242 public function getErrors()
244 return $this->errors
;