From aa83596b0bec71af8d96ee346d7a625709bf0750 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sat, 10 Nov 2012 12:13:53 +0100 Subject: Clarify keep-alive setting, move it to User Interface section, change label to "Refresh (check for new messages, etc.)", allow no-refresh mode. --- program/steps/settings/func.inc | 35 ++++++++++++++++++----------------- program/steps/settings/save_prefs.inc | 28 +++++++++++++++------------- 2 files changed, 33 insertions(+), 30 deletions(-) (limited to 'program/steps') diff --git a/program/steps/settings/func.inc b/program/steps/settings/func.inc index 8bef2ff51..27e1e1346 100644 --- a/program/steps/settings/func.inc +++ b/program/steps/settings/func.inc @@ -237,6 +237,24 @@ function rcmail_user_prefs($current=null) ); } + if (!isset($no_override['keep_alive'])) { + $field_id = 'rcmfd_keep_alive'; + $select_keep_alive = new html_select(array('name' => '_keep_alive', 'id' => $field_id)); + + $select_keep_alive->add(rcube_label('never'), 0); + foreach (array(1, 3, 5, 10, 15, 30, 60) as $min) { + if (!$config['min_keep_alive'] || $config['min_keep_alive'] <= $min * 60) { + $label = rcube_label(array('name' => 'everynminutes', 'vars' => array('n' => $min))); + $select_keep_alive->add($label, $min); + } + } + + $blocks['main']['options']['keep_alive'] = array( + 'title' => html::label($field_id, Q(rcube_label('refreshinterval'))), + 'content' => $select_keep_alive->show($config['keep_alive']/60), + ); + } + // show drop-down for available skins if (!isset($no_override['skin'])) { $skins = rcmail_get_skins(); @@ -370,23 +388,6 @@ function rcmail_user_prefs($current=null) 'content' => $input_pagesize->show($size ? $size : 50), ); } - - if (!isset($no_override['keep_alive'])) { - $field_id = 'rcmfd_keep_alive'; - $select_keep_alive = new html_select(array('name' => '_keep_alive', 'id' => $field_id)); - - foreach(array(1, 3, 5, 10, 15, 30, 60) as $min) - if((!$config['min_keep_alive'] || $config['min_keep_alive'] <= $min * 60) - && (!$config['session_lifetime'] || $config['session_lifetime'] > $min)) { - $select_keep_alive->add(rcube_label(array('name' => 'everynminutes', 'vars' => array('n' => $min))), $min); - } - - $blocks['new_message']['options']['keep_alive'] = array( - 'title' => html::label($field_id, Q(rcube_label('keepalive'))), - 'content' => $select_keep_alive->show($config['keep_alive']/60), - ); - } - if (!isset($no_override['check_all_folders'])) { $field_id = 'rcmfd_check_all_folders'; $input_check_all = new html_checkbox(array('name' => '_check_all_folders', 'id' => $field_id, 'value' => 1)); diff --git a/program/steps/settings/save_prefs.inc b/program/steps/settings/save_prefs.inc index db7b134c4..2f22be7c4 100644 --- a/program/steps/settings/save_prefs.inc +++ b/program/steps/settings/save_prefs.inc @@ -33,7 +33,8 @@ switch ($CURR_SECTION) 'date_format' => isset($_POST['_date_format']) ? get_input_value('_date_format', RCUBE_INPUT_POST) : $CONFIG['date_format'], 'time_format' => isset($_POST['_time_format']) ? get_input_value('_time_format', RCUBE_INPUT_POST) : ($CONFIG['time_format'] ? $CONFIG['time_format'] : 'H:i'), 'prettydate' => isset($_POST['_pretty_date']) ? TRUE : FALSE, - 'skin' => isset($_POST['_skin']) ? get_input_value('_skin', RCUBE_INPUT_POST) : $CONFIG['skin'], + 'keep_alive' => isset($_POST['_keep_alive']) ? intval($_POST['_keep_alive'])*60 : $CONFIG['keep_alive'], + 'skin' => isset($_POST['_skin']) ? get_input_value('_skin', RCUBE_INPUT_POST) : $CONFIG['skin'], ); // compose derived date/time format strings @@ -50,7 +51,6 @@ switch ($CURR_SECTION) 'preview_pane_mark_read' => isset($_POST['_preview_pane_mark_read']) ? intval($_POST['_preview_pane_mark_read']) : $CONFIG['preview_pane_mark_read'], 'autoexpand_threads' => isset($_POST['_autoexpand_threads']) ? intval($_POST['_autoexpand_threads']) : 0, 'mdn_requests' => isset($_POST['_mdn_requests']) ? intval($_POST['_mdn_requests']) : 0, - 'keep_alive' => isset($_POST['_keep_alive']) ? intval($_POST['_keep_alive'])*60 : $CONFIG['keep_alive'], 'check_all_folders' => isset($_POST['_check_all_folders']) ? TRUE : FALSE, 'mail_pagesize' => is_numeric($_POST['_mail_pagesize']) ? max(2, intval($_POST['_mail_pagesize'])) : $CONFIG['mail_pagesize'], ); @@ -157,16 +157,16 @@ switch ($CURR_SECTION) $a_user_prefs['timezone'] = (string) $a_user_prefs['timezone']; - break; - case 'mailbox': - - // force keep_alive - if (isset($a_user_prefs['keep_alive'])) { - $a_user_prefs['keep_alive'] = max(60, $CONFIG['min_keep_alive'], $a_user_prefs['keep_alive']); - if (!empty($CONFIG['session_lifetime'])) - $a_user_prefs['keep_alive'] = min($CONFIG['session_lifetime']*60, $a_user_prefs['keep_alive']); + if (isset($a_user_prefs['keep_alive']) && !empty($CONFIG['min_keep_alive'])) { + if ($a_user_prefs['keep_alive'] > $CONFIG['min_keep_alive']) { + $a_user_prefs['keep_alive'] = $CONFIG['min_keep_alive']; + } } + break; + + case 'mailbox': + // force min size if ($a_user_prefs['mail_pagesize'] < 1) $a_user_prefs['mail_pagesize'] = 10; @@ -174,7 +174,8 @@ switch ($CURR_SECTION) if (isset($CONFIG['max_pagesize']) && ($a_user_prefs['mail_pagesize'] > $CONFIG['max_pagesize'])) $a_user_prefs['mail_pagesize'] = (int) $CONFIG['max_pagesize']; - break; + break; + case 'addressbook': // force min size @@ -184,7 +185,8 @@ switch ($CURR_SECTION) if (isset($CONFIG['max_pagesize']) && ($a_user_prefs['addressbook_pagesize'] > $CONFIG['max_pagesize'])) $a_user_prefs['addressbook_pagesize'] = (int) $CONFIG['max_pagesize']; - break; + break; + case 'folders': // special handling for 'default_folders' @@ -199,7 +201,7 @@ switch ($CURR_SECTION) } } - break; + break; } // Save preferences -- cgit v1.2.3 From 77de23fa939338546a3e049459ffd29edd9058c2 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Sun, 11 Nov 2012 10:32:05 +0100 Subject: Added cross-task 'refresh' request for system state updates --- CHANGELOG | 2 + index.php | 4 +- program/include/rcmail.php | 5 ++- program/js/app.js | 75 +++++++++++++++++++++++---------- program/localization/en_US/messages.inc | 1 + program/steps/mail/check_recent.inc | 10 +++-- program/steps/mail/func.inc | 1 + 7 files changed, 70 insertions(+), 28 deletions(-) (limited to 'program/steps') diff --git a/CHANGELOG b/CHANGELOG index 02fe0e2ce..dea6c1993 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,8 @@ CHANGELOG Roundcube Webmail =========================== +- Improved keep-alive action. Now the interval is based on session_lifetime +- Added cross-task 'refresh' request for system state updates - Fix AREA links handling (#1488792) - Better client-side timezone detection using the jsTimezoneDetect library (#1488725) - Fix possible HTTP DoS on error in keep-alive requests (#1488782) diff --git a/index.php b/index.php index 0ad371a4a..05fc641b5 100644 --- a/index.php +++ b/index.php @@ -249,7 +249,6 @@ $plugin = $RCMAIL->plugins->exec_hook('ready', array('task' => $RCMAIL->task, 'a $RCMAIL->set_task($plugin['task']); $RCMAIL->action = $plugin['action']; - // handle special actions if ($RCMAIL->action == 'keep-alive') { $OUTPUT->reset(); @@ -282,7 +281,8 @@ while ($redirects < 5) { else if (($stepfile = $RCMAIL->get_action_file()) && is_file($incfile = INSTALL_PATH . 'program/steps/'.$RCMAIL->task.'/'.$stepfile) ) { - include $incfile; + // include action file only once (in case it don't exit) + include_once $incfile; $redirects++; } else { diff --git a/program/include/rcmail.php b/program/include/rcmail.php index a755aa846..04b87e48c 100644 --- a/program/include/rcmail.php +++ b/program/include/rcmail.php @@ -332,7 +332,7 @@ class rcmail extends rcube $this->output->set_charset(RCMAIL_CHARSET); // add some basic labels to client - $this->output->add_label('loading', 'servererror', 'requesttimedout'); + $this->output->add_label('loading', 'servererror', 'requesttimedout', 'refreshing'); return $this->output; } @@ -770,6 +770,7 @@ class rcmail extends rcube } } + /** * Registers action aliases for current task * @@ -784,6 +785,7 @@ class rcmail extends rcube } } + /** * Returns current action filename * @@ -798,6 +800,7 @@ class rcmail extends rcube return strtr($this->action, '-', '_') . '.inc'; } + /** * Fixes some user preferences according to namespace handling change. * Old Roundcube versions were using folder names with removed namespace prefix. diff --git a/program/js/app.js b/program/js/app.js index f372c0f9e..25fddf10c 100644 --- a/program/js/app.js +++ b/program/js/app.js @@ -482,7 +482,8 @@ function rcube_webmail() this.onloads[i](); } - // start keep-alive interval + // start keep-alive and refresh intervals + this.start_refresh(); this.start_keepalive(); }; @@ -880,10 +881,6 @@ function rcube_webmail() this.show_message(this.env.first_uid); break; - case 'checkmail': - this.check_for_recent(true); - break; - case 'compose': url = {}; @@ -2061,6 +2058,15 @@ function rcube_webmail() } }; + // sends request to check for recent messages + this.checkmail = function() + { + var lock = this.set_busy(true, 'checkingmail'), + params = this.check_recent_params(); + + this.http_request('check-recent', params, lock); + }; + // list messages of a specific mailbox using filter this.filter_mailbox = function(filter) { @@ -6125,7 +6131,7 @@ function rcube_webmail() // trigger plugin hook var result = this.triggerEvent('request'+action, postdata); if (result !== undefined) { - // abort if one the handlers returned false + // abort if one of the handlers returned false if (result === false) return false; else @@ -6237,6 +6243,7 @@ function rcube_webmail() } break; + case 'refresh': case 'check-recent': case 'getunread': case 'search': @@ -6469,13 +6476,25 @@ function rcube_webmail() // starts interval for keep-alive signal this.start_keepalive = function() { - if (!this.env.session_lifetime || this.env.framed || this.task == 'login' || this.env.action == 'print') + if (!this.env.session_lifetime || this.env.framed || this.env.extwin || this.task == 'login' || this.env.action == 'print') return; - if (this._int) - clearInterval(this._int); + if (this._keepalive) + clearInterval(this._keepalive); - this._int = setInterval(function(){ ref.keep_alive(); }, this.env.session_lifetime * 0.5 * 1000); + this._keepalive = setInterval(function(){ ref.keep_alive(); }, this.env.session_lifetime * 0.5 * 1000); + }; + + // starts interval for refresh signal + this.start_refresh = function() + { + if (!this.env.keep_alive || this.env.framed || this.env.extwin || this.task == 'login' || this.env.action == 'print') + return; + + if (this._refresh) + clearInterval(this._refresh); + + this._refresh = setInterval(function(){ ref.refresh(); }, this.env.keep_alive * 1000); }; // sends keep-alive signal @@ -6485,27 +6504,39 @@ function rcube_webmail() this.http_request('keep-alive'); }; - // sends request to check for recent messages - this.check_for_recent = function(refresh) + // sends refresh signal + this.refresh = function() { - if (this.busy) + if (this.busy) { + // try again after 10 seconds + setTimeout(function(){ ref.refresh(); ref.start_refresh(); }, 10000); return; + } - var lock, url = {_mbox: this.env.mailbox}; + var params = {}, lock = this.set_busy(true, 'refreshing'); - if (refresh) { - lock = this.set_busy(true, 'checkingmail'); - url._refresh = 1; - } + if (this.task == 'mail' && this.gui_objects.mailboxlist) + params = this.check_recent_params(); + + // plugins should bind to 'requestrefresh' event to add own params + this.http_request('refresh', params, lock); + }; + // returns check-recent request parameters + this.check_recent_params = function() + { + var params = {_mbox: this.env.mailbox}; + + if (this.gui_objects.mailboxlist) + params._folderlist = 1; if (this.gui_objects.messagelist) - url._list = 1; + params._list = 1; if (this.gui_objects.quotadisplay) - url._quota = 1; + params._quota = 1; if (this.env.search_request) - url._search = this.env.search_request; + params._search = this.env.search_request; - this.http_request('check-recent', url, lock); + return params; }; diff --git a/program/localization/en_US/messages.inc b/program/localization/en_US/messages.inc index cabc9998b..a858d0acf 100644 --- a/program/localization/en_US/messages.inc +++ b/program/localization/en_US/messages.inc @@ -37,6 +37,7 @@ $messages['invalidhost'] = 'Invalid server name.'; $messages['nomessagesfound'] = 'No messages found in this mailbox.'; $messages['loggedout'] = 'You have successfully terminated the session. Good bye!'; $messages['mailboxempty'] = 'Mailbox is empty.'; +$messages['refreshing'] = 'Refreshing...'; $messages['loading'] = 'Loading...'; $messages['uploading'] = 'Uploading file...'; $messages['uploadingmany'] = 'Uploading files...'; diff --git a/program/steps/mail/check_recent.inc b/program/steps/mail/check_recent.inc index 1a1b08c60..90d17c15b 100644 --- a/program/steps/mail/check_recent.inc +++ b/program/steps/mail/check_recent.inc @@ -19,8 +19,14 @@ +-----------------------------------------------------------------------+ */ +// If there's no folder or messages list, there's nothing to update +// This can happen on 'refresh' request +if (empty($_REQUEST['_folderlist']) && empty($_REQUEST['_list'])) { + return; +} + $current = $RCMAIL->storage->get_folder(); -$check_all = !empty($_GET['_refresh']) || (bool)$RCMAIL->config->get('check_all_folders'); +$check_all = $RCMAIL->action != 'refresh' || (bool)$RCMAIL->config->get('check_all_folders'); // list of folders to check if ($check_all) { @@ -102,6 +108,4 @@ foreach ($a_mailboxes as $mbox_name) { } } -$RCMAIL->plugins->exec_hook('keep_alive', array()); - $OUTPUT->send(); diff --git a/program/steps/mail/func.inc b/program/steps/mail/func.inc index f128a3834..374ab7571 100644 --- a/program/steps/mail/func.inc +++ b/program/steps/mail/func.inc @@ -1810,6 +1810,7 @@ $OUTPUT->add_handlers(array( // register action aliases $RCMAIL->register_action_map(array( + 'refresh' => 'check_recent.inc', 'preview' => 'show.inc', 'print' => 'show.inc', 'moveto' => 'move_del.inc', -- cgit v1.2.3 From f226549d4f8f258deca9e165ef857252b79d2ee0 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Mon, 12 Nov 2012 14:50:49 +0100 Subject: Renamed config options: keep_alive to refresh_interval, min_keep_alive to min_refresh_interval --- CHANGELOG | 1 + config/main.inc.php.dist | 6 +++--- installer/rcube_install.php | 3 --- program/include/rcmail.php | 4 ++-- program/include/rcube_config.php | 2 ++ program/js/app.js | 5 ++--- program/steps/settings/func.inc | 16 ++++++++-------- program/steps/settings/save_prefs.inc | 8 ++++---- 8 files changed, 22 insertions(+), 23 deletions(-) (limited to 'program/steps') diff --git a/CHANGELOG b/CHANGELOG index 6c50340cc..d0473c675 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -3,6 +3,7 @@ CHANGELOG Roundcube Webmail - Improved keep-alive action. Now the interval is based on session_lifetime (#1488507) - Added cross-task 'refresh' request for system state updates (#1488507) +- Renamed config options: keep_alive to refresh_interval, min_keep_alive to min_refresh_interval - Fix AREA links handling (#1488792) - Better client-side timezone detection using the jsTimezoneDetect library (#1488725) - Fix possible HTTP DoS on error in keep-alive requests (#1488782) diff --git a/config/main.inc.php.dist b/config/main.inc.php.dist index 64312b6a9..1b7ae5a54 100644 --- a/config/main.inc.php.dist +++ b/config/main.inc.php.dist @@ -498,8 +498,8 @@ $rcmail_config['recipients_separator'] = ','; // don't let users set pagesize to more than this value if set $rcmail_config['max_pagesize'] = 200; -// Minimal value of user's 'keep_alive' setting (in seconds) -$rcmail_config['min_keep_alive'] = 60; +// Minimal value of user's 'refresh_interval' setting (in seconds) +$rcmail_config['min_refresh_interval'] = 60; // Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option. // By default refresh time is set to 1 second. You can set this value to true @@ -781,7 +781,7 @@ $rcmail_config['flag_for_deletion'] = false; // Default interval for auto-refresh requests (in seconds) // These are requests for system state updates e.g. checking for new messages, etc. // Setting it to 0 disables the feature. -$rcmail_config['keep_alive'] = 60; +$rcmail_config['refresh_interval'] = 60; // If true all folders will be checked for recent messages $rcmail_config['check_all_folders'] = false; diff --git a/installer/rcube_install.php b/installer/rcube_install.php index d1dce9d0e..06c57c0ac 100644 --- a/installer/rcube_install.php +++ b/installer/rcube_install.php @@ -342,9 +342,6 @@ class rcube_install } } - if ($current['keep_alive'] && $current['session_lifetime'] < $current['keep_alive']) - $current['session_lifetime'] = max(10, ceil($current['keep_alive'] / 60) * 2); - $this->config = array_merge($this->config, $current); foreach ((array)$current['ldap_public'] as $key => $values) { diff --git a/program/include/rcmail.php b/program/include/rcmail.php index 04b87e48c..99a68e81d 100644 --- a/program/include/rcmail.php +++ b/program/include/rcmail.php @@ -317,8 +317,8 @@ class rcmail extends rcube if (!($this->output instanceof rcube_output_html)) $this->output = new rcube_output_html($this->task, $framed); - // set keep-alive interval - $this->output->set_env('keep_alive', $this->config->get('keep_alive', 0)); + // set refresh interval + $this->output->set_env('refresh_interval', $this->config->get('refresh_interval', 0)); $this->output->set_env('session_lifetime', $this->config->get('session_lifetime', 0) * 60); if ($framed) { diff --git a/program/include/rcube_config.php b/program/include/rcube_config.php index 1f165ba4a..bbc3e9c6e 100644 --- a/program/include/rcube_config.php +++ b/program/include/rcube_config.php @@ -43,6 +43,8 @@ class rcube_config 'mail_pagesize' => 'pagesize', 'addressbook_pagesize' => 'pagesize', 'reply_mode' => 'top_posting', + 'refresh_interval' => 'keep_alive', + 'min_refresh_interval' => 'min_keep_alive', ); diff --git a/program/js/app.js b/program/js/app.js index 25fddf10c..fb9c299ec 100644 --- a/program/js/app.js +++ b/program/js/app.js @@ -44,7 +44,6 @@ function rcube_webmail() this.identifier_expr = new RegExp('[^0-9a-z\-_]', 'gi'); // default environment vars - this.env.keep_alive = 60; // seconds this.env.request_timeout = 180; // seconds this.env.draft_autosave = 0; // seconds this.env.comm_path = './'; @@ -6488,13 +6487,13 @@ function rcube_webmail() // starts interval for refresh signal this.start_refresh = function() { - if (!this.env.keep_alive || this.env.framed || this.env.extwin || this.task == 'login' || this.env.action == 'print') + if (!this.env.refresh_interval || this.env.framed || this.env.extwin || this.task == 'login' || this.env.action == 'print') return; if (this._refresh) clearInterval(this._refresh); - this._refresh = setInterval(function(){ ref.refresh(); }, this.env.keep_alive * 1000); + this._refresh = setInterval(function(){ ref.refresh(); }, this.env.refresh_interval * 1000); }; // sends keep-alive signal diff --git a/program/steps/settings/func.inc b/program/steps/settings/func.inc index 27e1e1346..876e02761 100644 --- a/program/steps/settings/func.inc +++ b/program/steps/settings/func.inc @@ -237,21 +237,21 @@ function rcmail_user_prefs($current=null) ); } - if (!isset($no_override['keep_alive'])) { - $field_id = 'rcmfd_keep_alive'; - $select_keep_alive = new html_select(array('name' => '_keep_alive', 'id' => $field_id)); + if (!isset($no_override['refresh_interval'])) { + $field_id = 'rcmfd_refresh_interval'; + $select_refresh_interval = new html_select(array('name' => '_refresh_interval', 'id' => $field_id)); - $select_keep_alive->add(rcube_label('never'), 0); + $select_refresh_interval->add(rcube_label('never'), 0); foreach (array(1, 3, 5, 10, 15, 30, 60) as $min) { - if (!$config['min_keep_alive'] || $config['min_keep_alive'] <= $min * 60) { + if (!$config['min_refresh_interval'] || $config['min_refresh_interval'] <= $min * 60) { $label = rcube_label(array('name' => 'everynminutes', 'vars' => array('n' => $min))); - $select_keep_alive->add($label, $min); + $select_refresh_interval->add($label, $min); } } - $blocks['main']['options']['keep_alive'] = array( + $blocks['main']['options']['refresh_interval'] = array( 'title' => html::label($field_id, Q(rcube_label('refreshinterval'))), - 'content' => $select_keep_alive->show($config['keep_alive']/60), + 'content' => $select_refresh_interval->show($config['refresh_interval']/60), ); } diff --git a/program/steps/settings/save_prefs.inc b/program/steps/settings/save_prefs.inc index 2f22be7c4..5daab0d24 100644 --- a/program/steps/settings/save_prefs.inc +++ b/program/steps/settings/save_prefs.inc @@ -33,7 +33,7 @@ switch ($CURR_SECTION) 'date_format' => isset($_POST['_date_format']) ? get_input_value('_date_format', RCUBE_INPUT_POST) : $CONFIG['date_format'], 'time_format' => isset($_POST['_time_format']) ? get_input_value('_time_format', RCUBE_INPUT_POST) : ($CONFIG['time_format'] ? $CONFIG['time_format'] : 'H:i'), 'prettydate' => isset($_POST['_pretty_date']) ? TRUE : FALSE, - 'keep_alive' => isset($_POST['_keep_alive']) ? intval($_POST['_keep_alive'])*60 : $CONFIG['keep_alive'], + 'refresh_interval' => isset($_POST['_refresh_interval']) ? intval($_POST['_refresh_interval'])*60 : $CONFIG['refresh_interval'], 'skin' => isset($_POST['_skin']) ? get_input_value('_skin', RCUBE_INPUT_POST) : $CONFIG['skin'], ); @@ -157,9 +157,9 @@ switch ($CURR_SECTION) $a_user_prefs['timezone'] = (string) $a_user_prefs['timezone']; - if (isset($a_user_prefs['keep_alive']) && !empty($CONFIG['min_keep_alive'])) { - if ($a_user_prefs['keep_alive'] > $CONFIG['min_keep_alive']) { - $a_user_prefs['keep_alive'] = $CONFIG['min_keep_alive']; + if (isset($a_user_prefs['refresh_interval']) && !empty($CONFIG['min_refresh_interval'])) { + if ($a_user_prefs['refresh_interval'] > $CONFIG['min_refresh_interval']) { + $a_user_prefs['refresh_interval'] = $CONFIG['min_refresh_interval']; } } -- cgit v1.2.3