Jalview 2.6 source licence
[jalview.git] / src / jalview / gui / Desktop.java
index 90af881..6910f28 100755 (executable)
@@ -1,30 +1,32 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
+ * 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.gui;
 
 import jalview.bin.Cache;
 import jalview.io.*;
+import jalview.ws.params.ParamManager;
 
 import java.awt.*;
 import java.awt.datatransfer.*;
 import java.awt.dnd.*;
 import java.awt.event.*;
+import java.beans.PropertyChangeEvent;
+import java.beans.PropertyChangeListener;
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
 import java.io.File;
@@ -41,7 +43,8 @@ import javax.swing.event.MenuEvent;
 import javax.swing.event.MenuListener;
 
 /**
- * DOCUMENT ME!
+ * Jalview Desktop
+ * 
  * 
  * @author $author$
  * @version $Revision$
@@ -49,22 +52,123 @@ import javax.swing.event.MenuListener;
 public class Desktop extends jalview.jbgui.GDesktop implements
         DropTargetListener, ClipboardOwner, IProgressIndicator
 {
-  /** DOCUMENT ME!! */
+
+  private class JalviewChangeSupport implements PropertyChangeListener
+  {
+    public void propertyChange(PropertyChangeEvent evt)
+    {
+      // Handle change events - most are simply routed to other sources
+      changeSupport.firePropertyChange(evt);
+    }
+
+    /**
+     * change listeners are notified of changes to resources so they can update
+     * their state. E.g. - the 'services' property notifies when the available
+     * set of web service endpoints have changed.
+     */
+    private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
+            this);
+
+    /**
+     * @param propertyName
+     * @param listener
+     * @see java.beans.PropertyChangeSupport#addPropertyChangeListener(java.lang.String,
+     *      java.beans.PropertyChangeListener)
+     */
+    public void addJalviewPropertyChangeListener(String propertyName,
+            PropertyChangeListener listener)
+    {
+      changeSupport.addPropertyChangeListener(propertyName, listener);
+    }
+
+    /**
+     * @param listener
+     * @see java.beans.PropertyChangeSupport#addPropertyChangeListener(
+     *      java.beans.PropertyChangeListener)
+     */
+    public void addJalviewPropertyChangeListener(
+            PropertyChangeListener listener)
+    {
+      changeSupport.addPropertyChangeListener(listener);
+    }
+
+    /*
+     * @param propertyName
+     * 
+     * @param oldValue
+     * 
+     * @param newValue
+     * 
+     * @see
+     * java.beans.PropertyChangeSupport#firePropertyChange(java.lang.String,
+     * java.lang.Object, java.lang.Object) public void firePropertyChange(String
+     * propertyName, Object oldValue, Object newValue) {
+     * changeSupport.firePropertyChange(propertyName, oldValue, newValue); }
+     */
+
+    /**
+     * @param propertyName
+     * @param listener
+     * @see java.beans.PropertyChangeSupport#removePropertyChangeListener(java.lang.String,
+     *      java.beans.PropertyChangeListener)
+     */
+    public void removeJalviewPropertyChangeListener(String propertyName,
+            PropertyChangeListener listener)
+    {
+      changeSupport.removePropertyChangeListener(propertyName, listener);
+    }
+
+  }
+
+  private JalviewChangeSupport changeSupport = new JalviewChangeSupport();
+
+  /**
+   * @param listener
+   * @see jalview.gui.Desktop.JalviewChangeSupport#addJalviewPropertyChangeListener(java.beans.PropertyChangeListener)
+   */
+  public void addJalviewPropertyChangeListener(
+          PropertyChangeListener listener)
+  {
+    changeSupport.addJalviewPropertyChangeListener(listener);
+  }
+
+  /**
+   * @param propertyName
+   * @param listener
+   * @see jalview.gui.Desktop.JalviewChangeSupport#addJalviewPropertyChangeListener(java.lang.String,
+   *      java.beans.PropertyChangeListener)
+   */
+  public void addJalviewPropertyChangeListener(String propertyName,
+          PropertyChangeListener listener)
+  {
+    changeSupport.addJalviewPropertyChangeListener(propertyName, listener);
+  }
+
+  /**
+   * @param propertyName
+   * @param listener
+   * @see jalview.gui.Desktop.JalviewChangeSupport#removeJalviewPropertyChangeListener(java.lang.String,
+   *      java.beans.PropertyChangeListener)
+   */
+  public void removeJalviewPropertyChangeListener(String propertyName,
+          PropertyChangeListener listener)
+  {
+    changeSupport.removeJalviewPropertyChangeListener(propertyName,
+            listener);
+  }
+
+  /** Singleton Desktop instance */
   public static Desktop instance;
 
