| | |
| | | public $url = 'plugins/'; |
| | | public $task = ''; |
| | | public $output; |
| | | public $handlers = array(); |
| | | public $handlers = array(); |
| | | public $allowed_prefs = array(); |
| | | public $allowed_session_prefs = array(); |
| | | public $active_plugins = array(); |
| | | |
| | | protected $plugins = array(); |
| | | protected $tasks = array(); |
| | |
| | | protected $actionmap = array(); |
| | | protected $objectsmap = array(); |
| | | protected $template_contents = array(); |
| | | protected $active_hook = false; |
| | | protected $exec_stack = array(); |
| | | |
| | | // Deprecated names of hooks, will be removed after 0.5-stable release |
| | | protected $deprecated_hooks = array( |
| | |
| | | * Load the specified plugin |
| | | * |
| | | * @param string Plugin name |
| | | * @param boolean Force loading of the plugin even if it doesn't match the filter |
| | | * @param boolean Require loading of the plugin, error if it doesn't exist |
| | | * |
| | | * @return boolean True on success, false if not loaded or failure |
| | | */ |
| | | public function load_plugin($plugin_name) |
| | | public function load_plugin($plugin_name, $force = false, $require = true) |
| | | { |
| | | static $plugins_dir; |
| | | |
| | |
| | | } |
| | | |
| | | // plugin already loaded |
| | | if ($this->plugins[$plugin_name] || class_exists($plugin_name, false)) { |
| | | if ($this->plugins[$plugin_name]) { |
| | | return true; |
| | | } |
| | | |
| | | $fn = $plugins_dir . DIRECTORY_SEPARATOR . $plugin_name |
| | | . DIRECTORY_SEPARATOR . $plugin_name . '.php'; |
| | | $fn = "$plugins_dir/$plugin_name/$plugin_name.php"; |
| | | |
| | | if (file_exists($fn)) { |
| | | include $fn; |
| | | if (is_readable($fn)) { |
| | | if (!class_exists($plugin_name, false)) { |
| | | include $fn; |
| | | } |
| | | |
| | | // instantiate class if exists |
| | | if (class_exists($plugin_name, false)) { |
| | | $plugin = new $plugin_name($this); |
| | | $this->active_plugins[] = $plugin_name; |
| | | |
| | | // check inheritance... |
| | | if (is_subclass_of($plugin, 'rcube_plugin')) { |
| | | // ... task, request type and framed mode |
| | | if ((!$plugin->task || preg_match('/^('.$plugin->task.')$/i', $this->task)) |
| | | if (($force || !$plugin->task || preg_match('/^('.$plugin->task.')$/i', $this->task)) |
| | | && (!$plugin->noajax || (is_object($this->output) && $this->output->type == 'html')) |
| | | && (!$plugin->noframe || empty($_REQUEST['_framed'])) |
| | | ) { |
| | | $plugin->init(); |
| | | $this->plugins[$plugin_name] = $plugin; |
| | | } |
| | | |
| | | if (!empty($plugin->allowed_prefs)) { |
| | | $this->allowed_prefs = array_merge($this->allowed_prefs, $plugin->allowed_prefs); |
| | | } |
| | | |
| | | return true; |
| | | } |
| | | } |
| | |
| | | true, false); |
| | | } |
| | | } |
| | | else { |
| | | elseif ($require) { |
| | | rcube::raise_error(array('code' => 520, 'type' => 'php', |
| | | 'file' => __FILE__, 'line' => __LINE__, |
| | | 'message' => "Failed to load plugin file $fn"), true, false); |
| | | } |
| | | |
| | | return false; |
| | | } |
| | | |
| | | /** |
| | | * Get information about a specific plugin. |
| | | * This is either provided my a plugin's info() method or extracted from a package.xml or a composer.json file |
| | | * |
| | | * @param string Plugin name |
| | | * @return array Meta information about a plugin or False if plugin was not found |
| | | */ |
| | | public function get_info($plugin_name) |
| | | { |
| | | static $composer_lock, $license_uris = array( |
| | | 'Apache' => 'http://www.apache.org/licenses/LICENSE-2.0.html', |
| | | 'Apache-2' => 'http://www.apache.org/licenses/LICENSE-2.0.html', |
| | | 'Apache-1' => 'http://www.apache.org/licenses/LICENSE-1.0', |
| | | 'Apache-1.1' => 'http://www.apache.org/licenses/LICENSE-1.1', |
| | | 'GPL' => 'http://www.gnu.org/licenses/gpl.html', |
| | | 'GPLv2' => 'http://www.gnu.org/licenses/gpl-2.0.html', |
| | | 'GPL-2.0' => 'http://www.gnu.org/licenses/gpl-2.0.html', |
| | | 'GPLv3' => 'http://www.gnu.org/licenses/gpl-3.0.html', |
| | | 'GPL-3.0' => 'http://www.gnu.org/licenses/gpl-3.0.html', |
| | | 'GPL-3.0+' => 'http://www.gnu.org/licenses/gpl.html', |
| | | 'GPL-2.0+' => 'http://www.gnu.org/licenses/gpl.html', |
| | | 'AGPLv3' => 'http://www.gnu.org/licenses/agpl.html', |
| | | 'AGPLv3+' => 'http://www.gnu.org/licenses/agpl.html', |
| | | 'AGPL-3.0' => 'http://www.gnu.org/licenses/agpl.html', |
| | | 'LGPL' => 'http://www.gnu.org/licenses/lgpl.html', |
| | | 'LGPLv2' => 'http://www.gnu.org/licenses/lgpl-2.0.html', |
| | | 'LGPLv2.1' => 'http://www.gnu.org/licenses/lgpl-2.1.html', |
| | | 'LGPLv3' => 'http://www.gnu.org/licenses/lgpl.html', |
| | | 'LGPL-2.0' => 'http://www.gnu.org/licenses/lgpl-2.0.html', |
| | | 'LGPL-2.1' => 'http://www.gnu.org/licenses/lgpl-2.1.html', |
| | | 'LGPL-3.0' => 'http://www.gnu.org/licenses/lgpl.html', |
| | | 'LGPL-3.0+' => 'http://www.gnu.org/licenses/lgpl.html', |
| | | 'BSD' => 'http://opensource.org/licenses/bsd-license.html', |
| | | 'BSD-2-Clause' => 'http://opensource.org/licenses/BSD-2-Clause', |
| | | 'BSD-3-Clause' => 'http://opensource.org/licenses/BSD-3-Clause', |
| | | 'FreeBSD' => 'http://opensource.org/licenses/BSD-2-Clause', |
| | | 'MIT' => 'http://www.opensource.org/licenses/mit-license.php', |
| | | 'PHP' => 'http://opensource.org/licenses/PHP-3.0', |
| | | 'PHP-3' => 'http://www.php.net/license/3_01.txt', |
| | | 'PHP-3.0' => 'http://www.php.net/license/3_0.txt', |
| | | 'PHP-3.01' => 'http://www.php.net/license/3_01.txt', |
| | | ); |
| | | |
| | | $dir = dir($this->dir); |
| | | $fn = unslashify($dir->path) . "/$plugin_name/$plugin_name.php"; |
| | | $info = false; |
| | | |
| | | if (!class_exists($plugin_name, false)) { |
| | | if (is_readable($fn)) |
| | | include($fn); |
| | | else |
| | | return false; |
| | | } |
| | | |
| | | if (class_exists($plugin_name)) |
| | | $info = $plugin_name::info(); |
| | | |
| | | // fall back to composer.json file |
| | | if (!$info) { |
| | | $composer = INSTALL_PATH . "/plugins/$plugin_name/composer.json"; |
| | | if (is_readable($composer) && ($json = @json_decode(file_get_contents($composer), true))) { |
| | | list($info['vendor'], $info['name']) = explode('/', $json['name']); |
| | | $info['version'] = $json['version']; |
| | | $info['license'] = $json['license']; |
| | | $info['uri'] = $json['homepage']; |
| | | $info['require'] = array_filter(array_keys((array)$json['require']), function($pname) { |
| | | if (strpos($pname, '/') == false) |
| | | return false; |
| | | list($vendor, $name) = explode('/', $pname); |
| | | return !($name == 'plugin-installer' || $vendor == 'pear-pear'); |
| | | }); |
| | | } |
| | | |
| | | // read local composer.lock file (once) |
| | | if (!isset($composer_lock)) { |
| | | $composer_lock = @json_decode(@file_get_contents(INSTALL_PATH . "/composer.lock"), true); |
| | | if ($composer_lock['packages']) { |
| | | foreach ($composer_lock['packages'] as $i => $package) { |
| | | $composer_lock['installed'][$package['name']] = $package; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // load additional information from local composer.lock file |
| | | if ($lock = $composer_lock['installed'][$json['name']]) { |
| | | $info['version'] = $lock['version']; |
| | | $info['uri'] = $lock['homepage'] ? $lock['homepage'] : $lock['source']['uri']; |
| | | $info['src_uri'] = $lock['dist']['uri'] ? $lock['dist']['uri'] : $lock['source']['uri']; |
| | | } |
| | | } |
| | | |
| | | // fall back to package.xml file |
| | | if (!$info) { |
| | | $package = INSTALL_PATH . "/plugins/$plugin_name/package.xml"; |
| | | if (is_readable($package) && ($file = file_get_contents($package))) { |
| | | $doc = new DOMDocument(); |
| | | $doc->loadXML($file); |
| | | $xpath = new DOMXPath($doc); |
| | | $xpath->registerNamespace('rc', "http://pear.php.net/dtd/package-2.0"); |
| | | |
| | | // XPaths of plugin metadata elements |
| | | $metadata = array( |
| | | 'name' => 'string(//rc:package/rc:name)', |
| | | 'version' => 'string(//rc:package/rc:version/rc:release)', |
| | | 'license' => 'string(//rc:package/rc:license)', |
| | | 'license_uri' => 'string(//rc:package/rc:license/@uri)', |
| | | 'src_uri' => 'string(//rc:package/rc:srcuri)', |
| | | 'uri' => 'string(//rc:package/rc:uri)', |
| | | ); |
| | | |
| | | foreach ($metadata as $key => $path) { |
| | | $info[$key] = $xpath->evaluate($path); |
| | | } |
| | | |
| | | // dependent required plugins (can be used, but not included in config) |
| | | $deps = $xpath->evaluate('//rc:package/rc:dependencies/rc:required/rc:package/rc:name'); |
| | | for ($i = 0; $i < $deps->length; $i++) { |
| | | $dn = $deps->item($i)->nodeValue; |
| | | $info['require'][] = $dn; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // At least provide the name |
| | | if (!$info && class_exists($plugin_name)) { |
| | | $info = array('name' => $plugin_name, 'version' => '--'); |
| | | } |
| | | else if ($info['license'] && empty($info['license_uri']) && ($license_uri = $license_uris[$info['license']])) { |
| | | $info['license_uri'] = $license_uri; |
| | | } |
| | | |
| | | return $info; |
| | | } |
| | | |
| | | /** |
| | |
| | | $args = array('arg' => $args); |
| | | } |
| | | |
| | | // TODO: avoid recusion by checking in_array($hook, $this->exec_stack) ? |
| | | |
| | | $args += array('abort' => false); |
| | | $this->active_hook = $hook; |
| | | array_push($this->exec_stack, $hook); |
| | | |
| | | foreach ((array)$this->handlers[$hook] as $callback) { |
| | | $ret = call_user_func($callback, $args); |
| | |
| | | $args = $ret + $args; |
| | | } |
| | | |
| | | if ($args['abort']) { |
| | | if ($args['break']) { |
| | | break; |
| | | } |
| | | } |
| | | |
| | | $this->active_hook = false; |
| | | array_pop($this->exec_stack); |
| | | return $args; |
| | | } |
| | | |
| | |
| | | */ |
| | | public function is_processing($hook = null) |
| | | { |
| | | return $this->active_hook && (!$hook || $this->active_hook == $hook); |
| | | return count($this->exec_stack) > 0 && (!$hook || in_array($hook, $this->exec_stack)); |
| | | } |
| | | |
| | | /** |
| | |
| | | } |
| | | |
| | | /** |
| | | * Returns loaded plugin |
| | | * |
| | | * @return rcube_plugin Plugin instance |
| | | */ |
| | | public function get_plugin($name) |
| | | { |
| | | return $this->plugins[$name]; |
| | | } |
| | | |
| | | /** |
| | | * Callback for template_container hooks |
| | | * |
| | | * @param array $attrib |