SORT and THREAD handling in search
[squirrelmail.git] / src / search.php
index 14c425e2b3a5d05959679b0080623eb88287ec09..5e63fe677f5634ca44a94e59d1ce5ad808e517d8 100644 (file)
@@ -6,10 +6,11 @@
  * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * Originally by Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
+ * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/** Path for SquirrelMail required files. */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
@@ -188,7 +189,7 @@ function asearch_forget_recent($data_dir, $username, $forget_index)
        asearch_write_recent($data_dir, $username, $recent_array);
 }
 
-function asearch_recent_exists($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array)
+function asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array)
 {
        global $recent_prefkeys;
 
@@ -209,10 +210,10 @@ function asearch_recent_exists($recent_array, $mailbox_array, $biop_array, $unop
                                        $what_string == $recent_array['asearch_recent_what'][$recent_num] &&
                                        $exclude_string == $recent_array['asearch_recent_exclude'][$recent_num]
                                        )
-                               return TRUE;
+                               return $recent_num;
                }
        }
-       return FALSE;
+       return -1;
 }
 
 /* push a recent search */
@@ -223,15 +224,19 @@ function asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array,
        $recent_max = getPref($data_dir, $username, 'search_memory', 0);
        if ($recent_max > 0) {
                $recent_array = asearch_read_recent($data_dir, $username);
-               if (!asearch_recent_exists($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array)) {
-                       $input = array($where_array, $mailbox_array, $what_array, $biop_array, $unop_array, $exclude_array);
-                       $i = 0;
+               $recent_found = asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array);
+               if ($recent_found >= 0) {       // Remove identical recent
                        foreach ($recent_prefkeys as $key) {
-                               array_unshift($recent_array[$key], asearch_serialize($input[$i]));
-                               $i++;
+                               array_splice($recent_array[$key], $recent_found, 1);
                        }
-                       asearch_write_recent($data_dir, $username, $recent_array);
-               }       
+               }
+               $input = array($where_array, $mailbox_array, $what_array, $biop_array, $unop_array, $exclude_array);
+               $i = 0;
+               foreach ($recent_prefkeys as $key) {
+                       array_unshift($recent_array[$key], asearch_serialize($input[$i]));
+                       $i++;
+               }
+               asearch_write_recent($data_dir, $username, $recent_array);
        }
 }
 
