From 2aa2b332f6e216ceeabc36ef6b942c40d91bda5a Mon Sep 17 00:00:00 2001 From: alecpl <alec@alec.pl> Date: Wed, 08 Sep 2010 05:40:39 -0400 Subject: [PATCH] - Small performance improvements --- program/include/rcube_plugin.php | 63 ++++++++++++++++++++++--------- 1 files changed, 45 insertions(+), 18 deletions(-) diff --git a/program/include/rcube_plugin.php b/program/include/rcube_plugin.php index 63acaf8..c92b58e 100644 --- a/program/include/rcube_plugin.php +++ b/program/include/rcube_plugin.php @@ -15,14 +15,14 @@ | Author: Thomas Bruederli <roundcube@gmail.com> | +-----------------------------------------------------------------------+ - $Id: $ + $Id$ */ /** * Plugin interface class * - * @package Core + * @package PluginAPI */ abstract class rcube_plugin { @@ -31,6 +31,7 @@ public $task; protected $home; protected $urlbase; + private $mytask; /** * Default constructor. @@ -53,13 +54,20 @@ * The loaded values are patched over the global configuration. * * @param string 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 (!$rcmail->config->load_from_file($fpath)) - raise_error(array('code' => 527, 'type' => 'php', 'message' => "Failed to load config from $fpath"), true, false); + if (is_file($fpath) && !$rcmail->config->load_from_file($fpath)) { + raise_error(array('code' => 527, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Failed to load config from $fpath"), true, false); + return false; + } + + return true; } /** @@ -127,15 +135,8 @@ */ 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,7 +149,7 @@ */ public function register_action($action, $callback) { - $this->api->register_action($action, $this->ID, $callback); + $this->api->register_action($action, $this->ID, $callback, $this->mytask); } /** @@ -172,7 +173,7 @@ */ public function include_script($fn) { - $this->api->include_script($this->ressource_url($fn)); + $this->api->include_script($this->resource_url($fn)); } /** @@ -182,7 +183,7 @@ */ public function include_stylesheet($fn) { - $this->api->include_stylesheet($this->ressource_url($fn)); + $this->api->include_stylesheet($this->resource_url($fn)); } /** @@ -198,22 +199,48 @@ // fix relative paths foreach (array('imagepas', 'imageact', 'imagesel') as $key) if ($p[$key]) - $p[$key] = $this->api->url . $this->ressource_url($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 + * @return string Absolute URL to the given resource + */ + public function url($fn) + { + return $this->api->url . $this->resource_url($fn); } /** * Make the given file name link into the plugin directory */ - private function ressource_url($fn) + private function resource_url($fn) { if ($fn[0] != '/' && !preg_match('|^https?://|i', $fn)) return $this->ID . '/' . $fn; 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() + { + $skin_path = 'skins/'.$this->api->output->config['skin']; + if (!is_dir(realpath(slashify($this->home) . $skin_path))) + $skin_path = 'skins/default'; + return $skin_path; + } /** * Callback function for array_map -- Gitblit v1.9.1