Changeset 4154 in subversion

Timestamp:

Oct 29, 2010 4:42:28 AM (3 years ago)

Author:

alec

Message:

• Plugin API: add possibility to disable plugin in AJAX mode, 'noajax' property
• Plugin API: add possibility to disable plugin in framed mode, 'noframe' property

Location:

trunk/roundcubemail

Files:

• CHANGELOG (modified) (1 diff)
• program/include/rcube_plugin.php (modified) (1 diff)
• program/include/rcube_plugin_api.php (modified) (2 diffs)

trunk/roundcubemail/CHANGELOG

@@ -55 +55 @@
 - Plugin API: added 'contact_form' hook
 - Add SORT=DISPLAY support (RFC 5957)
+- Plugin API: add possibility to disable plugin in AJAX mode, 'noajax' property
+- Plugin API: add possibility to disable plugin in framed mode, 'noframe' property
 
 RELEASE 0.4.2

trunk/roundcubemail/program/include/rcube_plugin.php

@@ -27 +27 @@
 abstract class rcube_plugin
 {
+  /**
+   * Class name of the plugin instance
+   *
+   * @var string
+   */
   public $ID;
 
   /**
-   * Holds an istance of Plugin API
+   * Instance of Plugin API
    *
    * @var rcube_plugin_api
    */
   public $api;
+
+  /**
+   * Regular expression defining task(s) to bind with 
+   *
+   * @var string
+   */
   public $task;
+
+  /**
+   * Disables plugin in AJAX requests
+   *
+   * @var boolean
+   */
+  public $noajax = false;
+
+  /**
+   * Disables plugin in framed mode
+   *
+   * @var boolean
+   */
+  public $noframe = false;
+
   protected $home;
   protected $urlbase;
   private $mytask;
+
 
   /**

trunk/roundcubemail/program/include/rcube_plugin_api.php

@@ -123 +123 @@
         if (class_exists($plugin_name, false)) {
           $plugin = new $plugin_name($this);
-          // check inheritance and task specification
-          if (is_subclass_of($plugin, 'rcube_plugin') && (!$plugin->task || preg_match('/^('.$plugin->task.')$/i', $rcmail->task))) {
-            $plugin->init();
-            $this->plugins[] = $plugin;
+          // 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($this->output, 'rcube_template'))
+                && (!$plugin->noframe || empty($_REQUEST['_framed']))
+            ) {
+              $plugin->init();
+              $this->plugins[] = $plugin;
+            }
           }
         }
@@ -257 +263 @@
     else if (strpos($action, 'plugin.') !== 0)
       $action = 'plugin.'.$action;
-    
+
     // can register action only if it's not taken or registered by myself
     if (!isset($this->actionmap[$action]) || $this->actionmap[$action] == $owner) {