Templating for searching email
[squirrelmail.git] / src / search.php
index a4862adb5292c737d755b702e078cf26c1611207..7e037d223a019898a7ca92f5ee249c599a410dc8 100644 (file)
@@ -3,35 +3,34 @@
 /**
  * search.php
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * IMAP search page
  *
  * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
  *
+ * @author Alex Lemaresquier - Brainstorm <alex at brainstorm.fr>
+ * @copyright &copy; 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
+ * @subpackage search
  * @link http://www.ietf.org/rfc/rfc3501.txt
- * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
+ * @todo explain why references are used in function calls
  */
 
 /**
- * Path for SquirrelMail required files.
- * @ignore
+ * Include the SquirrelMail initialization file.
  */
-define('SM_PATH','../');
+require('../include/init.php');
 
 /** SquirrelMail required files.
  */
-require_once(SM_PATH . 'include/validate.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/imap_messages.php');
+require_once(SM_PATH . 'functions/imap_general.php');
 require_once(SM_PATH . 'functions/mime.php');
-require_once(SM_PATH . 'functions/mailbox_display.php'); //getButton()...
-include_once(SM_PATH . 'class/template/template.class.php');
+require_once(SM_PATH . 'functions/mailbox_display.php'); //getButton()
+require_once(SM_PATH . 'functions/forms.php');
+require_once(SM_PATH . 'functions/date.php');
 
 /** Prefs array ordinals. Must match $recent_prefkeys and $saved_prefkeys
  */
@@ -48,95 +47,42 @@ define('ASEARCH_MAX', 7);
  */
 define('ASEARCH_CRITERIA', 'criteria');
 
-/** Builds a href with params
- * @param string $params optional parameters to GET
- */
-function asearch_get_href($params = '')
-{
-    $href = 'search.php';
-    if ($params != '')
-        $href .= '?' . $params;
-    return $href;
-}
-
-/** Builds a [link]
- * @param string $href (reference)
- * @param string $text
- * @param string $title
- */
-function asearch_get_link(&$href, $text, $title = '')
-{
-    if ($title != '')
-        $title = ' title="' . $title . '"';
-    return '<a href="' . $href . '"' . $title . '>' . $text . '</a>';
-}
-
-/** Builds a toggle [link]
- * @param integer $value
- * @param string $action
- * @param array $text_array
- * @param array $title_array
- */
-function asearch_get_toggle_link($value, $action, $text_array, $title_array = array())
-{
-    return asearch_get_link(asearch_get_href($action . '=' . (int)$value), $text_array[$value], asearch_nz($title_array[$value]));
-}
 
 /**
+ * Array sort callback used to sort $imap_asearch_options
  * @param string $a
  * @param string $b
  * @return bool strcoll()-like result
+ * @since 1.5.0
+ * @private
  */
 function asearch_unhtml_strcoll($a, $b)
 {
+    // FIXME: Translation policy says "no html entities in translations"
     return strcoll(asearch_unhtmlentities($a), asearch_unhtmlentities($b));
 }
 
