From fc552037ca992235b5fa72ea167a8e0d01d33b9d Mon Sep 17 00:00:00 2001
From: jmehrens <jason_mehrens@hotmail.com>
Date: Sun, 24 Jan 2021 19:50:20 -0600
Subject: [PATCH] UniqueValue should use UUID::randomUUID for boundary and
 messageid #460

Signed-off-by: jmehrens <jason_mehrens@hotmail.com>
---
 .../main/java/com/sun/mail/util/PropUtil.java |  33 ++-
 .../jakarta/mail/internet/MimeMessage.java    |   1 +
 .../jakarta/mail/internet/UniqueValue.java    |  65 ++++--
 .../java/jakarta/mail/internet/package.html   |  29 ++-
 .../mail/util/logging/MailHandlerTest.java    |   2 +-
 .../mail/internet/UniqueValueTest.java        | 198 ++++++++++++++++++
 6 files changed, 307 insertions(+), 21 deletions(-)
 create mode 100644 mail/src/test/java/jakarta/mail/internet/UniqueValueTest.java

diff --git a/mail/src/main/java/com/sun/mail/util/PropUtil.java b/mail/src/main/java/com/sun/mail/util/PropUtil.java
index 1ff431d3..23a06ea3 100644
--- a/mail/src/main/java/com/sun/mail/util/PropUtil.java
+++ b/mail/src/main/java/com/sun/mail/util/PropUtil.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -115,6 +115,37 @@ public static boolean getBooleanSystemProperty(String name, boolean def) {
 	}
     }
 
