package net.sf.jpkgmk;
   
   import java.io.File;
   import java.io.IOException;
   import java.io.Writer;
   import java.util.ArrayList;
   import java.util.Iterator;
   import java.util.List;
   
  import net.sf.jpkgmk.util.StringUtil;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /**
   * Object representation for a pkginfo file.
   * <p>
   * For details refer to <a href="http://docs.sun.com/app/docs/doc/817-0683/6mgff29br?a=view">
   * http://docs.sun.com/app/docs/doc/817-0683/6mgff29br?a=view</a>.
   * </p>
   * 
   * @author gommma (gommma AT users.sourceforge.net)
   * @author Last changed by: $Author: gommma $
   * @version $Revision: 2 $ $Date: 2008-08-20 21:14:19 +0200 (Mi, 20 Aug 2008) $
   * @since 1.0
   */
  public class PkgInfo extends AbstractFileCreatorAdapter
  {
  
  	public static final String PKG_INFO = "pkginfo";
  
  	public static final String CATEGORY_APPLICATION = "application";
  	public static final String CATEGORY_SYSTEM = "system";
  	
  	public static final String LINE_SEPARATOR = System.getProperty("line.separator");
  
  	static final String VAR_VENDOR = "VENDOR";
  	static final String VAR_CATEGORY = "CATEGORY";
  	static final String VAR_BASEDIR = "BASEDIR";
  	static final String VAR_DESC = "DESC";
  	static final String VAR_ARCH = "ARCH";
  	static final String VAR_VERSION = "VERSION";
  	static final String VAR_NAME = "NAME";
  	static final String VAR_PKG = "PKG";
  
  	/**
  	 * Package name (up to 10 characters) - is required
  	 */
  	private String pkg;
  	private String name;
  	private String version;
  	/**
  	 * Solaris architecture (sparc/x86) - is required
  	 */
  	private String arch;
  	private String desc;
  	private String pkgInfoBasedir = "/";
  	private String category;
  	private String vendor = "unknown";
  	private List<String> optionList;
  	
  	private Log log = LogFactory.getLog(PkgInfo.class);
  	
  	
  	public PkgInfo()
  	{
  		
  	}
  	
  	/**
  	 * Constructor taking the mandatory parameters for this class
  	 * @param pkg
  	 * @param name
  	 * @param version
  	 * @param arch
  	 */
  	public PkgInfo(String pkg, String name, String version, String arch, String category) {
  		this(pkg, name, version, arch, category, null, null, null, null);
  	}
  	
  	/**
  	 * @param pkg
  	 * @param name
  	 * @param version
  	 * @param arch
  	 * @param category
  	 * @param desc
  	 * @param basedir
  	 * @param vendor
  	 * @param optionList addition options, for example "SUMW_PRODNAME=XyOS", "SUMW_PRODVERS=5.10"
  	 */
  	public PkgInfo(String pkg, String name, String version, String arch, String category, 
  			String desc, String basedir, String vendor, List<String> optionList) {
  		super();
  		
  		// Set the values
  		setPkgInternal(pkg);
  		setNameInternal(name);
  		this.version = version;
 		this.arch = arch;
 		this.category = category;
 
 		
 		if(!StringUtil.isNullOrEmpty(desc)) {
 			this.desc = desc;
 		}
 		if(!StringUtil.isNullOrEmpty(basedir)) {
 			this.pkgInfoBasedir = basedir;
 		}
 		if(!StringUtil.isNullOrEmpty(vendor)) {
 			this.vendor = vendor;
 		}
 		this.optionList = optionList;
 	}
 
 
 	public void validate()
 	{
 		if(pkg == null) {
 			throw new NullPointerException("The parameter 'pkg' must not be null");
 		}
 		if(name == null) {
 			throw new NullPointerException("The parameter 'name' must not be null");
 		}
 		if(version == null) {
 			throw new NullPointerException("The parameter 'version' must not be null");
 		}
 		if(arch == null) {
 			throw new NullPointerException("The parameter 'arch' must not be null");
 		}
 		if (category == null) {
 			throw new NullPointerException("The parameter 'category' must not be null");
 		}
 	}
 
 	
 	public String getPkg() {
 		return pkg;
 	}
 
 	public void setPkg(String pkg) {
 		setPkgInternal(pkg);
 	}
 	
 	private void setPkgInternal(String pkg) {
 		if(pkg.length() > 32) {
 			throw new IllegalArgumentException("The given package abbreviation '" + pkg + "' exceeds the maximum allowed length of 32.");
 		}
 		this.pkg = pkg;
 	}
 	
 	
 	public String getVersion() {
 		return version;
 	}
 
 	
 	public String getName() {
 		return name;
 	}
 
 	public void setName(String name) {
 		this.setNameInternal(name);
 	}
 
 	private void setNameInternal(String name) {
 		if(name.length() > 256) {
 			throw new IllegalArgumentException("The given package name '" + name + "' exceeds the maximum allowed length of 256.");
 		}
 		this.name = name;
 	}
 
 	public String getArch() {
 		return arch;
 	}
 
 	
 	public String getDesc() {
 		return desc;
 	}
 
 	public String getPkgInfoBasedir() {
 		return pkgInfoBasedir;
 	}
 
 	public String getCategory() {
 		return category;
 	}
 
 	public String getVendor() {
 		return vendor;
 	}
 
 	public List<String> getOptionList() {
 		return optionList;
 	}
 	public void setOptionList(List<String> optionList) {
 		this.optionList = optionList;
 	}
 	public void addOption(String option) {
 		if(this.optionList == null) {
 			this.optionList = new ArrayList<String>();
 		}
 		this.optionList.add(option);
 	}
 
 	public void setVersion(String version) {
 		this.version = version;
 	}
 
 	public void setArch(String arch) {
 		this.arch = arch;
 	}
 
 	public void setDesc(String desc) {
 		this.desc = desc;
 	}
 
 	public void setPkgInfoBasedir(String pkgInfoBasedir) {
 		this.pkgInfoBasedir = pkgInfoBasedir;
 	}
 
 	public void setCategory(String category) {
 		this.category = category;
 	}
 
 	public void setVendor(String vendor) {
 		this.vendor = vendor;
 	}
 
 	@Override
 	public FileHandler getFileHandler(File targetDir) {
 		DefaultFileHandler fileCreator = new DefaultFileHandler(targetDir, PKG_INFO);
 		return fileCreator;
 	}
 
 	/**
 	 * write pkginfo
 	 * @param target
 	 * @throws IOException 
 	 */
 	public void writeContent(Writer writer) throws IOException 
 	{
 		// Info message
 		log.info("creating pkginfo: \t" + this.toString());
 		String pkgInfo = createPkgInfo();
 		writer.write(pkgInfo);
 		writer.flush();
 		log.info("done.");
 	}
 
 	private String createPkgInfo() 
 	{
 		StringBuffer target = new StringBuffer();
 		// creating pkginfo
 		target.append(VAR_PKG).append("=").append(pkg).append(LINE_SEPARATOR);
 		target.append(VAR_NAME).append("=").append(name).append(LINE_SEPARATOR);
 		target.append(VAR_VERSION).append("=").append(version).append(LINE_SEPARATOR);
 		target.append(VAR_ARCH).append("=").append(arch).append(LINE_SEPARATOR);
 		if(this.desc != null) {
 			target.append(VAR_DESC).append("=").append(desc).append(LINE_SEPARATOR);
 		}
 		if(this.pkgInfoBasedir != null) {
 			target.append(VAR_BASEDIR).append("=").append(pkgInfoBasedir).append(LINE_SEPARATOR);
 		}
 		if(this.category != null) {
 			target.append(VAR_CATEGORY).append("=").append(category).append(LINE_SEPARATOR);
 		}
 		if(this.vendor != null) {
 			target.append(VAR_VENDOR).append("=").append(vendor).append(LINE_SEPARATOR);
 		}
 		
 		// add options
 		if(this.optionList != null) {
 			for(Iterator<String> optionIter = this.optionList.iterator(); optionIter.hasNext() ;) {
 				String option = optionIter.next();
 				target.append(option).append(LINE_SEPARATOR);
 			}
 		}
 		return target.toString();
 	}
 
 	public String generateFilename() {
 		String name = this.getPkg() + "_" + this.getVersion();
 		return name;
 	}
 
 	@Override
 	public String toString()
 	{
 		StringBuffer sb = new StringBuffer();
 		sb.append("pkg=").append(pkg);
 		sb.append(",name=").append(name);
 		sb.append(",version=").append(version);
 		sb.append(",arch=").append(arch);
 		sb.append(",desc=").append(desc);
 		sb.append(",basedir=").append(pkgInfoBasedir);
 		sb.append(",category=").append(category);
 		sb.append(",vendor=").append(vendor);
 		return sb.toString();
 	}
 	
 	
 //	private void printUsage()
 //	{
 //		StringBuffer sb = new StringBuffer();
 //		sb.append("Usage of $0");
 //		sb.append("> $0 -p <pkg> -n <name> -v <version> -a <arch> [-c <category>]");
 //		sb.append("             [-b <basedir>] [-d <description>] [-vd <vendor>] [-o <flag>...]");
 //		sb.append("[Details of Option]");
 //		sb.append(  "-p  <pkg>          : package name (ex. SUMWgcc)");
 //		sb.append(  "-n  <name>         : application name (ex. gcc)");
 //		sb.append(  "-v  <version>      : application version (ex. 4.2.0)");
 //		sb.append(  "-a  <arch>         : architecuture, i86pc,sum4u...");
 //		sb.append(  "-c  <category>     : category of the application (ex. system, application, GNOME2)");
 //		sb.append(  "                     (default = appilcation)");
 //		sb.append(  "-b  <basedir>      : base directory of the application (default = /)");
 //		sb.append(  "-d  <description>  : package description");
 //		sb.append(  "-vd <vendor>       : vendor name (default = unknown)");
 //		sb.append(  "-o  <flag>         : if you want to add other flags, please use it");
 //	    sb.append(  "                     (ex. -o \"SUMW_PRODNAME=XyOS\" -o \"SUMW_PRODVERS=5.10\"");
 //	}
 
 }