$checked => $exclude
[squirrelmail.git] / src / search.php
index 97eb545f60419238613c2972cb8ffe3205947964..16aa65ef5fc9ee924fac404354544ad36559e7a5 100644 (file)
@@ -3,27 +3,48 @@
 /**
  * search.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 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
+ * IMAP search page
+ *
+ * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @link http://www.ietf.org/rfc/rfc3501.txt
+ * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
  */
 
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
-/* SquirrelMail required files. */
+/** SquirrelMail required files. */
 require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'functions/strings.php');
 require_once(SM_PATH . 'functions/imap_asearch.php');
 require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'functions/strings.php');
+require_once(SM_PATH . 'functions/imap_messages.php');
+require_once(SM_PATH . 'functions/mime.php');
+require_once(SM_PATH . 'functions/mailbox_display.php');       //getButton()...
 
+/**
+ * @param string $a
+ * @param string $b
+ * @return bool strcoll()-like result
+ */
 function asearch_unhtml_strcoll($a, $b)
 {
        return strcoll(asearch_unhtmlentities($a), asearch_unhtmlentities($b));
 }
-        
+
+/**
+ * @param string $mailbox mailbox name
+ * @return string mailbox name ready to display
+ */
 function imap_get_mailbox_display($mailbox)
 {
        if (strtoupper($mailbox) == 'INBOX')
@@ -31,6 +52,10 @@ function imap_get_mailbox_display($mailbox)
        return imap_utf7_decode_local($mailbox);
 }
 
+/**
+ * @param string $mailbox mailbox name
+ * @return string mailbox name ready to display
+ */
 function asearch_get_mailbox_display($mailbox)
 {
        if ($mailbox == 'All Folders')
@@ -38,45 +63,83 @@ function asearch_get_mailbox_display($mailbox)
        return imap_get_mailbox_display($mailbox);
 }
 
+/**
+ * @param array $color color array
+ * @param string $txt text to display
+ * @return string title ready to display
+ */
 function asearch_get_title_display($color, $txt)
 {
        return '<b><big>' . $txt . '</big></b>';
 }
 
+/**
+ * @param array $color color array
+ * @param string $txt text to display
+ * @return string error text ready to display
+ */
 function asearch_get_error_display($color, $txt)
 {
        return '<font color="' . $color[2] . '">' . '<b><big>' . $txt . '</big></b></font>';
-/*return '<b><big>' . $txt . '</big></b>';*/
 }
 
+/**
+ * @param array $input_array array to serialize
+ * @return string a string containing a byte-stream representation of value that can be stored anywhere
+ */
 function asearch_serialize($input_array)
 {
-/*return $input_array[0];*/
        return serialize($input_array);
 }
 
+/**
+ * @param string $input_string string to unserialize
+ * @return array
+ */
 function asearch_unserialize($input_string)
 {
-/*return array($input_string);*/
        return unserialize($input_string);
 }
 
+/**
+ * @param string $data_dir prefs data dir or dsn
+ * @param string $username the username
+ * @param string $key the pref key
+ * @param integer $index the pref key index
+ * @param string $default default value
+ * @return string pref value
+ */
 function asearch_getPref($data_dir, $username, $key, $index, $default = '')
 {
        return getPref($data_dir, $username, $key . $index, $default);
 }
 
+/**
+ * @param string $data_dir prefs data dir or dsn
+ * @param string $username the username
+ * @param string $key the pref key
+ * @param integer $index the pref key index
+ * @param string $value pref value to set
+ * @return bool status
+ */
 function asearch_setPref($data_dir, $username, $key, $index, $value)
 {
        return setPref($data_dir, $username, $key . $index, $value);
 }
 
+/**
+ * @param string $data_dir prefs data dir or dsn
+ * @param string $username the username
+ * @param string $key the pref key
+ * @param integer $index the pref key index
+ * @return bool status
+ */
 function asearch_removePref($data_dir, $username, $key, $index)
 {
        return removePref($data_dir, $username, $key . $index);
 }
 
-/* sanity checks, done before running the imap command and before push_recent */
+/** Sanity checks, done before running the imap command and before push_recent */
 function asearch_check_query($where_array, $what_array, $exclude_array)
 {
        global $imap_asearch_opcodes;
@@ -94,7 +157,7 @@ function asearch_check_query($where_array, $what_array, $exclude_array)
        return '';
 }
 
