jalview 2.5 release banner
[jalview.git] / src / jalview / bin / JalviewLite.java
index 5d2aa04..a904d7c 100755 (executable)
@@ -1,20 +1,19 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  * 
- * 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 file is part of Jalview.
  * 
- * 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.
+ * Jalview 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 3 of the License, or (at your option) any later version.
  * 
- * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * Jalview 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.bin;
 
@@ -22,6 +21,8 @@ import java.applet.*;
 
 import java.awt.*;
 import java.awt.event.*;
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
 import java.util.*;
 
 import jalview.appletgui.*;
@@ -51,7 +52,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param sep
-   *                separator string or null for default
+   *          separator string or null for default
    * @return String list of selected sequence IDs, each terminated by sep or
    *         ("¬" as default)
    */
@@ -62,7 +63,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param alf
-   *                alignframe containing selection
+   *          alignframe containing selection
    * @return String list of selected sequence IDs, each terminated by "¬"
    * 
    */
@@ -75,9 +76,9 @@ public class JalviewLite extends Applet
    * get list of selected sequence IDs separated by given separator
    * 
    * @param alf
-   *                window containing selection
+   *          window containing selection
    * @param sep
-   *                separator string to use - default is "¬"
+   *          separator string to use - default is "¬"
    * @return String list of selected sequence IDs, each terminated by the given
    *         separator
    */
@@ -107,12 +108,12 @@ public class JalviewLite extends Applet
    * get sequences selected in current alignFrame and return their alignment in
    * format 'format' either with or without suffix
    * 
-   * @param alf -
-   *                where selection is
-   * @param format -
-   *                format of alignment file
-   * @param suffix -
-   *                "true" to append /start-end string to each sequence ID
+   * @param alf
+   *          - where selection is
+   * @param format
+   *          - format of alignment file
+   * @param suffix
+   *          - "true" to append /start-end string to each sequence ID
    * @return selected sequences as flat file or empty string if there was no
    *         current selection
    */
@@ -126,12 +127,12 @@ public class JalviewLite extends Applet
    * get sequences selected in alf and return their alignment in format 'format'
    * either with or without suffix
    * 
-   * @param alf -
-   *                where selection is
-   * @param format -
-   *                format of alignment file
-   * @param suffix -
-   *                "true" to append /start-end string to each sequence ID
+   * @param alf
+   *          - where selection is
+   * @param format
+   *          - format of alignment file
+   * @param suffix
+   *          - "true" to append /start-end string to each sequence ID
    * @return selected sequences as flat file or empty string if there was no
    *         current selection
    */
