Fix sorting and paging in cross-folder searches

Thomas Bruederli

2014-01-16 2baeac116abef9d5bcb748c687577d16dce868a0

 program/steps/mail/list.inc

@@ -4,9 +4,12 @@
 +-----------------------------------------------------------------------+
 | program/steps/mail/list.inc                                           |
 |                                                                       |
 | This file is part of the RoundCube Webmail client                     |
 | Copyright (C) 2005, RoundCube Dev. - Switzerland                      |
 | Licensed under the GNU GPL                                            |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2005-2007, 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:                                                              |
 |   Send message list to client (as remote response)                    |
@@ -14,67 +17,134 @@
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+

 $Id$

*/

$REMOTE_REQUEST = TRUE;
$OUTPUT_TYPE = 'js';
if (!$OUTPUT->ajax_call) {
  return;
}

$sort = isset($_GET['_sort']) ? $_GET['_sort'] : false;
$save_arr      = array();
$dont_override = (array) $RCMAIL->config->get('dont_override');

// is there a sort type for this request?
if ($sort)
  {
if ($sort = rcube_utils::get_input_value('_sort', rcube_utils::INPUT_GET)) {
  // yes, so set the sort vars
  list($sort_col, $sort_order) = explode('_', $sort);

  // set session vars for sort (so next page and task switch know how to sort)
  $_SESSION['sort_col'] = $sort_col;
  $_SESSION['sort_order'] = $sort_order;
  if (!in_array('message_sort_col', $dont_override)) {
    $_SESSION['sort_col'] = $save_arr['message_sort_col'] = $sort_col;
  }
else
  {
  // use session settings if set, defaults if not
  $sort_col   = isset($_SESSION['sort_col'])   ? $_SESSION['sort_col']   : $CONFIG['message_sort_col'];
  $sort_order = isset($_SESSION['sort_order']) ? $_SESSION['sort_order'] : $CONFIG['message_sort_order'];
  if (!in_array('message_sort_order', $dont_override)) {
    $_SESSION['sort_order'] = $save_arr['message_sort_order'] = $sort_order;
  }
  
}

// we have a saved search request
if (!empty($_GET['_search']) && isset($_SESSION['search'][$_GET['_search']]))
  {
  $a_msgs = split(',', $_SESSION['search'][$_GET['_search']]);
  $a_headers = $IMAP->list_header_set($mbox, $a_msgs, NULL, $sort_col, $sort_order);
  $count = count($a_msgs);
// is there a set of columns for this request?
if ($cols = rcube_utils::get_input_value('_cols', rcube_utils::INPUT_GET)) {
  if (!in_array('list_cols', $dont_override)) {
    $save_arr['list_cols'] = explode(',', $cols);
  }
else
  {
  if ($count = $IMAP->messagecount())
    $a_headers = $IMAP->list_headers($mbox, NULL, $sort_col, $sort_order);
}

if (!empty($save_arr)) {
  $RCMAIL->user->save_prefs($save_arr);
}

$mbox_name = $RCMAIL->storage->get_folder();
$threading = (bool) $RCMAIL->storage->get_threading();

// Synchronize mailbox cache, handle flag changes
$RCMAIL->storage->folder_sync($mbox_name);

// initialize searching result if search_filter is used
if ($_SESSION['search_filter'] && $_SESSION['search_filter'] != 'ALL') {
  $search_request = md5($mbox_name.$_SESSION['search_filter']);
  $RCMAIL->storage->search($mbox_name, $_SESSION['search_filter'], RCUBE_CHARSET, rcmail_sort_column());
  $_SESSION['search'] = $RCMAIL->storage->get_search_set();
  $_SESSION['search_request'] = $search_request;
  $OUTPUT->set_env('search_request', $search_request);
}

// fetch message headers
if ($count = $RCMAIL->storage->count($mbox_name, $threading ? 'THREADS' : 'ALL', !empty($_REQUEST['_refresh'])))
  $a_headers = $RCMAIL->storage->list_messages($mbox_name, NULL, rcmail_sort_column(), rcmail_sort_order());

// update search set (possible change of threading mode)
if (!empty($_REQUEST['_search']) && isset($_SESSION['search'])
    && $_SESSION['search_request'] == $_REQUEST['_search']
) {
  $_SESSION['search'] = $RCMAIL->storage->get_search_set();

  // multi-folder search
  if ($_SESSION['search'][1]->multi) {
    if (empty($cols))
      $cols = $_SESSION['list_attrib']['columns'] ? $_SESSION['list_attrib']['columns'] : (array)$CONFIG['list_cols'];
    if (!in_array('folder', $cols))
      $cols[] = 'folder';  // Add 'folder' column to list

    // make message UIDs unique by appending the folder name
    foreach ($a_headers as $i => $header) {
      $header->uid .= '-'.$header->folder;
      $header->flags['skip_mbox_check'] = true;
      if ($header->parent_uid)
        $header->parent_uid .= '-'.$header->folder;
    }
  }
}
// remove old search data
else if (empty($_REQUEST['_search']) && isset($_SESSION['search'])) {
  $RCMAIL->session->remove('search');
}

$unseen = $IMAP->messagecount($mbox, 'UNSEEN', !empty($_GET['_refresh']) ? TRUE : FALSE);

// update message count display
$pages = ceil($count/$IMAP->page_size);
$commands = sprintf("this.set_env('messagecount', %d);\n", $count);
$commands .= sprintf("this.set_env('pagecount', %d);\n", $pages);
$commands .= sprintf("this.set_rowcount('%s');\n", rcmail_get_messagecount_text($count));
// empty result? we'll skip UNSEEN counting in rcmail_send_unread_count()
if (empty($search_request) && empty($a_headers)) {
    $unseen = 0;
}

// update mailboxlist
$mbox = $IMAP->get_mailbox_name();
$commands .= sprintf("this.set_unread_count('%s', %d);\n", addslashes($mbox), $unseen);
rcmail_send_unread_count($mbox_name, !empty($_REQUEST['_refresh']), $unseen);

// update message count display
$pages  = ceil($count/$RCMAIL->storage->get_pagesize());
$exists = $RCMAIL->storage->count($mbox_name, 'EXISTS');

$OUTPUT->set_env('messagecount', $count);
$OUTPUT->set_env('pagecount', $pages);
$OUTPUT->set_env('threading', $threading);
$OUTPUT->set_env('current_page', $count ? $RCMAIL->storage->get_page() : 1);
$OUTPUT->set_env('exists', $exists);
$OUTPUT->command('set_rowcount', rcmail_get_messagecount_text($count), $mbox_name);

// add message rows
if (isset($a_headers) && count($a_headers))
  $commands .= rcmail_js_message_list($a_headers);
rcmail_js_message_list($a_headers, FALSE, $cols);
if (isset($a_headers) && count($a_headers)) {
  if ($search_request) {
    $OUTPUT->show_message('searchsuccessful', 'confirmation', array('nr' => $count));
  }

  
  // remember last HIGHESTMODSEQ value (if supported)
  // we need it for flag updates in check-recent
  $data = $RCMAIL->storage->folder_data($mbox_name);
  if (!empty($data['HIGHESTMODSEQ'])) {
    $_SESSION['list_mod_seq'] = $data['HIGHESTMODSEQ'];
  }
}
else {
  // handle IMAP errors (e.g. #1486905)
  if ($err_code = $RCMAIL->storage->get_error_code()) {
    $RCMAIL->display_server_error();
  }
  else if ($search_request)
    $OUTPUT->show_message('searchnomatch', 'notice');
  else
    $OUTPUT->show_message('nomessagesfound', 'notice');
}

// set trash folder state
if ($mbox_name === $RCMAIL->config->get('trash_mbox')) {
    $OUTPUT->command('set_trash_count', $exists);
}

// send response
rcube_remote_response($commands);

exit;
?>
$OUTPUT->send();