-/* read the recent searches */
+/** Read the recent searches */
 function asearch_read_recent($data_dir, $username)
 {
        global $recent_prefkeys;
@@ -117,7 +180,7 @@ function asearch_read_recent($data_dir, $username)
        return $recent_array;
 }
 
-/* get the saved searches */
+/** Get the saved searches */
 function asearch_read_saved($data_dir, $username)
 {
        global $saved_prefkeys;
@@ -137,7 +200,7 @@ function asearch_read_saved($data_dir, $username)
        return $saved_array;
 }
 
-/* save a recent search */
+/** Save a recent search */
 function asearch_save_recent($data_dir, $username, $recent_index)
 {
        global $recent_prefkeys, $saved_prefkeys;
@@ -156,6 +219,7 @@ function asearch_save_recent($data_dir, $username, $recent_index)
        }
 }
 
+/** Write a recent search */
 function asearch_write_recent($data_dir, $username, $recent_array)
 {
        global $recent_prefkeys;
@@ -174,7 +238,7 @@ function asearch_write_recent($data_dir, $username, $recent_array)
        }
 }
 
-/* forget a recent search  */
+/** Forget a recent search  */
 function asearch_forget_recent($data_dir, $username, $forget_index)
 {
        global $recent_prefkeys;
@@ -186,7 +250,8 @@ 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)
+/** Find a recent search */
+function asearch_find_recent($recent_array, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 {
        global $recent_prefkeys;
 
@@ -196,6 +261,7 @@ function asearch_recent_exists($recent_array, $mailbox_array, $biop_array, $unop
        $where_string = asearch_serialize($where_array);
        $what_string = asearch_serialize($what_array);
        $exclude_string = asearch_serialize($exclude_array);
+       $sub_string = asearch_serialize($sub_array);
        $recent_count = count($recent_array[$recent_prefkeys[0]]);
        for ($recent_num=0; $recent_num<$recent_count; $recent_num++) {
                if (isset($recent_array[$recent_prefkeys[0]][$recent_num])) {
@@ -205,38 +271,46 @@ function asearch_recent_exists($recent_array, $mailbox_array, $biop_array, $unop
                                        $unop_string == $recent_array['asearch_recent_unop'][$recent_num] &&
                                        $where_string == $recent_array['asearch_recent_where'][$recent_num] &&
                                        $what_string == $recent_array['asearch_recent_what'][$recent_num] &&
-                                       $exclude_string == $recent_array['asearch_recent_exclude'][$recent_num]
+                                       $exclude_string == $recent_array['asearch_recent_exclude'][$recent_num] &&
+                                       $sub_string == $recent_array['asearch_recent_sub'][$recent_num]
                                        )
-                               return TRUE;
+                               return $recent_num;
                }
        }
-       return FALSE;
+       return -1;
 }
 
-/* push a recent search */
-function asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array)
+/** Push a recent search */
+function asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 {
        global $recent_prefkeys;
 
        $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, $sub_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, $sub_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);
        }
 }
 
-/* edit a recent search */
+/**
+ * Edit a recent search
+ * @global array mailbox_array searched mailboxes
+ */
 function asearch_edit_recent($data_dir, $username, $index)
 {
-       global $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array;
+       global $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array;
 
        $mailbox_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_recent_mailbox', $index));
        $biop_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_recent_biop', $index));
@@ -244,19 +318,20 @@ function asearch_edit_recent($data_dir, $username, $index)
        $where_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_recent_where', $index));
        $what_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_recent_what', $index));
        $exclude_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_recent_exclude', $index));
+       $sub_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_recent_sub', $index));
 }
 
-/* edit the last recent search if the prefs permit it */
+/** Edit the last recent search if the prefs permit it */
 function asearch_edit_last($data_dir, $username)
 {
        if (getPref($data_dir, $username, 'search_memory', 0) > 0)
                asearch_edit_recent($data_dir, $username, 0);
 }
 
-/* edit a saved search */
+/** Edit a saved search */
 function asearch_edit_saved($data_dir, $username, $index)
 {
-       global $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array;
+       global $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array;
 
        $mailbox_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_saved_mailbox', $index));
        $biop_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_saved_biop', $index));
@@ -264,8 +339,10 @@ function asearch_edit_saved($data_dir, $username, $index)
        $where_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_saved_where', $index));
        $what_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_saved_what', $index));
        $exclude_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_saved_exclude', $index));
+       $sub_array = asearch_unserialize(asearch_getPref($data_dir, $username, 'asearch_saved_sub', $index));
 }
 
