<?php
/**
- * globals.php
+ * global.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 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$
+ * @version $Id$
+ * @package squirrelmail
*/
+/** Bring in the config file. */
require_once(SM_PATH . 'config/config.php');
-/* set the name of the session cookie */
+/** 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.
+/** 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');
-/* 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 */
* 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')
{
* 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;
}
}
-/* 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) {
}
}
+/**
+ * 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;
}
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,
* sqgetGlobalVar('username',$username,SQ_SESSION);
* -- no quotes around last param!
*
- * Returns FALSE if variable is not found.
- * Returns TRUE if it is.
+ * @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,
so that if a valid value isn't specified,
all three arrays will be searched. */
default:
- case SQ_INORDER:
+ case SQ_INORDER: // check session, post, get
case SQ_SESSION:
if( isset($_SESSION[$name]) ) {
$value = $_SESSION[$name];
} elseif ( $search == SQ_SESSION ) {
break;
}
+ case SQ_FORM: // check post, get
case SQ_POST:
if( isset($_POST[$name]) ) {
$value = $_POST[$name];
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() {
/*
$sessid = session_id();
if (!empty( $sessid )) {
- if ( !check_php_version(4,1) ) {
- global $HTTP_SESSION_VARS;
- $HTTP_SESSION_VARS = array();
- } else {
- $_SESSION = array();
- }
+ $_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
*/
function sqsession_is_active() {
-
+
$sessid = session_id();
if ( empty( $sessid ) ) {
session_start();
projects / squirrelmail.git / blobdiff