X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fglobal.php;h=0c19df8867be16ffd7a227fa26dcfe9749396790;hp=ee8478e5c9329c9f76c591fe6c58b2267538dd3a;hb=82d304a0501324b276cabab1870755d5352bd21c;hpb=3658a9997eba0d86235f104b8aea2c827877f520 diff --git a/functions/global.php b/functions/global.php index ee8478e5..0c19df88 100644 --- a/functions/global.php +++ b/functions/global.php @@ -1,9 +1,9 @@ = ($a.$b.$c); } -/* recursively strip slashes from the values of an array */ +/** + * 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[2] < $c ) ) { + return FALSE; + } + return TRUE; +} + + +/** + * 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) { @@ -77,7 +138,16 @@ 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; @@ -88,7 +158,15 @@ function sqsession_register ($var, $name) { 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]); @@ -99,6 +177,12 @@ function sqsession_unregister ($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; @@ -117,50 +201,146 @@ function sqsession_is_registered ($name) { } +define('SQ_INORDER',0); +define('SQ_GET',1); +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 - * (in that order) and register it as a global var. + * Search for the var $name in $_SESSION, $_POST, $_GET, + * $_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 + * a var in one place specifically. + * + * 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! + * + * @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 sqextractGlobalVar ($name) { +function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) { + if ( !check_php_version(4,1) ) { - global $_SESSION, $_GET, $_POST; - } - global $$name; - if( isset($_SESSION[$name]) ) { - $$name = $_SESSION[$name]; - } - if( isset($_POST[$name]) ) { - $$name = $_POST[$name]; + global $HTTP_COOKIE_VARS, $HTTP_GET_VARS, $HTTP_POST_VARS, + $HTTP_SERVER_VARS, $HTTP_SESSION_VARS; + + $_COOKIE =& $HTTP_COOKIE_VARS; + $_GET =& $HTTP_GET_VARS; + $_POST =& $HTTP_POST_VARS; + $_SERVER =& $HTTP_SERVER_VARS; + $_SESSION =& $HTTP_SESSION_VARS; } - else if ( isset($_GET[$name]) ) { - $$name = $_GET[$name]; + + /* 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: // check session, post, get + case SQ_SESSION: + if( isset($_SESSION[$name]) ) { + $value = $_SESSION[$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; + } + break; } + 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() { + + /* + * php.net says we can kill the cookie by setting just the name: + * http://www.php.net/manual/en/function.setcookie.php + * maybe this will help fix the session merging again. + * + * Changed the theory on this to kill the cookies first starting + * a new session will provide a new session for all instances of + * the browser, we don't want that, as that is what is causing the + * merging of sessions. + */ + global $base_uri; - /* start session to be able to destroy it later */ - session_start(); + if (isset($_COOKIE[session_name()])) setcookie(session_name(), '', time() - 5, $base_uri); + if (isset($_COOKIE['username'])) setcookie('username','',time() - 5,$base_uri); + if (isset($_COOKIE['key'])) setcookie('key','',time() - 5,$base_uri); - if ( !check_php_version(4,1) ) { - global $HTTP_SESSION_VARS; - $HTTP_SESSION_VARS = array(); - } - else { - $_SESSION = array(); + $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(); } - /* - * now reset cookies to 5 seconds ago to delete from browser - */ +} + +/** + * 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 + * started, unlike $_POST, $_GET and such + */ - @session_destroy(); - $cookie_params = session_get_cookie_params(); - setcookie(session_name(), '', time() - 5, $cookie_params['path'], - $cookie_params['domain']); - setcookie('username', '', time() - 5, $base_uri); - setcookie('key', '', time() - 5 , $base_uri); +function sqsession_is_active() { + + $sessid = session_id(); + if ( empty( $sessid ) ) { + session_start(); + } } + ?>