@@ -250,15 +251,15 @@ public class JalviewLite extends Applet
   /**
    * 
    * @param text
-   *                alignment file as a string
+   *          alignment file as a string
    * @param title
-   *                window title
+   *          window title
    * @return null or new alignment frame
    */
   public AlignFrame loadAlignment(String text, String title)
   {
     Alignment al = null;
-    
+
     String format = new IdentifyFile().Identify(text,
             AppletFormatAdapter.PASTE);
     try
@@ -295,28 +296,80 @@ public class JalviewLite extends Applet
    * AlignFrame if the applet is started as embedded on the page and then
    * afterwards a new view is created.
    */
-  public static AlignFrame currentAlignFrame;
+  public static AlignFrame currentAlignFrame = null;
 
   /**
    * This is the first frame to be displayed, and does not change. API calls
    * will default to this instance if currentAlignFrame is null.
    */
-  AlignFrame initialAlignFrame;
+  AlignFrame initialAlignFrame = null;
 
   boolean embedded = false;
 
   private boolean checkForJmol = true;
-  private boolean checkedForJmol = false; // ensure we don't check for jmol every time the app is re-inited
+
+  private boolean checkedForJmol = false; // ensure we don't check for jmol
+
+  // every time the app is re-inited
 
   public boolean jmolAvailable = false;
 
-  public static boolean debug;
+  public static boolean debug = false;
+
+  static String builddate = null, version = null;
+
+  private static void initBuildDetails()
+  {
+    if (builddate == null)
+    {
+      builddate = "unknown";
+      version = "test";
+      java.net.URL url = JalviewLite.class
+              .getResource("/.build_properties");
+      if (url != null)
+      {
+        try
+        {
+          BufferedReader reader = new BufferedReader(new InputStreamReader(
+                  url.openStream()));
+          String line;
+          while ((line = reader.readLine()) != null)
+          {
+            if (line.indexOf("VERSION") > -1)
+            {
+              version = line.substring(line.indexOf("=") + 1);
+            }
+            if (line.indexOf("BUILD_DATE") > -1)
+            {
+              builddate = line.substring(line.indexOf("=") + 1);
+            }
+          }
+        } catch (Exception ex)
+        {
+          ex.printStackTrace();
+        }
+      }
+    }
+  }
+
+  public static String getBuildDate()
+  {
+    initBuildDetails();
+    return builddate;
+  }
+
+  public static String getVersion()
+  {
+    initBuildDetails();
+    return version;
+  }
 
   /**
    * init method for Jalview Applet
    */
   public void init()
   {
+
     /**
      * turn on extra applet debugging
      */
@@ -325,6 +378,13 @@ public class JalviewLite extends Applet
     {
       debug = dbg.toLowerCase().equals("true");
     }
+    if (debug)
+    {
+
+      System.err.println("JalviewLite Version " + getVersion());
+      System.err.println("Build Date : " + getBuildDate());
+
+    }
     /**
      * if true disable the check for jmol
      */
@@ -444,13 +504,13 @@ public class JalviewLite extends Applet
    * Initialises and displays a new java.awt.Frame
    * 
    * @param frame
-   *                java.awt.Frame to be displayed
+   *          java.awt.Frame to be displayed
    * @param title
-   *                title of new frame
+   *          title of new frame
    * @param width
-   *                width if new frame
+   *          width if new frame
    * @param height
-   *                height of new frame
+   *          height of new frame
    */
   public static void addFrame(final Frame frame, String title, int width,
           int height)
@@ -498,7 +558,9 @@ public class JalviewLite extends Applet
       /*
        * Probably not necessary to do this - see TODO above. (non-Javadoc)
        * 
-       * @see java.awt.event.WindowAdapter#windowDeactivated(java.awt.event.WindowEvent)
+       * @see
+       * java.awt.event.WindowAdapter#windowDeactivated(java.awt.event.WindowEvent
+       * )
        * 
        * public void windowDeactivated(WindowEvent e) { if (currentAlignFrame ==
        * frame) { currentAlignFrame = null; if (debug) {
@@ -515,7 +577,7 @@ public class JalviewLite extends Applet
    * If file given in parameter not found, displays error message
    * 
    * @param g
-   *                graphics context
+   *          graphics context
    */
   public void paint(Graphics g)
   {
@@ -539,14 +601,15 @@ public class JalviewLite extends Applet
 
   class LoadJmolThread extends Thread
   {
-    private boolean running=false;
+    private boolean running = false;
 
     public void run()
     {
-      if (running || checkedForJmol) {
+      if (running || checkedForJmol)
+      {
         return;
       }
-      running=true;
+      running = true;
       if (checkForJmol)
       {
         try
@@ -574,8 +637,8 @@ public class JalviewLite extends Applet
                   .println("Skipping Jmol check. Will use MCView (probably)");
         }
       }
-      checkedForJmol=true;
-      running=false;
+      checkedForJmol = true;
+      running = false;
     }
 
     public boolean notFinished()
@@ -600,8 +663,11 @@ public class JalviewLite extends Applet
      * State variable: format of file source
      */
     String format;
+
     String _file;
+
     JalviewLite applet;
+
     private void dbgMsg(String msg)
     {
       if (applet.debug)
@@ -636,10 +702,10 @@ public class JalviewLite extends Applet
       dbgMsg("Protocol identified as '" + protocol + "'");
       return file;
     }
-    
+
     public LoadingThread(String _file, JalviewLite _applet)
     {
-      this._file=_file;
+      this._file = _file;
       applet = _applet;
     }
 
@@ -650,7 +716,13 @@ public class JalviewLite extends Applet
       while (jmolchecker.notFinished())
       {
         // wait around until the Jmol check is complete.
-        try { Thread.sleep(2); } catch (Exception e) {};
+        try
+        {
+          Thread.sleep(2);
+        } catch (Exception e)
+        {
+        }
+        ;
       }
       startLoading();
     }
@@ -672,12 +744,32 @@ public class JalviewLite extends Applet
       {
         dbgMsg("File load exception.");
         ex.printStackTrace();
+        if (debug)
+        {
+          try
+          {
+            FileParse fp = new FileParse(file, protocol);
+            String ln = null;
+            dbgMsg(">>>Dumping contents of '" + file + "' " + "("
+                    + protocol + ")");
+            while ((ln = fp.nextLine()) != null)
+            {
+              dbgMsg(ln);
+            }
+            dbgMsg(">>>Dump finished.");
+          } catch (Exception e)
+          {
+            System.err
+                    .println("Exception when trying to dump the content of the file parameter.");
+            e.printStackTrace();
+          }
+        }
       }
       if ((al != null) && (al.getHeight() > 0))
       {
         dbgMsg("Successfully loaded file.");
         newAlignFrame = new AlignFrame(al, applet, file, embedded);
-        if (initialAlignFrame==null)
+        if (initialAlignFrame == null)
         {
           initialAlignFrame = newAlignFrame;
         }
@@ -689,8 +781,7 @@ public class JalviewLite extends Applet
           newAlignFrame.setTitle("Sequences from " + getDocumentBase());
         }
 
-        newAlignFrame.statusBar.setText("Successfully loaded file "
-                + file);
+        newAlignFrame.statusBar.setText("Successfully loaded file " + file);
 
         String treeFile = applet.getParameter("tree");
         if (treeFile == null)
@@ -749,8 +840,7 @@ public class JalviewLite extends Applet
           param = setProtocolState(param);
 
           if (new AnnotationFile().readAnnotationFile(
-                  newAlignFrame.viewport.getAlignment(), param,
-                  protocol))
+                  newAlignFrame.viewport.getAlignment(), param, protocol))
           {
             newAlignFrame.alignPanel.fontChanged();
             newAlignFrame.alignPanel.setScrollValues(0, 0);
@@ -841,9 +931,8 @@ public class JalviewLite extends Applet
                   tmp2.addElement(st2.nextToken());
                   seqstring = st2.nextToken();
                 }
-                tmp.addElement((Sequence) newAlignFrame
-                        .getAlignViewport().getAlignment().findName(
-                                seqstring));
+                tmp.addElement((Sequence) newAlignFrame.getAlignViewport()
+                        .getAlignment().findName(seqstring));
               }
 
               seqs = new SequenceI[tmp.size()];
