YAGNI: Emblem interface

2 files changed, 248 insertions, 276 deletions

diff --git a/pdf-over-signator/src/main/java/at/asit/pdfover/signator/CachedFileNameEmblem.java b/pdf-over-signator/src/main/java/at/asit/pdfover/signator/CachedFileNameEmblem.java
deleted file mode 100644
index 236fb905..00000000
--- a/pdf-over-signator/src/main/java/at/asit/pdfover/signator/CachedFileNameEmblem.java
+++ /dev/null
@@ -1,271 +0,0 @@
-/*
- * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
- *
- * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
- * the European Commission - subsequent versions of the EUPL (the "Licence");
- * You may not use this work except in compliance with the Licence.
- * You may obtain a copy of the Licence at:
- * http://joinup.ec.europa.eu/software/page/eupl
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the Licence is distributed on an "AS IS" basis,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Licence for the specific language governing permissions and
- * limitations under the Licence.
- */
-package at.asit.pdfover.signator;
-
-// Imports
-import java.awt.Graphics2D;
-import java.awt.image.BufferedImage;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.nio.file.Files;
-import java.nio.file.Paths;
-import java.util.Iterator;
-import java.util.Properties;
-
-import javax.imageio.ImageIO;
-import javax.imageio.ImageReader;
-import javax.imageio.stream.ImageInputStream;
-
-import org.apache.commons.codec.digest.DigestUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import com.drew.imaging.ImageMetadataReader;
-import com.drew.imaging.ImageProcessingException;
-import com.drew.metadata.Metadata;
-import com.drew.metadata.MetadataException;
-import com.drew.metadata.exif.ExifDirectoryBase;
-import com.drew.metadata.exif.ExifIFD0Directory;
-
-/**
- *
- */
-public class CachedFileNameEmblem implements Emblem {
-	/**
-	 * SLF4J Logger instance
-	 **/
-	private static final Logger log = LoggerFactory.getLogger(CachedFileNameEmblem.class);
-
-	private final String fileDir = System.getProperty("user.home") + File.separator + ".pdf-over";
-	private final String imgFileName = ".emblem";
-	private final String imgFileExt = "png";
-	private final String propFileName = ".emblem.properties";
-
-	private final String imgProp = "IMG";
-	private final String hshProp = "HSH";
-	private final int maxWidth  = 480;
-	private final int maxHeight = 600;
-
-	private String fileName = null;
-
-	/**
-	 * Constructor
-	 * @param filename
-	 */
-	public CachedFileNameEmblem(String filename) {
-		this.fileName = filename;
-	}
-
-	private String getFileHash(String filename) throws IOException {
-		InputStream is = Files.newInputStream(Paths.get(this.fileName));
-		return DigestUtils.md5Hex(is);
-	}
-
-	/**
-	 * Correctly rotate JPEG image by EXIF header
-	 * @param img the image
-	 * @param imgFile the image file
-	 * @return the fixed image
-	 */
-	public static BufferedImage fixImage(BufferedImage img, File imgFile) {
-		int oheight = img.getHeight();
-		int owidth = img.getWidth();
-
-		// Read EXIF metadata for jpeg
-		ImageInputStream iis = null;
-		try {
-			iis = ImageIO.createImageInputStream(imgFile);
-			Iterator<ImageReader> imageReaders = ImageIO.getImageReaders(iis);
-
-			while (imageReaders.hasNext()) {
-				ImageReader reader = imageReaders.next();
-				log.debug(reader.getFormatName());
-				if (reader.getFormatName().equals("JPEG")) {
-					try {
-						Metadata metadata = ImageMetadataReader.readMetadata(imgFile);
-						ExifIFD0Directory metaDirectory = (metadata != null) ? metadata.getFirstDirectoryOfType(ExifIFD0Directory.class) : null;
-						if (metaDirectory != null) {
-							int orientation = metaDirectory.getInt(
-									ExifDirectoryBase.TAG_ORIENTATION);
-							if (orientation > 2) {
-								// rotate
-								double rotation = 0;
-								int height = owidth;
-								int width = oheight;
-								switch ((orientation + 1) / 2) {
-									case 2:
-										rotation = Math.PI;
-										height = oheight;
-										width = owidth;
-										break;
-									case 3:
-										rotation = Math.PI / 2;
-										break;
-									case 4:
-										rotation = 3 * Math.PI / 2;
-										break;
-								}
-								log.debug("EXIF orientation " + orientation + ", rotating " + rotation + "rad");
-								BufferedImage result = new BufferedImage(width, height, img.getType());
-								Graphics2D g = result.createGraphics();
-								g.translate((width - owidth) / 2, (height - oheight) / 2);
-								g.rotate(rotation, owidth / 2, oheight / 2);
-								g.drawRenderedImage(img, null);
-								g.dispose();
-								img = result;
-								owidth = width;
-								oheight = height;
-							}
-							if (((orientation < 5) && (orientation % 2 == 0)) ||
-									(orientation > 5) && (orientation % 2 == 1)) {
-								// flip
-								log.debug("flipping image");
-								BufferedImage result = new BufferedImage(owidth, oheight, img.getType());
-								Graphics2D g = result.createGraphics();
-								g.drawImage(img, owidth, 0, -owidth, oheight, null);
-								g.dispose();
-								img = result;
-							}
-						}
-					} catch (ImageProcessingException e) {
-						log.error("Error reading emblem metadata", e);
-					} catch (MetadataException e) {
-						log.error("Error reading emblem metadata", e);
-					} catch (NullPointerException e) {
-						log.error("Error reading emblem metadata", e);
-					}
-				}
-			}
-		} catch (IOException e) {
-			log.error("Error reading image" , e);
-		} finally {
-			try {
-				if (iis != null)
-					iis.close();
-			} catch (IOException e) {
-				log.debug("Error closing stream", e);
-			}
-		}
-		return img;
-	}
-
-	private static BufferedImage scaleImage(BufferedImage img, int maxWidth, int maxHeight) {
-		int oheight = img.getHeight();
-		int owidth = img.getWidth();
-
-		double ratio = (double)owidth/(double)oheight;
-
-		int height = oheight;
-		int width = owidth;
-		if (height > maxHeight) {
-			height = maxHeight;
-			width = (int) (maxHeight * ratio);
-		}
-		if (width > maxWidth) {
-			width = maxWidth;
-			height = (int) (maxWidth / ratio);
-		}
-		BufferedImage result = img;
-		if (width != owidth || height == oheight) {
-			//scale image
-			log.debug("Scaling emblem: " + owidth + "x" + oheight + " to " + width + "x" + height);
-			result = new BufferedImage(width, height, img.getType() == 0 ? BufferedImage.TYPE_INT_ARGB : img.getType());
-			Graphics2D g = result.createGraphics();
-			g.drawImage(img, 0, 0, width, height, null);
-			g.dispose();
-		}
-		return result;
-	}
-
-	/* (non-Javadoc)
-	 * @see at.asit.pdfover.signator.Emblem#getFileName()
-	 */
-	@Override
-	public String getFileName() {
-		String emblemImg = this.fileName;
-		String emblemHsh = null;
-		String cachedEmblemFileName = this.fileDir + File.separator + this.imgFileName + "." + this.imgFileExt;
-
-		if (emblemImg == null || !(new File(emblemImg).exists()))
-			return null;
-
-		Properties emblemProps = new Properties();
-		// compare cache, try to load if match
-		try {
-			InputStream in = new FileInputStream(new File(this.fileDir, this.propFileName));
-			emblemProps.load(in);
-			if (emblemImg.equals(emblemProps.getProperty(this.imgProp))) {
-				emblemHsh = getFileHash(emblemImg);
-				if (emblemHsh.equals(emblemProps.getProperty(this.hshProp))) {
-					log.debug("Emblem cache hit: " + cachedEmblemFileName);
-					return cachedEmblemFileName;
-				}
-			}
-			log.debug("Emblem cache miss");
-		} catch (Exception e) {
-			log.warn("Can't load emblem cache", e);
-		}
-
-		try {
-			// create new cache
-			if (emblemHsh == null)
-				emblemHsh = getFileHash(emblemImg);
-			emblemProps.setProperty(this.imgProp, emblemImg);
-			emblemProps.setProperty(this.hshProp, emblemHsh);
-			File imgFile = new File(emblemImg);
-
-			BufferedImage img = ImageIO.read(imgFile);
-			img = fixImage(img, imgFile);
-			img = scaleImage(img, this.maxWidth, this.maxHeight);
-
-			File file = new File(this.fileDir, this.imgFileName + "." + this.imgFileExt);
-			ImageIO.write(img, this.imgFileExt, file); // ignore returned boolean
-			OutputStream out = new FileOutputStream(new File(this.fileDir, this.propFileName));
-			emblemProps.store(out, null);
-		} catch (IOException e) {
-			log.error("Can't save emblem cache", e);
-			return this.fileName;
-		}
-		return cachedEmblemFileName;
-	}
-
-	/**
-	 * Return the original filename
-	 * @return the original filename
-	 */
-	public String getOriginalFileName() {
-		return this.fileName;
-	}
-
-	/**
-	 * Return the original filename
-	 * @return the original filename
-	 */
-	public String getOriginalFileHash() {
-		if (this.fileName == null || !(new File(this.fileName).exists()))
-			return "";
-		try {
-			return getFileHash(this.fileName);
-		} catch (IOException e) {
-			log.debug("Error getting file hash", e);
-			return "";
-		}
-	}
-}
diff --git a/pdf-over-signator/src/main/java/at/asit/pdfover/signator/Emblem.java b/pdf-over-signator/src/main/java/at/asit/pdfover/signator/Emblem.java
index 71f764d3..6c7d208e 100644
--- a/pdf-over-signator/src/main/java/at/asit/pdfover/signator/Emblem.java
+++ b/pdf-over-signator/src/main/java/at/asit/pdfover/signator/Emblem.java
@@ -15,13 +15,256 @@
  */
 package at.asit.pdfover.signator;
 