-  // Need to decide if the Memory Usage is to be included in
-  // Next release or not.
   public static MyDesktopPane desktop;
 
-  // public static JDesktopPane desktop;
-
   static int openFrameCount = 0;
 
   static final int xOffset = 30;
 
   static final int yOffset = 30;
 
-  public static jalview.ws.Discoverer discoverer;
+  public static jalview.ws.jws1.Discoverer discoverer;
 
   public static Object[] jalviewClipboard;
 
@@ -72,6 +176,104 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
   static int fileLoadingCount = 0;
 
+  class MyDesktopManager implements DesktopManager
+  {
+
+    private DesktopManager delegate;
+
+    public MyDesktopManager(DesktopManager delegate)
+    {
+      this.delegate = delegate;
+    }
+
+    public void activateFrame(JInternalFrame f)
+    {
+      try
+      {
+        delegate.activateFrame(f);
+      } catch (NullPointerException npe)
+      {
+        Point p = getMousePosition();
+        instance.showPasteMenu(p.x, p.y);
+      }
+    }
+
+    public void beginDraggingFrame(JComponent f)
+    {
+      delegate.beginDraggingFrame(f);
+    }
+
+    public void beginResizingFrame(JComponent f, int direction)
+    {
+      delegate.beginResizingFrame(f, direction);
+    }
+
+    public void closeFrame(JInternalFrame f)
+    {
+      delegate.closeFrame(f);
+    }
+
+    public void deactivateFrame(JInternalFrame f)
+    {
+      delegate.deactivateFrame(f);
+    }
+
+    public void deiconifyFrame(JInternalFrame f)
+    {
+      delegate.deiconifyFrame(f);
+    }
+
+    public void dragFrame(JComponent f, int newX, int newY)
+    {
+      delegate.dragFrame(f, newX, newY);
+    }
+
+    public void endDraggingFrame(JComponent f)
+    {
+      delegate.endDraggingFrame(f);
+    }
+
+    public void endResizingFrame(JComponent f)
+    {
+      delegate.endResizingFrame(f);
+    }
+
+    public void iconifyFrame(JInternalFrame f)
+    {
+      delegate.iconifyFrame(f);
+    }
+
+    public void maximizeFrame(JInternalFrame f)
+    {
+      delegate.maximizeFrame(f);
+    }
+
+    public void minimizeFrame(JInternalFrame f)
+    {
+      delegate.minimizeFrame(f);
+    }
+
+    public void openFrame(JInternalFrame f)
+    {
+      delegate.openFrame(f);
+    }
+
+    public void resizeFrame(JComponent f, int newX, int newY, int newWidth,
+            int newHeight)
+    {
+      delegate.resizeFrame(f, newX, newY, newWidth, newHeight);
+    }
+
+    public void setBoundsForFrame(JComponent f, int newX, int newY,
+            int newWidth, int newHeight)
+    {
+      delegate.setBoundsForFrame(f, newX, newY, newWidth, newHeight);
+    }
+
+    // All other methods, simply delegate
+
+  }
+
   /**
    * Creates a new Desktop object.
    */
@@ -101,11 +303,11 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
     // This line prevents Windows Look&Feel resizing all new windows to maximum
     // if previous window was maximised
-    desktop.setDesktopManager(new DefaultDesktopManager());
-
+    desktop.setDesktopManager(new MyDesktopManager(
+            new DefaultDesktopManager()));
     Rectangle dims = getLastKnownDimensions("");
-    if (dims!=null)
-    {      
+    if (dims != null)
+    {
       setBounds(dims);
     }
     else
@@ -114,7 +316,17 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       setBounds((int) (screenSize.width - 900) / 2,
               (int) (screenSize.height - 650) / 2, 900, 650);
     }
-    jconsole = new Console(this);
+    jconsole = new Console(this, showjconsole);
+    // add essential build information
+    jconsole.setHeader("Jalview Desktop "
+            + jalview.bin.Cache.getProperty("VERSION") + "\n"
+            + "Build Date: "
+            + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown") + "\n"
+            + "Java version: " + System.getProperty("java.version") + "\n"
+            + System.getProperty("os.arch") + " "
+            + System.getProperty("os.name") + " "
+            + System.getProperty("os.version"));
+
     showConsole(showjconsole);
 
     this.addWindowListener(new WindowAdapter()
@@ -146,12 +358,27 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       }
     });
 
