From 367ebd7fa5935d9d514d4be5d708c334e4b73127 Mon Sep 17 00:00:00 2001
From: Makoto Onuki <omakoto@google.com>
Date: Wed, 11 Aug 2010 14:39:45 -0700
Subject: [PATCH] Handle multiple IMAP SEARCH results.

Apparently IMAP servers may return multiple SEARCH responses for a
single SEARCH command, and we need to handle all of them.

Before the IMAP rework there was 3 methods that issued the SEARCH command.
Two of them ware doing it right, but the other wasn't, which was what
I copied from, unfortunately!

In case you're wondering, originally the test for this method was done through
upper methods, e.g. getMessage().

Bug 2911647

Change-Id: Ia50072944d5b01c1e59541c3a966067b13910cc4
---
 .../android/email/mail/store/ImapStore.java   | 14 ++---
 .../email/mail/store/ImapStoreUnitTests.java  | 62 ++++++++++++++++++-
 2 files changed, 65 insertions(+), 11 deletions(-)

diff --git a/src/com/android/email/mail/store/ImapStore.java b/src/com/android/email/mail/store/ImapStore.java
index 656b4e33e..06c6dfccf 100644
--- a/src/com/android/email/mail/store/ImapStore.java
+++ b/src/com/android/email/mail/store/ImapStore.java
@@ -757,7 +757,7 @@ public class ImapStore extends Store {
             throw new Error("ImapStore.delete() not yet implemented");
         }
 
-        private String[] searchForUids(String searchCriteria)
+        /* package */ String[] searchForUids(String searchCriteria)
                 throws MessagingException {
             checkOpen();
             List<ImapResponse> responses;
@@ -771,29 +771,23 @@ public class ImapStore extends Store {
                     throw ioExceptionHandler(mConnection, ioe);
                 }
                 // S: * SEARCH 2 3 6
+                final ArrayList<String> uids = new ArrayList<String>();
                 for (ImapResponse response : responses) {
                     if (!response.isDataResponse(0, ImapConstants.SEARCH)) {
                         continue;
                     }
                     // Found SEARCH response data
-                    final int count = response.size() - 1;
-                    if (count <= 0) {
-                        return Utility.EMPTY_STRINGS; // ... but no UIDs in it!  Return empty array.
-                    }
-
-                    ArrayList<String> ret = new ArrayList<String>(count);
                     for (int i = 1; i < response.size(); i++) {
                         ImapString s = response.getStringOrEmpty(i);
                         if (s.isString()) {
-                            ret.add(s.getString());
+                            uids.add(s.getString());
                         }
                     }
-                    return ret.toArray(Utility.EMPTY_STRINGS);
                 }
+                return uids.toArray(Utility.EMPTY_STRINGS);
             } finally {
                 destroyResponses();
             }
-            return Utility.EMPTY_STRINGS;
         }
 
         @Override
diff --git a/tests/src/com/android/email/mail/store/ImapStoreUnitTests.java b/tests/src/com/android/email/mail/store/ImapStoreUnitTests.java
index 5648a5496..471d276b9 100644
--- a/tests/src/com/android/email/mail/store/ImapStoreUnitTests.java
+++ b/tests/src/com/android/email/mail/store/ImapStoreUnitTests.java
@@ -50,7 +50,6 @@ import android.test.AndroidTestCase;
 import android.test.MoreAsserts;
 import android.test.suitebuilder.annotation.SmallTest;
 
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.regex.Pattern;
@@ -1265,6 +1264,67 @@ public class ImapStoreUnitTests extends AndroidTestCase {
         // TODO: Test NO response. (src message not found)
     }
 
+    public void testSearchForUids() throws Exception {
+        MockTransport mock = openAndInjectMockTransport();
+        setupOpenFolder(mock);
+        mFolder.open(OpenMode.READ_WRITE, null);
+
+        // Single results
+        mock.expect(
+                getNextTag(false) + " UID SEARCH X",
+                new String[] {
+                        "* sEARCH 1",
+                        getNextTag(true) + " oK success"
+                });
+        MoreAsserts.assertEquals(new String[] {
+                "1"
+                }, mFolder.searchForUids("X"));
+
+        // Multiple results, including SEARCH with no UIDs.
+        mock.expect(
+                getNextTag(false) + " UID SEARCH UID 123",
+                new String[] {
+                        "* sEARCH 123 4 567",
+                        "* search",
+                        "* sEARCH 0",
+                        "* SEARCH",
+                        "* sEARCH 100 200 300",
+                        getNextTag(true) + " oK success"
+                });
+        MoreAsserts.assertEquals(new String[] {
+                "123", "4", "567", "0", "100", "200", "300"
+                }, mFolder.searchForUids("UID 123"));
+
+        // NO result
+        mock.expect(
+                getNextTag(false) + " UID SEARCH SOME CRITERIA",
+                new String[] {
+                        getNextTag(true) + " nO not found"
+                });
+        MoreAsserts.assertEquals(new String[] {
+                }, mFolder.searchForUids("SOME CRITERIA"));
+
+        // OK result, but result is empty. (Probably against RFC)
+        mock.expect(
+                getNextTag(false) + " UID SEARCH SOME CRITERIA",
+                new String[] {
+                        getNextTag(true) + " oK success"
+                });
+        MoreAsserts.assertEquals(new String[] {
+                }, mFolder.searchForUids("SOME CRITERIA"));
+
+        // OK result with empty search response.
+        mock.expect(
+                getNextTag(false) + " UID SEARCH SOME CRITERIA",
+                new String[] {
+                        "* search",
+                        getNextTag(true) + " oK success"
+                });
+        MoreAsserts.assertEquals(new String[] {
+                }, mFolder.searchForUids("SOME CRITERIA"));
+    }
+
+
     public void testGetMessage() throws Exception {
         MockTransport mock = openAndInjectMockTransport();
         setupOpenFolder(mock);