search on multiple terms, with patch of Jason Munro
[squirrelmail.git] / functions / imap_search.php
index 300beaad57617bd3fa4601b5b971ade955e11fd3..566189555096340ef8f702b23f9db6c1465c3f2c 100644 (file)
 <?php
 
 /**
- *   imap_search.php
+ * imap_search.php
  *
- *   Copyright (c) 1999-2001 The Squirrelmail Development Team
- *   Licensed under the GNU GPL. For full terms see the file COPYING.
+ * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- *   IMAP search routines
+ * IMAP search routines
  *
- *  $Id$
+ * $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.                              ***/
-/***    + 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('../functions/imap.php');
 require_once('../functions/date.php');
 require_once('../functions/array.php');
 require_once('../functions/mailbox_display.php');
 require_once('../functions/mime.php');
 
+function sqimap_search($imapConnection,$search_where,$search_what,$mailbox,$color, $search_position = '') {
+
+    global $msgs, $message_highlight_list, $squirrelmail_language, $languages, $index_order;
+    global $pos;
 
-    function sqimap_search($imapConnection,$search_where,$search_what,$mailbox,$color) {
+    $pos = $search_position;
 
-        global $msgs, $message_highlight_list, $squirrelmail_language, $languages, $index_order;
+    $urlMailbox = urlencode($mailbox);
 
-        $urlMailbox = urlencode($mailbox);
-        $isid = sqimap_session_id();
+    /* Construct the Search QuERY */
 
