/*
    Copyright (C) 2000  Ralph Hartley

    This program 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.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

import java.awt.event.*;
import java.awt.*;
import java.awt.geom.*;
import java.util.*;
import java.io.*;
import java.util.zip.*;
import java.net.*;
import java.util.jar.*;
import java.awt.print.*;
import java.awt.image.*;
import javax.swing.*;
import java.lang.ref.*;
import java.text.NumberFormat;

/**
 *The main class of the Carto program.
 *Contains everything that is found in a .cto file.<br>
 *As a general rule, variables and methods should not be in this file
 *unless there is no other place they can go.
 */
public class Carto implements Serializable {

  private static final long serialVersionUID = Version.getSUID();

  /**
   *The base from which carto files are relative.
   *(if any)
   */
  static File filebase = new File(System.getProperty("user.dir"));

  static GraphicsEnvironment genv = GraphicsEnvironment.getLocalGraphicsEnvironment();
  static GraphicsConfiguration gconf = genv.getDefaultScreenDevice().getDefaultConfiguration();

  public static Selection cutbuffer = null;

  public transient Selection[] selections = new Selection[4];

  /**The set of sizes for this file
   *@deprecated Replaced by defaults.
   */
  public TreeSet sizes;     //legacy

  /**
   *Default overrides for this file.
   *Keys are types, values are sets of FileDefaultables of that type. */
  public HashMap defaults = new HashMap(5,5);

  /**Survey data for this file. */
  public Survey survey = null;

  /**Composites in this file.
   *This only includes top level Composites. There may be composites included in
   *the file that are not in complist (usr defined symbols etc).*/
  public Vector complist = new Vector();

  /**Segments in this file.
   *ALL segments referenced from this must be in segmentlist. 
   *Does not include section and profile segments */
  public Vector segmentlist = new Vector();

  /**Cross sections in this file.
   *ALL sections referenced from this must be in sectionlist. */
  public Vector sectionlist = new Vector();

  /**The states of the editors that were open when last saved. */
  public EditState[] place = null;

  /**
   *PrefEditors for this file.
   *These contain the file specific preferences. */
  public PrefEditor[] prefs = null;

  /**The default screen unit.
   *New files get their screen unit from here.
   *Is set by a global Pref. */
  public static Unit defscreenunit = Unit.inch;

  /**The default map unit.
   *New files get their map unit from here.
   *Is set by a global Pref. */
  public static Unit defmapunit = Unit.foot;

  /**The screen unit.
   *This is the default unit for distances on the screen.
   *It is not really used for much.*/
  public Unit screenunit = defscreenunit;

  /**The map unit.
   *Determines what units the survey data are defined in terms off.
   *If not set correctly, survey data will not be interpreted correctly.
   */
  public Unit mapunit = defmapunit;

  /**Represents the version running now. */
  public static Version runversion = new Version();

  /**The version of Carto that created this file. */
  public String created_version = runversion.getVersion();
  /**The version of Carto that last saved this file. */
  public String saved_version = runversion.getVersion();

  /** The directory containing the .cto file<br>
   *Used for finding images if things have moved.
   */
  public transient File base = null;
  /** If the file was int a zip, the entry it was in.
   */
  public transient ZipEntry zipent = null;
  /**
   *If the file was in a zip the zip file it was in.
   */
  public transient ZipFile zipfile = null;

  /**The thread in which the background job runs.
   *If null, then there is no background job.
   *Background jobs are used for cooking and printing. Only
   *one is allowed at a time because they are not thread safe.
   *Background jobs must clear this pointer when the end.
   */
  public static Thread background = null;
  /**A flag that tells the background job that it should die. 
   *Background jobs should clear this flag when they die.*/
  public static int kill = 0;

  /**Indicates that a cook job should die. */
  public static int COOKKILL = 1;
  /**Indicates that a print job should die. */
  public static int PRINTKILL = 1;

