| 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: |
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: rcube_plugin_api.php 4469 2011-01-29 14:55:12Z thomasb $
+ $Id: rcube_plugin_api.php 5151 2011-08-31 12:49:44Z alec $
*/
return self::$instance;
}
-
-
+
+
/**
* Private constructor
*/
{
$this->dir = INSTALL_PATH . $this->url;
}
-
-
+
+
/**
* Load and init all enabled plugins
*
$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;
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
*
'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
$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;
}
// 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);
'message' => "Cannot register template handler $name; already taken by another plugin"), true, false);
}
}
-
-
+
+
/**
* Register this plugin to be responsible for a specific task
*
rcmail::$main_tasks[] = $task;
return true;
}
-
+
return false;
}
{
return $this->active_hook && (!$hook || $this->active_hook == $hook);
}
-
+
/**
* Include a plugin script file in the current HTML page
*
}
}
+
/**
* Include a plugin stylesheet in the current HTML page
*
$this->output->include_css($src);
}
}
-
+
+
/**
* Save the given HTML content to be added to a template container
*
{
$this->template_contents[$container] .= $html . "\n";
}
-
+
+
/**
* Callback for template_container hooks
*
$container = $attrib['name'];
return array('content' => $attrib['content'] . $this->template_contents[$container]);
}
-
+
+
/**
* Make the given file name link into the plugins directory
*
projects / roundcube.git / blobdiff