X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=program%2Finclude%2Frcube_plugin_api.php;h=e762fff0816ee16dcd9b3680f06205d62a4876c0;hb=76507f7c63a660742e76889ad6e3919f3dde3bb0;hp=75f1cc4784ac9d0e84c06a2c059fb287ced3eeb2;hpb=b68022ca3782d5eb5a1a7ef6f8cf7abe1dc15bd6;p=roundcube.git diff --git a/program/include/rcube_plugin_api.php b/program/include/rcube_plugin_api.php index 75f1cc4..e762fff 100644 --- a/program/include/rcube_plugin_api.php +++ b/program/include/rcube_plugin_api.php @@ -4,8 +4,8 @@ +-----------------------------------------------------------------------+ | program/include/rcube_plugin_api.php | | | - | This file is part of the RoundCube Webmail client | - | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland | + | This file is part of the Roundcube Webmail client | + | Copyright (C) 2008-2009, The Roundcube Dev Team | | Licensed under the GNU GPL | | | | PURPOSE: | @@ -15,14 +15,14 @@ | Author: Thomas Bruederli | +-----------------------------------------------------------------------+ - $Id: $ + $Id: rcube_plugin_api.php 5207 2011-09-12 12:52:01Z alec $ */ /** * The plugin loader and global API * - * @package Core + * @package PluginAPI */ class rcube_plugin_api { @@ -31,21 +31,52 @@ class rcube_plugin_api public $dir; public $url = 'plugins/'; public $output; + public $config; public $handlers = array(); private $plugins = array(); + private $tasks = array(); private $actions = array(); private $actionmap = array(); private $objectsmap = array(); private $template_contents = array(); - private $required_plugins = array('filesystem_attachments'); private $active_hook = false; + // Deprecated names of hooks, will be removed after 0.5-stable release + private $deprecated_hooks = array( + 'create_user' => 'user_create', + 'kill_session' => 'session_destroy', + 'upload_attachment' => 'attachment_upload', + 'save_attachment' => 'attachment_save', + 'get_attachment' => 'attachment_get', + 'cleanup_attachments' => 'attachments_cleanup', + 'display_attachment' => 'attachment_display', + 'remove_attachment' => 'attachment_delete', + 'outgoing_message_headers' => 'message_outgoing_headers', + 'outgoing_message_body' => 'message_outgoing_body', + 'address_sources' => 'addressbooks_list', + 'get_address_book' => 'addressbook_get', + 'create_contact' => 'contact_create', + 'save_contact' => 'contact_update', + 'contact_save' => 'contact_update', + 'delete_contact' => 'contact_delete', + 'manage_folders' => 'folders_list', + 'list_mailboxes' => 'mailboxes_list', + 'save_preferences' => 'preferences_save', + 'user_preferences' => 'preferences_list', + 'list_prefs_sections' => 'preferences_sections_list', + 'list_identities' => 'identities_list', + 'create_identity' => 'identity_create', + 'delete_identity' => 'identity_delete', + 'save_identity' => 'identity_update', + 'identity_save' => 'identity_update', + ); + /** * This implements the 'singleton' design pattern * - * @return object rcube_plugin_api The one and only instance if this class + * @return rcube_plugin_api The one and only instance if this class */ static function get_instance() { @@ -55,8 +86,8 @@ class rcube_plugin_api return self::$instance; } - - + + /** * Private constructor */ @@ -64,46 +95,25 @@ class rcube_plugin_api { $this->dir = INSTALL_PATH . $this->url; } - - + + /** * Load and init all enabled plugins * - * This has to be done after rcmail::load_gui() or rcmail::init_json() + * This has to be done after rcmail::load_gui() or rcmail::json_init() * was called because plugins need to have access to rcmail->output */ public function init() { $rcmail = rcmail::get_instance(); $this->output = $rcmail->output; - - $plugins_dir = dir($this->dir); + $this->config = $rcmail->config; + $plugins_enabled = (array)$rcmail->config->get('plugins', array()); - foreach ($plugins_enabled as $plugin_name) { - $fn = $plugins_dir->path . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php'; - - if (file_exists($fn)) { - include($fn); - - // instantiate class if exists - if (class_exists($plugin_name, false)) { - $plugin = new $plugin_name($this); - // check inheritance and task specification - if (is_subclass_of($plugin, 'rcube_plugin') && (!$plugin->task || preg_match('/('.$plugin->task.')/i', $rcmail->task))) { - $plugin->init(); - $this->plugins[] = $plugin; - } - } - else { - raise_error(array('code' => 520, 'type' => 'php', 'message' => "No plugin class $plugin_name found in $fn"), true, false); - } - } - else { - raise_error(array('code' => 520, 'type' => 'php', 'message' => "Failed to load plugin file $fn"), true, false); - } + $this->load_plugin($plugin_name); } - + // check existance of all required core plugins foreach ($this->required_plugins as $plugin_name) { $loaded = false; @@ -113,86 +123,133 @@ class rcube_plugin_api break; } } - + // load required core plugin if no derivate was found - if (!$loaded) { - $fn = $plugins_dir->path . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php'; - if (file_exists($fn)) { - include_once($fn); - - if (class_exists($plugin_name, false)) { - $plugin = new $plugin_name($this); - // check inheritance - if (is_subclass_of($plugin, 'rcube_plugin')) { - if (!$plugin->task || preg_match('/('.$plugin->task.')/i', $rcmail->task)) { - $plugin->init(); - $this->plugins[] = $plugin; - } - $loaded = true; - } - } - } - } - + if (!$loaded) + $loaded = $this->load_plugin($plugin_name); + // trigger fatal error if still not loaded if (!$loaded) { - raise_error(array('code' => 520, 'type' => 'php', 'message' => "Requried plugin $plugin_name was not loaded"), true, true); + 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 - - - // call imap_init right now - // (should actually be done in rcmail::imap_init() but plugins are not initialized then) - if ($rcmail->imap) { - $hook = $this->exec_hook('imap_init', array('fetch_headers' => $rcmail->imap->fetch_add_headers)); - if ($hook['fetch_headers']) - $rcmail->imap->fetch_add_headers = $hook['fetch_headers']; + } + + + /** + * Load the specified plugin + * + * @param string Plugin name + * @return boolean True on success, false if not loaded or failure + */ + public function load_plugin($plugin_name) + { + static $plugins_dir; + + $rcmail = rcmail::get_instance(); + + if (!$plugins_dir) { + $dir = dir($this->dir); + $plugins_dir = unslashify($dir->path); + } + + // plugin already loaded + if ($this->plugins[$plugin_name] || class_exists($plugin_name, false)) + return true; + + $fn = $plugins_dir . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php'; + + if (file_exists($fn)) { + include($fn); + + // instantiate class if exists + if (class_exists($plugin_name, false)) { + $plugin = new $plugin_name($this); + // 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'))) + && (!$plugin->noframe || empty($_REQUEST['_framed'])) + ) { + $plugin->init(); + $this->plugins[$plugin_name] = $plugin; + } + return true; + } + } + else { + 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', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Failed to load plugin file $fn"), true, false); + } + + return false; } - - + + /** * Allows a plugin object to register a callback for a certain hook * - * @param string Hook name - * @param mixed String with global function name or array($obj, 'methodname') + * @param string $hook Hook name + * @param mixed $callback String with global function name or array($obj, 'methodname') */ public function register_hook($hook, $callback) { - if (is_callable($callback)) + if (is_callable($callback)) { + if (isset($this->deprecated_hooks[$hook])) { + 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]; + } $this->handlers[$hook][] = $callback; + } else - raise_error(array('code' => 521, 'type' => 'php', 'message' => "Invalid callback function for $hook"), true, false); + raise_error(array('code' => 521, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Invalid callback function for $hook"), true, false); } - - + + /** * Triggers a plugin hook. * This is called from the application and executes all registered handlers * - * @param string Hook name - * @param array Named arguments (key->value pairs) + * @param string $hook Hook name + * @param array $args Named arguments (key->value pairs) * @return array The (probably) altered hook arguments */ public function exec_hook($hook, $args = array()) { + if (!is_array($args)) + $args = array('arg' => $args); + $args += array('abort' => false); $this->active_hook = $hook; - + foreach ((array)$this->handlers[$hook] as $callback) { $ret = call_user_func($callback, $args); if ($ret && is_array($ret)) $args = $ret + $args; - + if ($args['abort']) break; } - + $this->active_hook = false; return $args; } @@ -201,23 +258,28 @@ class rcube_plugin_api /** * Let a plugin register a handler for a specific request * - * @param string Action name (_task=mail&_action=plugin.foo) - * @param string Plugin name that registers this action - * @param mixed Callback: string with global function name or array($obj, 'methodname') + * @param string $action Action name (_task=mail&_action=plugin.foo) + * @param string $owner Plugin name that registers this action + * @param mixed $callback Callback: string with global function name or array($obj, 'methodname') + * @param string $task Task name registered by this plugin */ - public function register_action($action, $owner, $callback) + public function register_action($action, $owner, $callback, $task = null) { // check action name - if (strpos($action, 'plugin.') !== 0) + if ($task) + $action = $task.'.'.$action; + else if (strpos($action, 'plugin.') !== 0) $action = 'plugin.'.$action; - + // can register action only if it's not taken or registered by myself if (!isset($this->actionmap[$action]) || $this->actionmap[$action] == $owner) { $this->actions[$action] = $callback; $this->actionmap[$action] = $owner; } else { - raise_error(array('code' => 523, 'type' => 'php', 'message' => "Cannot register action $action; already taken by another plugin"), true, false); + raise_error(array('code' => 523, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Cannot register action $action; already taken by another plugin"), true, false); } } @@ -226,7 +288,7 @@ class rcube_plugin_api * This method handles requests like _task=mail&_action=plugin.foo * It executes the callback function that was registered with the given action. * - * @param string Action name + * @param string $action Action name */ public function exec_action($action) { @@ -234,7 +296,9 @@ class rcube_plugin_api call_user_func($this->actions[$action]); } else { - raise_error(array('code' => 524, 'type' => 'php', 'message' => "No handler found for action $action"), true, true); + raise_error(array('code' => 524, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "No handler found for action $action"), true, true); } } @@ -242,41 +306,85 @@ class rcube_plugin_api /** * Register a handler function for template objects * - * @param string Object name - * @param string Plugin name that registers this action - * @param mixed Callback: string with global function name or array($obj, 'methodname') + * @param string $name Object name + * @param string $owner Plugin name that registers this action + * @param mixed $callback Callback: string with global function name or array($obj, 'methodname') */ public function register_handler($name, $owner, $callback) { // check name if (strpos($name, 'plugin.') !== 0) $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) { $this->output->add_handler($name, $callback); $this->objectsmap[$name] = $owner; } else { - raise_error(array('code' => 525, 'type' => 'php', 'message' => "Cannot register template handler $name; already taken by another plugin"), true, false); + raise_error(array('code' => 525, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Cannot register template handler $name; already taken by another plugin"), true, false); } } - - + + + /** + * Register this plugin to be responsible for a specific task + * + * @param string $task Task name (only characters [a-z0-9_.-] are allowed) + * @param string $owner Plugin name that registers this action + */ + public function register_task($task, $owner) + { + if ($task != asciiwords($task)) { + 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', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false); + } + else { + $this->tasks[$task] = $owner; + rcmail::$main_tasks[] = $task; + return true; + } + + return false; + } + + + /** + * Checks whether the given task is registered by a plugin + * + * @param string $task Task name + * @return boolean True if registered, otherwise false + */ + public function is_plugin_task($task) + { + return $this->tasks[$task] ? true : false; + } + + /** * Check if a plugin hook is currently processing. * Mainly used to prevent loops and recursion. * - * @param string Hook to check (optional) + * @param string $hook Hook to check (optional) * @return boolean True if any/the given hook is currently processed, otherwise false */ public function is_processing($hook = null) { return $this->active_hook && (!$hook || $this->active_hook == $hook); } - + /** * Include a plugin script file in the current HTML page + * + * @param string $fn Path to script */ public function include_script($fn) { @@ -286,36 +394,62 @@ class rcube_plugin_api } } + /** * Include a plugin stylesheet in the current HTML page + * + * @param string $fn Path to stylesheet */ public function include_stylesheet($fn) { if ($this->output->type == 'html') { $src = $this->resource_url($fn); - $this->output->add_header(html::tag('link', array('rel' => "stylesheet", 'type' => "text/css", 'href' => $src))); + $this->output->include_css($src); } } - + + /** * Save the given HTML content to be added to a template container + * + * @param string $html HTML content + * @param string $container Template container identifier */ public function add_content($html, $container) { $this->template_contents[$container] .= $html . "\n"; } - + + + /** + * Returns list of loaded plugins names + * + * @return array List of plugin names + */ + public function loaded_plugins() + { + return array_keys($this->plugins); + } + + /** * Callback for template_container hooks + * + * @param array $attrib + * @return array */ private function template_container_hook($attrib) { $container = $attrib['name']; return array('content' => $attrib['content'] . $this->template_contents[$container]); } - + + /** * Make the given file name link into the plugins directory + * + * @param string $fn Filename + * @return string */ private function resource_url($fn) { @@ -326,4 +460,3 @@ class rcube_plugin_api } } -