squirrelmail/functions/global.php
2003-06-16 15:00:10 +00:00

300 lines
8.1 KiB
PHP

<?php
/**
* globals.php
*
* Copyright (c) 1999-2003 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
* It also has some session register functions that work across various
* php versions.
*
* $Id$
*/
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');
}
/* 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.
* 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, $PHP_SELF;
$_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;
if (!isset($PHP_SELF) || empty($PHP_SELF)) {
$PHP_SELF = $HTTP_SERVER_VARS['PHP_SELF'];
}
}
/* if running with magic_quotes_gpc then strip the slashes
from POST and GET global arrays */
if (get_magic_quotes_gpc()) {
sqstripslashes($_GET);
sqstripslashes($_POST);
}
/* strip any tags added to the url from PHP_SELF.
This fixes hand crafted url XXS expoits for any
page that uses PHP_SELF as the FORM action */
$_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
/**
* returns true if current php version is at mimimum a.b.c
*
* Called: check_php_version(4,1)
*/
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);
}
/**
* 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)
*/
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 */
function sqstripslashes(&$array) {
if(count($array) > 0) {
foreach ($array as $index=>$value) {
if (is_array($array[$index])) {
sqstripslashes($array[$index]);
}
else {
$array[$index] = stripslashes($value);
}
}
}
}
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_register("$name");
}
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]);
}
session_unregister("$name");
}
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;
}
}
return $result;
}
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,
* $_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!
*
* Returns FALSE if variable is not found.
* Returns TRUE if it is.
*/
function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) {
if ( !check_php_version(4,1) ) {
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;
}
/* 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;
}
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;
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);
$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();
}
}
/*
* 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
*/
function sqsession_is_active() {
$sessid = session_id();
if ( empty( $sessid ) ) {
session_start();
}
}
?>