X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=program%2Finclude%2Frcube_plugin_api.php;h=e762fff0816ee16dcd9b3680f06205d62a4876c0;hb=76507f7c63a660742e76889ad6e3919f3dde3bb0;hp=7eec2dc1434ce27f45063c2b207af6cd7a163b17;hpb=4212156c5c79d2f58342feb0d3ed1893f177bcab;p=roundcube.git diff --git a/program/include/rcube_plugin_api.php b/program/include/rcube_plugin_api.php index 7eec2dc..e762fff 100644 --- a/program/include/rcube_plugin_api.php +++ b/program/include/rcube_plugin_api.php @@ -5,7 +5,7 @@ | program/include/rcube_plugin_api.php | | | | This file is part of the Roundcube Webmail client | - | Copyright (C) 2008-2009, Roundcube Dev. - Switzerland | + | Copyright (C) 2008-2009, The Roundcube Dev Team | | Licensed under the GNU GPL | | | | PURPOSE: | @@ -15,7 +15,7 @@ | Author: Thomas Bruederli | +-----------------------------------------------------------------------+ - $Id: rcube_plugin_api.php 4154 2010-10-29 08:42:28Z alec $ + $Id: rcube_plugin_api.php 5207 2011-09-12 12:52:01Z alec $ */ @@ -86,8 +86,8 @@ class rcube_plugin_api return self::$instance; } - - + + /** * Private constructor */ @@ -95,8 +95,8 @@ class rcube_plugin_api { $this->dir = INSTALL_PATH . $this->url; } - - + + /** * Load and init all enabled plugins * @@ -109,44 +109,11 @@ class rcube_plugin_api $this->output = $rcmail->output; $this->config = $rcmail->config; - $plugins_dir = dir($this->dir); - $plugins_dir = unslashify($plugins_dir->path); $plugins_enabled = (array)$rcmail->config->get('plugins', array()); - foreach ($plugins_enabled as $plugin_name) { - $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_a($this->output, 'rcube_template')) - && (!$plugin->noframe || empty($_REQUEST['_framed'])) - ) { - $plugin->init(); - $this->plugins[] = $plugin; - } - } - } - 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); - } + $this->load_plugin($plugin_name); } - + // check existance of all required core plugins foreach ($this->required_plugins as $plugin_name) { $loaded = false; @@ -156,43 +123,84 @@ class rcube_plugin_api break; } } - + // load required core plugin if no derivate was found - if (!$loaded) { - $fn = $plugins_dir . 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', - 'file' => __FILE__, 'line' => __LINE__, - 'message' => "Requried plugin $plugin_name was not loaded"), true, true); + '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 + * + * @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 * @@ -215,8 +223,8 @@ class rcube_plugin_api '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 @@ -232,16 +240,16 @@ class rcube_plugin_api $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; } @@ -307,7 +315,7 @@ class rcube_plugin_api // 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); @@ -319,8 +327,8 @@ class rcube_plugin_api 'message' => "Cannot register template handler $name; already taken by another plugin"), true, false); } } - - + + /** * Register this plugin to be responsible for a specific task * @@ -344,7 +352,7 @@ class rcube_plugin_api rcmail::$main_tasks[] = $task; return true; } - + return false; } @@ -372,7 +380,7 @@ class rcube_plugin_api { return $this->active_hook && (!$hook || $this->active_hook == $hook); } - + /** * Include a plugin script file in the current HTML page * @@ -386,6 +394,7 @@ class rcube_plugin_api } } + /** * Include a plugin stylesheet in the current HTML page * @@ -395,10 +404,11 @@ class rcube_plugin_api { 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 * @@ -409,7 +419,19 @@ class rcube_plugin_api { $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 * @@ -421,7 +443,8 @@ class rcube_plugin_api $container = $attrib['name']; return array('content' => $attrib['content'] . $this->template_contents[$container]); } - + + /** * Make the given file name link into the plugins directory * @@ -437,4 +460,3 @@ class rcube_plugin_api } } -