JAL-1552 fix JAL-2122 resolve File->string before adding to List<String>.
[jalview.git] / src / jalview / gui / Desktop.java
index c957444..698b164 100644 (file)
@@ -23,6 +23,7 @@ package jalview.gui;
 import jalview.api.AlignViewportI;
 import jalview.api.AlignmentViewPanel;
 import jalview.bin.Cache;
+import jalview.bin.Jalview;
 import jalview.io.FileLoader;
 import jalview.io.FormatAdapter;
 import jalview.io.IdentifyFile;
@@ -46,6 +47,7 @@ import java.awt.GridLayout;
 import java.awt.Point;
 import java.awt.Rectangle;
 import java.awt.Toolkit;
+import java.awt.Window;
 import java.awt.datatransfer.Clipboard;
 import java.awt.datatransfer.ClipboardOwner;
 import java.awt.datatransfer.DataFlavor;
@@ -70,7 +72,6 @@ import java.beans.PropertyVetoException;
 import java.io.BufferedInputStream;
 import java.io.File;
 import java.io.FileOutputStream;
-import java.lang.reflect.Constructor;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.Hashtable;
@@ -188,6 +189,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       this.delegate = delegate;
     }
 
+    @Override
     public void activateFrame(JInternalFrame f)
     {
       try
@@ -200,31 +202,37 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       }
     }
 
+    @Override
     public void beginDraggingFrame(JComponent f)
     {
       delegate.beginDraggingFrame(f);
     }
 
+    @Override
     public void beginResizingFrame(JComponent f, int direction)
     {
       delegate.beginResizingFrame(f, direction);
     }
 
+    @Override
     public void closeFrame(JInternalFrame f)
     {
       delegate.closeFrame(f);
     }
 
+    @Override
     public void deactivateFrame(JInternalFrame f)
     {
       delegate.deactivateFrame(f);
     }
 
+    @Override
     public void deiconifyFrame(JInternalFrame f)
     {
       delegate.deiconifyFrame(f);
     }
 
+    @Override
     public void dragFrame(JComponent f, int newX, int newY)
     {
       if (newY < 0)
@@ -234,31 +242,37 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       delegate.dragFrame(f, newX, newY);
     }
 
+    @Override
     public void endDraggingFrame(JComponent f)
     {
       delegate.endDraggingFrame(f);
     }
 
+    @Override
     public void endResizingFrame(JComponent f)
     {
       delegate.endResizingFrame(f);
     }
 
+    @Override
     public void iconifyFrame(JInternalFrame f)
     {
       delegate.iconifyFrame(f);
     }
 
+    @Override
     public void maximizeFrame(JInternalFrame f)
     {
       delegate.maximizeFrame(f);
     }
 
+    @Override
     public void minimizeFrame(JInternalFrame f)
     {
       delegate.minimizeFrame(f);
     }
 
+    @Override
     public void openFrame(JInternalFrame f)
     {
       delegate.openFrame(f);
@@ -275,6 +289,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       delegate.resizeFrame(f, newX, newY, newWidth, newHeight);
     }
 
+    @Override
     public void setBoundsForFrame(JComponent f, int newX, int newY,
             int newWidth, int newHeight)
     {
@@ -297,7 +312,20 @@ public class Desktop extends jalview.jbgui.GDesktop implements
      */
     instance = this;
     doVamsasClientCheck();
-    doGroovyCheck();
+
+    groovyShell = new JMenuItem();
+    groovyShell.setText(MessageManager.getString("label.groovy_console"));
+    groovyShell.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        groovyShell_actionPerformed();
+      }
+    });
+    toolsMenu.add(groovyShell);
+    groovyShell.setVisible(true);
+
     doConfigureStructurePrefs();
     setTitle("Jalview " + jalview.bin.Cache.getProperty("VERSION"));
     setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
