From ce92ba767a9557daf7f18be94882dd7e6f4591fb Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Thu, 30 Sep 2010 09:24:33 -0400
Subject: [PATCH] - Plugin API: improved 'abort' flag handling, added 'result' item in some hooks: group_*, contact_*, identity_* (#1486914)
---
program/include/rcube_plugin_api.php | 144 ++++++++++++++++++++++++++++++++++++++++--------
1 files changed, 120 insertions(+), 24 deletions(-)
diff --git a/program/include/rcube_plugin_api.php b/program/include/rcube_plugin_api.php
index c31773c..2313d69 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, Roundcube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -34,6 +34,7 @@
public $handlers = array();
private $plugins = array();
+ private $tasks = array();
private $actions = array();
private $actionmap = array();
private $objectsmap = array();
@@ -42,10 +43,40 @@
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()
{
@@ -76,16 +107,17 @@
{
$rcmail = rcmail::get_instance();
$this->output = $rcmail->output;
-
+
$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->path . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php';
-
+ $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);
@@ -120,7 +152,8 @@
// load required core plugin if no derivate was found
if (!$loaded) {
- $fn = $plugins_dir->path . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php';
+ $fn = $plugins_dir . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php';
+
if (file_exists($fn)) {
include_once($fn);
@@ -156,13 +189,20 @@
/**
* 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',
'file' => __FILE__, 'line' => __LINE__,
@@ -174,8 +214,8 @@
* 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())
@@ -203,14 +243,17 @@
/**
* 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
@@ -230,7 +273,7 @@
* 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)
{
@@ -248,9 +291,9 @@
/**
* 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)
{
@@ -272,10 +315,50 @@
/**
+ * 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)
@@ -285,6 +368,8 @@
/**
* Include a plugin script file in the current HTML page
+ *
+ * @param string $fn Path to script
*/
public function include_script($fn)
{
@@ -296,6 +381,8 @@
/**
* Include a plugin stylesheet in the current HTML page
+ *
+ * @param string $fn Path to stylesheet
*/
public function include_stylesheet($fn)
{
@@ -307,6 +394,9 @@
/**
* 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)
{
@@ -315,6 +405,9 @@
/**
* Callback for template_container hooks
+ *
+ * @param array $attrib
+ * @return array
*/
private function template_container_hook($attrib)
{
@@ -324,6 +417,9 @@
/**
* Make the given file name link into the plugins directory
+ *
+ * @param string $fn Filename
+ * @return string
*/
private function resource_url($fn)
{
--
Gitblit v1.9.1