+/** Write a saved searches */
 function asearch_write_saved($data_dir, $username, $saved_array)
 {
        global $saved_prefkeys;
@@ -281,7 +358,7 @@ function asearch_write_saved($data_dir, $username, $saved_array)
        }
 }
 
-/* delete a saved search  */
+/** Delete a saved search  */
 function asearch_delete_saved($data_dir, $username, $saved_index)
 {
        global $saved_prefkeys;
@@ -294,13 +371,13 @@ function asearch_delete_saved($data_dir, $username, $saved_index)
        asearch_write_saved($data_dir, $username, $saved_array);
 }
 
-/* translate the input date to imap date to local date display, so the user can know if the date is wrong or illegal */
+/** Translate the input date to imap date to local date display, so the user can know if the date is wrong or illegal */
 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
@@ -311,8 +388,8 @@ function asearch_get_date_display($what)
        return $what_display;
 }
 
-/* translate the query to rough natural display */
-function asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array)
+/** Translate the query to rough natural display */
+function asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 {
        global $imap_asearch_biops_in, $imap_asearch_biops, $imap_asearch_unops, $imap_asearch_options;
        global $imap_asearch_opcodes;
@@ -373,7 +450,7 @@ function asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_ar
        return $query_display;
 }
 
-/* Handle the alternate row colors */
+/** Handle the alternate row colors */
 function asearch_get_row_color($color, $row_num)
 {
 /*$color_string = ($row_num%2 ? $color[0] : $color[4]);*/
@@ -388,7 +465,7 @@ function asearch_get_row_color($color, $row_num)
        return $color_string;
 }
 
-/* Print a whole query array, recent or saved */
+/** Print a whole query array, recent or saved */
 function asearch_print_query_array($query_array, $query_keys, $action_array, $title)
 {
        global $color;
@@ -412,7 +489,8 @@ function asearch_print_query_array($query_array, $query_keys, $action_array, $ti
                        $where_array = $search_array[0];
                        $what_array = $search_array[2];
                        $exclude_array = $search_array[5];
-                       $query_display = asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array);
+                       $sub_array = $search_array[6];
+                       $query_display = asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
 
                        echo html_tag('td', $query_num+1, 'right');
                        echo html_tag('td', $query_display, 'center', '', 'width="80%"');
@@ -427,7 +505,7 @@ function asearch_print_query_array($query_array, $query_keys, $action_array, $ti
        echo '</table>' . "\n";
 }
 
-/* print the saved array */
+/** Print the saved array */
 function asearch_print_saved($data_dir, $username)
 {
        global $saved_prefkeys;
@@ -442,7 +520,7 @@ function asearch_print_saved($data_dir, $username)
        }
 }
 
-/* print the recent array */
+/** Print the recent array */
 function asearch_print_recent($data_dir, $username)
 {
        global $recent_prefkeys;
@@ -458,13 +536,13 @@ function asearch_print_recent($data_dir, $username)
        }
 }
 
-/* build an <option> statement */
+/** Build an <option> statement */
 function asearch_opt($val, $sel, $tit)
 {
-    return '<option value="' . $val . '"' . ($sel == $val ? ' selected' : '') . '>' . $tit . '</option>' . "\n";
+       return '<option value="' . $val . '"' . ($sel == $val ? ' selected' : '') . '>' . $tit . '</option>' . "\n";
 }
 
-/* build a <select> statement from an array */
+/** Build a <select> statement from an array */
 function asearch_opt_array($var_name, $opt_array, $cur_val)
 {
        $output = '<select name="' . $var_name . '">' . "\n";
@@ -474,6 +552,7 @@ function asearch_opt_array($var_name, $opt_array, $cur_val)
        return $output;
 }
 
+/** Verify that a mailbox exists */
 function asearch_mailbox_exists($mailbox, $boxes)
 {
        foreach ($boxes as $box) {
@@ -483,8 +562,8 @@ function asearch_mailbox_exists($mailbox, $boxes)
        return FALSE;
 }
 
-/* print one form row */
-function asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $row_num)
+/** Print one form row */
+function asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
 {
        global $imap_asearch_biops_in, $imap_asearch_unops, $imap_asearch_options;
        global $color;
@@ -505,35 +584,32 @@ function asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop,
                if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes)))
                        echo asearch_opt($mailbox, $mailbox, '[' . _("Missing") . '] ' . asearch_get_mailbox_display($mailbox));
                echo asearch_opt('All Folders', $mailbox, '[' . asearch_get_mailbox_display('All Folders') . ']');
