Changeset 929a508 in github

Timestamp:

Mar 1, 2010 2:04:34 PM (3 years ago)

Author:

alecpl <alec@…>

Branches:

master, HEAD, courier-fix, dev-browser-capabilities, pdo, release-0.6, release-0.7, release-0.8

Children:

0c4d3fd

Parents:

a72ad65

Message:

• Improve performance by avoiding unnecessary updates to the session table (#1486325)

Files:

• CHANGELOG (modified) (1 diff)
• index.php (modified) (1 diff)
• plugins/managesieve/managesieve.php (modified) (2 diffs)
• plugins/new_user_dialog/new_user_dialog.php (modified) (1 diff)
• program/include/iniset.php (modified) (1 diff)
• program/include/main.inc (modified) (1 diff)
• program/include/rcmail.php (modified) (11 diffs)
• program/include/rcube_plugin_api.php (modified) (1 diff)
• program/include/rcube_session.php (added)
• program/include/rcube_template.php (modified) (1 diff)
• program/include/rcube_user.php (modified) (2 diffs)
• program/steps/mail/func.inc (modified) (1 diff)

CHANGELOG

@@ -2 +2 @@
 ===========================
 
+- Improve performance by avoiding unnecessary updates to the session table (#1486325)
 - Fix invalid font tags which cause HTML message rendering problems (#1486521)
 - Fix CVE-2010-0464: Disable DNS prefetching (#1486449)

index.php

@@ -97 +97 @@
         $RCMAIL->login($auth['user'], $auth['pass'], $auth['host'])) {
     // create new session ID
-    rcube_sess_unset('temp');
-    rcube_sess_regenerate_id();
+    $RCMAIL->session->remove('temp');
+    $RCMAIL->session->regenerate_id();
 
     // send auth cookie if necessary

plugins/managesieve/managesieve.php

@@ -222 +222 @@
           $this->rc->output->show_message('managesieve.setdeleted', 'confirmation');
           $this->rc->output->command('managesieve_reload');
-          rcube_sess_unset('managesieve_current');
+          $this->rc->session->remove('managesieve_current');
         } else {
           $this->rc->output->show_message('managesieve.setdeleteerror', 'error');
@@ -271 +271 @@
         $this->rc->output->show_message('managesieve.setcreated', 'confirmation');
         $this->rc->output->command('parent.managesieve_reload', $name);
-//      rcube_sess_unset('managesieve_current');
+//      $this->rc->session->remove('managesieve_current');
       } else {
         $this->rc->output->show_message($error, 'error');

plugins/new_user_dialog/new_user_dialog.php

@@ -99 +99 @@
     if (!empty($save_data['name']) && !empty($save_data['email'])) {
       $rcmail->user->update_identity($identity['identity_id'], $save_data);
-      rcube_sess_unset('plugin.newuserdialog');
+      $rcmail->session->remove('plugin.newuserdialog');
     }
     

program/include/iniset.php

@@ -53 +53 @@
 
 ini_set('error_reporting', E_ALL&~E_NOTICE);
-if (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') {
-   ini_set('session.cookie_secure', 1);
-} else {
-   ini_set('session.cookie_secure', 0);
-}
-ini_set('session.name', 'roundcube_sessid');
-ini_set('session.use_cookies', 1);
-ini_set('session.use_only_cookies', 1);
-ini_set('session.serialize_handler', 'php');
 
 // increase maximum execution time for php scripts

program/include/main.inc

@@ -1488 +1488 @@
   if ($port && $_SERVER['SERVER_PORT'] == $port)
     return true;
-  if ($use_https && $RCMAIL->config->get('use_https'))
+  if ($use_https && isset($RCMAIL) && $RCMAIL->config->get('use_https'))
     return true;
 
   return false;
+}
+
+// for backward compatibility
+function rcube_sess_unset($var_name=null)
+{
+  global $RCMAIL;
+
+  $RCMAIL->session->remove($var_name);
 }
 

program/include/rcmail.php

@@ -36 +36 @@
   public $user;
   public $db;
+  public $session;
   public $smtp;
   public $imap;
@@ -83 +84 @@
   private function startup()
   {
-    $config_all = $this->config->all();
-
     // initialize syslog
     if ($this->config->get('log_driver') == 'syslog') {
@@ -95 +94 @@
     $GLOBALS['DB'] = $this->get_dbh();
 
-    // use database for storing session data
-    include_once('include/session.inc');
-
-    // set session domain
-    if (!empty($config_all['session_domain'])) {
-      ini_set('session.cookie_domain', $config_all['session_domain']);
-    }
-    // set session garbage collecting time according to session_lifetime
-    if (!empty($config_all['session_lifetime'])) {
-      ini_set('session.gc_maxlifetime', ($config_all['session_lifetime']) * 120);
-    }
-
-    // start PHP session (if not in CLI mode)
-    if ($_SERVER['REMOTE_ADDR'])
-      session_start();
-
-    // set initial session vars
-    if (!isset($_SESSION['auth_time'])) {
-      $_SESSION['auth_time'] = time();
-      $_SESSION['temp'] = true;
-    }
+    // start session
+    $this->session_init();
 
     // create user object
     $this->set_user(new rcube_user($_SESSION['user_id']));
+
+    // configure session (after user config merge!)
+    $this->session_configure();
 
     // set task and action properties
@@ -126 +109 @@
     // reset some session parameters when changing task
     if ($_SESSION['task'] != $this->task)
-      rcube_sess_unset('page');
+      $this->session->remove('page');
 
     // set current task to session
@@ -133 +116 @@
     // init output class
     if (!empty($_REQUEST['_remote']))
-      $GLOBALS['OUTPUT'] = $this->init_json();
+      $GLOBALS['OUTPUT'] = $this->json_init();
     else
       $GLOBALS['OUTPUT'] = $this->load_gui(!empty($_REQUEST['_framed']));
@@ -315 +298 @@
 
     // set keep-alive/check-recent interval
-    if ($keep_alive = $this->config->get('keep_alive')) {
-      // be sure that it's less than session lifetime
-      if ($session_lifetime = $this->config->get('session_lifetime'))
-        $keep_alive = min($keep_alive, $session_lifetime * 60 - 30);
-      $this->output->set_env('keep_alive', max(60, $keep_alive));
+    if ($keep_alive = $this->session->get_keep_alive()) {
+      $this->output->set_env('keep_alive', $keep_alive);
     }
 
@@ -344 +324 @@
    * @return object rcube_json_output Reference to JSON output object
    */
-  public function init_json()
+  public function json_init()
   {
     if (!($this->output instanceof rcube_json_output))
@@ -441 +421 @@
 
     return $conn;
+  }
+
+
+  /**
+   * Create session object and start the session.
+   */
+  public function session_init()
+  {
+    $lifetime = $this->config->get('session_lifetime', 0) * 60;
+
+    // set session domain
+    if ($domain = $this->config->get('session_domain')) {
+      ini_set('session.cookie_domain', $domain);
+    }
+    // set session garbage collecting time according to session_lifetime
+    if ($lifetime) {
+      ini_set('session.gc_maxlifetime', $lifetime * 2);
+    }
+
+    ini_set('session.cookie_secure', rcube_https_check());
+    ini_set('session.name', 'roundcube_sessid');
+    ini_set('session.use_cookies', 1);
+    ini_set('session.use_only_cookies', 1);  
+    ini_set('session.serialize_handler', 'php');
+
+    // use database for storing session data
+    $this->session = new rcube_session($this->get_dbh(), $lifetime);
+
+    $this->session->register_gc_handler('rcmail_temp_gc');
+    if ($this->config->get('enable_caching'))
+      $this->session->register_gc_handler('rcmail_cache_gc');
+
+    // start PHP session (if not in CLI mode)
+    if ($_SERVER['REMOTE_ADDR'])
+      session_start();
+
+    // set initial session vars
+    if (!isset($_SESSION['auth_time'])) {
+      $_SESSION['auth_time'] = time();
+      $_SESSION['temp'] = true;
+    }
+  }
+
+
+  /**
+   * Configure session object internals
+   */
+  public function session_configure()
+  {
+    $lifetime = $this->config->get('session_lifetime', 0) * 60;
+
+    // set keep-alive/check-recent interval
+    if ($keep_alive = $this->config->get('keep_alive')) {
+      // be sure that it's less than session lifetime
+      if ($lifetime)
+        $keep_alive = min($keep_alive, $lifetime - 30);
+      $keep_alive = max(60, $keep_alive);
+      $this->session->set_keep_alive($keep_alive);
+    }
   }
 
@@ -795 +834 @@
   function authenticate_session()
   {
-    global $SESS_CLIENT_IP, $SESS_CHANGED;
-
     // advanced session authentication
     if ($this->config->get('double_auth')) {
@@ -811 +848 @@
     }
     else {
-      $valid = $this->config->get('ip_check') ? $_SERVER['REMOTE_ADDR'] == $SESS_CLIENT_IP : true;
+      $valid = $this->config->get('ip_check') ? $_SERVER['REMOTE_ADDR'] == $this->session->get_ip() : true;
     }
 
     // check session filetime
     $lifetime = $this->config->get('session_lifetime');
-    if (!empty($lifetime) && isset($SESS_CHANGED) && $SESS_CHANGED + $lifetime*60 < time()) {
+    $sess_ts = $this->session->get_ts();
+    if (!empty($lifetime) && !empty($sess_ts) && $sess_ts + $lifetime*60 < time()) {
       $valid = false;
     }
@@ -831 +869 @@
     $this->plugins->exec_hook('kill_session');
     
-    rcube_sess_unset();
+    $this->session->remove();
     $_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
     rcmail::setcookie('sessauth', '-del-', time() - 60);

program/include/rcube_plugin_api.php

@@ -70 +70 @@
    * Load and init all enabled plugins
    *
-   * This has to be done after rcmail::load_gui() or rcmail::init_json()
+   * This has to be done after rcmail::load_gui() or rcmail::json_init()
    * was called because plugins need to have access to rcmail->output
    */

program/include/rcube_template.php

@@ -987 +987 @@
         }
 
-        // get e-mail address form default identity
+        // get e-mail address from default identity
         if ($sql_arr = $this->app->user->get_identity()) {
             $username = $sql_arr['email'];

program/include/rcube_user.php

@@ -48 +48 @@
     if ($id && !$sql_arr)
     {
-      $sql_result = $this->db->query("SELECT * FROM ".get_table_name('users')." WHERE  user_id=?", $id);
+      $sql_result = $this->db->query("SELECT * FROM ".get_table_name('users')." WHERE user_id=?", $id);
       $sql_arr = $this->db->fetch_assoc($sql_result);
     }
@@ -155 +155 @@
     $sql_result = $this->db->query(
       "SELECT * FROM ".get_table_name('identities')."
-       WHERE  del<>1
-       AND    user_id=?
+       WHERE del<>1 AND user_id=?
        $sql_add
        ORDER BY ".$this->db->quoteIdentifier('standard')." DESC, name ASC, identity_id ASC",

program/steps/mail/func.inc

@@ -1326 +1326 @@
     return;
 
-  rcmail::get_instance()->plugins->exec_hook('cleanup_attachments',array());
-  
-  rcube_sess_unset('compose');
+  $rcmail = rcmail::get_instance();
+  $rcmail->plugins->exec_hook('cleanup_attachments',array());
+  $rcmail->session->remove('compose');
   }