@@ -302,7 +307,7 @@ function asearch_get_date_display($what)
        $what_parts = sqimap_asearch_parse_date($what);
        if (count($what_parts) == 4) {
                if (checkdate($what_parts[2], $what_parts[1], $what_parts[3])) {
-                       $what_display = date_intl(_("M j, Y"),mktime(0,0,0,$what_parts[2],$what_parts[1],$what_parts[3]));
+                       $what_display = date_intl(_("M j, Y"), mktime(0,0,0,$what_parts[2],$what_parts[1],$what_parts[3]));
                        /*$what_display = $what_parts[1] . ' ' . getMonthName($what_parts[2]) . ' ' . $what_parts[3];*/
                }
                else
@@ -511,8 +516,6 @@ function asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop,
        echo '</select></td>' . "\n";
 
 /* Unary operator and Search location */
-       if (empty($where))
-               $where = 'FROM';
        echo html_tag('td',
                asearch_opt_array('unop[' . $row_num . ']', $imap_asearch_unops, $unop)
                . asearch_opt_array('where[' . $row_num . ']', $imap_asearch_options, $where),
@@ -535,7 +538,7 @@ function asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop,
 }
 
 /* print the search form */
-function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $add_criteria)
+function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array)
 {
        global $search_button_html, $add_criteria_button_html, $del_excluded_button_html, $del_all_button_html;
        global $color;
@@ -546,17 +549,12 @@ function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array
 
        echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="1" border="0"');
        echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Criteria")), 'center', $color[5], 'colspan=5'));
-       $row_count = count($where_array) + $add_criteria;
-       $mailbox = '';
+       $row_count = count($where_array);
        for ($row_num = 0; $row_num < $row_count; $row_num++) {
-               /* Keep the last non-empty mailbox as default choice */
-               if (strip_tags(asearch_nz($mailbox_array[$row_num])) != '')
-                       $mailbox = strip_tags($mailbox_array[$row_num]);
-               if ($mailbox == '')
-                       $mailbox = $boxes[0]['unformatted'];
+               $mailbox = asearch_nz($mailbox_array[$row_num]);
                $biop = strip_tags(asearch_nz($biop_array[$row_num]));
                $unop = strip_tags(asearch_nz($unop_array[$row_num]));
-               $where = asearch_nz($where_array[$row_num]);
+               $where = strip_tags(asearch_nz($where_array[$row_num]));
                $what = asearch_nz($what_array[$row_num]);
                $exclude = strip_tags(asearch_nz($exclude_array[$row_num]));
                asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $row_num);
@@ -577,22 +575,36 @@ function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array
 
 /* print the $msgs messages from $mailbox mailbox */
 /* this is almost the original code */
-function asearch_print_mailbox_msgs($msgs, $mailbox, $cnt, $imapConnection, $where, $what, $usecache = false, $newsort = false)
+function asearch_print_mailbox_msgs($imapConnection, $mailbox, $msgs, $cnt, $sort, $color, $where, $what)
 {
-       global $sort, $color;
-    
        if ($cnt > 0) {
-               $msort = calc_msort($msgs, $sort);
-               $showbox = asearch_get_mailbox_display($mailbox);
-               echo html_tag('div', '<b><big>' . _("Folder:") . ' '. $showbox.'</big></b>','center') . "\n";
+               global $allow_server_sort, $allow_thread_sort, $thread_sort_messages;
+
+               $thread_sort_messages = 0;
+               if ($allow_thread_sort) {
+                       global $data_dir, $username;
+                       $thread_sort_messages = getPref($data_dir, $username, 'thread_' . $mailbox);
+                       $msort = $msgs;
+                       $real_sort = 6;
+               }
+               elseif ($allow_server_sort) {
+                       $msort = $msgs;
+                       $real_sort = 6;
+               }
+               else {
+                       $msort = calc_msort($msgs, $sort);
+                       $real_sort = $sort;
+               }
+               $mailbox_display = asearch_get_mailbox_display($mailbox);
+               echo html_tag('div', '<b><big>' . _("Folder:") . ' '. $mailbox_display . '</big></b>','center') . "\n";
 
                $msg_cnt_str = get_msgcnt_str(1, $cnt, $cnt);
-               $toggle_all = get_selectall_link(1, $sort);
+               $toggle_all = get_selectall_link(1, $real_sort);
 
                echo '<table border="0" width="100%" cellpadding="0" cellspacing="0">';
 
                echo '<tr><td>';
-               mail_message_listing_beginning($imapConnection, $mailbox, $sort, $msg_cnt_str, $toggle_all, 1);
+               mail_message_listing_beginning($imapConnection, $mailbox, $real_sort, $msg_cnt_str, $toggle_all, 1);
                echo '</td></tr>';
 
                echo '<tr><td HEIGHT="5" BGCOLOR="'.$color[4].'"></td></tr>';  
@@ -603,8 +615,8 @@ function asearch_print_mailbox_msgs($msgs, $mailbox, $cnt, $imapConnection, $whe
 
                echo '       <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="'.$color[5].'">';
                echo '        <tr><td>';
-               printHeader($mailbox, 6, $color, false);
-               displayMessageArray($imapConnection, $cnt, 1, $msort, $mailbox, $sort, $color, $cnt, $where, $what);
+               printHeader($mailbox, $sort, $color, !$thread_sort_messages);
+               displayMessageArray($imapConnection, $cnt, 1, $msort, $mailbox, $real_sort, $color, $cnt, $where, $what);
                echo '        </td></tr>';
                echo '       </table>';
                echo '     </td></tr>';
@@ -617,8 +629,6 @@ function asearch_print_mailbox_msgs($msgs, $mailbox, $cnt, $imapConnection, $whe
 }                            
 
 /* ------------------------ main ------------------------ */
-global $allow_thread_sort;
-
 /* get globals we may need */
 sqgetGlobalVar('username', $username, SQ_SESSION);
 sqgetGlobalVar('key', $key, SQ_COOKIE);
@@ -759,8 +769,21 @@ else
        $exclude_array = array();
 
 /* Used by recent and saved stuff */
-if (isset($_GET['rownum'])) {
+if (isset($_GET['rownum']))
     $submit_rownum = strip_tags($_GET['rownum']);
+
+/* Change global sort */
+if (sqgetGlobalVar('newsort', $newsort, SQ_GET)) {
+       setPref($data_dir, $username, 'sort', $newsort);
+       $sort = $newsort;
+       sqsession_register($sort, 'sort');
+       asearch_edit_last($data_dir, $username);
+}
+
+/* Change mailbox threading */
+if (sqgetGlobalVar('set_thread', $set_thread, SQ_GET)) {
+       setPref($data_dir, $username, 'thread_' . $mailbox_array[0], ($set_thread == 1) ? 1 : 0 );
+       asearch_edit_last($data_dir, $username);
 }
 
 /* end of get globals */
@@ -816,7 +839,9 @@ else {
                break;
                case 'search_recent':
                        $submit = $search_button_text;
-               /*nobreak;*/
+                       asearch_edit_recent($data_dir, $username, $submit_rownum);
+                       asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array);
+               break;
                case 'edit_recent':     /* no link to do this, yet */
                        asearch_edit_recent($data_dir, $username, $submit_rownum);
                break;
@@ -825,7 +850,9 @@ else {
                break;
                case 'search_saved':
                        $submit = $search_button_text;
-               /*nobreak;*/
+                       asearch_edit_saved($data_dir, $username, $submit_rownum);
+                       asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array);
+               break;
                case 'edit_saved':
                        asearch_edit_saved($data_dir, $username, $submit_rownum);
                break;
@@ -840,11 +867,9 @@ $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0
 /* get mailbox names once here */
 $boxes = sqimap_mailbox_list($imapConnection);
 /* ensure we have a valid default mailbox name */
-$mailbox = strip_tags(asearch_nz($mailbox_array[0]));
-if (($mailbox == '') || ($mailbox == 'None'))  {       //Workaround for sm quirk IMHO (what if I really have a mailbox called None?)
-       $mailbox = $boxes[0]['unformatted'];
-       $mailbox_array[0] = $mailbox;
-}
+$mailbox = asearch_nz($mailbox_array[0]);
+if (($mailbox == '') || ($mailbox == 'None'))  //Workaround for sm quirk IMHO (what if I really have a mailbox called None?)
+       $mailbox = $boxes[0]['unformatted'];    //Usually INBOX ;)
 
 if (isset($composenew) && $composenew) {
        $comp_uri = "../src/compose.php?mailbox=" . urlencode($mailbox) .
@@ -864,17 +889,24 @@ if (!$search_silent) {
                                '', '', 'width="100%"') . "\n";
        asearch_print_saved($data_dir, $username);
        asearch_print_recent($data_dir, $username);
-       if (($submit == $add_criteria_button_text) || (empty($where_array)))
-               $new_row = 1;
-       else
-               $new_row = 0;
-       asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $new_row);
-}
-
-/* This deserves a comment, at least. What is it for exactly? */
-if (isset($newsort)) {
-    $sort = $newsort;
-    sqsession_register($sort, 'sort');
+       if (empty($where_array)) {
+               $mailbox_array[0] = $mailbox;
+               $biop_array[0] = '';
+               $unop_array[0] = '';
+               $where_array[0] = 'FROM';
+               $what_array[0] = '';
+               $exclude_array[0] = '';
+       }
+       if ($submit == $add_criteria_button_text) {
+               $last_index = max(count($where_array) - 1, 0);
+               $mailbox_array[] = asearch_nz($mailbox_array[$last_index]);
+               $biop_array[] = asearch_nz($biop_array[$last_index]);
+               $unop_array[] = asearch_nz($unop_array[$last_index]);
+               $where_array[] = asearch_nz($where_array[$last_index]);
+               $what_array[] = asearch_nz($what_array[$last_index]);
+               $exclude_array[] = asearch_nz($exclude_array[$last_index]);
+       }
+       asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array);
 }
 
 /*********************************************************************
@@ -883,16 +915,8 @@ if (isset($newsort)) {
  * used. Also check to make sure we actually have the array in the   *
  * registered session data.  :)                                      *
  *********************************************************************/
-if (! isset($use_mailbox_cache)) {
+if (!isset($use_mailbox_cache))
     $use_mailbox_cache = 0;
-}
-
-/* There is a problem with registered vars in 4.1 */
-/*
-if(substr(phpversion(), 0, 3) == '4.1') {
-    $use_mailbox_cache = FALSE;
-}
-*/
 
 do_hook('search_after_form');
 
@@ -906,11 +930,11 @@ if ($submit == $search_button_text) {
        if ($query_error != '')
                echo '<br>' . html_tag('div', asearch_get_error_display($color, $query_error), 'center') . "\n";
        else {
-               $old_allow_thread_sort = 0;
-               if ($allow_thread_sort == TRUE) {
-                       $old_allow_thread_sort = $allow_thread_sort;
-                       $allow_thread_sort = FALSE;
-               }
+
+               // Disable thread sort for now if there is more than one mailbox
+               global $allow_thread_sort;
+               $old_allow_thread_sort = $allow_thread_sort;
+               $allow_thread_sort = (count(array_unique($mailbox_array)) <= 1);
 
                $boxcount = count($boxes);
                for ($boxnum=0; $boxnum<$boxcount; $boxnum++) {
@@ -930,15 +954,14 @@ if ($submit == $search_button_text) {
                                        $what = asearch_serialize($what_array);*/
                                        $where = $where_array[0];
                                        $what = $what_array[0];
-                                       asearch_print_mailbox_msgs($msgs, $mailbox, count($msgs), $imapConnection, urlencode($where), urlencode($what), false, false);
+                                       asearch_print_mailbox_msgs($imapConnection, $mailbox, $msgs, count($msgs), $sort, $color, urlencode($where), urlencode($what));
                        }
                }
 
-               $allow_thread_sort = $old_allow_thread_sort;
+               $allow_thread_sort = $old_allow_thread_sort;    // Restore thread sort
        }
 }
 
-
 do_hook('search_bottom');
 sqimap_logout($imapConnection);
 echo '</body></html>';