  /**Create a new, empty carto file. */
  public Carto() {
    for (int i=0;i<4;i++)
      selections[i] = new Selection(this);

    FileDefaultable.sortOut(defaults);
  }

  /**
   *Prompt the user for a .cto file */
  public static File choose(Component parent) {
    JFileChooser choose = Persist.current.getFileChooser();

    choose.setFileFilter(new FileTypes(FileTypes.CARTO));
    choose.rescanCurrentDirectory();
    if (choose.showOpenDialog(parent)!=choose.APPROVE_OPTION) return(null);
    return(choose.getSelectedFile());
  }

  /**
   *Read a Carto from a file.
   *Sorts out its defaults.
   *@returns null if the file has a problem
   */
  public static Carto read(File filename) {
    Object result = null;
    File base = null;
    ZipFile zip = null;
    ZipEntry zipent = null;
    try {
      InputStream istream = null;
      if (filename.getName().substring(filename.getName().lastIndexOf('.')+1).equals("cto")) {
        istream = new FileInputStream(filename);
        base = filename.getCanonicalFile().getParentFile();
      }
      else {
        base = filename.getCanonicalFile();
        zip = new ZipFile(filename);

        Vector ctos = new Vector();
        for (Enumeration zipnames = zip.entries();
             zipnames.hasMoreElements();) {
          ZipEntry ent = (ZipEntry)zipnames.nextElement();
          String name = ent.getName();
          int dot = name.lastIndexOf('.');
          if (dot>=0 && name.substring(dot).equals("cto"))
            ctos.add(ent);
        }
        if (ctos.size()==0) throw new FileNotFoundException(filename.getName()+
        						     " does not conatain any .cto files");
        else if (ctos.size()==1) zipent = (ZipEntry)ctos.elementAt(0);
        else {
          Object[] names = ctos.toArray();
          zipent = (ZipEntry)JOptionPane.showInputDialog(null,
        					      "Choose .cto file from zip",
        					      "Zip",
        					      JOptionPane.QUESTION_MESSAGE,
        					      null,
        					      names,
        					      names[0]);
        }
        if (zipent==null) return(null);
        istream = zip.getInputStream(zipent);
      }
      ObjectInputStream in = new ObjectInputStream(istream);
      result = in.readObject();
      istream.close();
    } catch (Exception e) {
        ErrorLog.log("Carto file not sucessfully read: "+filename);
        ErrorLog.exception(e);
        return(null);
    }

    if (result == null || !(result instanceof Carto)) {
      ErrorLog.log("error: could not read Carto data from "+filename+".");
      return(null);
    }
    else {
      Carto res = (Carto)result;
      FileDefaultable.sortOut(res.defaults);
      res.zipfile = zip;
      res.base = base;
      res.zipent = zipent;
      return(res);
    }
  }

  /**
   *Get ready for Survey update.
   */
  public void prepareForSurveyUpdate() {
    for (Iterator it = complist.iterator();it.hasNext();) {
      ((Comp)it.next()).prepareForSurveyUpdate(null);
    }
  }

  /**
   *Use a survey update.
   *Move symbols to follow changed morph.
   */
  public void useSurveyUpdate() {
    for (Iterator it = complist.iterator();it.hasNext();) {
      ((Comp)it.next()).useSurveyUpdate();
    }
  }

  /**
   * Gets list of eliments by type 
   */
  public Vector getList(String name) {
    if (name.equals(CartoFrame.SEGWORD)) return(segmentlist);
    else if (name.equals(CartoFrame.COMPWORD)) return(complist);
    else if (name.equals(CartoFrame.SECTION)) return(sectionlist);
    return(new Vector()); //Should never happen.
  }

  /**
   *Cleans up trash.
   *Deletes Segments that are referenced but not listed.
   *Put code to fix other inconsitent states here. */
  public void clean() {
    for (Iterator it = complist.iterator();it.hasNext();)
      ((Comp)it.next()).clean(segmentlist);
  }

