search with Unicode char throws BadCommandException with UTF8=ALLOW - fix #333

Author: bshannon

doc/release/CHANGES.txt

@@ -33,6 +33,7 @@ GH  323	Support loading protocol providers using ServiceLoader
 GH  326	Apply relaxed Content-Disposition parsing to Content-Disposition params
 GH  330	Attachment filename is ignored
 GH  332	http proxy support should support authenticating to the proxy server
+GH  333	search with Unicode char throws BadCommandException with UTF8=ALLOW
 GH  334	gimap set labels error with some non english characters
 
 

mail/src/main/java/com/sun/mail/imap/protocol/IMAPProtocol.java

@@ -2493,17 +2493,20 @@ public int[] search(SearchTerm term)
      */
     private int[] search(String msgSequence, SearchTerm term)
 			throws ProtocolException, SearchException {
-	// Check if the search "text" terms contain only ASCII chars
-	if (SearchSequence.isAscii(term)) {
+	// Check if the search "text" terms contain only ASCII chars,
+	// or if utf8 support has been enabled (in which case CHARSET
+	// is not allowed; see RFC 6855, section 3, last paragraph)
+	if (supportsUtf8() || SearchSequence.isAscii(term)) {
 	    try {
 		return issueSearch(msgSequence, term, null);
 	    } catch (IOException ioex) { /* will not happen */ }
 	}
 
 	/*
-	 * The search "text" terms do contain non-ASCII chars. We need to
-	 * use SEARCH CHARSET <charset> ...
-	 *	The charsets we try to use are UTF-8 and the locale's
+	 * The search "text" terms do contain non-ASCII chars and utf8
+	 * support has not been enabled.  We need to use:
+	 * "SEARCH CHARSET <charset> ..."
+	 * The charsets we try to use are UTF-8 and the locale's
 	 * default charset. If the server supports UTF-8, great, 
 	 * always use it. Else we try to use the default charset.
 	 */

mail/src/test/java/com/sun/mail/imap/IMAPSearchTest.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2009-2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2009-2018 Oracle and/or its affiliates. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
@@ -113,4 +113,69 @@ public void search(String line) throws IOException {
             }
         }
     }
+
+    /**
+     * Test that when the server supports UTF8 and the client enables it,
+     * the client doesn't issue a SEARCH CHARSET command even if the search
+     * term includes a non-ASCII character.
+     * (see RFC 6855, section 3, last paragraph)
+     */
+    @Test
+    public void testUtf8Search() {
+        TestServer server = null;
+        try {
+            server = new TestServer(new IMAPUtf8Handler() {
+		@Override
+		public void search(String line) throws IOException {
+		    if (line.contains("CHARSET"))
+			bad("CHARSET not supported");
+		    else
+			ok();
+		}
+	    });
+            server.start();
+
+            final Properties properties = new Properties();
+            properties.setProperty("mail.imap.host", "localhost");
+            properties.setProperty("mail.imap.port", "" + server.getPort());
+            final Session session = Session.getInstance(properties);
+            //session.setDebug(true);
+
+            final Store store = session.getStore("imap");
+	    Folder folder = null;
+            try {
+                store.connect("test", "test");
+                folder = store.getFolder("INBOX");
+                folder.open(Folder.READ_ONLY);
+		Message[] msgs = folder.search(new SubjectTerm("\u2019"));
+	    } catch (Exception ex) {
+		System.out.println(ex);
+		//ex.printStackTrace();
+		fail(ex.toString());
+            } finally {
+		if (folder != null)
+		    folder.close(false);
+                store.close();
+            }
+        } catch (final Exception e) {
+            e.printStackTrace();
+            fail(e.getMessage());
+        } finally {
+            if (server != null) {
+                server.quit();
+            }
+        }
+    }
+
+    /**
+     * An IMAPHandler that enables UTF-8 support.
+     */
+    private static class IMAPUtf8Handler extends IMAPHandler {
+	{{ capabilities += " ENABLE UTF8=ACCEPT"; }}
+
+	@Override
+	public void enable(String line) throws IOException {
+	    ok();
+	}
+    }
 }