Ticket #1485012: previewnotread.r2682.patch

config/main.inc.php.dist

@@ -387 +387 @@
 // default setting if preview pane is enabled
 $rcmail_config['preview_pane'] = FALSE;
 
+// Preview pane mark as read
+$rcmail_config['preview_pane_mark_read'] = TRUE;
+
+// Preview pane mark as read delay (seconds)
+$rcmail_config['preview_pane_mark_read_delay'] = 0;
+
+// Message display mark as read
+$rcmail_config['message_view_mark_read'] = TRUE;
+
 // focus new window if new message arrives
 $rcmail_config['focus_on_new_message'] = true;
 

program/include/rcube_config.php

@@ -79 +79 @@
       foreach ($this->prop['default_imap_folders'] as $n => $folder)
         $this->prop['default_imap_folders'][$n] = rcube_charset_convert($folder, RCMAIL_CHARSET, 'UTF7-IMAP');
 
+    // fix default mark as read behaviour
+    if (empty($this->prop['preview_pane_mark_read'])) $this->prop['preview_pane_mark_read'] = TRUE;
+    if (empty($this->prop['preview_pane_mark_read_delay'])) $this->prop['preview_pane_mark_read_delay'] = 0;
+    if (empty($this->prop['message_view_mark_read'])) $this->prop['message_view_mark_read'] = TRUE;
+
     // set PHP error logging according to config
     if ($this->prop['debug_level'] & 1) {
       ini_set('log_errors', 1);

program/js/app.js

@@ -1249 +1249 @@
     if (this.preview_timer)
       clearTimeout(this.preview_timer);
     
+    if (this.preview_read_timer)
+      clearTimeout(this.preview_read_timer);
+
     // save folderlist and folders location/sizes for droptarget calculation in drag_move()
     if (this.gui_objects.folderlist && model)
       {
@@ -1414 +1417 @@
     if (this.preview_timer)
       clearTimeout(this.preview_timer);
 
+    if (this.preview_read_timer)
+      clearTimeout(this.preview_read_timer);
+
     var selected = list.selection.length==1;
 
     // Hide certain command buttons when Drafts folder is selected
@@ -1441 +1447 @@
       if (this.preview_timer)
         clearTimeout(this.preview_timer);
 
+      if (this.preview_read_timer)
+        clearTimeout(this.preview_read_timer);
+
     var uid = list.get_single_selection();
     if (uid && this.env.mailbox == this.env.drafts_mailbox)
       this.goto_url('compose', '_draft_uid='+uid+'&_mbox='+urlencode(this.env.mailbox), true);
@@ -1515 +1524 @@
       target.location.href = this.env.comm_path+url;
 
       // mark as read and change mbox unread counter
-      if (action == 'preview' && this.message_list && this.message_list.rows[id] && this.message_list.rows[id].unread)
+      if (action == 'preview' && this.message_list && this.message_list.rows[id] && this.message_list.rows[id].unread && this.env.preview_pane_mark_read)
         {
-        this.set_message(id, 'unread', false);
-        if (this.env.unread_counts[this.env.mailbox])
+          this.preview_read_timer = window.setTimeout(function(rcmail){
+          ref.set_message(id, 'unread', false);
+          if (ref.env.unread_counts[ref.env.mailbox])
           {
-          this.env.unread_counts[this.env.mailbox] -= 1;
-          this.set_unread_count(this.env.mailbox, this.env.unread_counts[this.env.mailbox], this.env.mailbox == 'INBOX');
+            ref.env.unread_counts[ref.env.mailbox] -= 1;
+            ref.set_unread_count(ref.env.mailbox, ref.env.unread_counts[ref.env.mailbox], ref.env.mailbox == 'INBOX');
           }
+          if (ref.env.preview_pane_mark_read_delay > 0) ref.toggle_read_status('read', Array(id));
+          }, this.env.preview_pane_mark_read_delay * 1000);
         }
       }
     };
@@ -3809 +3821 @@
       addrbook_show_images.disabled = !checkbox.checked;
     }
 
+  this.toggle_preview_pane = function(checkbox)
+    {
+    var preview_pane_mark_read;
+    if (preview_pane_mark_read = document.getElementById('rcmfd_preview_pane_mark_read'))
+      preview_pane_mark_read.disabled = !checkbox.checked;
+    }
+
+  this.toggle_preview_read = function(checkbox)
+    {
+    var preview_pane_mark_read_delay;
+    if (preview_pane_mark_read_delay = document.getElementById('rcmfd_preview_pane_mark_read_delay'))
+      preview_pane_mark_read_delay.disabled = !checkbox.checked;
+    }
+
   // display fetched raw headers
   this.set_headers = function(content)
   {

program/localization/en_US/labels.inc

@@ -329 +329 @@
 $labels['MB'] = 'MB';
 $labels['GB'] = 'GB';
 
+$labels['previewpanemarkread']  = 'Mark previewed messages as read';
+$labels['previewpanemarkreaddelay']  = 'Wait %s seconds before marking message as read';
+$labels['messageviewmarkread']  = 'Mark displayed messages as read';
+
 ?>

program/steps/mail/func.inc

@@ -96 +96 @@
   if ($CONFIG['skip_deleted'])
     $OUTPUT->set_env('skip_deleted', true);
           
+  if ($CONFIG['preview_pane_mark_read'])
+    $OUTPUT->set_env('preview_pane_mark_read', true);
+  if ($CONFIG['preview_pane_mark_read_delay'])
+    $OUTPUT->set_env('preview_pane_mark_read_delay', $CONFIG['preview_pane_mark_read_delay']);
+
   if ($CONFIG['trash_mbox'])
     $OUTPUT->set_env('trash_mailbox', $CONFIG['trash_mbox']);
   if ($CONFIG['drafts_mbox'])

program/steps/mail/show.inc

@@ -138 +138 @@
     }
 
   // mark message as read
