Mirrors/roundcubemail
2
0
Fork 0
mirror of https://github.com/roundcube/roundcubemail.git synced 2026-03-09 17:46:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

- Implemented 'storage_connected' API hook after successful IMAP login (#1490025)

Browse Source 
- Added config option 'imap_log_session' to enable Roundcube <-> IMAP session ID logging
- Added config option 'log_session_id' to control the lengh of the session identifer in logs
This commit is contained in:
Thomas Bruederli
2014-08-07 17:04:05 +02:00
parent 1db9a4931c
commit f954922c03
2 changed files with 42 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
program/lib/Roundcube/rcube.php
View File

@@ -389,8 +389,12 @@ class rcube
$this->storage->set_options($options);
$this->set_storage_prop();
}
// subscribe to 'storage_connected' hook for session logging
if ($this->config->get('imap_log_session', false)) {
$this->plugins->register_hook('storage_connected', array($this, 'storage_log_session'));
}
}
/**
* Set storage parameters.
@@ -457,6 +461,16 @@ class rcube
}
/**
* Callback for IMAP connection events to log session identifiers
*/
public function storage_log_session($args)
{
if (!empty($args['session']) && session_id()) {
$this->write_log('imap_session', $args['session']);
}
}
/**
* Create session object and start the session.
*/
@@ -1138,8 +1152,12 @@ class rcube
$line = var_export($line, true);
}
$date_format = self::$instance ? self::$instance->config->get('log_date_format') : null;
$log_driver = self::$instance ? self::$instance->config->get('log_driver') : null;
$date_format = $log_driver = $session_key = null;
if (self::$instance) {
$date_format = self::$instance->config->get('log_date_format');
$log_driver = self::$instance->config->get('log_driver');
$session_key = intval(self::$instance->config->get('log_session_id', 8));
}
if (empty($date_format)) {
$date_format = 'd-M-Y H:i:s O';
@@ -1158,8 +1176,8 @@ class rcube
}
// add session ID to the log
if ($sess = session_id()) {
$line = '<' . substr($sess, 0, 8) . '> ' . $line;
if ($session_key > 0 && ($sess = session_id())) {
$line = '<' . substr($sess, 0, $session_key) . '> ' . $line;
}
if ($log_driver == 'syslog') {

24
program/lib/Roundcube/rcube_imap.php
View File

@@ -56,6 +56,7 @@ class rcube_imap extends rcube_storage
*/
protected $icache = array();
protected $plugins;
protected $list_page = 1;
protected $delimiter;
protected $namespace;
@@ -82,6 +83,7 @@ class rcube_imap extends rcube_storage
public function __construct()
{
$this->conn = new rcube_imap_generic();
$this->plugins = rcube::get_instance()->plugins;
// Set namespace and delimiter from session,
// so some methods would work before connection
@@ -147,7 +149,7 @@ class rcube_imap extends rcube_storage
$attempt = 0;
do {
$data = rcube::get_instance()->plugins->exec_hook('storage_connect',
$data = $this->plugins->exec_hook('storage_connect',
array_merge($this->options, array('host' => $host, 'user' => $user,
'attempt' => ++$attempt)));
@@ -170,8 +172,20 @@ class rcube_imap extends rcube_storage
$this->connect_done = true;
if ($this->conn->connected()) {
// check for session identifier
$session = null;
if (preg_match('/\s+SESSIONID=([^=\s]+)/', $this->conn->result, $m)) {
$session = $m[1];
}
// get namespace and delimiter
$this->set_env();
// trigger post-connect hook
$this->plugins->exec_hook('storage_connected', array(
'host' => $host, 'user' => $user, 'session' => $session
));
return true;
}
// write error log
@@ -1506,7 +1520,7 @@ class rcube_imap extends rcube_storage
$folder = $this->folder;
}
$plugin = rcube::get_instance()->plugins->exec_hook('imap_search_before', array(
$plugin = $this->plugins->exec_hook('imap_search_before', array(
'folder' => $folder,
'search' => $search,
'charset' => $charset,
@@ -2501,7 +2515,7 @@ class rcube_imap extends rcube_storage
// increase messagecount of the target folder
$this->set_messagecount($folder, 'ALL', 1);
rcube::get_instance()->plugins->exec_hook('message_saved', array(
$this->plugins->exec_hook('message_saved', array(
'folder' => $folder,
'message' => $message,
'headers' => $headers,
@@ -2777,7 +2791,7 @@ class rcube_imap extends rcube_storage
}
// Give plugins a chance to provide a list of folders
$data = rcube::get_instance()->plugins->exec_hook('storage_folders',
$data = $this->plugins->exec_hook('storage_folders',
array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LSUB'));
if (isset($data['folders'])) {
@@ -2909,7 +2923,7 @@ class rcube_imap extends rcube_storage
}
// Give plugins a chance to provide a list of folders
$data = rcube::get_instance()->plugins->exec_hook('storage_folders',
$data = $this->plugins->exec_hook('storage_folders',
array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LIST'));
if (isset($data['folders'])) {