From 63d6e6dfc35e6d82c4a64f37c408794c163becd4 Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Wed, 28 Sep 2011 15:16:41 -0400
Subject: [PATCH] Bump versions to 0.6 stable
---
program/include/rcube_session.php | 299 +++++++++++++++++++++++++++++++++++++++++++++++------------
1 files changed, 236 insertions(+), 63 deletions(-)
diff --git a/program/include/rcube_session.php b/program/include/rcube_session.php
index 55c2e14..01b9367 100644
--- a/program/include/rcube_session.php
+++ b/program/include/rcube_session.php
@@ -42,31 +42,55 @@
private $prev;
private $secret = '';
private $ip_check = false;
+ private $logging = false;
private $keep_alive = 0;
+ private $memcache;
/**
* Default constructor
*/
- public function __construct($db, $lifetime=60)
+ public function __construct($db, $config)
{
- $this->db = $db;
- $this->lifetime = $lifetime;
- $this->start = microtime(true);
- $this->ip = $_SERVER['REMOTE_ADDR'];
+ $this->db = $db;
+ $this->start = microtime(true);
+ $this->ip = $_SERVER['REMOTE_ADDR'];
+ $this->logging = $config->get('log_session', false);
+ $this->mc_debug = $config->get('memcache_debug', false);
- // valid time range is now - 1/2 lifetime to now + 1/2 lifetime
- $now = time();
- $this->now = $now - ($now % ($this->lifetime / 2));
- $this->prev = $this->now - ($this->lifetime / 2);
+ $lifetime = $config->get('session_lifetime', 1) * 60;
+ $this->set_lifetime($lifetime);
- // set custom functions for PHP session management
- session_set_save_handler(
- array($this, 'open'),
- array($this, 'close'),
- array($this, 'read'),
- array($this, 'write'),
- array($this, 'destroy'),
- array($this, 'gc'));
+ // use memcache backend
+ if ($config->get('session_storage', 'db') == 'memcache') {
+ $this->memcache = rcmail::get_instance()->get_memcache();
+
+ // set custom functions for PHP session management if memcache is available
+ if ($this->memcache) {
+ session_set_save_handler(
+ array($this, 'open'),
+ array($this, 'close'),
+ array($this, 'mc_read'),
+ array($this, 'mc_write'),
+ array($this, 'mc_destroy'),
+ array($this, 'gc'));
+ }
+ else {
+ raise_error(array('code' => 604, 'type' => 'db',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => "Failed to connect to memcached. Please check configuration"),
+ true, true);
+ }
+ }
+ else {
+ // set custom functions for PHP session management
+ session_set_save_handler(
+ array($this, 'open'),
+ array($this, 'close'),
+ array($this, 'db_read'),
+ array($this, 'db_write'),
+ array($this, 'db_destroy'),
+ array($this, 'db_gc'));
+ }
}
@@ -82,16 +106,31 @@
}
- // read session data
- public function read($key)
+ /**
+ * Delete session data for the given key
+ *
+ * @param string Session ID
+ */
+ public function destroy($key)
+ {
+ return $this->memcache ? $this->mc_destroy($key) : $this->db_destroy($key);
+ }
+
+
+ /**
+ * Read session data from database
+ *
+ * @param string Session ID
+ * @return string Session vars
+ */
+ public function db_read($key)
{
$sql_result = $this->db->query(
- sprintf("SELECT vars, ip, %s AS changed FROM %s WHERE sess_id = ?",
- $this->db->unixtimestamp('changed'), get_table_name('session')),
- $key);
+ "SELECT vars, ip, changed FROM ".get_table_name('session')
+ ." WHERE sess_id = ?", $key);
- if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
- $this->changed = $sql_arr['changed'];
+ if ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) {
+ $this->changed = strtotime($sql_arr['changed']);
$this->ip = $sql_arr['ip'];
$this->vars = base64_decode($sql_arr['vars']);
$this->key = $key;
@@ -112,29 +151,25 @@
* @param string Serialized session vars
* @return boolean True on success
*/
- public function write($key, $vars)
+ public function db_write($key, $vars)
{
$ts = microtime(true);
$now = $this->db->fromunixtime((int)$ts);
+ // no session row in DB (db_read() returns false)
+ if (!$this->key) {
+ $oldvars = false;
+ }
// use internal data from read() for fast requests (up to 0.5 sec.)
- if ($key == $this->key && $ts - $this->start < 0.5) {
+ else if ($key == $this->key && (!$this->vars || $ts - $this->start < 0.5)) {
$oldvars = $this->vars;
- } else { // else read data again from DB
- $oldvars = $this->read($key);
+ }
+ else { // else read data again from DB
+ $oldvars = $this->db_read($key);
}
if ($oldvars !== false) {
- $a_oldvars = $this->unserialize($oldvars);
- if (is_array($a_oldvars)) {
- foreach ((array)$this->unsets as $k)
- unset($a_oldvars[$k]);
-
- $newvars = $this->serialize(array_merge(
- (array)$a_oldvars, (array)$this->unserialize($vars)));
- }
- else
- $newvars = $vars;
+ $newvars = $this->_fixvars($vars, $oldvars);
if ($newvars !== $oldvars) {
$this->db->query(
@@ -154,8 +189,30 @@
$key, base64_encode($vars), (string)$this->ip);
}
- $this->unsets = array();
return true;
+ }
+
+
+ /**
+ * Merge vars with old vars and apply unsets
+ */
+ private function _fixvars($vars, $oldvars)
+ {
+ if ($oldvars !== false) {
+ $a_oldvars = $this->unserialize($oldvars);
+ if (is_array($a_oldvars)) {
+ foreach ((array)$this->unsets as $k)
+ unset($a_oldvars[$k]);
+
+ $newvars = $this->serialize(array_merge(
+ (array)$a_oldvars, (array)$this->unserialize($vars)));
+ }
+ else
+ $newvars = $vars;
+ }
+
+ $this->unsets = array();
+ return $newvars;
}
@@ -165,7 +222,7 @@
* @param string Session ID
* @return boolean True on success
*/
- public function destroy($key)
+ public function db_destroy($key)
{
$this->db->query(
sprintf("DELETE FROM %s WHERE sess_id = ?", get_table_name('session')),
@@ -181,17 +238,112 @@
* @param string Session lifetime in seconds
* @return boolean True on success
*/
- public function gc($maxlifetime)
+ public function db_gc($maxlifetime)
{
// just delete all expired sessions
$this->db->query(
sprintf("DELETE FROM %s WHERE changed < %s",
get_table_name('session'), $this->db->fromunixtime(time() - $maxlifetime)));
- foreach ($this->gc_handlers as $fct)
- $fct();
+ $this->gc();
return true;
+ }
+
+
+ /**
+ * Read session data from memcache
+ *
+ * @param string Session ID
+ * @return string Session vars
+ */
+ public function mc_read($key)
+ {
+ $value = $this->memcache->get($key);
+ if ($this->mc_debug) write_log('memcache', "get($key): " . strlen($value));
+ if ($value && ($arr = unserialize($value))) {
+ $this->changed = $arr['changed'];
+ $this->ip = $arr['ip'];
+ $this->vars = $arr['vars'];
+ $this->key = $key;
+
+ if (!empty($this->vars))
+ return $this->vars;
+ }
+
+ return false;
+ }
+
+ /**
+ * Save session data.
+ * handler for session_read()
+ *
+ * @param string Session ID
+ * @param string Serialized session vars
+ * @return boolean True on success
+ */
+ public function mc_write($key, $vars)
+ {
+ $ts = microtime(true);
+
+ // no session data in cache (mc_read() returns false)
+ if (!$this->key)
+ $oldvars = false;
+ // use internal data for fast requests (up to 0.5 sec.)
+ else if ($key == $this->key && (!$this->vars || $ts - $this->start < 0.5))
+ $oldvars = $this->vars;
+ else // else read data again
+ $oldvars = $this->mc_read($key);
+
+ $newvars = $oldvars !== false ? $this->_fixvars($vars, $oldvars) : $vars;
+
+ if ($newvars !== $oldvars || $ts - $this->changed > $this->lifetime / 2) {
+ $value = serialize(array('changed' => time(), 'ip' => $this->ip, 'vars' => $newvars));
+ $ret = $this->memcache->set($key, $value, MEMCACHE_COMPRESSED, $this->lifetime);
+ if ($this->mc_debug) {
+ write_log('memcache', "set($key): " . strlen($value) . ": " . ($ret ? 'OK' : 'ERR'));
+ write_log('memcache', "... get($key): " . strlen($this->memcache->get($key)));
+ }
+ return $ret;
+ }
+
+ return true;
+ }
+
+ /**
+ * Handler for session_destroy() with memcache backend
+ *
+ * @param string Session ID
+ * @return boolean True on success
+ */
+ public function mc_destroy($key)
+ {
+ $ret = $this->memcache->delete($key);
+ if ($this->mc_debug) write_log('memcache', "delete($key): " . ($ret ? 'OK' : 'ERR'));
+ return $ret;
+ }
+
+
+ /**
+ * Execute registered garbage collector routines
+ */
+ public function gc()
+ {
+ foreach ($this->gc_handlers as $fct)
+ $fct();
+ }
+
+
+ /**
+ * Cleanup session data before saving
+ */
+ public function cleanup()
+ {
+ // current compose information is stored in $_SESSION['compose'], move it to $_SESSION['compose_data_<ID>']
+ if ($compose_id = $_SESSION['compose']['id']) {
+ $_SESSION['compose_data_'.$compose_id] = $_SESSION['compose'];
+ $this->remove('compose');
+ }
}
@@ -209,27 +361,15 @@
/**
* Generate and set new session id
+ *
+ * @param boolean $destroy If enabled the current session will be destroyed
*/
- public function regenerate_id()
+ public function regenerate_id($destroy=true)
{
- // delete old session record
- $this->destroy(session_id());
+ session_regenerate_id($destroy);
+
$this->vars = false;
-
- $randval = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
-
- for ($random = '', $i=1; $i <= 32; $i++) {
- $random .= substr($randval, mt_rand(0,(strlen($randval) - 1)), 1);
- }
-
- // use md5 value for id
- $this->key = md5($random);
- session_id($this->key);
-
- $cookie = session_get_cookie_params();
- $lifetime = $cookie['lifetime'] ? time() + $cookie['lifetime'] : 0;
-
- rcmail::setcookie(session_name(), $this->key, $lifetime);
+ $this->key = session_id();
return true;
}
@@ -257,6 +397,7 @@
*/
public function kill()
{
+ $this->vars = false;
$this->destroy(session_id());
rcmail::setcookie($this->cookiename, '-del-', time() - 60);
}
@@ -365,12 +506,29 @@
return unserialize( 'a:' . $items . ':{' . $serialized . '}' );
}
+
+ /**
+ * Setter for session lifetime
+ */
+ public function set_lifetime($lifetime)
+ {
+ $this->lifetime = max(120, $lifetime);
+
+ // valid time range is now - 1/2 lifetime to now + 1/2 lifetime
+ $now = time();
+ $this->now = $now - ($now % ($this->lifetime / 2));
+ $this->prev = $this->now - ($this->lifetime / 2);
+ }
+
/**
* Setter for keep_alive interval
*/
public function set_keep_alive($keep_alive)
{
$this->keep_alive = $keep_alive;
+
+ if ($this->lifetime < $keep_alive)
+ $this->set_lifetime($keep_alive + 30);
}
/**
@@ -426,12 +584,18 @@
$this->cookie = $_COOKIE[$this->cookiename];
$result = $this->ip_check ? $_SERVER['REMOTE_ADDR'] == $this->ip : true;
+ if (!$result)
+ $this->log("IP check failed for " . $this->key . "; expected " . $this->ip . "; got " . $_SERVER['REMOTE_ADDR']);
+
if ($result && $this->_mkcookie($this->now) != $this->cookie) {
// Check if using id from previous time slot
- if ($this->_mkcookie($this->prev) == $this->cookie)
+ if ($this->_mkcookie($this->prev) == $this->cookie) {
$this->set_auth_cookie();
- else
+ }
+ else {
$result = false;
+ $this->log("Session authentication failed for " . $this->key . "; invalid auth cookie sent");
+ }
}
return $result;
@@ -459,5 +623,14 @@
$auth_string = "$this->key,$this->secret,$timeslot";
return "S" . (function_exists('sha1') ? sha1($auth_string) : md5($auth_string));
}
+
+ /**
+ *
+ */
+ function log($line)
+ {
+ if ($this->logging)
+ write_log('session', $line);
+ }
}
--
Gitblit v1.9.1