4 +-----------------------------------------------------------------------+
5 | program/include/rcube_plugin.php |
7 | This file is part of the Roundcube Webmail client |
8 | Copyright (C) 2008-2009, The Roundcube Dev Team |
9 | Licensed under the GNU GPL |
12 | Abstract plugins interface/class |
13 | All plugins need to extend this class |
14 +-----------------------------------------------------------------------+
15 | Author: Thomas Bruederli <roundcube@gmail.com> |
16 +-----------------------------------------------------------------------+
18 $Id: rcube_plugin.php 4870 2011-06-21 09:10:14Z alec $
23 * Plugin interface class
27 abstract class rcube_plugin
30 * Class name of the plugin instance
37 * Instance of Plugin API
39 * @var rcube_plugin_api
44 * Regular expression defining task(s) to bind with
51 * Disables plugin in AJAX requests
55 public $noajax = false;
58 * Disables plugin in framed mode
62 public $noframe = false;
70 * Default constructor.
72 * @param rcube_plugin_api $api Plugin API
74 public function __construct($api)
76 $this->ID = get_class($this);
78 $this->home = $api->dir . $this->ID;
79 $this->urlbase = $api->url . $this->ID . '/';
83 * Initialization method, needs to be implemented by the plugin itself
85 abstract function init();
89 * Attempt to load the given plugin which is required for the current plugin
91 * @param string Plugin name
92 * @return boolean True on success, false on failure
94 public function require_plugin($plugin_name)
96 return $this->api->load_plugin($plugin_name);
101 * Load local config file from plugins directory.
102 * The loaded values are patched over the global configuration.
104 * @param string $fname Config file name relative to the plugin's folder
105 * @return boolean True on success, false on failure
107 public function load_config($fname = 'config.inc.php')
109 $fpath = $this->home.'/'.$fname;
110 $rcmail = rcmail::get_instance();
111 if (is_file($fpath) && !$rcmail->config->load_from_file($fpath)) {
112 raise_error(array('code' => 527, 'type' => 'php',
113 'file' => __FILE__, 'line' => __LINE__,
114 'message' => "Failed to load config from $fpath"), true, false);
122 * Register a callback function for a specific (server-side) hook
124 * @param string $hook Hook name
125 * @param mixed $callback Callback function as string or array with object reference and method name
127 public function add_hook($hook, $callback)
129 $this->api->register_hook($hook, $callback);
133 * Load localized texts from the plugins dir
135 * @param string $dir Directory to search in
136 * @param mixed $add2client Make texts also available on the client (array with list or true for all)
138 public function add_texts($dir, $add2client = false)
142 $lang = $_SESSION['language'];
143 $locdir = slashify(realpath(slashify($this->home) . $dir));
146 // use buffering to handle empty lines/spaces after closing PHP tag
149 foreach (array('en_US', $lang) as $lng) {
150 @include($locdir . $lng . '.inc');
151 $texts = (array)$labels + (array)$messages + (array)$texts;
156 // prepend domain to text keys and add to the application texts repository
157 if (!empty($texts)) {
159 foreach ($texts as $key => $value)
160 $add[$domain.'.'.$key] = $value;
162 $rcmail = rcmail::get_instance();
163 $rcmail->load_language($lang, $add);
165 // add labels to client
167 $js_labels = is_array($add2client) ? array_map(array($this, 'label_map_callback'), $add2client) : array_keys($add);
168 $rcmail->output->add_label($js_labels);
174 * Wrapper for rcmail::gettext() adding the plugin ID as domain
176 * @param string $p Message identifier
177 * @return string Localized text
178 * @see rcmail::gettext()
180 public function gettext($p)
182 return rcmail::get_instance()->gettext($p, $this->ID);
186 * Register this plugin to be responsible for a specific task
188 * @param string $task Task name (only characters [a-z0-9_.-] are allowed)
190 public function register_task($task)
192 if ($this->api->register_task($task, $this->ID))
193 $this->mytask = $task;
197 * Register a handler for a specific client-request action
199 * The callback will be executed upon a request like /?_task=mail&_action=plugin.myaction
201 * @param string $action Action name (should be unique)
202 * @param mixed $callback Callback function as string or array with object reference and method name
204 public function register_action($action, $callback)
206 $this->api->register_action($action, $this->ID, $callback, $this->mytask);
210 * Register a handler function for a template object
212 * When parsing a template for display, tags like <roundcube:object name="plugin.myobject" />
213 * will be replaced by the return value if the registered callback function.
215 * @param string $name Object name (should be unique and start with 'plugin.')
216 * @param mixed $callback Callback function as string or array with object reference and method name
218 public function register_handler($name, $callback)
220 $this->api->register_handler($name, $this->ID, $callback);
224 * Make this javascipt file available on the client
226 * @param string $fn File path; absolute or relative to the plugin directory
228 public function include_script($fn)
230 $this->api->include_script($this->resource_url($fn));
234 * Make this stylesheet available on the client
236 * @param string $fn File path; absolute or relative to the plugin directory
238 public function include_stylesheet($fn)
240 $this->api->include_stylesheet($this->resource_url($fn));
244 * Append a button to a certain container
246 * @param array $p Hash array with named parameters (as used in skin templates)
247 * @param string $container Container name where the buttons should be added to
248 * @see rcube_remplate::button()
250 public function add_button($p, $container)
252 if ($this->api->output->type == 'html') {
253 // fix relative paths
254 foreach (array('imagepas', 'imageact', 'imagesel') as $key)
256 $p[$key] = $this->api->url . $this->resource_url($p[$key]);
258 $this->api->add_content($this->api->output->button($p), $container);
263 * Generate an absolute URL to the given resource within the current
266 * @param string $fn The file name
267 * @return string Absolute URL to the given resource
269 public function url($fn)
271 return $this->api->url . $this->resource_url($fn);
275 * Make the given file name link into the plugin directory
277 * @param string $fn Filename
279 private function resource_url($fn)
281 if ($fn[0] != '/' && !preg_match('|^https?://|i', $fn))
282 return $this->ID . '/' . $fn;
288 * Provide path to the currently selected skin folder within the plugin directory
289 * with a fallback to the default skin folder.
291 * @return string Skin path relative to plugins directory
293 public function local_skin_path()
295 $skin_path = 'skins/'.$this->api->config->get('skin');
296 if (!is_dir(realpath(slashify($this->home) . $skin_path)))
297 $skin_path = 'skins/default';
302 * Callback function for array_map
304 * @param string $key Array key.
307 private function label_map_callback($key)
309 return $this->ID.'.'.$key;