/*
    * 
    *  © Copyright 2005-2010, Mike Odling-Smee.  All rights reserved.
    * 	
    * 	Licensed under the Artistic License: 
    * 	http://www.opensource.org/licenses/artistic-license.php
    * 	
    * Preamble
    * 
   *         The intent of this document is to state the conditions under which a 
   *         Package may be copied, such that the Copyright Holder maintains some 
   *         semblance of artistic control over the development of the package, while 
   *         giving the users of the package the right to use and distribute the Package
   * 	       in a more-or-less customary fashion, plus the right to make reasonable 
   *         modifications.
   * 
   * Definitions:
   * 
   *         * "Package" refers to the collection of files distributed by the 
   *         Copyright Holder, and derivatives of that collection of files created 
   *         through textual modification. 
   * 
   *         * "Standard Version" refers to such a Package if it has not been modified, 
   *         or has been modified in accordance with the wishes of the Copyright Holder.
   * 
   *         * "Copyright Holder" is whoever is named in the copyright or copyrights for
   *         the package. 
   * 
   *         * "You" is you, if you're thinking about copying or distributing this Package.
   * 
   *         * "Reasonable copying fee" is whatever you can justify on the basis of 
   *         media cost, duplication charges, time of people involved, and so on. 
   *         (You will not be required to justify it to the Copyright Holder, but 
   *         only to the computing community at large as a market that must bear the 
   *         fee.) 
   * 
   *         * "Freely Available" means that no fee is charged for the item 
   *         itself, though there may be fees involved in handling the item. It also 
   *         means that recipients of the item may redistribute it under the same 
   *         conditions they received it.
   * 
   * 	1. You may make and give away verbatim copies of the source form of the Standard 
   * 	Version of this Package without restriction, provided that you duplicate all of 
   * 	the original copyright notices and associated disclaimers.
   * 	
   * 	2. You may apply bug fixes, portability fixes and other modifications derived 
   * 	from the Public Domain or from the Copyright Holder. A Package modified in such 
   * 	a way shall still be considered the Standard Version.
   * 	
   * 	3. You may otherwise modify your copy of this Package in any way, provided that 
   * 	you insert a prominent notice in each changed file stating how and when you 
   * 	changed that file, and provided that you do at least ONE of the following:
   * 	
   * 		a) place your modifications in the Public Domain or otherwise make them 
   * 		Freely Available, such as by posting said modifications to Usenet or an 
   * 		equivalent medium, or placing the modifications on a major archive site such 
   * 		as ftp.uu.net, or by allowing the Copyright Holder to include your modifications 
   * 		in the Standard Version of the Package.
   * 	
   * 		b) use the modified Package only within your corporation or organization.
   * 	
   * 		c) rename any non-standard executables so the names do not conflict with 
   * 		standard executables, which must also be provided, and provide a separate 
   * 		manual page for each non-standard executable that clearly documents how it 
   * 		differs from the Standard Version.
   * 	
   * 		d) make other distribution arrangements with the Copyright Holder.
   * 	
   * 	4. You may distribute the programs of this Package in object code or executable 
   * 	form, provided that you do at least ONE of the following:
   * 	
   * 		a) distribute a Standard Version of the executables and library files, 
   * 		together with instructions (in the manual page or equivalent) on where to 
   * 		get the Standard Version.
   * 	
   * 		b) accompany the distribution with the machine-readable source of the 
   * 		Package with your modifications.
   * 	
   * 		c) accompany any non-standard executables with their corresponding Standard 
   * 		Version executables, giving the non-standard executables non-standard names, 
   * 		and clearly documenting the differences in manual pages (or equivalent), 
   * 		together with instructions on where to get the Standard Version.
   * 	
   * 		d) make other distribution arrangements with the Copyright Holder.
   * 	
   * 	5. You may charge a reasonable copying fee for any distribution of this Package. 
   * 	You may charge any fee you choose for support of this Package. You may not 
   * 	charge a fee for this Package itself. However, you may distribute this Package 
   * 	in aggregate with other (possibly commercial) programs as part of a larger 
   * 	(possibly commercial) software distribution provided that you do not advertise 
   * 	this Package as a product of your own.
   * 	
   * 	6. The scripts and library files supplied as input to or produced as output from 
   * 	the programs of this Package do not automatically fall under the copyright of 
   * 	this Package, but belong to whomever generated them, and may be sold 
   * 	commercially, and may be aggregated with this Package.
   * 	
   * 	7. C or perl subroutines supplied by you and linked into this Package shall not 
   * 	be considered part of this Package.
  * 	
  * 	8. The name of the Copyright Holder may not be used to endorse or promote 
  * 	products derived from this software without specific prior written permission.
  * 	
  * 	9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED 
  * 	WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF 
  * 	MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  * 
  * The End
  */
 package net.sourceforge.xuse;
 
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
 
 import net.sourceforge.xuse.build.BuildException;
 import net.sourceforge.xuse.build.StylesheetInvoker;
 import net.sourceforge.xuse.build.XusePropertiesReader;
 import net.sourceforge.xuse.log.Logger;
 import net.sourceforge.xuse.tools.exporting.ExportFactory;
 import net.sourceforge.xuse.tools.exporting.Exporter;
 import net.sourceforge.xuse.tools.importing.ImportFactory;
 import net.sourceforge.xuse.utils.CommandLineWrapper;
 import net.sourceforge.xuse.utils.FileUtils;
 import net.sourceforge.xuse.utils.XuseUtils;
 
 import com.xmlsolutions.annotation.Requirement;
 import com.xmlsolutions.annotation.UseCase;
 
 @Requirement(traceTo="RQ61")
 public class Xuse {
 	
 	private static final StylesheetInvoker XSL_INVOKER = StylesheetInvoker.getInstance();
 	
 	private static final String BUILD_ALL = "xuse";
 	private static final String BUILD_HTML = "xuse:html";
 	private static final String BUILD_HTML_DOCS = "xuse:documents-html";
 	private static final String NEW_PROJECT = "xuse:new-project";
 	private static final String UPGRADE = "xuse:upgrade";
 	private static final String VALIDATE = "xuse:validate";
 	private static final String PDF_USE_CASE = "xuse:pdf-use-case";
 	private static final String PDF_USE_CASES = "xuse:pdf-use-cases";
 	private static final String IMPORT_TRACE_REPORT = "xuse:import-trace-report";
 	private static final String IMPORT_REQUIREMENTS = "xuse:import-requirements";
 	private static final String EXPORT_REQUIREMENTS = "xuse:export-requirements";
 	private static final String IMPORT_GLOSSARY = "xuse:import-glossary";
 	private static final String HELP_1 = "-help";
 	private static final String HELP_2 = "--help";
 	private static final String HELP_3 = "-h";
 	private static final String HELP_4 = "-man";
 	private static final String HELP_5 = "man";
 	private static final String HELP_6 = "help";
 	private static final String[] ALL_HELP_COMMANDS = new String[] {HELP_1, HELP_2, HELP_3, HELP_4, HELP_5, HELP_6};
 	private static final List<String> ALL_HELP_COMMANDS_LIST = Arrays.asList(ALL_HELP_COMMANDS);
 	//private static final String GRAPH_REQUIREMENT = "xuse:graph-requirement";
 	
 	private static final String[] ALL_COMMANDS = new String[] {BUILD_ALL, BUILD_HTML, BUILD_HTML_DOCS, NEW_PROJECT, UPGRADE, VALIDATE, PDF_USE_CASE, PDF_USE_CASES, IMPORT_TRACE_REPORT, IMPORT_REQUIREMENTS, EXPORT_REQUIREMENTS,IMPORT_GLOSSARY, HELP_1};
 	private static final List<String> ALL_COMMANDS_LIST = Arrays.asList(ALL_COMMANDS);
 	
 	public static void main(String[] args) {
 		if (args != null && args.length > 0 && validArgZero(args[0])) {
 			Xuse builder = new Xuse();
 			builder.dispatchBuildRequest(args);
 		} else {
 			System.out.print("\n\nUsage: java net.sourceforge.xuse.Xuse | xuse.bat | xuse.sh | xuse");
 			for (String command: ALL_COMMANDS) {
 				System.out.print(" \n\t ");
 				System.out.print(command);
 			}
 			System.out.println("\n\n\te.g. xuse xuse:new-project");
 		}
 	}
 	
 	private void dispatchBuildRequest(String args[]) throws BuildException {
 		long startTime = System.currentTimeMillis();
 		Locale locale = XusePropertiesReader.getLocaleOverride();
 		if (locale != null) {
 			Locale.setDefault(locale);
 		}
 		String goal = args[0];
 		System.out.println("__  __              ");  
 		System.out.println("// /// /_  _  ___ ___ ");  
 		System.out.println(" >  <| || |(_-</ -_)");  
 		System.out.println("/_///_////_,_|/__///___| v. " + net.sourceforge.xuse.build.Version.getFullVersion());  
 		System.out.println();
 		System.out.println();
 		debugEnv(this);
 		debugArgs(this, args);
 		Logger.debug(this, XusePropertiesReader.debugProperties());
 		if (ALL_HELP_COMMANDS_LIST.contains(goal)) {
 			this.displayHelp();
 		} else if (goal.equals(BUILD_ALL)) {
 			this.xuse();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(BUILD_HTML)) {
 			this.xuseHtml();
 			this.displayExecutionTime(startTime);
 		}else if (goal.equals(BUILD_HTML_DOCS)) {
 			this.xuseDocumentsHtml();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(NEW_PROJECT)) {
 			this.newProject();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(VALIDATE)) {
 			this.validateProject();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(UPGRADE)) {
 			this.upGrade();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(PDF_USE_CASE)) {
 			this.pdfUseCase(args[1]);
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(PDF_USE_CASES)) {
 			this.pdfUseCases();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(IMPORT_TRACE_REPORT)) {
 			this.importTraceReport();
 			this.displayExecutionTime(startTime);
 		} else if (goal.equals(IMPORT_REQUIREMENTS)) {
             this.importRequirements();
             this.displayExecutionTime(startTime);
         } else if (goal.equals(IMPORT_GLOSSARY)) {
             this.importGlossary();
             this.displayExecutionTime(startTime);
         } else if (goal.equals(EXPORT_REQUIREMENTS)) {
             this.exportRequirements();
             this.displayExecutionTime(startTime);
         }//else if (goal.equals(GRAPH_REQUIREMENT)) {
 			//this.graphRequirement(args[1]);
 		//} 
         else {
         	Logger.error(this, "Goal: " + goal + " was not recognised");
         	System.exit(-1);
         }		
 		this.processPerformanceResults();
 	}
 	
 	private void displayExecutionTime(long startTime) {
 		long processingTime = (System.currentTimeMillis() - startTime) / 1000;
 		int minutes = (int)Math.floor(processingTime / 60);
 		int seconds = (int)Math.floor(processingTime - (60 * minutes));
 		Logger.info(this, "Processing complete in " + minutes + " mins "+ seconds + " seconds");
 	}
 	
 	public void displayHelp() {
 	    System.out.println("Help: todo");
 	}
 	
 	private void processPerformanceResults() {
 		Logger.debug(this, "in processPerformanceResults()");
 		XSL_INVOKER.processPerformanceResults();
 	}
 	
 	public void xuse() throws BuildException {
 		Logger.debug(this, "In xuse()");
 		this.xuseHtml();
 		this.xusePdf();
 	}
 	
 	public void xusePdf() throws BuildException {
 		Logger.debug(this, "In xusePdf()");
 		this.pdfUseCases();
 	}
 	
 	@Requirement(traceTo={"RQ19", "RQ60"})
 	@UseCase(traceTo={"UC2"})
 	public void xuseHtml() throws BuildException {
 		Logger.debug(this, "In xuseHtml()");
 		try {
 			this.xuseDocumentsHtml();
 			XSL_INVOKER.invokeBuildHTMLSite();
 		} catch (Throwable t) {
 			throw new BuildException("Error building site", t);
 		}
 	}
 	
 	@Requirement(traceTo={"RQ19", "RQ60"})
 	public void xuseDocumentsHtml() throws BuildException {
 		Logger.debug(this, "In xuseDocumentsHtml()");
 		try {
 			FileUtils.extractStyleSheets();
 			FileUtils.extractResources();
 			FileUtils.copyHTMLResources(XusePropertiesReader.getOutputDirectory());
 			FileUtils.extractSchemas();
 			XSL_INVOKER.invokeBuildHTMLDocuments();
 		} catch (Throwable t) {
 			throw new BuildException("Error building site", t);
 		}
 	}
 	
 	@Requirement(traceTo={"RQ40"})
 	public void newProject() throws BuildException {
 		Logger.debug(this, "In newProject()");
 		try {
 			FileUtils.extractTemplateProject();
 		} catch (Throwable t) {
 			throw new BuildException("Error copying resources", t);
 		}
 	}
 	
 	@Requirement(traceTo={"RQ48"})
 	public void validateProject() throws BuildException {
 		Logger.debug(this, "In validateProject()");
 		try {
 			FileUtils.extractStyleSheets();
 			FileUtils.extractSchemas();
 			XSL_INVOKER.invokeValidateProject();
 		} catch (Throwable t) {
 			throw new BuildException("Error validating project", t);
 		}
 	}
 	
 	@Requirement(traceTo={"RQ3", "RQ58"})
 	public void pdfUseCases() throws BuildException {
 		Logger.debug(this, "In pdfUseCases()");
 		try {
 			FileUtils.extractStyleSheets();
 			FileUtils.extractResources();
 			XSL_INVOKER.invokePDFUseCases();
 		} catch (Throwable t) {
 			throw new BuildException("Error creating pdf of use-case", t);
 		} 
 	}
 	
 	public void importTraceReport() throws BuildException {
 		Logger.debug(this, "In importTraceReport()");
 	    try {
 			FileUtils.extractStyleSheets();
 			FileUtils.extractResources();
 			XSL_INVOKER.invokeImportTraceReport();
 		} catch (Throwable t) {
 			throw new BuildException("Error importing trace report", t);
 		} 	        
 	}
 	
 	public void importRequirements() throws BuildException {
 		Logger.debug(this, "In importRequirements()");
 		try {
 			FileUtils.extractStyleSheets();
 			ImportFactory.newRequirementsInstance().importContent();
 	    } catch (Throwable t) {
 	    	throw new BuildException("Error importing requirements", t);
 	    } 
 	}
 	
 	public void importGlossary() throws BuildException {
 		Logger.debug(this, "In importGlossary()");
 		try {
 			FileUtils.extractStyleSheets();
 			ImportFactory.newGlossaryInstance().importContent();
 	    } catch (Throwable t) {
 	    	throw new BuildException("Error importing requirements", t);
 	    } 
 	}
 	
 	public void exportRequirements() throws BuildException {
 		Logger.debug(this, "In exportRequirements()");
         try {
         	FileUtils.extractStyleSheets();
             Exporter exporter = ExportFactory.newInstance();
             exporter.exportRequirements();
         } catch (Throwable t) {
             throw new BuildException("Error exporting requirements", t);
         } 
     }
 	
 	@Requirement(traceTo={"RQ3", "RQ58"})
 	public void pdfUseCase(String useCaseId) throws BuildException {
 		Logger.debug(this, "In pdfUseCase()");
 		try {
 			FileUtils.extractStyleSheets();
 			FileUtils.extractResources();
 			XSL_INVOKER.invokePDFSingleUseCase(useCaseId);
 		} catch (Throwable t) {
 			throw new BuildException("Error creating pdf of use-case", t);
 		} 
 	}
 	
 	public void graphRequirement(String requirementId) throws BuildException {
 		Logger.debug(this, "In graphRequirement()");
 		if (CommandLineWrapper.graphVizAvailable()) {
 			try {
 				FileUtils.extractStyleSheets();
 				FileUtils.extractResources();
 				XSL_INVOKER.invokeGraphRequirement(requirementId);
 			} catch (Throwable t) {
 				throw new BuildException("Error graphing requirement " + requirementId, t);
 			}
 		} else {
 			throw new BuildException("Please install the graphics utility Graphiz - graphing the requirements depends on this layout engine.");
 		}
 	}
 	
 	@Requirement(traceTo={"RQ20"})
 	public void upGrade() throws BuildException {
 		Logger.debug(this, "In upGrade()");
 		BufferedReader br = null;
 		try {
 			System.out.print("Upgrading your project - It is strongly recommended that you back up your files to a safe location before running this command: continue?(y,n)");
 			br = new BufferedReader(new InputStreamReader(System.in));
 			String line = br.readLine();
 			if (line.equalsIgnoreCase("y")) {
 				File baseDir = new File(System.getProperty("user.dir"));
 				File stakeholderFile = new File(baseDir, XusePropertiesReader.getStakeholders());
 				FileUtils.extractResourceFromJar(XusePropertiesReader.getTemplateProjectPath() + "/" + XusePropertiesReader.getRequirementsDir(), "stakeholders.xml", stakeholderFile);
 				FileUtils.copyDirectory(XusePropertiesReader.getTemplateProjectPath() + "/src/resources", new File(baseDir, "src/resources"), false);
 				FileUtils.extractStyleSheets();
 				XSL_INVOKER.invokeUpgrade();
 				//TODO: There seems to be an intermittent file lock on the repository file
 				//Force garbage collection and wait a while
 				System.gc();
 				Thread.sleep(5000);
 				//Archive existing files
 				XuseUtils.archiveUseCases();
 				XuseUtils.renameUpgradedCases();
 				XuseUtils.archiveRequirements();
 				XuseUtils.renameUpgradedRequirements();
 			} else {
 				System.out.println("Upgrade aborted by user....");
 				System.exit(-1);
 			}
 		} catch (Throwable t) {
 			throw new BuildException("Error upgrading", t);
 		} finally {
 			if (br != null) {
 				try {
 					br.close();
 				} catch (IOException e) {
 					throw new BuildException("Could not close buffered reader", e);
 				}
 			}
 		}
 	}
 	
 	private static boolean validArgZero(String arg) {
 		return arg != null && (ALL_COMMANDS_LIST.contains(arg) || ALL_HELP_COMMANDS_LIST.contains(arg));
 	}
 	
 	private static void debugArgs(Object clazzInstance, String[] args) {
 		if (args != null) {
 			int index = 0;
 			for (String arg : args) {
 				Logger.debug(clazzInstance, "[" + index + "] " + arg);
 				index++;
 			}
 		}
 	}
 	
 	private static void debugEnv(Object clazzInstance) {
 		Logger.debug(clazzInstance, "Using " + net.sf.saxon.Version.getProductName() + " version: " + net.sf.saxon.Version.getProductVersion() + ", released: " + net.sf.saxon.Version.getReleaseDate());
 		Logger.debug(clazzInstance, "Environment settings");
 		Logger.debug(clazzInstance, "-------------------------------------------------------------");
 		Logger.debug(clazzInstance, "File encoding\t\t" + System.getProperty("file.encoding"));
 		Logger.debug(clazzInstance, "File encoding package\t\t" + System.getProperty("file.encoding.pkg"));
 		Logger.debug(clazzInstance, "File separator\t\t" + System.getProperty("file.separator"));
 		Logger.debug(clazzInstance, "Classpath\t\t" + System.getProperty("java.class.path"));
 		//Logger.debug(clazzInstance, "Class version\t\t" + System.getProperty("java.class.version"));
 		//Logger.debug(clazzInstance, "Java Compiler\t\t" + System.getProperty("java.compiler"));
 		Logger.debug(clazzInstance, "JAVA_HOME\t\t" + System.getProperty("java.home"));
 		//Logger.debug(clazzInstance, "Java IO tmp dir\t\t" + System.getProperty("java.io.tmpdir"));
 		Logger.debug(clazzInstance, "Java version\t\t" + System.getProperty("java.version"));
 		Logger.debug(clazzInstance, "Java Vendor\t\t" + System.getProperty("java.vendor"));
 		Logger.debug(clazzInstance, "Java Vendor URL\t\t" + System.getProperty("java.vendor.url"));
 		Logger.debug(clazzInstance, "Line Seperator\t\t" + System.getProperty("line.separator"));
 		Logger.debug(clazzInstance, "OS Name\t\t" + System.getProperty("os.name"));
 		Logger.debug(clazzInstance, "OS Arch\t\t" + System.getProperty("os.arch"));
 		Logger.debug(clazzInstance, "OS Version\t\t" + System.getProperty("os.version"));
 		Logger.debug(clazzInstance, "Path Separator\t\t" + System.getProperty("path.separator"));
 		Logger.debug(clazzInstance, "User dir\t\t" + System.getProperty("user.dir"));
 		//Logger.debug(clazzInstance, "User home\t\t" + System.getProperty("user.home"));
 		//Logger.debug(clazzInstance, "User name\t\t" + System.getProperty("user.name"));
 		Logger.debug(clazzInstance, "User region\t\t" + System.getProperty("user.region"));
 		Logger.debug(clazzInstance, "User timezone\t\t" + System.getProperty("user.timezone"));
 		Logger.debug(clazzInstance, "-------------------------------------------------------------");
 	}
 
 }