/*
    * $Id: UrlFile.java 125 2008-11-04 07:18:28Z arnep $
    */
   package net.sf.ovanttasks.ovnative.win32;
   
   import java.io.File;
   import java.io.FileOutputStream;
   import java.io.FileReader;
   import java.io.IOException;
  import java.io.LineNumberReader;
  import java.io.PrintStream;
  import java.net.URL;
  
  /**
   * UrlFile reads and writes Windows Shortcut files in the .url format. 
   * It can be used to create or read <i>url</i> files which are used by Microsoft for Shortcuts and
   * Favorites.
   * </p>
   * <p>
   * see <a href="http://www.cyanwerks.com/urlFile-format-url.html">windows shortcut
   * url urlFile format</a> for details of the urlFile format.*
   * </p>
   * <p>
   * 
   * <pre>
   * UrlFile sf = new UrlFile(new File(Win32
   * 		.getSpecialDirectory(Win32.SPECIALDIRECTORY_PERSONAL_DESKTOP),
   * 		&quot;Go to ROXES Technologies.url&quot;));
   * sf.setUrl(new URL(&quot;http://www.roxes.com&quot;));
   * sf.setIconFile(&quot;C:\\winnt\\explorer.exe&quot;);
   * sf.setIconIndex(1);
   * // create desktop shortcut
   * sf.save();
   * 
   * // dump created shortcut to console
   * System.out.println(sf);
   * 
   * // create favorite
   * // save shortcut in internet explorer favorites directory 
   * sf.save(new File(Win32
   * 		.getSpecialDirectory(Win32.SPECIALDIRECTORY_PERSONAL_FAVORITES),
   * 		&quot;Go to ROXES Technologies.url&quot;));
   * </pre>
   * 
   * </p>
   * 
   * @author lars.gersmann@roxes.com
   * @author arnep@users.sf.net
   */
  public class UrlFile {
  
      public static final String SIGNATURE = "[InternetShortcut]";
      public static final String LINE_BREAK = "\r\n";
      public static final int SHOWCOMMAND_NORMAL = -1;
      public static final int SHOWCOMMAND_MAXIMIZED = 3;
      public static final int SHOWCOMMAND_MINIMIZED = 7;
      String workingDirectory;
      String iconFile;
      int iconIndex = -1;
      URL url;
      int showCommand = -1;
      short hotKey = -1;
      String modified;
      File urlFile;
  
      /**
       * Create a new <code>LnkFile</code> instance for a specified location.
       * <p>
       * If <code>load</code> is <code>true</code> the instance of 
       * <code>LnkFile</code> is initialized with the values from the <code>lnkFile</code>. 
       * <p>
       * The native library is also loaded.
       * 
       * @param urlFile The lnkFile to use
       * @param load wether or not load the data from existing file.
       */
      public UrlFile(File urlFile, boolean load) throws IOException {
          if (!urlFile.getName().endsWith(".url")) {
              throw new IllegalArgumentException("Url file name must end with \".url\"");
          }
          this.urlFile = urlFile;
          if (load) {
              load();
          }
      }
  
      public void load() throws IOException {
          if (!urlFile.exists() || (urlFile.length() == 0)) {
              return;
          }
          LineNumberReader reader = new LineNumberReader(new FileReader(urlFile));
  
          String line = reader.readLine();
          if (!line.equals(SIGNATURE)) {
              throw new Win32Exception("Shortcut Signature \"" + SIGNATURE + "\"" + " not found in file " + urlFile.getAbsolutePath());
          }
          while ((line = reader.readLine()) != null) {
              int i = line.indexOf('=');
              if (i == -1) {
                 throw new Win32Exception("Invalid Shortcut file format (line " + reader.getLineNumber() + "): \"=\" expected in \"" + line + "\"");
             }
             String key = line.substring(0, i);
             String value = line.substring(i + 1);
 
             if (key.equals("URL")) {
                 url = new URL(value);
             } else if (key.equals("WorkingDirectory")) {
                 workingDirectory = value;
             } else if (key.equals("IconFile")) {
                 iconFile = value;
             } else if (key.equals("IconIndex")) {
                 iconIndex = Integer.parseInt(value);
             } else if (key.equals("ShowCommand")) {
                 showCommand = Integer.parseInt(value);
             } else if (key.equals("Modified")) {
                 modified = value;
             } else if (key.equals("HotKey")) {
                 hotKey = Short.parseShort(value);
             } else {
                 throw new Win32Exception("Invalid Shortcut file format (line " + reader.getLineNumber() + "): dont know key " + key);
             }
         }
 
         reader.close();
     }
 
     /**
      * Create a new <code>UrlFile</code> instance for a specified location.
      * <p>
      * {@link File#File(java.lang.String, java.lang.String) 
      * If <code>load</code> is <code>true</code> the instance of 
      * <code>UrlFile</code> is initialized with the values from the file. 
      * <p>
      * The native library is also loaded.
      * 
      * @param directory The parent pathname string
      * @param name The child pathname
      * @param load wether or not load the data from existing file.
      * @throws IOException 
      */
     public UrlFile(String directory, String name, boolean load) throws IOException {
         setUrlFile(directory, name);
         if (load) {
             load();
         }
     }
 
     public File getUrlFile() {
         return urlFile;
     }
 
     private void setUrlFile(final String directory, String name) {
         if (!name.endsWith(".url")) {
             name += ".url";
         }
         urlFile = new File(directory, name);
         // recoursive ?? apply to LnkFile???
         if (!urlFile.getParentFile().exists()) {
             urlFile.getParentFile().mkdirs();
         }
     }
 
     @Override
     public String toString() {
         StringBuffer sb = new StringBuffer();
         sb.append(SIGNATURE).append(LINE_BREAK);
 
         if (url != null) {
             sb.append("URL=").append(url).append(LINE_BREAK);
         }
         if (showCommand != SHOWCOMMAND_NORMAL) {
             sb.append("ShowCommand=").append(showCommand).append(LINE_BREAK);
         }
         if (workingDirectory != null) {
             sb.append("WorkingDirectory=").append(workingDirectory).append(
                     LINE_BREAK);
         }
         if (iconFile != null) {
             sb.append("IconFile=").append(iconFile).append(LINE_BREAK);
         }
         if (iconIndex != -1) {
             sb.append("IconIndex=").append(iconIndex).append(LINE_BREAK);
         }
         if (modified != null) {
             sb.append("Modified=").append(modified).append(LINE_BREAK);
         }
         if (hotKey != -1) {
             sb.append("HotKey=").append(hotKey).append(LINE_BREAK);
         }
         return sb.toString();
     }
 
     /**
      * @return iconIndex
      */
     public int getIconIndex() {
         return iconIndex;
     }
 
     /**
      * @return modified
      */
     public String getModified() {
         return modified;
     }
 
     /**
      * @return showCommand (see the SHOWCOMMAND_* constants)
      */
     public int getShowCommand() {
         return showCommand;
     }
 
     /**
      * @return url to open
      */
     public URL getUrl() {
         return url;
     }
 
     /**
      * @return working directory
      */
     public String getWorkingDirectory() {
         return workingDirectory;
     }
 
     /**
      * @param string
      *            modification date
      */
     public void setModified(String string) {
         modified = string;
     }
 
     /**
      * @param i
      *            the show command to use (see the SHOWCOMMAND_* constants)
      */
     public void setShowCommand(int i) {
         showCommand = i;
     }
 
     /**
      * @param url
      *            url to open
      */
     public void setUrl(URL url) {
         this.url = url;
     }
 
     /**
      * @param string
      *            the working directory
      */
     public void setWorkingDirectory(String string) {
         workingDirectory = string;
     }
 
     public void save(final String directory, final String name) throws IOException {
         setUrlFile(directory, name);
         save();
     }
 
     public void save() throws IOException {
         PrintStream out = new PrintStream(new FileOutputStream(urlFile));
         out.print(toString());
         out.close();
     }
 
     public void save(File file) throws IOException {
         this.urlFile = file;
         save();
     }
 
     public String getHotKey() {
         return HotKeyTools.toString(hotKey);
     }
 
     /**
      * @return the icon urlFile
      */
     public String getIconFile() {
         return iconFile;
     }
 
     public void setHotKey(String hotKey) {
         this.hotKey = HotKeyTools.parseString(hotKey);
     }
 
     /**
      * @param iconFile
      *            the icon urlFile to use (valid urlFile types are exe, dll and ico)
      * @param iconIndex 
      */
     public void setIcon(String iconFile, int iconIndex) {
         this.iconFile = iconFile;
         this.iconIndex = iconIndex;
     }
 }