-
-/**
- * @param string $mailbox mailbox name utf7 encoded inc. special case INBOX
- * @return string mailbox name ready to display (utf7 decoded or localized INBOX)
- */
-function imap_get_mailbox_display($mailbox)
-{
-    if (strtoupper($mailbox) == 'INBOX')
-        return _("INBOX");
-    return imap_utf7_decode_local($mailbox);
-}
-
 /**
  * @param string $mailbox mailbox name or special case 'All Folders'
  * @return string mailbox name ready to display (utf7 decoded or localized 'All Folders')
+ * @since 1.5.0
+ * @private
  */
 function asearch_get_mailbox_display($mailbox)
 {
-    if ($mailbox == 'All Folders')
+    if ($mailbox == 'All Folders') {
         return _("All Folders");
-    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>';
+    } elseif (strtoupper($mailbox) == 'INBOX') {
+        return _("INBOX");
+    }
+    return imap_utf7_decode_local($mailbox);
 }
 
 /**
  * @param array $input_array array to serialize
  * @return string a string containing a byte-stream representation of value that can be stored anywhere
+ * @since 1.5.0
+ * @private
  */
 function asearch_serialize(&$input_array)
 {
@@ -149,6 +95,8 @@ function asearch_serialize(&$input_array)
 /**
  * @param string $input_string string to unserialize
  * @return array
+ * @since 1.5.0
+ * @private
  */
 function asearch_unserialize($input_string)
 {
@@ -159,10 +107,15 @@ function asearch_unserialize($input_string)
 }
 
 /**
+ * Gets user's advanced search preferences
+ *
+ * Arguments are different in 1.5.0.
  * @param string $key the pref key
  * @param integer $index the pref key index
  * @param string $default default value
  * @return string pref value
+ * @since 1.5.0
+ * @private
  */
 function asearch_getPref(&$key, $index, $default = '')
 {
@@ -171,10 +124,15 @@ function asearch_getPref(&$key, $index, $default = '')
 }
 
 /**
+ * Sets user's advanced search preferences
+ *
+ * Arguments are different in 1.5.0.
  * @param string $key the pref key
  * @param integer $index the pref key index
  * @param string $value pref value to set
  * @return bool status
+ * @since 1.5.0
+ * @private
  */
 function asearch_setPref(&$key, $index, $value)
 {
@@ -183,9 +141,14 @@ function asearch_setPref(&$key, $index, $value)
 }
 
 /**
+ * Deletes user's advanced search preferences
+ *
+ * Arguments are different in 1.5.0.
  * @param string $key the pref key
  * @param integer $index the pref key index
  * @return bool status
+ * @since 1.5.0
+ * @private
  */
 function asearch_removePref(&$key, $index)
 {
@@ -193,7 +156,14 @@ function asearch_removePref(&$key, $index)
     return removePref($data_dir, $username, $key . ($index + !$search_advanced));
 }
 
-/** Sanity checks, done before running the imap command and before calling push_recent
+/**
+ * Sanity checks, done before running the imap command and before calling push_recent
+ * @param array $where_array search location data
+ * @param array $what_array search criteria data
+ * @param array $exclude_array excluded criteria data
+ * @return string error message or empty string
+ * @since 1.5.0
+ * @private
  */
 function asearch_check_query(&$where_array, &$what_array, &$exclude_array)
 {
@@ -212,7 +182,13 @@ function asearch_check_query(&$where_array, &$what_array, &$exclude_array)
     return '';
 }
 
-/** Read the recent searches from the prefs
+/**
+ * Read the recent searches from the prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @return array recent searches
+ * @since 1.5.0
+ * @private
  */
 function asearch_read_recent()
 {
@@ -238,7 +214,13 @@ function asearch_read_recent()
     return $recent_array;
 }
 
-/** Read the saved searches from the prefs
+/**
+ * Read the saved searches from the prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @return array saved searches
+ * @since 1.5.0
+ * @private
  */
 function asearch_read_saved()
 {
@@ -259,14 +241,24 @@ function asearch_read_saved()
     return $saved_array;
 }
 
-/** Save a recent search to the prefs
+/**
+ * Save a recent search to the prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @param integer $recent_index
+ * @since 1.5.0
+ * @private
  */
 function asearch_save_recent($recent_index)
 {
     global $recent_prefkeys, $saved_prefkeys;
 
     $saved_array = asearch_read_saved();
-    $saved_index = count($saved_array[$saved_prefkeys[0]]);
+    if (isset($saved_array[$saved_prefkeys[0]])) {
+        $saved_index = count($saved_array[$saved_prefkeys[0]]);
+    } else {
+        $saved_index = 0;
+    }
     $recent_array = asearch_read_recent();
     $n = 0;
     foreach ($recent_prefkeys as $key) {
@@ -279,7 +271,13 @@ function asearch_save_recent($recent_index)
     }
 }
 
-/** Write a recent search to prefs
+/**
+ * Write a recent search to prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @param array $recent_array
+ * @since 1.5.0
+ * @private
  */
 function asearch_write_recent(&$recent_array)
 {
@@ -298,7 +296,13 @@ function asearch_write_recent(&$recent_array)
     }
 }
 
-/** Remove a recent search from prefs
+/**
+ * Remove a recent search from prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @param integer $forget_index removed search number
+ * @since 1.5.0
+ * @private
  */
 function asearch_forget_recent($forget_index)
 {
@@ -311,7 +315,19 @@ function asearch_forget_recent($forget_index)
     asearch_write_recent($recent_array);
 }
 