@@ -355,6 +383,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
     this.addWindowListener(new WindowAdapter()
     {
+      @Override
       public void windowClosing(WindowEvent evt)
       {
         quit();
@@ -364,9 +393,10 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     MouseAdapter ma;
     this.addMouseListener(ma = new MouseAdapter()
     {
+      @Override
       public void mousePressed(MouseEvent evt)
       {
-        if (SwingUtilities.isRightMouseButton(evt))
+        if (evt.isPopupTrigger())
         {
           showPasteMenu(evt.getX(), evt.getY());
         }
@@ -396,6 +426,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     // Spawn a thread that shows the splashscreen
     SwingUtilities.invokeLater(new Runnable()
     {
+      @Override
       public void run()
       {
         new SplashScreen();
@@ -407,6 +438,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     // takes to open it later on.
     new Thread(new Runnable()
     {
+      @Override
       public void run()
       {
         Cache.log.debug("Filechooser init thread started.");
@@ -578,16 +610,19 @@ public class Desktop extends jalview.jbgui.GDesktop implements
         // reselected again.
         boolean refresh = true;
 
+        @Override
         public void menuCanceled(MenuEvent e)
         {
           refresh = true;
         }
 
+        @Override
         public void menuDeselected(MenuEvent e)
         {
           refresh = true;
         }
 
+        @Override
         public void menuSelected(MenuEvent e)
         {
           if (refresh)
@@ -608,6 +643,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
             MessageManager.getString("label.paste_new_window"));
     item.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent evt)
       {
         paste();
@@ -630,7 +666,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
         String file = (String) contents
                 .getTransferData(DataFlavor.stringFlavor);
 
-        String format = new IdentifyFile().Identify(file,
+        String format = new IdentifyFile().identify(file,
                 FormatAdapter.PASTE);
 
         new FileLoader().LoadFile(file, FormatAdapter.PASTE, format);
@@ -771,6 +807,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     final JMenuItem menuItem = new JMenuItem(title);
     frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
     {
+      @Override
       public void internalFrameActivated(
               javax.swing.event.InternalFrameEvent evt)
       {
@@ -782,6 +819,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
       }
 
+      @Override
       public void internalFrameClosed(
               javax.swing.event.InternalFrameEvent evt)
       {
@@ -799,6 +837,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
     menuItem.addActionListener(new ActionListener()
     {
+      @Override
       public void actionPerformed(ActionEvent e)
       {
         try
@@ -871,6 +910,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     }
   }
 
+  @Override
   public void lostOwnership(Clipboard clipboard, Transferable contents)
   {
     if (!internalCopy)
@@ -881,14 +921,17 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     internalCopy = false;
   }
 
+  @Override
   public void dragEnter(DropTargetDragEvent evt)
   {
   }
 
+  @Override
   public void dragExit(DropTargetEvent evt)
   {
   }
 
+  @Override
   public void dragOver(DropTargetDragEvent evt)
   {
   }
@@ -904,57 +947,20 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    * @param evt
    *          DOCUMENT ME!
    */
+  @Override
   public void drop(DropTargetDropEvent evt)
   {
     boolean success = true;
     Transferable t = evt.getTransferable();
-    java.util.List files = null;
-    java.util.List protocols = null;
+    java.util.List<String> files = new ArrayList<String>();
+    java.util.List<String> protocols = new ArrayList<String>();
 
     try
     {
-      DataFlavor uriListFlavor = new DataFlavor(
-              "text/uri-list;class=java.lang.String");
-      if (t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
-      {
-        // Works on Windows and MacOSX
-        evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
-        files = (java.util.List) t
-                .getTransferData(DataFlavor.javaFileListFlavor);
-      }
-      else if (t.isDataFlavorSupported(uriListFlavor))
-      {
-        // This is used by Unix drag system
-        evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
-        String data = (String) t.getTransferData(uriListFlavor);
-        files = new java.util.ArrayList(1);
-        protocols = new java.util.ArrayList(1);
-        for (java.util.StringTokenizer st = new java.util.StringTokenizer(
-                data, "\r\n"); st.hasMoreTokens();)
-        {
-          String s = st.nextToken();
-          if (s.startsWith("#"))
-          {
-            // the line is a comment (as per the RFC 2483)
-            continue;
-          }
-          java.net.URI uri = new java.net.URI(s);
-          if (uri.getScheme().toLowerCase().startsWith("http"))
-          {
-            protocols.add(FormatAdapter.URL);
-            files.add(uri.toString());
-          }
-          else
-          {
-            // otherwise preserve old behaviour: catch all for file objects
-            java.io.File file = new java.io.File(uri);
-            protocols.add(FormatAdapter.FILE);
-            files.add(file.toString());
-          }
-        }
-      }
+      Desktop.transferFromDropTarget(files, protocols, evt, t);
     } catch (Exception e)
     {
+      e.printStackTrace();
       success = false;
     }
 
@@ -976,7 +982,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
           }
           else
           {
-            format = new IdentifyFile().Identify(file, protocol);
+            format = new IdentifyFile().identify(file, protocol);
           }
 
           new FileLoader().LoadFile(file, protocol, format);
@@ -1027,20 +1033,13 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       }
       else
       {
-        format = new IdentifyFile().Identify(choice, FormatAdapter.FILE);
+        format = new IdentifyFile().identify(choice, FormatAdapter.FILE);
       }
 
       if (viewport != null)
       {
         new FileLoader().LoadFile(viewport, choice, FormatAdapter.FILE,
                 format);
-        // viewport.setShowSequenceFeatures(JSONFile.isSeqFeaturesEnabled());
-        // AlignFrame af = viewport.getAlignPanel().alignFrame;
-        // if (af != null)
-        // {
-        // af.changeColour(JSONFile.getColourScheme());
-        // af.setMenusForViewport();
-        // }
       }
       else
       {
@@ -1110,7 +1109,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     }
     else
     {
-      String format = new IdentifyFile().Identify(url, FormatAdapter.URL);
+      String format = new IdentifyFile().identify(url, FormatAdapter.URL);
 
       if (format.equals("URL NOT FOUND"))
       {
@@ -1211,6 +1210,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     // message.toString(), "About Jalview", JOptionPane.INFORMATION_MESSAGE);
     new Thread(new Runnable()
     {
+      @Override
       public void run()
       {
         new SplashScreen(true);
@@ -1521,6 +1521,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
       new Thread(new Runnable()
       {
+        @Override
         public void run()
         {
           // TODO: refactor to Jalview desktop session controller action.
@@ -1592,6 +1593,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
               selectedFile.getParent());
       new Thread(new Runnable()
       {
+        @Override
         public void run()
         {
           setProgressBar(
@@ -2111,6 +2113,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
           sessit.addActionListener(new ActionListener()
           {
 
+            @Override
             public void actionPerformed(ActionEvent e)
             {
               if (dsktp.v_client == null)
@@ -2118,6 +2121,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
                 Thread rthr = new Thread(new Runnable()
                 {
 
+                  @Override
                   public void run()
                   {
                     dsktp.v_client = new VamsasApplication(dsktp, mysesid);
@@ -2290,6 +2294,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       return showMemoryUsage;
     }
 
+    @Override
     public void run()
     {
       df = java.text.NumberFormat.getNumberInstance();
@@ -2356,24 +2361,6 @@ public class Desktop extends jalview.jbgui.GDesktop implements
 
   protected JMenuItem groovyShell;
 
-  public void doGroovyCheck()
-  {
-    if (jalview.bin.Cache.groovyJarsPresent())
-    {
-      groovyShell = new JMenuItem();
-      groovyShell.setText(MessageManager.getString("label.groovy_console"));
-      groovyShell.addActionListener(new ActionListener()
-      {
-        public void actionPerformed(ActionEvent e)
-        {
-          groovyShell_actionPerformed();
-        }
-      });
-      toolsMenu.add(groovyShell);
-      groovyShell.setVisible(true);
-    }
-  }
-
   /**
    * Accessor method to quickly get all the AlignmentFrames loaded.
    * 
@@ -2381,6 +2368,12 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    */
   public static AlignFrame[] getAlignFrames()
   {
+    if (Jalview.isHeadlessMode())
+    {
+      // Desktop.desktop is null in headless mode
+      return new AlignFrame[] { currentAlignFrame };
+    }
+
     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
 
     if (frames == null)
@@ -2455,24 +2448,9 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    */
   public void groovyShell_actionPerformed()
   {
-    // use reflection to avoid creating compilation dependency.
-    if (!jalview.bin.Cache.groovyJarsPresent())
-    {
-      throw new Error(
-              MessageManager
-                      .getString("error.implementation_error_cannot_create_groovyshell"));
-    }
     try
     {
-      Class<?> gcClass = Desktop.class.getClassLoader().loadClass(
-              "groovy.ui.Console");
-      Constructor<?> gccons = gcClass.getConstructor();
-      java.lang.reflect.Method setvar = gcClass.getMethod("setVariable",
-              new Class[] { String.class, Object.class });
-      java.lang.reflect.Method run = gcClass.getMethod("run");
-      Object gc = gccons.newInstance();
-      setvar.invoke(gc, new Object[] { "Jalview", this });
-      run.invoke(gc);
+      openGroovyConsole();
     } catch (Exception ex)
     {
       jalview.bin.Cache.log.error("Groovy Shell Creation failed.", ex);
@@ -2485,6 +2463,65 @@ public class Desktop extends jalview.jbgui.GDesktop implements
   }
 
   /**
+   * Open the Groovy console
+   */
+  void openGroovyConsole()
+  {
+    groovyConsole = new groovy.ui.Console();
+
+    /*
+     * bind groovy variable 'Jalview' to the Desktop object
+     */
+    groovyConsole.setVariable("Jalview", this);
+
+    /*
+     * start the console
+     */
+    groovyConsole.run();
+
+    /*
+     * Allow only one console at a time, so that the AlignFrame menu option
+     * 'Calculate | Run Groovy script' is unambiguous.
+     * Disable 'new console', and enable 'Run script', when the console is 
+     * opened, and the reverse when it is closed
+     */
+    Window window = (Window) groovyConsole.getFrame();
+    window.addWindowListener(new WindowAdapter()
+    {
+      @Override
+      public void windowClosed(WindowEvent e)
+      {
+        groovyShell.setEnabled(true);
+        enableExecuteGroovy(false);
+      }
+    });
+
+    /*
+     * if we got this far, enable 'Run Groovy' in AlignFrame menus
+     * and disable opening a second console
+     */
+    groovyShell.setEnabled(false);
+    enableExecuteGroovy(true);
+  }
+
+  /**
+   * Enable or disable 'Run Groovy script' in AlignFrame calculate menus
+   * 
+   * @param enabled
+   */
+  public void enableExecuteGroovy(boolean enabled)
+  {
+    AlignFrame[] alignFrames = getAlignFrames();
+    if (alignFrames != null)
+    {
+      for (AlignFrame af : alignFrames)
+      {
+        af.setGroovyEnabled(enabled);
+      }
+    }
+  }
+
+  /**
    * Progress bars managed by the IProgressIndicator method.
    */
   private Hashtable<Long, JPanel> progressBars;
@@ -2496,6 +2533,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    * 
    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
    */
+  @Override
   public void setProgressBar(String message, long id)
   {
     if (progressBars == null)
@@ -2525,6 +2563,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    * @see jalview.gui.IProgressIndicator#registerHandler(long,
    * jalview.gui.IProgressIndicatorHandler)
    */
+  @Override
   public void registerHandler(final long id,
           final IProgressIndicatorHandler handler)
   {
@@ -2545,6 +2584,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
       cancel.addActionListener(new ActionListener()
       {
 
+        @Override
         public void actionPerformed(ActionEvent e)
         {
           handler.cancelActivity(id);
@@ -2703,6 +2743,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
             // only run if we aren't already displaying one of these.
             addDialogThread(serviceChangedDialog = new Runnable()
             {
+              @Override
               public void run()
               {
 
@@ -2786,6 +2827,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
   {
     new Thread(new Runnable()
     {
+      @Override
       public void run()
       {
         try
@@ -2875,6 +2917,8 @@ public class Desktop extends jalview.jbgui.GDesktop implements
    */
   private java.util.concurrent.Semaphore block = new Semaphore(0);
 
+  private static groovy.ui.Console groovyConsole;
+
   /**
    * add another dialog thread to the queue
    * 
@@ -2884,6 +2928,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
   {
     dialogExecutor.submit(new Runnable()
     {
+      @Override
       public void run()
       {
         if (dialogPause)
@@ -2927,7 +2972,7 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     ImageMaker im = new jalview.util.ImageMaker(this, ImageMaker.TYPE.EPS,
             "View of Desktop", getWidth(), getHeight(), of = new File(
                     "Jalview_snapshot" + System.currentTimeMillis()
-                            + ".eps"), "View of desktop");
+                            + ".eps"), "View of desktop", null, 0, false);
     try
     {
       paintAll(im.getGraphics());
@@ -3102,4 +3147,107 @@ public class Desktop extends jalview.jbgui.GDesktop implements
     Desktop.currentAlignFrame = currentAlignFrame;
   }
 
+  public static groovy.ui.Console getGroovyConsole()
+  {
+    return groovyConsole;
+  }
+
+  public static void transferFromDropTarget(List<String> files,
+          List<String> protocols, DropTargetDropEvent evt, Transferable t)
+          throws Exception
+  {
+
+    DataFlavor uriListFlavor = new DataFlavor(
+            "text/uri-list;class=java.lang.String");
+    if (t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
+    {
+      // Works on Windows and MacOSX
+      Cache.log.debug("Drop handled as javaFileListFlavor");
+      evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
+      for (Object file : (List) t
+              .getTransferData(DataFlavor.javaFileListFlavor))
+      {
+        files.add(((File)file).toString());
+        protocols.add(FormatAdapter.FILE);
+      }
+    }
+    else
+    {
+      // Unix like behaviour
+      boolean added = false;
+      String data = null;
+      if (t.isDataFlavorSupported(uriListFlavor))
+      {
+        Cache.log.debug("Drop handled as uriListFlavor");
+        // This is used by Unix drag system
+        evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
+        data = (String) t.getTransferData(uriListFlavor);
+      }
+      if (data == null)
+      {
+        // fallback to text: workaround - on OSX where there's a JVM bug
+        Cache.log.debug("standard URIListFlavor failed. Trying text");
+        // try text fallback
+        data = (String) t.getTransferData(new DataFlavor(
+                "text/plain;class=java.lang.String"));
+        if (Cache.log.isDebugEnabled())
+        {
+          Cache.log.debug("fallback returned " + data);
+        }
+      }
+      while (protocols.size() < files.size())
+      {
+        Cache.log.debug("Adding missing FILE protocol for "
+                + files.get(protocols.size()));
+        protocols.add(FormatAdapter.FILE);
+      }
+      for (java.util.StringTokenizer st = new java.util.StringTokenizer(
+              data, "\r\n"); st.hasMoreTokens();)
+      {
+        added = true;
+        String s = st.nextToken();
+        if (s.startsWith("#"))
+        {
+          // the line is a comment (as per the RFC 2483)
+          continue;
+        }
+        java.net.URI uri = new java.net.URI(s);
+        if (uri.getScheme().toLowerCase().startsWith("http"))
+        {
+          protocols.add(FormatAdapter.URL);
+          files.add(uri.toString());
+        }
+        else
+        {
+          // otherwise preserve old behaviour: catch all for file objects
+          java.io.File file = new java.io.File(uri);
+          protocols.add(FormatAdapter.FILE);
+          files.add(file.toString());
+        }
+      }
+      if (Cache.log.isDebugEnabled())
+      {
+        if (data == null || !added)
+        {
+          Cache.log
+                  .debug("Couldn't resolve drop data. Here are the supported flavors:");
+          for (DataFlavor fl : t.getTransferDataFlavors())
+          {
+            Cache.log.debug("Supported transfer dataflavor: "
+                    + fl.toString());
+            evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
+            Object df = t.getTransferData(fl);
+            if (df != null)
+            {
+              Cache.log.debug("Retrieves: " + df);
+            }
+            else
+            {
+              Cache.log.debug("Retrieved nothing");
+            }
+          }
+        }
+      }
+    }
+  }
 }