/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

/************************************************************************

        FILENAME: L10nTask.java

        AUTHOR: Erica Grevemeyer      DATE: Jan  30 11:21:09 PST 2002

************************************************************************/
package org.netbeans.nbbuild;

import org.apache.tools.ant.*;
import org.apache.tools.ant.taskdefs.*;
import org.apache.tools.ant.types.FileSet;
import java.io.*;
import java.util.*;
import org.netbeans.nbbuild.utils.cvsutils.CvsEntries;

/**
 * This task was created to create L10N kits.
 * The xml to call this task might look like:
 * 
 *
 *
 * Each resulting kit will be a tar file containing one directory
 *   for each repository examined.  
 * Each repository_directory will contain one tar-file
 *   for each module with changed localizable files.
 * The structure of the tar file is as follows:
 * repository_dir/
 *                 module_tar/
 *                            generatedFile
 *                            contentFile
 *                            localizableFile1.html
 *                            localizableFile2.gif...
 *
 * 1.  All localizable files (as defined in "localizableFile")
 *     "localizableFile" is a list of file patterns difining all localizable source files.
 *     "localizableFile" itself is not included in the kit.
 * 2.  A content file (as named in "contentFile")
 *     This is a list of the names of all localizable files which need to be (re)localized.
 * 3.  A generated file (as named in "generatedFile")
 *     This is a list of the names of all localizable files with the most recent
 *     CVS revision number. 
 * 
 * The generated file need not be committed to cvs until the files come back
 * localized. (This is a change from the procedure followed in late 2001).
 *
 * As of version 1.1.2, converted Gzip methods to use ant 1.4.1, and added ability to 
 * 1) embed exclude patterns in the l10n.list file 
 *		(must use keyword "exclude " followed by the pattern.)
 * 2) add ability to embed reading of additional files 
 *		(must use the keyword "read " followed by the path to the file)
 *		The special case "read global" will read the file set by the property globalFile
 * 3) add the ability to embed properties in the patterns. i
 *		The special case "l10n-module" property will be set from within L10nTask
 *
 * @author Erica Grevemeyer
 * @version 1.1,	Feb  4 11:21:09 PST 2002
 * @version 1.1.2	Aug 29 15:23:51 PDT 2002
 */
public class L10nTask extends MatchingTask {
	private String[] modules;
	private String[] topdirs;
	private String localizableFile, generatedFile, changedFile,globalFile;
	private String allFile = "l10n.list.all";
	private String excludePattern = ""; 
	private String includePattern = ""; 
		// Sets the set of exclude patterns. 
		// Patterns may be separated by a comma or a space.
		// The first instance which necessitated this addition was 
		// "**/ja/**"
	private String buildDir;
	private String distDir;
	private Vector error = new Vector();
	private Hashtable cvsEntriesCache=new Hashtable();
	private Hashtable changed = new Hashtable();
	private Hashtable generatedFileHash = new Hashtable();
	private Hashtable fullPropHash = null ;

	private Project p;
	private boolean readGlobalFile=false; //have we already read globalFile?
	private StringBuffer[] globalsbholder= new StringBuffer[2];
	static boolean DEBUG = false;
	boolean cont=false;
	private String buildNumber;
	String[] localizableFiles;