  /**
   *Tells if station is used anywhere,<br>
   *other than in survey.
   *If so, returns string saying how.
   *Otherwise returns null.
   *Used to decide if safe to delete station from survey.
   */
  public String used(Vertex station) {
    String res = "";

//    for (Iterator it = complist.iterator();it.hasNext();) {
//      String str = ((Comp)it.next()).used(station);
//      if (str!=null) res += "\n"+str;
//    }

    for (Iterator it = segmentlist.iterator();it.hasNext();) {
      Segment seg = (Segment)it.next();
      if (seg.map.used(station))
        res += "   to morph segment "+seg+"\n";
    }

    if (res.length()==0) return(null);
    return(res);
  }

  /**
   *Remove any use of station.<br>
   *Used to make it safe to delete station from survey.
   */
  public void remove(Vertex station) {
//    for (Iterator it = complist.iterator();it.hasNext();)
//      ((Comp)it.next()).remove(station);

    for (Iterator it = segmentlist.iterator();it.hasNext();)
      ((Segment)it.next()).map.remove(station);
  }


  /**Start a background job.
   *Makes sure that there is not one already. */
  public static boolean startBackground(Thread action) {
    synchronized(Carto.class) {
      if (background != null) {
        ErrorLog.log("There is already a background process going on\n"+
        	     "It should be stoped before starting another\n");
        return(false);
      }
      background = action;
      background.setPriority(background.getPriority()-1);
      background.start();
      return(true);
    }
  }

  /**Indicate that background has died.
   *Must only be called by the background job.
   *Must always be called by any background job before dieing */
  public static void cleanBackground() {
    synchronized(Carto.class) {
      background = null;
      kill = 0;
    }
  }

  /**Kill the background job.
   *Waits for the job to die. */
  public static void stopBackground(int killval) {
    Thread deadthread;
    synchronized(Carto.class) {
      deadthread = Carto.background;
      if (deadthread!=null)
          Carto.kill = killval;
    }
    if (deadthread!= null)
      while (background==deadthread) {
        try {
          Thread.sleep(50);
        } catch (InterruptedException e) {}
      }
  }

  /**
   *Recook all segments.<br>
   *Throws out the morphed version of all segments
   *and forces them to be remorphed from scratch. */
  public void reCookAll(final ThreadMessage message,final CartoFrame owner) {
//    ErrorLog.log("recookall debug");

    if (Segment.cookondemand) {
      ImageThread.stopLoading();
      for (Iterator it = segmentlist.iterator();it.hasNext();) {
        Segment seg = (Segment) it.next();
        seg.doCook(null);
      }
    }
    else {

      startBackground(new Thread(){
          public void run() {
            try {
              for (Iterator it = segmentlist.iterator();it.hasNext();) {
        	Segment seg = (Segment) it.next();
        	seg.unCook();
        	if (seg.cookable()) seg.cook(null);
              }
            } catch (CookKillException killex) {
            } finally {
              owner.repaint();
              cleanBackground();
            }
          }}); 
    }
  }

  /**
   *Hard recook of all segments.<br>
   *Currently this just calls reCookAll, because there is no
   *soft recook anymore.
   */
  public void hardReCookAll(final ThreadMessage message,final CartoFrame owner) {
    reCookAll(message,owner);
  }

  /**
   *Get the defaults of a given type.
   *Returns the set of default overides, if any. */
  public TreeSet getDefs(Class type) {
    if (!defaults.containsKey(type))
      defaults.put(type, new TreeSet());
    return((TreeSet)defaults.get(type));
  }

  /**Reads a Carto from a stream.
   *We define this method to fix up the old file to work with the current version. */
  private void readObject(java.io.ObjectInputStream stream)
      throws java.io.IOException,java.lang.ClassNotFoundException {
    stream.defaultReadObject();

    //fix legacies from before PrefDef existed

    if (defaults==null) defaults = new HashMap(5,5);

    if (!defaults.containsKey(Size.class)) {
      if (sizes!=null) defaults.put(Size.class,sizes);
      else defaults.put(Size.class,new TreeSet());
    }

    if (mapunit==null) mapunit = defmapunit;
    if (screenunit==null) screenunit = defscreenunit;

    if (sectionlist==null) sectionlist = new Vector();

    if (selections==null || selections[0]==null) {
      selections = new Selection[4];
      for (int i=0;i<4;i++)
        selections[i] = new Selection(this);
    }
  }

