/******************************************************************************
    * ContactEngine.java - Base class for the plugin contact making engines
    * 
    * PicMan - The BuckoSoft Picture Manager in Java
    * Copyright(c) 2005 - Dick Balaska
    * 
    */
   package com.buckosoft.PicMan.business.contact;
   
  import java.awt.Color;
  import java.awt.Graphics2D;
  import java.awt.image.BufferedImage;
  import java.io.File;
  import java.text.DecimalFormat;
  import java.util.Iterator;
  import java.util.LinkedList;
  import java.util.List;
  
  import javax.imageio.ImageIO;
  import javax.imageio.ImageWriter;
  import javax.imageio.stream.ImageOutputStream;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  import com.buckosoft.PicMan.business.ContactManager;
  import com.buckosoft.PicMan.business.PicManFacade;
  import com.buckosoft.PicMan.business.util.CopyFile;
  import com.buckosoft.PicMan.db.DatabaseFacade;
  import com.buckosoft.PicMan.domain.Chain;
  import com.buckosoft.PicMan.domain.ContactParams;
  import com.buckosoft.PicMan.domain.Pic;
  import com.buckosoft.PicMan.domain.Set;
  import com.buckosoft.PicMan.domain.System;
  import com.buckosoft.PicMan.domain.Thumbnail;
  
  /** Base class for the plugin contact making engines.  Make a single contact sheet. <br>
   * If we detect that someone else is using the PicReader (like a user editing Filters),
   * then sleep for a minute so we don't slow down the user.
   * @author Dick Balaska
   * @since 2005/08/06
   * @version $Revision: 1.2 $ <br> $Date: 2014/02/13 07:24:02 $
   * @see <a href="http://cvs.buckosoft.com/Projects/PicMan/PicMan/src/main/java/com/buckosoft/PicMan/business/contact/ContactEngine.java">ContactEngine.java</a>
   */
  public abstract class ContactEngine {
  	//private final static boolean DEBUG = true;
  	protected final Log logger = LogFactory.getLog(getClass());
  
  	protected	PicManFacade	pmf;
  	protected	DatabaseFacade	dbf;
  	protected	System			system;
  	protected	ContactParams	contactParams;
  	protected	Set				set;
  	protected	int				cWidth;
  	protected	int				cHeight;
  	protected	String			cName;
  	protected	String			cPath;		// contains the path up to the extension i.e. C:\temp\PicMan\poster\FirstPoster_000
  	protected	int				tHeight;
  	protected	String			cUuid;
  	protected	Chain			chain;
  	protected	ContactManager	contactManager;
  
  	/** Set the reference to the PicMan API.
  	 * @param pmf The PicManFacade
  	 */
  	public	void	setPicMan(PicManFacade pmf) {
  		this.pmf = pmf;
  		this.dbf = pmf.getDB();
  	}
  
  	public void setContactManager(ContactManager contactManager) {
  		this.contactManager = contactManager;
  	}
  
  	protected abstract boolean _makeContact();
  	
  	/** Make a contact sheet based on these parameters.
  	 * @param contactParams
  	 * @return true = success
  	 */
  	public boolean makeContact(ContactParams contactParams) {
  		this.contactParams = contactParams;
  		system = dbf.getSystem();
  		chain = dbf.getChain(contactParams.getCid());
  		cUuid	= contactParams.getUuid();
  		cWidth  = chain.getContactWidth();
  		cHeight = chain.getContactHeight();
  		tHeight = contactParams.getSize();
  		cName = chain.getContactPrefix() + cUuid;
  		cPath = contactParams.getOutputDirectory() + "/" + cName;
  		set = dbf.getSet(contactParams.getSetName());
  		return(_makeContact());
  	}
  
  
  	protected LinkedList<String> randomize(List<String> in) {
  		LinkedList<String> out = new LinkedList<String>();
  		while (!in.isEmpty()) {
  			double d = Math.random() * in.size();
 			out.add(in.remove((int)d));
 		}
 		return(out);
 	}
 
 	private final DecimalFormat df = new DecimalFormat("0.##");
 
 	protected int drawThumb(Graphics2D g, String tName, int tHeight, int x, int y) {
 		Pic			pic;
 		Thumbnail	tn;
 		pic = pmf.getDB().getPic(tName);
 		if (pmf.getPicReader().getQueueDepth() > 0) {
 			logger.info("Queue depth " + pmf.getPicReader().getQueueDepth() + " --- sleeping");
 			try {
 				java.lang.Thread.sleep(3000);
 			} catch (InterruptedException e) {
 			}
 		}
 		String label = null;
 		if (system.isShowRateOnPics())
 			label = df.format(dbf.getPicRate(tName, set, contactParams.getSize()));
 		tn = pmf.getPicReader().getThumbNail(pic, tHeight, label);
 		if (tn.isXThumb() && system.isSkipXThumbs())
 			return(0);
 		g.drawImage(tn.getImage(), null, x, y);		
 		return(tn.getImage().getWidth());
 	}
 	
 	protected void drawContactLabel(Graphics2D g) {
 		int xp = 300;
 		int yp = 12;
 		String	text = chain.getContactPrefix() + cUuid;
 		g.setColor(Color.BLACK);
 		g.drawString(text, xp+1, yp+1);
 		g.setColor(Color.WHITE);
 		g.drawString(text, xp,   yp);
 	}
 	
 	protected boolean isAbort() {
 		return(this.contactManager.isAbort());
 	}
 	
 	protected boolean writePic(BufferedImage bi, boolean makeBackup) {
 		Iterator<ImageWriter> writers = ImageIO.getImageWritersByFormatName("jpg");
 		ImageWriter writer = (ImageWriter)writers.next();
 		File file = new File(cPath + ".jpg");
 		logger.info("Writing jpg to '" + file.getPath() + "'");
 		try {
 			ImageOutputStream oos = ImageIO.createImageOutputStream(file);
 			writer.setOutput(oos);
 			writer.write(bi);
 			oos.close();
 		} catch (Exception e) {
 			bi = null;
 			pmf.addError(e);
 			return(false);
 		}
 		if (makeBackup)
 			CopyFile.makeBackup(pmf, file);
 		logger.info("Done with " + cUuid);
 		return(true);
 	}
 }