+    /**
+     * Get a string valued System property.
+     *
+     * @param	name	the property name
+     * @param	def	default value if property not found
+     * @return		the property value
+     */
+    public static String getSystemProperty(String name, String def) {
+	try {
+	    Object v = getProp(System.getProperties(), name);
+            if (v != null) { //found entry
+                return v instanceof String ? (String) v : def;
+            }
+	} catch (ClassCastException useDefault) {
+            return def;
+        } catch (SecurityException sex) {
+	    // fall through...
+	}
+
+	/*
+	 * If we can't get the entire System Properties object because
+	 * of a SecurityException, just ask for the specific property.
+	 */
+	try {
+	    String value = System.getProperty(name);
+	    return value == null ? def : value;
+	} catch (ClassCastException | SecurityException useDefault) {
+	    return def;
+	}
+    }
+
     /**
      * Get the value of the specified property.
      * If the "get" method returns null, use the getProperty method,
diff --git a/mail/src/main/java/jakarta/mail/internet/MimeMessage.java b/mail/src/main/java/jakarta/mail/internet/MimeMessage.java
index f987ec1e..e3a770ea 100644
--- a/mail/src/main/java/jakarta/mail/internet/MimeMessage.java
+++ b/mail/src/main/java/jakarta/mail/internet/MimeMessage.java
@@ -2213,6 +2213,7 @@ public void saveChanges() throws MessagingException {
      *
      * @exception  	MessagingException for failures
      * @since		JavaMail 1.4
+     * @see jakarta.mail.internet.InternetAddress#getLocalAddress
      */
     protected void updateMessageID() throws MessagingException {
 	setHeader("Message-ID", 
diff --git a/mail/src/main/java/jakarta/mail/internet/UniqueValue.java b/mail/src/main/java/jakarta/mail/internet/UniqueValue.java
index 01a6da33..8f73c0a4 100644
--- a/mail/src/main/java/jakarta/mail/internet/UniqueValue.java
+++ b/mail/src/main/java/jakarta/mail/internet/UniqueValue.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -16,7 +16,8 @@
 
 package jakarta.mail.internet;
 
-import java.net.*;
+import com.sun.mail.util.PropUtil;
+import java.util.UUID;
 import java.util.concurrent.atomic.AtomicInteger;
 import jakarta.mail.Session;
 
@@ -36,7 +37,7 @@ class UniqueValue {
     /**
      * A global unique number, to ensure uniqueness of generated strings.
      */
-    private static AtomicInteger id = new AtomicInteger();
+    private static final AtomicInteger id = new AtomicInteger();
 
     /**
      * Get a unique value for use in a multipart boundary string.
@@ -47,12 +48,19 @@ class UniqueValue {
      */
     public static String getUniqueBoundaryValue() {
 	StringBuilder s = new StringBuilder();
-	long hash = s.hashCode();
-
+        s.append("----=_Part_");
+        String p = PropUtil.getSystemProperty(
+                "mail.mime.multipart.boundary.factory", null);
+        if (UniqueValue.class.getName().equals(p)) {
 	// Unique string is ----=_Part_<part>_<hashcode>.<currentTime>
-	s.append("----=_Part_").append(id.getAndIncrement()).append("_").
-	  append(hash).append('.').
+            s.append(id.getAndIncrement()).append("_").
+                append(System.identityHashCode(s)).append('.').
 	  append(System.currentTimeMillis());
+        } else if (UUID.class.getName().equals(p)) {
+            s.append(UUID.randomUUID());
+        } else { //Not defined or malformed property.
+            s.append(UUID.randomUUID());
+        }
 	return s.toString();
     }
 
@@ -71,25 +79,46 @@ public static String getUniqueBoundaryValue() {
      * @see jakarta.mail.internet.InternetAddress
      */
     public static String getUniqueMessageIDValue(Session ssn) {
-	String suffix = null;
+	StringBuilder s = new StringBuilder();
+        String p = messageIdSupplier(ssn);
+        if (UniqueValue.class.getName().equals(p)) {
+            // Unique string is <hashcode>.<id>.<currentTime><suffix>
+            s.append(System.identityHashCode(s)).append('.').
+            append(id.getAndIncrement()).append('.').
+            append(System.currentTimeMillis());
+        } else if (UUID.class.getName().equals(p)) {
+            s.append(UUID.randomUUID());
+        } else { //Not defined or malformed property.
+            s.append(UUID.randomUUID());
+        }
 
+        String suffix;
 	InternetAddress addr = InternetAddress.getLocalAddress(ssn);
 	if (addr != null)
 	    suffix = addr.getAddress();
 	else {
 	    suffix = "jakartamailuser@localhost"; // worst-case default
 	}
-	int at = suffix.lastIndexOf('@');
-	if (at >= 0)
-	    suffix = suffix.substring(at);
-
-	StringBuilder s = new StringBuilder();
 
-	// Unique string is <hashcode>.<id>.<currentTime><suffix>
-	s.append(s.hashCode()).append('.').
-	  append(id.getAndIncrement()).append('.').
-	  append(System.currentTimeMillis()).
-	  append(suffix);
+	int at = suffix.lastIndexOf('@');
+	if (at >= 0) {
+            s.append(suffix, at, suffix.length());
+        } else {
+            s.append(suffix);
+        }
 	return s.toString();
     }
+
+    private static String messageIdSupplier(Session ssn) {
+        String k = "mail.mime.messageid.factory";
+        if (ssn != null) {
+            return ssn.getProperty(k);
+        } else {//Act like default default session without creating it.
+            return PropUtil.getSystemProperty(k, null);
+        }
+    }
+    
+    private UniqueValue() throws IllegalAccessException {
+        throw new IllegalAccessException(UniqueValue.class.getName());
+    }
 }
diff --git a/mail/src/main/java/jakarta/mail/internet/package.html b/mail/src/main/java/jakarta/mail/internet/package.html
index d3412d9f..d87121e7 100644
--- a/mail/src/main/java/jakarta/mail/internet/package.html
+++ b/mail/src/main/java/jakarta/mail/internet/package.html
@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <!--
 
-    Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
+    Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 
     This program and the accompanying materials are made available under the
     terms of the Eclipse Public License v. 2.0, which is available at
@@ -290,6 +290,20 @@
 </TD>
 </TR>
 
+<TR>
+<TD><A ID="mail.mime.messageid.factory">mail.mime.messageid.factory</A></TD>
+<TD>String</TD>
+<TD>
+Sets the format of the MimeMessage message id. If set to 
+<code>"javax.mail.internet.UniqueValue"</code>, for format compatible with older
+versions of JakartaMail.  If set to <code>"java.util.UUID"</code> the message id
+will contain a randomly generator UUID.
+The default is <code>"java.util.UUID"</code> if not specified or format is
+invalid.  The message id suffix can be modified by using <code>mail.from</code>
+or <code>mail.host</code> session properties.
+</TD>
+</TR>
+
 <TR>
 <TD><A ID="mail.replyallcc">mail.replyallcc</A></TD>
 <TD>boolean</TD>
@@ -344,6 +358,19 @@
 </TD>
 </TR>
 
+<TR>
+<TD><A ID="mail.mime.multipart.boundary.factory">mail.mime.multipart.boundary.factory</A></TD>
+<TD>String</TD>
+<TD>
+Sets the format of the MimeMultipart boundary line. If set to 
+<code>"javax.mail.internet.UniqueValue"</code>, for format compatible with older
+versions of JakartaMail.  If set to <code>"java.util.UUID"</code> the boundary
+line will contain a randomly generator UUID.
+The default is <code>"java.util.UUID"</code> if not specified or format is
+invalid.
+</TD>
+</TR>
+
 <TR>
 <TD><A ID="mail.mime.setcontenttypefilename">mail.mime.setcontenttypefilename</A></TD>
 <TD>boolean</TD>
diff --git a/mail/src/test/java/com/sun/mail/util/logging/MailHandlerTest.java b/mail/src/test/java/com/sun/mail/util/logging/MailHandlerTest.java
index 70b7c9f2..7ecdb657 100644
--- a/mail/src/test/java/com/sun/mail/util/logging/MailHandlerTest.java
+++ b/mail/src/test/java/com/sun/mail/util/logging/MailHandlerTest.java
@@ -62,7 +62,7 @@ public class MailHandlerTest extends AbstractLogging {
     /**
      * A host name that can not be resolved.
      */
-    private static final String UNKNOWN_HOST = "bad-host-name";
+    private static final String UNKNOWN_HOST = MailHandlerTest.class.getName();
     /**
      * Stores a writable directory that is in the class path and visible to the
      * context class loader.
diff --git a/mail/src/test/java/jakarta/mail/internet/UniqueValueTest.java b/mail/src/test/java/jakarta/mail/internet/UniqueValueTest.java
new file mode 100644
index 00000000..83c0e940
--- /dev/null
+++ b/mail/src/test/java/jakarta/mail/internet/UniqueValueTest.java
@@ -0,0 +1,198 @@
+/*
+ * Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+package jakarta.mail.internet;
+
+import java.util.Properties;
+import java.util.UUID;
+import jakarta.mail.Session;
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+public class UniqueValueTest {
+
+    public UniqueValueTest() {
+    }
+
+    @Test
+    public void testDefGetUniqueBoundaryValue() {
+        String start = "----=_Part_";
+        String result = UniqueValue.getUniqueBoundaryValue();
+        assertTrue(result, result.startsWith(start));
+        try {
+            UUID.fromString(result.substring(start.length()));
+        } catch (Throwable t) {
+            System.err.println(result);
+            throw t;
+        }
+    }
+
+    @Test
+    public void testUuidGetUniqueBoundaryValue() {
+        String key = "mail.mime.multipart.boundary.factory";
+        System.setProperty(key, UUID.class.getName());
+        try {
+            String start = "----=_Part_";
+            String result = UniqueValue.getUniqueBoundaryValue();
+            assertTrue(result, result.startsWith(start));
+            try {
+                UUID.fromString(result.substring(start.length()));
+            } catch (Throwable t) {
+                System.err.println(result);
+                throw t;
+            }
+        } finally {
+            System.getProperties().remove(key);
+        }
+    }
+
+    @Test
+    public void testUvGetUniqueBoundaryValue() {
+        String key = "mail.mime.multipart.boundary.factory";
+        System.setProperty(key, UniqueValue.class.getName());
+        try {
+            String start = "----=_Part_";
+            String result = UniqueValue.getUniqueBoundaryValue();
+            assertTrue(result, result.startsWith(start));
+            try {
+                int s = start.length();
+                int n = result.indexOf('_', s);
+                Long.parseLong(result.substring(s, n)); //id
+
+                s = n + 1;
+                n = result.indexOf('.', s);
+                Long.parseLong(result.substring(s, n)); //hashCode
+
+                Long.parseLong(result.substring(n + 1)); //millis
+            } catch (Throwable t) {
+                System.err.println(result);
+                throw t;
+            }
+        } finally {
+            System.getProperties().remove(key);
+        }
+    }
+
+    @Test
+    public void testDefGetUniqueMessageIDValue() {
+        Session s = Session.getInstance(new Properties());
+        String result = UniqueValue.getUniqueMessageIDValue(s);
+        UUID.fromString(result.substring(0, result.indexOf('@')));
+    }
+
+    /**
+     * If a session is given but the value is not defined ensure code will not
+     * fallback to using system properties.
+     */
+    @Test
+    public void testUuidNoheritGetUniqueMessageIDValue() {
+        String key = "mail.mime.messageid.factory";
+        System.setProperty(key, UniqueValue.class.getName());
+        try {
+            this.testDefGetUniqueMessageIDValue();
+        } finally {
+            System.getProperties().remove(key);
+        }
+    }
+
+    @Test
+    public void testUvGetUniqueMessageIDValue() {
+        Properties p = new Properties();
+        p.put("mail.mime.messageid.factory",
+                UniqueValue.class.getName());
+        String result = UniqueValue.getUniqueMessageIDValue(
+                Session.getInstance(p));
+        try {
+            int s = 0;
+            int n = result.indexOf('.', s);
+            Long.parseLong(result.substring(s, n)); //id
+
+            s = n + 1;
+            n = result.indexOf('.', s);
+            Long.parseLong(result.substring(s, n)); //hashCode
+
+            s = n + 1;
+            n = result.indexOf('@', s);
+            Long.parseLong(result.substring(s, n)); //millis
+        } catch (Throwable t) {
+            System.err.println(result);
+            throw t;
+        }
+    }
+
+    @Test
+    public void testUuidGetUniqueMessageIDValue() {
+        Properties p = new Properties();
+        p.put("mail.mime.messageid.factory", UUID.class.getName());
+        String result = UniqueValue.getUniqueMessageIDValue(
+                Session.getInstance(p));
+        try {
+            UUID.fromString(result.substring(0, result.indexOf('@')));
+        } catch (Throwable t) {
+            System.err.println(result);
+            throw t;
+        }
+    }
+
+    @Test
+    public void testDefSystemGetUniqueMessageIDValue() {
+        String result = UniqueValue.getUniqueMessageIDValue((Session) null);
+        UUID.fromString(result.substring(0, result.indexOf('@')));
+    }
+
+    @Test
+    public void testUvSystemGetUniqueMessageIDValue() {
+        String key = "mail.mime.messageid.factory";
+        System.setProperty(key, UniqueValue.class.getName());
+        try {
+            String result = UniqueValue.getUniqueMessageIDValue((Session) null);
+            try {
+                int s = 0;
+                int n = result.indexOf('.', s);
+                Long.parseLong(result.substring(s, n)); //id
+
+                s = n + 1;
+                n = result.indexOf('.', s);
+                Long.parseLong(result.substring(s, n)); //hashCode
+
+                s = n + 1;
+                n = result.indexOf('@', s);
+                Long.parseLong(result.substring(s, n)); //millis
+            } catch (Throwable t) {
+                System.err.println(result);
+                throw t;
+            }
+        } finally {
+            System.getProperties().remove(key);
+        }
+    }
+
+    @Test
+    public void testUuidSystemGetUniqueMessageIDValue() {
+        String key = "mail.mime.messageid.factory";
+        System.setProperty(key, UUID.class.getName());
+        try {
+            String result = UniqueValue.getUniqueMessageIDValue((Session) null);
+            try {
+                UUID.fromString(result.substring(0, result.indexOf('@')));
+            } catch (Throwable t) {
+                System.err.println(result);
+                throw t;
+            }
+        } finally {
+            System.getProperties().remove(key);
+        }
+    }
+}