Merge branch 'master' of https://github.com/roundcube/roundcubemail

Andy Wermke

2013-04-04 92cd7f34b07e86062f2c024039e3309768b48ce6

 program/lib/Roundcube/rcube_plugin.php

@@ -2,10 +2,8 @@

/*
 +-----------------------------------------------------------------------+
 | program/include/rcube_plugin.php                                      |
 |                                                                       |
 | 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.                |
@@ -62,6 +60,14 @@
   */
  public $noframe = false;

    /**
     * A list of config option names that can be modified
     * by the user via user interface (with save-prefs command)
     *
     * @var array
     */
    public $allowed_prefs;

  protected $home;
  protected $urlbase;
  private $mytask;
@@ -85,7 +91,6 @@
   */
  abstract function init();


  /**
   * Attempt to load the given plugin which is required for the current plugin
   *
@@ -97,18 +102,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',
@@ -124,7 +130,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)
  {
@@ -135,7 +142,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)
  {
@@ -146,7 +154,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)
  {
@@ -200,26 +209,33 @@
    // 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;
            }

      $rcmail = rcube::get_instance();
      $rcmail->load_language($lang, $add);
            $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);
        $rcmail->output->add_label($js_labels);
                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);
      }
    }
  }

  /**
   * Wrapper for rcmail::gettext() adding the plugin ID as domain
     * Wrapper for rcube::gettext() adding the plugin ID as domain
   *
   * @param string $p Message identifier
     *
   * @return string Localized text
   * @see rcmail::gettext()
     * @see rcube::gettext()
   */
  public function gettext($p)
  {
@@ -229,12 +245,13 @@
  /**
   * Register this plugin to be responsible for a specific task
   *
   * @param string $task 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 ($this->api->register_task($task, $this->ID))
        if ($this->api->register_task($task, $this->ID)) {
      $this->mytask = $task;
        }
  }

  /**
@@ -243,7 +260,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)
  {
@@ -257,7 +275,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)
  {
@@ -289,15 +308,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);
    }
@@ -308,6 +330,7 @@
   * plugin directory
   *
   * @param string $fn The file name
     *
   * @return string Absolute URL to the given resource
   */
  public function url($fn)
@@ -322,10 +345,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;
        }
  }

  /**
@@ -336,11 +361,12 @@
   */
  public function local_skin_path()
  {
    $rcmail = rcube::get_instance();
    foreach (array($rcmail->config->get('skin'), 'larry') as $skin) {
        $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;
@@ -356,5 +382,4 @@
  {
    return $this->ID.'.'.$key;
  }

}