- Fix double slash in plugin directory path (#1486872)

alecpl

2010-07-26 d5d968048601fa1d519f7cfee11f23918afc186c

 program/include/rcube_plugin.php

@@ -15,14 +15,14 @@
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id: $
 $Id$

*/

/**
 * Plugin interface class
 *
 * @package Core
 * @package PluginAPI
 */
abstract class rcube_plugin
{
@@ -31,6 +31,7 @@
  public $task;
  protected $home;
  protected $urlbase;
  private $mytask;

  /**
   * Default constructor.
@@ -47,6 +48,27 @@
   * Initialization method, needs to be implemented by the plugin itself
   */
  abstract function init();
  
  /**
   * 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
   * @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 (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;
    }
    
    return true;
  }

  /**
   * Register a callback function for a specific (server-side) hook
@@ -101,11 +123,22 @@
   * @return string Localized text
   * @see rcmail::gettext()
   */
  function gettext($p)
  public function gettext($p)
  {
    return rcmail::get_instance()->gettext($p, $this->ID);
  }
  

  /**
   * Register this plugin to be responsible for a specific task
   *
   * @param string Task name (only characters [a-z0-9_.-] are allowed)
   */
  public function register_task($task)
  {
    if ($this->api->register_task($task, $this->ID))
      $this->mytask = $task;
  }

  /**
    * Register a handler for a specific client-request action
    *
@@ -116,7 +149,7 @@
   */
  public function register_action($action, $callback)
  {
    $this->api->register_action($action, $this->ID, $callback);
    $this->api->register_action($action, $this->ID, $callback, $this->mytask);
  }

  /**
@@ -140,7 +173,7 @@
   */
  public function include_script($fn)
  {
    $this->api->include_script($this->ressource_url($fn));
    $this->api->include_script($this->resource_url($fn));
  }

  /**
@@ -150,7 +183,7 @@
   */
  public function include_stylesheet($fn)
  {
    $this->api->include_stylesheet($this->ressource_url($fn));
    $this->api->include_stylesheet($this->resource_url($fn));
  }
  
  /**
@@ -166,22 +199,48 @@
      // fix relative paths
      foreach (array('imagepas', 'imageact', 'imagesel') as $key)
        if ($p[$key])
          $p[$key] = $this->api->url . $this->ressource_url($p[$key]);
          $p[$key] = $this->api->url . $this->resource_url($p[$key]);
      
      $this->api->add_content($this->api->output->button($p), $container);
    }
  }
  
  /**
   * Generate an absolute URL to the given resource within the current
   * plugin directory
   *
   * @param string The file name
   * @return string Absolute URL to the given resource
   */
  public function url($fn)
  {
      return $this->api->url . $this->resource_url($fn);
  }

  /**
   * Make the given file name link into the plugin directory
   */
  private function ressource_url($fn)
  private function resource_url($fn)
  {
    if ($fn[0] != '/' && !eregi('^https?://', $fn))
    if ($fn[0] != '/' && !preg_match('|^https?://|i', $fn))
      return $this->ID . '/' . $fn;
    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