functions/global.php

   1 <?php
   2
   3 /**
   4  * globals.php
   5  *
   6  * Copyright (c) 1999-2003 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This includes code to update < 4.1.0 globals to the newer format
  10  * It also has some session register functions that work across various
  11  * php versions.
  12  *
  13  * $Id$
  14  */
  15
  16 require_once(SM_PATH . 'config/config.php');
  17
  18 /* set the name of the session cookie */
  19 if(isset($session_name) && $session_name) {
  20     ini_set('session.name' , $session_name);
  21 } else {
  22     ini_set('session.name' , 'SQMSESSID');
  23 }
  24
  25 /* If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
  26  * Force magic_quotes_runtime off.
  27  * chilts@birdbrained.org - I put it here in the hopes that all SM code includes this.
  28  * If there's a better place, please let me know.
  29  */
  30 ini_set('magic_quotes_runtime','0');
  31
  32 /* convert old-style superglobals to current method
  33  * this is executed if you are running PHP 4.0.x.
  34  * it is run via a require_once directive in validate.php
  35  * and redirect.php. Patch submitted by Ray Black.
  36  */
  37
  38 if ( !check_php_version(4,1) ) {
  39   global $_COOKIE, $_ENV, $_FILES, $_GET, $_POST, $_SERVER, $_SESSION;
  40   global $HTTP_COOKIE_VARS, $HTTP_ENV_VARS, $HTTP_POST_FILES, $HTTP_GET_VARS,
  41          $HTTP_POST_VARS, $HTTP_SERVER_VARS, $HTTP_SESSION_VARS, $PHP_SELF;
  42   $_COOKIE  =& $HTTP_COOKIE_VARS;
  43   $_ENV     =& $HTTP_ENV_VARS;
  44   $_FILES   =& $HTTP_POST_FILES;
  45   $_GET     =& $HTTP_GET_VARS;
  46   $_POST    =& $HTTP_POST_VARS;
  47   $_SERVER  =& $HTTP_SERVER_VARS;
  48   $_SESSION =& $HTTP_SESSION_VARS;
  49   if (!isset($PHP_SELF) || empty($PHP_SELF)) {
  50      $PHP_SELF =  $HTTP_SERVER_VARS['PHP_SELF'];
  51   }
  52 }
  53
  54 /* if running with magic_quotes_gpc then strip the slashes
  55    from POST and GET global arrays */
  56
  57 if (get_magic_quotes_gpc()) {
  58     sqstripslashes($_GET);
  59     sqstripslashes($_POST);
  60 }
  61
  62 /* strip any tags added to the url from PHP_SELF.
  63    This fixes hand crafted url XXS expoits for any
  64    page that uses PHP_SELF as the FORM action */
  65
  66 $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
  67
  68 /**
  69  * returns true if current php version is at mimimum a.b.c
  70  *
  71  * Called: check_php_version(4,1)
  72  */
  73 function check_php_version ($a = '0', $b = '0', $c = '0')
  74 {
  75     global $SQ_PHP_VERSION;
  76
  77     if(!isset($SQ_PHP_VERSION))
  78         $SQ_PHP_VERSION = substr( str_pad( preg_replace('/\D/','', PHP_VERSION), 3, '0'), 0, 3);
  79
  80     return $SQ_PHP_VERSION >= ($a.$b.$c);
  81 }
  82
  83 /**
  84  * returns true if the current internal SM version is at minimum a.b.c
  85  * These are plain integer comparisons, as our internal version is
  86  * constructed by us, as an array of 3 ints.
  87  *
  88  * Called: check_sm_version(1,3,3)
  89  */
  90 function check_sm_version($a = 0, $b = 0, $c = 0)
  91 {
  92     global $SQM_INTERNAL_VERSION;
  93     if ( !isset($SQM_INTERNAL_VERSION) ||
  94          $SQM_INTERNAL_VERSION[0] < $a ||
  95          $SQM_INTERNAL_VERSION[1] < $b ||
  96          ( $SQM_INTERNAL_VERSION[1] == $b &&
  97            $SQM_INTERNAL_VERSION[2] < $c ) ) {
  98         return FALSE;
  99     }
 100     return TRUE;
 101 }
 102
 103
 104 /* recursively strip slashes from the values of an array */
 105 function sqstripslashes(&$array) {
 106     if(count($array) > 0) {
 107         foreach ($array as $index=>$value) {
 108             if (is_array($array[$index])) {
 109                 sqstripslashes($array[$index]);
 110             }
 111             else {
 112                 $array[$index] = stripslashes($value);
 113             }
 114         }
 115     }
 116 }
 117
 118 function sqsession_register ($var, $name) {
 119
 120     sqsession_is_active();
 121
 122     if ( !check_php_version(4,1) ) {
 123         global $HTTP_SESSION_VARS;
 124         $HTTP_SESSION_VARS[$name] = $var;
 125     }
 126     else {
 127         $_SESSION["$name"] = $var;
 128     }
 129     session_register("$name");
 130 }
 131
 132 function sqsession_unregister ($name) {
 133
 134     sqsession_is_active();
 135
 136     if ( !check_php_version(4,1) ) {
 137         global $HTTP_SESSION_VARS;
 138         unset($HTTP_SESSION_VARS[$name]);
 139     }
 140     else {
 141         unset($_SESSION[$name]);
 142     }
 143     session_unregister("$name");
 144 }
 145
 146 function sqsession_is_registered ($name) {
 147     $test_name = &$name;
 148     $result = false;
 149     if ( !check_php_version(4,1) ) {
 150         global $HTTP_SESSION_VARS;
 151         if (isset($HTTP_SESSION_VARS[$test_name])) {
 152             $result = true;
 153         }
 154     }
 155     else {
 156         if (isset($_SESSION[$test_name])) {
 157             $result = true;
 158         }
 159     }
 160     return $result;
 161 }
 162
 163
 164 define('SQ_INORDER',0);
 165 define('SQ_GET',1);
 166 define('SQ_POST',2);
 167 define('SQ_SESSION',3);
 168 define('SQ_COOKIE',4);
 169 define('SQ_SERVER',5);
 170
 171 /**
 172  * Search for the var $name in $_SESSION, $_POST, $_GET,
 173  * $_COOKIE, or $_SERVER and set it in provided var.
 174  *
 175  * If $search is not provided,  or == SQ_INORDER, it will search
 176  * $_SESSION, then $_POST, then $_GET. Otherwise,
 177  * use one of the defined constants to look for
 178  * a var in one place specifically.
 179  *
 180  * Note: $search is an int value equal to one of the
 181  * constants defined above.
 182  *
 183  * example:
 184  *    sqgetGlobalVar('username',$username,SQ_SESSION);
 185  *  -- no quotes around last param!
 186  *
 187  * Returns FALSE if variable is not found.
 188  * Returns TRUE if it is.
 189  */
 190 function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) {
 191
 192     if ( !check_php_version(4,1) ) {
 193         global $HTTP_COOKIE_VARS, $HTTP_GET_VARS, $HTTP_POST_VARS,
 194                $HTTP_SERVER_VARS, $HTTP_SESSION_VARS;
 195
 196         $_COOKIE  =& $HTTP_COOKIE_VARS;
 197         $_GET     =& $HTTP_GET_VARS;
 198         $_POST    =& $HTTP_POST_VARS;
 199         $_SERVER  =& $HTTP_SERVER_VARS;
 200         $_SESSION =& $HTTP_SESSION_VARS;
 201     }
 202
 203     /* NOTE: DO NOT enclose the constants in the switch
 204        statement with quotes. They are constant values,
 205        enclosing them in quotes will cause them to evaluate
 206        as strings. */
 207     switch ($search) {
 208         /* we want the default case to be first here,
 209            so that if a valid value isn't specified,
 210            all three arrays will be searched. */
 211       default:
 212       case SQ_INORDER:
 213       case SQ_SESSION:
 214         if( isset($_SESSION[$name]) ) {
 215             $value = $_SESSION[$name];
 216             return TRUE;
 217         } elseif ( $search == SQ_SESSION ) {
 218             break;
 219         }
 220       case SQ_POST:
 221         if( isset($_POST[$name]) ) {
 222             $value = $_POST[$name];
 223             return TRUE;
 224         } elseif ( $search == SQ_POST ) {
 225           break;
 226         }
 227       case SQ_GET:
 228         if ( isset($_GET[$name]) ) {
 229             $value = $_GET[$name];
 230             return TRUE;
 231         }
 232         /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
 233         break;
 234       case SQ_COOKIE:
 235         if ( isset($_COOKIE[$name]) ) {
 236             $value = $_COOKIE[$name];
 237             return TRUE;
 238         }
 239         break;
 240       case SQ_SERVER:
 241         if ( isset($_SERVER[$name]) ) {
 242             $value = $_SERVER[$name];
 243             return TRUE;
 244         }
 245         break;
 246     }
 247     return FALSE;
 248 }
 249
 250 function sqsession_destroy() {
 251
 252     /*
 253      * php.net says we can kill the cookie by setting just the name:
 254      * http://www.php.net/manual/en/function.setcookie.php
 255      * maybe this will help fix the session merging again.
 256      *
 257      * Changed the theory on this to kill the cookies first starting
 258      * a new session will provide a new session for all instances of
 259      * the browser, we don't want that, as that is what is causing the
 260      * merging of sessions.
 261      */
 262
 263     global $base_uri;
 264
 265     if (isset($_COOKIE[session_name()])) setcookie(session_name(), '', time() - 5, $base_uri);
 266     if (isset($_COOKIE['username'])) setcookie('username','',time() - 5,$base_uri);
 267     if (isset($_COOKIE['key'])) setcookie('key','',time() - 5,$base_uri);
 268
 269     $sessid = session_id();
 270     if (!empty( $sessid )) {
 271         if ( !check_php_version(4,1) ) {
 272             global $HTTP_SESSION_VARS;
 273             $HTTP_SESSION_VARS = array();
 274         } else {
 275             $_SESSION = array();
 276         }
 277         @session_destroy();
 278     }
 279
 280 }
 281
 282 /*
 283  * Function to verify a session has been started.  If it hasn't
 284  * start a session up.  php.net doesn't tell you that $_SESSION
 285  * (even though autoglobal), is not created unless a session is
 286  * started, unlike $_POST, $_GET and such
 287  */
 288
 289 function sqsession_is_active() {
 290
 291     $sessid = session_id();
 292     if ( empty( $sessid ) ) {
 293         session_start();
 294     }
 295 }
 296
 297
 298 ?>