From aa83596b0bec71af8d96ee346d7a625709bf0750 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sat, 10 Nov 2012 06:13:53 -0500
Subject: [PATCH] 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/save_prefs.inc |  269 ++++++++++++++++++++++++++++++++++++++---------------
 1 files changed, 191 insertions(+), 78 deletions(-)

diff --git a/program/steps/settings/save_prefs.inc b/program/steps/settings/save_prefs.inc
index 7444a8b..2f22be7 100644
--- a/program/steps/settings/save_prefs.inc
+++ b/program/steps/settings/save_prefs.inc
@@ -4,9 +4,12 @@
  +-----------------------------------------------------------------------+
  | program/steps/settings/save_prefs.inc                                 |
  |                                                                       |
- | This file is part of the RoundCube Webmail client                     |
- | Copyright (C) 2005-2007, RoundCube Dev. - Switzerland                 |
- | Licensed under the GNU GPL                                            |
+ | This file is part of the Roundcube Webmail client                     |
+ | Copyright (C) 2005-2009, The Roundcube Dev Team                       |
+ |                                                                       |
+ | 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:                                                              |
  |   Save user preferences to DB and to the current session              |
@@ -14,94 +17,204 @@
  +-----------------------------------------------------------------------+
  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
  +-----------------------------------------------------------------------+
-
- $Id$
-
 */
 
-// check request token and exit if invalid
-if (!$RCMAIL->check_request('save-prefs', RCUBE_INPUT_POST)) {
-  $OUTPUT->show_message('invalidrequest', 'error');
-  rcmail_overwrite_action('preferences');
-  return;
+$CURR_SECTION = get_input_value('_section', RCUBE_INPUT_POST);
+
+$a_user_prefs = array();
+
+// set options for specified section
+switch ($CURR_SECTION)
+{
+  case 'general':
+    $a_user_prefs = array(
+      'language'     => isset($_POST['_language']) ? get_input_value('_language', RCUBE_INPUT_POST) : $CONFIG['language'],
+      'timezone'     => isset($_POST['_timezone']) ? get_input_value('_timezone', RCUBE_INPUT_POST) : $CONFIG['timezone'],
+      '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'],
+      'skin'         => isset($_POST['_skin']) ? get_input_value('_skin', RCUBE_INPUT_POST) : $CONFIG['skin'],
+    );
+
+    // compose derived date/time format strings
+    if ((isset($_POST['_date_format']) || isset($_POST['_time_format'])) && $a_user_prefs['date_format'] && $a_user_prefs['time_format']) {
+      $a_user_prefs['date_short'] = 'D ' . $a_user_prefs['time_format'];
+      $a_user_prefs['date_long'] = $a_user_prefs['date_format'] . ' ' . $a_user_prefs['time_format'];
+    }
+
+  break;
+
+  case 'mailbox':
+    $a_user_prefs = array(
+      'preview_pane'         => isset($_POST['_preview_pane']) ? TRUE : FALSE,
+      '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,
+      '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'],
+    );
+
+  break;
+
+  case 'mailview':
+    $a_user_prefs = array(
+      'message_extwin'  => intval($_POST['_message_extwin']),
+      'prefer_html'     => isset($_POST['_prefer_html']) ? TRUE : FALSE,
+      'inline_images'   => isset($_POST['_inline_images']) ? TRUE : FALSE,
+      'show_images'     => isset($_POST['_show_images']) ? intval($_POST['_show_images']) : 0,
+      'display_next'    => isset($_POST['_display_next']) ? TRUE : FALSE,
+      'default_charset' => get_input_value('_default_charset', RCUBE_INPUT_POST),
+    );
+
+  break;
+
+  case 'compose':
+    $a_user_prefs = array(
+      'compose_extwin'     => intval($_POST['_compose_extwin']),
+      'htmleditor'         => intval($_POST['_htmleditor']),
+      'draft_autosave'     => isset($_POST['_draft_autosave']) ? intval($_POST['_draft_autosave']) : 0,
+      'mime_param_folding' => isset($_POST['_mime_param_folding']) ? intval($_POST['_mime_param_folding']) : 0,
+      'force_7bit'         => isset($_POST['_force_7bit']) ? TRUE : FALSE,
+      'mdn_default'        => isset($_POST['_mdn_default']) ? TRUE : FALSE,
+      'dsn_default'        => isset($_POST['_dsn_default']) ? TRUE : FALSE,
+      'reply_same_folder'  => isset($_POST['_reply_same_folder']) ? TRUE : FALSE,
+      'spellcheck_before_send' => isset($_POST['_spellcheck_before_send']) ? TRUE : FALSE,
+      'spellcheck_ignore_syms' => isset($_POST['_spellcheck_ignore_syms']) ? TRUE : FALSE,
+      'spellcheck_ignore_nums' => isset($_POST['_spellcheck_ignore_nums']) ? TRUE : FALSE,
+      'spellcheck_ignore_caps' => isset($_POST['_spellcheck_ignore_caps']) ? TRUE : FALSE,
+      'show_sig'           => isset($_POST['_show_sig']) ? intval($_POST['_show_sig']) : 1,
+      'reply_mode'         => isset($_POST['_reply_mode']) ? intval($_POST['_reply_mode']) : 0,
+      'strip_existing_sig' => isset($_POST['_strip_existing_sig']),
+      'sig_above'          => !empty($_POST['_sig_above']) && $_POST['_reply_mode'] > 0,
+      'default_font'       => get_input_value('_default_font', RCUBE_INPUT_POST),
+      'forward_attachment' => !empty($_POST['_forward_attachment']),
+    );
+
+  break;
+
+  case 'addressbook':
+    $a_user_prefs = array(
+      'default_addressbook'  => get_input_value('_default_addressbook', RCUBE_INPUT_POST, true),
+      'autocomplete_single'  => isset($_POST['_autocomplete_single']) ? TRUE : FALSE,
+      'addressbook_sort_col' => get_input_value('_addressbook_sort_col', RCUBE_INPUT_POST),
+      'addressbook_name_listing' => intval(get_input_value('_addressbook_name_listing', RCUBE_INPUT_POST)),
+      'addressbook_pagesize' => is_numeric($_POST['_addressbook_pagesize']) ? max(2, intval($_POST['_addressbook_pagesize'])) : $CONFIG['addressbook_pagesize'],
+    );
+
+  break;
+
+  case 'server':
+    $a_user_prefs = array(
+      'read_when_deleted' => isset($_POST['_read_when_deleted']) ? TRUE : FALSE,
+      'skip_deleted'      => isset($_POST['_skip_deleted']) ? TRUE : FALSE,
+      'flag_for_deletion' => isset($_POST['_flag_for_deletion']) ? TRUE : FALSE,
+      'delete_always' 	  => isset($_POST['_delete_always']) ? TRUE : FALSE,
+      'delete_junk' 	  => isset($_POST['_delete_junk']) ? TRUE : FALSE,
+      'logout_purge'      => isset($_POST['_logout_purge']) ? TRUE : FALSE,
+      'logout_expunge'    => isset($_POST['_logout_expunge']) ? TRUE : FALSE,
+    );
+
+  break;
+
+  case 'folders':
+    $a_user_prefs = array(
+      'drafts_mbox' => get_input_value('_drafts_mbox', RCUBE_INPUT_POST, true),
+      'sent_mbox'   => get_input_value('_sent_mbox', RCUBE_INPUT_POST, true),
+      'junk_mbox'   => get_input_value('_junk_mbox', RCUBE_INPUT_POST, true),
+      'trash_mbox'  => get_input_value('_trash_mbox', RCUBE_INPUT_POST, true),
+    );
+
+  break;
 }
 