-               echo sqimap_mailbox_option_list($imapConnection, array(strtolower($mailbox)), 0, $boxes);
-       echo '</select></td>' . "\n";
+               echo sqimap_mailbox_option_list($imapConnection, array(strtolower($mailbox)), 0, $boxes, NULL);
+       echo '</select>' . "\n";
+
+/* Include Subfolders */
+       echo _("and&nbsp;subfolders:") . 
+           addCheckBox('sub[' . $row_num .']', $sub) . '</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),
                'center');
 
 /* Text input */
-/* This is the original stuff. Except it doesn't work (eg commas are lost), why so much trouble?
-       $what_disp = str_replace(',', ' ', $what);
-       $what_disp = str_replace('\\\\', '\\', $what_disp);
-       $what_disp = str_replace('\\"', '"', $what_disp);
-       $what_disp = str_replace('"', '&quot;', $what_disp);*/
-       $what_disp = htmlspecialchars($what, ENT_QUOTES);
-       echo html_tag('td', '<input type="text" size="35" name="what[' . $row_num . ']" value="' . $what_disp . '">', 'center') . "\n";
+       echo html_tag('td', addInput('what['.$row_num.']', $what, '35'), 'center') . "\n";
 
 /* Exclude criteria */
        echo html_tag('td',
-               _("Exclude Criteria:") . '<input type=checkbox name="exclude[' . $row_num .']"' . ($exclude ? ' CHECKED' : '') . '>', 'center', '') . "\n";
+               _("Exclude Criteria:") . sm_print_r($exclude) . 
+               addCheckBox('exclude['.$row_num.']', $exclude), 'center', '') . "\n";
 
        echo "</tr>\n";
 }
 
-/* print the search form */
-function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $add_criteria)
+/** Print the search form */
+function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 {
        global $search_button_html, $add_criteria_button_html, $del_excluded_button_html, $del_all_button_html;
        global $color;
@@ -544,20 +620,16 @@ 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 = 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);
+               $sub = strip_tags(asearch_nz($sub_array[$row_num]));
+               asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
        }
        echo '</table>' . "\n";
 
@@ -573,24 +645,36 @@ function asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array
        echo '</form>' . "\n";
 }
 
-/* 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)
+/** Print the $msgs messages from $mailbox mailbox */
+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);
 
                $msg_cnt_str = get_msgcnt_str(1, $cnt, $cnt);
-               $toggle_all = get_selectall_link(1, $sort);
+               $paginator_str = '<b><big>' . _("Folder:") . ' '. $mailbox_display . '&nbsp;</big></b>';
 
-               echo '<table border="0" width="100%" cellpadding="0" cellspacing="0">';
+               echo '<br><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, NULL, $mailbox, $real_sort, $msg_cnt_str, $paginator_str, 1, 1);
                echo '</td></tr>';
 
                echo '<tr><td HEIGHT="5" BGCOLOR="'.$color[4].'"></td></tr>';  
@@ -601,8 +685,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>';
@@ -614,18 +698,31 @@ function asearch_print_mailbox_msgs($msgs, $mailbox, $cnt, $imapConnection, $whe
        }
 }                            
 
-/* ------------------------ main ------------------------ */
-global $allow_thread_sort;
+/**
+ * @param array $boxes mailboxes array (reference)
+ * @return array selectable unformatted mailboxes names
+ */
+function sqimap_asearch_get_selectable_unformatted_mailboxes(&$boxes)
+{
+       $mboxes_array = array();
+       $boxcount = count($boxes);
+       for ($boxnum=0; $boxnum<$boxcount; $boxnum++) {
+               if (!in_array('noselect', $boxes[$boxnum]['flags']))
+                       $mboxes_array[] = $boxes[$boxnum]['unformatted'];
+       }
+       return $mboxes_array;
+}
 
+/* ------------------------ main ------------------------ */
 /* get globals we may need */
 sqgetGlobalVar('username', $username, SQ_SESSION);
 sqgetGlobalVar('key', $key, SQ_COOKIE);
 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);   /* we really need this? */
 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION); /* do we really need this? */
 
