Added a server-side thread sort option. disabled by default (site wide)
[squirrelmail.git] / src / search.php
index 9fedb9559e23cdd3a588df591681faa104c61efc..9786cb5dd85132d53fd9edfedb41d81aef627314 100644 (file)
 <?php
 
 /**
- * right_main.php
+ * search.php
  *
- * Copyright (c) 1999-2001 The Squirrelmail Development Team
+ * Copyright (c) 1999-2002 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$
  */
 
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
-/***    + Base level indent should begin at left margin, as    ***/
-/***      the require_once below looks.                        ***/
-/***    + All identation should consist of four space blocks   ***/
-/***    + Tab characters are evil.                             ***/
-/***    + all comments should use "slash-star ... star-slash"  ***/
-/***      style -- no pound characters, no slash-slash style   ***/
-/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
-/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
-/***    + Please use ' instead of ", when possible. Note "     ***/
-/***      should always be used in _( ) function calls.        ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
 require_once('../src/validate.php');
 require_once('../functions/imap.php');
 require_once('../functions/imap_search.php');
 require_once('../functions/array.php');
+require_once('../functions/strings.php');
+
+
+/*  here are some functions, could go in imap_search.php
+
+    this was here, pretty handy  */
+function s_opt( $val, $sel, $tit ) {
+    echo "            <option value=\"$val\"";
+    if ( $sel == $val ) {
+        echo ' selected';
+    }
+    echo  ">$tit</option>\n";
+}
+
+/*  function to get the recent searches and put them in arrays  */
+function get_recent($pref_name, $username, $data_dir) {
+    $array = array ();
+    $recent_count = getPref($data_dir, $username, 'search_memory', 0);
+    $n = 0;
+    for ($x=1;$x<=$recent_count;$x++) {
+    $array[$n] = getPref($data_dir, $username, "$pref_name" . "$x", "");
+    $n++;
+    }
+    return $array;
+}
+
+/*  function to get the saved searches and put them in arrays  */
+function get_saved($pref_name, $username, $data_dir) {
+    $array = array ();
+    $n = 0;
+    for ($x=1;;$x++) {
+        $array[$n] = getPref($data_dir, $username, "$pref_name" . "$x", "");
+    if ($array[$n] == "") {
+        array_pop($array);
+        return $array;
+    }
+    $n++;
+    }
+    return $array;
+}
+
+/*  function to update recent pref arrays  */
+function update_recent($what, $where, $mailbox, $username, $data_dir) {
+    $what_array = get_recent('search_what', $username, $data_dir);
+    $where_array = get_recent('search_where', $username, $data_dir);
+    $folder_array = get_recent('search_folder', $username, $data_dir);
+    $dupe = 'no';
+    for ($i=0;$i<count($what_array);$i++) {
+        if ($what == $what_array[$i] &&
+            $where == $where_array[$i] &&
+            $mailbox == $folder_array[$i]) {
 
-    function s_opt( $val, $sel, $tit ) {
-        echo "            <option value=\"$val\"";
-        if ( $sel )
-            echo 'selected';
-        echo  ">$tit</option>\n";
+            $dupe = 'yes';
+        }
     }
+    if ($dupe == 'no') {
+    array_push ($what_array, $what);
+    array_push ($where_array, $where);
+    array_push ($folder_array, $mailbox);
+    array_shift ($what_array);
+    array_shift ($where_array);
+    array_shift ($folder_array);
+    $recent_count = getPref($data_dir, $username, 'search_memory', 0);
+    $n=0;
+    for ($i=1;$i<=$recent_count;$i++) {
+        setPref($data_dir, $username, "search_what$i", $what_array[$n]);
+        setPref($data_dir, $username, "search_where$i", $where_array[$n]);
+        setPref($data_dir, $username, "search_folder$i", $folder_array[$n]);
+       $n++;
+       }
+    }
+}
+
+/*  function to forget a recent search  */
+function forget_recent($forget_index, $username, $data_dir) {
+    $what_array = get_recent('search_what', $username, $data_dir);
+    $where_array = get_recent('search_where', $username, $data_dir);
+    $folder_array = get_recent('search_folder', $username, $data_dir);
+    array_splice($what_array, $forget_index, 1);
+    array_splice($where_array, $forget_index, 1);
+    array_splice($folder_array, $forget_index, 1);
+    array_unshift($what_array, '');
+    array_unshift($where_array, '');
+    array_unshift($folder_array, '');
+    $recent_count = getPref($data_dir, $username, 'search_memory', 0);
+    $n=0;
+    for ($i=1;$i<=$recent_count;$i++) {
+        setPref($data_dir, $username, "search_what$i", $what_array[$n]);
+        setPref($data_dir, $username, "search_where$i", $where_array[$n]);
+        setPref($data_dir, $username, "search_folder$i", $folder_array[$n]);
+        $n++;
+    }
+}
+
+/*  function to delete a saved search  */
+function delete_saved($delete_index, $username, $data_dir) {
+    $saved_what_array = get_saved('saved_what', $username, $data_dir);
+    $saved_where_array = get_saved('saved_where', $username, $data_dir);
+    $saved_folder_array = get_saved('saved_folder', $username, $data_dir);
+    array_splice($saved_what_array, $delete_index, 1);
+    array_splice($saved_where_array, $delete_index, 1);
+    array_splice($saved_folder_array, $delete_index, 1);
+    $n=0;
+    $saved_count = count($saved_what_array);
+    $last_element = $saved_count + 1;
+    if ($last_element < 1) {
+        for ($i=1;$i<=$saved_count;$i++) {
+            setPref($data_dir, $username, "saved_what$i", $saved_what_array[$n]);
+        setPref($data_dir, $username, "saved_where$i", $saved_where_array[$n]);
+        setPref($data_dir, $username, "saved_folder$i", $saved_folder_array[$n]);
+        $n++;
+        }
+    }
+    removePref($data_dir, $username, "saved_what$last_element");
+    removePref($data_dir, $username, "saved_where$last_element");
+    removePref($data_dir, $username, "saved_folder$last_element");
+}
+
+/*  function to save a search from recent to saved  */
+function save_recent($save_index, $username, $data_dir) {
+    $what_array = get_recent('search_what', $username, $data_dir);
+    $where_array = get_recent('search_where', $username, $data_dir);
+    $folder_array = get_recent('search_folder', $username, $data_dir);
+    $saved_what_once = array_slice($what_array, $save_index, 1);
+    $saved_where_once = array_slice($where_array, $save_index, 1);
+    $saved_folder_once = array_slice($folder_array, $save_index, 1);
+    $saved_array = get_saved('saved_what', $username, $data_dir);
+    $saved_count = (count($saved_array) + 1);
+    setPref($data_dir, $username, "saved_what$saved_count", $saved_what_once[0]);
+    setPref($data_dir, $username, "saved_where$saved_count", $saved_where_once[0]);
+    setPref($data_dir, $username, "saved_folder$saved_count", $saved_folder_once[0]);
+}
+
+/* ------------------------ main ------------------------ */
+
+/*  reset these arrays on each page load just in case  */
+$what_array = array ();
+$where_array = array ();
+$folder_array = array ();
+$saved_what_array = array ();
+$saved_where_array = array ();
+$saved_folder_array = array ();
+$search_all = 'none';
+$perbox_count = array ();
+
+/*  get mailbox names  */
+$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+$boxes = sqimap_mailbox_list($imapConnection);
+
+/*  set current mailbox to INBOX if none was selected or if page
+    was called to search all folders.  */
+if ( !isset($mailbox) || $mailbox == 'None' || $mailbox == '' ) {
+    $mailbox = $boxes[0]['unformatted'];
+}
+if ($mailbox == 'All Folders') {
+    $search_all = 'all';
+}
+
+displayPageHeader($color, $mailbox);
 
-   displayPageHeader($color, $mailbox);
-   $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-
-   do_hook('search_before_form');
-   echo "<br>\n".
-        "      <table width=95% align=center cellpadding=2 cellspacing=0 border=0>\n".
-        "      <tr><td bgcolor=\"$color[0]\">\n".
-        "          <center><b>"._("Search")."</b></center>\n".
-        "      </td></tr>\n".
-        '      <tr><td align=center>'.
-
-        "<FORM ACTION=\"search.php\" NAME=s>\n".
-        "   <TABLE WIDTH=\"75%\">\n".
-        "     <TR>\n".
-        "       <TD WIDTH=\"33%\">\n".
-        '         <TT><SMALL><SELECT NAME="mailbox">';
-
-   $boxes = sqimap_mailbox_list($imapConnection);
-   for ($i = 0; $i < count($boxes); $i++) {
-      if (!in_array('noselect', $boxes[$i]['flags'])) {
-         $box = $boxes[$i]['unformatted'];
-         $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['unformatted-disp']);
-         if ($mailbox == $box)
+/*  See how the page was called and fire off correct function  */
+if ((!isset($submit) || empty($submit)) && !empty($what)) {
+    $submit = _("Search");
+}
+if ( !isset( $submit ) ) {
+    /*
+        Jason, leave E_ALL only on error reporting in php.ini
+        Variables must contain a value befor to check them,
+        or else there are compilation slow down as PHP has
+        to guess.
+        Remove this comment once read 8-)
+    */
+    $submit = '';
+} else if ($submit == _("Search") && !empty($what)) {
+    update_recent($what, $where, $mailbox, $username, $data_dir);
+}
+elseif ($submit == 'forget') {
+    forget_recent($count, $username, $data_dir);
+}
+elseif ($submit == 'save') {
+    save_recent($count, $username, $data_dir);
+}
+elseif ($submit == 'delete') {
+    delete_saved($count, $username, $data_dir);
+}
+
+do_hook('search_before_form');
+
+echo "<BR>\n".
+     "<table width=\"100%\">\n".
+        "<TR><td bgcolor=\"$color[0]\">\n".
+            "<CENTER><B>" . _("Search") . "</B></CENTER>\n".
+        "</TD></TR>\n".
+     "</TABLE>\n";
+
+/*  update the recent and saved searches from the pref files  */
+$what_array = get_recent('search_what', $username, $data_dir);
+$where_array = get_recent('search_where', $username, $data_dir);
+$folder_array = get_recent('search_folder', $username, $data_dir);
+$recent_count = getPref($data_dir, $username, 'search_memory', 0);
+$saved_what_array = get_saved('saved_what', $username, $data_dir);
+$saved_where_array = get_saved('saved_where', $username, $data_dir);
+$saved_folder_array = get_saved('saved_folder', $username, $data_dir);
+$saved_count = count($saved_what_array);
+$count_all = 0;
+
+/* Saved Search Table */
+if ($saved_count > 0) {
+    echo "<BR>\n"
+    . "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>"
+    . '<TR><TD align=center><B>Saved Searches</B></TD></TR><TR><TD>'
+    . '<TABLE WIDTH="100%" ALIGN="CENTER" CELLPADDING=0 CELLSPACING=0>';
+    for ($i=0; $i < $saved_count; ++$i) {
+        if ($i % 2) {
+            echo "<TR BGCOLOR=\"$color[0]\">";
+        } else {
+            echo "<TR BGCOLOR=\"$color[4]\">";
+        }
+        echo "<TD WIDTH=\"35%\">$saved_folder_array[$i]</TD>"
+        . "<TD ALIGN=LEFT>$saved_what_array[$i]</TD>"
+        . "<TD ALIGN=CENTER>$saved_where_array[$i]</TD>"
+        . '<TD ALIGN=RIGHT>'
+        .   '<A HREF=search.php'
+        .     '?mailbox=' . urlencode($saved_folder_array[$i])
+        .     '&amp;what=' . urlencode($saved_what_array[$i])
+        .     '&amp;where=' . urlencode($saved_where_array[$i])
+        .   '>' . _("edit") . '</A>'
+        .   '&nbsp;|&nbsp;'
+        .   '<A HREF=search.php'
+        .     '?mailbox=' . urlencode($saved_folder_array[$i])
+        .     '&amp;what=' . urlencode($saved_what_array[$i])
+        .     '&amp;where=' . urlencode($saved_where_array[$i])
+        .     '&amp;submit=Search_no_update'
+        .   '>' . _("search") . '</A>'
+        .   '&nbsp;|&nbsp;'
+        .   "<A HREF=search.php?count=$i&amp;submit=delete>"
+        .     _("delete")
+        .   '</A>'
+        . '</TD></TR>';
+    }
+    echo "</TABLE></TD></TR></TABLE>\n";
+}
+
+/* Recent Search Table */
+if ($recent_count > 0) {
+    echo "<BR>\n"
+       . "<TABLE WIDTH=\"95%\" BGCOLOR=\"$color[9]\" ALIGN=\"CENTER\" CELLPADDING=1 CELLSPACING=1>\n"
+       . '<TR><TD ALIGN=CENTER><B>' . _("Recent Searches") . '</B></TD></TR><TR><TD>'
+       . '<TABLE WIDTH="100%" ALIGN="CENTER" CELLPADDING=0 CELLSPACING=0>';
+    for ($i=0; $i < $recent_count; ++$i) {
+        if (!empty($what_array[$i])) {
+            if ($folder_array[$i] == "") {
+                $folder_array[$i] = "INBOX";
+            }
+            if ($i % 2) {
+                echo "<TR BGCOLOR=\"$color[0]\">";
+            } else {
+                echo "<TR BGCOLOR=\"$color[4]\">";
+            }
+            echo "<TD WIDTH=35%>$folder_array[$i]</TD>"
+               . "<TD ALIGN=LEFT>$what_array[$i]</TD>"
+               . "<TD ALIGN=CENTER>$where_array[$i]</TD>"
+               . '<TD ALIGN=RIGHT>'
+               .   "<A HREF=search.php?count=$i&amp;submit=save>"
+               .     _("save")
+               .   '</A>'
+               .   '&nbsp;|&nbsp;'
+               .   '<A HREF=search.php'
+               .     '?mailbox=' . urlencode($folder_array[$i])
+               .     '&amp;what=' . urlencode($what_array[$i])
+               .     '&amp;where=' . urlencode($where_array[$i])
+               .     '&amp;submit=Search_no_update'
+               .   '>' . _("search") . '</A>'
+               .   '&nbsp;|&nbsp;'
+               .   "<A HREF=search.php?count=$i&amp;submit=forget>"
+               .     _("forget")
+               .   '</A>'
+               . '</TD></TR>';
+        }
+    }
+    echo '</TABLE></TD></TR></TABLE><BR>';
+}
+
+/* Search Form */
+echo '<B>' . _("Current Search") . '</B>'
+   . '<FORM ACTION="search.php" NAME=s>'
+   . '   <TABLE WIDTH="95%" CELLPADDING=0 CELLSPACING=0>'
+   . '     <TR>'
+   . '       <TD><SELECT NAME="mailbox">';
+for ($i = 0; $i < count($boxes); $i++) {
+    if (!in_array('noselect', $boxes[$i]['flags'])) {
+        $box = $boxes[$i]['unformatted'];
+        $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['unformatted-disp']);
+        if( $box2 == 'INBOX' ) {
+            $box2 = _("INBOX");
+        }
+        if ($mailbox == $box) {
             echo "         <OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
-         else
+        }
+        else {
             echo "         <OPTION VALUE=\"$box\">$box2</OPTION>\n";
-      }
-   }
-   echo '         </SELECT></SMALL></TT>'.
-        "       </TD>\n".
-        "        <TD ALIGN=\"CENTER\" WIDTH=\"33%\">\n";
-   if (!isset($what))
-       $what = '';
-   $what_disp = ereg_replace(',', ' ', $what);
-   $what_disp = str_replace('\\\\', '\\', $what_disp);
-   $what_disp = str_replace('\\"', '"', $what_disp);
-   $what_disp = str_replace('"', '&quot;', $what_disp);
-   echo "          <INPUT TYPE=\"TEXT\" SIZE=\"20\" NAME=\"what\" VALUE=\"$what_disp\">\n".
-                '</TD>'.
-               "<TD ALIGN=\"RIGHT\" WIDTH=\"33%\">\n".
-                 '<SELECT NAME="where">';
-
-   s_opt( 'BODY', ($where == 'BODY'), _("Body") );
-   s_opt( 'TEXT', ($where == 'TEXT'), _("Everywhere") );
-   s_opt( 'SUBJECT', ($where == 'SUBJECT'), _("Subject") );
-   s_opt( 'FROM', ($where == 'FROM'), _("From") );
-   s_opt( 'CC', ($where == 'CC'), _("Cc") );
-   s_opt( 'TO', ($where == 'TO'), _("To") );
-
-   echo "         </SELECT>\n" .
-        "        </TD>\n".
-        "       <TD COLSPAN=\"3\" ALIGN=\"CENTER\">\n".
-        "         <INPUT TYPE=\"submit\" VALUE=\""._("Search")."\">\n".
-        "       </TD>\n".
-        "     </TR>\n".
-        "   </TABLE>\n".
-        "</FORM>".
-        "</td></tr></table>";
-   do_hook("search_after_form");
-   if (isset($where) && $where && isset($what) && $what) {   
-      sqimap_mailbox_select($imapConnection, $mailbox);
-      sqimap_search($imapConnection, $where, $what, $mailbox, $color);
-   }
-   do_hook("search_bottom");
-   sqimap_logout ($imapConnection);
+        }
+    }
+}
+        echo "<OPTION VALUE=\"All Folders\"";
+        if ($mailbox == "All Folders") {
+            echo "SELECTED";
+        }
+        echo ">All folders</OPTION>\n";
+echo '         </SELECT>'.
+     "       </TD>\n".
+     "        <TD ALIGN=\"CENTER\">\n";
+if ( !isset( $what ) ) {
+    $what = '';
+}
+$what_disp = str_replace(',', ' ', $what);
+$what_disp = str_replace('\\\\', '\\', $what_disp);
+$what_disp = str_replace('\\"', '"', $what_disp);
+$what_disp = str_replace('"', '&quot;', $what_disp);
+echo "          <INPUT TYPE=\"TEXT\" SIZE=\"35\" NAME=\"what\" VALUE=\"$what_disp\">\n".
+     "        </TD>\n".
+     "<TD ALIGN=\"RIGHT\">\n".
+     "<SELECT NAME=\"where\">";
+s_opt( 'BODY', $where, _("Body") );
+s_opt( 'TEXT', $where, _("Everywhere") );
+s_opt( 'SUBJECT', $where, _("Subject") );
+s_opt( 'FROM', $where, _("From") );
+s_opt( 'CC', $where, _("Cc") );
+s_opt( 'TO', $where, _("To") );
+echo "         </SELECT>\n" .
+     "        </TD>\n".
+     "       <TD COLSPAN=\"3\" ALIGN=\"CENTER\">\n".
+     "         <INPUT TYPE=\"submit\" NAME=\"submit\" VALUE=\"" . _("Search") . "\">\n".
+     "       </TD>\n".
+     "     </TR>\n".
+     "</FORM>\n".
+     "   </TABLE>\n".
+     "</TD></TR></TABLE>\n";
+
+
+do_hook('search_after_form');
+
+/*
+    search all folders option still in the works. returns a table for each
+    folder it finds a match in.
+*/
+
+if ($search_all == 'all') {
+    $mailbox == '';
+    $boxcount = count($boxes);
+    echo '<BR><CENTER><B>' .
+         _("Search Results") .
+         "</B><CENTER><BR>\n";
+    for ($x=0;$x<$boxcount;$x++) {
+        if (!in_array('noselect', $boxes[$x]['flags'])) {
+            $mailbox = $boxes[$x]['unformatted'];
+        }
+        if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
+            sqimap_mailbox_select($imapConnection, $mailbox);
+            $count_all = sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
+        array_push($perbox_count, $count_all);
+        }
+    }
+    for ($i=0;$i<count($perbox_count);$i++) {
+        if ($perbox_count[$i] != "") {
+           break;
+        }
+        $count_all = "none";
+    }
+    if ($count_all == "none") {
+        echo '<br><b>' .
+             _("No Messages found") .
+             '</b><br>';
+    }
+}
+
+/*  search one folder option  */
+else {
+    if (($submit == _("Search") || $submit == 'Search_no_update') && !empty($what)) {
+        echo '<BR><CENTER><B>' .
+             _("Search Results") .
+             "</B></CENTER>\n";
+        sqimap_mailbox_select($imapConnection, $mailbox);
+        sqimap_search($imapConnection, $where, $what, $mailbox, $color, 0, $search_all, $count_all);
+    }
+}
+
+/*  must have search terms to search  */
+if ($submit == _("Search") && empty($what)) {
+    echo "<BR><CENTER><B>Please enter something to search for</B></CENTER>\n";
+}
+
+do_hook('search_bottom');
+sqimap_logout ($imapConnection);
+echo '</body></html>';
+
 ?>
-</body></html>