-$a_user_prefs = array(
-  'language'     => isset($_POST['_language']) ? get_input_value('_language', RCUBE_INPUT_POST) : $CONFIG['language'],
-  'timezone'     => isset($_POST['_timezone']) ? (is_numeric($_POST['_timezone']) ? floatval($_POST['_timezone']) : get_input_value('_timezone', RCUBE_INPUT_POST)) : $CONFIG['timezone'],
-  'dst_active'   => isset($_POST['_dst_active']) ? TRUE : FALSE,
-  'pagesize'     => is_numeric($_POST['_pagesize']) ? max(2, intval($_POST['_pagesize'])) : $CONFIG['pagesize'],
-  'prettydate'   => isset($_POST['_pretty_date']) ? TRUE : FALSE,
-  'prefer_html'  => isset($_POST['_prefer_html']) ? TRUE : FALSE,
-  'htmleditor'   => isset($_POST['_htmleditor']) ? TRUE : FALSE,
-  'inline_images'   => isset($_POST['_inline_images']) ? TRUE : FALSE,
-  'preview_pane' => isset($_POST['_preview_pane']) ? TRUE : FALSE,
-  'focus_on_new_message' => isset($_POST['_focus_on_new_message']) ? TRUE : FALSE,
-  'read_when_deleted' => isset($_POST['_read_when_deleted']) ? TRUE : FALSE,
-  'skip_deleted' => isset($_POST['_skip_deleted']) ? TRUE : FALSE,
-  'flag_for_deletion' => isset($_POST['_flag_for_deletion']) ? TRUE : FALSE,
-  'logout_purge' => isset($_POST['_logout_purge']) ? TRUE : FALSE,
-  'logout_expunge' => isset($_POST['_logout_expunge']) ? TRUE : FALSE,
-  'draft_autosave' => isset($_POST['_draft_autosave']) ? intval($_POST['_draft_autosave']) : 0,
-  'show_images' => isset($_POST['_show_images']) ? intval($_POST['_show_images']) : 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,
-  'mime_param_folding' => isset($_POST['_mime_param_folding']) ? intval($_POST['_mime_param_folding']) : 0,
-  'mdn_requests' => isset($_POST['_mdn_requests']) ? intval($_POST['_mdn_requests']) : 0,
-  'skin' => isset($_POST['_skin']) ? get_input_value('_skin', RCUBE_INPUT_POST) : $CONFIG['skin'],
-  'drafts_mbox' => get_input_value('_drafts_mbox', RCUBE_INPUT_POST),
-  'sent_mbox' => get_input_value('_sent_mbox', RCUBE_INPUT_POST),
-  'junk_mbox' => get_input_value('_junk_mbox', RCUBE_INPUT_POST),
-  'trash_mbox' => get_input_value('_trash_mbox', RCUBE_INPUT_POST),
-  );
+$plugin = rcmail::get_instance()->plugins->exec_hook('preferences_save',
+  array('prefs' => $a_user_prefs, 'section' => $CURR_SECTION));
 
