Changeset 05a631a in github

Timestamp:

Jun 3, 2010 2:40:06 AM (3 years ago)

Author:

thomascube <thomas@…>

Branches:

master, HEAD, courier-fix, dev-browser-capabilities, pdo, release-0.6, release-0.7, release-0.8

Children:

bb8721aa

Parents:

ae8a2a55

Message:

Allow plugins to register their own tasks

Files:

• index.php (modified) (1 diff)
• program/include/rcube_plugin.php (modified) (3 diffs)
• program/include/rcube_plugin_api.php (modified) (3 diffs)

index.php

@@ -243 +243 @@
   $stepfile = !empty($action_map[$RCMAIL->task][$RCMAIL->action]) ?
     $action_map[$RCMAIL->task][$RCMAIL->action] : strtr($RCMAIL->action, '-', '_') . '.inc';
-
+    
   // execute a plugin action
-  if (preg_match('/^plugin\./', $RCMAIL->action)) {
+  if ($RCMAIL->plugins->is_plugin_task($RCMAIL->task)) {
+    $RCMAIL->plugins->exec_action($RCMAIL->task.'.'.$RCMAIL->action);
+    break;
+  }
+  else if (preg_match('/^plugin\./', $RCMAIL->action)) {
     $RCMAIL->plugins->exec_action($RCMAIL->action);
     break;

program/include/rcube_plugin.php

@@ -32 +32 @@
   protected $home;
   protected $urlbase;
+  private $mytask;
 
   /**
@@ -135 +136 @@
   public function register_task($task)
   {
-    if ($task != asciiwords($task)) {
-      raise_error(array('code' => 526, 'type' => 'php',
-        'file' => __FILE__, 'line' => __LINE__,
-        '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',
-        'file' => __FILE__, 'line' => __LINE__,
-        'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false);
-    }
-    else {
-      rcmail::$main_tasks[] = $task;
-    }
+    if ($this->api->register_task($task, $this->ID))
+      $this->mytask = $task;
   }
 
@@ -160 +150 @@
   public function register_action($action, $callback)
   {
-    $this->api->register_action($action, $this->ID, $callback);
+    $this->api->register_action($action, $this->ID, $callback, $this->mytask);
   }
 

program/include/rcube_plugin_api.php

@@ -35 +35 @@
   public $handlers = array();
   private $plugins = array();
+  private $tasks = array();
   private $actions = array();
   private $actionmap = array();
@@ -207 +208 @@
    * @param string Plugin name that registers this action
    * @param mixed Callback: string with global function name or array($obj, 'methodname')
-   */
-  public function register_action($action, $owner, $callback)
+   * @param string Task name registered by this plugin
+   */
+  public function register_action($action, $owner, $callback, $task = null)
   {
     // check action name
-    if (strpos($action, 'plugin.') !== 0)
+    if ($task)
+      $action = $task.'.'.$action;
+    else if (strpos($action, 'plugin.') !== 0)
       $action = 'plugin.'.$action;
     
@@ -273 +277 @@
   
   /**
+   * Register this plugin to be responsible for a specific task
+   *
+   * @param string Task name (only characters [a-z0-9_.-] are allowed)
+   * @param string Plugin name that registers this action
+   */
+  public function register_task($task, $owner)
+  {
+    if ($task != asciiwords($task)) {
+      raise_error(array('code' => 526, 'type' => 'php',
+        'file' => __FILE__, 'line' => __LINE__,
+        'message' => "Invalid task name: $task. Only characters [a-z0-9_.-] are allowed"), true, false);
+    }
+    else if (in_array($task, rcmail::$main_tasks)) {
+      raise_error(array('code' => 526, 'type' => 'php',
+        'file' => __FILE__, 'line' => __LINE__,
+        'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false);
+    }
+    else {
+      $this->tasks[$task] = $owner;
+      rcmail::$main_tasks[] = $task;
+      return true;
+    }
+    
+    return false;
+  }
+
+
+  /**
+   * Checks whether the given task is registered by a plugin
+   *
+   * @return boolean True if registered, otherwise false
+   */
+  public function is_plugin_task($task)
+  {
+    return $this->tasks[$task] ? true : false;
+  }
+
+
+  /**
    * Check if a plugin hook is currently processing.
    * Mainly used to prevent loops and recursion.