File Source for OCSP_SESSION.phpclass

<?php
/**
* session class it is planed to add different session types
* therefore this class is already implemented but uses standard php session
* for the moment
*
* @project Open CSP-Management
* @package common
* @category session
*
* @author Peter Krebs (pk)<pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-07-31
* @version $Id: OCSP_SESSION.phpclass,v 1.9 2008/11/19 07:40:07 pitlinz Exp $
*/
/**
* Session Error Class
*
* @project Open CSP-Management
* @package common
* @category session
*
* @author Peter Krebs (pk)<pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-08-24
*/
class OCSP_SESSION_ERROR {
/** -----------------------------------------------------
* Compositions:
*/
/**
* @var OCSP_SESSION $mySession
* @access public
*/
var $mySession=NULL;
/** -----------------------------------------------------
* Attributes:
*/
/**
* @var string $errMsg
* @access public
*/
var $errMsg="";
/**
*
* METHODS _____________________________________________
*
*/
/**
* @param OCSP_SESSION $aSession
* @param string $errMsg
*/
function __construct(&$aSession,$aMsg)
{
$this->mySession=&$aSession;
$this->errMsg=$aMsg;
}
}
/**
* Session Class
*
* @project Open CSP-Management
* @package common
* @category session
*
* @author Peter Krebs (pk)<pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-07-31
* @version pk-08-03-14 singleton
*
* @version $Id: OCSP_SESSION.phpclass,v 1.9 2008/11/19 07:40:07 pitlinz Exp $
*/
class OCSP_SESSION {
/*** class variables --------------------------------------------- */
/**
* @staticvar OCSP_SESSION $instance
*/
private static $instance=NULL;
/**
* @staticvar string $myName
*/
protected static $myName="";
/** -----------------------------------------------------
* Aggregations:
*/
/** -----------------------------------------------------
* Compositions:
*/
/** -----------------------------------------------------
* Attributes:
*/
/**
* @var array $mySessionVals
* @access protected
*/
protected $mySessionVals=array();
/**
* @var boolean $isOpened
* @access protected
*/
protected $isOpened=false;
/**
* @var boolean $isWritten
* @access protected
*/
protected $isWritten=false;
/**
* @var boolean $hasChanged
* @access protected
*/
protected $hasChanged=false;
/**
*
* METHODS _____________________________________________
*
*/
// --------------------------------------------------------------
// static method
// --------------------------------------------------------------
/**
* @param mixed $aValue
*
* @return boolean
*/
public static function isSessionError(&$aValue)
{
return pcf_is_instance_of($aValue,'OCSP_SESSION_ERROR');
}
// --------------------------------------------------------------
// Constructors and descructors
// --------------------------------------------------------------
/**
* constructor
*/
protected function __construct()
{
if (empty(self::$myName))
{
if(($str_name = ini_get('session.name')) && !empty($str_name)) {
self::$myName = ini_get('session.name');
} else {
self::$myName = 'OCSP_SES';
}
}
}
/**
* save session on descruct
*/
function __destruct()
{
if ($this->isOpened()) {
$this->closeSession();
}
}
// --------------------------------------------------------------
// static instance functions
// --------------------------------------------------------------
/**
* returns the session object
*
* @param boolean $open (open the session?)
*
* @return OCSP_SESSION
*/
public static function getInstance($open=false)
{
if (!self::$instance)
{
self::$instance = new OCSP_SESSION();
}
if ($open && (!self::$instance->isOpened()))
{
self::$instance->openSession();
if (!self::$instance->isOpened())
{
throw new Exception(_OCSP_SESSION_ERROR_. ": COULD NOT OPEN SESSION");
}
}
return self::$instance;
}
/**
* returns if we already have an instance
*
* @return boolean
*
* @since pk-08-03-14
*/
public static function hasInstance()
{
if (self::$instance)
{
return true;
} else {
return false;
}
}
// --------------------------------------------------
// open/close
// --------------------------------------------------
/**
* starts the session
* @param string $aName
* @param boolean $debug
*
* @return boolean
*/
function openSession()
{
if (!defined('__OCSP_SESSION_'.$this->getName().'__')) {
session_start();
$this->isOpened=true;
define('__OCSP_SESSION_'.$this->getName().'__',TRUE);
}
return $this->isOpened();
}
/**
* closes a session and writes the data
*/
function closeSession()
{
session_write_close();
$this->isOpened =false;
$this->isWritten=true;
}
// --------------------------------------------------------------
// getter setter
// --------------------------------------------------------------
/**
* @return boolean;
*/
function isOpened()
{
return $this->isOpened;
}
/**
* @return boolean
*/
function hasChanged()
{
return $this->hasChanged;
}
/**
* @return string
*/
function getName()
{
return self::$myName;
}
/**
* @return string
*/
function getId()
{
return session_id();
}
// --------------------------------------------------------------
// values
// --------------------------------------------------------------
/**
* @param string $aVarName
* @param boolean $debug
*
* @return mixed
*/
function getValue($aVarName,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_SESSION::getValue($aVarName)");
if (empty($aVarName)) return NULL;
if (!$this->isOpened() && !$this->openSession())
{
return new OCSP_SESSION_ERROR($this,"session could not be opened");
}
if (isset($this->mySessionVals[$aVarName]))
{
return $this->mySessionVals[$aVarName];
}
if (isset($_SESSION[$aVarName]))
{
return $_SESSION[$aVarName];
}
return Null;
}
/**
* sets a session var value
*
* @param string $aVarName
* @param mixed $aValue
* @param boolean $debug
*
* @return mixed (TRUE in case of no error else an OCSP_SESSION_ERROR object)
*/
function setValue($aVarName,$aValue,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_SESSION::setValue($aVarName)");
if (!$this->isOpened() && !$this->openSession())
{
return new OCSP_SESSION_ERROR($this,"session could not be opened");
}
if ($this->isWritten)
{
throw new Exception(_OCSP_SESSION_ERROR_ . ': SESSION ALREADY WRITTEN');
}
$oldValue=$this->getValue($aVarName);
if ($oldValue != $aValue)
{
$this->mySessionVals[$aVarName]=$aValue;
$_SESSION[$aVarName]=$aValue;
$this->hasChanged=True;
}
return True;
}
/**
* sets a session value which is not set
*
* if $aVarName is already set in the session nothing is done
* and False returned
*
* @param string $aVarName
* @param string $aValue
* @param boolean $debug
*
* @return boolean if the value has changed
*
* @since pk-08-06-11
*/
public function setDefaultValue($aVarName,$aValue,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_SESSION::setDefaultValue(".$aVarName.")");
$mix_sessValue = $this->getValue($aVarName);
if (!empty($mix_sessValue) && ($mix_sessValue !== Null))
{
return False;
}
return $this->setValue($aVarName,$aValue,$debug);
}
/**
* @param string $aVarName
* @param boolean $debug
*/
function unsetValue($aVarName,$debug=False)
{
if (!$this->isOpened() && !$this->openSession())
{
return new OCSP_SESSION_ERROR($this,"session could not be opened");
}
if ($this->isWritten)
{
throw new Exception(_OCSP_SESSION_ERROR_ . ': SESSION ALREADY WRITTEN');
}
if (isset($this->mySessionVals[$aVarName]))
{
$this->hasChanged=TRUE;
unset($this->mySessionVals);
}
if (isset($_SESSION[$aVarName]))
{
$this->hasChanged=TRUE;
unset($_SESSION[$aVarName]);
}
}
// --------------------------------------------------------------
// user methods
// --------------------------------------------------------------
/**
* clears all user data from the session
*
* @param boolean $debug
*/
function clearUser($debug=false)
{
$this->unsetValue('CURRENTUSER',$debug);
$this->unsetValue('CURRENTUSERCHK',$debug);
}
/**
* returns the stored userId
*
* @param boolean $debug
*
* @return int
*
* @since pk-08-07-02
*/
public function getUserId($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_SESSION::getUserId");
if ($arr_usrData = $this->getValue('CURRENTUSER'))
{
return intval($arr_usrData['USR_ID']);
}
return 0;
}
/**
* @param boolean $reqDB (establish a database connection)
* @param boolean $debug
*
* @return OCSP_USER
*
* @requires user/OCSP_USER.phpclass
*
*/
function getUser($reqDB=FALSE,$debug=FALSE)
{
pcf_require_class('OCSP_USER',"user/");
return OCSP_USER::factoryCurrentFromSession();
}
/**
* refreshes the user session
*
* @param boolean $withoutUsrDb
*
* @access public
*/
function refreshUser($withoutUsrDb=FALSE)
{
echoDebugLine(__FILE__,__LINE__,"<p>NOT IMPLEMENTET CALL OCSP_SESSION::refreshUser()</p><pre>".print_r($_SESSION,True)."</pre>");
exit();
}
// --------------------------------------------------------------
// en- / decryption
// --------------------------------------------------------------
private static function get_rnd_iv($iv_len)
{
$iv = "qe3jignfmas4qeeqfrfmas4qegnqw2egtjkn5lgdaaafaadsjpqd37qwet8zuiopl1";
while(strlen($iv) < $iv_len) $iv.=$iv;
return substr($iv,0,$iv_len);
}
/**
* returns a default password for encrypt/decrypt
*
* @return string
*/
private function get_cryptPassword()
{
$password = $this->getValue('MD5PWD');
if (empty($password))
{
$password = md5("open".time().$_SERVER['REMOTE_ADDR'].$_SERVER['REMOTE_PORT']."CSP");
$this->setValue('MD5PWD',$password);
}
return $password;
}
/**
* md5 encrypts a text
*
* if $password is empty $_SESSION['MD5PWD'] is used
*
* @param string $plain_text
* @param string $password
* @param int $iv_len
*
* @returns string
*
* @see http://www.php.net/manual/en/function.md5.php
*
* @since pk-08-03-14
*/
public function encrypt($plain_text, $password="", $iv_len = 16)
{
if (empty($password))
{
$password=$this->get_cryptPassword();
}
$password =md5($password);
$plain_text =base64_encode($plain_text);
$plain_text .= "\x13";
$n = strlen($plain_text);
if ($n % 16) $plain_text .= str_repeat("\0", 16 - ($n % 16));
$i = 0;
$enc_text = self::get_rnd_iv($iv_len);
$iv = substr($password ^ $enc_text, 0, 512);
while ($i < $n) {
$block = substr($plain_text, $i, 16) ^ pack('H*', md5($iv));
$enc_text .= $block;
$iv = substr($block . $iv, 0, 512) ^ $password;
$i += 16;
}
return base64_encode(urlencode($enc_text));
}
/**
* md5 decrypts a text
*
* if $password is empty $_SESSION['MD5PWD'] is used
*
* @param string $enc_text
* @param string $password
* @param int $iv_len
*
* @returns string
*
* @see http://www.php.net/manual/en/function.md5.php
*
* @since pk-08-03-14
*/
public function decrypt($enc_text, $password="", $iv_len = 16) {
if (empty($password))
{
$password=$this->get_cryptPassword();
}
// prepare password and enc_text
$password=md5($password);
$enc_text = urldecode(base64_decode($enc_text));
$n = strlen($enc_text);
$i = $iv_len;
$plain_text = '';
$iv = substr($password ^ substr($enc_text, 0, $iv_len), 0, 512);
while ($i < $n) {
$block = substr($enc_text, $i, 16);
$plain_text .= $block ^ pack('H*', md5($iv));
$iv = substr($block . $iv, 0, 512) ^ $password;
$i += 16;
}
return base64_decode(preg_replace('/\\x13\\x00*$/', '', $plain_text));
}
}
?>

Source for file OCSP_SESSION.phpclass