- Make some methods public (#1488428)

alecpl

2012-04-14 9870dac30de1b8d1bdeab57af3eeb7c89b21ef76

 program/include/rcube_session.php

@@ -5,9 +5,12 @@
 | program/include/rcube_session.php                                     |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2011, The Roundcube Dev Team                       |
 | Copyright (C) 2005-2012, The Roundcube Dev Team                       |
 | Copyright (C) 2011, Kolab Systems AG                                  |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | 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                       |
@@ -52,9 +55,9 @@
   */
  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;
@@ -75,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);
@@ -126,10 +129,10 @@
  public function db_read($key)
  {
    $sql_result = $this->db->query(
      "SELECT vars, ip, changed FROM ".get_table_name('session')." WHERE sess_id = ?",
      $key);
      "SELECT vars, ip, changed FROM ".$this->db->table_name('session')
      ." WHERE sess_id = ?", $key);

    if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
    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']);
@@ -156,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);
    }

@@ -169,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);
    }

@@ -220,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;
@@ -238,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();

@@ -280,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);
@@ -311,20 +322,8 @@
   */
  public function gc()
  {
    foreach ($this->gc_handlers as $fct)
    foreach ($this->gc_handlers as $fct) {
      call_user_func($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');
    }
  }

@@ -334,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;
  }


@@ -380,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);
  }


@@ -605,14 +625,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);
      rcmail::write_log('session', $line);
  }

}