X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=program%2Finclude%2Frcube_plugin.php;h=748d958e8ed1cb98eac1b73d778ef82f3178f2be;hb=76507f7c63a660742e76889ad6e3919f3dde3bb0;hp=5e37764c4c3a3f6f6df2987babc85884754906f0;hpb=b68022ca3782d5eb5a1a7ef6f8cf7abe1dc15bd6;p=roundcube.git

diff --git a/program/include/rcube_plugin.php b/program/include/rcube_plugin.php
index 5e37764..748d958 100644
--- a/program/include/rcube_plugin.php
+++ b/program/include/rcube_plugin.php
@@ -4,8 +4,8 @@
  +-----------------------------------------------------------------------+
  | program/include/rcube_plugin.php                                      |
  |                                                                       |
- | This file is part of the RoundCube Webmail client                     |
- | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland                 |
+ | This file is part of the Roundcube Webmail client                     |
+ | Copyright (C) 2008-2009, The Roundcube Dev Team                       |
  | Licensed under the GNU GPL                                            |
  |                                                                       |
  | PURPOSE:                                                              |
@@ -15,31 +15,67 @@
  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
  +-----------------------------------------------------------------------+
 
- $Id: $
+ $Id: rcube_plugin.php 5168 2011-09-05 11:08:48Z alec $
 
 */
 
 /**
  * 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 . '/';
   }
   
@@ -47,20 +83,35 @@ abstract class rcube_plugin
    * 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 (!$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;
     }
     
@@ -70,8 +121,8 @@ abstract class rcube_plugin
   /**
    * 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)
   {
@@ -81,8 +132,8 @@ abstract class rcube_plugin
   /**
    * 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)
   {
@@ -91,12 +142,20 @@ abstract class rcube_plugin
     $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)) {
       $add = array();
@@ -117,6 +176,7 @@ abstract class rcube_plugin
   /**
    * Wrapper for rcmail::gettext() adding the plugin ID as domain
    *
+   * @param string $p Message identifier
    * @return string Localized text
    * @see rcmail::gettext()
    */
@@ -128,19 +188,12 @@ abstract class rcube_plugin
   /**
    * 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 +201,12 @@ abstract class rcube_plugin
     *
     * 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 +215,8 @@ abstract class rcube_plugin
    * 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 +226,7 @@ abstract class rcube_plugin
   /**
    * 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,7 +236,7 @@ abstract class rcube_plugin
   /**
    * 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)
   {
@@ -193,8 +246,8 @@ abstract class rcube_plugin
   /**
    * 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)
@@ -213,7 +266,7 @@ abstract class rcube_plugin
    * 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 +276,8 @@ abstract class rcube_plugin
 
   /**
    * Make the given file name link into the plugin directory
+   *
+   * @param string $fn Filename
    */
   private function resource_url($fn)
   {
@@ -232,8 +287,25 @@ abstract class rcube_plugin
       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
+   */
+  public function local_skin_path()
+  {
+      $skin_path = 'skins/'.$this->api->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)
   {