| | |
| | | | Author: Thomas Bruederli <roundcube@gmail.com> | |
| | | +-----------------------------------------------------------------------+ |
| | | |
| | | $Id: $ |
| | | $Id$ |
| | | |
| | | */ |
| | | |
| | | /** |
| | | * Plugin interface class |
| | | * |
| | | * @package Core |
| | | * @package PluginAPI |
| | | */ |
| | | abstract class rcube_plugin |
| | | { |
| | |
| | | public $task; |
| | | protected $home; |
| | | protected $urlbase; |
| | | private $mytask; |
| | | |
| | | /** |
| | | * Default constructor. |
| | |
| | | { |
| | | $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; |
| | | } |
| | | |
| | |
| | | */ |
| | | 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; |
| | | } |
| | | |
| | | /** |
| | |
| | | */ |
| | | public function register_action($action, $callback) |
| | | { |
| | | $this->api->register_action($action, $this->ID, $callback); |
| | | $this->api->register_action($action, $this->ID, $callback, $this->mytask); |
| | | } |
| | | |
| | | /** |
| | |
| | | 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 |