mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 11:28:25 +00:00
779 lines
18 KiB
PHP
779 lines
18 KiB
PHP
<?php
|
|
/**
|
|
* Session class for Cake.
|
|
*
|
|
* Cake abstracts the handling of sessions.
|
|
* There are several convenient methods to access session information.
|
|
* This class is the implementation of those methods.
|
|
* They are mostly used by the Session Component.
|
|
*
|
|
* PHP versions 4 and 5
|
|
*
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
*
|
|
* Licensed under The MIT License
|
|
* Redistributions of files must retain the above copyright notice.
|
|
*
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
|
* @package cake
|
|
* @subpackage cake.cake.libs
|
|
* @since CakePHP(tm) v .0.10.0.1222
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
|
*/
|
|
|
|
/**
|
|
* Session class for Cake.
|
|
*
|
|
* Cake abstracts the handling of sessions. There are several convenient methods to access session information.
|
|
* This class is the implementation of those methods. They are mostly used by the Session Component.
|
|
*
|
|
* @package cake
|
|
* @subpackage cake.cake.libs
|
|
*/
|
|
class CakeSession {
|
|
|
|
/**
|
|
* True if the Session is still valid
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public static $valid = false;
|
|
|
|
/**
|
|
* Error messages for this session
|
|
*
|
|
* @var array
|
|
*/
|
|
public static $error = false;
|
|
|
|
/**
|
|
* User agent string
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $_userAgent = '';
|
|
|
|
/**
|
|
* Path to where the session is active.
|
|
*
|
|
* @var string
|
|
*/
|
|
public static $path = '/';
|
|
|
|
/**
|
|
* Error number of last occurred error
|
|
*
|
|
* @var integer
|
|
*/
|
|
public static $lastError = null;
|
|
|
|
/**
|
|
* 'Security.level' setting, "high", "medium", or "low".
|
|
*
|
|
* @var string
|
|
*/
|
|
public static $security = null;
|
|
|
|
/**
|
|
* Start time for this session.
|
|
*
|
|
* @var integer
|
|
*/
|
|
public static $time = false;
|
|
|
|
/**
|
|
* Cookie lifetime
|
|
*
|
|
* @var integer
|
|
*/
|
|
public static $cookieLifeTime;
|
|
|
|
/**
|
|
* Time when this session becomes invalid.
|
|
*
|
|
* @var integer
|
|
*/
|
|
public static $sessionTime = false;
|
|
|
|
/**
|
|
* Keeps track of keys to watch for writes on
|
|
*
|
|
* @var array
|
|
*/
|
|
public static $watchKeys = array();
|
|
|
|
/**
|
|
* Current Session id
|
|
*
|
|
* @var string
|
|
*/
|
|
public static $id = null;
|
|
|
|
/**
|
|
* Hostname
|
|
*
|
|
* @var string
|
|
*/
|
|
public static $host = null;
|
|
|
|
/**
|
|
* Session timeout multiplier factor
|
|
*
|
|
* @var integer
|
|
*/
|
|
public static $timeout = null;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param string $base The base path for the Session
|
|
* @param boolean $start Should session be started right now
|
|
*/
|
|
public static function init($base = null, $start = true) {
|
|
App::import('Core', array('Set', 'Security'));
|
|
self::$time = time();
|
|
|
|
$checkAgent = Configure::read('Session.checkAgent');
|
|
if (($checkAgent === true || $checkAgent === null) && env('HTTP_USER_AGENT') != null) {
|
|
self::$_userAgent = md5(env('HTTP_USER_AGENT') . Configure::read('Security.salt'));
|
|
}
|
|
|
|
self::_setupDatabase();
|
|
if ($start === true) {
|
|
self::_setPath($base);
|
|
self::_setHost(env('HTTP_HOST'));
|
|
self::start();
|
|
}
|
|
if (isset($_SESSION) || $start === true) {
|
|
self::$sessionTime = self::$time + (Security::inactiveMins() * Configure::read('Session.timeout'));
|
|
self::$security = Configure::read('Security.level');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Setup the Path variable
|
|
*
|
|
* @param string $base base path
|
|
* @return void
|
|
*/
|
|
protected static function _setPath($base = null) {
|
|
if (empty($base)) {
|
|
self::$path = '/';
|
|
return;
|
|
}
|
|
if (strpos($base, 'index.php') !== false) {
|
|
$base = str_replace('index.php', '', $base);
|
|
}
|
|
if (strpos($base, '?') !== false) {
|
|
$base = str_replace('?', '', $base);
|
|
}
|
|
self::$path = $base;
|
|
}
|
|
|
|
/**
|
|
* Set the host name
|
|
*
|
|
* @param string $host Hostname
|
|
* @return void
|
|
*/
|
|
protected static function _setHost($host) {
|
|
self::$host = $host;
|
|
if (strpos(self::$host, ':') !== false) {
|
|
self::$host = substr(self::$host, 0, strpos(self::$host, ':'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Setup database configuration for Session, if enabled.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function _setupDatabase() {
|
|
if (Configure::read('Session.save') !== 'database') {
|
|
return;
|
|
}
|
|
$modelName = Configure::read('Session.model');
|
|
$database = Configure::read('Session.database');
|
|
$table = Configure::read('Session.table');
|
|
|
|
if (empty($database)) {
|
|
$database = 'default';
|
|
}
|
|
$settings = array(
|
|
'class' => 'Session',
|
|
'alias' => 'Session',
|
|
'table' => 'cake_sessions',
|
|
'ds' => $database
|
|
);
|
|
if (!empty($modelName)) {
|
|
$settings['class'] = $modelName;
|
|
}
|
|
if (!empty($table)) {
|
|
$settings['table'] = $table;
|
|
}
|
|
ClassRegistry::init($settings);
|
|
}
|
|
|
|
/**
|
|
* Starts the Session.
|
|
*
|
|
* @return boolean True if session was started
|
|
*/
|
|
public static function start() {
|
|
if (self::started()) {
|
|
return true;
|
|
}
|
|
|
|
session_write_close();
|
|
self::__initSession();
|
|
self::_startSession();
|
|
$started = self::started();
|
|
|
|
if (!self::id() && $started) {
|
|
self::_checkValid();
|
|
}
|
|
|
|
self::$error = array();
|
|
return self::started();
|
|
}
|
|
|
|
/**
|
|
* Determine if Session has been started.
|
|
*
|
|
* @return boolean True if session has been started.
|
|
*/
|
|
public static function started() {
|
|
return isset($_SESSION) && session_id();
|
|
}
|
|
|
|
/**
|
|
* Returns true if given variable is set in session.
|
|
*
|
|
* @param string $name Variable name to check for
|
|
* @return boolean True if variable is there
|
|
*/
|
|
public static function check($name) {
|
|
if (empty($name)) {
|
|
return false;
|
|
}
|
|
$result = Set::classicExtract($_SESSION, $name);
|
|
return isset($result);
|
|
}
|
|
|
|
/**
|
|
* Returns the Session id
|
|
*
|
|
* @param id $name string
|
|
* @return string Session id
|
|
*/
|
|
public static function id($id = null) {
|
|
if ($id) {
|
|
self::$id = $id;
|
|
session_id(self::$id);
|
|
}
|
|
if (self::started()) {
|
|
return session_id();
|
|
}
|
|
return self::$id;
|
|
}
|
|
|
|
/**
|
|
* Removes a variable from session.
|
|
*
|
|
* @param string $name Session variable to remove
|
|
* @return boolean Success
|
|
*/
|
|
public static function delete($name) {
|
|
if (self::check($name)) {
|
|
if (in_array($name, self::$watchKeys)) {
|
|
trigger_error(sprintf(__('Deleting session key {%s}'), $name), E_USER_NOTICE);
|
|
}
|
|
self::__overwrite($_SESSION, Set::remove($_SESSION, $name));
|
|
return (self::check($name) == false);
|
|
}
|
|
self::__setError(2, sprintf(__("%s doesn't exist"), $name));
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Used to write new data to _SESSION, since PHP doesn't like us setting the _SESSION var itself
|
|
*
|
|
* @param array $old Set of old variables => values
|
|
* @param array $new New set of variable => value
|
|
* @access private
|
|
*/
|
|
function __overwrite(&$old, $new) {
|
|
if (!empty($old)) {
|
|
foreach ($old as $key => $var) {
|
|
if (!isset($new[$key])) {
|
|
unset($old[$key]);
|
|
}
|
|
}
|
|
}
|
|
foreach ($new as $key => $var) {
|
|
$old[$key] = $var;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return error description for given error number.
|
|
*
|
|
* @param integer $errorNumber Error to set
|
|
* @return string Error as string
|
|
* @access private
|
|
*/
|
|
function __error($errorNumber) {
|
|
if (!is_array(self::$error) || !array_key_exists($errorNumber, self::$error)) {
|
|
return false;
|
|
} else {
|
|
return self::$error[$errorNumber];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns last occurred error as a string, if any.
|
|
*
|
|
* @return mixed Error description as a string, or false.
|
|
*/
|
|
public static function error() {
|
|
if (self::$lastError) {
|
|
return self::__error(self::$lastError);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns true if session is valid.
|
|
*
|
|
* @return boolean Success
|
|
*/
|
|
public static function valid() {
|
|
if (self::read('Config')) {
|
|
$validAgent = (
|
|
Configure::read('Session.checkAgent') === false ||
|
|
self::$_userAgent == self::read('Config.userAgent')
|
|
);
|
|
if ($validAgent && self::$time <= self::read('Config.time')) {
|
|
if (self::$error === false) {
|
|
self::$valid = true;
|
|
}
|
|
} else {
|
|
self::$valid = false;
|
|
self::__setError(1, 'Session Highjacking Attempted !!!');
|
|
}
|
|
}
|
|
return self::$valid;
|
|
}
|
|
|
|
/**
|
|
* Get / Set the userAgent
|
|
*
|
|
* @param string $userAgent Set the userAgent
|
|
* @return void
|
|
*/
|
|
public static function userAgent($userAgent = null) {
|
|
if ($userAgent) {
|
|
self::$_userAgent = $userAgent;
|
|
}
|
|
return self::$_userAgent;
|
|
}
|
|
|
|
/**
|
|
* Returns given session variable, or all of them, if no parameters given.
|
|
*
|
|
* @param mixed $name The name of the session variable (or a path as sent to Set.extract)
|
|
* @return mixed The value of the session variable
|
|
*/
|
|
public static function read($name = null) {
|
|
if (is_null($name)) {
|
|
return self::__returnSessionVars();
|
|
}
|
|
if (empty($name)) {
|
|
return false;
|
|
}
|
|
$result = Set::classicExtract($_SESSION, $name);
|
|
|
|
if (!is_null($result)) {
|
|
return $result;
|
|
}
|
|
self::__setError(2, "$name doesn't exist");
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns all session variables.
|
|
*
|
|
* @return mixed Full $_SESSION array, or false on error.
|
|
* @access private
|
|
*/
|
|
function __returnSessionVars() {
|
|
if (!empty($_SESSION)) {
|
|
return $_SESSION;
|
|
}
|
|
self::__setError(2, 'No Session vars set');
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Tells Session to write a notification when a certain session path or subpath is written to
|
|
*
|
|
* @param mixed $var The variable path to watch
|
|
* @return void
|
|
*/
|
|
public static function watch($var) {
|
|
if (empty($var)) {
|
|
return false;
|
|
}
|
|
if (!in_array($var, self::$watchKeys, true)) {
|
|
self::$watchKeys[] = $var;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tells Session to stop watching a given key path
|
|
*
|
|
* @param mixed $var The variable path to watch
|
|
* @return void
|
|
*/
|
|
public static function ignore($var) {
|
|
if (!in_array($var, self::$watchKeys)) {
|
|
debug("NOT");
|
|
return;
|
|
}
|
|
foreach (self::$watchKeys as $i => $key) {
|
|
if ($key == $var) {
|
|
unset(self::$watchKeys[$i]);
|
|
self::$watchKeys = array_values(self::$watchKeys);
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Writes value to given session variable name.
|
|
*
|
|
* @param mixed $name Name of variable
|
|
* @param string $value Value to write
|
|
* @return boolean True if the write was successful, false if the write failed
|
|
*/
|
|
public static function write($name, $value = null) {
|
|
if (empty($name)) {
|
|
return false;
|
|
}
|
|
$write = $name;
|
|
if (!is_array($name)) {
|
|
$write = array($name => $value);
|
|
}
|
|
foreach ($write as $key => $val) {
|
|
if (in_array($key, self::$watchKeys)) {
|
|
trigger_error(sprintf(__('Writing session key {%s}: %s'), $key, Debugger::exportVar($val)), E_USER_NOTICE);
|
|
}
|
|
self::__overwrite($_SESSION, Set::insert($_SESSION, $key, $val));
|
|
if (Set::classicExtract($_SESSION, $key) !== $val) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Helper method to destroy invalid sessions.
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function destroy() {
|
|
$_SESSION = null;
|
|
self::$id = null;
|
|
self::init(self::$path);
|
|
self::start();
|
|
self::renew();
|
|
self::_checkValid();
|
|
}
|
|
|
|
/**
|
|
* Helper method to initialize a session, based on Cake core settings.
|
|
*
|
|
* @access private
|
|
*/
|
|
function __initSession() {
|
|
$iniSet = function_exists('ini_set');
|
|
if ($iniSet && env('HTTPS')) {
|
|
ini_set('session.cookie_secure', 1);
|
|
}
|
|
if ($iniSet && (self::$security === 'high' || self::$security === 'medium')) {
|
|
ini_set('session.referer_check', self::$host);
|
|
}
|
|
self::$cookieLifeTime = Configure::read('Session.timeout') * Security::inactiveMins();
|
|
|
|
switch (Configure::read('Session.save')) {
|
|
case 'cake':
|
|
if (empty($_SESSION) && $iniSet) {
|
|
ini_set('session.use_trans_sid', 0);
|
|
ini_set('url_rewriter.tags', '');
|
|
ini_set('session.serialize_handler', 'php');
|
|
ini_set('session.use_cookies', 1);
|
|
ini_set('session.name', Configure::read('Session.cookie'));
|
|
ini_set('session.cookie_lifetime', self::$cookieLifeTime);
|
|
ini_set('session.cookie_path', self::$path);
|
|
ini_set('session.auto_start', 0);
|
|
ini_set('session.save_path', TMP . 'sessions');
|
|
}
|
|
break;
|
|
case 'database':
|
|
if (empty($_SESSION)) {
|
|
if (Configure::read('Session.model') === null) {
|
|
trigger_error(__("You must set the all Configure::write('Session.*') in core.php to use database storage"), E_USER_WARNING);
|
|
self::_stop();
|
|
}
|
|
if ($iniSet) {
|
|
ini_set('session.use_trans_sid', 0);
|
|
ini_set('url_rewriter.tags', '');
|
|
ini_set('session.save_handler', 'user');
|
|
ini_set('session.serialize_handler', 'php');
|
|
ini_set('session.use_cookies', 1);
|
|
ini_set('session.name', Configure::read('Session.cookie'));
|
|
ini_set('session.cookie_lifetime', self::$cookieLifeTime);
|
|
ini_set('session.cookie_path', self::$path);
|
|
ini_set('session.auto_start', 0);
|
|
}
|
|
}
|
|
session_set_save_handler(
|
|
array('CakeSession','__open'),
|
|
array('CakeSession', '__close'),
|
|
array('CakeSession', '__read'),
|
|
array('CakeSession', '__write'),
|
|
array('CakeSession', '__destroy'),
|
|
array('CakeSession', '__gc')
|
|
);
|
|
break;
|
|
case 'php':
|
|
if (empty($_SESSION) && $iniSet) {
|
|
ini_set('session.use_trans_sid', 0);
|
|
ini_set('session.name', Configure::read('Session.cookie'));
|
|
ini_set('session.cookie_lifetime', self::$cookieLifeTime);
|
|
ini_set('session.cookie_path', self::$path);
|
|
}
|
|
break;
|
|
case 'cache':
|
|
if (empty($_SESSION)) {
|
|
if (!class_exists('Cache')) {
|
|
require LIBS . 'cache.php';
|
|
}
|
|
if ($iniSet) {
|
|
ini_set('session.use_trans_sid', 0);
|
|
ini_set('url_rewriter.tags', '');
|
|
ini_set('session.save_handler', 'user');
|
|
ini_set('session.use_cookies', 1);
|
|
ini_set('session.name', Configure::read('Session.cookie'));
|
|
ini_set('session.cookie_lifetime', self::$cookieLifeTime);
|
|
ini_set('session.cookie_path', self::$path);
|
|
}
|
|
}
|
|
session_set_save_handler(
|
|
array('CakeSession','__open'),
|
|
array('CakeSession', '__close'),
|
|
array('Cache', 'read'),
|
|
array('Cache', 'write'),
|
|
array('Cache', 'delete'),
|
|
array('Cache', 'gc')
|
|
);
|
|
break;
|
|
default:
|
|
$config = CONFIGS . Configure::read('Session.save') . '.php';
|
|
|
|
if (is_file($config)) {
|
|
require($config);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper method to start a session
|
|
*
|
|
* @return boolean Success
|
|
*/
|
|
protected function _startSession() {
|
|
if (headers_sent()) {
|
|
if (empty($_SESSION)) {
|
|
$_SESSION = array();
|
|
}
|
|
} elseif (!isset($_SESSION)) {
|
|
session_cache_limiter ("must-revalidate");
|
|
session_start();
|
|
header ('P3P: CP="NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM"');
|
|
} else {
|
|
session_start();
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Helper method to create a new session.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected static function _checkValid() {
|
|
if (self::read('Config')) {
|
|
if ((Configure::read('Session.checkAgent') === false || self::$_userAgent == self::read('Config.userAgent')) && self::$time <= self::read('Config.time')) {
|
|
$time = self::read('Config.time');
|
|
self::write('Config.time', self::$sessionTime);
|
|
if (Configure::read('Security.level') === 'high') {
|
|
$check = self::read('Config.timeout');
|
|
$check -= 1;
|
|
self::write('Config.timeout', $check);
|
|
|
|
if (time() > ($time - (Security::inactiveMins() * Configure::read('Session.timeout')) + 2) || $check < 1) {
|
|
self::renew();
|
|
self::write('Config.timeout', Security::inactiveMins());
|
|
}
|
|
}
|
|
self::$valid = true;
|
|
} else {
|
|
self::destroy();
|
|
self::$valid = false;
|
|
self::__setError(1, 'Session Highjacking Attempted !!!');
|
|
}
|
|
} else {
|
|
self::write('Config.userAgent', self::$_userAgent);
|
|
self::write('Config.time', self::$sessionTime);
|
|
self::write('Config.timeout', Security::inactiveMins());
|
|
self::$valid = true;
|
|
self::__setError(1, 'Session is valid');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Restarts this session.
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function renew() {
|
|
if (session_id()) {
|
|
if (session_id() != '' || isset($_COOKIE[session_name()])) {
|
|
setcookie(Configure::read('Session.cookie'), '', time() - 42000, self::$path);
|
|
}
|
|
session_regenerate_id(true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper method to set an internal error message.
|
|
*
|
|
* @param integer $errorNumber Number of the error
|
|
* @param string $errorMessage Description of the error
|
|
* @return void
|
|
* @access private
|
|
*/
|
|
function __setError($errorNumber, $errorMessage) {
|
|
if (self::$error === false) {
|
|
self::$error = array();
|
|
}
|
|
self::$error[$errorNumber] = $errorMessage;
|
|
self::$lastError = $errorNumber;
|
|
}
|
|
|
|
/**
|
|
* Method called on open of a database session.
|
|
*
|
|
* @return boolean Success
|
|
* @access private
|
|
*/
|
|
function __open() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method called on close of a database session.
|
|
*
|
|
* @return boolean Success
|
|
* @access private
|
|
*/
|
|
function __close() {
|
|
$probability = mt_rand(1, 150);
|
|
if ($probability <= 3) {
|
|
switch (Configure::read('Session.save')) {
|
|
case 'cache':
|
|
Cache::gc();
|
|
break;
|
|
default:
|
|
CakeSession::__gc();
|
|
break;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method used to read from a database session.
|
|
*
|
|
* @param mixed $id The key of the value to read
|
|
* @return mixed The value of the key or false if it does not exist
|
|
* @access private
|
|
*/
|
|
function __read($id) {
|
|
$model =& ClassRegistry::getObject('Session');
|
|
|
|
$row = $model->find('first', array(
|
|
'conditions' => array($model->primaryKey => $id)
|
|
));
|
|
|
|
if (empty($row[$model->alias]['data'])) {
|
|
return false;
|
|
}
|
|
|
|
return $row[$model->alias]['data'];
|
|
}
|
|
|
|
/**
|
|
* Helper function called on write for database sessions.
|
|
*
|
|
* @param integer $id ID that uniquely identifies session in database
|
|
* @param mixed $data The value of the data to be saved.
|
|
* @return boolean True for successful write, false otherwise.
|
|
* @access private
|
|
*/
|
|
function __write($id, $data) {
|
|
$expires = time() + Configure::read('Session.timeout') * Security::inactiveMins();
|
|
$model =& ClassRegistry::getObject('Session');
|
|
$return = $model->save(compact('id', 'data', 'expires'));
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Method called on the destruction of a database session.
|
|
*
|
|
* @param integer $id ID that uniquely identifies session in database
|
|
* @return boolean True for successful delete, false otherwise.
|
|
* @access private
|
|
*/
|
|
function __destroy($id) {
|
|
$model =& ClassRegistry::getObject('Session');
|
|
$return = $model->delete($id);
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Helper function called on gc for database sessions.
|
|
*
|
|
* @param integer $expires Timestamp (defaults to current time)
|
|
* @return boolean Success
|
|
* @access private
|
|
*/
|
|
function __gc($expires = null) {
|
|
$model =& ClassRegistry::getObject('Session');
|
|
|
|
if (!$expires) {
|
|
$expires = time();
|
|
}
|
|
|
|
$return = $model->deleteAll(array($model->alias . ".expires <" => $expires), false, false);
|
|
return $return;
|
|
}
|
|
}
|
|
|
|
// Initialize the session
|
|
CakeSession::init();
|