| | |
| | | | program/include/rcube_plugin.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2009, Roundcube Dev. - Switzerland | |
| | | | Copyright (C) 2008-2009, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | */ |
| | | abstract class rcube_plugin |
| | | { |
| | | /** |
| | | * Class name of the plugin instance |
| | | * |
| | | * @var string |
| | | */ |
| | | public $ID; |
| | | |
| | | /** |
| | | * Holds an istance of Plugin API |
| | | * 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. |
| | |
| | | { |
| | | $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. |
| | |
| | | $lang = $_SESSION['language']; |
| | | $locdir = slashify(realpath(slashify($this->home) . $dir)); |
| | | $texts = array(); |
| | | |
| | | |
| | | // use buffering to handle empty lines/spaces after closing PHP tag |
| | | ob_start(); |
| | | |
| | | foreach (array('en_US', $lang) as $lng) { |
| | | @include($locdir . $lng . '.inc'); |
| | | $texts = (array)$labels + (array)$messages + (array)$texts; |
| | | $fpath = $locdir . $lng . '.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)) { |
| | |
| | | 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->config->get('skin'); |
| | | if (!is_dir(realpath(slashify($this->home) . $skin_path))) |