/*   Copyright (C) 2004 Finalist IT Group
    *
    *   This file is part of JAG - the Java J2EE Application Generator
    *
    *   JAG is free software; you can redistribute it and/or modify
    *   it under the terms of the GNU General Public License as published by
    *   the Free Software Foundation; either version 2 of the License, or
    *   (at your option) any later version.
    *   JAG is distributed in the hope that it will be useful,
   *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   *   GNU General Public License for more details.
   *   You should have received a copy of the GNU General Public License
   *   along with JAG; if not, write to the Free Software
   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package com.finalist.ant.tasks.docbook;
  
  import java.io.File;
  import java.net.URI;
  import java.net.URISyntaxException;
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.Map;
  
  import javax.xml.transform.Templates;
  import javax.xml.transform.Transformer;
  import javax.xml.transform.TransformerConfigurationException;
  import javax.xml.transform.TransformerFactory;
  import javax.xml.transform.stream.StreamSource;
  
  import org.apache.tools.ant.BuildException;
  import org.apache.tools.ant.DirectoryScanner;
  import org.apache.tools.ant.Task;
  import org.apache.tools.ant.types.FileSet;
  
  /***
   * <code>AbstractDocBookTask.java</code>
   *
   *	This Abstract class represents a DocBook Task
   *	other classes which implements this class must inplement the execute methode to
   *	execute the task.
   *
   *	The class can only have a child which is a XSLTParameterTask and has the name of
   *	"param" (This is a bad behaviour of ant)
   *	
   *	There are tree attributes that need to be set:
   *	docbookfile representing the xml file which contains the docbook file to be transformed 
   * xslfile the xsl file which will be used during transformation
   * outputdir in this directory the output will be generated
   * 
   * @author Stefan Lenselink
   * @version $Revision: 1.1 $
   */
  
  public abstract class AbstractDocBookTask extends Task {
  	private String docbookfile;
  	private String versionextention;
  	private String baseDir;
  	private File xslfile;
  	private File outputdir;
  	private HashMap paramMap;
  	private String[] files;
  	private boolean useFileSet = false;
  	private int currentFilesPos = 0;
  	
  	/***
  	 * The setter method for the docbookfile attribute
  	 * 
  	 * @param docbookfile the path of the file to be used as the docbook source file
  	 */
  	public void setDocbookfile(String docbookfile){
  		if(docbookfile == null){
  			useFileSet = true;
  		}else{
  			if(useFileSet){
  				System.out.println("There is a FileSet Specifyed, that will be used, " + docbookfile + " will be ignored");
  			}else{
  				this.docbookfile = docbookfile;
  			}
  		}
  	}
  	
  	/***
  	 * The setter method for the xslfile attribute
  	 * 
  	 * @param xslfile the xsl file to use to transform the docbookfile
  	 */
  	public void setXslfile(File xslfile){
  		this.xslfile = xslfile;
  	}
  	
  	/***
  	 * The setter method for the outputdir attribute
  	 * 
  	 * @param outputdir the directory to put the output
  	 */
  	public void setOutputdir(File outputdir){
 		this.outputdir = outputdir;
 	}
 	
 	/***
 	 * Add a nested XSLTParameterTask to this task
 	 * 
 	 * Watch it!! the name of the taskdef MUST be param and can't be changed!!!
 	 * example: <taskdef name="param" classpathref="classpath" classname="com.finalist.ant.tasks.XSLTParameterTask"/>
 	 * If you need to change the name of the taskdef change the method in the code as well
 	 * This is because of the design of ant, can't help it.
 	 * 
 	 * implementing the TaskContainer interface and implement the addTask(Task task) method
 	 * wouldn't help because a other classloader will be used to load XSLTParameterTask and so It can't be CAST
 	 * 
 	 * @param task the XSLTParameterTask containing the parameters used for transformation
 	 */
 	public void addConfiguredParam(XSLTParameterTask task){
 		if(paramMap == null){
 			paramMap = new HashMap();
 		}
 		paramMap.put(task.getName(), task.getValue());
 	}
 	/***
 	 * This method addes a fileset to the current task, the files specifyed will be used
 	 * for generation 
 	 * 
 	 * @param fileSet the FileSet to use
 	 */
 	public void addConfiguredFileset(FileSet fileSet){
 		if(docbookfile != null){
 			System.out.println("There is a docbookfile " + docbookfile + " specifyed but FileSet will be used");
 		}
 		useFileSet = true;
 		DirectoryScanner scanner = fileSet.getDirectoryScanner(this.getProject());
 		String[] arr = scanner.getIncludedFiles();
 		files = new String[arr.length];
 		File dir = scanner.getBasedir();
 		for (int i = 0; i < arr.length; i++) {
 			String string = arr[i];
 			File f = new File(dir, string);
 			files[i] = f.toURI().toString();
 		}
 	}
 	/***
 	 * This abstract method must be implemented by a implementing class to preform the execution of the task 
 	 * 
 	 * @see org.apache.tools.ant.Task#execute()
 	 */
 	public abstract void execute() throws BuildException;
 	
 	/***
 	 * Getter method for the docbookfile attribute
 	 * 
 	 * @return the docbook source file specifyed with the docbookfile attribute
 	 */
 	protected String getDocbookfile() {
 		if(useFileSet){
 			String file = files[currentFilesPos];
 			currentFilesPos++;
 			return file;
 		}else{
 			return docbookfile;
 		}
 	}
 
 	/***
 	 * This method returns a File to write the transformed document to
 	 * 
 	 * @param extention the extention which the generated file should have (normaly html or pdf)
 	 * @return the full path to the file which need to be generated
 	 */
 	protected File getOutputFile(String extention){
 		//remove the old extention
 		String stringWithoutExtention;
 		if(useFileSet){
 			stringWithoutExtention = files[currentFilesPos].substring(0, files[currentFilesPos].lastIndexOf("."));
 		}else{
 			stringWithoutExtention= docbookfile.substring(0, docbookfile.lastIndexOf("."));
 		}
 		
 		//is there a versionextention set?
 		if(versionextention != null){
 			//add the versionextention
 			stringWithoutExtention = stringWithoutExtention + versionextention;
 		}
 		
 		//add the new extention
 		String stringWithExtention = stringWithoutExtention + "." + extention;
 
 		String filename = stringWithExtention;
 		baseDir = filename;
 		try {
 			URI uri = new URI(stringWithExtention);
 			
 			//Get the URI as String 
 			String uriString = uri.toString();
 			
 			//Get the new filename. because we're dealing with URI's (which contains '/') a File.seperator can't be used!!  
 			filename = uriString.substring(uriString.lastIndexOf("/") + 1 , uriString.length());
 			
 			//Get the baseDir!! (needed for FOP to retrieve the images)
 			baseDir = uriString.substring(0, uriString.lastIndexOf("/") + 1);
 			
 		} catch (URISyntaxException e) {
 			//Ok for some reason this is no URI; printstackTrace to know what went wrong 
 			e.printStackTrace();
 		}
 		return new File(outputdir, filename);
 	}
 	
 	/***
 	 * This method return the Transformer that need to be used
 	 * 
 	 * @return the Transformer used
 	 * @throws TransformerConfigurationException when a TransformerConfigurationException occours a TransformerConfigurationException will be thrown
 	 */
 	protected Transformer getTransformer() throws TransformerConfigurationException {
 		//Get a instance of the TransformerFactory
 		TransformerFactory tf = TransformerFactory.newInstance();
 		
 		//Compile a template of the xslfile specifyed as attribute
 		Templates template = tf.newTemplates(new StreamSource(xslfile));
 			
 		//Get the Transformer from the template and return it
 		return template.newTransformer();
 	}
 	
 	/***
 	 * This method returns the total number of Cycles that will be done
 	 * 
 	 * @return the number of cycles
 	 */
 	protected int getNumberOfCycles(){
 		if(useFileSet){
 			return files.length;
 		}else{
 			return 1;
 		}
 	}
 	/***
 	 * This method returns the baseDir of the current docbook file
 	 * Caution! the getOutputFile must be called first to prevent null returning
 	 * @return the baseDir of the Docbook file
 	 * @see AbstractDocBookTask#getOutputFile(String)
 	 */
 	protected String getBaseDir(){
 		return baseDir;
 	}
 	
 	/***
 	 * This method sets the parameters on the given transfromer
 	 * 
 	 * @param transformer the transformer on which the parameters need te be set
 	 */
 	protected void doSetParameter(Transformer transformer){
 		//Go fetch and set the parameters
 		if(paramMap != null){
 			Iterator it = paramMap.entrySet().iterator();
 			while(it.hasNext()){
 				Map.Entry entry = (Map.Entry) it.next();
 				transformer.setParameter(String.valueOf(entry.getKey()), entry.getValue());
 			}
 		}
 	}
 
 	/***
 	 * Setter method for the versionExtention
 	 * 
 	 * @param string the versionExtention which needs to be added after the file name
 	 * for example: if the versionExtention is "v1.0" and the docbookfile is manual.xml
 	 * the html output will become manualv1.0.html 
 	 */
 	public void setVersionextention(String versionextention) {
 		this.versionextention = versionextention;
 	}
 
 }
 
 
 
 /*
  * $Log: AbstractDocBookTask.java,v $
  * Revision 1.1  2004/03/12 22:16:00  ekkelenkamp
  * no message
  *
  * Revision 1.3  2004/01/14 14:40:13  stefan
  * Added support for nested filesets, see manual for details
  *
  * Revision 1.2  2004/01/06 13:26:38  stefan
  * Added local dtd support and local watermark image support, now it's independent from the Internet
  *
  * Revision 1.1  2003/12/29 15:46:41  stefan
  * initial checkin of the DocBook Ant Task
  *
  */