* Added a debug mode.

[squirrelmail.git] / functions / plugin.php

diff --git a/functions/plugin.php b/functions/plugin.php
index c1c4cf2aa7f739966f69cd7cae19b70fc02d8a09..4b86b769824c00d8d8f76abce5745e87025edab4 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -7,40 +7,66 @@
  **
  ** Plugins will eventually be a way to provide added functionality
  ** without having to patch the SquirrelMail source code. Have some
- ** patients, though, as the these funtions might change in the near
+ ** patience, though, as the these funtions might change in the near
  ** future.
  **
  ** Documentation on how to write plugins might show up some time.
  **
+ ** $Id$
  **/
 
 
    $plugin_php = true;
+   $plugin_general_debug = false;
 
    // This function adds a plugin
    function use_plugin ($name) {
-      include ('../plugins/'.$name.'/setup.php');
-      $function = 'squirrelmail_plugin_init_'.$name;
-      $function();
+      global $plugin_general_debug;
+      
+      if (file_exists('../plugins/'.$name.'/setup.php')) {
+         if ($plugin_general_debug)
+           echo "plugin:  --  Loading $name/setup.php<br>\n";
+         include ('../plugins/'.$name.'/setup.php');
+         $function = 'squirrelmail_plugin_init_'.$name;
+         if (function_exists($function))
+        {
+           if ($plugin_general_debug)
+              echo "plugin:  ---- Executing $function to init plugin<br>\n";
+            $function();
+        }
+        elseif ($plugin_general_debug)
+           echo "plugin:  -- Init function $function doesn't exist.<br>\n";
+      }
+      elseif ($plugin_general_debug)
+         echo "plugin:  Couldn't find $name/setup.php<br>\n";
    }
 
    // This function executes a hook
    function do_hook ($name) {
       global $squirrelmail_plugin_hooks;
-      if (is_array($squirrelmail_plugin_hooks[$name])) {
-         reset($squirrelmail_plugin_hooks[$name]);
-         
-         while (list ($id, $function) = 
-                each ($squirrelmail_plugin_hooks[$name])) {
+      $Data = func_get_args();
+      if (isset($squirrelmail_plugin_hooks[$name]) && 
+          is_array($squirrelmail_plugin_hooks[$name])) {
+         foreach ($squirrelmail_plugin_hooks[$name] as $id => $function) {
             // Add something to set correct gettext domain for plugin
-            $function();
+            if (function_exists($function)) {
+                $function($Data);
+            }
          }
       }
-   }
+      
+      // Variable-length argument lists have a slight problem when
+      // passing values by reference.  Pity.  This is a workaround.
+      return $Data;
+  }
 
    // On startup, register all plugins configured for use
-  if (is_array($plugins))
-     while (list ($id, $name) = each ($plugins))
-        use_plugin($name);
+   if (isset($plugins) && is_array($plugins))
+      foreach ($plugins as $id => $name)
+      {
+         if ($plugin_general_debug)
+           echo "plugin:  Attempting load of plugin $name<br>\n";
+         use_plugin($name);
+      }
 
 ?>