Aleksander Machniak
2013-10-17 197203727417a03d87053a47e5aa5175a76e3e0b
program/include/rcube_plugin_api.php
@@ -27,12 +27,14 @@
class rcube_plugin_api
{
  static private $instance;
  public $dir;
  public $url = 'plugins/';
  public $output;
  public $config;
  public $allowed_prefs         = array();
  public $allowed_session_prefs = array();
  public $handlers = array();
  private $plugins = array();
  private $tasks = array();
@@ -86,8 +88,8 @@
    return self::$instance;
  }
  /**
   * Private constructor
   */
@@ -95,8 +97,8 @@
  {
    $this->dir = INSTALL_PATH . $this->url;
  }
  /**
   * Load and init all enabled plugins
   *
@@ -113,7 +115,7 @@
    foreach ($plugins_enabled as $plugin_name) {
      $this->load_plugin($plugin_name);
    }
    // check existance of all required core plugins
    foreach ($this->required_plugins as $plugin_name) {
      $loaded = false;
@@ -123,7 +125,7 @@
          break;
        }
      }
      // load required core plugin if no derivate was found
      if (!$loaded)
        $loaded = $this->load_plugin($plugin_name);
@@ -138,7 +140,7 @@
    // register an internal hook
    $this->register_hook('template_container', array($this, 'template_container_hook'));
    // maybe also register a shudown function which triggers shutdown functions of all plugin objects
  }
@@ -152,18 +154,18 @@
  public function load_plugin($plugin_name)
  {
    static $plugins_dir;
    $rcmail = rcmail::get_instance();
    if (!$plugins_dir) {
      $dir = dir($this->dir);
      $plugins_dir = unslashify($dir->path);
    }
    // plugin already loaded
    if ($this->plugins[$plugin_name] || class_exists($plugin_name, false))
      return true;
    $fn = $plugins_dir . DIRECTORY_SEPARATOR . $plugin_name . DIRECTORY_SEPARATOR . $plugin_name . '.php';
    if (file_exists($fn)) {
@@ -175,12 +177,15 @@
        // check inheritance...
        if (is_subclass_of($plugin, 'rcube_plugin')) {
          // ... task, request type and framed mode
          if ((!$plugin->task || preg_match('/^('.$plugin->task.')$/i', $rcmail->task)) /*
              && (!$plugin->noajax || is_a($rcmail->output, 'rcube_template'))
              && (!$plugin->noframe || empty($_REQUEST['_framed']))*/
          if ((!$plugin->task || preg_match('/^('.$plugin->task.')$/i', $rcmail->task))
              && (!$plugin->noajax || (is_object($rcmail->output) && is_a($rcmail->output, 'rcube_template')))
              && (!$plugin->noframe || empty($_REQUEST['_framed']))
          ) {
            $plugin->init();
            $this->plugins[$plugin_name] = $plugin;
          }
          if (!empty($plugin->allowed_prefs)) {
            $this->allowed_prefs = array_merge($this->allowed_prefs, $plugin->allowed_prefs);
          }
          return true;
        }
@@ -196,11 +201,11 @@
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Failed to load plugin file $fn"), true, false);
    }
    return false;
  }
  /**
   * Allows a plugin object to register a callback for a certain hook
   *
@@ -223,8 +228,8 @@
        'file' => __FILE__, 'line' => __LINE__,
        'message' => "Invalid callback function for $hook"), true, false);
  }
  /**
   * Triggers a plugin hook.
   * This is called from the application and executes all registered handlers
@@ -240,16 +245,16 @@
    $args += array('abort' => false);
    $this->active_hook = $hook;
    foreach ((array)$this->handlers[$hook] as $callback) {
      $ret = call_user_func($callback, $args);
      if ($ret && is_array($ret))
        $args = $ret + $args;
      if ($args['abort'])
        break;
    }
    $this->active_hook = false;
    return $args;
  }
@@ -315,7 +320,7 @@
    // check name
    if (strpos($name, 'plugin.') !== 0)
      $name = 'plugin.'.$name;
    // can register handler only if it's not taken or registered by myself
    if (!isset($this->objectsmap[$name]) || $this->objectsmap[$name] == $owner) {
      $this->output->add_handler($name, $callback);
@@ -327,8 +332,8 @@
        'message' => "Cannot register template handler $name; already taken by another plugin"), true, false);
    }
  }
  /**
   * Register this plugin to be responsible for a specific task
   *
@@ -352,7 +357,7 @@
      rcmail::$main_tasks[] = $task;
      return true;
    }
    return false;
  }
@@ -380,7 +385,7 @@
  {
    return $this->active_hook && (!$hook || $this->active_hook == $hook);
  }
  /**
   * Include a plugin script file in the current HTML page
   *
@@ -394,6 +399,7 @@
    }
  }
  /**
   * Include a plugin stylesheet in the current HTML page
   *
@@ -406,7 +412,8 @@
      $this->output->include_css($src);
    }
  }
  /**
   * Save the given HTML content to be added to a template container
   *
@@ -417,7 +424,19 @@
  {
    $this->template_contents[$container] .= $html . "\n";
  }
  /**
   * Returns list of loaded plugins names
   *
   * @return array List of plugin names
   */
  public function loaded_plugins()
  {
    return array_keys($this->plugins);
  }
  /**
   * Callback for template_container hooks
   *
@@ -429,7 +448,8 @@
    $container = $attrib['name'];
    return array('content' => $attrib['content'] . $this->template_contents[$container]);
  }
  /**
   * Make the given file name link into the plugins directory
   *