From 9870dac30de1b8d1bdeab57af3eeb7c89b21ef76 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Sat, 14 Apr 2012 02:35:52 -0400
Subject: [PATCH] - Make some methods public (#1488428)
---
program/include/rcube_session.php | 502 +++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 405 insertions(+), 97 deletions(-)
diff --git a/program/include/rcube_session.php b/program/include/rcube_session.php
index da799be..da221c3 100644
--- a/program/include/rcube_session.php
+++ b/program/include/rcube_session.php
@@ -4,9 +4,13 @@
+-----------------------------------------------------------------------+
| program/include/rcube_session.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland |
- | Licensed under the GNU GPL |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2005-2012, The Roundcube Dev Team |
+ | Copyright (C) 2011, Kolab Systems AG |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Provide database supported session management |
@@ -20,35 +24,76 @@
*/
+/**
+ * Class to provide database supported session storage
+ *
+ * @package Core
+ * @author Thomas Bruederli <roundcube@gmail.com>
+ * @author Aleksander Machniak <alec@alec.pl>
+ */
class rcube_session
{
private $db;
private $ip;
+ private $start;
private $changed;
private $unsets = array();
private $gc_handlers = array();
- private $start;
+ private $cookiename = 'roundcube_sessauth';
private $vars = false;
private $key;
+ private $now;
+ 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->db = $db;
+ $this->start = microtime(true);
+ $this->ip = $_SERVER['REMOTE_ADDR'];
+ $this->logging = $config->get('log_session', false);
- // 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'));
+ $lifetime = $config->get('session_lifetime', 1) * 60;
+ $this->set_lifetime($lifetime);
+
+ // 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 {
+ rcube::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'));
+ }
}
@@ -64,137 +109,265 @@
}
- // 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 ".$this->db->table_name('session')
+ ." WHERE sess_id = ?", $key);
- if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
- $this->changed = $sql_arr['changed'];
- $this->vars = $sql_arr['vars'];
- $this->ip = $sql_arr['ip'];
- $this->key = $key;
+ 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;
- if (!empty($sql_arr['vars']))
- return $sql_arr['vars'];
+ if (!empty($this->vars))
+ return $this->vars;
}
return false;
}
-
- // save session data
- public function write($key, $vars)
+
+ /**
+ * Save session data.
+ * handler for session_read()
+ *
+ * @param string Session ID
+ * @param string Serialized session vars
+ * @return boolean True on success
+ */
+ public function db_write($key, $vars)
{
$ts = microtime(true);
$now = $this->db->fromunixtime((int)$ts);
- // use internal data from read() for fast requests (up to 0.5 sec.)
- if ($key == $this->key && $ts - $this->start < 0.5) {
- $oldvars = $this->vars;
- } else { // else read data again from DB
- $oldvars = $this->read($key);
+ // 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.)
+ else if ($key == $this->key && (!$this->vars || $ts - $this->start < 0.5)) {
+ $oldvars = $this->vars;
+ }
+ else { // else read data again from DB
+ $oldvars = $this->db_read($key);
+ }
+
if ($oldvars !== false) {
- $a_oldvars = $this->unserialize($oldvars);
- foreach ((array)$this->unsets as $k)
- unset($a_oldvars[$k]);
+ $newvars = $this->_fixvars($vars, $oldvars);
- $newvars = $this->serialize(array_merge(
- (array)$a_oldvars, (array)$this->unserialize($vars)));
-
- if ($this->keep_alive>0) {
- $timeout = min($this->lifetime * 0.5,
- $this->lifetime - $this->keep_alive);
- } else {
- $timeout = 0;
- }
-
- if (!($newvars === $oldvars) || ($ts - $this->changed > $timeout)) {
+ if ($newvars !== $oldvars) {
$this->db->query(
- sprintf("UPDATE %s SET vars = ?, changed = %s WHERE sess_id = ?",
- get_table_name('session'), $now),
- $newvars, $key);
+ sprintf("UPDATE %s SET vars=?, changed=%s WHERE sess_id=?",
+ $this->db->table_name('session'), $now),
+ base64_encode($newvars), $key);
+ }
+ else if ($ts - $this->changed > $this->lifetime / 2) {
+ $this->db->query("UPDATE ".$this->db->table_name('session')." SET changed=$now WHERE sess_id=?", $key);
}
}
else {
$this->db->query(
sprintf("INSERT INTO %s (sess_id, vars, ip, created, changed) ".
"VALUES (?, ?, ?, %s, %s)",
- get_table_name('session'), $now, $now),
- $key, $vars, (string)$_SERVER['REMOTE_ADDR']);
+ $this->db->table_name('session'), $now, $now),
+ $key, base64_encode($vars), (string)$this->ip);
}
- $this->unsets = array();
return true;
}
- // handler for session_destroy()
- public function destroy($key)
+ /**
+ * 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;
+ }
+
+
+ /**
+ * Handler for session_destroy()
+ *
+ * @param string Session ID
+ * @return boolean True on success
+ */
+ public function db_destroy($key)
{
$this->db->query(
- sprintf("DELETE FROM %s WHERE sess_id = ?", get_table_name('session')),
+ sprintf("DELETE FROM %s WHERE sess_id = ?", $this->db->table_name('session')),
$key);
return true;
}
- // garbage collecting function
- public function gc($maxlifetime)
+ /**
+ * Garbage collecting function
+ *
+ * @param string Session lifetime in seconds
+ * @return boolean True on success
+ */
+ 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)));
+ $this->db->table_name('session'), $this->db->fromunixtime(time() - $maxlifetime)));
- foreach ($this->gc_handlers as $fct)
- $fct();
+ $this->gc();
return true;
}
- // registering additional garbage collector functions
- public function register_gc_handler($func_name)
+ /**
+ * Read session data from memcache
+ *
+ * @param string Session ID
+ * @return string Session vars
+ */
+ public function mc_read($key)
{
- if ($func_name && !in_array($func_name, $this->gc_handlers))
- $this->gc_handlers[] = $func_name;
- }
+ if ($value = $this->memcache->get($key)) {
+ $arr = unserialize($value);
+ $this->changed = $arr['changed'];
+ $this->ip = $arr['ip'];
+ $this->vars = $arr['vars'];
+ $this->key = $key;
-
- public function regenerate_id()
- {
- $randval = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
-
- for ($random = '', $i=1; $i <= 32; $i++) {
- $random .= substr($randval, mt_rand(0,(strlen($randval) - 1)), 1);
+ if (!empty($this->vars))
+ return $this->vars;
}
- // use md5 value for id or remove capitals from string $randval
- $random = md5($random);
+ return false;
+ }
- // delete old session record
- $this->destroy(session_id());
+ /**
+ * 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);
- session_id($random);
+ // 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);
- $cookie = session_get_cookie_params();
- $lifetime = $cookie['lifetime'] ? time() + $cookie['lifetime'] : 0;
+ $newvars = $oldvars !== false ? $this->_fixvars($vars, $oldvars) : $vars;
+
+ if ($newvars !== $oldvars || $ts - $this->changed > $this->lifetime / 2)
+ return $this->memcache->set($key, serialize(array('changed' => time(), 'ip' => $this->ip, 'vars' => $newvars)), MEMCACHE_COMPRESSED, $this->lifetime);
+
+ return true;
+ }
- rcmail::setcookie(session_name(), $random, $lifetime);
+ /**
+ * Handler for session_destroy() with memcache backend
+ *
+ * @param string Session ID
+ * @return boolean True on success
+ */
+ public function mc_destroy($key)
+ {
+ return $this->memcache->delete($key);
+ }
+
+
+ /**
+ * Execute registered garbage collector routines
+ */
+ public function gc()
+ {
+ foreach ($this->gc_handlers as $fct) {
+ call_user_func($fct);
+ }
+ }
+
+
+ /**
+ * Register additional garbage collector functions
+ *
+ * @param mixed Callback function
+ */
+ public function register_gc_handler($func)
+ {
+ foreach ($this->gc_handlers as $handler) {
+ if ($handler == $func) {
+ return;
+ }
+ }
+
+ $this->gc_handlers[] = $func;
+ }
+
+
+ /**
+ * Generate and set new session id
+ *
+ * @param boolean $destroy If enabled the current session will be destroyed
+ */
+ public function regenerate_id($destroy=true)
+ {
+ session_regenerate_id($destroy);
+
+ $this->vars = false;
+ $this->key = session_id();
return true;
}
- // unset session variable
- public function remove($var=NULL)
+ /**
+ * Unset a session variable
+ *
+ * @param string Varibale name
+ * @return boolean True on success
+ */
+ public function remove($var=null)
{
if (empty($var))
return $this->destroy(session_id());
@@ -204,9 +377,37 @@
return true;
}
+
+ /**
+ * Kill this session
+ */
+ public function kill()
+ {
+ $this->vars = false;
+ $this->ip = $_SERVER['REMOTE_ADDR']; // update IP (might have changed)
+ $this->destroy(session_id());
+ rcmail::setcookie($this->cookiename, '-del-', time() - 60);
+ }
- // serialize session data
+ /**
+ * Re-read session data from storage backend
+ */
+ public function reload()
+ {
+ if ($this->key && $this->memcache)
+ $data = $this->mc_read($this->key);
+ else if ($this->key)
+ $data = $this->db_read($this->key);
+
+ if ($data)
+ session_decode($data);
+ }
+
+
+ /**
+ * Serialize session data
+ */
private function serialize($vars)
{
$data = '';
@@ -219,8 +420,10 @@
}
- // unserialize session data
- // http://www.php.net/manual/en/function.session-decode.php#56106
+ /**
+ * Unserialize session data
+ * http://www.php.net/manual/en/function.session-decode.php#56106
+ */
private function unserialize($str)
{
$str = (string)$str;
@@ -305,26 +508,131 @@
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);
}
+ /**
+ * Getter for keep_alive interval
+ */
public function get_keep_alive()
{
return $this->keep_alive;
}
- // getter for private variables
- public function get_ts()
- {
- return $this->changed;
- }
-
- // getter for private variables
+ /**
+ * Getter for remote IP saved with this session
+ */
public function get_ip()
{
return $this->ip;
}
+
+ /**
+ * Setter for cookie encryption secret
+ */
+ function set_secret($secret)
+ {
+ $this->secret = $secret;
+ }
+
+
+ /**
+ * Enable/disable IP check
+ */
+ function set_ip_check($check)
+ {
+ $this->ip_check = $check;
+ }
+
+ /**
+ * Setter for the cookie name used for session cookie
+ */
+ function set_cookiename($cookiename)
+ {
+ if ($cookiename)
+ $this->cookiename = $cookiename;
+ }
+
+
+ /**
+ * Check session authentication cookie
+ *
+ * @return boolean True if valid, False if not
+ */
+ function check_auth()
+ {
+ $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) {
+ $this->set_auth_cookie();
+ }
+ else {
+ $result = false;
+ $this->log("Session authentication failed for " . $this->key . "; invalid auth cookie sent");
+ }
+ }
+
+ return $result;
+ }
+
+
+ /**
+ * Set session authentication cookie
+ */
+ function set_auth_cookie()
+ {
+ $this->cookie = $this->_mkcookie($this->now);
+ rcmail::setcookie($this->cookiename, $this->cookie, 0);
+ $_COOKIE[$this->cookiename] = $this->cookie;
+ }
+
+
+ /**
+ * Create session cookie from session data
+ *
+ * @param int Time slot to use
+ */
+ function _mkcookie($timeslot)
+ {
+ $auth_string = "$this->key,$this->secret,$timeslot";
+ return "S" . (function_exists('sha1') ? sha1($auth_string) : md5($auth_string));
+ }
+
+ /**
+ *
+ */
+ function log($line)
+ {
+ if ($this->logging)
+ rcmail::write_log('session', $line);
+ }
}
--
Gitblit v1.9.1