Code Cleaning

[squirrelmail.git] / functions / plugin.php

diff --git a/functions/plugin.php b/functions/plugin.php
index 392359fcc74e203c75530293ad26c2a09c8e63f4..3ce547ca38ce8e4b52144274a8bc05fe947f2dc6 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -3,7 +3,7 @@
 /**
  * plugin.php
  *
- * Copyright (c) 1999-2001 The SquirrelMail Development Team
+ * Copyright (c) 1999-2002 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.
@@ -13,65 +13,64 @@
  * $Id$
  */
 
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
-/***    + Base level indent should begin at left margin, as    ***/
-/***      the first line of the function definition below.     ***/
-/***    + All identation should consist of four space blocks   ***/
-/***    + Tab characters are evil.                             ***/
-/***    + all comments should use "slash-star ... star-slash"  ***/
-/***      style -- no pound characters, no slash-slash style   ***/
-/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
-/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
-/***    + Please use ' instead of ", when possible. Note "     ***/
-/***      should always be used in _( ) function calls.        ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
 global $squirrelmail_plugin_hooks;
 $squirrelmail_plugin_hooks = array();
 
-    // This function adds a plugin
-    function use_plugin ($name) {
+/* This function adds a plugin. */
+function use_plugin ($name) {
+    if (file_exists("../plugins/$name/setup.php")) {
+        include_once("../plugins/$name/setup.php");
+        $function = "squirrelmail_plugin_init_$name";
+        if (function_exists($function)) {
+            $function();
+        }
+    }
+}
 
-        if (file_exists("../plugins/$name/setup.php")) {
-            include_once("../plugins/$name/setup.php");
-            $function = "squirrelmail_plugin_init_$name";
+/* This function executes a hook. */
+function do_hook ($name) {
+    global $squirrelmail_plugin_hooks;
+    $data = func_get_args();
+
+    if (isset($squirrelmail_plugin_hooks[$name])
+          && is_array($squirrelmail_plugin_hooks[$name])) {
+        foreach ($squirrelmail_plugin_hooks[$name] as $function) {
+            /* Add something to set correct gettext domain for plugin. */
             if (function_exists($function)) {
-                $function();
+                $function($data);
             }
         }
-
     }
 
-    // This function executes a hook
-    function do_hook ($name) {
-        global $squirrelmail_plugin_hooks;
-        $data = func_get_args();
+    /* Variable-length argument lists have a slight problem when */
+    /* passing values by reference. Pity. This is a workaround.  */
+    return $data;
+}
 
-        if (isset($squirrelmail_plugin_hooks[$name])
-              && is_array($squirrelmail_plugin_hooks[$name])) {
-            foreach ($squirrelmail_plugin_hooks[$name] as $function) {
-                // Add something to set correct gettext domain for plugin
-                if (function_exists($function)) {
-                    $function($data);
-                }
-            }
-        }
+/*************************************/
+/*** MAIN PLUGIN LOADING CODE HERE ***/
+/*************************************/
 
-        // 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 (isset($plugins) && is_array($plugins)) {
+    foreach ($plugins as $name) {
+        use_plugin($name);
     }
+}
 
-    /* -------------------- MAIN --------------------- */
+    /**
+     * 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.
+     */
+    function soupNazi(){
 
-    // On startup, register all plugins configured for use
-    if (isset($plugins) && is_array($plugins)) {
-        foreach ($plugins as $name) {
-            use_plugin($name);
-        }
+        global $HTTP_USER_AGENT, $SQSPELL_SOUP_NAZI;
+        
+        require_once('../plugins/squirrelspell/sqspell_config.php');
+
+        $soup_menu = explode( ',', $SQSPELL_SOUP_NAZI );
+        return( in_array( trim( $HTTP_USER_AGENT ), $soup_menu ) );
     }
 
-?>
+?>
\ No newline at end of file