-$data  =  rcmail::get_instance()->plugins->exec_hook('save_preferences', array('prefs' => $a_user_prefs));
-$a_user_prefs = $data['prefs'];
+$a_user_prefs = $plugin['prefs'];
 
 // don't override these parameters
 foreach ((array)$CONFIG['dont_override'] as $p)
   $a_user_prefs[$p] = $CONFIG[$p];
 
-// special handling for 'default_imap_folders'
-if (in_array('default_imap_folders', (array)$CONFIG['dont_override'])) {
-  foreach (array('drafts_mbox','sent_mbox','junk_mbox','trash_mbox') as $p)
-    $a_user_prefs[$p] = $CONFIG[$p];
-}
-else {
-  $a_user_prefs['default_imap_folders'] = array('INBOX');
-  foreach (array('drafts_mbox','sent_mbox','junk_mbox','trash_mbox') as $p) {
-    if ($a_user_prefs[$p])
-      $a_user_prefs['default_imap_folders'][] = $a_user_prefs[$p];
-  }
+
+// verify some options
+switch ($CURR_SECTION)
+{
+  case 'general':
+
+    // switch UI language
+    if (isset($_POST['_language']) && $a_user_prefs['language'] != $_SESSION['language']) {
+      $RCMAIL->load_language($a_user_prefs['language']);
+      $OUTPUT->command('reload', 500);
+    }
+
+    // switch skin (if valid, otherwise unset the pref and fall back to default)
+    if (!$OUTPUT->set_skin($a_user_prefs['skin']))
+      unset($a_user_prefs['skin']);
+    else if ($RCMAIL->config->get('skin') != $a_user_prefs['skin'])
+      $OUTPUT->command('reload', 500);
+
+    $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'];
+      }
+    }
+
+    break;
+
+  case 'mailbox':
+
+    // force min size
+    if ($a_user_prefs['mail_pagesize'] < 1)
+      $a_user_prefs['mail_pagesize'] = 10;
+
+    if (isset($CONFIG['max_pagesize']) && ($a_user_prefs['mail_pagesize'] > $CONFIG['max_pagesize']))
+      $a_user_prefs['mail_pagesize'] = (int) $CONFIG['max_pagesize'];
+
+    break;
+
+  case 'addressbook':
+
+    // force min size
+    if ($a_user_prefs['addressbook_pagesize'] < 1)
+      $a_user_prefs['addressbook_pagesize'] = 10;
+
+    if (isset($CONFIG['max_pagesize']) && ($a_user_prefs['addressbook_pagesize'] > $CONFIG['max_pagesize']))
+      $a_user_prefs['addressbook_pagesize'] = (int) $CONFIG['max_pagesize'];
+
+    break;
+
+  case 'folders':
+
+    // special handling for 'default_folders'
+    if (in_array('default_folders', (array)$CONFIG['dont_override'])) {
+      foreach (array('drafts_mbox','sent_mbox','junk_mbox','trash_mbox') as $p)
+        $a_user_prefs[$p] = $CONFIG[$p];
+    } else {
+      $a_user_prefs['default_folders'] = array('INBOX');
+      foreach (array('drafts_mbox','sent_mbox','junk_mbox','trash_mbox') as $p) {
+        if ($a_user_prefs[$p])
+          $a_user_prefs['default_folders'][] = $a_user_prefs[$p];
+      }
+    }
+
+    break;
 }
 
-// switch UI language
-if (isset($_POST['_language'])) {
-  $RCMAIL->load_language($a_user_prefs['language']);
-}
+// Save preferences
+if (!$plugin['abort'])
+  $saved = $RCMAIL->user->save_prefs($a_user_prefs);
+else
+  $saved = $plugin['result'];
 
-// switch skin
-$OUTPUT->set_skin($a_user_prefs['skin']);
-
-// force min size
-if ($a_user_prefs['pagesize'] < 1)
-  $a_user_prefs['pagesize'] = 10;
-
-if (isset($CONFIG['max_pagesize']) && ($a_user_prefs['pagesize'] > $CONFIG['max_pagesize']))
-  $a_user_prefs['pagesize'] = (int) $CONFIG['max_pagesize'];
-
-// 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 ($USER->save_prefs($a_user_prefs))
+if ($saved)
   $OUTPUT->show_message('successfullysaved', 'confirmation');
+else
+  $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : 'errorsaving', 'error');
 
-// go to next step
-rcmail_overwrite_action('preferences');
+// display the form again
+rcmail_overwrite_action('edit-prefs');
 
-?>

--
Gitblit v1.9.1