Replacing tabs with spaces, trimming white space at EOL and newline at EOF

[squirrelmail.git] / functions / plugin.php

diff --git a/functions/plugin.php b/functions/plugin.php
index 56315dc41d9cff76a791a4c8e5f0d01d0cc6105c..bcf034f412263ea29f491f83467e398ddd989cca 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -3,19 +3,20 @@
 /**
  * plugin.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This file provides the framework for a plugin architecture.
  *
  * Documentation on how to write plugins might show up some time.
  *
- * $Id$
+ * @version $Id$
  * @package squirrelmail
  */
 
 /** Everything needs global.. */
 require_once(SM_PATH . 'functions/global.php');
+require_once(SM_PATH . 'functions/prefs.php');
 
 global $squirrelmail_plugin_hooks;
 $squirrelmail_plugin_hooks = array();
@@ -41,9 +42,9 @@ function use_plugin ($name) {
  * @return mixed $data
  */
 function do_hook ($name) {
-    global $squirrelmail_plugin_hooks;
+    global $squirrelmail_plugin_hooks, $currentHookName;
     $data = func_get_args();
-    $ret = '';
+    $currentHookName = $name;
 
     if (isset($squirrelmail_plugin_hooks[$name])
           && is_array($squirrelmail_plugin_hooks[$name])) {
@@ -55,15 +56,24 @@ function do_hook ($name) {
         }
     }
 
+    $currentHookName = '';
+
     /* Variable-length argument lists have a slight problem when */
     /* passing values by reference. Pity. This is a workaround.  */
     return $data;
 }
 
-/* This function executes a hook. */
+/**
+ * This function executes a hook and allows for parameters to be passed.
+ *
+ * @param string name the name of the hook
+ * @param mixed param the parameters to pass to the hook function
+ * @return mixed the return value of the hook function
+ */
 function do_hook_function($name,$parm=NULL) {
-    global $squirrelmail_plugin_hooks;
+    global $squirrelmail_plugin_hooks, $currentHookName;
     $ret = '';
+    $currentHookName = $name;
 
     if (isset($squirrelmail_plugin_hooks[$name])
           && is_array($squirrelmail_plugin_hooks[$name])) {
@@ -75,15 +85,25 @@ function do_hook_function($name,$parm=NULL) {
         }
     }
 
+    $currentHookName = '';
+
     /* Variable-length argument lists have a slight problem when */
     /* passing values by reference. Pity. This is a workaround.  */
     return $ret;
 }
 
-/* This function executes a hook. */
+/**
+ * This function executes a hook, concatenating the results of each
+ * plugin that has the hook defined.
+ *
+ * @param string name the name of the hook
+ * @param mixed parm optional hook function parameters
+ * @return string a concatenation of the results of each plugin function
+ */
 function concat_hook_function($name,$parm=NULL) {
-    global $squirrelmail_plugin_hooks;
+    global $squirrelmail_plugin_hooks, $currentHookName;
     $ret = '';
+    $currentHookName = $name;
 
     if (isset($squirrelmail_plugin_hooks[$name])
           && is_array($squirrelmail_plugin_hooks[$name])) {
@@ -95,6 +115,8 @@ function concat_hook_function($name,$parm=NULL) {
         }
     }
 
+    $currentHookName = '';
+
     /* Variable-length argument lists have a slight problem when */
     /* passing values by reference. Pity. This is a workaround.  */
     return $ret;
@@ -105,9 +127,16 @@ function concat_hook_function($name,$parm=NULL) {
  * false. If $priority is > 0, any one or more trues will override
  * any falses. If $priority < 0, then one or more falses will
  * override any trues.
- * Priority 0 means majority rules.  Ties will be broken with $tie */
+ * Priority 0 means majority rules.  Ties will be broken with $tie
+ *
+ * @param string name the hook name
+ * @param mixed parm the parameters for the hook function
+ * @param int priority
+ * @param bool tie
+ * @return bool the result of the function
+ */
 function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
-    global $squirrelmail_plugin_hooks;
+    global $squirrelmail_plugin_hooks, $currentHookName;
     $yea = 0;
     $nay = 0;
     $ret = $tie;
@@ -116,6 +145,7 @@ function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
         is_array($squirrelmail_plugin_hooks[$name])) {
 
         /* Loop over the plugins that registered the hook */
+        $currentHookName = $name;
         foreach ($squirrelmail_plugin_hooks[$name] as $function) {
             if (function_exists($function)) {
                 $ret = $function($parm);
@@ -126,6 +156,7 @@ function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
                 }
             }
         }
+        $currentHookName = '';
 
         /* Examine the aftermath and assign the return value appropriately */
         if (($priority > 0) && ($yea)) {
@@ -149,18 +180,13 @@ function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
  * This function checks whether the user's USER_AGENT is known to
  * be broken. If so, returns true and the plugin is invisible to the
  * offending browser.
+ * *** THIS IS A TEST FOR JAVASCRIPT SUPPORT ***
+ * FIXME: This function needs to have its name changed!
+ *
+ * @return bool whether this browser properly supports JavaScript
  */
 function soupNazi(){
-
-    $soup_menu = array('Mozilla/3','Mozilla/2','Mozilla/1', 'Opera 4',
-                       'Opera/4', 'OmniWeb', 'Lynx');
-    sqgetGlobalVar('HTTP_USER_AGENT', $user_agent, SQ_SERVER);
-    foreach($soup_menu as $browser) {
-        if(stristr($user_agent, $browser)) {
-            return 1;
-        }
-    }
-    return 0;
+    return !checkForJavascript();
 }
 /*************************************/
 /*** MAIN PLUGIN LOADING CODE HERE ***/
@@ -173,4 +199,4 @@ if (isset($plugins) && is_array($plugins)) {
     }
 }
 
-?>
+?>
\ No newline at end of file