-/** Find a recent search in the prefs (used to avoid saving duplicates)
+/**
+ * Find a recent search in the prefs (used to avoid saving duplicates)
+ * @param array $recent_array
+ * @param array $mailbox_array
+ * @param array $biop_array
+ * @param array $unop_array
+ * @param array $where_array
+ * @param array $what_array
+ * @param array $exclude_array
+ * @param array $sub_array
+ * @return integer
+ * @since 1.5.0
+ * @private
  */
 function asearch_find_recent(&$recent_array, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
 {
@@ -345,7 +361,18 @@ function asearch_find_recent(&$recent_array, &$mailbox_array, &$biop_array, &$un
     return -1;
 }
 
-/** Push a recent search into the prefs
+/**
+ * Push a recent search into the prefs
+ * @param array $recent_array
+ * @param array $mailbox_array
+ * @param array $biop_array
+ * @param array $unop_array
+ * @param array $where_array
+ * @param array $what_array
+ * @param array $exclude_array
+ * @param array $sub_array
+ * @since 1.5.0
+ * @private
  */
 function asearch_push_recent(&$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
 {
@@ -376,8 +403,14 @@ function asearch_push_recent(&$mailbox_array, &$biop_array, &$unop_array, &$wher
     }
 }
 
-/** Edit a recent search
+/**
+ * Edit a recent search
+ *
+ * Function arguments are different in 1.5.0
  * @global array mailbox_array searched mailboxes
+ * @param mixed $index
+ * @since 1.5.0
+ * @private
  */
 function asearch_edit_recent($index)
 {
@@ -396,8 +429,14 @@ function asearch_edit_recent($index)
     }
 }
 
-/** Get last search criteria from session or prefs
- * FIX ME, try to avoid globals
+/**
+ * Get last search criteria from session or prefs
+ *
+ * Function arguments are different in 1.5.0
+ * FIXME, try to avoid globals
+ * @param mixed $index
+ * @since 1.5.0
+ * @private
  */
 function asearch_edit_last($index) {
     if (sqGetGlobalVar(ASEARCH_CRITERIA, $criteria, SQ_SESSION)) {
@@ -420,7 +459,13 @@ function asearch_edit_last($index) {
     }
 }
 
-/** Edit a saved search
+/**
+ * Edit a saved search
+ *
+ * Function arguments are different in 1.5.0
+ * @param mixed $index
+ * @since 1.5.0
+ * @private
  */
 function asearch_edit_saved($index)
 {
@@ -439,7 +484,13 @@ function asearch_edit_saved($index)
     }
 }
 
-/** Write a saved search to the prefs
+/**
+ * Write a saved search to the prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @param array $saved_array
+ * @since 1.5.0
+ * @private
  */
 function asearch_write_saved(&$saved_array)
 {
@@ -456,7 +507,13 @@ function asearch_write_saved(&$saved_array)
     }
 }
 
-/** Delete a saved search from the prefs
+/**
+ * Delete a saved search from the prefs
+ *
+ * Function arguments are different in 1.5.0
+ * @param integer $saved_index
+ * @since 1.5.0
+ * @private
  */
 function asearch_delete_saved($saved_index)
 {
@@ -472,7 +529,10 @@ function asearch_delete_saved($saved_index)
 
 /** Translate the input date to imap date to local date display,
  * so the user can know if the date is wrong or illegal
+ * @param string $what date string
  * @return string locally formatted date or error text
+ * @since 1.5.0
+ * @private
  */
 function asearch_get_date_display(&$what)
 {
@@ -486,8 +546,19 @@ function asearch_get_date_display(&$what)
     return _("(Wrong date)");
 }
 
-/** Translate the query to rough natural display
+/**
+ * Translate the query to rough natural display
+ * @param array $color
+ * @param array $mailbox_array
+ * @param array $biop_array
+ * @param array $unop_array
+ * @param array $where_array
+ * @param array $what_array
+ * @param array $exclude_array
+ * @param array $sub_array
  * @return string rough natural query ready to display
+ * @since 1.5.0
+ * @private
  */
 function asearch_get_query_display(&$color, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array)
 {
@@ -505,7 +576,7 @@ function asearch_get_query_display(&$color, &$mailbox_array, &$biop_array, &$uno
                 $cur_mailbox = 'INBOX';
             $biop = asearch_nz($biop_array[$crit_num]);
             if (($query_display == '') || ($cur_mailbox != $last_mailbox)) {
-                $mailbox_display = ' <b>' . asearch_get_mailbox_display($cur_mailbox) . '</b>';
+                $mailbox_display = ' <span class="mailbox">' . htmlspecialchars(asearch_get_mailbox_display($cur_mailbox)) . '</span>';
                 if ($query_display == '')
                     $biop_display = _("In");
                 else
@@ -526,25 +597,25 @@ function asearch_get_query_display(&$color, &$mailbox_array, &$biop_array, &$uno
             $what = $what_array[$crit_num];
             if ($what_type) { /* Check opcode parameter */
                 if ($what == '')
-                    $what_display = ' ' . asearch_get_error_display($color, _("(Missing argument)"));
+                    $what_display = ' <span class="error">' . _("(Missing argument)") .'</span>';
                 else {
                     if ($what_type == 'adate')
                         $what_display = asearch_get_date_display($what);
                     else
                         $what_display = htmlspecialchars($what);
-                    $what_display = ' <b>' . $what_display . '</b>';
+                    $what_display = ' <span class="value">' . $what_display . '</span>';
                 }
             }
             else {
                 if ($what)
-                    $what_display = ' ' . asearch_get_error_display($color, _("(Spurious argument)"));
+                    $what_display = ' <span class="error">' . _("(Spurious argument)") .'</span>';
                 else
                     $what_display = '';
             }
             if ($mailbox_display != '')
-                $query_display .= ' <u><i>' . $biop_display . '</i></u>' . $mailbox_display . ' <u><i>' . $where_display . '</i></u>' . $what_display;
+                $query_display .= ' <span class="operator">' . $biop_display . '</span>' . $mailbox_display . ' <span class="conditions">' . $where_display . '</span>' . $what_display;
             else
-                $query_display .= ' <u><i>' . $biop_display . ' ' . $where_display . '</i></u>' . $what_display;
+                $query_display .= ' <span class="operator">' . $biop_display . '</span> <span class="conditions">' . $where_display . '</span>' . $what_display;
         }
     }
     return $query_display;
@@ -570,83 +641,72 @@ function getButton($type, $name, $value, $js = '', $enabled = TRUE) {
             '" style="padding: 0px; margin: 0px" />';
 }
 
-
-/** Handle the alternate row colors
- * @return string color value
- */
-function asearch_get_row_color(&$color, $row_num)
-{
-/*$color_string = ($row_num%2 ? $color[0] : $color[4]);*/
-    $color_string = $color[4];
-    if ($GLOBALS['alt_index_colors']) {
-        if (($row_num % 2) == 0) {
-            if (!isset($color[12]))
-                $color[12] = '#EAEAEA';
-            $color_string = $color[12];
-        }
-    }
-    return $color_string;
-}
-
-/** Print a whole query array, recent or saved
+/**
+ * Print a whole query array, recent or saved
+ *
+ * Function arguments are different in 1.5.0
+ * @param array $boxes (unused)
+ * @param array $query_array
+ * @param mixed $query_keys
+ * @param array $action_array
+ * @param mixed $title
+ * @param string $show_pref
+ * @since 1.5.0
+ * @private
  */
 function asearch_print_query_array(&$boxes, &$query_array, &$query_keys, &$action_array, $title, $show_pref)
 {
-    global $color;
     global $data_dir, $username;
-    global $use_icons, $icon_theme;
+    global $icon_theme_path;
+    global $oTemplate;
 
     $show_flag = getPref($data_dir, $username, $show_pref, 0) & 1;
-    $use_icons_flag = ($use_icons) && ($icon_theme != 'none');
-    if ($use_icons_flag)
-        $text_array = array('<img src="' . SM_PATH . 'images/minus.png" border="0" height="7" width="7" />',
-            '<img src="' . SM_PATH . 'images/plus.png" border="0" height="7" width="7" />');
-    else
-        $text_array = array('-', '+');
-    $toggle_link = asearch_get_toggle_link(!$show_flag, $show_pref, $text_array, array(_("Fold"), _("Unfold")));
-    if (!$use_icons_flag)
-        $toggle_link = '<small>[' . $toggle_link . ']</small>';
-
-    echo "<br />\n";
-    echo html_tag('table', '', 'center', $color[9], 'width="95%" cellpadding="1" cellspacing="1" border="0"');
-    echo html_tag('tr',
-        html_tag('td', $toggle_link, 'center', $color[5], 'width="5%"')
-        . html_tag('td', asearch_get_title_display($color, $title), 'center', $color[5], 'colspan=4'));
-    if ($show_flag) {
-        $main_key = $query_keys[ASEARCH_WHERE];
-        $query_count = count($query_array[$main_key]);
-        for ($query_num = 0, $row_num = 0; $query_num < $query_count; $query_num++) {
-            if (!empty($query_array[$main_key][$query_num])) {
-                echo html_tag('tr', '', '', asearch_get_row_color($color, $row_num));
-
-                unset($search_array);
-                foreach ($query_keys as $query_key) {
-                    $search_array[] = asearch_unserialize($query_array[$query_key][$query_num]);
-                }
-                $where_array = $search_array[ASEARCH_WHERE];
-                $mailbox_array = $search_array[ASEARCH_MAILBOX];
-                $what_array = $search_array[ASEARCH_WHAT];
-                $unop_array = $search_array[ASEARCH_UNOP];
-                $biop_array = asearch_nz($search_array[ASEARCH_BIOP], array());
-                $exclude_array = asearch_nz($search_array[ASEARCH_EXCLUDE], array());
-                $sub_array = asearch_nz($search_array[ASEARCH_SUB], array());
-                $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%"');
-                foreach ($action_array as $action => $action_display) {
-                    echo html_tag('td', '<a href="' . asearch_get_href('submit=' . $action . '&amp;rownum=' . $query_num) . '">' . $action_display . '</a>', 'center');
-                }
-
-                echo '</tr>' . "\n";
-                $row_num++;
+    $a = array();
+    $main_key = $query_keys[ASEARCH_WHERE];
+    $query_count = count($query_array[$main_key]);
+    for ($query_num = 0, $row_num = 0; $query_num < $query_count; $query_num++) {
+        if (!empty($query_array[$main_key][$query_num])) {
+            unset($search_array);
+            foreach ($query_keys as $query_key) {
+                $search_array[] = asearch_unserialize($query_array[$query_key][$query_num]);
             }
+            
+            $where_array = $search_array[ASEARCH_WHERE];
+            $mailbox_array = $search_array[ASEARCH_MAILBOX];
+            $what_array = $search_array[ASEARCH_WHAT];
+            $unop_array = $search_array[ASEARCH_UNOP];
+            $biop_array = asearch_nz($search_array[ASEARCH_BIOP], array());
+            $exclude_array = asearch_nz($search_array[ASEARCH_EXCLUDE], array());
+            $sub_array = asearch_nz($search_array[ASEARCH_SUB], array());
+            $query_display = asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array);
+            
+            $a[$query_num] = $query_display;
         }
     }
-    echo '</table>' . "\n";
+            
+    $oTemplate->assign('list_title', $title);
+    $oTemplate->assign('show_list', $show_flag==1);
+    $oTemplate->assign('is_recent_list', $title==_("Recent Searches"));
+    $oTemplate->assign('expand_collapse_toggle', '../src/search.php?'.$show_pref.'='.($show_flag==1 ? 0 : 1));
+    $oTemplate->assign('query_list', $a);
+    
+    $oTemplate->assign('save_recent', '../src/search.php?submit=save_recent&rownum=');
+    $oTemplate->assign('do_recent', '../src/search.php?submit=search_recent&rownum=');
+    $oTemplate->assign('forget_recent', '../src/search.php?submit=forget_recent&rownum=');
+    
+    $oTemplate->assign('edit_saved', '../src/search.php?submit=edit_saved&rownum=');
+    $oTemplate->assign('do_saved', '../src/search.php?submit=search_saved&rownum=');
+    $oTemplate->assign('delete_saved', '../src/search.php?submit=delete_saved&rownum=');
+    
+    $oTemplate->display('search_list.tpl');
 }
 
 /** Print the saved array
+ *
+ * Function arguments are different in 1.5.0
+ * @param array $boxes (unused, see asearch_print_query_array())
+ * @since 1.5.0
+ * @private
  */
 function asearch_print_saved(&$boxes)
 {
@@ -656,7 +716,7 @@ function asearch_print_saved(&$boxes)
     if (isset($saved_array[$saved_prefkeys[0]])) {
         $saved_count = count($saved_array[$saved_prefkeys[0]]);
         if ($saved_count > 0) {
-            $saved_actions = array('edit_saved' => _("edit"), 'search_saved' => _("search"), 'delete_saved' => _("delete"));
+            $saved_actions = array('edit_saved' => _("Edit"), 'search_saved' => _("Search"), 'delete_saved' => _("Delete"));
             asearch_print_query_array($boxes, $saved_array, $saved_prefkeys, $saved_actions, _("Saved Searches"), 'search_show_saved');
         }
     }
@@ -664,6 +724,11 @@ function asearch_print_saved(&$boxes)
 
 /**
  * Print the recent array
+ *
+ * Function arguments are different in 1.5.0
+ * @param array $boxes (unused, see asearch_print_query_array())
+ * @since 1.5.0
+ * @private
  */
 function asearch_print_recent(&$boxes)
 {
@@ -679,26 +744,13 @@ function asearch_print_recent(&$boxes)
     }
 }
 
-/** Build an <option> statement
- */
-function asearch_opt($val, $sel, $tit)
-{
-    return '<option value="' . $val . '"' . ($sel == $val ? ' selected="selected"' : '') . '>' . $tit . '</option>' . "\n";
-}
-
-/** Build a <select> statement from an array
- */
-function asearch_opt_array($var_name, $opt_array, $cur_val)
-{
-    $output = '<select name="' . $var_name . '">' . "\n";
-    foreach($opt_array as $val => $display)
-        $output .= asearch_opt($val, $cur_val, asearch_nz($display, $val));
-    $output .= '</select>' . "\n";
-    return $output;
-}
-
 /** Verify that a mailbox exists
+ * @param string $mailbox
+ * @param array $boxes
  * @return bool mailbox exists
+ * @deprecated FIXME use standard functions
+ * @since 1.5.0
+ * @private
  */
 function asearch_mailbox_exists($mailbox, &$boxes)
 {
@@ -709,180 +761,138 @@ function asearch_mailbox_exists($mailbox, &$boxes)
     return FALSE;
 }
 
-/** Build the mailbox select
- */
-function asearch_get_form_mailbox($imapConnection, &$boxes, $mailbox, $row_num = 0)
-{
-    if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes))) {
-        $missing = asearch_opt($mailbox, $mailbox, '[' . _("Missing") . '] ' . asearch_get_mailbox_display($mailbox));
-    } else {
-        $missing = '';
-    }
-    return '<select name="mailbox[' . $row_num . ']">'
-        . $missing
-        . asearch_opt('All Folders', $mailbox, '[' . asearch_get_mailbox_display('All Folders') . ']')
-        . sqimap_mailbox_option_list($imapConnection, array(strtolower($mailbox)), 0, $boxes, NULL)
-        . '</select>';
-}
-
-/** Build the Include subfolders checkbox
- */
-function asearch_get_form_sub($sub, $row_num = 0)
-{
-    return function_exists('addCheckBox') ? addCheckBox('sub[' . $row_num .']', $sub)
-    : '<input type="checkbox" name="sub[' . $row_num .']"' . ($sub ? ' checked="checked"' : '') . ' />';
-}
-
-/** Build the 2 unop and where selects
- */
-function asearch_get_form_location($unop, $where, $row_num = 0)
-{
-    global $imap_asearch_unops, $imap_asearch_options;
-
-    return asearch_opt_array('unop[' . $row_num . ']', $imap_asearch_unops, $unop)
-        . asearch_opt_array('where[' . $row_num . ']', $imap_asearch_options, $where);
-}
-
-/** Build the what text input
- */
-function asearch_get_form_what($what, $row_num = 0)
-{
-    return function_exists('addInput') ? addInput('what[' . $row_num . ']', $what, '35')
-    : '<input type="text" size="35" name="what[' . $row_num . ']" value="' . htmlspecialchars($what) . '" />';
-}
-
-/** Build the Exclude criteria checkbox
- */
-function asearch_get_form_exclude($exclude, $row_num = 0)
-{
-    return function_exists('addCheckBox') ? addCheckBox('exclude['.$row_num.']', $exclude)
-    : '<input type="checkbox" name="exclude[' . $row_num .']"' . ($exclude ? ' checked="checked"' : '') . ' />';
-}
-
-/** Print one advanced form row
- */
-function asearch_print_form_row($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
-{
-    global $imap_asearch_biops_in;
-    global $color;
-
-    echo html_tag('tr', '', '', $color[4]);
-
-//Binary operator
-    echo html_tag('td', $row_num ?
-            asearch_opt_array('biop[' . $row_num . ']', $imap_asearch_biops_in, $biop)
-            : '<b>' . _("In") . '</b>', 'center') . "\n";
-
-//Mailbox list and Include Subfolders
-    echo html_tag('td',
-            asearch_get_form_mailbox($imapConnection, $boxes, $mailbox, $row_num)
-        . _("and&nbsp;subfolders:") . asearch_get_form_sub($sub, $row_num), 'center') . "\n";
-
-//Unary operator and Search location
-    echo html_tag('td', asearch_get_form_location($unop, $where, $row_num), 'center') . "\n";
-
-//Text input
-    echo html_tag('td', asearch_get_form_what($what, $row_num), 'center') . "\n";
-
-//Exclude criteria
-    echo html_tag('td', _("Exclude Criteria:") . asearch_get_form_exclude($exclude, $row_num), 'center') . "\n";
-
-    echo "</tr>\n";
-}
-
 /** Print the advanced search form
+ * @param stream $imapConnection
+ * @param array $boxes
+ * @param array $mailbox_array
+ * @param array $biop_array
+ * @param array $unop_array
+ * @param array $where_array
+ * @param array $what_array
+ * @param array $exclude_array
+ * @param array $sub_array
+ * @since 1.5.0
+ * @private
  */
 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;
+    global $oTemplate, $allow_advanced_search, $search_advanced, 
+           $imap_asearch_unops, $imap_asearch_biops_in, $imap_asearch_options;
 
-//Search Form
-    echo "<br />\n";
-    echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
-
-    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);
-    for ($row_num = 0; $row_num < $row_count; $row_num++) {
+    # Build the criteria array
+    $c = array();
+    for ($row_num = 0; $row_num < count($where_array); $row_num++) {
         $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]));
-        $sub = strip_tags(asearch_nz($sub_array[$row_num]));
-        asearch_print_form_row($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
+        $a = array();
+        $a['MailboxSel'] = asearch_nz($mailbox_array[$row_num]);
+        $a['LogicSel'] = strip_tags(asearch_nz($biop_array[$row_num]));
+        $a['UnarySel'] = strip_tags(asearch_nz($unop_array[$row_num]));
+        $a['WhereSel'] = strip_tags(asearch_nz($where_array[$row_num]));
+        $a['What'] = asearch_nz($what_array[$row_num]);
+        $a['Exclude'] = strip_tags(asearch_nz($exclude_array[$row_num])) == 'on';
+        $a['IncludeSubfolders'] = strip_tags(asearch_nz($sub_array[$row_num])) == 'on';
+        
+        $c[$row_num] = $a;
     }
-    echo '</table>' . "\n";
-
-//Submit buttons
-    echo html_tag('table', '', 'center', $color[9], 'width="100%" cellpadding="1" cellspacing="0" border="0"');
-    echo html_tag('tr',
-                html_tag('td', getButton('submit', 'submit', $search_button_html), 'center') . "\n"
-            . html_tag('td', getButton('submit', 'submit', $add_criteria_button_html), 'center') . "\n"
-            . html_tag('td', getButton('submit', 'submit', $del_all_button_html), 'center') . "\n"
-            . html_tag('td', getButton('submit', 'submit', $del_excluded_button_html), 'center') . "\n"
-            );
-    echo '</table>' . "\n";
-    echo '</form>' . "\n";
-}
-
-/** Print one basic form row
- */
-function asearch_print_form_row_basic($imapConnection, &$boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num)
-{
-    global $search_button_html;
-    global $color;
-
-    echo html_tag('tr', '', '', $color[4]);
-
-//Mailbox list
-    echo html_tag('td', '<b>' . _("In") . '</b> ' . asearch_get_form_mailbox($imapConnection, $boxes, $mailbox), 'center') . "\n";
-
-//Unary operator and Search location
-    echo html_tag('td', asearch_get_form_location($unop, $where), 'center') . "\n";
-
-//Text input
-    echo html_tag('td', asearch_get_form_what($what), 'center') . "\n";
-
-//Submit button
-    echo html_tag('td', getButton('submit', 'submit', $search_button_html), 'center') . "\n";
-
-    echo "</tr>\n";
+        
+    # Build the mailbox array
+    $a = array();
+    if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes))) {
+        $a[$mailbox] = '[' . _("Missing") . '] ' . htmlspecialchars(asearch_get_mailbox_display($mailbox));
+    }
+    $a['All Folders'] = '[' . asearch_get_mailbox_display('All Folders') . ']';
+    $a = array_merge($a, sqimap_mailbox_option_array($imapConnection, 0, $boxes, NULL));
+    
+    if ($allow_advanced_search > 1) {
+        $link = '../src/search.php?advanced='.($search_advanced ? 0 : 1);
+        $txt = $search_advanced ? _("Standard Search") : _("Advanced search");
+    } else {
+        $link = NULL;
+        $txt = NULL;
+    }
+           
+    $oTemplate->assign('allow_advanced_search', $allow_advanced_search > 1);
+    $oTemplate->assign('adv_toggle_text', $txt);
+    $oTemplate->assign('adv_toggle_link', $link);
+    
+    $oTemplate->assign('mailbox_options', $a);
+    $oTemplate->assign('logical_options', $imap_asearch_biops_in);
+    $oTemplate->assign('unary_options', $imap_asearch_unops);
+    $oTemplate->assign('where_options', $imap_asearch_options);
+
+    $oTemplate->assign('criteria', $c);
+    
+    echo '<form action="../src/search.php" name="form_asearch">' . "\n";
+    $oTemplate->display('search_advanced.tpl');
+    echo "</form>\n";
 }
 
 /** Print the basic search form
+ * @param stream $imapConnection
+ * @param array $boxes
+ * @param array $mailbox_array
+ * @param array $biop_array
+ * @param array $unop_array
+ * @param array $where_array
+ * @param array $what_array
+ * @param array $exclude_array
+ * @param array $sub_array
+ * @since 1.5.1
+ * @private
  */
 function asearch_print_form_basic($imapConnection, &$boxes, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array)
 {
-    global $color;
-
-//Search Form
-    echo "<br />\n";
-    echo '<form action="' . asearch_get_href() . '" name="form_asearch">' . "\n";
-
-    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=4'));
-    $row_count = count($where_array);
-    for ($row_num = 0; $row_num < $row_count; $row_num++) {
-        $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]));
-        $sub = strip_tags(asearch_nz($sub_array[$row_num]));
-        asearch_print_form_row_basic($imapConnection, $boxes, $mailbox, $biop, $unop, $where, $what, $exclude, $sub, $row_num);
+    global $allow_advanced_search, $search_advanced, $oTemplate, $imap_asearch_unops, $imap_asearch_options;
+
+    $row_num = 0;
+    $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]));
+    $sub = strip_tags(asearch_nz($sub_array[$row_num]));
+
+    # Build the mailbox array
+    $a = array();
+    if (($mailbox != 'All Folders') && (!asearch_mailbox_exists($mailbox, $boxes))) {
+        $a[$mailbox] = '[' . _("Missing") . '] ' . htmlspecialchars(asearch_get_mailbox_display($mailbox));
+    }
+    $a['All Folders'] = '[' . asearch_get_mailbox_display('All Folders') . ']';
+    $a = array_merge($a, sqimap_mailbox_option_array($imapConnection, 0, $boxes, NULL));
+        
+    if ($allow_advanced_search > 1) {
+        $link = '../src/search.php?advanced='.($search_advanced ? 0 : 1);
+        $txt = $search_advanced ? _("Standard Search") : _("Advanced search");
+    } else {
+        $link = NULL;
+        $txt = NULL;
     }
