From 66510e20d36cb8da4f3012ef063de7bfce9b51aa Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 09 May 2012 07:52:28 -0400
Subject: [PATCH] Merge pull request #1 from Brianetta/de-svn
---
program/include/rcube_plugin.php | 216 +++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 158 insertions(+), 58 deletions(-)
diff --git a/program/include/rcube_plugin.php b/program/include/rcube_plugin.php
index 68a5bb3..25a3b6a 100644
--- a/program/include/rcube_plugin.php
+++ b/program/include/rcube_plugin.php
@@ -4,9 +4,12 @@
+-----------------------------------------------------------------------+
| program/include/rcube_plugin.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland |
- | Licensed under the GNU GPL |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2008-2009, 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: |
| Abstract plugins interface/class |
@@ -15,87 +18,186 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: $
+ $Id$
*/
/**
* Plugin interface class
*
- * @package Core
+ * @package PluginAPI
*/
abstract class rcube_plugin
{
+ /**
+ * Class name of the plugin instance
+ *
+ * @var string
+ */
public $ID;
+
+ /**
+ * Instance of Plugin API
+ *
+ * @var rcube_plugin_api
+ */
public $api;
+
+ /**
+ * Regular expression defining task(s) to bind with
+ *
+ * @var string
+ */
public $task;
+
+ /**
+ * Disables plugin in AJAX requests
+ *
+ * @var boolean
+ */
+ public $noajax = false;
+
+ /**
+ * Disables plugin in framed mode
+ *
+ * @var boolean
+ */
+ public $noframe = false;
+
protected $home;
protected $urlbase;
+ private $mytask;
+
/**
* Default constructor.
+ *
+ * @param rcube_plugin_api $api Plugin API
*/
public function __construct($api)
{
$this->ID = get_class($this);
$this->api = $api;
- $this->home = $api->dir . DIRECTORY_SEPARATOR . $this->ID;
+ $this->home = $api->dir . $this->ID;
$this->urlbase = $api->url . $this->ID . '/';
}
-
+
/**
* Initialization method, needs to be implemented by the plugin itself
*/
abstract function init();
-
+
+
+ /**
+ * Attempt to load the given plugin which is required for the current plugin
+ *
+ * @param string Plugin name
+ * @return boolean True on success, false on failure
+ */
+ public function require_plugin($plugin_name)
+ {
+ return $this->api->load_plugin($plugin_name);
+ }
+
+
/**
* Load local config file from plugins directory.
* The loaded values are patched over the global configuration.
*
- * @param string Config file name relative to the plugin's folder
+ * @param string $fname Config file name relative to the plugin's folder
* @return boolean True on success, false on failure
*/
public function load_config($fname = 'config.inc.php')
{
$fpath = $this->home.'/'.$fname;
- $rcmail = rcmail::get_instance();
- if (is_file($fpath) && !$rcmail->config->load_from_file($fpath, false)) {
- raise_error(array('code' => 527, 'type' => 'php', 'message' => "Failed to load config from $fpath"), true, false);
+ $rcube = rcube::get_instance();
+ if (is_file($fpath) && !$rcube->config->load_from_file($fpath)) {
+ rcube::raise_error(array(
+ 'code' => 527, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "Failed to load config from $fpath"), true, false);
return false;
}
-
+
return true;
}
/**
* Register a callback function for a specific (server-side) hook
*
- * @param string Hook name
- * @param mixed Callback function as string or array with object reference and method name
+ * @param string $hook Hook name
+ * @param mixed $callback Callback function as string or array with object reference and method name
*/
public function add_hook($hook, $callback)
{
$this->api->register_hook($hook, $callback);
}
-
+
+ /**
+ * Unregister a callback function for a specific (server-side) hook.
+ *
+ * @param string $hook Hook name
+ * @param mixed $callback Callback function as string or array with object reference and method name
+ */
+ public function remove_hook($hook, $callback)
+ {
+ $this->api->unregister_hook($hook, $callback);
+ }
+
/**
* Load localized texts from the plugins dir
*
- * @param string Directory to search in
- * @param mixed Make texts also available on the client (array with list or true for all)
+ * @param string $dir Directory to search in
+ * @param mixed $add2client Make texts also available on the client (array with list or true for all)
*/
public function add_texts($dir, $add2client = false)
{
$domain = $this->ID;
-
- $lang = $_SESSION['language'];
+ $lang = $_SESSION['language'];
+ $langs = array_unique(array('en_US', $lang));
$locdir = slashify(realpath(slashify($this->home) . $dir));
- $texts = array();
-
- foreach (array('en_US', $lang) as $lng) {
- @include($locdir . $lng . '.inc');
- $texts = (array)$labels + (array)$messages + (array)$texts;
+ $texts = array();
+
+ // Language aliases used to find localization in similar lang, see below
+ $aliases = array(
+ 'de_CH' => 'de_DE',
+ 'es_AR' => 'es_ES',
+ 'fa_AF' => 'fa_IR',
+ 'nl_BE' => 'nl_NL',
+ 'pt_BR' => 'pt_PT',
+ 'zh_CN' => 'zh_TW',
+ );
+
+ // use buffering to handle empty lines/spaces after closing PHP tag
+ ob_start();
+
+ foreach ($langs as $lng) {
+ $fpath = $locdir . $lng . '.inc';
+ if (is_file($fpath) && is_readable($fpath)) {
+ include $fpath;
+ $texts = (array)$labels + (array)$messages + (array)$texts;
+ }
+ else if ($lng != 'en_US') {
+ // Find localization in similar language (#1488401)
+ $alias = null;
+ if (!empty($aliases[$lng])) {
+ $alias = $aliases[$lng];
+ }
+ else if ($key = array_search($lng, $aliases)) {
+ $alias = $key;
+ }
+
+ if (!empty($alias)) {
+ $fpath = $locdir . $alias . '.inc';
+ if (is_file($fpath) && is_readable($fpath)) {
+ include $fpath;
+ $texts = (array)$labels + (array)$messages + (array)$texts;
+ }
+ }
+ }
}
+
+ ob_end_clean();
// prepend domain to text keys and add to the application texts repository
if (!empty($texts)) {
@@ -105,7 +207,7 @@
$rcmail = rcmail::get_instance();
$rcmail->load_language($lang, $add);
-
+
// add labels to client
if ($add2client) {
$js_labels = is_array($add2client) ? array_map(array($this, 'label_map_callback'), $add2client) : array_keys($add);
@@ -113,34 +215,28 @@
}
}
}
-
+
/**
* Wrapper for rcmail::gettext() adding the plugin ID as domain
*
+ * @param string $p Message identifier
* @return string Localized text
* @see rcmail::gettext()
*/
public function gettext($p)
{
- return rcmail::get_instance()->gettext($p, $this->ID);
+ return rcube::get_instance()->gettext($p, $this->ID);
}
/**
* Register this plugin to be responsible for a specific task
*
- * @param string Task name (only characters [a-z0-9_.-] are allowed)
+ * @param string $task Task name (only characters [a-z0-9_.-] are allowed)
*/
public function register_task($task)
{
- if ($task != asciiwords($task)) {
- raise_error(array('code' => 526, 'type' => 'php', 'message' => "Invalid task name: $task. Only characters [a-z0-9_.-] are allowed"), true, false);
- }
- else if (in_array(rcmail::$main_tasks, $task)) {
- raise_error(array('code' => 526, 'type' => 'php', 'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false);
- }
- else {
- rcmail::$main_tasks[] = $task;
- }
+ if ($this->api->register_task($task, $this->ID))
+ $this->mytask = $task;
}
/**
@@ -148,12 +244,12 @@
*
* The callback will be executed upon a request like /?_task=mail&_action=plugin.myaction
*
- * @param string Action name (should be unique)
- * @param mixed Callback function as string or array with object reference and method name
+ * @param string $action Action name (should be unique)
+ * @param mixed $callback Callback function as string or array with object reference and method name
*/
public function register_action($action, $callback)
{
- $this->api->register_action($action, $this->ID, $callback);
+ $this->api->register_action($action, $this->ID, $callback, $this->mytask);
}
/**
@@ -162,8 +258,8 @@
* When parsing a template for display, tags like <roundcube:object name="plugin.myobject" />
* will be replaced by the return value if the registered callback function.
*
- * @param string Object name (should be unique and start with 'plugin.')
- * @param mixed Callback function as string or array with object reference and method name
+ * @param string $name Object name (should be unique and start with 'plugin.')
+ * @param mixed $callback Callback function as string or array with object reference and method name
*/
public function register_handler($name, $callback)
{
@@ -173,7 +269,7 @@
/**
* Make this javascipt file available on the client
*
- * @param string File path; absolute or relative to the plugin directory
+ * @param string $fn File path; absolute or relative to the plugin directory
*/
public function include_script($fn)
{
@@ -183,18 +279,18 @@
/**
* Make this stylesheet available on the client
*
- * @param string File path; absolute or relative to the plugin directory
+ * @param string $fn File path; absolute or relative to the plugin directory
*/
public function include_stylesheet($fn)
{
$this->api->include_stylesheet($this->resource_url($fn));
}
-
+
/**
* Append a button to a certain container
*
- * @param array Hash array with named parameters (as used in skin templates)
- * @param string Container name where the buttons should be added to
+ * @param array $p Hash array with named parameters (as used in skin templates)
+ * @param string $container Container name where the buttons should be added to
* @see rcube_remplate::button()
*/
public function add_button($p, $container)
@@ -204,16 +300,16 @@
foreach (array('imagepas', 'imageact', 'imagesel') as $key)
if ($p[$key])
$p[$key] = $this->api->url . $this->resource_url($p[$key]);
-
+
$this->api->add_content($this->api->output->button($p), $container);
}
}
-
+
/**
* Generate an absolute URL to the given resource within the current
* plugin directory
*
- * @param string The file name
+ * @param string $fn The file name
* @return string Absolute URL to the given resource
*/
public function url($fn)
@@ -223,6 +319,8 @@
/**
* Make the given file name link into the plugin directory
+ *
+ * @param string $fn Filename
*/
private function resource_url($fn)
{
@@ -231,29 +329,31 @@
else
return $fn;
}
-
+
/**
* Provide path to the currently selected skin folder within the plugin directory
* with a fallback to the default skin folder.
*
* @return string Skin path relative to plugins directory
*/
- protected function local_skin_path()
+ public function local_skin_path()
{
- $skin_path = 'skins/'.$this->api->output->config['skin'];
- if (!is_dir(realpath(slashify($this->home) . $skin_path)))
- $skin_path = 'skins/default';
+ $rcmail = rcube::get_instance();
+ $skin_path = 'skins/' . $rcmail->config->get('skin');
+ if (!is_dir(realpath(slashify($this->home) . $skin_path)))
+ $skin_path = 'skins/default';
return $skin_path;
}
/**
* Callback function for array_map
+ *
+ * @param string $key Array key.
+ * @return string
*/
private function label_map_callback($key)
{
return $this->ID.'.'.$key;
}
-
}
-
--
Gitblit v1.9.1