X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fglobal.php;h=634d9d38f1a9521a0884c7bd96507aac2c5b0d8e;hb=dc027257ddbb2de540e88a22d038c69e4fab29c0;hp=a048f3dbda0c8eab6911f90a0f64170531fe83a7;hpb=b455793d64b04ed76805c862363b4c71d2792d5e;p=squirrelmail.git

diff --git a/functions/global.php b/functions/global.php
index a048f3db..634d9d38 100644
--- a/functions/global.php
+++ b/functions/global.php
@@ -1,52 +1,45 @@
 <?php
 
 /**
- * globals.php
+ * global.php
  *
- * Copyright (c) 1999-2003 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 
+ * This includes code to update < 4.1.0 globals to the newer format
  * It also has some session register functions that work across various
- * php versions. 
+ * php versions.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
  */
 
+/** Bring in the config file. */
 require_once(SM_PATH . 'config/config.php');
 
-/* set the name of the session cookie */
-if(isset($session_name) && $session_name) {  
-    ini_set('session.name' , $session_name);  
-} else {  
-    ini_set('session.name' , 'SQMSESSID');  
+/** set the name of the session cookie */
+if(isset($session_name) && $session_name) {
+    ini_set('session.name' , $session_name);
+} else {
+    ini_set('session.name' , 'SQMSESSID');
 }
 
-/* If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
+/**
+ * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
  * Force magic_quotes_runtime off.
- * chilts@birdbrained.org - I put it here in the hopes that all SM code includes this.
+ * 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');
 
-/* convert old-style superglobals to current method
- * this is executed if you are running PHP 4.0.x.
- * it is run via a require_once directive in validate.php 
- * and redirect.php. Patch submitted by Ray Black.
- */ 
-
-if ( !check_php_version(4,1) ) {
-  global $_COOKIE, $_ENV, $_FILES, $_GET, $_POST, $_SERVER, $_SESSION;
-  global $HTTP_COOKIE_VARS, $HTTP_ENV_VARS, $HTTP_POST_FILES, $HTTP_GET_VARS,
-         $HTTP_POST_VARS, $HTTP_SERVER_VARS, $HTTP_SESSION_VARS;
-  $_COOKIE  =& $HTTP_COOKIE_VARS;
-  $_ENV     =& $HTTP_ENV_VARS;
-  $_FILES   =& $HTTP_POST_FILES;
-  $_GET     =& $HTTP_GET_VARS;
-  $_POST    =& $HTTP_POST_VARS;
-  $_SERVER  =& $HTTP_SERVER_VARS;
-  $_SESSION =& $HTTP_SESSION_VARS;
-}
+/* Since we decided all IMAP servers must implement the UID command as defined in
+ * the IMAP RFC, we force $uid_support to be on.
+ */
+
+global $uid_support;
+$uid_support = true;
+
+sqsession_is_active();
 
 /* if running with magic_quotes_gpc then strip the slashes
    from POST and GET global arrays */
@@ -62,43 +55,52 @@ if (get_magic_quotes_gpc()) {
 
 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
 
-/** 
- * returns true if current php version is at mimimum a.b.c 
- * 
+/**
+ * returns true if current php version is at mimimum a.b.c
+ *
  * Called: check_php_version(4,1)
+ * @param int a major version number
+ * @param int b minor version number
+ * @param int c release number
+ * @return bool
  */
-function check_php_version ($a = '0', $b = '0', $c = '0')             
+function check_php_version ($a = '0', $b = '0', $c = '0')
 {
-    global $SQ_PHP_VERSION;
- 
-    if(!isset($SQ_PHP_VERSION))
-        $SQ_PHP_VERSION = substr( str_pad( preg_replace('/\D/','', PHP_VERSION), 3, '0'), 0, 3);
-
-    return $SQ_PHP_VERSION >= ($a.$b.$c);
+    return version_compare ( PHP_VERSION, "$a.$b.$c", 'ge' );
 }
 
 /**
- * returns true if the current internal SM version is at minimum a.b.c 
- * These are plain integer comparisons, as our internal version is 
+ * returns true if the current internal SM version is at minimum a.b.c
+ * These are plain integer comparisons, as our internal version is
  * constructed by us, as an array of 3 ints.
  *
  * Called: check_sm_version(1,3,3)
+ * @param int a major version number
+ * @param int b minor version number
+ * @param int c release number
+ * @return bool
  */
 function check_sm_version($a = 0, $b = 0, $c = 0)
 {
     global $SQM_INTERNAL_VERSION;
     if ( !isset($SQM_INTERNAL_VERSION) ||
          $SQM_INTERNAL_VERSION[0] < $a ||
-	 $SQM_INTERNAL_VERSION[1] < $b ||
-	 ( $SQM_INTERNAL_VERSION[1] == $b &&
+         ( $SQM_INTERNAL_VERSION[0] == $a &&
+           $SQM_INTERNAL_VERSION[1] < $b) ||
+         ( $SQM_INTERNAL_VERSION[0] == $a &&
+           $SQM_INTERNAL_VERSION[1] == $b &&
            $SQM_INTERNAL_VERSION[2] < $c ) ) {
         return FALSE;
-    } 
-    return TRUE;  
+    }
+    return TRUE;
 }
 
 
-/* recursively strip slashes from the values of an array */
+/**
+ * Recursively strip slashes from the values of an array.
+ * @param array array the array to strip, passed by reference
+ * @return void
+ */
 function sqstripslashes(&$array) {
     if(count($array) > 0) {
         foreach ($array as $index=>$value) {
@@ -112,48 +114,49 @@ function sqstripslashes(&$array) {
     }
 }
 
+/**
+ * Add a variable to the session.
+ * @param mixed $var the variable to register
+ * @param string $name the name to refer to this variable
+ * @return void
+ */
 function sqsession_register ($var, $name) {
 
     sqsession_is_active();
 
-    if ( !check_php_version(4,1) ) {
-        global $HTTP_SESSION_VARS;
-        $HTTP_SESSION_VARS[$name] = $var;
-    }
-    else {
-        $_SESSION["$name"] = $var; 
-    }
+    $_SESSION["$name"] = $var;
+
     session_register("$name");
 }
 
+/**
+ * Delete a variable from the session.
+ * @param string $name the name of the var to delete
+ * @return void
+ */
 function sqsession_unregister ($name) {
 
     sqsession_is_active();
 
-    if ( !check_php_version(4,1) ) {
-        global $HTTP_SESSION_VARS;
-        unset($HTTP_SESSION_VARS[$name]);
-    }
-    else {
-        unset($_SESSION[$name]);
-    }
+    unset($_SESSION[$name]);
+
     session_unregister("$name");
 }
 
+/**
+ * Checks to see if a variable has already been registered
+ * in the session.
+ * @param string $name the name of the var to check
+ * @return bool whether the var has been registered
+ */
 function sqsession_is_registered ($name) {
     $test_name = &$name;
     $result = false;
-    if ( !check_php_version(4,1) ) {
-        global $HTTP_SESSION_VARS;
-        if (isset($HTTP_SESSION_VARS[$test_name])) {
-            $result = true;
-        }
-    }
-    else {
-        if (isset($_SESSION[$test_name])) {
-            $result = true;
-        }
+
+    if (isset($_SESSION[$test_name])) {
+        $result = true;
     }
+
     return $result;
 }
 
@@ -164,65 +167,88 @@ define('SQ_POST',2);
 define('SQ_SESSION',3);
 define('SQ_COOKIE',4);
 define('SQ_SERVER',5);
+define('SQ_FORM',6);
 
 /**
  * Search for the var $name in $_SESSION, $_POST, $_GET,
- * $_COOKIE, or $_SERVER and set it in provided var. 
+ * $_COOKIE, or $_SERVER and set it in provided var.
+ *
  * If $search is not provided,  or == SQ_INORDER, it will search
  * $_SESSION, then $_POST, then $_GET. Otherwise,
- * use one of the defined constants to look for 
+ * use one of the defined constants to look for
  * a var in one place specifically.
- * Returns FALSE if variable is not found.
- * Returns TRUE if it is.
+ *
+ * Note: $search is an int value equal to one of the
+ * constants defined above.
+ *
+ * example:
+ *    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
+ * @return bool whether variable is found.
  */
 function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) {
-    if ( !check_php_version(4,1) ) {
-        global $_SESSION, $_GET, $_POST, $_COOKIE, $_SERVER;
-    }
-    
+
+    /* NOTE: DO NOT enclose the constants in the switch
+       statement with quotes. They are constant values,
+       enclosing them in quotes will cause them to evaluate
+       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. */
-	default:
-	case 'SQ_INORDER':
-	case 'SQ_SESSION':
-	  if( isset($_SESSION[$name]) ) {
+        /* we want the default case to be first here,
+           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:
+        if( isset($_SESSION[$name]) ) {
             $value = $_SESSION[$name];
-	    return TRUE;
-          } elseif ( $search == SQ_SESSION ) {
-	    break;
-	  }
-	case 'SQ_POST':
-	  if( isset($_POST[$name]) ) {
+            return TRUE;
+        } elseif ( $search == SQ_SESSION ) {
+            break;
+        }
+      case SQ_FORM:   // check post, get
+      case SQ_POST:
+        if( isset($_POST[$name]) ) {
             $value = $_POST[$name];
-	    return TRUE;
-	  } elseif ( $search == SQ_POST ) {
-	    break;
-	  }
-       	case 'SQ_GET':
-	  if ( isset($_GET[$name]) ) {
-            $value = $_GET[$name];
-	    return TRUE;
-	  } 
-	  /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
-	  break;
-        case 'SQ_COOKIE':
-          if ( isset($_COOKIE[$name]) ) {
-             $value = $_COOKIE[$name];
-             return TRUE;
-          }
-	  break;
-	case 'SQ_SERVER':
-          if ( isset($_SERVER[$name]) ) {
-             $value = $_SERVER[$name];
-             return TRUE;
-          }
+            return TRUE;
+        } elseif ( $search == SQ_POST ) {
           break;
+        }
+      case SQ_GET:
+        if ( isset($_GET[$name]) ) {
+            $value = $_GET[$name];
+            return TRUE;
+        }
+        /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
+        break;
+      case SQ_COOKIE:
+        if ( isset($_COOKIE[$name]) ) {
+            $value = $_COOKIE[$name];
+            return TRUE;
+        }
+        break;
+      case SQ_SERVER:
+        if ( isset($_SERVER[$name]) ) {
+            $value = $_SERVER[$name];
+            return TRUE;
+        }
+        break;
     }
+    /* Nothing found, reset $value and return FALSE */
+    $value = null;
     return FALSE;
 }
 
+/**
+ * Deletes an existing session, more advanced than the standard PHP
+ * session_destroy(), it explicitly deletes the cookies and global vars.
+ */
 function sqsession_destroy() {
 
     /*
@@ -244,18 +270,13 @@ function sqsession_destroy() {
 
     $sessid = session_id();
     if (!empty( $sessid )) {
-        if ( !check_php_version(4,1) ) {
-            global $HTTP_SESSION_VARS;
-            $HTTP_SESSION_VARS = array();
-        } else {
-            $_SESSION = array();
-        }
-        @session_destroy;
+        $_SESSION = array();
+        @session_destroy();
     }
 
 }
 
-/*
+/**
  * Function to verify a session has been started.  If it hasn't
  * start a session up.  php.net doesn't tell you that $_SESSION
  * (even though autoglobal), is not created unless a session is
@@ -270,5 +291,5 @@ function sqsession_is_active() {
     }
 }
 
-
+// vim: et ts=4
 ?>