Source for file global.php

Documentation is available at global.php

  1. <?php
  2.  
  3. /**
  4.  * global.php
  5.  *
  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
  8.  * php versions.
  9.  *
  10.  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  11.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  12.  * @version $Id: global.php,v 1.27.2.19 2006/07/29 08:57:52 tokul Exp $
  13.  * @package squirrelmail
  14.  */
  15.  
  16. /**
  17.  * Set constants
  18.  */
  19. define('SQ_INORDER',0);
  20. define('SQ_GET',1);
  21. define('SQ_POST',2);
  22. define('SQ_SESSION',3);
  23. define('SQ_COOKIE',4);
  24. define('SQ_SERVER',5);
  25. define('SQ_FORM',6);
  26.  
  27. /** First code that should be executed before other files are loaded */
  28.  
  29. /**
  30.  * Must be executed before any other scripts are loaded.
  31.  *
  32.  * If register_globals are on, unregister globals.
  33.  * Second test covers boolean set as string (php_value register_globals off).
  34.  */
  35. if ((bool) ini_get('register_globals') &&
  36.     strtolower(ini_get('register_globals'))!='off') {
  37.     /**
  38.      * Remove all globals that are not reserved by PHP
  39.      * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
  40.      */
  41.     foreach ($GLOBALS as $key => $value) {
  42.         switch($key) {
  43.         case 'HTTP_POST_VARS':
  44.         case '_POST':
  45.         case 'HTTP_GET_VARS':
  46.         case '_GET':
  47.         case 'HTTP_COOKIE_VARS':
  48.         case '_COOKIE':
  49.         case 'HTTP_SERVER_VARS':
  50.         case '_SERVER':
  51.         case 'HTTP_ENV_VARS':
  52.         case '_ENV':
  53.         case 'HTTP_POST_FILES':
  54.         case '_FILES':
  55.         case '_REQUEST':
  56.         case 'HTTP_SESSION_VARS':
  57.         case '_SESSION':
  58.         case 'GLOBALS':
  59.         case 'key':
  60.         case 'value':
  61.             break;
  62.         default:
  63.             unset($GLOBALS[$key]);
  64.         }
  65.     }
  66.     // Unset variables used in foreach
  67.         unset($GLOBALS['key']);
  68.     unset($GLOBALS['value']);
  69. }
  70.  
  71. /*
  72.  * strip any tags added to the url from PHP_SELF.
  73.  * This fixes hand crafted url XXS expoits for any
  74.  * page that uses PHP_SELF as the FORM action
  75.  * Must be executed before strings.php is loaded (php_self() call in strings.php).
  76.  */
  77. if (isset($_SERVER['PHP_SELF'])) {
  78.     // php 4.1+
  79.         $_SERVER['PHP_SELF'] = strip_tags($_SERVER['PHP_SELF']);
  80. } elseif (isset($HTTP_SERVER_VARS['PHP_SELF'])) {
  81.     // php 4.0.6
  82.         $HTTP_SERVER_VARS['PHP_SELF'] = strip_tags($HTTP_SERVER_VARS['PHP_SELF']);
  83. }
  84.  
  85. /**
  86.  * Bring in the config file
  87.  * We need $session_name
  88.  * config.php $version depends on strings.php.
  89.  * strings.php sets $PHP_SELF.
  90.  */
  91. require_once(SM_PATH . 'functions/strings.php');
  92. require_once(SM_PATH . 'config/config.php');
  93.  
  94. /** set the name of the session cookie */
  95. if(isset($session_name) && $session_name) {
  96.     ini_set('session.name' , $session_name);
  97. } else {
  98.     ini_set('session.name' , 'SQMSESSID');
  99. }
  100.  
  101. /**
  102.  * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
  103.  * Force magic_quotes_runtime off.
  104.  * [email protected] - I put it here in the hopes that all SM code includes this.
  105.  * If there's a better place, please let me know.
  106.  */
  107. ini_set('magic_quotes_runtime','0');
  108.  
  109. /**
  110.  * [#1518885] session.use_cookies = off breaks SquirrelMail
  111.  *
  112.  * When session cookies are not used, all http redirects, meta refreshes,
  113.  * src/download.php and javascript URLs are broken. Setting must be set
  114.  * before session is started.
  115.  */
  116. if (!(bool)ini_get('session.use_cookies') ||
  117.     ini_get('session.use_cookies') == 'off') {
  118.     ini_set('session.use_cookies','1');
  119. }
  120.  
  121. /* convert old-style superglobals to current method
  122.  * this is executed if you are running PHP 4.0.x.
  123.  * it is run via a require_once directive in validate.php
  124.  * and redirect.php. Patch submitted by Ray Black.
  125.  */
  126. sqsession_is_active();
  127. if ( !check_php_version(4,1) ) {
  128.   global $_COOKIE, $_ENV, $_FILES, $_GET, $_POST, $_SERVER, $_SESSION;
  129.   global $HTTP_COOKIE_VARS, $HTTP_ENV_VARS, $HTTP_POST_FILES, $HTTP_GET_VARS,
  130.          $HTTP_POST_VARS, $HTTP_SERVER_VARS, $HTTP_SESSION_VARS, $PHP_SELF;
  131.   $_COOKIE  =& $HTTP_COOKIE_VARS;
  132.   $_ENV     =& $HTTP_ENV_VARS;
  133.   $_FILES   =& $HTTP_POST_FILES;
  134.   $_GET     =& $HTTP_GET_VARS;
  135.   $_POST    =& $HTTP_POST_VARS;
  136.   $_SERVER  =& $HTTP_SERVER_VARS;
  137.   $_SESSION =& $HTTP_SESSION_VARS;
  138.   if (!isset($PHP_SELF) || empty($PHP_SELF)) {
  139.      $PHP_SELF =  $HTTP_SERVER_VARS['PHP_SELF'];
  140.   }
  141. }
  142.  
  143. /* if running with magic_quotes_gpc then strip the slashes
  144.    from POST and GET global arrays */
  145.  
  146. if (get_magic_quotes_gpc()) {
  147.     sqstripslashes($_GET);
  148.     sqstripslashes($_POST);
  149. }
  150.  
  151. /**
  152.  * returns true if current php version is at mimimum a.b.c
  153.  *
  154.  * Called: check_php_version(4,1)
  155.  * @param int a major version number
  156.  * @param int b minor version number
  157.  * @param int c release number
  158.  * @return bool 
  159.  */
  160. function check_php_version ($a = '0', $b = '0', $c = '0')
  161. {
  162.     global $SQ_PHP_VERSION;
  163.  
  164.     if(!isset($SQ_PHP_VERSION))
  165.         $SQ_PHP_VERSION = substr( str_pad( preg_replace('/\D/','', PHP_VERSION), 3, '0'), 0, 3);
  166.  
  167.     return $SQ_PHP_VERSION >= ($a.$b.$c);
  168. }
  169.  
  170. /**
  171.  * returns true if the current internal SM version is at minimum a.b.c
  172.  * These are plain integer comparisons, as our internal version is
  173.  * constructed by us, as an array of 3 ints.
  174.  *
  175.  * Called: check_sm_version(1,3,3)
  176.  * @param int a major version number
  177.  * @param int b minor version number
  178.  * @param int c release number
  179.  * @return bool 
  180.  */
  181. function check_sm_version($a = 0, $b = 0, $c = 0)
  182. {
  183.     global $SQM_INTERNAL_VERSION;
  184.     if ( !isset($SQM_INTERNAL_VERSION) ||
  185.          $SQM_INTERNAL_VERSION[0] < $a ||
  186.          ( $SQM_INTERNAL_VERSION[0] == $a &&
  187.            $SQM_INTERNAL_VERSION[1] < $b) ||
  188.          ( $SQM_INTERNAL_VERSION[0] == $a &&
  189.            $SQM_INTERNAL_VERSION[1] == $b &&
  190.            $SQM_INTERNAL_VERSION[2] < $c ) ) {
  191.         return FALSE;
  192.     }
  193.     return TRUE;
  194. }
  195.  
  196.  
  197. /**
  198.  * Recursively strip slashes from the values of an array.
  199.  * @param array array the array to strip, passed by reference
  200.  * @return void 
  201.  */
  202. function sqstripslashes(&$array) {
  203.     if(count($array) > 0) {
  204.         foreach ($array as $index=>$value) {
  205.             if (is_array($array[$index])) {
  206.                 sqstripslashes($array[$index]);
  207.             }
  208.             else {
  209.                 $array[$index] = stripslashes($value);
  210.             }
  211.         }
  212.     }
  213. }
  214.  
  215. /**
  216.  * Add a variable to the session.
  217.  * @param mixed $var the variable to register
  218.  * @param string $name the name to refer to this variable
  219.  * @return void 
  220.  */
  221. function sqsession_register ($var, $name) {
  222.  
  223.     sqsession_is_active();
  224.  
  225.     if ( !check_php_version(4,1) ) {
  226.         global $HTTP_SESSION_VARS;
  227.         $HTTP_SESSION_VARS[$name] = $var;
  228.     } else {
  229.         $_SESSION["$name"] = $var;
  230.     }
  231.     session_register("$name");
  232. }
  233.  
  234. /**
  235.  * Delete a variable from the session.
  236.  * @param string $name the name of the var to delete
  237.  * @return void 
  238.  */
  239. function sqsession_unregister ($name) {
  240.  
  241.     sqsession_is_active();
  242.  
  243.     if ( !check_php_version(4,1) ) {
  244.         global $HTTP_SESSION_VARS;
  245.         unset($HTTP_SESSION_VARS[$name]);
  246.     } else {
  247.         unset($_SESSION[$name]);
  248.     }
  249.     session_unregister("$name");
  250. }
  251.  
  252. /**
  253.  * Checks to see if a variable has already been registered
  254.  * in the session.
  255.  * @param string $name the name of the var to check
  256.  * @return bool whether the var has been registered
  257.  */
  258. function sqsession_is_registered ($name) {
  259.     $test_name = &$name;
  260.     $result = false;
  261.     if ( !check_php_version(4,1) ) {
  262.         global $HTTP_SESSION_VARS;
  263.         if (isset($HTTP_SESSION_VARS[$test_name])) {
  264.             $result = true;
  265.         }
  266.     } else {
  267.         if (isset($_SESSION[$test_name])) {
  268.             $result = true;
  269.         }
  270.     }
  271.  
  272.     return $result;
  273. }
  274.  
  275. /**
  276.  * Search for the var $name in $_SESSION, $_POST, $_GET,
  277.  * $_COOKIE, or $_SERVER and set it in provided var.
  278.  *
  279.  * If $search is not provided,  or == SQ_INORDER, it will search
  280.  * $_SESSION, then $_POST, then $_GET. Otherwise,
  281.  * use one of the defined constants to look for
  282.  * a var in one place specifically.
  283.  *
  284.  * Note: $search is an int value equal to one of the
  285.  * constants defined above.
  286.  *
  287.  * example:
  288.  *    sqgetGlobalVar('username',$username,SQ_SESSION);
  289.  *  -- no quotes around last param!
  290.  *
  291.  * @param string name the name of the var to search
  292.  * @param mixed value the variable to return
  293.  * @param int search constant defining where to look
  294.  * @return bool whether variable is found.
  295.  */
  296. function sqgetGlobalVar($name, &$value, $search = SQ_INORDER) {
  297.  
  298.     if ( !check_php_version(4,1) ) {
  299.         global $HTTP_COOKIE_VARS, $HTTP_GET_VARS, $HTTP_POST_VARS,
  300.                $HTTP_SERVER_VARS, $HTTP_SESSION_VARS;
  301.  
  302.         $_COOKIE  =& $HTTP_COOKIE_VARS;
  303.         $_GET     =& $HTTP_GET_VARS;
  304.         $_POST    =& $HTTP_POST_VARS;
  305.         $_SERVER  =& $HTTP_SERVER_VARS;
  306.         $_SESSION =& $HTTP_SESSION_VARS;
  307.     }
  308.  
  309.     /* NOTE: DO NOT enclose the constants in the switch
  310.        statement with quotes. They are constant values,
  311.        enclosing them in quotes will cause them to evaluate
  312.        as strings. */
  313.     switch ($search) {
  314.         /* we want the default case to be first here,
  315.            so that if a valid value isn't specified,
  316.            all three arrays will be searched. */
  317.       default:
  318.       case SQ_INORDER: // check session, post, get
  319.       case SQ_SESSION:
  320.         if( isset($_SESSION[$name]) ) {
  321.             $value = $_SESSION[$name];
  322.             return TRUE;
  323.         } elseif ( $search == SQ_SESSION ) {
  324.             break;
  325.         }
  326.       case SQ_FORM:   // check post, get
  327.       case SQ_POST:
  328.         if( isset($_POST[$name]) ) {
  329.             $value = $_POST[$name];
  330.             return TRUE;
  331.         } elseif ( $search == SQ_POST ) {
  332.           break;
  333.         }
  334.       case SQ_GET:
  335.         if ( isset($_GET[$name]) ) {
  336.             $value = $_GET[$name];
  337.             return TRUE;
  338.         }
  339.         /* NO IF HERE. FOR SQ_INORDER CASE, EXIT after GET */
  340.         break;
  341.       case SQ_COOKIE:
  342.         if ( isset($_COOKIE[$name]) ) {
  343.             $value = $_COOKIE[$name];
  344.             return TRUE;
  345.         }
  346.         break;
  347.       case SQ_SERVER:
  348.         if ( isset($_SERVER[$name]) ) {
  349.             $value = $_SERVER[$name];
  350.             return TRUE;
  351.         }
  352.         break;
  353.     }
  354.     /* if not found, return false */
  355.     return FALSE;
  356. }
  357.  
  358. /**
  359.  * Deletes an existing session, more advanced than the standard PHP
  360.  * session_destroy(), it explicitly deletes the cookies and global vars.
  361.  */
  362. function sqsession_destroy() {
  363.  
  364.     /*
  365.      * php.net says we can kill the cookie by setting just the name:
  366.      * http://www.php.net/manual/en/function.setcookie.php
  367.      * maybe this will help fix the session merging again.
  368.      *
  369.      * Changed the theory on this to kill the cookies first starting
  370.      * a new session will provide a new session for all instances of
  371.      * the browser, we don't want that, as that is what is causing the
  372.      * merging of sessions.
  373.      */
  374.  
  375.     global $base_uri;
  376.  
  377.     if (isset($_COOKIE[session_name()])) setcookie(session_name(), '', 0, $base_uri);
  378.     if (isset($_COOKIE['username'])) setcookie('username', '', 0, $base_uri);
  379.     if (isset($_COOKIE['key'])) setcookie('key', '', 0, $base_uri);
  380.  
  381.     $sessid = session_id();
  382.     if (!empty( $sessid )) {
  383.         if ( !check_php_version(4,1) ) {
  384.             global $HTTP_SESSION_VARS;
  385.             $HTTP_SESSION_VARS = array();
  386.         } else {
  387.             $_SESSION = array();
  388.         }
  389.         @session_destroy();
  390.     }
  391.  
  392. }
  393.  
  394. /**
  395.  * Function to verify a session has been started.  If it hasn't
  396.  * start a session up.  php.net doesn't tell you that $_SESSION
  397.  * (even though autoglobal), is not created unless a session is
  398.  * started, unlike $_POST, $_GET and such
  399.  */
  400.  
  401. function sqsession_is_active() {
  402.  
  403.     $sessid = session_id();
  404.     if ( empty( $sessid ) ) {
  405.         session_start();
  406.     }
  407. }
  408.  
  409. // vim: et ts=4
  410. ?>

Documentation generated on Sat, 07 Oct 2006 16:31:26 +0300 by phpDocumentor 1.3.0RC6