From 0c259682f65eaaf23ea4ccb56a706d6baf3007e4 Mon Sep 17 00:00:00 2001 From: alecpl Date: Fri, 13 Apr 2012 08:52:02 +0000 Subject: - Merge devel-framework branch, resolved conflicts --- program/include/rcube_plugin_api.php | 83 +++++++++++++++++++++--------------- 1 file changed, 49 insertions(+), 34 deletions(-) (limited to 'program/include/rcube_plugin_api.php') diff --git a/program/include/rcube_plugin_api.php b/program/include/rcube_plugin_api.php index be12f11b5..95fd3b66a 100644 --- a/program/include/rcube_plugin_api.php +++ b/program/include/rcube_plugin_api.php @@ -22,6 +22,11 @@ */ +// location where plugins are loade from +if (!defined('RCMAIL_PLUGINS_DIR')) + define('RCMAIL_PLUGINS_DIR', INSTALL_PATH . 'plugins/'); + + /** * The plugin loader and global API * @@ -33,8 +38,8 @@ class rcube_plugin_api public $dir; public $url = 'plugins/'; + public $task = ''; public $output; - public $config; public $handlers = array(); private $plugins = array(); @@ -43,7 +48,6 @@ class rcube_plugin_api private $actionmap = array(); private $objectsmap = array(); private $template_contents = array(); - private $required_plugins = array('filesystem_attachments', 'jqueryui'); private $active_hook = false; // Deprecated names of hooks, will be removed after 0.5-stable release @@ -99,29 +103,48 @@ class rcube_plugin_api */ private function __construct() { - $this->dir = INSTALL_PATH . $this->url; + $this->dir = slashify(RCMAIL_PLUGINS_DIR); } /** - * Load and init all enabled plugins + * Initialize plugin engine * * This has to be done after rcmail::load_gui() or rcmail::json_init() * was called because plugins need to have access to rcmail->output + * + * @param object rcube Instance of the rcube base class + * @param string Current application task (used for conditional plugin loading) */ - public function init() + public function init($app, $task = '') { - $rcmail = rcmail::get_instance(); - $this->output = $rcmail->output; - $this->config = $rcmail->config; + $this->task = $task; + $this->output = $app->output; + + // register an internal hook + $this->register_hook('template_container', array($this, 'template_container_hook')); - $plugins_enabled = (array)$rcmail->config->get('plugins', array()); + // maybe also register a shudown function which triggers shutdown functions of all plugin objects + } + + + /** + * Load and init all enabled plugins + * + * This has to be done after rcmail::load_gui() or rcmail::json_init() + * was called because plugins need to have access to rcmail->output + * + * @param array List of configured plugins to load + * @param array List of plugins required by the application + */ + public function load_plugins($plugins_enabled, $required_plugins = array()) + { foreach ($plugins_enabled as $plugin_name) { $this->load_plugin($plugin_name); } // check existance of all required core plugins - foreach ($this->required_plugins as $plugin_name) { + foreach ($required_plugins as $plugin_name) { $loaded = false; foreach ($this->plugins as $plugin) { if ($plugin instanceof $plugin_name) { @@ -136,19 +159,13 @@ class rcube_plugin_api // trigger fatal error if still not loaded if (!$loaded) { - raise_error(array('code' => 520, 'type' => 'php', + rcube::raise_error(array('code' => 520, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Requried plugin $plugin_name was not loaded"), true, true); } } - - // register an internal hook - $this->register_hook('template_container', array($this, 'template_container_hook')); - - // maybe also register a shudown function which triggers shutdown functions of all plugin objects } - /** * Load the specified plugin * @@ -159,8 +176,6 @@ class rcube_plugin_api { static $plugins_dir; - $rcmail = rcmail::get_instance(); - if (!$plugins_dir) { $dir = dir($this->dir); $plugins_dir = unslashify($dir->path); @@ -181,8 +196,8 @@ class rcube_plugin_api // check inheritance... if (is_subclass_of($plugin, 'rcube_plugin')) { // ... task, request type and framed mode - if ((!$plugin->task || preg_match('/^('.$plugin->task.')$/i', $rcmail->task)) - && (!$plugin->noajax || (is_object($rcmail->output) && is_a($rcmail->output, 'rcube_template'))) + if ((!$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(); @@ -192,13 +207,13 @@ class rcube_plugin_api } } else { - raise_error(array('code' => 520, 'type' => 'php', + rcube::raise_error(array('code' => 520, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "No plugin class $plugin_name found in $fn"), true, false); } } else { - raise_error(array('code' => 520, 'type' => 'php', + rcube::raise_error(array('code' => 520, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Failed to load plugin file $fn"), true, false); } @@ -217,7 +232,7 @@ class rcube_plugin_api { if (is_callable($callback)) { if (isset($this->deprecated_hooks[$hook])) { - raise_error(array('code' => 522, 'type' => 'php', + rcube::raise_error(array('code' => 522, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Deprecated hook name. ".$hook.' -> '.$this->deprecated_hooks[$hook]), true, false); $hook = $this->deprecated_hooks[$hook]; @@ -225,7 +240,7 @@ class rcube_plugin_api $this->handlers[$hook][] = $callback; } else - raise_error(array('code' => 521, 'type' => 'php', + rcube::raise_error(array('code' => 521, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Invalid callback function for $hook"), true, false); } @@ -297,7 +312,7 @@ class rcube_plugin_api $this->actionmap[$action] = $owner; } else { - raise_error(array('code' => 523, 'type' => 'php', + rcube::raise_error(array('code' => 523, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Cannot register action $action; already taken by another plugin"), true, false); } @@ -316,7 +331,7 @@ class rcube_plugin_api call_user_func($this->actions[$action]); } else { - raise_error(array('code' => 524, 'type' => 'php', + rcube::raise_error(array('code' => 524, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "No handler found for action $action"), true, true); } @@ -337,14 +352,14 @@ class rcube_plugin_api $name = 'plugin.'.$name; // can register handler only if it's not taken or registered by myself - if (!isset($this->objectsmap[$name]) || $this->objectsmap[$name] == $owner) { + if (is_object($this->output) && (!isset($this->objectsmap[$name]) || $this->objectsmap[$name] == $owner)) { $this->output->add_handler($name, $callback); $this->objectsmap[$name] = $owner; } else { - raise_error(array('code' => 525, 'type' => 'php', + rcube::raise_error(array('code' => 525, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, - 'message' => "Cannot register template handler $name; already taken by another plugin"), true, false); + 'message' => "Cannot register template handler $name; already taken by another plugin or no output object available"), true, false); } } @@ -358,12 +373,12 @@ class rcube_plugin_api public function register_task($task, $owner) { if ($task != asciiwords($task)) { - raise_error(array('code' => 526, 'type' => 'php', + rcube::raise_error(array('code' => 526, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Invalid task name: $task. Only characters [a-z0-9_.-] are allowed"), true, false); } else if (in_array($task, rcmail::$main_tasks)) { - raise_error(array('code' => 526, 'type' => 'php', + rcube::raise_error(array('code' => 526, 'type' => 'php', 'file' => __FILE__, 'line' => __LINE__, 'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false); } @@ -408,7 +423,7 @@ class rcube_plugin_api */ public function include_script($fn) { - if ($this->output->type == 'html') { + if (is_object($this->output) && $this->output->type == 'html') { $src = $this->resource_url($fn); $this->output->add_header(html::tag('script', array('type' => "text/javascript", 'src' => $src))); } @@ -422,7 +437,7 @@ class rcube_plugin_api */ public function include_stylesheet($fn) { - if ($this->output->type == 'html') { + if (is_object($this->output) && $this->output->type == 'html') { $src = $this->resource_url($fn); $this->output->include_css($src); } -- cgit v1.2.3