+// Imports
+import java.awt.Graphics2D;
+import java.awt.image.BufferedImage;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Iterator;
+import java.util.Properties;
+
+import javax.imageio.ImageIO;
+import javax.imageio.ImageReader;
+import javax.imageio.stream.ImageInputStream;
+
+import org.apache.commons.codec.digest.DigestUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.drew.imaging.ImageMetadataReader;
+import com.drew.imaging.ImageProcessingException;
+import com.drew.metadata.Metadata;
+import com.drew.metadata.MetadataException;
+import com.drew.metadata.exif.ExifDirectoryBase;
+import com.drew.metadata.exif.ExifIFD0Directory;
+
 /**
- * Provides a logo for a signature block
+ *
  */
-public interface Emblem {
+public class Emblem {
+	/**
+	 * SLF4J Logger instance
+	 **/
+	private static final Logger log = LoggerFactory.getLogger(Emblem.class);
+
+	private final String fileDir = System.getProperty("user.home") + File.separator + ".pdf-over";
+	private final String imgFileName = ".emblem";
+	private final String imgFileExt = "png";
+	private final String propFileName = ".emblem.properties";
+
+	private final String imgProp = "IMG";
+	private final String hshProp = "HSH";
+	private final int maxWidth  = 480;
+	private final int maxHeight = 600;
+
+	private String fileName = null;
+
+	/**
+	 * Constructor
+	 * @param filename
+	 */
+	public Emblem(String filename) {
+		this.fileName = filename;
+	}
+
+	private String getFileHash(String filename) throws IOException {
+		InputStream is = Files.newInputStream(Paths.get(this.fileName));
+		return DigestUtils.md5Hex(is);
+	}
+
+	/**
+	 * Correctly rotate JPEG image by EXIF header
+	 * @param img the image
+	 * @param imgFile the image file
+	 * @return the fixed image
+	 */
+	public static BufferedImage fixImage(BufferedImage img, File imgFile) {
+		int oheight = img.getHeight();
+		int owidth = img.getWidth();
+
+		// Read EXIF metadata for jpeg
+		ImageInputStream iis = null;
+		try {
+			iis = ImageIO.createImageInputStream(imgFile);
+			Iterator<ImageReader> imageReaders = ImageIO.getImageReaders(iis);
+
+			while (imageReaders.hasNext()) {
+				ImageReader reader = imageReaders.next();
+				log.debug(reader.getFormatName());
+				if (reader.getFormatName().equals("JPEG")) {
+					try {
+						Metadata metadata = ImageMetadataReader.readMetadata(imgFile);
+						ExifIFD0Directory metaDirectory = (metadata != null) ? metadata.getFirstDirectoryOfType(ExifIFD0Directory.class) : null;
+						if (metaDirectory != null) {
+							int orientation = metaDirectory.getInt(
+									ExifDirectoryBase.TAG_ORIENTATION);
+							if (orientation > 2) {
+								// rotate
+								double rotation = 0;
+								int height = owidth;
+								int width = oheight;
+								switch ((orientation + 1) / 2) {
+									case 2:
+										rotation = Math.PI;
+										height = oheight;
+										width = owidth;
+										break;
+									case 3:
+										rotation = Math.PI / 2;
+										break;
+									case 4:
+										rotation = 3 * Math.PI / 2;
+										break;
+								}
+								log.debug("EXIF orientation " + orientation + ", rotating " + rotation + "rad");
+								BufferedImage result = new BufferedImage(width, height, img.getType());
+								Graphics2D g = result.createGraphics();
+								g.translate((width - owidth) / 2, (height - oheight) / 2);
+								g.rotate(rotation, owidth / 2, oheight / 2);
+								g.drawRenderedImage(img, null);
+								g.dispose();
+								img = result;
+								owidth = width;
+								oheight = height;
+							}
+							if (((orientation < 5) && (orientation % 2 == 0)) ||
+									(orientation > 5) && (orientation % 2 == 1)) {
+								// flip
+								log.debug("flipping image");
+								BufferedImage result = new BufferedImage(owidth, oheight, img.getType());
+								Graphics2D g = result.createGraphics();
+								g.drawImage(img, owidth, 0, -owidth, oheight, null);
+								g.dispose();
+								img = result;
+							}
+						}
+					} catch (ImageProcessingException e) {
+						log.error("Error reading emblem metadata", e);
+					} catch (MetadataException e) {
+						log.error("Error reading emblem metadata", e);
+					} catch (NullPointerException e) {
+						log.error("Error reading emblem metadata", e);
+					}
+				}
+			}
+		} catch (IOException e) {
+			log.error("Error reading image" , e);
+		} finally {
+			try {
+				if (iis != null)
+					iis.close();
+			} catch (IOException e) {
+				log.debug("Error closing stream", e);
+			}
+		}
+		return img;
+	}
+
+	private static BufferedImage scaleImage(BufferedImage img, int maxWidth, int maxHeight) {
+		int oheight = img.getHeight();
+		int owidth = img.getWidth();
+
+		double ratio = (double)owidth/(double)oheight;
+
+		int height = oheight;
+		int width = owidth;
+		if (height > maxHeight) {
+			height = maxHeight;
+			width = (int) (maxHeight * ratio);
+		}
+		if (width > maxWidth) {
+			width = maxWidth;
+			height = (int) (maxWidth / ratio);
+		}
+		BufferedImage result = img;
+		if (width != owidth || height == oheight) {
+			//scale image
+			log.debug("Scaling emblem: " + owidth + "x" + oheight + " to " + width + "x" + height);
+			result = new BufferedImage(width, height, img.getType() == 0 ? BufferedImage.TYPE_INT_ARGB : img.getType());
+			Graphics2D g = result.createGraphics();
+			g.drawImage(img, 0, 0, width, height, null);
+			g.dispose();
+		}
+		return result;
+	}
+
+	/* (non-Javadoc)
+	 * @see at.asit.pdfover.signator.Emblem#getFileName()
+	 */
+	public String getFileName() {
+		String emblemImg = this.fileName;
+		String emblemHsh = null;
+		String cachedEmblemFileName = this.fileDir + File.separator + this.imgFileName + "." + this.imgFileExt;
+
+		if (emblemImg == null || !(new File(emblemImg).exists()))
+			return null;
+
+		Properties emblemProps = new Properties();
+		// compare cache, try to load if match
+		try {
+			InputStream in = new FileInputStream(new File(this.fileDir, this.propFileName));
+			emblemProps.load(in);
+			if (emblemImg.equals(emblemProps.getProperty(this.imgProp))) {
+				emblemHsh = getFileHash(emblemImg);
+				if (emblemHsh.equals(emblemProps.getProperty(this.hshProp))) {
+					log.debug("Emblem cache hit: " + cachedEmblemFileName);
+					return cachedEmblemFileName;
+				}
+			}
+			log.debug("Emblem cache miss");
+		} catch (Exception e) {
+			log.warn("Can't load emblem cache", e);
+		}
+
+		try {
+			// create new cache
+			if (emblemHsh == null)
+				emblemHsh = getFileHash(emblemImg);
+			emblemProps.setProperty(this.imgProp, emblemImg);
+			emblemProps.setProperty(this.hshProp, emblemHsh);
+			File imgFile = new File(emblemImg);
+
+			BufferedImage img = ImageIO.read(imgFile);
+			img = fixImage(img, imgFile);
+			img = scaleImage(img, this.maxWidth, this.maxHeight);
+
+			File file = new File(this.fileDir, this.imgFileName + "." + this.imgFileExt);
+			ImageIO.write(img, this.imgFileExt, file); // ignore returned boolean
+			OutputStream out = new FileOutputStream(new File(this.fileDir, this.propFileName));
+			emblemProps.store(out, null);
+		} catch (IOException e) {
+			log.error("Can't save emblem cache", e);
+			return this.fileName;
+		}
+		return cachedEmblemFileName;
+	}
+
+	/**
+	 * Return the original filename
+	 * @return the original filename
+	 */
+	public String getOriginalFileName() {
+		return this.fileName;
+	}
+
 	/**
-	 * Return the file name of the Emblem
-	 * @return the file name
+	 * Return the original filename
+	 * @return the original filename
 	 */
-	public String getFileName();
+	public String getOriginalFileHash() {
+		if (this.fileName == null || !(new File(this.fileName).exists()))
+			return "";
+		try {
+			return getFileHash(this.fileName);
+		} catch (IOException e) {
+			log.debug("Error getting file hash", e);
+			return "";
+		}
+	}
 }