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 | 127 +++++++++++++++++++++++++----------------
1 files changed, 77 insertions(+), 50 deletions(-)
diff --git a/program/include/rcube_session.php b/program/include/rcube_session.php
index d3da36f..da221c3 100644
--- a/program/include/rcube_session.php
+++ b/program/include/rcube_session.php
@@ -5,8 +5,12 @@
| program/include/rcube_session.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2011, The Roundcube Dev Team |
- | Licensed under the GNU GPL |
+ | 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 |
@@ -42,6 +46,7 @@
private $prev;
private $secret = '';
private $ip_check = false;
+ private $logging = false;
private $keep_alive = 0;
private $memcache;
@@ -50,27 +55,20 @@
*/
public function __construct($db, $config)
{
- $this->db = $db;
- $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);
$lifetime = $config->get('session_lifetime', 1) * 60;
$this->set_lifetime($lifetime);
// use memcache backend
if ($config->get('session_storage', 'db') == 'memcache') {
- $this->memcache = new Memcache;
- $mc_available = 0;
- foreach ($config->get('memcache_hosts', array()) as $host) {
- list($host, $port) = explode(':', $host);
- if (!$port) $port = 11211;
- // add server and attempt to connect if not already done yet
- if ($this->memcache->addServer($host, $port) && !$mc_available)
- $mc_available += intval($this->memcache->connect($host, $port));
- }
+ $this->memcache = rcmail::get_instance()->get_memcache();
// set custom functions for PHP session management if memcache is available
- if ($mc_available) {
+ if ($this->memcache) {
session_set_save_handler(
array($this, 'open'),
array($this, 'close'),
@@ -80,7 +78,7 @@
array($this, 'gc'));
}
else {
- raise_error(array('code' => 604, 'type' => 'db',
+ rcube::raise_error(array('code' => 604, 'type' => 'db',
'line' => __LINE__, 'file' => __FILE__,
'message' => "Failed to connect to memcached. Please check configuration"),
true, true);
@@ -131,12 +129,11 @@
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'];
+ 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;
@@ -162,10 +159,15 @@
$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 && (!$this->vars || $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
+ }
+ else { // else read data again from DB
$oldvars = $this->db_read($key);
}
@@ -175,18 +177,18 @@
if ($newvars !== $oldvars) {
$this->db->query(
sprintf("UPDATE %s SET vars=?, changed=%s WHERE sess_id=?",
- get_table_name('session'), $now),
+ $this->db->table_name('session'), $now),
base64_encode($newvars), $key);
}
else if ($ts - $this->changed > $this->lifetime / 2) {
- $this->db->query("UPDATE ".get_table_name('session')." SET changed=$now WHERE sess_id=?", $key);
+ $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),
+ $this->db->table_name('session'), $now, $now),
$key, base64_encode($vars), (string)$this->ip);
}
@@ -199,8 +201,6 @@
*/
private function _fixvars($vars, $oldvars)
{
- $ts = microtime(true);
-
if ($oldvars !== false) {
$a_oldvars = $this->unserialize($oldvars);
if (is_array($a_oldvars)) {
@@ -228,7 +228,7 @@
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;
@@ -246,7 +246,7 @@
// 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)));
$this->gc();
@@ -288,8 +288,11 @@
{
$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.)
- if ($key == $this->key && (!$this->vars || $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
$oldvars = $this->mc_read($key);
@@ -319,20 +322,8 @@
*/
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']
- if ($_SESSION['compose']) {
- $_SESSION['compose_data'][$_SESSION['compose']['id']] = $_SESSION['compose'];
- $this->remove('compose');
+ foreach ($this->gc_handlers as $fct) {
+ call_user_func($fct);
}
}
@@ -342,10 +333,15 @@
*
* @param mixed Callback function
*/
- public function register_gc_handler($func_name)
+ public function register_gc_handler($func)
{
- if ($func_name && !in_array($func_name, $this->gc_handlers))
- $this->gc_handlers[] = $func_name;
+ foreach ($this->gc_handlers as $handler) {
+ if ($handler == $func) {
+ return;
+ }
+ }
+
+ $this->gc_handlers[] = $func;
}
@@ -388,8 +384,24 @@
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);
+ }
+
+
+ /**
+ * 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);
}
@@ -574,12 +586,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;
@@ -608,4 +626,13 @@
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