Source for file session.php

Documentation is available at session.php

  1. <?php
  2. /**
  3.  * Session constants and tools
  4.  *
  5.  * @author    Jean-Philippe Brunon <jp75018@free.fr>
  6.  * @copyright    2007-2009 Jean-Philippe Brunon
  7.  * @license    http://www.opensource.org/licenses/gpl-license.php GPL
  8.  * @package    php-endurance
  9.  * @version    $Id: session.php 66 2009-03-26 10:39:25Z jp75018 $
  10.  */
  11.  
  12. /**
  13.  * General configuration file
  14.  */
  15. require_once ('conf/config.php');
  16.  
  17. /**
  18.  * Recursive delete mode : Remove only files (keep directory structure intact)
  19.  */
  20. define('DIR_REMOVE_FILE', 1);
  21. /**
  22.  * Recursive delete mode : Remove all except root directory
  23.  */
  24. define('DIR_REMOVE_SUBDIR', 2);
  25. /**
  26.  * Recursive delete mode : Remove all
  27.  */
  28. define('DIR_REMOVE_ALL', 3);
  29.  
  30. /**
  31.  * Session start
  32.  *
  33.  * Call instead of session_start() to start sessions.
  34.  * Cleanup temporary files
  35.  * ($GLOBALS['tmp_dir'] and $GLOBALS['upload_dir'] directories).
  36.  *
  37.  * @return      void 
  38.  */
  39. function plw_session_start()
  40. {
  41. // Set session timeout
  42.   @ini_set('session.gc_maxlifetime', $GLOBALS['session_gc_maxlifetime']);
  43.  
  44.   session_start();
  45.  
  46.   $ts = time();
  47.  
  48.   $lang = null;
  49.   if (isset($_POST['lang']))
  50.   { unset($_SESSION['lang']); }        // Language change
  51.   if (isset($_SESSION['lang']))
  52.   { $lang = $_SESSION['lang']; }    // Language already set in session
  53.   if ((! $lang) && isset($_POST['lang']))
  54.   {
  55.   // Case of language change
  56.     $lang = strtolower(substr($_POST['lang'], 0, 2));
  57.     if (! file_exists('lang/strings_' . $lang . '.inc.php'))
  58.     { $lang = null; }
  59.   }
  60.   if (! $lang)
  61.   {
  62.   // Language stored in cookie?
  63.     if ($_COOKIE['lang'])
  64.     { $lang = $_COOKIE['lang']; }
  65.   }
  66.   if (! $lang)
  67.   {
  68.   // If no language : Use browser language if supported, else use def language
  69.     if ($lang = get_browser_language($_SERVER['HTTP_ACCEPT_LANGUAGE']))
  70.     {
  71.       $lang = strtolower(substr($lang, 0, 2));    // Consider main language only
  72.       if (! file_exists('lang/strings_' . $lang . '.inc.php'))
  73.       { $lang = null; }
  74.     }
  75.   }
  76.   if (! $lang)
  77.   { $lang = $GLOBALS['def_lang']; }        // If still KO => Get default language
  78.   set_language($lang);
  79.  
  80. // Get browser width and height
  81.   if (is_numeric($_COOKIE['browser_width']))
  82.   { $_SESSION['browser_width'] = $_COOKIE['browser_width']; }
  83.   else
  84.   { unset($_SESSION['browser_width']); }
  85.  
  86. // Get preferences from cookies
  87.   $_SESSION['pref_display_width'] = $_COOKIE['pref_display_width'];
  88.  
  89. // Cleanup tmp and upload directories
  90.   if ((($_SESSION['http_count']+$ts) % 100) < $GLOBALS['garbage_collect_proba'])
  91.   {
  92.     $d = dir($GLOBALS['tmp_dir']);
  93.     while (($file = $d->read()) !== false)
  94.     {
  95.       if (($file == '.') || ($file == '..'))
  96.       { continue; }
  97.       if (! @is_dir($file))
  98.       {
  99.     if (($ts - @filemtime($GLOBALS['tmp_dir'] . $file)) >=
  100.       $GLOBALS['tmp_files_duration'])
  101.     { @unlink($GLOBALS['tmp_dir'] . $file); }
  102.       }
  103.     }
  104.     $d->close();
  105.  
  106.   // Cleanup all users upload directories (recursive)
  107.   // Do not remove 'upload' directory itself, even if empty
  108.     remove_dir_recursive($GLOBALS['upload_dir'],
  109.       $GLOBALS['upload_files_duration'], DIR_REMOVE_SUBDIR, $ts);
  110.   }
  111.  
  112. // Always cleanup user upload directory (recursive)
  113.   if ($_SESSION['my_user_id'])
  114.   {
  115.     remove_dir_recursive($GLOBALS['upload_dir'] .
  116.     str_pad($_SESSION['my_user_id'], 6, '0', STR_PAD_LEFT),
  117.       $GLOBALS['upload_files_duration'], DIR_REMOVE_ALL, $ts);
  118.   }
  119.  
  120.   $_SESSION['http_count']++;
  121. }
  122.  
  123. /**
  124.  * Get language from browser language string (take preferred language)
  125.  *
  126.  * @param       string    $browser_language Browser language string
  127.  * @return      string     Language ISO code : xx or xx-YY of preferred language
  128.  *             or null if no language found
  129.  */
  130. function get_browser_language($browser_language)
  131. {
  132.   if (! $browser_language)
  133.   { return null; }
  134.  
  135.   $lang_tab = explode(',', $browser_language);
  136.   $max_priority = 0;
  137.   $lang = null;
  138.   for ($i = 0; $i < count($lang_tab); $i++)
  139.   {
  140.     if (preg_match('/^\s*([^;\s]+)\s*(;\s*q\s*=\s*([0-9]*\.?[0-9]*))?\s*$/i',
  141.       $lang_tab[$i], $matches))
  142.     {
  143.       $priority = 1;
  144.       if ($matches[3])
  145.       { $priority = $matches[3]; }
  146.       if ($priority > $max_priority)
  147.       {
  148.     $lang = $matches[1];
  149.           $max_priority = $priority;
  150.       }
  151.     }
  152.   }
  153.  
  154.   return $lang;
  155. }
  156.  
  157. /**
  158.  * Set language in session
  159.  *
  160.  * @param       string  $lang Language to set (2 letters ISO code)
  161.  * @return      void 
  162.  */
  163. function set_language($lang)
  164. {
  165.   if ($lang && ($lang != $_SESSION['lang']))
  166.   { require_once ('lang/strings_' . $lang . '.inc.php'); }
  167.   $_SESSION['lang'] = $lang;
  168.   $GLOBALS['lang'] = $lang;
  169. }
  170.  
  171. /**
  172.  * Get total size of files in a directory (recursively or not)
  173.  *
  174.  * Note : Each file size is rounded up assuming default block size.
  175.  *
  176.  * @param       string    $dir_name Directory name (relative to site root)
  177.  * @param       string  $recur true to consider subdirectories, else false
  178.  * @return      integer Cumulated size in bytes, 0 on error
  179.  */
  180. function dir_size_recursive($dir_name, $recur = true)
  181. {
  182.   $cum_size = 0;
  183.  
  184.   $dir_handler = @dir($dir_name);
  185.   if (! $dir_handler)
  186.   { return 0; }
  187.  
  188.   while (($entry = $dir_handler->read()) !== false)
  189.   {
  190.     if (($entry == '.') || ($entry == '..') || ($entry == '.svn'))
  191.     { continue; }
  192.  
  193.     $entry = $dir_name . '/' . $entry;
  194.     $file_stat = @stat($entry);
  195.     if (is_array($file_stat))
  196.     {
  197.       $file_size = $file_stat['size'] + ($file_size ? 0 : 1);
  198.       $cum_size += $GLOBALS['fs_block_size'] *
  199.     ceil($file_size / $GLOBALS['fs_block_size']);
  200.     }
  201.  
  202.     if (@is_dir($entry))
  203.     { $cum_size += dir_size_recursive($entry, $recur); }
  204.   }
  205.  
  206.   $dir_handler->close();
  207.  
  208.   return $cum_size;
  209. }
  210.  
  211. /**
  212.  * Recursive delete a directory
  213.  *
  214.  * Remove subdirs / dir only if all files in subdirs / dir are removed.
  215.  *
  216.  * @param       string  $dir_name Directory name (relative to site root)
  217.  * @param       integer $age Remove only files modified more than <age>
  218.  *             seconds ago (all if = 0)
  219.  * @param       string  $mode Delete mode (see DIR_REMOVE_*)
  220.  * @param       integer $ts Current timestamp. Do not use, avoid calling time().
  221.  * @return      boolean true if directory was removed, else false.
  222.  */
  223. function remove_dir_recursive($dir_name,
  224.   $age = 0, $mode = DIR_REMOVE_SUBDIR, $ts = null)
  225. {
  226.   $dir_handler = @dir($dir_name);
  227.   if (! $dir_handler)
  228.   { return false; }
  229.  
  230.   if (! $ts)
  231.   { $ts = time(); }
  232.  
  233.   $entry_nb = 0;
  234.   $del_nb = 0;
  235.   while (($entry = $dir_handler->read()) !== false)
  236.   {
  237.     if (($entry == '.') || ($entry == '..') || ($entry == '.svn'))
  238.     { continue; }
  239.  
  240.     $entry_nb++;
  241.     $entry = $dir_name . '/' . $entry;
  242.     if (@is_dir($entry))
  243.     {
  244.       if (remove_dir_recursive($entry, $age,
  245.     ($mode == DIR_REMOVE_FILE) ? DIR_REMOVE_FILE : DIR_REMOVE_ALL, $ts))
  246.       { $del_nb++; }
  247.     }
  248.     else
  249.     {
  250.       $file_stat = @stat($entry);
  251.       if (is_array($file_stat))
  252.       {
  253.     $file_age = $ts - $file_stat['mtime'];
  254.     if ($file_age >= $age)
  255.     {
  256.       if (@unlink($entry))
  257.       { $del_nb++; }
  258.     }
  259.       }
  260.     }
  261.   }
  262.   $dir_handler->close();
  263.  
  264. // Remove directory if empty
  265.   $ret_value = false;
  266.   if ($mode == DIR_REMOVE_ALL)
  267.   {
  268.     if ($entry_nb == $del_nb)
  269.     {
  270.       if (@rmdir($dir_name))
  271.       { $ret_value = true; }
  272.     }
  273.   }
  274.  
  275.   return $ret_value;
  276. }
  277.  
  278. /**
  279.  * Start timer to measure performance
  280.  *
  281.  * @return      float   Unix timestamp in microseconds.
  282.  */
  283. function timer_start()
  284. {
  285.   list($usec, $sec) = explode(" ", microtime());
  286.  
  287.   return ((float)$usec + (float)$sec);
  288. }
  289.  
  290. /**
  291.  * Stop timer to measure performance
  292.  *
  293.  * @param       float   $start Timestamp returned by timer_start().
  294.  * @return      float   Elapsed real time in microseconds between timer_start()
  295.  *             and timer_stop().
  296.  */
  297. function timer_stop($start)
  298. {
  299.   return round(1000000 * (timer_start() - $start));
  300. }

Documentation generated on Sat, 28 Mar 2009 23:17:13 +0000 by phpDocumentor 1.4.1