-    discoverer = new jalview.ws.Discoverer(); // Only gets started if gui is
     // displayed.
+    // Thread off a new instance of the file chooser - this reduces the time it
+    // takes to open it later on.
+    new Thread(new Runnable()
+    {
+      public void run()
+      {
+        Cache.log.debug("Filechooser init thread started.");
+        JalviewFileChooser chooser = new JalviewFileChooser(
+                jalview.bin.Cache.getProperty("LAST_DIRECTORY"),
+                jalview.io.AppletFormatAdapter.READABLE_EXTENSIONS,
+                jalview.io.AppletFormatAdapter.READABLE_FNAMES,
+                jalview.bin.Cache.getProperty("DEFAULT_FILE_FORMAT"));
+        Cache.log.debug("Filechooser init thread finished.");
+      }
+    }).start();
   }
 
   /**
    * recover the last known dimensions for a jalview window
+   * 
    * @param windowName
    *          - empty string is desktop, all other windows have unique prefix
    * @return null or last known dimensions scaled to current geometry (if last
@@ -159,6 +386,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    */
   Rectangle getLastKnownDimensions(String windowName)
   {
+    // TODO: lock aspect ratio for scaling desktop Bug #0058199
     Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
     String x = jalview.bin.Cache.getProperty(windowName + "SCREEN_X");
     String y = jalview.bin.Cache.getProperty(windowName + "SCREEN_Y");
@@ -175,21 +403,30 @@ public class Desktop extends jalview.jbgui.GDesktop implements
         // attempt #1 - try to cope with change in screen geometry - this
         // version doesn't preserve original jv aspect ratio.
         // take ratio of current screen size vs original screen size.
-        double sw = ( (1f*screenSize.width)
-                / (1f*Integer.parseInt(jalview.bin.Cache
-                        .getProperty("SCREENGEOMETRY_WIDTH"))))
-                        ;
-        double sh = ( (1f*screenSize.height)
-                / (1f*Integer.parseInt(jalview.bin.Cache
+        double sw = ((1f * screenSize.width) / (1f * Integer
+                .parseInt(jalview.bin.Cache
+                        .getProperty("SCREENGEOMETRY_WIDTH"))));
+        double sh = ((1f * screenSize.height) / (1f * Integer
+                .parseInt(jalview.bin.Cache
                         .getProperty("SCREENGEOMETRY_HEIGHT"))));
         // rescale the bounds depending upon the current screen geometry.
         ix = (int) (ix * sw);
         iw = (int) (iw * sw);
         iy = (int) (iy * sh);
         ih = (int) (ih * sh);
-        jalview.bin.Cache.log.debug("Got last known dimensions for "+windowName+": x:"+ix + " y:"+iy + " width:"+iw+" height:"+ih);
+        while (ix>=screenSize.width) {
+          jalview.bin.Cache.log.debug("Window geometry location recall error: shifting horizontal to within screenbounds.");
+          ix-=screenSize.width;
+        }
+        while (iy>=screenSize.height) {
+          jalview.bin.Cache.log.debug("Window geometry location recall error: shifting vertical to within screenbounds.");
+                    iy-=screenSize.height;
+        }
+        jalview.bin.Cache.log.debug("Got last known dimensions for "
+                + windowName + ": x:" + ix + " y:" + iy + " width:" + iw
+                + " height:" + ih);
       }
-      // return dimensions for new instance 
+      // return dimensions for new instance
       return new Rectangle(ix, iy, iw, ih);
     }
     return null;
@@ -275,7 +512,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
   }
 
   /**
-   * DOCUMENT ME!
+   * Adds and opens the given frame to the desktop
    * 
    * @param frame
    *          DOCUMENT ME!
@@ -311,6 +548,8 @@ public class Desktop extends jalview.jbgui.GDesktop implements
           boolean resizable)
   {
 
+    // TODO: allow callers to determine X and Y position of frame (eg. via
+    // bounds object).
     // TODO: consider fixing method to update entries in the window submenu with
     // the current window title
 
@@ -667,11 +906,12 @@ public class Desktop extends jalview.jbgui.GDesktop implements
             .setProperty("SCREENGEOMETRY_WIDTH", screen.width + "");
     jalview.bin.Cache.setProperty("SCREENGEOMETRY_HEIGHT", screen.height
             + "");
-    storeLastKnownDimensions("",new Rectangle(getBounds().x,getBounds().y, getWidth(), getHeight()));
+    storeLastKnownDimensions("", new Rectangle(getBounds().x,
+            getBounds().y, getWidth(), getHeight()));
 
     if (jconsole != null)
     {
-      storeLastKnownDimensions("JAVA_CONSOLE_",jconsole.getBounds());
+      storeLastKnownDimensions("JAVA_CONSOLE_", jconsole.getBounds());
       jconsole.stopConsole();
     }
     System.exit(0);
@@ -679,13 +919,14 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
   private void storeLastKnownDimensions(String string, Rectangle jc)
   {
-    jalview.bin.Cache.log.debug("Storing last known dimensions for "+string+": x:"+jc.x + " y:"+jc.y + " width:"+jc.width+" height:"+jc.height);
-    
-    jalview.bin.Cache.setProperty(string+"SCREEN_X",jc.x + "");
-    jalview.bin.Cache.setProperty(string+"SCREEN_Y", jc.y + "");
-    jalview.bin.Cache.setProperty(string+"SCREEN_WIDTH", jc.width + "");
-    jalview.bin.Cache.setProperty(string+"SCREEN_HEIGHT", jc.height
-            + "");
+    jalview.bin.Cache.log.debug("Storing last known dimensions for "
+            + string + ": x:" + jc.x + " y:" + jc.y + " width:" + jc.width
+            + " height:" + jc.height);
+
+    jalview.bin.Cache.setProperty(string + "SCREEN_X", jc.x + "");
+    jalview.bin.Cache.setProperty(string + "SCREEN_Y", jc.y + "");
+    jalview.bin.Cache.setProperty(string + "SCREEN_WIDTH", jc.width + "");
+    jalview.bin.Cache.setProperty(string + "SCREEN_HEIGHT", jc.height + "");
   }
 
   /**
@@ -944,13 +1185,23 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     if (value == JalviewFileChooser.APPROVE_OPTION)
     {
       java.io.File choice = chooser.getSelectedFile();
-      JProgressBar progpanel = addProgressPanel("Saving jalview project "
-              + choice.getName());
+      setProgressBar("Saving jalview project "
+              + choice.getName(), choice.hashCode());
       jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice.getParent());
       // TODO catch and handle errors for savestate
-      new Jalview2XML().SaveState(choice);
-      removeProgressPanel(progpanel);
-
+      try {
+        new Jalview2XML().SaveState(choice);
+      } catch (OutOfMemoryError oom)
+      {
+        new OOMWarning("Whilst saving current state to "+choice.getName(), oom);
+      }
+      catch (Exception ex)
+      {
+        Cache.log.error("Problems whilst trying to save to "+choice.getName(),ex);
+        JOptionPane.showMessageDialog(this, "Error whilst saving current state to "+choice.getName(), "Couldn't save project", JOptionPane.WARNING_MESSAGE);
+      }
+      setProgressBar(null, choice.hashCode());
+      
     }
   }
 
@@ -973,13 +1224,27 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
     if (value == JalviewFileChooser.APPROVE_OPTION)
     {
-      String choice = chooser.getSelectedFile().getAbsolutePath();
-      setProgressBar("loading jalview project "
-              + chooser.getSelectedFile().getName(), choice.hashCode());
+      final String choice = chooser.getSelectedFile().getAbsolutePath();
       jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
               .getSelectedFile().getParent());
-      new Jalview2XML().LoadJalviewAlign(choice);
+      new Thread(new Runnable() {
+        public void run() {
+          setProgressBar("loading jalview project "
+              + choice, choice.hashCode());
+          try {
+      new Jalview2XML().LoadJalviewAlign(choice); } 
+      catch (OutOfMemoryError oom)
+      {
+        new OOMWarning("Whilst loading project from "+choice, oom);
+      }
+      catch (Exception ex)
+      {
+        Cache.log.error("Problems whilst loading project from "+choice,ex);
+        JOptionPane.showMessageDialog(Desktop.desktop, "Error whilst loading project from "+choice, "Couldn't load project", JOptionPane.WARNING_MESSAGE);
+      }
       setProgressBar(null, choice.hashCode());
+        }
+      }).start();
     }
   }
 
@@ -1645,15 +1910,18 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
     public void paintComponent(Graphics g)
     {
-      if (showMemoryUsage && g != null)
+      if (showMemoryUsage && g != null && df != null)
       {
         if (percentUsage < 20)
           g.setColor(Color.red);
-
-        g.drawString("Total Free Memory: " + df.format(totalFreeMemory)
-                + "MB; Max Memory: " + df.format(maxMemory) + "MB; "
-                + df.format(percentUsage) + "%", 10, getHeight()
-                - g.getFontMetrics().getHeight());
+        FontMetrics fm = g.getFontMetrics();
+        if (fm != null)
+        {
+          g.drawString("Total Free Memory: " + df.format(totalFreeMemory)
+                  + "MB; Max Memory: " + df.format(maxMemory) + "MB; "
+                  + df.format(percentUsage) + "%", 10, getHeight()
+                  - fm.getHeight());
+        }
       }
     }
 
@@ -1852,4 +2120,127 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     return v_client;
 
   }
+  /**
+   * flag set if jalview GUI is being operated programmatically
+   */
+  private boolean inBatchMode=false;
+
+  /**
+   * check if jalview GUI is being operated programmatically
+   * @return inBatchMode
+   */
+  public boolean isInBatchMode()
+  {
+    return inBatchMode;
+  }
+
+  /**
+   * set flag if jalview GUI is being operated programmatically
+   * @param inBatchMode 
+   */
+  public void setInBatchMode(boolean inBatchMode)
+  {
+    this.inBatchMode = inBatchMode;
+  }
+
+
+  public void startServiceDiscovery()
+  {
+    startServiceDiscovery(false);
+  }
+
+  public void startServiceDiscovery(boolean blocking)
+  {
+    boolean alive = true;
+    Thread t0 = null, t1 = null, t2 = null;
+
+    // todo: changesupport handlers need to be transferred
+    if (discoverer == null)
+    {
+      discoverer = new jalview.ws.jws1.Discoverer();
+      // register PCS handler for desktop.
+      discoverer.addPropertyChangeListener(changeSupport);
+    }
+    if (Cache.getDefault("SHOW_JWS1_SERVICES", true))
+    {
+      (t0 = new Thread(discoverer)).start();
+    }
+
+    try
+    {
+      if (Cache.getDefault("SHOW_ENFIN_SERVICES", true))
+      {
+        // EnfinEnvision web service menu entries are rebuild every time the
+        // menu is shown, so no changeSupport events are needed.
+        jalview.ws.EnfinEnvision2OneWay.getInstance();
+        (t1 = new Thread(jalview.ws.EnfinEnvision2OneWay.getInstance()))
+                .start();
+      }
+    } catch (Exception e)
+    {
+      Cache.log
+              .info(
+                      "Exception when trying to launch Envision2 workflow discovery.",
+                      e);
+      Cache.log.info(e.getStackTrace());
+    }
+    if (Cache.getDefault("SHOW_JWS2_SERVICES", true))
+    {
+      jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
+              .addPropertyChangeListener(changeSupport);
+      (t2 = new Thread(jalview.ws.jws2.Jws2Discoverer.getDiscoverer()))
+              .start();
+    }
+    if (blocking)
+    {
+      while (alive)
+      {
+        try
+        {
+          Thread.sleep(15);
+        } catch (Exception e)
+        {
+        }
+        alive = (t1 != null && t1.isAlive())
+                || (t2 != null && t2.isAlive())
+                || (t0 != null && t0.isAlive());
+      }
+    }
+  }
+
+  /**
+   * start a thread to open a URL in the configured browser. Pops up a warning dialog to the user if there is an exception when calling out to the browser to open the URL.
+   * @param url
+   */
+  public static void showUrl(final String url)
+  {
+    new Thread(new Runnable() {
+      public void run() {
+        try {
+          jalview.util.BrowserLauncher.openURL(url);
+        } catch (Exception ex)
+        {    
+          JOptionPane
+                  .showInternalMessageDialog(
+                          Desktop.desktop,
+                          "Unixers: Couldn't find default web browser."
+                                  + "\nAdd the full path to your browser in Preferences.",
+                          "Web browser not found", JOptionPane.WARNING_MESSAGE);
+
+          ex.printStackTrace();
+        }
+      }
+    }).start();    
+  }
+
+  public static WsParamSetManager wsparamManager = null;
+  public static ParamManager getUserParameterStore()
+  {
+    if (wsparamManager==null)
+    {
+      wsparamManager = new WsParamSetManager();
+    }
+    return wsparamManager;
+  }
+
 }