thomascube
2009-07-23 efbe9ea781154c32ff8913eae95965c2f2ae8d9a
program/include/rcube_plugin.php
@@ -47,6 +47,25 @@
   * 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 (!$rcmail->config->load_from_file($fpath)) {
      raise_error(array('code' => 527, 'type' => 'php', '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 +120,29 @@
   * @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 ($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;
    }
  }
  /**
    * Register a handler for a specific client-request action
    *
@@ -140,7 +177,7 @@
   */
  public function include_script($fn)
  {
    $this->api->include_script($this->ressource_url($fn));
    $this->api->include_script($this->resource_url($fn));
  }
  /**
@@ -150,7 +187,7 @@
   */
  public function include_stylesheet($fn)
  {
    $this->api->include_stylesheet($this->ressource_url($fn));
    $this->api->include_stylesheet($this->resource_url($fn));
  }
  
  /**
@@ -166,7 +203,7 @@
      // 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);
    }
@@ -175,9 +212,9 @@
  /**
   * 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;