-    echo '</table>' . "\n";
-    echo '</form>' . "\n";
+           
+    $oTemplate->assign('allow_advanced_search', $allow_advanced_search > 1);
+    $oTemplate->assign('adv_toggle_text', $txt);
+    $oTemplate->assign('adv_toggle_link', $link);
+
+    $oTemplate->assign('mailbox_options', $a);
+    $oTemplate->assign('unary_options', $imap_asearch_unops);
+    $oTemplate->assign('where_options', $imap_asearch_options);
+    
+    $oTemplate->assign('mailbox_sel', strtolower(htmlspecialchars($mailbox)));
+    $oTemplate->assign('unary_sel', $unop);
+    $oTemplate->assign('where_sel', $where);
+    $oTemplate->assign('what_val', $what);
+        
+    echo '<form action="../src/search.php" name="form_asearch">' . "\n";
+    $oTemplate->display('search.tpl');
+    echo "</form>\n";
 }
 
 
 /**
  * @param array $boxes mailboxes array (reference)
  * @return array selectable unformatted mailboxes names
+ * @since 1.5.0
+ * @private
  */
 function sqimap_asearch_get_selectable_unformatted_mailboxes(&$boxes)
 {
@@ -897,10 +907,7 @@ function sqimap_asearch_get_selectable_unformatted_mailboxes(&$boxes)
 
 /* ------------------------ main ------------------------ */
 /* get globals we will need */
-sqgetGlobalVar('username', $username, SQ_SESSION);
-sqgetGlobalVar('key', $key, SQ_COOKIE);
 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
-sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
 
 if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
     $checkall = (int) $temp;
@@ -911,7 +918,6 @@ if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
  */
 sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
 
-
 $search_button_html = _("Search");
 $search_button_text = asearch_unhtmlentities($search_button_html);
 $add_criteria_button_html = _("Add New Criteria");
@@ -1014,8 +1020,8 @@ $aMailboxGlobalPref = array(
  * system wide admin settings and incoming vars.
  */
 $aConfig = array(
-                'allow_thread_sort' => $allow_thread_sort,
-                'allow_server_sort' => $allow_server_sort,
+//                'allow_thread_sort' => $allow_thread_sort,
+//                'allow_server_sort' => $allow_server_sort,
                 'user'              => $username,
                 'setindex'          => 1
                 );
@@ -1108,12 +1114,6 @@ if ( sqgetGlobalVar('account', $temp,  SQ_GET) ) {
     $iAccount = 0;
 }
 
-/**
- * Which templatedir are we using. TODO, add make a config var of this and make it possible to switch templates
- */
-$sTplDir = SM_PATH . 'templates/default/';
-
-
 /**
  * Incoming submit buttons from the message list with search results
  */
@@ -1307,7 +1307,7 @@ if ($search_advanced) {
 uasort($imap_asearch_options, 'asearch_unhtml_strcoll');
 
 /* open IMAP connection */
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
 
 
 /* get mailboxes once here */
@@ -1358,7 +1358,7 @@ if (isset($aMailbox['FORWARD_SESSION'])) {
         session_write_close();
         // restart the session. Do not use sqsession_is_active because the session_id
         // isn't empty after a session_write_close
-        session_start();
+        sqsession_start();
 
         if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
             $compose_width = '640';
@@ -1386,26 +1386,13 @@ if (isset($aMailbox['FORWARD_SESSION'])) {
 }
 
 if (isset($note)) {
-    echo html_tag( 'div', '<b>' . $note .'</b>', 'center' ) . "<br />\n";
+    $oTemplate->assign('note', $note);
+    $oTemplate->display('note.tpl');
 }
 
-
 do_hook('search_before_form');
 
 if (!$search_silent) {
-    //Add a link to the other search mode if allowed
-    if ($allow_advanced_search > 1)
-        $toggle_link = ' - <small>['
-            . asearch_get_toggle_link(!$search_advanced, 'advanced', array(_("Standard search"), _("Advanced search")))
-            . ']</small>';
-    else
-        $toggle_link = '';
-
-    echo html_tag('table',
-                html_tag('tr', "\n"
-                . html_tag('td', asearch_get_title_display($color, _("Search")) . $toggle_link, 'center', $color[0])
-                    ) ,
-                '', '', 'width="100%"') . "\n";
     asearch_print_saved($boxes);
     asearch_print_recent($boxes);
     if (empty($where_array)) {
@@ -1445,17 +1432,18 @@ do_hook('search_after_form');
 
 if ($submit == $search_button_text) {
     $msgsfound = false;
-    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, $sub_array), 'center', $color[4]));
-    echo '</table>' . "\n";
 
+    $err = asearch_check_query($where_array, $what_array, $exclude_array);
+
+    $oTemplate->assign('query_has_error', $err!='');
+    $oTemplate->assign('query_error', $err=='' ? NULL : $err);
+    $oTemplate->assign('query', asearch_get_query_display($color, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $sub_array));
+    
+    $oTemplate->display('search_result_top.tpl');
+    
     flush();
     $iMsgCnt = 0;
-    $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 {
+    if ($err == '') {
         $mboxes_array = sqimap_asearch_get_selectable_unformatted_mailboxes($boxes);
         /**
          * Retrieve the search queries
@@ -1593,8 +1581,9 @@ if ($submit == $search_button_text) {
                 */
                 sqgetGlobalVar('align',$align,SQ_SESSION);
 
-                $oTemplate = new Template($sTplDir);
-
+                /**
+                 * TODO: Clean up handling of message list once the template is cleaned up.
+                 */
                 if ($aMailbox['EXISTS'] > 0) {
                     if ($iError) {
                        // TODO
@@ -1603,28 +1592,29 @@ if ($submit == $search_button_text) {
                         foreach ($aTemplate as $k => $v) {
                             $oTemplate->assign($k, $v);
                         }
+
+                        $mailbox_display = asearch_get_mailbox_display($aMailbox['NAME']);
+                        if (strtoupper($mbx) == 'INBOX') {
+                            $mailbox_display = _("INBOX");
+                        } else {
+                            $mailbox_display = imap_utf7_decode_local($mbx);
+                        }
+
+                        $oTemplate->assign('mailbox_name', htmlspecialchars($mailbox_display));
+                        $oTemplate->display('search_result_mailbox.tpl');
+
                         $oTemplate->assign('page_selector',  $page_selector);
                         $oTemplate->assign('page_selector_max', $page_selector_max);
                         $oTemplate->assign('compact_paginator', $compact_paginator);
                         $oTemplate->assign('javascript_on', $javascript_on);
                         $oTemplate->assign('enablesort', (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false);
-                        // Aaaaaahhhhhhh FIX ME DO NOT USE the string "none" for a var when you mean the boolean false or null
-                        $oTemplate->assign('icon_theme', (isset($icon_theme) && $icon_theme !== 'none') ? $icon_theme : false);
+                        $oTemplate->assign('icon_theme_path', $icon_theme_path);
                         $oTemplate->assign('use_icons', (isset($use_icons)) ? $use_icons : false);
                         $oTemplate->assign('aOrder', array_keys($aColumns));
                         $oTemplate->assign('alt_index_colors', isset($alt_index_colors) ? $alt_index_colors: false);
                         $oTemplate->assign('color', $color);
                         $oTemplate->assign('align', $align);
 
-                        $mailbox_display = asearch_get_mailbox_display($aMailbox['NAME']);
-                        if (strtoupper($mbx) == 'INBOX') {
-                            $mailbox_display = _("INBOX");
-                        } else {
-                            $mailbox_display = imap_utf7_decode_local($mbx);
-                        }
-
-                        echo '<br /><b><big>' . _("Folder:") . ' '. $mailbox_display . '&nbsp;</big></b>';
-
                         $oTemplate->display('message_list.tpl');
                     }
                 }
@@ -1636,12 +1626,13 @@ if ($submit == $search_button_text) {
         }
     }
     if(!$iMsgCnt) {
-        echo '<br />' . html_tag('div', asearch_get_error_display($color, _("No Messages Found")), 'center') . "\n";
+        $oTemplate->display('search_result_empty.tpl');
     }
 }
 
 do_hook('search_bottom');
 sqimap_logout($imapConnection);
-echo '</body></html>';
+
+$oTemplate->display('footer.tpl');
 sqsession_register($mailbox_cache,'mailbox_cache');
 ?>
\ No newline at end of file