-$recent_prefkeys = array('asearch_recent_where', 'asearch_recent_mailbox', 'asearch_recent_what', 'asearch_recent_biop', 'asearch_recent_unop', 'asearch_recent_exclude');
-$saved_prefkeys = array('asearch_saved_where', 'asearch_saved_mailbox', 'asearch_saved_what', 'asearch_saved_biop', 'asearch_saved_unop', 'asearch_saved_exclude');
-/*$asearch_keys = array('where', 'mailbox', 'what', 'biop', 'unop', 'exclude');*/
+$recent_prefkeys = array('asearch_recent_where', 'asearch_recent_mailbox', 'asearch_recent_what', 'asearch_recent_biop', 'asearch_recent_unop', 'asearch_recent_exclude', 'asearch_recent_sub');
+$saved_prefkeys = array('asearch_saved_where', 'asearch_saved_mailbox', 'asearch_saved_what', 'asearch_saved_biop', 'asearch_saved_unop', 'asearch_saved_exclude', 'asearch_saved_sub');
+/*$asearch_keys = array('where', 'mailbox', 'what', 'biop', 'unop', 'exclude', 'sub');*/
 
 $search_button_html = _("Search");
 $search_button_text = asearch_unhtmlentities($search_button_html);
@@ -691,26 +788,29 @@ $imap_asearch_biops = array(
        'OR' => _("Or")
 );
 
-/*
-       unset : Enter key, or called from outside (eg read_body)
-       $search_button_text : Search button
-       'Search_no_update' : Search but don't update recent
-       'Search_last' : Same as no_update but reload and search last
-       'Search_silent' : Same as no_update but only display results
-       $add_criteria_button_text : Add New Criteria button
-       $del_excluded_button_text : Remove Excluded Criteria button
-       $del_all_button_text : Remove All Criteria button
-       'save_recent'
-       'search_recent'
-       'forget_recent'
-       'edit_saved'
-       'search_saved'
-       'delete_saved'
-*/
+/** How we did enter the form
+ * - unset : Enter key, or called from outside (eg read_body)
+ * - $search_button_text : Search button
+ * - 'Search_no_update' : Search but don't update recent
+ * - 'Search_last' : Same as no_update but reload and search last
+ * - 'Search_silent' : Same as no_update but only display results
+ * - $add_criteria_button_text : Add New Criteria button
+ * - $del_excluded_button_text : Remove Excluded Criteria button
+ * - $del_all_button_text : Remove All Criteria button
+ * - 'save_recent'
+ * - 'search_recent'
+ * - 'forget_recent'
+ * - 'edit_saved'
+ * - 'search_saved'
+ * - 'delete_saved'
+ * @global string $submit
+ */
 if (isset($_GET['submit']))
        $submit = strip_tags($_GET['submit']);
 