	public void execute() throws BuildException {
		// 1. Check that settable variables have been set.
		// If they have not been, abandon ship!

		if (modules == null ) {
			throw new BuildException("Required variable not set.  Set 'modules' in the calling .xml file");
		}
		if (topdirs == null ) {
			throw new BuildException("Required variable not set.  Set 'topdirs' in the calling .xml file");
		}
		if (distDir == null ) {
			throw new BuildException("Required variable not set.  Set 'distDir' in the calling .xml file");
		}

		if (buildDir == null ) {
			throw new BuildException("Required variable not set.  Set 'buildDir' in the calling .xml file");
		}
		if (localizableFile == null ) {
			throw new BuildException("Required variable not set.  Set 'localizableFile' in the calling .xml file");
		}
		if (generatedFile == null ) {
			throw new BuildException("Required variable not set.  Set 'generatedFile' in the calling .xml file");
		}
		if (changedFile == null ) {
			throw new BuildException("Required variable not set.  Set 'changedFile' in the calling .xml file");
		}
		if (buildNumber == null ) {
			throw new BuildException("Required variable not set.  Set 'buildNumber' in the calling .xml file");
		}

		//if the dir doesn't exist, make it.
		// if the dir still doesn't exist, fail.
		File dd = new File(distDir);
		if ( ! dd.exists()  ) {
			dd.mkdirs();
		}

		System.out.print("topdirs:\t");
		for (int j=0; j= 0) {
						String moduleFileName= localizableFiles[i].substring(lio+fullTopDir.length()+1);
						allWrite.write(moduleFileName+"\n");
					} else {
						System.out.println("Error: NO TOPDIR HERE: "+ localizableFiles[i]+ " FTD: "+fullTopDir+" LIO "+lio);
					}

				}
			}
			allWrite.close();
		
		} catch (IOException ioe) {
			System.out.println("IOException"+ioe);
			return false;
		}
		return true;

	}
	public boolean printToFile(String fullTopDir, String module) {

		// if (DEBUG) System.out.println("IN printToFile FULLTOPDIR"+fullTopDir+ " MODULE" + module);
			
		try {

			int lastSlashIndex = fullTopDir.lastIndexOf(File.separator);
			String topDir= fullTopDir.substring(lastSlashIndex+1);

		/*  No need to mkdirs now - printToAllFile is making them.
			File f = new File(buildDir+ File.separator +topDir );
			f.mkdirs();
		*/

			FileWriter genWrite = new FileWriter(fullTopDir+File.separator+module+File.separator+module+"."+generatedFile);
			FileWriter changedWrite = new FileWriter(fullTopDir+File.separator+module+File.separator+module+"."+changedFile);


			if ( generatedFileHash == null ) {
				generatedFileHash = new Hashtable();
			} else {

				for (Enumeration g = generatedFileHash.keys() ; g.hasMoreElements() ;) {
					String genFileKey = (String)g.nextElement();
					int lioTopDir =  genFileKey.lastIndexOf(topDir);
					String moduleFileName = genFileKey.substring(lioTopDir+topDir.length()+1) ;

					genWrite.write(moduleFileName+"\t"+(String)generatedFileHash.get(genFileKey)+"\n");
				}

				// To make sure the changeFile & generatedFile appear in the tar,
				// make them the first lines in the file.
				for (Enumeration c = changed.keys() ; c.hasMoreElements() ;) {
					String changedFileKey = (String)c.nextElement();

					int lio = changedFileKey.lastIndexOf(topDir+File.separator+module);
					String moduleFileName;
					if (lio >= 0) {
				
						moduleFileName=changedFileKey.substring(changedFileKey.lastIndexOf(topDir+File.separator+module)+topDir.length()+1);
						changedWrite.write(moduleFileName+"\n");
					} else {
						// If we get here, the cache is probobly not really being cleared.  

						//The cache is not being cleared 
						// OR we have wild-card characters
						System.out.println("WARNING: L10n.list file error. Each item in your list should reference the current module.  If this is a global l10n file used over several modules use the property ${l10n-module} as a place-holder.  This error occurred in "+module+".");
						// Contact program administrator.\r\t"+ changedFileKey+ "\r\tTD "+topDir+File.separator+module +" LIO "+lio);	
					}

					//changedWrite.write(changedFileKey+"\n");
					//Changed should have a list of fullpath in order to do copy
				}
			}

			if (! error.isEmpty() ) {
				FileWriter errorWrite = new FileWriter(buildDir+File.separator+"l10n-errors.txt", true);
				for (Enumeration e = error.elements(); e.hasMoreElements();) {
					String ee = (String)e.nextElement();
					errorWrite.write(ee+"\n");
					System.out.println("Error: "+ee);
				}
				errorWrite.close();
			}
	

			genWrite.close();
			changedWrite.close();


		} catch (IOException ioe) {
			System.out.println("IOException printToFile()"+ioe);
			return false;
		}
		return true;
	}

        /** You can use this function independently of "execute()", but
         * you have to set these attributes: localizableFile,
         * globalFile (if "read global" is used in any l10n.list
         * files), excludePattern (if desired), includePattern (if
         * desired)
         */
	public String[] getLocalizableFiles(File topRoot, String module) {
		String[] lfs = null;
		StringBuffer[] sbholder=new StringBuffer[2];
		StringBuffer sbi= new StringBuffer();
		StringBuffer sbe = new StringBuffer();
		String includeS="";
		String excludeS="";
		// if (DEBUG) System.out.println("\t\tIN getLocalizableFiles(File "+topRoot.getName()+", " + module+")");

		if( fullPropHash == null) {
		  p = getProject() ;
		  fullPropHash = p.getProperties();
		}
		fullPropHash.put("l10n-module", module);

		try {
			File includes = new File(topRoot.getCanonicalPath() + File.separator + module + File.separator + localizableFile);
			if ( ! includes.exists() || includes.length() <= 0 ) {
				//if (DEBUG) System.out.println("FILE IS too short to mess with "+ module);
				return lfs;
			}

			try {
				sbholder = processListFile(includes,module);
			} catch (java.io.IOException ioe) {
				System.out.println("Error processing file. "+ioe);
			}

			if (sbholder != null) {
				sbi = sbholder[0];
				sbe = sbholder[1];

				sbe.append(" "+excludePattern);
				sbi.append(" "+includePattern);

				if (DEBUG) {
					System.out.println("INC "+sbi.toString());
					System.out.println("EXC "+sbe.toString());
				}
			}

			this.fileset = new FileSet();

			// this.setIncludesfile(includes);
			if ( sbi !=null) {
				this.setIncludes(sbi.toString()); 
					//changed to accomodate excludes in file
			}

			if (sbe != null ) {
				this.setExcludes(sbe.toString());
				// Sets the set of exclude patterns. 
				// Patterns may be separated by a comma or a space.
			}

			DirectoryScanner ds = this.getDirectoryScanner(topRoot);
		
			ds.scan();
			lfs = ds.getIncludedFiles();

			for (int k=0; k 0) {
						String filename = line.substring(0,tabIndex);
						String revision = line.substring(tabIndex+1);
						h.put(topDirFullPath+File.separator+filename, revision);
					} else {
						System.out.println("There's no tab in this line"+"["+line+"]");
					
					}

                }

            } //while
		} catch(java.io.FileNotFoundException e) {
			// Warning: Generated File: "+generatedFile+" in "+
			// topDir+File.separator+mod+" not found.  
			// Adding all files to changed list."
			return(null);
		} catch(java.io.IOException e) {
			System.out.println("IOException "+ e);
		}

		return h;
	}

	// Accessor Methods

	public void setTopdirs(String s) {
		StringTokenizer st = new StringTokenizer(s);
		String[] tops = new String[st.countTokens()];
		int i=0;
		while (st.hasMoreTokens()) {
			tops[i++]=st.nextToken();
		}

		if (false) {
			for (int j=0; j= 0) {
				//Check that the mod doesn't have a slash
				// (if it does, keep only what is to the left of the slash)
				fullMod=fullMod.substring(0,index);

				// if (DEBUG) System.out.println("CHANGED FULLMOD & it's NOW "+fullMod);
			}
                        modSet.add( fullMod );
		}
                this.modules = new String[ modSet.size() ];
                Iterator it = modSet.iterator();
                
                int i=0;
                while( it.hasNext() )
                    this.modules[i++] = (String) it.next();
		
	}

	public StringBuffer[] processListFile(File inc,String module) throws java.io.IOException {
		System.out.println("Reading list file: "+inc.toString());
		StringBuffer[] sbholder=new StringBuffer[2];
		StringBuffer sbi = new StringBuffer();
		StringBuffer sbe = new StringBuffer();

		
		if(inc.exists() && inc.length() >0) {
			//Read Includes File.
			try {
				BufferedReader br = new BufferedReader(new FileReader(inc));
				String line;
				while((line=br.readLine()) != null && line.indexOf("#") <0) {
					boolean skipit=false;
					// For each line check if there are any properties which 
					// should be interpreted first.
					while (line.indexOf("${") >= 0 && skipit == false) {
						
						String propertyName;
						String value="";
						String res="";
						String pre="";

						propertyName=line.substring(line.indexOf("${")+2,line.indexOf("}"));

						if (fullPropHash.containsKey(propertyName)) {
							
							value=(String)fullPropHash.get(propertyName);
							res = line.substring(line.indexOf("}")+1);	
							pre= line.substring(0,line.indexOf("{")-1);
							line=pre+value+res;
							// System.out.println("LINE is now "+line);
						} else {
							System.out.println("Uninterpretable property in l10n file:"+inc.toString()+". "+propertyName+" Interpreting the entire line literally.");
							skipit=true;
						}
					}

					if (line.indexOf("exclude") >= 0) {
						sbe.append(" "+line.substring("exclude".length()+1));
					} else if (line.indexOf("read global") >= 0) {
						
						if (globalFile != null && ! globalFile.equals("")) {
							if (readGlobalFile==true) {
								System.out.println("Already read it");
								//We did it once, don't do it again.
								// just copy in the values.
								sbi.append(" "+globalsbholder[0]);
								sbe.append(" "+globalsbholder[1]);
							} else {
							        globalsbholder[0]= new StringBuffer();
								globalsbholder[1]= new StringBuffer();
								StringBuffer[] globalarray = processListFile(new File(globalFile),module);
								if (globalarray[0] != null) {
									sbi.append(" "+globalarray[0]);
									globalsbholder[0].append(" "+globalarray[0]); 
									//put it where we can get it back.
								} 
								if (globalarray[1] != null) {
									sbe.append(" "+globalarray[1]);
									globalsbholder[1].append(" "+globalarray[1]); 
										//put it where we can get it back.
								}
							}
							readGlobalFile = true ;
						}
					} else if( line.trim().startsWith( "read")) {
					  String l = line.trim() ;
					  l = l.substring( 4) ;
					  l = l.trim() ;
					  StringBuffer[] sbarr = processListFile( new File( l), 
										  module) ;
					  sbi.append( " " + sbarr[ 0]) ;
					  sbe.append( " " + sbarr[ 1]) ;
					} else {
						sbi.append(" "+line);
					}
					// System.out.println("GLOBAL"+line.indexOf("read global")+" EXCLUDES "+line.indexOf("exclude")+ "FILE"+inc.toString());
				} //while
				br.close();
				} catch (java.io.IOException ioe) {
					throw new java.io.IOException(ioe.toString());	
				}
		}
		sbholder[0]=sbi;
		sbholder[1]=sbe;
		return sbholder;
	}

	public void setDistDir(String s) {
		// if (DEBUG) System.out.println("DIST DIR SHOULD BE: "+s);
		this.distDir=s;
	}
	public void setBuildDir(String s) {
		this.buildDir=s;
	}
	public void setDebug(boolean s) {
		this.DEBUG=s;
	}
	public void setLocalizableFile(String s) {
		this.localizableFile=s;
	}
	public void setExcludePattern(String s) {
		this.excludePattern=s;
	}
	public void setIncludePattern(String s) {
		this.includePattern=s;
	}
	
	public void setBuildNumber(String s) {
		this.buildNumber=s;
	}
	public void setGeneratedFile(String s) {
		this.generatedFile=s;
	}
	public void setChangedFile(String s) {
		this.changedFile=s;
	}
	public void setGlobalFile(String s) {
		this.globalFile=s;
	}
}