d7612d1613efe2b9bae8018a6972124868ee93ab
6 * This includes code to update < 4.1.0 globals to the newer format
7 * It also has some session register functions that work across various
10 * @copyright © 1999-2006 The SquirrelMail Project Team
11 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
13 * @package squirrelmail
18 define('SQ_INORDER',0);
21 define('SQ_SESSION',3);
22 define('SQ_COOKIE',4);
23 define('SQ_SERVER',5);
28 * returns true if current php version is at mimimum a.b.c
30 * Called: check_php_version(4,1)
31 * @param int a major version number
32 * @param int b minor version number
33 * @param int c release number
36 function check_php_version ($a = '0', $b = '0', $c = '0')
38 return version_compare ( PHP_VERSION
, "$a.$b.$c", 'ge' );
42 * returns true if the current internal SM version is at minimum a.b.c
43 * These are plain integer comparisons, as our internal version is
44 * constructed by us, as an array of 3 ints.
46 * Called: check_sm_version(1,3,3)
47 * @param int a major version number
48 * @param int b minor version number
49 * @param int c release number
52 function check_sm_version($a = 0, $b = 0, $c = 0)
54 global $SQM_INTERNAL_VERSION;
55 if ( !isset($SQM_INTERNAL_VERSION) ||
56 $SQM_INTERNAL_VERSION[0] < $a ||
57 ( $SQM_INTERNAL_VERSION[0] == $a &&
58 $SQM_INTERNAL_VERSION[1] < $b) ||
59 ( $SQM_INTERNAL_VERSION[0] == $a &&
60 $SQM_INTERNAL_VERSION[1] == $b &&
61 $SQM_INTERNAL_VERSION[2] < $c ) ) {
69 * Recursively strip slashes from the values of an array.
70 * @param array array the array to strip, passed by reference
73 function sqstripslashes(&$array) {
74 if(count($array) > 0) {
75 foreach ($array as $index=>$value) {
76 if (is_array($array[$index])) {
77 sqstripslashes($array[$index]);
80 $array[$index] = stripslashes($value);
87 * Add a variable to the session.
88 * @param mixed $var the variable to register
89 * @param string $name the name to refer to this variable
92 function sqsession_register ($var, $name) {
94 sqsession_is_active();
96 $_SESSION["$name"] = $var;
98 session_register("$name");
102 * Delete a variable from the session.
103 * @param string $name the name of the var to delete
106 function sqsession_unregister ($name) {
108 sqsession_is_active();
110 unset($_SESSION[$name]);
112 session_unregister("$name");
116 * Checks to see if a variable has already been registered
118 * @param string $name the name of the var to check
119 * @return bool whether the var has been registered
121 function sqsession_is_registered ($name) {
125 if (isset($_SESSION[$test_name])) {
133 * Search for the var $name in $_SESSION, $_POST, $_GET, $_COOKIE, or $_SERVER
134 * and set it in provided var.
136 * If $search is not provided, or if it is SQ_INORDER, it will search $_SESSION,
137 * then $_POST, then $_GET. If $search is SQ_FORM it will search $_POST and
138 * $_GET. Otherwise, use one of the defined constants to look for a var in one
139 * place specifically.
141 * Note: $search is an int value equal to one of the constants defined above.
144 * sqgetGlobalVar('username',$username,SQ_SESSION);
145 * // No quotes around last param, it's a constant - not a string!
147 * @param string name the name of the var to search
148 * @param mixed value the variable to return
149 * @param int search constant defining where to look
150 * @param int typecast force variable to be cast to given type (please
151 * use SQ_TYPE_XXX constants or set to FALSE (default)
152 * to leave variable type unmolested)
153 * @return bool whether variable is found.
155 function sqgetGlobalVar($name, &$value, $search = SQ_INORDER
, $default = NULL, $typecast = false) {
160 /* we want the default case to be first here,
161 so that if a valid value isn't specified,
162 all three arrays will be searched. */
164 case SQ_INORDER
: // check session, post, get
166 if( isset($_SESSION[$name]) ) {
167 $value = $_SESSION[$name];
170 } elseif ( $search == SQ_SESSION
) {
173 case SQ_FORM
: // check post, get
175 if( isset($_POST[$name]) ) {
176 $value = $_POST[$name];
179 } elseif ( $search == SQ_POST
) {
183 if ( isset($_GET[$name]) ) {
184 $value = $_GET[$name];
188 /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
191 if ( isset($_COOKIE[$name]) ) {
192 $value = $_COOKIE[$name];
198 if ( isset($_SERVER[$name]) ) {
199 $value = $_SERVER[$name];
205 if ($result && $typecast) {
207 case SQ_TYPE_INT
: $value = (int) $value; break;
208 case SQ_TYPE_STRING
: $value = (string) $value; break;
209 case SQ_TYPE_BOOL
: $value = (bool) $value; break;
212 } else if (!is_null($default)) {
219 * Deletes an existing session, more advanced than the standard PHP
220 * session_destroy(), it explicitly deletes the cookies and global vars.
222 function sqsession_destroy() {
225 * php.net says we can kill the cookie by setting just the name:
226 * http://www.php.net/manual/en/function.setcookie.php
227 * maybe this will help fix the session merging again.
229 * Changed the theory on this to kill the cookies first starting
230 * a new session will provide a new session for all instances of
231 * the browser, we don't want that, as that is what is causing the
232 * merging of sessions.
237 if (isset($_COOKIE[session_name()])) sqsetcookie(session_name(), '', 0, $base_uri);
238 if (isset($_COOKIE['username'])) sqsetcookie('username','',0,$base_uri);
239 if (isset($_COOKIE['key'])) sqsetcookie('key','',0,$base_uri);
241 $sessid = session_id();
242 if (!empty( $sessid )) {
249 * Function to verify a session has been started. If it hasn't
250 * start a session up. php.net doesn't tell you that $_SESSION
251 * (even though autoglobal), is not created unless a session is
252 * started, unlike $_POST, $_GET and such
254 function sqsession_is_active() {
255 $sessid = session_id();
256 if ( empty( $sessid ) ) {
262 * Function to start the session and store the cookie with the session_id as
263 * HttpOnly cookie which means that the cookie isn't accessible by javascript
266 function sqsession_start() {
270 $session_id = session_id();
272 // session_starts sets the sessionid cookie buth without the httponly var
273 // setting the cookie again sets the httponly cookie attribute
275 // disable, @see sqsetcookie and php 5.1.2
276 // sqsetcookie(session_name(),session_id(),false,$base_uri);
282 * @param string $sName The name of the cookie.
283 * @param string $sValue The value of the cookie.
284 * @param int $iExpire The time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
285 * @param string $sPath The path on the server in which the cookie will be available on.
286 * @param string $sDomain The domain that the cookie is available.
287 * @param boolean $bSecure Indicates that the cookie should only be transmitted over a secure HTTPS connection.
288 * @param boolean $bHttpOnly Disallow JS to access the cookie (IE6 only)
291 function sqsetcookie($sName,$sValue,$iExpire=false,$sPath="",$sDomain="",$bSecure=false,$bHttpOnly=true,$bFlush=false) {
292 static $sCookieCache;
293 if (!isset($sCache)) {
297 * We have to send all cookies with one header call otherwise we loose cookies.
298 * In order to achieve that the sqsetcookieflush function calls this function with $bFlush = true.
299 * If that happens we send the cookie header.
302 // header($sCookieCache);
307 // php 5.1.2 and 4.4.2 do not allow to send multiple headers at once.
308 // Because that's the only way to get this thing working we fallback to
309 // setcookie until we solved this
310 if ($iExpire===false) $iExpire = 0;
311 setcookie($sName, $sValue, $iExpire, $sPath);
314 $sHeader = "Set-Cookie: $sName=$sValue";
316 $sHeader .= "; path=$sPath";
318 if ($iExpire !== false) {
319 $sHeader .= "; Max-Age=$iExpire";
320 // php uses Expire header, also add the expire header
321 $sHeader .= "; expires=". gmdate('D, d-M-Y H:i:s T',$iExpire);
324 $sHeader .= "; Domain=$sDomain";
326 // TODO: IE for Mac (5.2) thinks that semicolon is part of cookie domain
328 $sHeader .= "; Secure";
331 $sHeader .= "; HttpOnly";
333 // $sHeader .= "; Version=1";
334 $sCookieCache .= $sHeader ."\r\n";
335 //header($sHeader."\r\n");
339 * Send the cookie header
341 * Cookies set with sqsetcookie will bet set after a sqsetcookieflush call.
344 function sqsetcookieflush() {
345 sqsetcookie('','','','','','','',true);
349 * session_regenerate_id replacement for PHP < 4.3.2
351 * This code is borrowed from Gallery, session.php version 1.53.2.1
353 if (!function_exists('session_regenerate_id')) {
354 function make_seed() {
355 list($usec, $sec) = explode(' ', microtime());
356 return (float)$sec +
((float)$usec * 100000);
359 function php_combined_lcg() {
360 mt_srand(make_seed());
361 $tv = gettimeofday();
362 $lcg['s1'] = $tv['sec'] ^
(~
$tv['usec']);
363 $lcg['s2'] = mt_rand();
364 $q = (int) ($lcg['s1'] / 53668);
365 $lcg['s1'] = (int) (40014 * ($lcg['s1'] - 53668 * $q) - 12211 * $q);
366 if ($lcg['s1'] < 0) {
367 $lcg['s1'] +
= 2147483563;
369 $q = (int) ($lcg['s2'] / 52774);
370 $lcg['s2'] = (int) (40692 * ($lcg['s2'] - 52774 * $q) - 3791 * $q);
371 if ($lcg['s2'] < 0) {
372 $lcg['s2'] +
= 2147483399;
374 $z = (int) ($lcg['s1'] - $lcg['s2']);
378 return $z * 4.656613e-10;
381 function session_regenerate_id() {
383 $tv = gettimeofday();
384 sqgetGlobalVar('REMOTE_ADDR',$remote_addr,SQ_SERVER
);
385 $buf = sprintf("%.15s%ld%ld%0.8f", $remote_addr, $tv['sec'], $tv['usec'], php_combined_lcg() * 10);
386 session_id(md5($buf));
387 if (ini_get('session.use_cookies')) {
388 // at a later stage we use sqsetcookie. At this point just do
389 // what session_regenerate_id would do
390 setcookie(session_name(), session_id(), NULL, $base_uri);
400 * Creates an URL for the page calling this function, using either the PHP global
401 * REQUEST_URI, or the PHP global PHP_SELF with QUERY_STRING added. Before 1.5.1
402 * function was stored in function/strings.php.
404 * @return string the complete url for this page
407 function php_self () {
408 if ( sqgetGlobalVar('REQUEST_URI', $req_uri, SQ_SERVER
) && !empty($req_uri) ) {
412 if ( sqgetGlobalVar('PHP_SELF', $php_self, SQ_SERVER
) && !empty($php_self) ) {
414 // need to add query string to end of PHP_SELF to match REQUEST_URI
416 if ( sqgetGlobalVar('QUERY_STRING', $query_string, SQ_SERVER
) && !empty($query_string) ) {
417 $php_self .= '?' . $query_string;