-/* Used by search */
+/** Searched mailboxes
+ * @global array $mailbox_array
+ */
 if (isset($_GET['mailbox'])) {
        $mailbox_array = $_GET['mailbox'];
        if (!is_array($mailbox_array))
@@ -719,6 +819,9 @@ if (isset($_GET['mailbox'])) {
 else
        $mailbox_array = array();
 
+/** Binary operators
+ * @global array $biop_array
+ */
 if (isset($_GET['biop'])) {
        $biop_array = $_GET['biop'];
        if (!is_array($biop_array))
@@ -727,6 +830,9 @@ if (isset($_GET['biop'])) {
 else
        $biop_array = array();
 
+/** Unary operators
+ * @global array $unop_array
+ */
 if (isset($_GET['unop'])) {
        $unop_array = $_GET['unop'];
        if (!is_array($unop_array))
@@ -735,6 +841,9 @@ if (isset($_GET['unop'])) {
 else
        $unop_array = array();
 
+/** Where to search
+ * @global array $where_array
+ */
 if (isset($_GET['where'])) {
        $where_array = $_GET['where'];
        if (!is_array($where_array))
@@ -743,6 +852,9 @@ if (isset($_GET['where'])) {
 else
        $where_array = array();
 
+/** What to search
+ * @global array $what_array
+ */
 if (isset($_GET['what'])) {
        $what_array = $_GET['what'];
        if (!is_array($what_array))
@@ -751,18 +863,48 @@ if (isset($_GET['what'])) {
 else
        $what_array = array();
 
+/** Whether to exclude this criteria from search
+ * @global array $exclude_array
+ */
 if (isset($_GET['exclude']))
        $exclude_array = $_GET['exclude'];
 else
        $exclude_array = array();
 
-/* Used by recent and saved stuff */
-if (isset($_GET['rownum'])) {
+/** Search within subfolders
+ * @global array $sub_array
+ */
+if (isset($_GET['sub']))
+       $sub_array = $_GET['sub'];
+else
+       $sub_array = array();
+
+/** Row number used by recent and saved stuff
+ */
+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 */
 
+/** If TRUE, do not show search interface
+ * @global bool $search_silent
+ */
 $search_silent = FALSE;        /* Default is normal behaviour */
 
 /*  See how the page was called and fire off correct function  */
@@ -780,7 +922,7 @@ else {
        switch ($submit) {
                case $search_button_text:
                        if (asearch_check_query($where_array, $what_array, $exclude_array) == '')
-                               asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array);
+                               asearch_push_recent($data_dir, $username, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
                break;
                case 'Search_silent':
                        $search_silent = TRUE;
@@ -798,6 +940,7 @@ else {
                                array_splice($where_array, $delrow, 1);
                                array_splice($what_array, $delrow, 1);
 /*                     array_splice($exclude_array, $delrow, 1);*/     /* There is still some php magic that eludes me */
+                               array_splice($sub_array, $delrow, 1);
                        }
                        $exclude_array = array();
                break;
@@ -808,13 +951,16 @@ else {
                        $where_array = array();
                        $what_array = array();
                        $exclude_array = array();
+                       $sub_array = array();
                break;
                case 'save_recent':
                        asearch_save_recent($data_dir, $username, $submit_rownum);
                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, $sub_array);
+               break;
                case 'edit_recent':     /* no link to do this, yet */
                        asearch_edit_recent($data_dir, $username, $submit_rownum);
                break;
@@ -823,7 +969,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, $sub_array);
+               break;
                case 'edit_saved':
                        asearch_edit_saved($data_dir, $username, $submit_rownum);
                break;
@@ -837,12 +985,11 @@ else {
 $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 = 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($mailbox_array[0])) {
-    $mailbox = strip_tags($mailbox_array[0]);
-}
-if (empty($mailbox))
-       $mailbox = $boxes[0]['unformatted'];
 if (isset($composenew) && $composenew) {
        $comp_uri = "../src/compose.php?mailbox=" . urlencode($mailbox) .
                "&amp;session=$composesession&amp;attachedmessages=true&amp";
@@ -861,17 +1008,31 @@ 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)) {
+               global $sent_folder;
+
+               $mailbox_array[0] = $mailbox;
+               $biop_array[0] = '';
+               $unop_array[0] = '';
+               if ($mailbox == $sent_folder)
+                       $where_array[0] = 'TO';
+               else
+                       $where_array[0] = 'FROM';
+               $what_array[0] = '';
+               $exclude_array[0] = '';
+               $sub_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]);
+               $sub_array[] = asearch_nz($sub_array[$last_index]);
+       }
+       asearch_print_form($imapConnection, $boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
 }
 
 /*********************************************************************
@@ -880,42 +1041,31 @@ 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');
 
 if ($submit == $search_button_text) {
        echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
        echo html_tag('tr', html_tag('td', asearch_get_title_display($color, _("Search Results")), 'center', $color[5]));
-       echo html_tag('tr', html_tag('td', asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array), 'center', $color[4]));
-       echo '</table><br>' . "\n";
+       echo html_tag('tr', html_tag('td', asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array), 'center', $color[4]));
+       echo '</table>' . "\n";
+
+       flush();
 
        $query_error = asearch_check_query($where_array, $what_array, $exclude_array);
        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;
-               }
 
-               $boxcount = count($boxes);
-               for ($boxnum=0; $boxnum<$boxcount; $boxnum++) {
-                       if (!in_array('noselect', $boxes[$boxnum]['flags']))
-                               $mboxes_array[] = $boxes[$boxnum]['unformatted'];
-               }
+               // Disable thread sort for now if there is more than one mailbox or at least one 'All Folders'
+               global $allow_thread_sort;
+               $old_allow_thread_sort = $allow_thread_sort;
+               $allow_thread_sort = ((count(array_unique($mailbox_array)) <= 1) && (!in_array('All Folders', $mailbox_array)));
 
-               $mboxes_msgs = sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $mboxes_array);
+               $mboxes_array = sqimap_asearch_get_selectable_unformatted_mailboxes($boxes);
+               $mboxes_msgs = sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array, $mboxes_array);
                if (empty($mboxes_msgs))
                        echo '<br>' . html_tag('div', asearch_get_error_display($color, _("No Messages Found")), 'center') . "\n";
                else {
@@ -927,15 +1077,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>';