@@ -915,13 +1004,13 @@ public class JalviewLite extends Applet
         param = getParameter("hidefeaturegroups");
         if (param != null)
         {
-          applet.setFeatureGroupStateOn(newAlignFrame,param, false);
+          applet.setFeatureGroupStateOn(newAlignFrame, param, false);
         }
         // show specific groups
         param = getParameter("showfeaturegroups");
         if (param != null)
         {
-          applet.setFeatureGroupStateOn(newAlignFrame,param, true);
+          applet.setFeatureGroupStateOn(newAlignFrame, param, true);
         }
       }
       else
@@ -936,7 +1025,7 @@ public class JalviewLite extends Applet
      * Discovers whether the given file is in the Applet Archive
      * 
      * @param file
-     *                String
+     *          String
      * @return boolean
      */
     boolean inArchive(String file)
@@ -1104,7 +1193,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param alf
-   *                alignframe to get feature groups on
+   *          alignframe to get feature groups on
    * @return
    * @see jalview.appletgui.AlignFrame#getFeatureGroups()
    */
@@ -1127,7 +1216,7 @@ public class JalviewLite extends Applet
 
   /**
    * @param alf
-   *                align frame to get groups of state visible
+   *          align frame to get groups of state visible
    * @param visible
    * @return
    * @see jalview.appletgui.AlignFrame#getFeatureGroupsOfState(boolean)
@@ -1139,9 +1228,9 @@ public class JalviewLite extends Applet
 
   /**
    * @param groups
-   *                tab separated list of group names
+   *          tab separated list of group names
    * @param state
-   *                true or false
+   *          true or false
    * @see jalview.appletgui.AlignFrame#setFeatureGroupState(java.lang.String[],
    *      boolean)
    */
@@ -1172,10 +1261,34 @@ public class JalviewLite extends Applet
    * List separator string
    * 
    * @param separator
-   *                the separator to set
+   *          the separator to set
    */
   public void setSeparator(String separator)
   {
     this.separator = separator;
   }
+
+  /**
+   * get boolean value of applet parameter 'name' and return default if
+   * parameter is not set
+   * 
+   * @param name
+   *          name of paremeter
+   * @param def
+   *          the value to return otherwise
+   * @return true or false
+   */
+  public boolean getDefaultParameter(String name, boolean def)
+  {
+    String stn;
+    if ((stn = getParameter(name)) == null)
+    {
+      return def;
+    }
+    if (stn.toLowerCase().equals("true"))
+    {
+      return true;
+    }
+    return false;
+  }
 }