#260: Added lots of tests, fixed a name regarding naming and also with mimetype when loading image from classpath/disk

Author: bbottema

modules/core-module/src/main/java/org/simplejavamail/internal/util/ImageMimeType.java

@@ -0,0 +1,86 @@
+package org.simplejavamail.internal.util;
+
+import javax.activation.MimetypesFileTypeMap;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+class ImageMimeType {
+
+    private static final String MIMETYPES = "image/xpm xpm\n"
+            + "image/xbm xbm\n"
+            + "image/x-xwindowdump xwd\n"
+            + "image/x-xwd xwd\n"
+            + "image/x-xpixmap xpm pm\n"
+            + "image/x-xbm xbm\n"
+            + "image/x-xbitmap xbm\n"
+            + "image/x-windows-bmp bmp\n"
+            + "image/x-tiff tif tiff\n"
+            + "image/x-rgb rgb\n"
+            + "image/x-quicktime qtif qti qif\n"
+            + "image/x-portable-pixmap ppm\n"
+            + "image/x-portable-greymap pgm\n"
+            + "image/x-portable-graymap pgm\n"
+            + "image/x-portable-bitmap pbm\n"
+            + "image/x-portable-anymap pnm\n"
+            + "image/x-pict pct\n"
+            + "image/x-pcx pcx\n"
+            + "image/x-niff niff nif\n"
+            + "image/x-jps jps\n"
+            + "image/x-jg art\n"
+            + "image/x-icon ico\n"
+            + "image/x-generic jpg tif wmf tiff bmp xpm png jpeg emf\n"
+            + "image/x-eps eps\n"
+            + "image/x-dwg svf dxf dwg\n"
+            + "image/x-cmu-raster ras\n"
+            + "image/vnd.xiff xif\n"
+            + "image/vnd.wap.wbmp wbmp\n"
+            + "image/vnd.rn-realpix rp\n"
+            + "image/vnd.rn-realflash rf\n"
+            + "image/vnd.net-fpx fpx\n"
+            + "image/vnd.fpx fpx\n"
+            + "image/vnd.dwg svf dxf dwg\n"
+            + "image/vasa mcf\n"
+            + "image/tiff tif tiff\n"
+            + "image/svg+xml svgz svg\n"
+            + "image/png x-png png PNG\n"
+            + "image/pjpeg jpg jfif jpeg jpe\n"
+            + "image/pict pic pict\n"
+            + "image/naplps naplps nap\n"
+            + "image/jutvision jut\n"
+            + "image/jpeg jpg JPG jfif jpeg jfif-tbnl jpe\n"
+            + "image/ief iefs ief\n"
+            + "image/gif gif GIF\n"
+            + "image/g3fax g3\n"
+            + "image/florian flo turbot\n"
+            + "image/fif fif\n"
+            + "image/cmu-raster ras rast\n"
+            + "image/bmp bmp bm";
+
+    public static final MimetypesFileTypeMap IMAGE_MIMETYPES_FILE_TYPE_MAP = createMap();
+
+    /**
+     * @return a vastly improved mimetype map
+     */
+    private static MimetypesFileTypeMap createMap() {
+        try (InputStream is = new ByteArrayInputStream(MIMETYPES.getBytes(UTF_8))) {
+            return new MimetypesFileTypeMap(is);
+        } catch (IOException ex) {
+            throw new RuntimeException(ex);
+        }
+    }
+
+    public static String getContentType(String fileName) {
+        return getContentType(fileName, null);
+    }
+
+    public static String getContentType(String fileName, String charset) {
+        String mimeType = IMAGE_MIMETYPES_FILE_TYPE_MAP.getContentType(fileName.toLowerCase());
+        if (charset != null && (mimeType.startsWith("text/") || mimeType.contains("javascript"))) {
+            mimeType += ";charset=" + charset.toLowerCase();
+        }
+        return mimeType;
+    }
+}

modules/core-module/src/main/java/org/simplejavamail/internal/util/MiscUtil.java

@@ -7,7 +7,6 @@
 
 import javax.activation.DataSource;
 import javax.activation.FileDataSource;
-import javax.activation.FileTypeMap;
 import javax.activation.URLDataSource;
 import javax.mail.Message.RecipientType;
 import javax.mail.internet.AddressException;
@@ -278,20 +277,22 @@ public static ByteArrayInputStream copyInputstream(InputStream input) {
 	}
 
 	@Nullable