  /**Gets the names of all the contents of a directory in a Jar file */
  public static String[] getSubdirList(JarFile source,String dirname) throws IOException{
    Vector list = new Vector();
    for (Enumeration entries  = source.entries();
         entries.hasMoreElements();) {
      String name = ((JarEntry)entries.nextElement()).getName();
      if (name.startsWith(dirname)
          && !name.equals(dirname)) list.add(name);
    }
    String[] res = new String[list.size()];
    for (int i=0;i<list.size();i++) res[i] = (String)list.elementAt(i);
    return(res);
  }

  /**Copies the named files from the Jar file.
   *Puts the results in the base directory. If any of
   *the named files are directories copies the files they contain
   *as well */
  public static void copyFiles(JarFile source,String[] names) throws IOException{
    for (Enumeration entries  = source.entries();
         entries.hasMoreElements();) {
      JarEntry ent = (JarEntry)entries.nextElement();
      String name = ent.getName();
      for (int i=0;i<names.length;i++) {
        if (name.equals(names[i])) {
          if (ent.isDirectory()) {
            (new File(filebase,name)).mkdir();
//            System.out.println("base = "+base+" dir = "+name);
            String[] subs = getSubdirList(source,name);
//            System.out.println("subs = "+subs);
            copyFiles(source,subs);
          } else {
            File dest = new File(filebase,name);
            try {
              InputStream instr = source.getInputStream(ent);
              OutputStream outstr = new FileOutputStream(dest);
              byte[] buff = new byte[1000];
              for (int num = 0;num>=0;) {
        	outstr.write(buff,0,num);
        	num = instr.read(buff);
              }
              outstr.close();
            } catch (IOException e) {
              ErrorLog.exception(e,"Cannot write "+dest);
            }
          }
        }
      }
    }
  }

  /**Copy a file from the jar file to the base directory. */
  public static void copyFile(String name){
    URL source = runversion.getClass().getResource(name);
//    System.out.println(source);
    File dest = new File(filebase,name);
    try {
      InputStream instr = source.openStream();
      OutputStream outstr = new FileOutputStream(dest);
      byte[] buff = new byte[1000];
      for (int num = 0;num>=0;) {
        outstr.write(buff,0,num);
        num = instr.read(buff);
      }
      outstr.close();
    } catch (IOException e) {
      ErrorLog.exception(e,"Cannot write "+dest);
    }
  }

  public static String[] installfiles = {"gpl.txt","contributors.txt","version.txt","symbol/","stamp/","help/"};
//,"example/"};

  /**Make sure the instalation is complete.
   *If not, complete it. Uses version.txt to determine
   *what needs to be unpacked. If needed unpacks
   *symbol libraries and
   *optional files (gpl.txt + example files (if any)).
   *If persist.sta does not exist, create it.*/
  public static void checkInstall() {
    File name = new File(filebase,"version.txt");
    if (!name.exists()) {
      ErrorLog.logOK("Installing files");
      try {
      JarFile source = ((JarURLConnection)(runversion.getClass().
        		getResource("version.txt").openConnection())).getJarFile();
      copyFiles(source,installfiles);
//      copyDir(source,"symbol",base);
//      copyDir(source,"stamp",base);
//      copyDir(source,"fill",base);
      } catch (IOException e) {ErrorLog.exception(e,"trouble installing");}
    }
    if (!Persist.statefile.exists()) {
      ErrorLog.logOK("Creating new default Preferences :"+Persist.statefile);
      (new Persist()).saveState();
    }
  }