-  if (!$MESSAGE->headers->seen) {
+  if (!$MESSAGE->headers->seen && (($RCMAIL->action == 'preview' && $CONFIG['preview_pane_mark_read'] && $CONFIG['preview_pane_mark_read_delay'] == 0) || ($RCMAIL->action == 'show' && $CONFIG['message_view_mark_read']))) {
     $IMAP->set_flag($MESSAGE->uid, 'SEEN');
     $RCMAIL->plugins->exec_hook('message_read', array('uid' => $MESSAGE->uid, 'mailbox' => $IMAP->mailbox, 'message' => $MESSAGE));
   }

program/steps/settings/func.inc

@@ -180 +180 @@
     // show config parameter for preview pane
     if (!isset($no_override['preview_pane'])) {
       $field_id = 'rcmfd_preview';
-      $input_preview = new html_checkbox(array('name' => '_preview_pane', 'id' => $field_id, 'value' => 1));
+      $input_preview = new html_checkbox(array('name' => '_preview_pane', 'id' => $field_id, 'value' => 1,
+        'onchange' => JS_OBJECT_NAME.'.toggle_preview_pane(this)'));
 
       $table->add('title', html::label($field_id, Q(rcube_label('previewpane'))));
       $table->add(null, $input_preview->show($config['preview_pane']?1:0));
     }
 
+    // show config parameter for preview pane auto mark as read
+    if (!isset($no_override['preview_pane_mark_read'])) {
+      $field_id = 'rcmfd_preview_pane_mark_read';
+      $input_preview = new html_checkbox(array('name' => '_preview_pane_mark_read', 'id' => $field_id,
+        'value' => 1,  'disabled' => $config['preview_pane']?0:1, 'onchange' => JS_OBJECT_NAME.'.toggle_preview_read(this)'));
+
+      $table->add('title', html::label($field_id, Q(rcube_label('previewpanemarkread'))));
+      $table->add(null, $input_preview->show($config['preview_pane_mark_read']?1:0));
+    }
+
+    // show config parameter for preview pane auto mark as read delay
+    if (!isset($no_override['preview_pane_mark_read_delay'])) {
+      $field_id = 'rcmfd_preview_pane_mark_read_delay';
+      $input_delay = new html_inputfield(array('name' => '_preview_pane_mark_read_delay', 'id' => $field_id, 'size' => 5,
+        'disabled' => $config['preview_pane_mark_read']?0:1));
+
+      $table->set_row_attribs('advanced');
+      $table->add(array('class' => 'title', 'colspan' => '2'), "    " . html::label($field_id, str_replace('%s', $input_delay->show($config['preview_pane_mark_read_delay']), Q(rcube_label('previewpanemarkreaddelay')))));
+      $table->add_row();
+    }
+
     if (!isset($no_override['mdn_requests'])) {
       $field_id = 'rcmfd_mdn_requests';
       $select_mdn_requests = new html_select(array('name' => '_mdn_requests', 'id' => $field_id));
@@ -229 +251 @@
   case 'mailview':
     $table = new html_table(array('cols' => 2));
 
+    // show config parameter for message view auto mark as read
+    if (!isset($no_override['message_view_mark_read'])) {
+      $field_id = 'rcmfd_message_view_mark_read';
+      $input_mark = new html_checkbox(array('name' => '_message_view_mark_read', 'id' => $field_id, 'value' => 1));
+
+      $table->add('title', html::label($field_id, Q(rcube_label('messageviewmarkread'))));
+      $table->add(null, $input_mark->show($config['message_view_mark_read']?1:0));
+    }
+
     // show checkbox for HTML/plaintext messages
     if (!isset($no_override['prefer_html'])) {
       $field_id = 'rcmfd_htmlmsg';

program/steps/settings/save_prefs.inc

@@ -29 +29 @@
   'htmleditor'   => isset($_POST['_htmleditor']) ? TRUE : FALSE,
   'inline_images'   => isset($_POST['_inline_images']) ? TRUE : FALSE,
   'preview_pane' => isset($_POST['_preview_pane']) ? TRUE : FALSE,
+  'preview_pane_mark_read' => isset($_POST['_preview_pane_mark_read']) ? TRUE : FALSE,
+  'preview_pane_mark_read_delay' => is_numeric($_POST['_preview_pane_mark_read_delay']) ? intval($_POST['_preview_pane_mark_read_delay']) : $CONFIG['preview_pane_mark_read_delay'],
+  'message_view_mark_read' => isset($_POST['_message_view_mark_read']) ? 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,