-        /* Construct the Search QuERY */
-        $ss = $isid;
-        if (isset($languages[$squirrelmail_language]['CHARSET']) &&
-            $languages[$squirrelmail_language]['CHARSET']) {
-            $ss .= " SEARCH CHARSET ".$languages[$squirrelmail_language]['CHARSET']." ALL $search_where \"$search_what\"\r\n";
-        } else {
-            $ss .= " SEARCH ALL $search_where \"$search_what\"\r\n";
+#  account for multiple search terms
+
+        $multi_search = array ();
+        $search_what = ereg_replace("[ ]{2,}", " ", $search_what);
+        $multi_search = split (" ", $search_what);
+        if (count($multi_search)==1) {
+                $search_string = $search_where . " " . "\"" . $multi_search[0] . "\"";
         }
-        fputs($imapConnection,$ss);
-
-        # Read Data Back From IMAP
-        $readin = sqimap_read_data ($imapConnection, $isid, false, $result, $message);
-        if (isset($languages[$squirrelmail_language]['CHARSET']) && strtolower($result) == 'no') {
-            $ss = $isid . " SEARCH CHARSET \"US-ASCII\" ALL $search_where \"$search_what\"\r\n";
-            fputs ($imapConnection, $ss);
-            $readin = sqimap_read_data ($imapConnection, $isid, true, $result, $message);
+        else {
+                $search_string = "";
+               $count = count($multi_search);
+                for ($x=0;$x<$count;$x++) {
+                       $search_string = $search_string . " " . $search_where . " " . "\"" . $multi_search[$x] . "\"";
+                }
         }
+       $search_string = ereg_replace("^ ", "", $search_string);
 
-        unset($messagelist); $msgs=""; $c = 0;
+# now use $search_string in the imap search
 
-        /* Keep going till we find the SEARCH responce */
-        while ($c < count( $readin )) {
+    if (isset($languages[$squirrelmail_language]['CHARSET']) &&
+        $languages[$squirrelmail_language]['CHARSET']) {
+        $ss = "SEARCH CHARSET ".$languages[$squirrelmail_language]['CHARSET']." ALL $search_string";
+    } else {
+        $ss .= "SEARCH ALL $search_string\"";
+    }
 
-            /* Check to see if a SEARCH Responce was recived */
-            if (substr($readin[$c],0,9) == "* SEARCH ")
-                $messagelist = explode(" ",substr($readin[$c],9));
-            else if (isset($errors))
-                $errors = $errors.$readin[$c];
-            else
-                $errors = $readin[$c];
-            $c++;
-        }
+    /* Read Data Back From IMAP */
+    $readin = sqimap_run_command ($imapConnection, $ss, true, $result, $message);
+    if (isset($languages[$squirrelmail_language]['CHARSET']) && strtolower($result) == 'no') {
+        $ss = "SEARCH CHARSET \"US-ASCII\" ALL $search_where \"$search_what\"";
+        $readin = sqimap_run_command ($imapConnection, $ss, true, $result, $message);
+    }
 
-        #If nothing is found * SEARCH should be the first error else echo errors
-        if (isset($errors) && strstr($errors,"* SEARCH")) {
-            echo '<br><CENTER>' . _("No Messages Found") . '</CENTER>';
-            return;
-        } else if (isset($errors)) {
-            echo "<!-- ".$errors." -->";
-        }
+    unset($messagelist); $msgs=""; $c = 0;
 
-        # HACKED CODED FROM ANOTHER FUNCTION, Could Probably dump this and mondify
-        # exsitising code with a search true/false varible.
+    /* Keep going till we find the SEARCH responce */
+    while ($c < count( $readin )) {
 
+        /* Check to see if a SEARCH Responce was recived */
+        if (substr($readin[$c],0,9) == "* SEARCH ")
+            $messagelist = explode(" ",substr($readin[$c],9));
+        else if (isset($errors))
+            $errors = $errors.$readin[$c];
+        else
+            $errors = $readin[$c];
+        $c++;
+    }
 
-        global $sent_folder;
-        for ($q = 0; $q < count($messagelist); $q++) {
-            $id[$q] = trim($messagelist[$q]);
-        }
-        $issent = ($mailbox == $sent_folder);
-        $hdr_list = sqimap_get_small_header_list($imapConnection, $id, $issent);
-        $flags = sqimap_get_flags_list($imapConnection, $id, $issent);
-        foreach ($hdr_list as $hdr) {
-            $from[] = $hdr->from;
-            $date[] = $hdr->date;
-            $subject[] = $hdr->subject;
-            $to[] = $hdr->to;
-            $priority[] = $hdr->priority;
-            $cc[] = $hdr->cc;
-            $size[] = $hdr->size;
-            $type[] = $hdr->type0;
-        }
+    /* If nothing is found * SEARCH should be the first error else echo errors */
+    if (isset($errors) && strstr($errors,"* SEARCH")) {
+        echo '<br><CENTER>' . _("No Messages Found") . '</CENTER>';
+        return;
+    } else if (isset($errors)) {
+        echo "<!-- ".$errors." -->";
+    }
 
-        $j = 0;
-        while ($j < count($messagelist)) {
-                $date[$j] = ereg_replace('  ', ' ', $date[$j]);
-                $tmpdate = explode(" ", trim($date[$j]));
-
-                $messages[$j]["TIME_STAMP"] = getTimeStamp($tmpdate);
-                $messages[$j]["DATE_STRING"] = getDateString($messages[$j]["TIME_STAMP"]);
-                $messages[$j]["ID"] = $id[$j];
-                $messages[$j]["FROM"] = decodeHeader($from[$j]);
-                $messages[$j]["FROM-SORT"] = strtolower(sqimap_find_displayable_name(decodeHeader($from[$j])));
-                $messages[$j]["SUBJECT"] = decodeHeader($subject[$j]);
-                $messages[$j]["SUBJECT-SORT"] = strtolower(decodeHeader($subject[$j]));
-                $messages[$j]["TO"] = decodeHeader($to[$j]);
-                $messages[$j]["PRIORITY"] = $priority[$j];
-                $messages[$j]["CC"] = $cc[$j];
-                $messages[$j]["SIZE"] = $size[$j];
-                $messages[$j]["TYPE0"] = $type[$j];
-
-                $num = 0;
-                while ($num < count($flags[$j])) {
-                    if ($flags[$j][$num] == 'Deleted') {
-                        $messages[$j]['FLAG_DELETED'] = true;
-                    } else if ($flags[$j][$num] == 'Answered') {
-                        $messages[$j]['FLAG_ANSWERED'] = true;
-                    } else if ($flags[$j][$num] == 'Seen') {
-                        $messages[$j]['FLAG_SEEN'] = true;
-                    } else if ($flags[$j][$num] == 'Flagged') {
-                        $messages[$j]['FLAG_FLAGGED'] = true;
-                    }
-                    $num++;
-                }
-                $j++;
-        }
+    /*
+        HACKED CODED FROM ANOTHER FUNCTION, Could Probably dump this and mondify
+        exsitising code with a search true/false varible.
+    */
 
-        /** Find and remove the ones that are deleted */
-        $i = 0;
-        $j = 0;
-        while ($j < count($messagelist)) {
-            if (isset($messages[$j]["FLAG_DELETED"]) && $messages[$j]["FLAG_DELETED"] == true) {
-                $j++;
-                continue;
+    global $sent_folder;
+    for ($q = 0; $q < count($messagelist); $q++) {
+        $id[$q] = trim($messagelist[$q]);
+    }
+    $issent = ($mailbox == $sent_folder);
+    $hdr_list = sqimap_get_small_header_list($imapConnection, $id, $issent);
+    $flags = sqimap_get_flags_list($imapConnection, $id, $issent);
+    foreach ($hdr_list as $hdr) {
+        $from[] = $hdr->from;
+        $date[] = $hdr->date;
+        $subject[] = $hdr->subject;
+        $to[] = $hdr->to;
+        $priority[] = $hdr->priority;
+        $cc[] = $hdr->cc;
+        $size[] = $hdr->size;
+        $type[] = $hdr->type0;
+    }
+
+    $j = 0;
+    while ($j < count($messagelist)) {
+            $date[$j] = ereg_replace('  ', ' ', $date[$j]);
+            $tmpdate = explode(" ", trim($date[$j]));
+
+            $messages[$j]["TIME_STAMP"] = getTimeStamp($tmpdate);
+            $messages[$j]["DATE_STRING"] = getDateString($messages[$j]["TIME_STAMP"]);
+            $messages[$j]["ID"] = $id[$j];
+            $messages[$j]["FROM"] = decodeHeader($from[$j]);
+            $messages[$j]["FROM-SORT"] = strtolower(sqimap_find_displayable_name(decodeHeader($from[$j])));
+            $messages[$j]["SUBJECT"] = decodeHeader($subject[$j]);
+            $messages[$j]["SUBJECT-SORT"] = strtolower(decodeHeader($subject[$j]));
+            $messages[$j]["TO"] = decodeHeader($to[$j]);
+            $messages[$j]["PRIORITY"] = $priority[$j];
+            $messages[$j]["CC"] = $cc[$j];
+            $messages[$j]["SIZE"] = $size[$j];
+            $messages[$j]["TYPE0"] = $type[$j];
+
+            $num = 0;
+            while ($num < count($flags[$j])) {
+                if ($flags[$j][$num] == 'Deleted') {
+                    $messages[$j]['FLAG_DELETED'] = true;
+                } else if ($flags[$j][$num] == 'Answered') {
+                    $messages[$j]['FLAG_ANSWERED'] = true;
+                } else if ($flags[$j][$num] == 'Seen') {
+                    $messages[$j]['FLAG_SEEN'] = true;
+                } else if ($flags[$j][$num] == 'Flagged') {
+                    $messages[$j]['FLAG_FLAGGED'] = true;
+                }
+                $num++;
             }
-            $msgs[$i] = $messages[$j];
+            $j++;
+    }
 
-            $i++;
+    /* Find and remove the ones that are deleted */
+    $i = 0;
+    $j = 0;
+    while ($j < count($messagelist)) {
+        if (isset($messages[$j]["FLAG_DELETED"]) && $messages[$j]["FLAG_DELETED"] == true) {
             $j++;
+            continue;
         }
-        $numMessages = $i;
+        $msgs[$i] = $messages[$j];
 
-        // There's gotta be messages in the array for it to sort them.
+        $i++;
+        $j++;
+    }
+    $numMessages = $i;
 
-        if (count($messagelist) > 0) {
-            $j=0;
-            if (!isset ($msg)) { $msg = ""; }
-            mail_message_listing_beginning($imapConnection,
-                "move_messages.php?msg=$msg&mailbox=$urlMailbox&where=".urlencode($search_where)."&what=".urlencode($search_what),
-                $mailbox, -1, '<b>' . _("Found") . ' ' . count($messagelist) . ' ' . _("messages") . '</b>',
-                '&nbsp;');
+    /* There's gotta be messages in the array for it to sort them. */
 
+    if (count($messagelist) > 0) {
+        $j=0;
+        if (!isset ($msg)) { 
+            $msg = ''; 
+        }
 
-            while ($j < count($msgs)) {
-                printMessageInfo($imapConnection, $msgs[$j]["ID"], 0, $j, $mailbox, "", 0, $search_where, $search_what);
-                $j++;
-            }
-            echo '</table></tr></td></table>';
+        mail_message_listing_beginning( $imapConnection,
+            "move_messages.php?msg=$msg&mailbox=$urlMailbox&pos=$pos&where=" . urlencode($search_where) . "&what=".urlencode($search_what),
+            $mailbox,
+            -1,
+            '<b>' . _("Found") . ' ' . count($messagelist) . ' ' . _("messages") . '</b>',
+            get_selectall_link($start_msg, $sort) );
+
+
+        while ($j < count($msgs)) {
+            printMessageInfo($imapConnection, $msgs[$j]["ID"], 0, $j, $mailbox, '', 0, $search_where, $search_what);
+            $j++;
         }
+        echo '</table></td></tr></table></form>';
+
     }
+}
 
 ?>