-	public static  DataSource tryResolveFileDataSource(@Nullable final String baseDir, @Nullable final String baseClassPath, @NotNull final String srcLocation)
+	public static  DataSource tryResolveImageFileDataSource(@Nullable final String baseDir, @Nullable final String baseClassPath, @NotNull final String srcLocation)
 			throws IOException {
-		DataSource fileSource = tryResolveFileDataSourceFromDisk(baseDir, srcLocation);
+		DataSource fileSource = tryResolveImageFileDataSourceFromDisk(baseDir, srcLocation);
 		return (fileSource != null) ? fileSource : tryResolveFileDataSourceFromClassPath(baseClassPath, srcLocation);
 	}
 
 	@Nullable
-	private static DataSource tryResolveFileDataSourceFromDisk(final @Nullable String baseDir, final @NotNull String srcLocation) {
+	private static DataSource tryResolveImageFileDataSourceFromDisk(final @Nullable String baseDir, final @NotNull String srcLocation) {
 		File file = new File(srcLocation);
 		if (!file.exists() && !file.isAbsolute()) {
 			file = new File(ofNullable(baseDir).orElse("."), srcLocation);
 		}
 		if (file.exists()) {
-			return new FileDataSource(file);
+			final FileDataSource fileDataSource = new FileDataSource(file);
+			fileDataSource.setFileTypeMap(ImageMimeType.IMAGE_MIMETYPES_FILE_TYPE_MAP);
+			return fileDataSource;
 		}
 		return null;
 	}
@@ -304,7 +305,7 @@ private static DataSource tryResolveFileDataSourceFromClassPath(final @Nullable
 
 		if (is != null) {
 			try {
-				final String mimeType = FileTypeMap.getDefaultFileTypeMap().getContentType(srcLocation);
+				final String mimeType = ImageMimeType.getContentType(srcLocation);
 				final ByteArrayDataSource ds = new ByteArrayDataSource(is, mimeType);
 				// EMAIL-125: set the name of the DataSource to the normalized resource URL similar to other DataSource implementations, e.g. FileDataSource, URLDataSource
 				ds.setName(MiscUtil.class.getResource(resourceName).toString());

modules/simple-java-mail/src/test/java/org/simplejavamail/api/email/NamedDataSource.java renamed to modules/core-module/src/main/java/org/simplejavamail/internal/util/NamedDataSource.java

@@ -1,4 +1,4 @@
-package org.simplejavamail.api.email;
+package org.simplejavamail.internal.util;
 
 import org.jetbrains.annotations.Nullable;
 
@@ -13,7 +13,7 @@
 /**
  * Allows given datasource to be renamed (for {@code javax.activation.DataHandler} perspective).
  */
-class NamedDataSource implements DataSource, EncodingAware {
+public class NamedDataSource implements DataSource, EncodingAware {
 
 	/**
 	 * Original data source used for attachment.

modules/simple-java-mail/src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageHelper.java

@@ -1,13 +1,14 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
+import org.jetbrains.annotations.NotNull;
 import org.simplejavamail.api.email.AttachmentResource;
 import org.simplejavamail.api.email.Email;
 import org.simplejavamail.api.email.Recipient;
 import org.simplejavamail.internal.util.MiscUtil;
+import org.simplejavamail.internal.util.NamedDataSource;
 
 import javax.activation.DataHandler;
 import javax.activation.DataSource;
-import org.jetbrains.annotations.NotNull;
 import javax.mail.Address;
 import javax.mail.BodyPart;
 import javax.mail.Message;

modules/simple-java-mail/src/main/java/org/simplejavamail/converter/internal/mimemessage/NamedDataSource.java

@@ -3,7 +3,6 @@
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import org.simplejavamail.MailException;
 import org.simplejavamail.api.email.AttachmentResource;
 import org.simplejavamail.api.email.CalendarMethod;
 import org.simplejavamail.api.email.Email;
@@ -17,6 +16,7 @@
 import org.simplejavamail.email.EmailBuilder;
 import org.simplejavamail.internal.util.CertificationUtil;
 import org.simplejavamail.internal.util.MiscUtil;
+import org.simplejavamail.internal.util.NamedDataSource;
 
 import javax.activation.DataSource;
 import javax.mail.Message.RecipientType;
@@ -85,7 +85,7 @@
 import static org.simplejavamail.internal.util.MiscUtil.extractEmailAddresses;
 import static org.simplejavamail.internal.util.MiscUtil.randomCid10;
 import static org.simplejavamail.internal.util.MiscUtil.resolveUrlDataSource;
-import static org.simplejavamail.internal.util.MiscUtil.tryResolveFileDataSource;
+import static org.simplejavamail.internal.util.MiscUtil.tryResolveImageFileDataSource;
 import static org.simplejavamail.internal.util.MiscUtil.valueNullOrEmpty;
 import static org.simplejavamail.internal.util.Preconditions.assumeNonNull;
 import static org.simplejavamail.internal.util.Preconditions.checkNonEmptyArgument;
@@ -375,8 +375,9 @@ private void resolveDynamicEmbeddedImageDataSources() {
 				final String srcLocation = matcher.group("src");
 				if (!srcLocation.startsWith("cid:")) {
 					if (!generatedCids.containsKey(srcLocation)) {
-						generatedCids.put(srcLocation, randomCid10());
-						withEmbeddedImage(generatedCids.get(srcLocation), resolveDynamicEmbeddedImageDataSource(srcLocation));
+						final String cid = randomCid10();
+						generatedCids.put(srcLocation, cid);
+						withEmbeddedImage(cid, new NamedDataSource(cid, resolveDynamicEmbeddedImageDataSource(srcLocation)));
 					}
 					final String imgSrcReplacement = matcher.group("imageTagStart") + "cid:" + generatedCids.get(srcLocation) + matcher.group("imageSrcEnd");
 					matcher.appendReplacement(stringBuffer, quoteReplacement(imgSrcReplacement));
@@ -390,7 +391,7 @@ private void resolveDynamicEmbeddedImageDataSources() {
 
 	private DataSource resolveDynamicEmbeddedImageDataSource(@NotNull final String srcLocation) {
 		try {
-			DataSource resolvedDataSource = tryResolveFileDataSource(embeddedImageBaseDir, embeddedImageBaseClassPath, srcLocation);
+			DataSource resolvedDataSource = tryResolveImageFileDataSource(embeddedImageBaseDir, embeddedImageBaseClassPath, srcLocation);
 			if (resolvedDataSource == null) {
 				resolvedDataSource = resolveUrlDataSource(embeddedImageBaseUrl, srcLocation);
 			}

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/EmailPopulatingBuilderImpl.java

@@ -12,16 +12,20 @@
 import java.io.IOException;
 import java.nio.charset.Charset;
 
+import static demo.ResourceFolderHelper.determineResourceFolder;
+
 /**
  * Demonstration program for the Simple Java Mail framework. Just fill your gmail, password and press GO.
  */
 public class FullEmailDemoApp extends DemoAppBase {
-	
+
 	public static void main(final String[] args) throws IOException {
 		testMixedRelatedAlternativeIncludingCalendarAndMessageParsingUsingVariousMailers();
 	}
 
 	private static void testMixedRelatedAlternativeIncludingCalendarAndMessageParsingUsingVariousMailers() throws IOException {
+		final String resourcesPathOnDisk = determineResourceFolder("simple-java-mail") + "/test/resources";
+
 		final EmailPopulatingBuilder emailPopulatingBuilderNormal = EmailBuilder.startingBlank();
 		emailPopulatingBuilderNormal.from("Simple Java Mail demo", "[email protected]");
 		// don't forget to add your own address here ->
@@ -30,7 +34,13 @@ private static void testMixedRelatedAlternativeIncludingCalendarAndMessageParsin
 		emailPopulatingBuilderNormal.withHTMLText("<p>This is an email with \"mixed\", \"related\" and \"alternative\" content: it contains a plain " +
 				"text part (ignored in favor of HTML by modern clients), an HTML content part (this HTML text) which references a related " +
 				"content part (the embedded image) and a iCalendar content part. In addition this email contains a separate attachment as " +
-				"well.</p><img src='cid:thumbsup'>" +
+				"well.</p>" +
+				"<ol>" +
+				"   <li>Image embedded with fixed cid and hardcoded datasource: <img width=25 src='cid:thumbsup'></li>" +
+				"   <li>Image embedded with generated cid datasource resolved from classpath:<img src='/test-dynamicembedded-image/excellent.png' style='width:25px'></li>" +
+				"   <li>Image embedded with generated cid datasource resolved from disk:<img src='" + resourcesPathOnDisk + "/test-dynamicembedded-image/excellent.png' style='width:25px'></li>" +
+				"   <li>Image embedded with generated cid datasource resolved from URL!:<img src='http://www.simplejavamail.org/assets/[email protected]' style='width:32px' title='Fork me on GitHub'></li>" +
+				"</ol>" +
 				"<p><b>Formal structure:</b><br>" +
 				"<ul>" +
 				"   <li>mixed (root)<ul>" +
@@ -39,7 +49,7 @@ private static void testMixedRelatedAlternativeIncludingCalendarAndMessageParsin
 				"   			<li>plain text</li>" +
 				"				<li>HTML text</li>" +
 				"			</ul></li>" +
-				"			<li>embeddable image (cid:thumbsup) </li>" +
+				"			<li>embeddable images (1x fixed: cid:thumbsup and 3x dynamically resolved)</li>" +
 				"		</ul></li>" +
 				"		<li>attachment</li>" +
 				"	</ul></li>" +
@@ -59,8 +69,8 @@ private static void testMixedRelatedAlternativeIncludingCalendarAndMessageParsin
 		final Email emailFromMimeMessage = EmailConverter.mimeMessageToEmail(mimeMessage);
 
 		mailerSMTPBuilder.buildMailer().sendMail(emailNormal);
-		mailerTLSBuilder.buildMailer().sendMail(emailNormal);
-		mailerSSLBuilder.buildMailer().sendMail(emailNormal);
-		mailerTLSBuilder.buildMailer().sendMail(emailFromMimeMessage); // should produce the exact same result as emailPopulatingBuilderNormal!
+//		mailerTLSBuilder.buildMailer().sendMail(emailNormal);
+//		mailerSSLBuilder.buildMailer().sendMail(emailNormal);
+//		mailerTLSBuilder.buildMailer().sendMail(emailFromMimeMessage); // should produce the exact same result as emailPopulatingBuilderNormal!
 	}
 }

modules/simple-java-mail/src/test/java/demo/FullEmailDemoApp.java

@@ -6,6 +6,7 @@
 import org.junit.Test;
 import org.simplejavamail.api.mailer.config.Pkcs12Config;
 import org.simplejavamail.email.EmailBuilder;
+import org.simplejavamail.internal.util.NamedDataSource;
 import testutil.ConfigLoaderTestHelper;
 import testutil.EmailHelper;
 
@@ -204,8 +205,8 @@ public void testEqualsEmail_EqualityFieldByField() throws IOException {
 		assertEmailEqual(b().withCalendarText(ADD, "moo").buildEmail(), b().withCalendarText(REPLY, "moo").buildEmail(), false);
 		assertEmailEqual(b().withCalendarText(ADD, "moo").buildEmail(), b().buildEmail(), false);
 		// forWardEmail
-		final Email email = EmailHelper.createDummyEmailBuilder(true, false, true, true).buildEmail();
-		final Email emailOther = EmailHelper.createDummyEmailBuilder(false, true, false, false).buildEmail();
+		final Email email = EmailHelper.createDummyEmailBuilder(true, false, true, true, false).buildEmail();
+		final Email emailOther = EmailHelper.createDummyEmailBuilder(false, true, false, false, false).buildEmail();
 		assertEmailEqual(f(email).buildEmail(), f(email).buildEmail(), true);
 		assertEmailEqual(f(email).buildEmail(), b().buildEmail(), false);
 		assertEmailEqual(f(email).buildEmail(), f(emailOther).buildEmail(), false);

modules/simple-java-mail/src/test/java/org/simplejavamail/api/email/EmailTest.java

@@ -202,9 +202,9 @@ public void loadPropertiesFromFileClassPath() {
 		assertThat(ConfigLoader.getProperty(SMIME_SIGNING_KEY_PASSWORD)).isEqualTo("letmein");
 		assertThat(ConfigLoader.getProperty(SMIME_ENCRYPTION_CERTIFICATE)).isEqualTo("src/test/resources/pkcs12/smime_test_user.pem.standard.crt");
 
-		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR)).isEqualTo("unable to test this as the value is variable depending on junit working folder");
-		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL)).isEqualTo("http://www.simplejavamail.org");
-		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH)).isEqualTo("/pkcs12");
+		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR)).isEqualTo("");
+		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL)).isEqualTo("");
+		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH)).isEqualTo("");
 	}
 
 	@Test