From 8e528fd7bf2e2bd1e20c7e7de5eefb26bf6b19d9 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 23 May 2012 14:09:57 -0400
Subject: [PATCH] hide_blockquote - a new plugin for hiding citation blocks
---
program/include/rcube_plugin_api.php | 101 ++++++++++++++++++++++++++++++++++----------------
1 files changed, 68 insertions(+), 33 deletions(-)
diff --git a/program/include/rcube_plugin_api.php b/program/include/rcube_plugin_api.php
index 54a9a8b..be12f11 100644
--- a/program/include/rcube_plugin_api.php
+++ b/program/include/rcube_plugin_api.php
@@ -5,8 +5,11 @@
| program/include/rcube_plugin_api.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2008-2009, The Roundcube Dev Team |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2008-2011, The Roundcube Dev Team |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Plugins repository |
@@ -40,7 +43,7 @@
private $actionmap = array();
private $objectsmap = array();
private $template_contents = array();
- private $required_plugins = array('filesystem_attachments');
+ private $required_plugins = array('filesystem_attachments', 'jqueryui');
private $active_hook = false;
// Deprecated names of hooks, will be removed after 0.5-stable release
@@ -71,6 +74,9 @@
'delete_identity' => 'identity_delete',
'save_identity' => 'identity_update',
'identity_save' => 'identity_update',
+ // to be removed after 0.8
+ 'imap_init' => 'storage_init',
+ 'mailboxes_list' => 'storage_folders',
);
/**
@@ -86,8 +92,8 @@
return self::$instance;
}
-
-
+
+
/**
* Private constructor
*/
@@ -95,8 +101,8 @@
{
$this->dir = INSTALL_PATH . $this->url;
}
-
-
+
+
/**
* Load and init all enabled plugins
*
@@ -113,7 +119,7 @@
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) {
$loaded = false;
@@ -123,7 +129,7 @@
break;
}
}
-
+
// load required core plugin if no derivate was found
if (!$loaded)
$loaded = $this->load_plugin($plugin_name);
@@ -138,7 +144,7 @@
// 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
}
@@ -152,18 +158,18 @@
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)) {
@@ -175,9 +181,9 @@
// 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($rcmail->output, 'rcube_template'))
- && (!$plugin->noframe || empty($_REQUEST['_framed']))*/
+ 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;
@@ -196,11 +202,11 @@
'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
*
@@ -223,8 +229,22 @@
'file' => __FILE__, 'line' => __LINE__,
'message' => "Invalid callback function for $hook"), true, false);
}
-
-
+
+ /**
+ * Allow a plugin object to unregister a callback.
+ *
+ * @param string $hook Hook name
+ * @param mixed $callback String with global function name or array($obj, 'methodname')
+ */
+ public function unregister_hook($hook, $callback)
+ {
+ $callback_id = array_search($callback, $this->handlers[$hook]);
+ if ($callback_id !== false) {
+ unset($this->handlers[$hook][$callback_id]);
+ }
+ }
+
+
/**
* Triggers a plugin hook.
* This is called from the application and executes all registered handlers
@@ -240,16 +260,16 @@
$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;
}
@@ -315,7 +335,7 @@
// 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);
@@ -327,8 +347,8 @@
'message' => "Cannot register template handler $name; already taken by another plugin"), true, false);
}
}
-
-
+
+
/**
* Register this plugin to be responsible for a specific task
*
@@ -352,7 +372,7 @@
rcmail::$main_tasks[] = $task;
return true;
}
-
+
return false;
}
@@ -380,7 +400,7 @@
{
return $this->active_hook && (!$hook || $this->active_hook == $hook);
}
-
+
/**
* Include a plugin script file in the current HTML page
*
@@ -394,6 +414,7 @@
}
}
+
/**
* Include a plugin stylesheet in the current HTML page
*
@@ -406,7 +427,8 @@
$this->output->include_css($src);
}
}
-
+
+
/**
* Save the given HTML content to be added to a template container
*
@@ -417,7 +439,19 @@
{
$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
*
@@ -429,7 +463,8 @@
$container = $attrib['name'];
return array('content' => $attrib['content'] . $this->template_contents[$container]);
}
-
+
+
/**
* Make the given file name link into the plugins directory
*
--
Gitblit v1.9.1