  /** Print some basic statistics for the file. <br>
   */
  public void printStats(PrintStream out) {
    double area = 0;
    double afact = 0;
    String aname = "hectares";
    NumberFormat form = NumberFormat.getNumberInstance();
    form.setMaximumFractionDigits(2);

    afact = Unit.meter.toUnit(mapunit); 
    afact *= afact;
    afact /= 10000;

    if (mapunit == Unit.foot) {
      afact/= 0.4047;
      aname = "acres";
    }

    out.println("last survey update "+survey.name);
    out.println(""+survey.stations.size()+" stations "+survey.shots.size()+" shots");
        
    out.println("\n"+segmentlist.size()+" Segments");

    int namemax = 0;
    int filemax = 0;
    for (Iterator it = segmentlist.iterator(); it.hasNext();) {
      Segment seg = (Segment)it.next();
      int length = seg.name.length(); 
      if (length>namemax) namemax = length;
      length = seg.isource.source.getName().length();
      if (length>filemax) filemax = length;
    }

    for (Iterator it = segmentlist.iterator(); it.hasNext();) {
      Segment seg = (Segment)it.next();
      double sarea = seg.area();
      area += sarea;
      StringBuffer buff = new StringBuffer();
      buff.append(seg.name);
      while (buff.length() < namemax+5) buff.append(' ');
      buff.append("file = "+seg.isource.source.getName());
      while (buff.length() < namemax+filemax+18) buff.append(' ');
      buff.append("area = "+form.format(sarea)+" sq "+mapunit+
        	  " ("+form.format(sarea*afact)+" "+aname+")");
      out.println(buff);
    }
    out.println("\nTotal area of segments = "+form.format(area)+" square "+mapunit+
        	" ("+form.format(area*afact)+" "+aname+")");

    area = Segment.totalArea(segmentlist);
    out.println("\nEstimated Cave area = "+form.format(area)+" square "+mapunit+
        	" ("+form.format(area*afact)+" "+aname+")");

    out.println("\n"+complist.size()+" Composites");

    for (Iterator it = complist.iterator(); it.hasNext();)
      out.println(""+((Comp)it.next()).name);
  }

  /**Start the Carto program.
   *Initializes error log, reads persistant state,
   *prints about message, and shows a new CartoFrame.<br>
   *CartoFrame does most top level functions, but it has the wrong name
   *to be the main class. */
  static public void main(String args[]) {
    boolean stats = false;
    int i;

    String filename = null;
    for (i=0;i<args.length;i++) {
      if (args[i].equals("-b")) {
        filebase = new File(filebase,args[i+1]);
        i++;
      }
      if (args[i].equals("-s")) {
//        filename = args[i+1];
        stats = true;
        i++;
        break;
      }
      else if (i==args.length-1)
        filename = args[i];
    }

    ErrorLog log = null;

    try {
      System.setErr(log=new ErrorLog());
    } catch (Exception e2) {
      System.out.println("Trying to set up the error file itself caused an error");
      System.out.println("RunID = "+Persist.current.getRunID());
      e2.printStackTrace();
    }

    checkInstall();

    Persist.restore();

    log.logMessage();
    
    System.out.print(runversion.getAbout());

    File startfile = null;
    if (filename!=null) startfile = new File(filebase,filename);

    if (stats) {
      try {
//        if (i==args.length) {
//          System.out.println("\nCarto File "+startfile.getName());
//          read(startfile).printStats(System.out);
//        }
        for (;i<args.length;i++) {
          File file = new File(filebase,args[i]);
          System.out.println("\nCarto File "+file.getName());
          read(file).printStats(System.out);
        }    
      } catch (Exception ex) {
        log.exception(ex,"Trouble printing stats");
        System.exit(1);
      }
    }
    else {
      CartoFrame frame = new CartoFrame(startfile);

      frame.show();
      
      frame.setLocation(CartoFrame.initialx,CartoFrame.initialy);
    }
  }        			 
}