Aleksander Machniak
2012-12-21 c4781306a54006727b05a5b8a5414e09c51b8bef
program/lib/Roundcube/rcube_plugin.php
@@ -3,7 +3,7 @@
/*
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2009, The Roundcube Dev Team                       |
 | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
@@ -83,7 +83,6 @@
   */
  abstract function init();
  /**
   * Attempt to load the given plugin which is required for the current plugin
   *
@@ -95,18 +94,19 @@
    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 $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;
    $rcube = rcube::get_instance();
    if (is_file($fpath) && !$rcube->config->load_from_file($fpath)) {
      rcube::raise_error(array(
        'code' => 527, 'type' => 'php',
@@ -122,7 +122,8 @@
   * Register a callback function for a specific (server-side) hook
   *
   * @param string $hook Hook name
   * @param mixed  $callback Callback function as string or array with object reference and method name
     * @param mixed  $callback Callback function as string or array
     *                         with object reference and method name
   */
  public function add_hook($hook, $callback)
  {
@@ -133,7 +134,8 @@
   * Unregister a callback function for a specific (server-side) hook.
   *
   * @param string $hook Hook name
   * @param mixed  $callback Callback function as string or array with object reference and method name
     * @param mixed  $callback Callback function as string or array
     *                         with object reference and method name
   */
  public function remove_hook($hook, $callback)
  {
@@ -144,7 +146,8 @@
   * Load localized texts from the plugins dir
   *
   * @param string $dir Directory to search in
   * @param mixed  $add2client Make texts also available on the client (array with list or true for all)
     * @param mixed  $add2client Make texts also available on the client
     *                           (array with list or true for all)
   */
  public function add_texts($dir, $add2client = false)
  {
@@ -198,15 +201,21 @@
    // prepend domain to text keys and add to the application texts repository
    if (!empty($texts)) {
      $add = array();
      foreach ($texts as $key => $value)
            foreach ($texts as $key => $value) {
        $add[$domain.'.'.$key] = $value;
            }
      $rcube = rcube::get_instance();
      $rcube->load_language($lang, $add);
      // add labels to client
      if ($add2client) {
        $js_labels = is_array($add2client) ? array_map(array($this, 'label_map_callback'), $add2client) : array_keys($add);
                if (is_array($add2client)) {
                    $js_labels = array_map(array($this, 'label_map_callback'), $add2client);
                }
                else {
                    $js_labels = array_keys($add);
                }
        $rcube->output->add_label($js_labels);
      }
    }
@@ -216,6 +225,7 @@
   * Wrapper for rcube::gettext() adding the plugin ID as domain
   *
   * @param string $p Message identifier
     *
   * @return string Localized text
   * @see rcube::gettext()
   */
@@ -231,8 +241,9 @@
   */
  public function register_task($task)
  {
    if ($this->api->register_task($task, $this->ID))
        if ($this->api->register_task($task, $this->ID)) {
      $this->mytask = $task;
        }
  }
  /**
@@ -241,7 +252,8 @@
    * The callback will be executed upon a request like /?_task=mail&_action=plugin.myaction
    *
    * @param string $action  Action name (should be unique)
    * @param mixed $callback Callback function as string or array with object reference and method name
     * @param mixed $callback Callback function as string
     *                        or array with object reference and method name
   */
  public function register_action($action, $callback)
  {
@@ -255,7 +267,8 @@
   * will be replaced by the return value if the registered callback function.
   *
   * @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
     * @param mixed  $callback Callback function as string or array with object reference
     *                         and method name
   */
  public function register_handler($name, $callback)
  {
@@ -287,15 +300,18 @@
   *
   * @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)
  {
    if ($this->api->output->type == 'html') {
      // fix relative paths
      foreach (array('imagepas', 'imageact', 'imagesel') as $key)
        if ($p[$key])
            foreach (array('imagepas', 'imageact', 'imagesel') as $key) {
                if ($p[$key]) {
          $p[$key] = $this->api->url . $this->resource_url($p[$key]);
                }
            }
      $this->api->add_content($this->api->output->button($p), $container);
    }
@@ -306,6 +322,7 @@
   * plugin directory
   *
   * @param string $fn The file name
     *
   * @return string Absolute URL to the given resource
   */
  public function url($fn)
@@ -320,10 +337,12 @@
   */
  private function resource_url($fn)
  {
    if ($fn[0] != '/' && !preg_match('|^https?://|i', $fn))
        if ($fn[0] != '/' && !preg_match('|^https?://|i', $fn)) {
      return $this->ID . '/' . $fn;
    else
        }
        else {
      return $fn;
        }
  }
  /**
@@ -337,8 +356,9 @@
    $rcube = rcube::get_instance();
    foreach (array($rcube->config->get('skin'), 'larry') as $skin) {
      $skin_path = 'skins/' . $skin;
      if (is_dir(realpath(slashify($this->home) . $skin_path)))
            if (is_dir(realpath(slashify($this->home) . $skin_path))) {
        break;
            }
    }
    return $skin_path;
@@ -354,5 +374,4 @@
  {
    return $this->ID.'.'.$key;
  }
}