Merge pull request #5 from DirectProjectJavaRI/develop

Releasing 6.0.1

Author: Greg Meyer

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>direct-common</artifactId>    
     <name>Direct Project common APIs</name>
-    <version>6.0</version>
+    <version>6.0.1</version>
     <description>Direct Project common APIs.  Includes instrumentation, auditing, and other utility APIs</description>
     <inceptionYear>2010</inceptionYear>
     <url>http://api.nhindirect.org/x/www/api.nhindirect.org/java/site/direct-common/${project.version}</url> 
@@ -28,7 +28,7 @@
    <parent>
 	   <groupId>org.springframework.boot</groupId>
 	   <artifactId>spring-boot-dependencies</artifactId>
-	   <version>2.1.2.RELEASE</version>
+	   <version>2.1.6.RELEASE</version>
    </parent>	   
 	<scm>
 		<url>scm:git:https://github.com/DirectProjectJavaRI/direct-common.git</url>
@@ -45,14 +45,14 @@
 			<dependency>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-dependencies</artifactId>
-				<version>2.1.2.RELEASE</version>
+				<version>2.1.6.RELEASE</version>
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>			
 			<dependency>
 				<groupId>org.springframework.cloud</groupId>
 				<artifactId>spring-cloud-starter-parent</artifactId>
-				 <version>Greenwich.RELEASE</version>
+				 <version>Greenwich.SR1</version>
 				<type>pom</type>
 				<scope>import</scope>		
 			</dependency>											
@@ -258,7 +258,7 @@
       <plugin>
       	<groupId>org.apache.maven.plugins</groupId> 
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>2.6.1</version>
+        <version>2.9.1</version>
         <configuration>
 		    <additionalparam>-Xdoclint:none</additionalparam>
 			<charset>UTF-8</charset>
@@ -309,7 +309,7 @@
 	      <plugin>
 	      	<groupId>org.apache.maven.plugins</groupId> 
 	        <artifactId>maven-javadoc-plugin</artifactId>
-	        <version>2.6.1</version>
+	        <version>2.9.1</version>
 	        <configuration>
 			    <additionalparam>-Xdoclint:none</additionalparam>
 				<charset>UTF-8</charset>

src/main/java/org/nhindirect/common/mail/dsn/impl/DefaultDSNFailureTextBodyPartGenerator.java

@@ -111,7 +111,8 @@ protected String headersToString(Enumeration<Header> originalMessageHeaders)
 		while (originalMessageHeaders.hasMoreElements()) 
 		{
 		    Header h = originalMessageHeaders.nextElement();
-		    sb.append(StringEscapeUtils.escapeHtml4(h.getName() + ": " + h.getValue()));
+		    // use escapeXml10 vs escapeHtml4 for its NUL character removing capabilities
+		    sb.append(StringEscapeUtils.escapeXml10(h.getName() + ": " + h.getValue()));
 		    sb.append("<br/>");
 		}
 		return sb.toString();

src/site/apt/releaseNotes.apt

@@ -6,6 +6,22 @@
         Greg Meyer
         ---
 
+{6.0.1}
+
+    Changes included with release 6.0.1
+    
+    []
+    
+    Enhancements
+    
+ 	* NA
+
+    [] 
+     
+    Bug Fixes
+
+ 	* Fixed Null character in HTML parsing when generating DSN messages
+
 {6.0}
 
     Changes included with release 6.0

src/test/java/org/nhindirect/common/mail/dsn/DNSGenerator_CreateDSNMessageTest.java

@@ -1,17 +1,22 @@
 package org.nhindirect.common.mail.dsn;
 
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
+import static org.hamcrest.CoreMatchers.containsString;
 import static org.junit.Assert.assertEquals;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.UUID;
 
 import javax.mail.Address;
+import javax.mail.Header;
 import javax.mail.internet.InternetAddress;
 import javax.mail.internet.MimeBodyPart;
 import javax.mail.internet.MimeMessage;
+import javax.mail.internet.MimeMultipart;
 
 import org.junit.Test;
 import org.nhindirect.common.mail.MailStandard;
@@ -62,4 +67,46 @@ public void testCreateDSNMessage_createGeneralDSNMessage() throws Exception
 		assertTrue(!MailStandard.getHeader(dsnMessage, MailStandard.Headers.Date).isEmpty());
 
 	}
+
+	@Test
+	public void testCreateDSNMessage_createDSNMessageWithOriginalHeaders() throws Exception
+	{
+		final DSNGenerator dsnGenerator = new DSNGenerator("Not Delivered:");
+		
+		final DSNRecipientHeaders dsnRecipHeaders = 
+				new DSNRecipientHeaders(DSNAction.FAILED, 
+						DSNStatus.getStatus(DSNStatus.PERMANENT, DSNStatus.UNDEFINED_STATUS), new InternetAddress("ah4626@test.com"));
+		
+		final List<DSNRecipientHeaders> dsnHeaders = new ArrayList<DSNRecipientHeaders>();
+		dsnHeaders.add(dsnRecipHeaders);
+		
+		final String originalMessageId = UUID.randomUUID().toString();
+		final DSNMessageHeaders messageDSNHeaders = new DSNMessageHeaders("DirectJUNIT", originalMessageId, MtaNameType.DNS);
+		
+		List<Address> faileRecips = new ArrayList<Address>();
+		faileRecips.add(new InternetAddress("ah4626@test.com"));
+		
+		List<Header> originalMessageHeaders = new ArrayList<Header>();
+		originalMessageHeaders.add(new Header("Date", "Tue, 11 Jun 2015 02:43:38 -0500 (CDT)"));
+		originalMessageHeaders.add(new Header("From", "\"Smith, John\" <from@test.com>"));
+		originalMessageHeaders.add(new Header("To", "\"Ben & Jerry\" <benandjerry@test.com>"));
+		originalMessageHeaders.add(new Header("Subject", "subject \0goes here")); // this subject contains a NUL character, which should get removed
+		
+		final DefaultDSNFailureTextBodyPartGenerator textGenerator = new DefaultDSNFailureTextBodyPartGenerator("", "%headers_tag%", "",
+				"", "", HumanReadableTextAssemblerFactory.getInstance());
+		
+		
+		
+		final MimeBodyPart textBodyPart = textGenerator.generate(new InternetAddress("gm2552@test.com"), faileRecips, Collections.enumeration(originalMessageHeaders));
+		
+		MimeMessage dsnMessage = dsnGenerator.createDSNMessage(new InternetAddress("gm2552@test.com"), "test", new InternetAddress("postmaster@test.com"), 
+				dsnHeaders, messageDSNHeaders, textBodyPart);
+		
+		assertNotNull(dsnMessage);
+		MimeBodyPart htmlBodyPart = (MimeBodyPart) ((MimeMultipart) dsnMessage.getContent()).getBodyPart(0);
+		String htmlContent = (String) htmlBodyPart.getContent();
+		assertThat(htmlContent, containsString("subject goes here")); // NUL is removed
+		assertThat(htmlContent, containsString("Ben &amp; Jerry")); // ampersand is encoded
+		assertThat(htmlContent, containsString("&lt;from@test.com&gt;")); // <> are encoded
+	}
 }