File Source for xt_sessionscope.class.php

<?php /*
*@=@=@=@ START LICENSE @=@=@=@*
Copyright or © or Copr. Stéphane TRICHET and Nicolas SOTRON
stephane.t@simpliciweb.net and nicolas.s@simpliciweb.net
This software is a computer program whose purpose is to make a
web hosting platform
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*@=@=@=@ END LICENSE @=@=@=@*
*/?><?php
/**
* xTSessionScope Class
*
*
* @author SimpliciWeb
* @version $Id: xt_sessionscope.class.php 602 2007-07-18 16:18:38Z stephanet $
* @package Common
* @subpackage FrameWork
*/
/**
* Manage a session scope with PHP session and database for security
*
* @author SimpliciWeb
* @version $Id: xt_sessionscope.class.php 602 2007-07-18 16:18:38Z stephanet $
* @package Common
* @subpackage FrameWork
*/
class xTSessionScope {
/**
* IS existin session
*
* @var bool
*/
var $m_is_existing_session = null;
/**
* Session id
*
* @var string
*/
var $m_session_id = NULL;
/**
* Database Connexion object
*
* @var DbConnexion
*/
var $m_object_dbconnexion = null;
/**
* Format Object
*
* @var Format
*/
var $m_object_format = null;
/**
* SQL Request : Update
*
* @var string
*/
var $req_update = "update t_session set ses_modified=now()
where ses_id = '%s';";
/**
* SQL Request : Insert
*
* @var string
*/
var $req_insert = "insert into t_session(ses_id,ses_created,ses_modified)
values('%s',now(), now());";
/**
* SQL Request : exist
*
* @var string
*/
var $req_exist = "select ses_id from t_session
where ses_id = '%s';";
/**
* SQL Request : Delete
*
* @var string
*/
var $req_delete = "delete from t_session
where DATE_ADD(ses_modified, INTERVAL %d MINUTE) < NOW();";
/**
* Time cookie life
*
* @var integer
*/
var $m_time_cookie_life = 0;//2678400; //3600*24*31; 1 mois
/**
* Session life time
*
* @var integer
*/
var $m_session_life_time_min = 30; // temps de vie d'une session en minutes
/**
* Must be destroyed
*
* @var bool
*/
var $m_must_be_destroyed ;
/**
* Session name
*
* @var string
*/
var $m_session_name ;
/**
*
*
* @var string
*/
var $test ;
/**
* Constructor, init the requests and objects. And attempt to load a session
*
* @param string $p_session_name
* @return xTSessionScope
*/
function xTSessionScope($p_session_name) {
global $g_object_loader;
$this->m_object_format =& $g_object_loader->getFormat();
$this->m_object_dbconnexion =& $g_object_loader->getDbConnexion();
$this->m_session_name = $p_session_name;
$this->test = $this->generateUniqueId();
session_cache_expire($this->m_session_life_time_min);
if ($this->m_time_cookie_life != 0)
session_set_cookie_params($this->m_time_cookie_life);
session_name($this->m_session_name);
//echo(" INIT Session");
$this->xLoadSession();
}
/**
* Force destroy
*
*/
function forceDestroy() {
$this->m_must_be_destroyed = true;
}
/**
* Get database id for the session id
*
* @param string $p_id
* @return string
*/
function getDatabaseId($p_id = "") {
if ($p_id == "")
$p_id = $this->m_session_id;
return $this->m_session_name."_".$p_id;
}
/**
* Destroy if needed (if exist)
*
*/
function destroyIfNeeded() {
//if ($this->m_must_be_destroyed)
//echo(" must be destruct");
//else
if ($this->m_must_be_destroyed) {
@session_unset();
if (session_id() <> '')
@session_destroy();
$this->m_is_existing_session = false;
$this->m_must_be_destroyed = false;
$this->m_session_id = "";
//echo($this->m_session_name);
//$_COOKIES[$this->m_session_name] = "";
// session_set_cookie_params (time() - 3600);
//@setcookie($this->m_session_name, '', time() - 3600);
}
}
/*function mustBeDestroyedDebuger() {
if ($this->m_must_be_destroyed)
echo(" must be destruct");
else
echo(" must NOT be destruct");
}*/
/**
* unset
*
* @access private
* @param string $p_name
*/
function xUnset($p_name) {
$_SESSION[$p_name] = '';
unset($_SESSION[$p_name]);
if (sizeof($_SESSION) == 0) {
$this->forceDestroy();
}
}
/**
* load session
*
* @access private
* @param bool $p_force_to_load
*/
function xLoadSession($p_force_to_load = false) {
$len_of_php_self = strlen($_SERVER['PHP_SELF']);
if (((substr($_SERVER['PHP_SELF'], $len_of_php_self - 3) == ".js")) ||
(substr($_SERVER['PHP_SELF'], $len_of_php_self - 4) == ".css")) {
return;
}
if ($this->m_is_existing_session)
return;
if (!isset($_COOKIE[$this->m_session_name]) &&
!isset($_REQUEST[$this->m_session_name]) &&
$p_force_to_load == false) {
$this->m_session_id = '';
$this->m_must_be_destroyed = false;
$this->m_is_existing_session = false;
return ;
}
@session_start();
//echo(" run real or not Session");
$this->xExist(session_id(), $is_existing_session);
$this->m_is_existing_session = $is_existing_session;
if (!$is_existing_session && !$p_force_to_load) {
$this->m_must_be_destroyed = true;
$this->m_session_id = "";
//echo(" set to not real :".session_id());
} else if (!$is_existing_session && $p_force_to_load) {
$this->m_is_existing_session = true;
$this->m_must_be_destroyed = false;
$this->m_session_id = session_id();
$this->xInsert($this->m_session_id);
//echo(" is creating");
} else {
$this->m_session_id = session_id();
$this->xUpdate($this->m_session_id);
$this->m_must_be_destroyed = false;
//echo(" is real");
}
/*
echo(" end default loading");
if ($this->m_must_be_destroyed)
echo(" must be destruct");
else
echo(" must NOT be destruct");
*/
}
/**
* Force to load a session
*
* @return unknown
*/
function forceToLoad() {
$this->xForceToLoad();
}
/**
* Force to load
*
* @access private
*/
function xForceToLoad() {
if (!$this->m_is_existing_session) {
$this->xLoadSession(true);
}
}
/**
* Force to clean in database
*
*/
function forceCleanning() {
$this->xClean();
}
/**
* Generate unique id : max of 35 charater generated
*
* @return string
*/
function generateUniqueId() {
return md5(uniqid(rand(), true));
}
/**
* Is not valid id
*
* @param string $p_value
* @return bool TRUE on error
*/
function isNotValidId($p_value) {
return $this->m_object_format->isNotVarchar($p_value, 45);
}
/**
* Insert
*
* @access private
* @param string $p_id
* @return bool TRUE on error
*/
function xInsert($p_id) {
if ($this->isNotValidId($p_id)) {
return onErrorThrow(true,plici_lang("lang_error_field"));
}
// on clean les sessions obsolètes
$this->xClean();
// preparation des paramètres
$parameters = array();
$parameters[sizeof($parameters)] = $this->getDatabaseId($p_id);
if ($this->m_object_dbconnexion->makeSqlQuery($this->req_insert, $parameters, $result)) {
return onErrorThrow(true,plici_lang("lang_error_addingsession"));
}
return false;
}
/**
* Clean the session
*
* @access private
* @return bool TRUE on error
*/
function xClean() {
// preparation des paramètres
$parameters = array();
$parameters[sizeof($parameters)] = session_cache_expire()+1;
if ($this->m_object_dbconnexion->makeSqlQuery($this->req_delete, $parameters, $result)) {
return onErrorThrow(true,plici_lang("lang_error_cleanningsession"));
}
return false;
}
/**
* update
*
* @param string $p_id
* @return bool TRUE on error
*/
function xUpdate($p_id) {
if ($this->isNotValidId($p_id)) {
return onErrorThrow(true,plici_lang("lang_error_field"));
}
// preparation des paramètres
$parameters = array();
$parameters[sizeof($parameters)] = $this->getDatabaseId($p_id);
if ($this->m_object_dbconnexion->makeSqlQuery($this->req_update, $parameters, $result)) {
return onErrorThrow(true,plici_lang("lang_error_sessionupdate"));
}
return false;
}
/**
* Test if exist session
*
* @access private
* @param string $p_id
* @param bool $r_bool_is_existing
* @return bool TRUE on error
*/
function xExist($p_id, &$r_bool_is_existing) {
$r_bool_is_existing = false;
if ($this->isNotValidId($p_id)) {
return onErrorThrow(true,plici_lang("lang_error_field"));
}
// preparation des paramètres
$parameters = array();
$parameters[sizeof($parameters)] = $this->getDatabaseId($p_id);
if ($this->m_object_dbconnexion->makeSqlQuery($this->req_exist, $parameters, $result)) {
return onErrorThrow(true,plici_lang("lang_error_sessionupdate"));
}
while ($row = mysql_fetch_row($result)) {
$r_bool_is_existing = true;
}
return false;
}
}
?>

Documentation generated on Tue, 25 Mar 2008 15:37:38 +0100 by phpDocumentor 1.3.2

Source for file xt_sessionscope.class.php