/*************************************************************************
 *                                                                       *
 *  EJBCA Community: The OpenSource Certificate Authority                *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.ejbca.util;

import java.awt.print.PageFormat;
import java.awt.print.Paper;
import java.awt.print.PrinterException;
import java.awt.print.PrinterJob;
import java.io.IOException;
import java.io.StringReader;

import javax.print.DocFlavor;
import javax.print.PrintService;
import javax.print.PrintServiceLookup;
import javax.print.attribute.HashPrintRequestAttributeSet;
import javax.print.attribute.PrintRequestAttributeSet;

import org.apache.log4j.Logger;
import org.cesecore.certificates.endentity.EndEntityInformation;
import org.ejbca.core.model.hardtoken.profiles.SVGImageManipulator;

/**
 * Class managing EJBCA print functionality, such as listing printers
 * and managing printjobs
 * 
 * @author Philip Vendil 2006 sep 20
 *
 * @version $Id: PrinterManager.java 22117 2015-10-29 10:53:42Z mikekushner $
 */
public class PrinterManager {
	
	private static Logger log = Logger.getLogger(PrinterManager.class);

	private static transient PrintService currentService = null;	
	private static transient String currentPrinterName = null;
	private static transient String currentSVGTemplateName = null;
	private static transient SVGImageManipulator sVGImagemanipulator = null;
	
	/**
	 * Method that returns the names of all the available printers or an empty list if
	 * no printers were found or an error occurred.
	 */
	public static String[] listPrinters(){
		String[] printerNames = new String[0];
		try {
			PrintRequestAttributeSet pras = new HashPrintRequestAttributeSet();
			DocFlavor flavor = DocFlavor.BYTE_ARRAY.AUTOSENSE;
			PrintService printService[] =  PrintServiceLookup.lookupPrintServices(flavor, pras);
			printerNames = new String[printService.length];
			for(int i=0;i<printService.length;i++){
				String name = "Error";
				PrintService service = printService[i];
				if (service != null) {
					name = service.getName();
					if (name == null) {
						name = "Undefined";
					}
				}
				printerNames[i] = name;					
			}			
		} catch (Throwable e) { // NOPMD: printers will give all sorts of wacky errors.
			String msg = "There might be a problem with one of the printers' configuration: ";
			log.warn(msg + e.getMessage());
			if (log.isDebugEnabled()) {
				log.debug(msg, e);
			}
		}		
		return printerNames;
	}


	
	/**
	 * Method performin the actual processing and
	 * printing of an SVG Template
	 * 
	 * Imporant the method is caching template data
	 * so to subsekvent calls with the samt svtTemplate name
	 * will result in the same SVG data being processed.
	 * Avoid the same svgTemplate name for two different
	 * SVG files
	 * 
	 * @param printerName the name of the printer to use
	 * @param svtTemplateName the filname of the SVG file.
	 * @param sVGData the actual SVG data.
	 * @param copies number of copies to print
	 * @param visualVaildity the visual validity use 0 if not used
	 * @param endEntityInformation the userdata
	 * @param pINs the PINS (or password)
	 * @param pUKs the PUKS, optional
	 * @param hardTokenSerialPrefix the prefix of the hardtoken, optional
	 * @param hardTokenSN optional
	 * @param copyOfHardTokenSN optional
	 * @throws PrinterException throws if any printer problems occur.
	 */
	public static void print(String printerName, String svtTemplateName, 
			String sVGData, int copies,
			int visualVaildity,  EndEntityInformation endEntityInformation, 
			String[] pINs, String[] pUKs, String hardTokenSerialPrefix,
			String hardTokenSN, String copyOfHardTokenSN) throws PrinterException{
	    if (log.isTraceEnabled()) {
            log.trace(">print: "+endEntityInformation.getUsername()+", "+printerName);
	    }
		if(currentService == null 
		   || currentPrinterName == null 
		   || !printerName.equals(currentPrinterName)){
			PrintRequestAttributeSet pras = new HashPrintRequestAttributeSet();
			DocFlavor flavor = DocFlavor.BYTE_ARRAY.AUTOSENSE;
			PrintService printService[] =  PrintServiceLookup.lookupPrintServices(flavor, pras);
			int i = 0;
			String trimemdPrinterName = printerName.trim();
			while ( i<printService.length && !trimemdPrinterName.equalsIgnoreCase(printService[i].getName()) ){
				i++;
			}
			currentService = i<printService.length ? printService[i] : null;	
			currentPrinterName = printerName;
		}	
		try{
			if(currentSVGTemplateName == null || !currentSVGTemplateName.equals(svtTemplateName)){
				sVGImagemanipulator = new SVGImageManipulator(new StringReader(sVGData),visualVaildity,hardTokenSerialPrefix);
			}

			if(currentService != null){
				PrinterJob job = PrinterJob.getPrinterJob();

				job.setPrintService(currentService);
				PageFormat pf = job.defaultPage();
				Paper paper = new Paper();
				paper.setSize(pf.getWidth(), pf.getHeight());
				paper.setImageableArea(0.0,0.0,pf.getWidth(), pf.getHeight());				

				pf.setPaper(paper);	   	  
				job.setPrintable(sVGImagemanipulator.print(endEntityInformation,pINs,pUKs,hardTokenSN, copyOfHardTokenSN),pf);	   	  
                job.setCopies(copies);
				job.print();
				log.info("Sent print job for end entity '"+endEntityInformation.getUsername()+"' to printer '"+currentService.getName()+"'.");
			}else{
				throw new PrinterException("Error, couldn't find the right printer");		  	   	
			}	
		}catch(IOException e){
			log.error(e);
			throw new PrinterException("Error occured when processing the SVG data :" + e.getMessage());		
		}
        if (log.isTraceEnabled()) {
            log.trace("<print: "+endEntityInformation.getUsername()+", "+printerName);
        }
	}
}