Removed $Id$

Aleksander Machniak

2012-05-22 041c93ce0bc00cb6417ce2e4bdce2ed84d37f50a

 program/include/rcube_plugin.php

@@ -5,8 +5,11 @@
 | program/include/rcube_plugin.php                                      |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2009, Roundcube Dev. - Switzerland                 |
 | Licensed under the GNU GPL                                            |
 | Copyright (C) 2008-2009, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
 | See the README file for a full license statement.                     |
 |                                                                       |
 | PURPOSE:                                                              |
 |  Abstract plugins interface/class                                     |
@@ -14,9 +17,6 @@
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id$

*/

/**
@@ -78,12 +78,25 @@
    $this->home = $api->dir . $this->ID;
    $this->urlbase = $api->url . $this->ID . '/';
  }
  

  /**
   * 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.
@@ -94,14 +107,15 @@
  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',
    $rcube = rcube::get_instance();
    if (is_file($fpath) && !$rcube->config->load_from_file($fpath)) {
      rcube::raise_error(array(
        'code' => 527, 'type' => 'php',
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Failed to load config from $fpath"), true, false);
      return false;
    }
    

    return true;
  }

@@ -115,7 +129,18 @@
  {
    $this->api->register_hook($hook, $callback);
  }
  

  /**
   * 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
   */
  public function remove_hook($hook, $callback)
  {
    $this->api->unregister_hook($hook, $callback);
  }

  /**
   * Load localized texts from the plugins dir
   *
@@ -125,17 +150,48 @@
  public function add_texts($dir, $add2client = false)
  {
    $domain = $this->ID;
    
    $lang = $_SESSION['language'];
    $lang   = $_SESSION['language'];
    $langs  = array_unique(array('en_US', $lang));
    $locdir = slashify(realpath(slashify($this->home) . $dir));
    $texts = array();
    $texts  = array();

    // Language aliases used to find localization in similar lang, see below
    $aliases = array(
        'de_CH' => 'de_DE',
        'es_AR' => 'es_ES',
        'fa_AF' => 'fa_IR',
        'nl_BE' => 'nl_NL',
        'pt_BR' => 'pt_PT',
        'zh_CN' => 'zh_TW',
    );

    // 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;
    foreach ($langs as $lng) {
      $fpath = $locdir . $lng . '.inc';
      if (is_file($fpath) && is_readable($fpath)) {
        include $fpath;
        $texts = (array)$labels + (array)$messages + (array)$texts;
      }
      else if ($lng != 'en_US') {
        // Find localization in similar language (#1488401)
        $alias = null;
        if (!empty($aliases[$lng])) {
          $alias = $aliases[$lng];
        }
        else if ($key = array_search($lng, $aliases)) {
          $alias = $key;
        }

        if (!empty($alias)) {
          $fpath = $locdir . $alias . '.inc';
          if (is_file($fpath) && is_readable($fpath)) {
            include $fpath;
            $texts = (array)$labels + (array)$messages + (array)$texts;
          }
        }
      }
    }

    ob_end_clean();
@@ -148,7 +204,7 @@

      $rcmail = rcmail::get_instance();
      $rcmail->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);
@@ -156,7 +212,7 @@
      }
    }
  }
  

  /**
   * Wrapper for rcmail::gettext() adding the plugin ID as domain
   *
@@ -166,7 +222,7 @@
   */
  public function gettext($p)
  {
    return rcmail::get_instance()->gettext($p, $this->ID);
    return rcube::get_instance()->gettext($p, $this->ID);
  }

  /**
@@ -226,7 +282,7 @@
  {
    $this->api->include_stylesheet($this->resource_url($fn));
  }
  

  /**
   * Append a button to a certain container
   *
@@ -241,11 +297,11 @@
      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);
    }
  }
  

  /**
   * Generate an absolute URL to the given resource within the current
   * plugin directory
@@ -270,18 +326,19 @@
    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()
  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';
    $rcmail = rcube::get_instance();
    $skin_path = 'skins/' . $rcmail->config->get('skin');
    if (!is_dir(realpath(slashify($this->home) . $skin_path)))
      $skin_path = 'skins/default';
    return $skin_path;
  }

@@ -296,6 +353,4 @@
    return $this->ID.'.'.$key;
  }


}