Partial support for IMAP LOgin Referrals: tell the user what's going on

[squirrelmail.git] / functions / global.php

diff --git a/functions/global.php b/functions/global.php
index 1330022c647bfb297b8cf26a43a1fda65ced18cc..634d9d38f1a9521a0884c7bd96507aac2c5b0d8e 100644 (file)
--- a/functions/global.php
+++ b/functions/global.php
@@ -3,7 +3,7 @@
 /**
  * global.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This includes code to update < 4.1.0 globals to the newer format
@@ -24,10 +24,11 @@ if(isset($session_name) && $session_name) {
     ini_set('session.name' , 'SQMSESSID');
 }
 
-/** If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
- *  Force magic_quotes_runtime off.
- *  tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
- *  If there's a better place, please let me know.
+/**
+ * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
+ * Force magic_quotes_runtime off.
+ * tassium@squirrelmail.org - I put it here in the hopes that all SM code includes this.
+ * If there's a better place, please let me know.
  */
 ini_set('magic_quotes_runtime','0');
 
@@ -184,6 +185,9 @@ define('SQ_FORM',6);
  *    sqgetGlobalVar('username',$username,SQ_SESSION);
  *  -- no quotes around last param!
  *
+ * WARNING: Since 1.4.5 and 1.5.1 function nulls $value, 
+ * if variable is not available.
+ *
  * @param string name the name of the var to search
  * @param mixed value the variable to return
  * @param int search constant defining where to look
@@ -197,8 +201,8 @@ function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) {
        as strings. */
     switch ($search) {
         /* we want the default case to be first here,
-          so that if a valid value isn't specified,
-          all three arrays will be searched. */
+           so that if a valid value isn't specified,
+           all three arrays will be searched. */
       default:
       case SQ_INORDER: // check session, post, get
       case SQ_SESSION:
@@ -236,6 +240,8 @@ function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) {
         }
         break;
     }
+    /* Nothing found, reset $value and return FALSE */
+    $value = null;
     return FALSE;
 }
 
@@ -286,4 +292,4 @@ function sqsession_is_active() {
 }
 
 // vim: et ts=4
-?>
\ No newline at end of file
+?>