mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
624ddc67cb
ENHANCEMENT Added optional $sid parameter to Session::start() to start the session using an existing session ID (from r91044) git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@92449 467b73ca-7a2a-4603-9d3b-597d59a354a9
270 lines
7.3 KiB
PHP
270 lines
7.3 KiB
PHP
<?php
|
|
/**
|
|
* Handles all manipulation of the session.
|
|
*
|
|
* The static methods are used to manipulate the currently active controller's session.
|
|
* The instance methods are used to manipulate a particular session. There can be more than one of these created.
|
|
*
|
|
* In order to support things like testing, the session is associated with a particular Controller. In normal usage, this is loaded from
|
|
* and saved to the regular PHP session, but for things like static-page-generation and unit-testing, you can create multiple Controllers,
|
|
* each with their own session.
|
|
*
|
|
* The instance object is basically just a way of manipulating a set of nested maps, and isn't specific to session data.
|
|
* This class is currently really basic and could do with a more well-thought-out implementation
|
|
* @package sapphire
|
|
* @subpackage control
|
|
*/
|
|
class Session {
|
|
|
|
/**
|
|
* @var $timeout Set session timeout
|
|
*/
|
|
static protected $timeout = 0;
|
|
|
|
static protected $session_ips = array();
|
|
|
|
/**
|
|
* Provide an <code>array</code> of rules specifing timeouts for IPv4 address ranges or
|
|
* individual IPv4 addresses. The key is an IP address or range and the value is the time
|
|
* until the session expires in seconds. For example:
|
|
*
|
|
* Session::set_timeout_ips(array(
|
|
* '127.0.0.1' => 36000
|
|
* ));
|
|
*
|
|
* Any user connecting from 127.0.0.1 (localhost) will have their session expired after 10 hours.
|
|
*
|
|
* Session::set_timeout is used to set the timeout value for any users whose address is not in the given IP range.
|
|
*
|
|
* @param array $session_ips Array of IPv4 rules.
|
|
*/
|
|
public static function set_timeout_ips($session_ips) {
|
|
if(!is_array($session_ips)) {
|
|
user_error("Session::set_timeout_ips expects an array as its argument", E_USER_NOTICE);
|
|
self::$session_ips = array();
|
|
} else {
|
|
self::$session_ips = $session_ips;
|
|
}
|
|
}
|
|
|
|
public static function set($name, $val) {
|
|
return Controller::curr()->getSession()->inst_set($name, $val);
|
|
}
|
|
public static function addToArray($name, $val) {
|
|
return Controller::curr()->getSession()->inst_addToArray($name, $val);
|
|
}
|
|
public static function get($name) {
|
|
return Controller::curr()->getSession()->inst_get($name);
|
|
}
|
|
public static function clear($name) {
|
|
return Controller::curr()->getSession()->inst_clear($name);
|
|
}
|
|
public static function getAll() {
|
|
return Controller::curr()->getSession()->inst_getAll();
|
|
}
|
|
public static function save() {
|
|
return Controller::curr()->getSession()->inst_save();
|
|
}
|
|
|
|
/**
|
|
* Session data
|
|
*/
|
|
protected $data = array();
|
|
protected $changedData = array();
|
|
|
|
/**
|
|
* Create a new session object, with the given starting data
|
|
* @param $data Can be an array of data (such as $_SESSION) or another Session object to clone.
|
|
*/
|
|
function __construct($data) {
|
|
if($data instanceof Session) $data = $data->inst_getAll();
|
|
|
|
$this->data = $data;
|
|
}
|
|
|
|
public function inst_set($name, $val) {
|
|
// Quicker execution path for "."-free names
|
|
if(strpos($name,'.') === false) {
|
|
$this->data[$name] = $val;
|
|
$this->changedData[$name] = $val;
|
|
|
|
} else {
|
|
$names = explode('.', $name);
|
|
|
|
// We still want to do this even if we have strict path checking for legacy code
|
|
$var = &$this->data;
|
|
$diffVar = &$this->changedData;
|
|
|
|
foreach($names as $n) {
|
|
$var = &$var[$n];
|
|
$diffVar = &$diffVar[$n];
|
|
}
|
|
|
|
$var = $val;
|
|
$diffVar = $val;
|
|
}
|
|
}
|
|
|
|
public function inst_addToArray($name, $val) {
|
|
$names = explode('.', $name);
|
|
|
|
// We still want to do this even if we have strict path checking for legacy code
|
|
$var = &$this->data;
|
|
$diffVar = &$this->changedData;
|
|
|
|
foreach($names as $n) {
|
|
$var = &$var[$n];
|
|
$diffVar = &$diffVar[$n];
|
|
}
|
|
|
|
$var[] = $val;
|
|
$diffVar[sizeof($var)-1] = $val;
|
|
}
|
|
|
|
public function inst_get($name) {
|
|
// Quicker execution path for "."-free names
|
|
if(strpos($name,'.') === false) {
|
|
if(isset($this->data[$name])) return $this->data[$name];
|
|
|
|
} else {
|
|
$names = explode('.', $name);
|
|
|
|
if(!isset($this->data)) {
|
|
return null;
|
|
}
|
|
|
|
$var = $this->data;
|
|
|
|
foreach($names as $n) {
|
|
if(!isset($var[$n])) {
|
|
return null;
|
|
}
|
|
$var = $var[$n];
|
|
}
|
|
|
|
return $var;
|
|
}
|
|
}
|
|
|
|
public function inst_clear($name) {
|
|
$names = explode('.', $name);
|
|
|
|
// We still want to do this even if we have strict path checking for legacy code
|
|
$var = &$this->data;
|
|
$diffVar = &$this->changedData;
|
|
|
|
foreach($names as $n) {
|
|
$var = &$var[$n];
|
|
$diffVar = &$diffVar[$n];
|
|
}
|
|
|
|
$var = null;
|
|
$diffVar = null;
|
|
}
|
|
|
|
public function inst_getAll() {
|
|
return $this->data;
|
|
}
|
|
|
|
/**
|
|
* Save data to session
|
|
* Only save the changes, so that anyone manipulating $_SESSION directly doesn't get burned.
|
|
*/
|
|
public function inst_save() {
|
|
$this->recursivelyApply($this->changedData, $_SESSION);
|
|
}
|
|
|
|
/**
|
|
* Recursively apply the changes represented in $data to $dest.
|
|
* Used to update $_SESSION
|
|
*/
|
|
protected function recursivelyApply($data, &$dest) {
|
|
foreach($data as $k => $v) {
|
|
if(is_array($v)) {
|
|
if(!isset($dest[$k])) $dest[$k] = array();
|
|
$this->recursivelyApply($v, $dest[$k]);
|
|
} else {
|
|
$dest[$k] = $v;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets the appropriate form message in session, with type. This will be shown once,
|
|
* for the form specified.
|
|
*
|
|
* @param formname the form name you wish to use ( usually $form->FormName() )
|
|
* @param messsage the message you wish to add to it
|
|
* @param type the type of message
|
|
*/
|
|
public static function setFormMessage($formname,$message,$type){
|
|
Session::set("FormInfo.$formname.message", $message);
|
|
Session::set("FormInfo.$formname.type", $type);
|
|
}
|
|
|
|
/**
|
|
* Initialize session.
|
|
* @param string $sid Start the session with a specific ID
|
|
*/
|
|
public static function start($sid = null) {
|
|
self::load_config();
|
|
|
|
if(!session_id() && !headers_sent()) {
|
|
session_set_cookie_params(self::$timeout, Director::baseURL());
|
|
// @ is to supress win32 warnings/notices when session wasn't cleaned up properly
|
|
// There's nothing we can do about this, because it's an operating system function!
|
|
if($sid) session_id($sid);
|
|
@session_start();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Destroy the active session.
|
|
* @param bool $removeCookie If set to TRUE, removes the user's cookie, FALSE does not remove
|
|
*/
|
|
public static function destroy($removeCookie = true) {
|
|
if(session_id()) {
|
|
if($removeCookie) unset($_COOKIE[session_name()]);
|
|
session_destroy();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Use the Session::$session_ips array to set timeouts based on IP address or IP address
|
|
* range.
|
|
*
|
|
* Note: The use of _sessions.php is deprecated.
|
|
*/
|
|
public static function load_config() {
|
|
foreach(self::$session_ips as $sessionIP => $timeout) {
|
|
if(preg_match('/^([0-9.]+)\s?-\s?([0-9.]+)$/', $sessionIP, $ips)) {
|
|
if(isset($_SERVER['REMOTE_ADDR'])) {
|
|
$startIP = ip2long($ips[1]);
|
|
$endIP = ip2long($ips[2]);
|
|
$clientIP = ip2long($_SERVER['REMOTE_ADDR']);
|
|
$minIP = min($startIP, $endIP);
|
|
$maxIP = max($startIP, $endIP);
|
|
|
|
if($minIP <= $clientIP && $clientIP <= $maxIP) {
|
|
return self::set_timeout($timeout);
|
|
}
|
|
}
|
|
}
|
|
// TODO - Net masks or something
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enter description here...
|
|
*
|
|
* @param int $timeout Time until a session expires in seconds. Defaults to expire when browser is closed.
|
|
*/
|
|
public static function set_timeout($timeout) {
|
|
self::$timeout = intval($timeout);
|
|
}
|
|
|
|
public static function get_timeout() {
|
|
return self::$timeout;
|
|
}
|
|
}
|
|
?>
|