src/jalview/gui/Desktop.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import static jalview.util.UrlConstants.SEQUENCE_ID;
  24
  25 import jalview.api.AlignViewportI;
  26 import jalview.api.AlignmentViewPanel;
  27 import jalview.bin.Cache;
  28 import jalview.bin.Jalview;
  29 import jalview.io.BackupFiles;
  30 import jalview.io.DataSourceType;
  31 import jalview.io.FileFormat;
  32 import jalview.io.FileFormatException;
  33 import jalview.io.FileFormatI;
  34 import jalview.io.FileFormats;
  35 import jalview.io.FileLoader;
  36 import jalview.io.FormatAdapter;
  37 import jalview.io.IdentifyFile;
  38 import jalview.io.JalviewFileChooser;
  39 import jalview.io.JalviewFileView;
  40 import jalview.jbgui.GSplitFrame;
  41 import jalview.jbgui.GStructureViewer;
  42 import jalview.project.Jalview2XML;
  43 import jalview.structure.StructureSelectionManager;
  44 import jalview.urls.IdOrgSettings;
  45 import jalview.util.ImageMaker;
  46 import jalview.util.MessageManager;
  47 import jalview.util.Platform;
  48 import jalview.util.UrlConstants;
  49 import jalview.viewmodel.AlignmentViewport;
  50 import jalview.ws.params.ParamManager;
  51 import jalview.ws.utils.UrlDownloadClient;
  52
  53 import java.awt.BorderLayout;
  54 import java.awt.Color;
  55 import java.awt.Dimension;
  56 import java.awt.FontMetrics;
  57 import java.awt.Graphics;
  58 import java.awt.GridLayout;
  59 import java.awt.Point;
  60 import java.awt.Rectangle;
  61 import java.awt.Toolkit;
  62 import java.awt.Window;
  63 import java.awt.datatransfer.Clipboard;
  64 import java.awt.datatransfer.ClipboardOwner;
  65 import java.awt.datatransfer.DataFlavor;
  66 import java.awt.datatransfer.Transferable;
  67 import java.awt.dnd.DnDConstants;
  68 import java.awt.dnd.DropTargetDragEvent;
  69 import java.awt.dnd.DropTargetDropEvent;
  70 import java.awt.dnd.DropTargetEvent;
  71 import java.awt.dnd.DropTargetListener;
  72 import java.awt.event.ActionEvent;
  73 import java.awt.event.ActionListener;
  74 import java.awt.event.InputEvent;
  75 import java.awt.event.KeyEvent;
  76 import java.awt.event.MouseAdapter;
  77 import java.awt.event.MouseEvent;
  78 import java.awt.event.WindowAdapter;
  79 import java.awt.event.WindowEvent;
  80 import java.beans.PropertyChangeEvent;
  81 import java.beans.PropertyChangeListener;
  82 import java.io.BufferedInputStream;
  83 import java.io.File;
  84 import java.io.FileOutputStream;
  85 import java.io.IOException;
  86 import java.net.URL;
  87 import java.util.ArrayList;
  88 import java.util.Hashtable;
  89 import java.util.List;
  90 import java.util.ListIterator;
  91 import java.util.StringTokenizer;
  92 import java.util.Vector;
  93 import java.util.concurrent.ExecutorService;
  94 import java.util.concurrent.Executors;
  95 import java.util.concurrent.Semaphore;
  96
  97 import javax.swing.AbstractAction;
  98 import javax.swing.Action;
  99 import javax.swing.ActionMap;
 100 import javax.swing.Box;
 101 import javax.swing.BoxLayout;
 102 import javax.swing.DefaultDesktopManager;
 103 import javax.swing.DesktopManager;
 104 import javax.swing.InputMap;
 105 import javax.swing.JButton;
 106 import javax.swing.JCheckBox;
 107 import javax.swing.JComboBox;
 108 import javax.swing.JComponent;
 109 import javax.swing.JDesktopPane;
 110 import javax.swing.JFrame;
 111 import javax.swing.JInternalFrame;
 112 import javax.swing.JLabel;
 113 import javax.swing.JMenuItem;
 114 import javax.swing.JPanel;
 115 import javax.swing.JPopupMenu;
 116 import javax.swing.JProgressBar;
 117 import javax.swing.KeyStroke;
 118 import javax.swing.SwingUtilities;
 119 import javax.swing.event.HyperlinkEvent;
 120 import javax.swing.event.HyperlinkEvent.EventType;
 121 import javax.swing.event.InternalFrameAdapter;
 122 import javax.swing.event.InternalFrameEvent;
 123 import javax.swing.event.MenuEvent;
 124 import javax.swing.event.MenuListener;
 125
 126 import org.stackoverflowusers.file.WindowsShortcut;
 127
 128 /**
 129  * Jalview Desktop
 130  *
 131  *
 132  * @author $author$
 133  * @version $Revision: 1.155 $
 134  */
 135 public class Desktop extends jalview.jbgui.GDesktop
 136         implements DropTargetListener, ClipboardOwner, IProgressIndicator,
 137         jalview.api.StructureSelectionManagerProvider
 138 {
 139   private static int DEFAULT_MIN_WIDTH = 300;
 140
 141   private static int DEFAULT_MIN_HEIGHT = 250;
 142
 143   private static int ALIGN_FRAME_DEFAULT_MIN_WIDTH = 600;
 144
 145   private static int ALIGN_FRAME_DEFAULT_MIN_HEIGHT = 70;
 146
 147   private static final String EXPERIMENTAL_FEATURES = "EXPERIMENTAL_FEATURES";
 148
 149   private JalviewChangeSupport changeSupport = new JalviewChangeSupport();
 150
 151   /**
 152    * news reader - null if it was never started.
 153    */
 154   private BlogReader jvnews = null;
 155
 156   private File projectFile;
 157
 158   /**
 159    * @param listener
 160    * @see jalview.gui.JalviewChangeSupport#addJalviewPropertyChangeListener(java.beans.PropertyChangeListener)
 161    */
 162   public void addJalviewPropertyChangeListener(
 163           PropertyChangeListener listener)
 164   {
 165     changeSupport.addJalviewPropertyChangeListener(listener);
 166   }
 167
 168   /**
 169    * @param propertyName
 170    * @param listener
 171    * @see jalview.gui.JalviewChangeSupport#addJalviewPropertyChangeListener(java.lang.String,
 172    *      java.beans.PropertyChangeListener)
 173    */
 174   public void addJalviewPropertyChangeListener(String propertyName,
 175           PropertyChangeListener listener)
 176   {
 177     changeSupport.addJalviewPropertyChangeListener(propertyName, listener);
 178   }
 179
 180   /**
 181    * @param propertyName
 182    * @param listener
 183    * @see jalview.gui.JalviewChangeSupport#removeJalviewPropertyChangeListener(java.lang.String,
 184    *      java.beans.PropertyChangeListener)
 185    */
 186   public void removeJalviewPropertyChangeListener(String propertyName,
 187           PropertyChangeListener listener)
 188   {
 189     changeSupport.removeJalviewPropertyChangeListener(propertyName,
 190             listener);
 191   }
 192
 193   /** Singleton Desktop instance */
 194   public static Desktop instance;
 195
 196   public static MyDesktopPane desktop;
 197
 198   static int openFrameCount = 0;
 199
 200   static final int xOffset = 30;
 201
 202   static final int yOffset = 30;
 203
 204   public static jalview.ws.jws1.Discoverer discoverer;
 205
 206   public static Object[] jalviewClipboard;
 207
 208   public static boolean internalCopy = false;
 209
 210   static int fileLoadingCount = 0;
 211
 212   class MyDesktopManager implements DesktopManager
 213   {
 214
 215     private DesktopManager delegate;
 216
 217     public MyDesktopManager(DesktopManager delegate)
 218     {
 219       this.delegate = delegate;
 220     }
 221
 222     @Override
 223     public void activateFrame(JInternalFrame f)
 224     {
 225       try
 226       {
 227         delegate.activateFrame(f);
 228       } catch (NullPointerException npe)
 229       {
 230         Point p = getMousePosition();
 231         instance.showPasteMenu(p.x, p.y);
 232       }
 233     }
 234
 235     @Override
 236     public void beginDraggingFrame(JComponent f)
 237     {
 238       delegate.beginDraggingFrame(f);
 239     }
 240
 241     @Override
 242     public void beginResizingFrame(JComponent f, int direction)
 243     {
 244       delegate.beginResizingFrame(f, direction);
 245     }
 246
 247     @Override
 248     public void closeFrame(JInternalFrame f)
 249     {
 250       delegate.closeFrame(f);
 251     }
 252
 253     @Override
 254     public void deactivateFrame(JInternalFrame f)
 255     {
 256       delegate.deactivateFrame(f);
 257     }
 258
 259     @Override
 260     public void deiconifyFrame(JInternalFrame f)
 261     {
 262       delegate.deiconifyFrame(f);
 263     }
 264
 265     @Override
 266     public void dragFrame(JComponent f, int newX, int newY)
 267     {
 268       if (newY < 0)
 269       {
 270         newY = 0;
 271       }
 272       delegate.dragFrame(f, newX, newY);
 273     }
 274
 275     @Override
 276     public void endDraggingFrame(JComponent f)
 277     {
 278       delegate.endDraggingFrame(f);
 279       desktop.repaint();
 280     }
 281
 282     @Override
 283     public void endResizingFrame(JComponent f)
 284     {
 285       delegate.endResizingFrame(f);
 286       desktop.repaint();
 287     }
 288
 289     @Override
 290     public void iconifyFrame(JInternalFrame f)
 291     {
 292       delegate.iconifyFrame(f);
 293     }
 294
 295     @Override
 296     public void maximizeFrame(JInternalFrame f)
 297     {
 298       delegate.maximizeFrame(f);
 299     }
 300
 301     @Override
 302     public void minimizeFrame(JInternalFrame f)
 303     {
 304       delegate.minimizeFrame(f);
 305     }
 306
 307     @Override
 308     public void openFrame(JInternalFrame f)
 309     {
 310       delegate.openFrame(f);
 311     }
 312
 313     @Override
 314     public void resizeFrame(JComponent f, int newX, int newY, int newWidth,
 315             int newHeight)
 316     {
 317       if (newY < 0)
 318       {
 319         newY = 0;
 320       }
 321       delegate.resizeFrame(f, newX, newY, newWidth, newHeight);
 322     }
 323
 324     @Override
 325     public void setBoundsForFrame(JComponent f, int newX, int newY,
 326             int newWidth, int newHeight)
 327     {
 328       delegate.setBoundsForFrame(f, newX, newY, newWidth, newHeight);
 329     }
 330
 331     // All other methods, simply delegate
 332
 333   }
 334
 335   /**
 336    * Creates a new Desktop object.
 337    */
 338   public Desktop()
 339   {
 340     /**
 341      * A note to implementors. It is ESSENTIAL that any activities that might
 342      * block are spawned off as threads rather than waited for during this
 343      * constructor.
 344      */
 345     instance = this;
 346     doVamsasClientCheck();
 347
 348     doConfigureStructurePrefs();
 349     setTitle("Jalview " + jalview.bin.Cache.getProperty("VERSION"));
 350     setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
 351     boolean selmemusage = jalview.bin.Cache.getDefault("SHOW_MEMUSAGE",
 352             false);
 353     boolean showjconsole = jalview.bin.Cache.getDefault("SHOW_JAVA_CONSOLE",
 354             false);
 355     desktop = new MyDesktopPane(selmemusage);
 356     showMemusage.setSelected(selmemusage);
 357     desktop.setBackground(Color.white);
 358     getContentPane().setLayout(new BorderLayout());
 359     // alternate config - have scrollbars - see notes in JAL-153
 360     // JScrollPane sp = new JScrollPane();
 361     // sp.getViewport().setView(desktop);
 362     // getContentPane().add(sp, BorderLayout.CENTER);
 363     getContentPane().add(desktop, BorderLayout.CENTER);
 364     desktop.setDragMode(JDesktopPane.OUTLINE_DRAG_MODE);
 365
 366     // This line prevents Windows Look&Feel resizing all new windows to maximum
 367     // if previous window was maximised
 368     desktop.setDesktopManager(new MyDesktopManager(
 369             (Platform.isWindows() ? new DefaultDesktopManager()
 370                     : Platform.isAMac()
 371                             ? new AquaInternalFrameManager(
 372                                     desktop.getDesktopManager())
 373                             : desktop.getDesktopManager())));
 374
 375     Rectangle dims = getLastKnownDimensions("");
 376     if (dims != null)
 377     {
 378       setBounds(dims);
 379     }
 380     else
 381     {
 382       Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
 383       setBounds((screenSize.width - 900) / 2, (screenSize.height - 650) / 2,
 384               900, 650);
 385     }
 386     jconsole = new Console(this, showjconsole);
 387     // add essential build information
 388     jconsole.setHeader(
 389             "Jalview Version: " + jalview.bin.Cache.getProperty("VERSION")
 390                     + "\n" + "Jalview Installation: "
 391                     + jalview.bin.Cache.getDefault("INSTALLATION",
 392                             "unknown")
 393                     + "\n" + "Build Date: "
 394                     + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown")
 395                     + "\n" + "Java version: "
 396                     + System.getProperty("java.version") + "\n"
 397                     + System.getProperty("os.arch") + " "
 398                     + System.getProperty("os.name") + " "
 399                     + System.getProperty("os.version"));
 400
 401     showConsole(showjconsole);
 402
 403     showNews.setVisible(false);
 404
 405     experimentalFeatures.setSelected(showExperimental());
 406
 407     getIdentifiersOrgData();
 408
 409     checkURLLinks();
 410
 411     this.addWindowListener(new WindowAdapter()
 412     {
 413       @Override
 414       public void windowClosing(WindowEvent evt)
 415       {
 416         quit();
 417       }
 418     });
 419
 420     MouseAdapter ma;
 421     this.addMouseListener(ma = new MouseAdapter()
 422     {
 423       @Override
 424       public void mousePressed(MouseEvent evt)
 425       {
 426         if (evt.isPopupTrigger()) // Mac
 427         {
 428           showPasteMenu(evt.getX(), evt.getY());
 429         }
 430       }
 431
 432       @Override
 433       public void mouseReleased(MouseEvent evt)
 434       {
 435         if (evt.isPopupTrigger()) // Windows
 436         {
 437           showPasteMenu(evt.getX(), evt.getY());
 438         }
 439       }
 440     });
 441     desktop.addMouseListener(ma);
 442
 443     this.setDropTarget(new java.awt.dnd.DropTarget(desktop, this));
 444     // Spawn a thread that shows the splashscreen
 445     SwingUtilities.invokeLater(new Runnable()
 446     {
 447       @Override
 448       public void run()
 449       {
 450         new SplashScreen();
 451       }
 452     });
 453
 454     // Thread off a new instance of the file chooser - this reduces the time it
 455     // takes to open it later on.
 456     new Thread(new Runnable()
 457     {
 458       @Override
 459       public void run()
 460       {
 461         Cache.log.debug("Filechooser init thread started.");
 462         String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
 463         JalviewFileChooser.forRead(Cache.getProperty("LAST_DIRECTORY"),
 464                 fileFormat);
 465         Cache.log.debug("Filechooser init thread finished.");
 466       }
 467     }).start();
 468     // Add the service change listener
 469     changeSupport.addJalviewPropertyChangeListener("services",
 470             new PropertyChangeListener()
 471             {
 472
 473               @Override
 474               public void propertyChange(PropertyChangeEvent evt)
 475               {
 476                 Cache.log.debug("Firing service changed event for "
 477                         + evt.getNewValue());
 478                 JalviewServicesChanged(evt);
 479               }
 480
 481             });
 482   }
 483
 484   /**
 485    * Answers true if user preferences to enable experimental features is True
 486    * (on), else false
 487    *
 488    * @return
 489    */
 490   public boolean showExperimental()
 491   {
 492     String experimental = Cache.getDefault(EXPERIMENTAL_FEATURES,
 493             Boolean.FALSE.toString());
 494     return Boolean.valueOf(experimental).booleanValue();
 495   }
 496
 497   public void doConfigureStructurePrefs()
 498   {
 499     // configure services
 500     StructureSelectionManager ssm = StructureSelectionManager
 501             .getStructureSelectionManager(this);
 502     if (jalview.bin.Cache.getDefault(Preferences.ADD_SS_ANN, true))
 503     {
 504       ssm.setAddTempFacAnnot(jalview.bin.Cache
 505               .getDefault(Preferences.ADD_TEMPFACT_ANN, true));
 506       ssm.setProcessSecondaryStructure(jalview.bin.Cache
 507               .getDefault(Preferences.STRUCT_FROM_PDB, true));
 508       ssm.setSecStructServices(
 509               jalview.bin.Cache.getDefault(Preferences.USE_RNAVIEW, true));
 510     }
 511     else
 512     {
 513       ssm.setAddTempFacAnnot(false);
 514       ssm.setProcessSecondaryStructure(false);
 515       ssm.setSecStructServices(false);
 516     }
 517   }
 518
 519   public void checkForNews()
 520   {
 521     final Desktop me = this;
 522     // Thread off the news reader, in case there are connection problems.
 523     new Thread(new Runnable()
 524     {
 525       @Override
 526       public void run()
 527       {
 528         Cache.log.debug("Starting news thread.");
 529
 530         jvnews = new BlogReader(me);
 531         showNews.setVisible(true);
 532         Cache.log.debug("Completed news thread.");
 533       }
 534     }).start();
 535   }
 536
 537   public void getIdentifiersOrgData()
 538   {
 539     // Thread off the identifiers fetcher
 540     new Thread(new Runnable()
 541     {
 542       @Override
 543       public void run()
 544       {
 545         Cache.log.debug("Downloading data from identifiers.org");
 546         UrlDownloadClient client = new UrlDownloadClient();
 547         try
 548         {
 549           client.download(IdOrgSettings.getUrl(),
 550                   IdOrgSettings.getDownloadLocation());
 551         } catch (IOException e)
 552         {
 553           Cache.log.debug("Exception downloading identifiers.org data"
 554                   + e.getMessage());
 555         }
 556       }
 557     }).start();
 558     ;
 559   }
 560
 561   @Override
 562   protected void showNews_actionPerformed(ActionEvent e)
 563   {
 564     showNews(showNews.isSelected());
 565   }
 566
 567   void showNews(boolean visible)
 568   {
 569     {
 570       Cache.log.debug((visible ? "Showing" : "Hiding") + " news.");
 571       showNews.setSelected(visible);
 572       if (visible && !jvnews.isVisible())
 573       {
 574         new Thread(new Runnable()
 575         {
 576           @Override
 577           public void run()
 578           {
 579             long now = System.currentTimeMillis();
 580             Desktop.instance.setProgressBar(
 581                     MessageManager.getString("status.refreshing_news"),
 582                     now);
 583             jvnews.refreshNews();
 584             Desktop.instance.setProgressBar(null, now);
 585             jvnews.showNews();
 586           }
 587         }).start();
 588       }
 589     }
 590   }
 591
 592   /**
 593    * recover the last known dimensions for a jalview window
 594    *
 595    * @param windowName
 596    *          - empty string is desktop, all other windows have unique prefix
 597    * @return null or last known dimensions scaled to current geometry (if last
 598    *         window geom was known)
 599    */
 600   Rectangle getLastKnownDimensions(String windowName)
 601   {
 602     // TODO: lock aspect ratio for scaling desktop Bug #0058199
 603     Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
 604     String x = jalview.bin.Cache.getProperty(windowName + "SCREEN_X");
 605     String y = jalview.bin.Cache.getProperty(windowName + "SCREEN_Y");
 606     String width = jalview.bin.Cache
 607             .getProperty(windowName + "SCREEN_WIDTH");
 608     String height = jalview.bin.Cache
 609             .getProperty(windowName + "SCREEN_HEIGHT");
 610     if ((x != null) && (y != null) && (width != null) && (height != null))
 611     {
 612       int ix = Integer.parseInt(x), iy = Integer.parseInt(y),
 613               iw = Integer.parseInt(width), ih = Integer.parseInt(height);
 614       if (jalview.bin.Cache.getProperty("SCREENGEOMETRY_WIDTH") != null)
 615       {
 616         // attempt #1 - try to cope with change in screen geometry - this
 617         // version doesn't preserve original jv aspect ratio.
 618         // take ratio of current screen size vs original screen size.
 619         double sw = ((1f * screenSize.width) / (1f * Integer.parseInt(
 620                 jalview.bin.Cache.getProperty("SCREENGEOMETRY_WIDTH"))));
 621         double sh = ((1f * screenSize.height) / (1f * Integer.parseInt(
 622                 jalview.bin.Cache.getProperty("SCREENGEOMETRY_HEIGHT"))));
 623         // rescale the bounds depending upon the current screen geometry.
 624         ix = (int) (ix * sw);
 625         iw = (int) (iw * sw);
 626         iy = (int) (iy * sh);
 627         ih = (int) (ih * sh);
 628         while (ix >= screenSize.width)
 629         {
 630           jalview.bin.Cache.log.debug(
 631                   "Window geometry location recall error: shifting horizontal to within screenbounds.");
 632           ix -= screenSize.width;
 633         }
 634         while (iy >= screenSize.height)
 635         {
 636           jalview.bin.Cache.log.debug(
 637                   "Window geometry location recall error: shifting vertical to within screenbounds.");
 638           iy -= screenSize.height;
 639         }
 640         jalview.bin.Cache.log.debug(
 641                 "Got last known dimensions for " + windowName + ": x:" + ix
 642                         + " y:" + iy + " width:" + iw + " height:" + ih);
 643       }
 644       // return dimensions for new instance
 645       return new Rectangle(ix, iy, iw, ih);
 646     }
 647     return null;
 648   }
 649
 650   private void doVamsasClientCheck()
 651   {
 652     if (jalview.bin.Cache.vamsasJarsPresent())
 653     {
 654       setupVamsasDisconnectedGui();
 655       VamsasMenu.setVisible(true);
 656       final Desktop us = this;
 657       VamsasMenu.addMenuListener(new MenuListener()
 658       {
 659         // this listener remembers when the menu was first selected, and
 660         // doesn't rebuild the session list until it has been cleared and
 661         // reselected again.
 662         boolean refresh = true;
 663
 664         @Override
 665         public void menuCanceled(MenuEvent e)
 666         {
 667           refresh = true;
 668         }
 669
 670         @Override
 671         public void menuDeselected(MenuEvent e)
 672         {
 673           refresh = true;
 674         }
 675
 676         @Override
 677         public void menuSelected(MenuEvent e)
 678         {
 679           if (refresh)
 680           {
 681             us.buildVamsasStMenu();
 682             refresh = false;
 683           }
 684         }
 685       });
 686       vamsasStart.setVisible(true);
 687     }
 688   }
 689
 690   void showPasteMenu(int x, int y)
 691   {
 692     JPopupMenu popup = new JPopupMenu();
 693     JMenuItem item = new JMenuItem(
 694             MessageManager.getString("label.paste_new_window"));
 695     item.addActionListener(new ActionListener()
 696     {
 697       @Override
 698       public void actionPerformed(ActionEvent evt)
 699       {
 700         paste();
 701       }
 702     });
 703
 704     popup.add(item);
 705     popup.show(this, x, y);
 706   }
 707
 708   public void paste()
 709   {
 710     try
 711     {
 712       Clipboard c = Toolkit.getDefaultToolkit().getSystemClipboard();
 713       Transferable contents = c.getContents(this);
 714
 715       if (contents != null)
 716       {
 717         String file = (String) contents
 718                 .getTransferData(DataFlavor.stringFlavor);
 719
 720         FileFormatI format = new IdentifyFile().identify(file,
 721                 DataSourceType.PASTE);
 722
 723         new FileLoader().LoadFile(file, DataSourceType.PASTE, format);
 724
 725       }
 726     } catch (Exception ex)
 727     {
 728       System.out.println(
 729               "Unable to paste alignment from system clipboard:\n" + ex);
 730     }
 731   }
 732
 733   /**
 734    * Adds and opens the given frame to the desktop
 735    *
 736    * @param frame
 737    *          Frame to show
 738    * @param title
 739    *          Visible Title
 740    * @param w
 741    *          width
 742    * @param h
 743    *          height
 744    */
 745   public static synchronized void addInternalFrame(
 746           final JInternalFrame frame, String title, int w, int h)
 747   {
 748     addInternalFrame(frame, title, true, w, h, true, false);
 749   }
 750
 751   /**
 752    * Add an internal frame to the Jalview desktop
 753    *
 754    * @param frame
 755    *          Frame to show
 756    * @param title
 757    *          Visible Title
 758    * @param makeVisible
 759    *          When true, display frame immediately, otherwise, caller must call
 760    *          setVisible themselves.
 761    * @param w
 762    *          width
 763    * @param h
 764    *          height
 765    */
 766   public static synchronized void addInternalFrame(
 767           final JInternalFrame frame, String title, boolean makeVisible,
 768           int w, int h)
 769   {
 770     addInternalFrame(frame, title, makeVisible, w, h, true, false);
 771   }
 772
 773   /**
 774    * Add an internal frame to the Jalview desktop and make it visible
 775    *
 776    * @param frame
 777    *          Frame to show
 778    * @param title
 779    *          Visible Title
 780    * @param w
 781    *          width
 782    * @param h
 783    *          height
 784    * @param resizable
 785    *          Allow resize
 786    */
 787   public static synchronized void addInternalFrame(
 788           final JInternalFrame frame, String title, int w, int h,
 789           boolean resizable)
 790   {
 791     addInternalFrame(frame, title, true, w, h, resizable, false);
 792   }
 793
 794   /**
 795    * Add an internal frame to the Jalview desktop
 796    *
 797    * @param frame
 798    *          Frame to show
 799    * @param title
 800    *          Visible Title
 801    * @param makeVisible
 802    *          When true, display frame immediately, otherwise, caller must call
 803    *          setVisible themselves.
 804    * @param w
 805    *          width
 806    * @param h
 807    *          height
 808    * @param resizable
 809    *          Allow resize
 810    * @param ignoreMinSize
 811    *          Do not set the default minimum size for frame
 812    */
 813   public static synchronized void addInternalFrame(
 814           final JInternalFrame frame, String title, boolean makeVisible,
 815           int w, int h, boolean resizable, boolean ignoreMinSize)
 816   {
 817
 818     // TODO: allow callers to determine X and Y position of frame (eg. via
 819     // bounds object).
 820     // TODO: consider fixing method to update entries in the window submenu with
 821     // the current window title
 822
 823     frame.setTitle(title);
 824     if (frame.getWidth() < 1 || frame.getHeight() < 1)
 825     {
 826       frame.setSize(w, h);
 827     }
 828     // THIS IS A PUBLIC STATIC METHOD, SO IT MAY BE CALLED EVEN IN
 829     // A HEADLESS STATE WHEN NO DESKTOP EXISTS. MUST RETURN
 830     // IF JALVIEW IS RUNNING HEADLESS
 831     // ///////////////////////////////////////////////
 832     if (instance == null || (System.getProperty("java.awt.headless") != null
 833             && System.getProperty("java.awt.headless").equals("true")))
 834     {
 835       return;
 836     }
 837
 838     openFrameCount++;
 839
 840     if (!ignoreMinSize)
 841     {
 842       frame.setMinimumSize(
 843               new Dimension(DEFAULT_MIN_WIDTH, DEFAULT_MIN_HEIGHT));
 844
 845       // Set default dimension for Alignment Frame window.
 846       // The Alignment Frame window could be added from a number of places,
 847       // hence,
 848       // I did this here in order not to miss out on any Alignment frame.
 849       if (frame instanceof AlignFrame)
 850       {
 851         frame.setMinimumSize(new Dimension(ALIGN_FRAME_DEFAULT_MIN_WIDTH,
 852                 ALIGN_FRAME_DEFAULT_MIN_HEIGHT));
 853       }
 854     }
 855
 856     frame.setVisible(makeVisible);
 857     frame.setClosable(true);
 858     frame.setResizable(resizable);
 859     frame.setMaximizable(resizable);
 860     frame.setIconifiable(resizable);
 861     frame.setOpaque(false);
 862
 863     if (frame.getX() < 1 && frame.getY() < 1)
 864     {
 865       frame.setLocation(xOffset * openFrameCount,
 866               yOffset * ((openFrameCount - 1) % 10) + yOffset);
 867     }
 868
 869     /*
 870      * add an entry for the new frame in the Window menu
 871      * (and remove it when the frame is closed)
 872      */
 873     final JMenuItem menuItem = new JMenuItem(title);
 874     frame.addInternalFrameListener(new InternalFrameAdapter()
 875     {
 876       @Override
 877       public void internalFrameActivated(InternalFrameEvent evt)
 878       {
 879         JInternalFrame itf = desktop.getSelectedFrame();
 880         if (itf != null)
 881         {
 882           if (itf instanceof AlignFrame)
 883           {
 884             Jalview.setCurrentAlignFrame((AlignFrame) itf);
 885           }
 886           itf.requestFocus();
 887         }
 888       }
 889
 890       @Override
 891       public void internalFrameClosed(InternalFrameEvent evt)
 892       {
 893         PaintRefresher.RemoveComponent(frame);
 894
 895         /*
 896          * defensive check to prevent frames being
 897          * added half off the window
 898          */
 899         if (openFrameCount > 0)
 900         {
 901           openFrameCount--;
 902         }
 903
 904         /*
 905          * ensure no reference to alignFrame retained by menu item listener
 906          */
 907         if (menuItem.getActionListeners().length > 0)
 908         {
 909           menuItem.removeActionListener(menuItem.getActionListeners()[0]);
 910         }
 911         windowMenu.remove(menuItem);
 912       };
 913     });
 914
 915     menuItem.addActionListener(new ActionListener()
 916     {
 917       @Override
 918       public void actionPerformed(ActionEvent e)
 919       {
 920         try
 921         {
 922           frame.setSelected(true);
 923           frame.setIcon(false);
 924         } catch (java.beans.PropertyVetoException ex)
 925         {
 926
 927         }
 928       }
 929     });
 930
 931     setKeyBindings(frame);
 932
 933     desktop.add(frame);
 934
 935     windowMenu.add(menuItem);
 936
 937     frame.toFront();
 938     try
 939     {
 940       frame.setSelected(true);
 941       frame.requestFocus();
 942     } catch (java.beans.PropertyVetoException ve)
 943     {
 944     } catch (java.lang.ClassCastException cex)
 945     {
 946       Cache.log.warn(
 947               "Squashed a possible GUI implementation error. If you can recreate this, please look at http://issues.jalview.org/browse/JAL-869",
 948               cex);
 949     }
 950   }
 951
 952   /**
 953    * Add key bindings to a JInternalFrame so that Ctrl-W and Cmd-W will close
 954    * the window
 955    *
 956    * @param frame
 957    */
 958   private static void setKeyBindings(JInternalFrame frame)
 959   {
 960     @SuppressWarnings("serial")
 961     final Action closeAction = new AbstractAction()
 962     {
 963       @Override
 964       public void actionPerformed(ActionEvent e)
 965       {
 966         frame.dispose();
 967       }
 968     };
 969
 970     /*
 971      * set up key bindings for Ctrl-W and Cmd-W, with the same (Close) action
 972      */
 973     KeyStroke ctrlWKey = KeyStroke.getKeyStroke(KeyEvent.VK_W,
 974             InputEvent.CTRL_DOWN_MASK);
 975     KeyStroke cmdWKey = KeyStroke.getKeyStroke(KeyEvent.VK_W,
 976             Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
 977
 978     InputMap inputMap = frame
 979             .getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
 980     String ctrlW = ctrlWKey.toString();
 981     inputMap.put(ctrlWKey, ctrlW);
 982     inputMap.put(cmdWKey, ctrlW);
 983
 984     ActionMap actionMap = frame.getActionMap();
 985     actionMap.put(ctrlW, closeAction);
 986   }
 987
 988   @Override
 989   public void lostOwnership(Clipboard clipboard, Transferable contents)
 990   {
 991     if (!internalCopy)
 992     {
 993       Desktop.jalviewClipboard = null;
 994     }
 995
 996     internalCopy = false;
 997   }
 998
 999   @Override
1000   public void dragEnter(DropTargetDragEvent evt)
1001   {
1002   }
1003
1004   @Override
1005   public void dragExit(DropTargetEvent evt)
1006   {
1007   }
1008
1009   @Override
1010   public void dragOver(DropTargetDragEvent evt)
1011   {
1012   }
1013
1014   @Override
1015   public void dropActionChanged(DropTargetDragEvent evt)
1016   {
1017   }
1018
1019   /**
1020    * DOCUMENT ME!
1021    *
1022    * @param evt
1023    *          DOCUMENT ME!
1024    */
1025   @Override
1026   public void drop(DropTargetDropEvent evt)
1027   {
1028     boolean success = true;
1029     // JAL-1552 - acceptDrop required before getTransferable call for
1030     // Java's Transferable for native dnd
1031     evt.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
1032     Transferable t = evt.getTransferable();
1033     List<String> files = new ArrayList<>();
1034     List<DataSourceType> protocols = new ArrayList<>();
1035
1036     try
1037     {
1038       Desktop.transferFromDropTarget(files, protocols, evt, t);
1039     } catch (Exception e)
1040     {
1041       e.printStackTrace();
1042       success = false;
1043     }
1044
1045     if (files != null)
1046     {
1047       try
1048       {
1049         for (int i = 0; i < files.size(); i++)
1050         {
1051           String file = files.get(i).toString();
1052           DataSourceType protocol = (protocols == null)
1053                   ? DataSourceType.FILE
1054                   : protocols.get(i);
1055           FileFormatI format = null;
1056
1057           if (file.endsWith(".jar"))
1058           {
1059             format = FileFormat.Jalview;
1060
1061           }
1062           else
1063           {
1064             format = new IdentifyFile().identify(file, protocol);
1065           }
1066
1067           new FileLoader().LoadFile(file, protocol, format);
1068
1069         }
1070       } catch (Exception ex)
1071       {
1072         success = false;
1073       }
1074     }
1075     evt.dropComplete(success); // need this to ensure input focus is properly
1076                                // transfered to any new windows created
1077   }
1078
1079   /**
1080    * DOCUMENT ME!
1081    *
1082    * @param e
1083    *          DOCUMENT ME!
1084    */
1085   @Override
1086   public void inputLocalFileMenuItem_actionPerformed(AlignViewport viewport)
1087   {
1088     String fileFormat = Cache.getProperty("DEFAULT_FILE_FORMAT");
1089     JalviewFileChooser chooser = JalviewFileChooser
1090             .forRead(Cache.getProperty("LAST_DIRECTORY"), fileFormat, true);
1091
1092     chooser.setFileView(new JalviewFileView());
1093     chooser.setDialogTitle(
1094             MessageManager.getString("label.open_local_file"));
1095     chooser.setToolTipText(MessageManager.getString("action.open"));
1096
1097     int value = chooser.showOpenDialog(this);
1098
1099     if (value == JalviewFileChooser.APPROVE_OPTION)
1100     {
1101       String choice = chooser.getSelectedFile().getPath();
1102       Cache.setProperty("LAST_DIRECTORY",
1103               chooser.getSelectedFile().getParent());
1104
1105       FileFormatI format = chooser.getSelectedFormat();
1106
1107       /*
1108        * Call IdentifyFile to verify the file contains what its extension implies.
1109        * Skip this step for dynamically added file formats, because
1110        * IdentifyFile does not know how to recognise them.
1111        */
1112       if (FileFormats.getInstance().isIdentifiable(format))
1113       {
1114         try
1115         {
1116           format = new IdentifyFile().identify(choice, DataSourceType.FILE);
1117         } catch (FileFormatException e)
1118         {
1119           // format = null; //??
1120         }
1121       }
1122
1123       if (viewport != null)
1124       {
1125         new FileLoader().LoadFile(viewport, choice, DataSourceType.FILE,
1126                 format);
1127       }
1128       else
1129       {
1130         new FileLoader().LoadFile(choice, DataSourceType.FILE, format);
1131       }
1132     }
1133   }
1134
1135   /**
1136    * DOCUMENT ME!
1137    *
1138    * @param e
1139    *          DOCUMENT ME!
1140    */
1141   @Override
1142   public void inputURLMenuItem_actionPerformed(AlignViewport viewport)
1143   {
1144     // This construct allows us to have a wider textfield
1145     // for viewing
1146     JLabel label = new JLabel(
1147             MessageManager.getString("label.input_file_url"));
1148     final JComboBox history = new JComboBox();
1149
1150     JPanel panel = new JPanel(new GridLayout(2, 1));
1151     panel.add(label);
1152     panel.add(history);
1153     history.setPreferredSize(new Dimension(400, 20));
1154     history.setEditable(true);
1155     history.addItem("http://www.");
1156
1157     String historyItems = jalview.bin.Cache.getProperty("RECENT_URL");
1158
1159     StringTokenizer st;
1160
1161     if (historyItems != null)
1162     {
1163       st = new StringTokenizer(historyItems, "\t");
1164
1165       while (st.hasMoreTokens())
1166       {
1167         history.addItem(st.nextElement());
1168       }
1169     }
1170
1171     int reply = JvOptionPane.showInternalConfirmDialog(desktop, panel,
1172             MessageManager.getString("label.input_alignment_from_url"),
1173             JvOptionPane.OK_CANCEL_OPTION);
1174
1175     if (reply != JvOptionPane.OK_OPTION)
1176     {
1177       return;
1178     }
1179
1180     String url = history.getSelectedItem().toString();
1181
1182     if (url.toLowerCase().endsWith(".jar"))
1183     {
1184       if (viewport != null)
1185       {
1186         new FileLoader().LoadFile(viewport, url, DataSourceType.URL,
1187                 FileFormat.Jalview);
1188       }
1189       else
1190       {
1191         new FileLoader().LoadFile(url, DataSourceType.URL,
1192                 FileFormat.Jalview);
1193       }
1194     }
1195     else
1196     {
1197       FileFormatI format = null;
1198       try
1199       {
1200         format = new IdentifyFile().identify(url, DataSourceType.URL);
1201       } catch (FileFormatException e)
1202       {
1203         // TODO revise error handling, distinguish between
1204         // URL not found and response not valid
1205       }
1206
1207       if (format == null)
1208       {
1209         JvOptionPane.showInternalMessageDialog(Desktop.desktop,
1210                 MessageManager.formatMessage("label.couldnt_locate",
1211                         new Object[]
1212                         { url }),
1213                 MessageManager.getString("label.url_not_found"),
1214                 JvOptionPane.WARNING_MESSAGE);
1215
1216         return;
1217       }
1218
1219       if (viewport != null)
1220       {
1221         new FileLoader().LoadFile(viewport, url, DataSourceType.URL,
1222                 format);
1223       }
1224       else
1225       {
1226         new FileLoader().LoadFile(url, DataSourceType.URL, format);
1227       }
1228     }
1229   }
1230
1231   /**
1232    * Opens the CutAndPaste window for the user to paste an alignment in to
1233    *
1234    * @param viewPanel
1235    *          - if not null, the pasted alignment is added to the current
1236    *          alignment; if null, to a new alignment window
1237    */
1238   @Override
1239   public void inputTextboxMenuItem_actionPerformed(
1240           AlignmentViewPanel viewPanel)
1241   {
1242     CutAndPasteTransfer cap = new CutAndPasteTransfer();
1243     cap.setForInput(viewPanel);
1244     Desktop.addInternalFrame(cap,
1245             MessageManager.getString("label.cut_paste_alignmen_file"), true,
1246             600, 500);
1247   }
1248
1249   /*
1250    * Exit the program
1251    */
1252   @Override
1253   public void quit()
1254   {
1255     Dimension screen = Toolkit.getDefaultToolkit().getScreenSize();
1256     jalview.bin.Cache.setProperty("SCREENGEOMETRY_WIDTH",
1257             screen.width + "");
1258     jalview.bin.Cache.setProperty("SCREENGEOMETRY_HEIGHT",
1259             screen.height + "");
1260     storeLastKnownDimensions("", new Rectangle(getBounds().x, getBounds().y,
1261             getWidth(), getHeight()));
1262
1263     if (jconsole != null)
1264     {
1265       storeLastKnownDimensions("JAVA_CONSOLE_", jconsole.getBounds());
1266       jconsole.stopConsole();
1267     }
1268     if (jvnews != null)
1269     {
1270       storeLastKnownDimensions("JALVIEW_RSS_WINDOW_", jvnews.getBounds());
1271
1272     }
1273     if (dialogExecutor != null)
1274     {
1275       dialogExecutor.shutdownNow();
1276     }
1277     closeAll_actionPerformed(null);
1278
1279     if (groovyConsole != null)
1280     {
1281       // suppress a possible repeat prompt to save script
1282       groovyConsole.setDirty(false);
1283       groovyConsole.exit();
1284     }
1285     System.exit(0);
1286   }
1287
1288   private void storeLastKnownDimensions(String string, Rectangle jc)
1289   {
1290     jalview.bin.Cache.log.debug("Storing last known dimensions for "
1291             + string + ": x:" + jc.x + " y:" + jc.y + " width:" + jc.width
1292             + " height:" + jc.height);
1293
1294     jalview.bin.Cache.setProperty(string + "SCREEN_X", jc.x + "");
1295     jalview.bin.Cache.setProperty(string + "SCREEN_Y", jc.y + "");
1296     jalview.bin.Cache.setProperty(string + "SCREEN_WIDTH", jc.width + "");
1297     jalview.bin.Cache.setProperty(string + "SCREEN_HEIGHT", jc.height + "");
1298   }
1299
1300   /**
1301    * DOCUMENT ME!
1302    *
1303    * @param e
1304    *          DOCUMENT ME!
1305    */
1306   @Override
1307   public void aboutMenuItem_actionPerformed(ActionEvent e)
1308   {
1309     // StringBuffer message = getAboutMessage(false);
1310     // JvOptionPane.showInternalMessageDialog(Desktop.desktop,
1311     //
1312     // message.toString(), "About Jalview", JvOptionPane.INFORMATION_MESSAGE);
1313     new Thread(new Runnable()
1314     {
1315       @Override
1316       public void run()
1317       {
1318         new SplashScreen(true);
1319       }
1320     }).start();
1321   }
1322
1323   public StringBuffer getAboutMessage(boolean shortv)
1324   {
1325     StringBuffer message = new StringBuffer();
1326     message.append("<html>");
1327     if (shortv)
1328     {
1329       message.append("<h1><strong>Version: "
1330               + jalview.bin.Cache.getProperty("VERSION")
1331               + "</strong></h1>");
1332       message.append("<strong>Last Updated: <em>"
1333               + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown")
1334               + "</em></strong>");
1335
1336     }
1337     else
1338     {
1339
1340       message.append("<strong>Version "
1341               + jalview.bin.Cache.getProperty("VERSION")
1342               + "; last updated: "
1343               + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"));
1344     }
1345
1346     if (jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking")
1347             .equals("Checking"))
1348     {
1349       message.append("<br>...Checking latest version...</br>");
1350     }
1351     else if (!jalview.bin.Cache.getDefault("LATEST_VERSION", "Checking")
1352             .equals(jalview.bin.Cache.getProperty("VERSION")))
1353     {
1354       boolean red = false;
1355       if (jalview.bin.Cache.getProperty("VERSION").toLowerCase()
1356               .indexOf("automated build") == -1)
1357       {
1358         red = true;
1359         // Displayed when code version and jnlp version do not match and code
1360         // version is not a development build
1361         message.append("<div style=\"color: #FF0000;font-style: bold;\">");
1362       }
1363
1364       message.append("<br>!! Version "
1365               + jalview.bin.Cache.getDefault("LATEST_VERSION",
1366                       "..Checking..")
1367               + " is available for download from "
1368               + jalview.bin.Cache.getDefault("www.jalview.org",
1369                       "http://www.jalview.org")
1370               + " !!");
1371       if (red)
1372       {
1373         message.append("</div>");
1374       }
1375     }
1376     message.append("<br>Authors:  " + jalview.bin.Cache.getDefault(
1377             "AUTHORFNAMES",
1378             "The Jalview Authors (See AUTHORS file for current list)")
1379             + "<br><br>Development managed by The Barton Group, University of Dundee, Scotland, UK.<br>"
1380             + "<br><br>For help, see the FAQ at <a href=\"http://www.jalview.org/faq\">www.jalview.org/faq</a> and/or join the jalview-discuss@jalview.org mailing list"
1381             + "<br><br>If  you use Jalview, please cite:"
1382             + "<br>Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009)"
1383             + "<br>Jalview Version 2 - a multiple sequence alignment editor and analysis workbench"
1384             + "<br>Bioinformatics doi: 10.1093/bioinformatics/btp033"
1385             + "</html>");
1386     return message;
1387   }
1388
1389   /**
1390    * DOCUMENT ME!
1391    *
1392    * @param e
1393    *          DOCUMENT ME!
1394    */
1395   @Override
1396   public void documentationMenuItem_actionPerformed(ActionEvent e)
1397   {
1398     try
1399     {
1400       Help.showHelpWindow();
1401     } catch (Exception ex)
1402     {
1403     }
1404   }
1405
1406   @Override
1407   public void closeAll_actionPerformed(ActionEvent e)
1408   {
1409     // TODO show a progress bar while closing?
1410     JInternalFrame[] frames = desktop.getAllFrames();
1411     for (int i = 0; i < frames.length; i++)
1412     {
1413       try
1414       {
1415         frames[i].setClosed(true);
1416       } catch (java.beans.PropertyVetoException ex)
1417       {
1418       }
1419     }
1420     Jalview.setCurrentAlignFrame(null);
1421     System.out.println("ALL CLOSED");
1422     if (v_client != null)
1423     {
1424       // TODO clear binding to vamsas document objects on close_all
1425     }
1426
1427     /*
1428      * reset state of singleton objects as appropriate (clear down session state
1429      * when all windows are closed)
1430      */
1431     StructureSelectionManager ssm = StructureSelectionManager
1432             .getStructureSelectionManager(this);
1433     if (ssm != null)
1434     {
1435       ssm.resetAll();
1436     }
1437   }
1438
1439   @Override
1440   public void raiseRelated_actionPerformed(ActionEvent e)
1441   {
1442     reorderAssociatedWindows(false, false);
1443   }
1444
1445   @Override
1446   public void minimizeAssociated_actionPerformed(ActionEvent e)
1447   {
1448     reorderAssociatedWindows(true, false);
1449   }
1450
1451   void closeAssociatedWindows()
1452   {
1453     reorderAssociatedWindows(false, true);
1454   }
1455
1456   /*
1457    * (non-Javadoc)
1458    *
1459    * @seejalview.jbgui.GDesktop#garbageCollect_actionPerformed(java.awt.event.
1460    * ActionEvent)
1461    */
1462   @Override
1463   protected void garbageCollect_actionPerformed(ActionEvent e)
1464   {
1465     // We simply collect the garbage
1466     jalview.bin.Cache.log.debug("Collecting garbage...");
1467     System.gc();
1468     jalview.bin.Cache.log.debug("Finished garbage collection.");
1469   }
1470
1471   /*
1472    * (non-Javadoc)
1473    *
1474    * @see
1475    * jalview.jbgui.GDesktop#showMemusage_actionPerformed(java.awt.event.ActionEvent
1476    * )
1477    */
1478   @Override
1479   protected void showMemusage_actionPerformed(ActionEvent e)
1480   {
1481     desktop.showMemoryUsage(showMemusage.isSelected());
1482   }
1483
1484   /*
1485    * (non-Javadoc)
1486    *
1487    * @see
1488    * jalview.jbgui.GDesktop#showConsole_actionPerformed(java.awt.event.ActionEvent
1489    * )
1490    */
1491   @Override
1492   protected void showConsole_actionPerformed(ActionEvent e)
1493   {
1494     showConsole(showConsole.isSelected());
1495   }
1496
1497   Console jconsole = null;
1498
1499   /**
1500    * control whether the java console is visible or not
1501    *
1502    * @param selected
1503    */
1504   void showConsole(boolean selected)
1505   {
1506     showConsole.setSelected(selected);
1507     // TODO: decide if we should update properties file
1508     Cache.setProperty("SHOW_JAVA_CONSOLE",
1509             Boolean.valueOf(selected).toString());
1510     jconsole.setVisible(selected);
1511   }
1512
1513   void reorderAssociatedWindows(boolean minimize, boolean close)
1514   {
1515     JInternalFrame[] frames = desktop.getAllFrames();
1516     if (frames == null || frames.length < 1)
1517     {
1518       return;
1519     }
1520
1521     AlignmentViewport source = null, target = null;
1522     if (frames[0] instanceof AlignFrame)
1523     {
1524       source = ((AlignFrame) frames[0]).getCurrentView();
1525     }
1526     else if (frames[0] instanceof TreePanel)
1527     {
1528       source = ((TreePanel) frames[0]).getViewPort();
1529     }
1530     else if (frames[0] instanceof PCAPanel)
1531     {
1532       source = ((PCAPanel) frames[0]).av;
1533     }
1534     else if (frames[0].getContentPane() instanceof PairwiseAlignPanel)
1535     {
1536       source = ((PairwiseAlignPanel) frames[0].getContentPane()).av;
1537     }
1538
1539     if (source != null)
1540     {
1541       for (int i = 0; i < frames.length; i++)
1542       {
1543         target = null;
1544         if (frames[i] == null)
1545         {
1546           continue;
1547         }
1548         if (frames[i] instanceof AlignFrame)
1549         {
1550           target = ((AlignFrame) frames[i]).getCurrentView();
1551         }
1552         else if (frames[i] instanceof TreePanel)
1553         {
1554           target = ((TreePanel) frames[i]).getViewPort();
1555         }
1556         else if (frames[i] instanceof PCAPanel)
1557         {
1558           target = ((PCAPanel) frames[i]).av;
1559         }
1560         else if (frames[i].getContentPane() instanceof PairwiseAlignPanel)
1561         {
1562           target = ((PairwiseAlignPanel) frames[i].getContentPane()).av;
1563         }
1564
1565         if (source == target)
1566         {
1567           try
1568           {
1569             if (close)
1570             {
1571               frames[i].setClosed(true);
1572             }
1573             else
1574             {
1575               frames[i].setIcon(minimize);
1576               if (!minimize)
1577               {
1578                 frames[i].toFront();
1579               }
1580             }
1581
1582           } catch (java.beans.PropertyVetoException ex)
1583           {
1584           }
1585         }
1586       }
1587     }
1588   }
1589
1590   /**
1591    * DOCUMENT ME!
1592    *
1593    * @param e
1594    *          DOCUMENT ME!
1595    */
1596   @Override
1597   protected void preferences_actionPerformed(ActionEvent e)
1598   {
1599     new Preferences();
1600   }
1601
1602   /**
1603    * Shows a file chooser dialog and writes out the current session as a Jalview
1604    * project file
1605    */
1606   @Override
1607   public void saveState_actionPerformed()
1608   {
1609     saveState_actionPerformed(false);
1610   }
1611
1612   public void saveState_actionPerformed(boolean saveAs)
1613   {
1614     java.io.File projectFile = getProjectFile();
1615     // autoSave indicates we already have a file and don't need to ask
1616     boolean autoSave = projectFile != null && !saveAs
1617             && BackupFiles.getEnabled();
1618
1619     // System.out.println("autoSave="+autoSave+", projectFile='"+projectFile+"',
1620     // saveAs="+saveAs+", Backups
1621     // "+(BackupFiles.getEnabled()?"enabled":"disabled"));
1622
1623     boolean approveSave = false;
1624     if (!autoSave)
1625     {
1626       JalviewFileChooser chooser = new JalviewFileChooser("jvp",
1627               "Jalview Project");
1628
1629       chooser.setFileView(new JalviewFileView());
1630       chooser.setDialogTitle(MessageManager.getString("label.save_state"));
1631
1632       int value = chooser.showSaveDialog(this);
1633
1634       if (value == JalviewFileChooser.APPROVE_OPTION)
1635       {
1636         projectFile = chooser.getSelectedFile();
1637         setProjectFile(projectFile);
1638         approveSave = true;
1639       }
1640     }
1641
1642     if (approveSave || autoSave)
1643     {
1644       final Desktop me = this;
1645       final java.io.File chosenFile = projectFile;
1646       new Thread(new Runnable()
1647       {
1648         @Override
1649         public void run()
1650         {
1651           // TODO: refactor to Jalview desktop session controller action.
1652           setProgressBar(MessageManager.formatMessage(
1653                   "label.saving_jalview_project", new Object[]
1654                   { chosenFile.getName() }), chosenFile.hashCode());
1655           jalview.bin.Cache.setProperty("LAST_DIRECTORY",
1656                   chosenFile.getParent());
1657           // TODO catch and handle errors for savestate
1658           // TODO prevent user from messing with the Desktop whilst we're saving
1659           try
1660           {
1661             BackupFiles backupfiles = new BackupFiles(chosenFile);
1662
1663             new Jalview2XML().saveState(backupfiles.getTempFile());
1664
1665             backupfiles.setWriteSuccess(true);
1666             backupfiles.rollBackupsAndRenameTempFile();
1667           } catch (OutOfMemoryError oom)
1668           {
1669             new OOMWarning("Whilst saving current state to "
1670                     + chosenFile.getName(), oom);
1671           } catch (Exception ex)
1672           {
1673             Cache.log.error("Problems whilst trying to save to "
1674                     + chosenFile.getName(), ex);
1675             JvOptionPane.showMessageDialog(me,
1676                     MessageManager.formatMessage(
1677                             "label.error_whilst_saving_current_state_to",
1678                             new Object[]
1679                             { chosenFile.getName() }),
1680                     MessageManager.getString("label.couldnt_save_project"),
1681                     JvOptionPane.WARNING_MESSAGE);
1682           }
1683           setProgressBar(null, chosenFile.hashCode());
1684         }
1685       }).start();
1686     }
1687   }
1688
1689   @Override
1690   public void saveAsState_actionPerformed(ActionEvent e)
1691   {
1692     saveState_actionPerformed(true);
1693   }
1694
1695   private void setProjectFile(File choice)
1696   {
1697     this.projectFile = choice;
1698   }
1699
1700   public File getProjectFile()
1701   {
1702     return this.projectFile;
1703   }
1704
1705   /**
1706    * Shows a file chooser dialog and tries to read in the selected file as a
1707    * Jalview project
1708    */
1709   @Override
1710   public void loadState_actionPerformed()
1711   {
1712     final String[] suffix = new String[] { "jvp", "jar" };
1713     final String[] desc = new String[] { "Jalview Project",
1714         "Jalview Project (old)" };
1715     JalviewFileChooser chooser = new JalviewFileChooser(
1716             Cache.getProperty("LAST_DIRECTORY"), suffix, desc,
1717             "Jalview Project", true, true); // last two booleans: allFiles,
1718                                             // allowBackupFiles
1719     chooser.setFileView(new JalviewFileView());
1720     chooser.setDialogTitle(MessageManager.getString("label.restore_state"));
1721
1722     int value = chooser.showOpenDialog(this);
1723
1724     if (value == JalviewFileChooser.APPROVE_OPTION)
1725     {
1726       final File selectedFile = chooser.getSelectedFile();
1727       setProjectFile(selectedFile);
1728       final String choice = selectedFile.getAbsolutePath();
1729       Cache.setProperty("LAST_DIRECTORY", selectedFile.getParent());
1730       new Thread(new Runnable()
1731       {
1732         @Override
1733         public void run()
1734         {
1735           setProgressBar(MessageManager.formatMessage(
1736                   "label.loading_jalview_project", new Object[]
1737                   { choice }), choice.hashCode());
1738           try
1739           {
1740             new Jalview2XML().loadJalviewAlign(choice);
1741           } catch (OutOfMemoryError oom)
1742           {
1743             new OOMWarning("Whilst loading project from " + choice, oom);
1744           } catch (Exception ex)
1745           {
1746             Cache.log.error(
1747                     "Problems whilst loading project from " + choice, ex);
1748             JvOptionPane.showMessageDialog(Desktop.desktop,
1749                     MessageManager.formatMessage(
1750                             "label.error_whilst_loading_project_from",
1751                             new Object[]
1752                             { choice }),
1753                     MessageManager.getString("label.couldnt_load_project"),
1754                     JvOptionPane.WARNING_MESSAGE);
1755           }
1756           setProgressBar(null, choice.hashCode());
1757         }
1758       }).start();
1759     }
1760   }
1761
1762   @Override
1763   public void inputSequence_actionPerformed(ActionEvent e)
1764   {
1765     new SequenceFetcher(this);
1766   }
1767
1768   JPanel progressPanel;
1769
1770   ArrayList<JPanel> fileLoadingPanels = new ArrayList<>();
1771
1772   public void startLoading(final String fileName)
1773   {
1774     if (fileLoadingCount == 0)
1775     {
1776       fileLoadingPanels.add(addProgressPanel(MessageManager
1777               .formatMessage("label.loading_file", new Object[]
1778               { fileName })));
1779     }
1780     fileLoadingCount++;
1781   }
1782
1783   private JPanel addProgressPanel(String string)
1784   {
1785     if (progressPanel == null)
1786     {
1787       progressPanel = new JPanel(new GridLayout(1, 1));
1788       totalProgressCount = 0;
1789       instance.getContentPane().add(progressPanel, BorderLayout.SOUTH);
1790     }
1791     JPanel thisprogress = new JPanel(new BorderLayout(10, 5));
1792     JProgressBar progressBar = new JProgressBar();
1793     progressBar.setIndeterminate(true);
1794
1795     thisprogress.add(new JLabel(string), BorderLayout.WEST);
1796
1797     thisprogress.add(progressBar, BorderLayout.CENTER);
1798     progressPanel.add(thisprogress);
1799     ((GridLayout) progressPanel.getLayout()).setRows(
1800             ((GridLayout) progressPanel.getLayout()).getRows() + 1);
1801     ++totalProgressCount;
1802     instance.validate();
1803     return thisprogress;
1804   }
1805
1806   int totalProgressCount = 0;
1807
1808   private void removeProgressPanel(JPanel progbar)
1809   {
1810     if (progressPanel != null)
1811     {
1812       synchronized (progressPanel)
1813       {
1814         progressPanel.remove(progbar);
1815         GridLayout gl = (GridLayout) progressPanel.getLayout();
1816         gl.setRows(gl.getRows() - 1);
1817         if (--totalProgressCount < 1)
1818         {
1819           this.getContentPane().remove(progressPanel);
1820           progressPanel = null;
1821         }
1822       }
1823     }
1824     validate();
1825   }
1826
1827   public void stopLoading()
1828   {
1829     fileLoadingCount--;
1830     if (fileLoadingCount < 1)
1831     {
1832       while (fileLoadingPanels.size() > 0)
1833       {
1834         removeProgressPanel(fileLoadingPanels.remove(0));
1835       }
1836       fileLoadingPanels.clear();
1837       fileLoadingCount = 0;
1838     }
1839     validate();
1840   }
1841
1842   public static int getViewCount(String alignmentId)
1843   {
1844     AlignmentViewport[] aps = getViewports(alignmentId);
1845     return (aps == null) ? 0 : aps.length;
1846   }
1847
1848   /**
1849    *
1850    * @param alignmentId
1851    *          - if null, all sets are returned
1852    * @return all AlignmentPanels concerning the alignmentId sequence set
1853    */
1854   public static AlignmentPanel[] getAlignmentPanels(String alignmentId)
1855   {
1856     if (Desktop.desktop == null)
1857     {
1858       // no frames created and in headless mode
1859       // TODO: verify that frames are recoverable when in headless mode
1860       return null;
1861     }
1862     List<AlignmentPanel> aps = new ArrayList<>();
1863     AlignFrame[] frames = getAlignFrames();
1864     if (frames == null)
1865     {
1866       return null;
1867     }
1868     for (AlignFrame af : frames)
1869     {
1870       for (AlignmentPanel ap : af.alignPanels)
1871       {
1872         if (alignmentId == null
1873                 || alignmentId.equals(ap.av.getSequenceSetId()))
1874         {
1875           aps.add(ap);
1876         }
1877       }
1878     }
1879     if (aps.size() == 0)
1880     {
1881       return null;
1882     }
1883     AlignmentPanel[] vap = aps.toArray(new AlignmentPanel[aps.size()]);
1884     return vap;
1885   }
1886
1887   /**
1888    * get all the viewports on an alignment.
1889    *
1890    * @param sequenceSetId
1891    *          unique alignment id (may be null - all viewports returned in that
1892    *          case)
1893    * @return all viewports on the alignment bound to sequenceSetId
1894    */
1895   public static AlignmentViewport[] getViewports(String sequenceSetId)
1896   {
1897     List<AlignmentViewport> viewp = new ArrayList<>();
1898     if (desktop != null)
1899     {
1900       AlignFrame[] frames = Desktop.getAlignFrames();
1901
1902       for (AlignFrame afr : frames)
1903       {
1904         if (sequenceSetId == null || afr.getViewport().getSequenceSetId()
1905                 .equals(sequenceSetId))
1906         {
1907           if (afr.alignPanels != null)
1908           {
1909             for (AlignmentPanel ap : afr.alignPanels)
1910             {
1911               if (sequenceSetId == null
1912                       || sequenceSetId.equals(ap.av.getSequenceSetId()))
1913               {
1914                 viewp.add(ap.av);
1915               }
1916             }
1917           }
1918           else
1919           {
1920             viewp.add(afr.getViewport());
1921           }
1922         }
1923       }
1924       if (viewp.size() > 0)
1925       {
1926         return viewp.toArray(new AlignmentViewport[viewp.size()]);
1927       }
1928     }
1929     return null;
1930   }
1931
1932   /**
1933    * Explode the views in the given frame into separate AlignFrame
1934    *
1935    * @param af
1936    */
1937   public static void explodeViews(AlignFrame af)
1938   {
1939     int size = af.alignPanels.size();
1940     if (size < 2)
1941     {
1942       return;
1943     }
1944
1945     for (int i = 0; i < size; i++)
1946     {
1947       AlignmentPanel ap = af.alignPanels.get(i);
1948       AlignFrame newaf = new AlignFrame(ap);
1949
1950       /*
1951        * Restore the view's last exploded frame geometry if known. Multiple
1952        * views from one exploded frame share and restore the same (frame)
1953        * position and size.
1954        */
1955       Rectangle geometry = ap.av.getExplodedGeometry();
1956       if (geometry != null)
1957       {
1958         newaf.setBounds(geometry);
1959       }
1960
1961       ap.av.setGatherViewsHere(false);
1962
1963       addInternalFrame(newaf, af.getTitle(), AlignFrame.DEFAULT_WIDTH,
1964               AlignFrame.DEFAULT_HEIGHT);
1965     }
1966
1967     af.alignPanels.clear();
1968     af.closeMenuItem_actionPerformed(true);
1969
1970   }
1971
1972   /**
1973    * Gather expanded views (separate AlignFrame's) with the same sequence set
1974    * identifier back in to this frame as additional views, and close the
1975    * expanded views. Note the expanded frames may themselves have multiple
1976    * views. We take the lot.
1977    *
1978    * @param source
1979    */
1980   public void gatherViews(AlignFrame source)
1981   {
1982     source.viewport.setGatherViewsHere(true);
1983     source.viewport.setExplodedGeometry(source.getBounds());
1984     JInternalFrame[] frames = desktop.getAllFrames();
1985     String viewId = source.viewport.getSequenceSetId();
1986
1987     for (int t = 0; t < frames.length; t++)
1988     {
1989       if (frames[t] instanceof AlignFrame && frames[t] != source)
1990       {
1991         AlignFrame af = (AlignFrame) frames[t];
1992         boolean gatherThis = false;
1993         for (int a = 0; a < af.alignPanels.size(); a++)
1994         {
1995           AlignmentPanel ap = af.alignPanels.get(a);
1996           if (viewId.equals(ap.av.getSequenceSetId()))
1997           {
1998             gatherThis = true;
1999             ap.av.setGatherViewsHere(false);
2000             ap.av.setExplodedGeometry(af.getBounds());
2001             source.addAlignmentPanel(ap, false);
2002           }
2003         }
2004
2005         if (gatherThis)
2006         {
2007           af.alignPanels.clear();
2008           af.closeMenuItem_actionPerformed(true);
2009         }
2010       }
2011     }
2012
2013   }
2014
2015   jalview.gui.VamsasApplication v_client = null;
2016
2017   @Override
2018   public void vamsasImport_actionPerformed(ActionEvent e)
2019   {
2020     if (v_client == null)
2021     {
2022       // Load and try to start a session.
2023       JalviewFileChooser chooser = new JalviewFileChooser(
2024               jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
2025
2026       chooser.setFileView(new JalviewFileView());
2027       chooser.setDialogTitle(
2028               MessageManager.getString("label.open_saved_vamsas_session"));
2029       chooser.setToolTipText(MessageManager.getString(
2030               "label.select_vamsas_session_opened_as_new_vamsas_session"));
2031
2032       int value = chooser.showOpenDialog(this);
2033
2034       if (value == JalviewFileChooser.APPROVE_OPTION)
2035       {
2036         String fle = chooser.getSelectedFile().toString();
2037         if (!vamsasImport(chooser.getSelectedFile()))
2038         {
2039           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2040                   MessageManager.formatMessage(
2041                           "label.couldnt_import_as_vamsas_session",
2042                           new Object[]
2043                           { fle }),
2044                   MessageManager
2045                           .getString("label.vamsas_document_import_failed"),
2046                   JvOptionPane.ERROR_MESSAGE);
2047         }
2048       }
2049     }
2050     else
2051     {
2052       jalview.bin.Cache.log.error(
2053               "Implementation error - load session from a running session is not supported.");
2054     }
2055   }
2056
2057   /**
2058    * import file into a new vamsas session (uses jalview.gui.VamsasApplication)
2059    *
2060    * @param file
2061    * @return true if import was a success and a session was started.
2062    */
2063   public boolean vamsasImport(URL url)
2064   {
2065     // TODO: create progress bar
2066     if (v_client != null)
2067     {
2068
2069       jalview.bin.Cache.log.error(
2070               "Implementation error - load session from a running session is not supported.");
2071       return false;
2072     }
2073
2074     try
2075     {
2076       // copy the URL content to a temporary local file
2077       // TODO: be a bit cleverer here with nio (?!)
2078       File file = File.createTempFile("vdocfromurl", ".vdj");
2079       FileOutputStream fos = new FileOutputStream(file);
2080       BufferedInputStream bis = new BufferedInputStream(url.openStream());
2081       byte[] buffer = new byte[2048];
2082       int ln;
2083       while ((ln = bis.read(buffer)) > -1)
2084       {
2085         fos.write(buffer, 0, ln);
2086       }
2087       bis.close();
2088       fos.close();
2089       v_client = new jalview.gui.VamsasApplication(this, file,
2090               url.toExternalForm());
2091     } catch (Exception ex)
2092     {
2093       jalview.bin.Cache.log.error(
2094               "Failed to create new vamsas session from contents of URL "
2095                       + url,
2096               ex);
2097       return false;
2098     }
2099     setupVamsasConnectedGui();
2100     v_client.initial_update(); // TODO: thread ?
2101     return v_client.inSession();
2102   }
2103
2104   /**
2105    * import file into a new vamsas session (uses jalview.gui.VamsasApplication)
2106    *
2107    * @param file
2108    * @return true if import was a success and a session was started.
2109    */
2110   public boolean vamsasImport(File file)
2111   {
2112     if (v_client != null)
2113     {
2114
2115       jalview.bin.Cache.log.error(
2116               "Implementation error - load session from a running session is not supported.");
2117       return false;
2118     }
2119
2120     setProgressBar(MessageManager.formatMessage(
2121             "status.importing_vamsas_session_from", new Object[]
2122             { file.getName() }), file.hashCode());
2123     try
2124     {
2125       v_client = new jalview.gui.VamsasApplication(this, file, null);
2126     } catch (Exception ex)
2127     {
2128       setProgressBar(MessageManager.formatMessage(
2129               "status.importing_vamsas_session_from", new Object[]
2130               { file.getName() }), file.hashCode());
2131       jalview.bin.Cache.log.error(
2132               "New vamsas session from existing session file failed:", ex);
2133       return false;
2134     }
2135     setupVamsasConnectedGui();
2136     v_client.initial_update(); // TODO: thread ?
2137     setProgressBar(MessageManager.formatMessage(
2138             "status.importing_vamsas_session_from", new Object[]
2139             { file.getName() }), file.hashCode());
2140     return v_client.inSession();
2141   }
2142
2143   public boolean joinVamsasSession(String mysesid)
2144   {
2145     if (v_client != null)
2146     {
2147       throw new Error(MessageManager
2148               .getString("error.try_join_vamsas_session_another"));
2149     }
2150     if (mysesid == null)
2151     {
2152       throw new Error(
2153               MessageManager.getString("error.invalid_vamsas_session_id"));
2154     }
2155     v_client = new VamsasApplication(this, mysesid);
2156     setupVamsasConnectedGui();
2157     v_client.initial_update();
2158     return (v_client.inSession());
2159   }
2160
2161   @Override
2162   public void vamsasStart_actionPerformed(ActionEvent e)
2163   {
2164     if (v_client == null)
2165     {
2166       // Start a session.
2167       // we just start a default session for moment.
2168       /*
2169        * JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.
2170        * getProperty("LAST_DIRECTORY"));
2171        *
2172        * chooser.setFileView(new JalviewFileView());
2173        * chooser.setDialogTitle("Load Vamsas file");
2174        * chooser.setToolTipText("Import");
2175        *
2176        * int value = chooser.showOpenDialog(this);
2177        *
2178        * if (value == JalviewFileChooser.APPROVE_OPTION) { v_client = new
2179        * jalview.gui.VamsasApplication(this, chooser.getSelectedFile());
2180        */
2181       v_client = new VamsasApplication(this);
2182       setupVamsasConnectedGui();
2183       v_client.initial_update(); // TODO: thread ?
2184     }
2185     else
2186     {
2187       // store current data in session.
2188       v_client.push_update(); // TODO: thread
2189     }
2190   }
2191
2192   protected void setupVamsasConnectedGui()
2193   {
2194     vamsasStart.setText(MessageManager.getString("label.session_update"));
2195     vamsasSave.setVisible(true);
2196     vamsasStop.setVisible(true);
2197     vamsasImport.setVisible(false); // Document import to existing session is
2198     // not possible for vamsas-client-1.0.
2199   }
2200
2201   protected void setupVamsasDisconnectedGui()
2202   {
2203     vamsasSave.setVisible(false);
2204     vamsasStop.setVisible(false);
2205     vamsasImport.setVisible(true);
2206     vamsasStart
2207             .setText(MessageManager.getString("label.new_vamsas_session"));
2208   }
2209
2210   @Override
2211   public void vamsasStop_actionPerformed(ActionEvent e)
2212   {
2213     if (v_client != null)
2214     {
2215       v_client.end_session();
2216       v_client = null;
2217       setupVamsasDisconnectedGui();
2218     }
2219   }
2220
2221   protected void buildVamsasStMenu()
2222   {
2223     if (v_client == null)
2224     {
2225       String[] sess = null;
2226       try
2227       {
2228         sess = VamsasApplication.getSessionList();
2229       } catch (Exception e)
2230       {
2231         jalview.bin.Cache.log.warn("Problem getting current sessions list.",
2232                 e);
2233         sess = null;
2234       }
2235       if (sess != null)
2236       {
2237         jalview.bin.Cache.log.debug(
2238                 "Got current sessions list: " + sess.length + " entries.");
2239         VamsasStMenu.removeAll();
2240         for (int i = 0; i < sess.length; i++)
2241         {
2242           JMenuItem sessit = new JMenuItem();
2243           sessit.setText(sess[i]);
2244           sessit.setToolTipText(MessageManager
2245                   .formatMessage("label.connect_to_session", new Object[]
2246                   { sess[i] }));
2247           final Desktop dsktp = this;
2248           final String mysesid = sess[i];
2249           sessit.addActionListener(new ActionListener()
2250           {
2251
2252             @Override
2253             public void actionPerformed(ActionEvent e)
2254             {
2255               if (dsktp.v_client == null)
2256               {
2257                 Thread rthr = new Thread(new Runnable()
2258                 {
2259
2260                   @Override
2261                   public void run()
2262                   {
2263                     dsktp.v_client = new VamsasApplication(dsktp, mysesid);
2264                     dsktp.setupVamsasConnectedGui();
2265                     dsktp.v_client.initial_update();
2266                   }
2267
2268                 });
2269                 rthr.start();
2270               }
2271             };
2272           });
2273           VamsasStMenu.add(sessit);
2274         }
2275         // don't show an empty menu.
2276         VamsasStMenu.setVisible(sess.length > 0);
2277
2278       }
2279       else
2280       {
2281         jalview.bin.Cache.log.debug("No current vamsas sessions.");
2282         VamsasStMenu.removeAll();
2283         VamsasStMenu.setVisible(false);
2284       }
2285     }
2286     else
2287     {
2288       // Not interested in the content. Just hide ourselves.
2289       VamsasStMenu.setVisible(false);
2290     }
2291   }
2292
2293   @Override
2294   public void vamsasSave_actionPerformed(ActionEvent e)
2295   {
2296     if (v_client != null)
2297     {
2298       // TODO: VAMSAS DOCUMENT EXTENSION is VDJ
2299       JalviewFileChooser chooser = new JalviewFileChooser("vdj",
2300               "Vamsas Document");
2301
2302       chooser.setFileView(new JalviewFileView());
2303       chooser.setDialogTitle(MessageManager
2304               .getString("label.save_vamsas_document_archive"));
2305
2306       int value = chooser.showSaveDialog(this);
2307
2308       if (value == JalviewFileChooser.APPROVE_OPTION)
2309       {
2310         java.io.File choice = chooser.getSelectedFile();
2311         JPanel progpanel = addProgressPanel(MessageManager
2312                 .formatMessage("label.saving_vamsas_doc", new Object[]
2313                 { choice.getName() }));
2314         Cache.setProperty("LAST_DIRECTORY", choice.getParent());
2315         String warnmsg = null;
2316         String warnttl = null;
2317         try
2318         {
2319           v_client.vclient.storeDocument(choice);
2320         } catch (Error ex)
2321         {
2322           warnttl = "Serious Problem saving Vamsas Document";
2323           warnmsg = ex.toString();
2324           jalview.bin.Cache.log
2325                   .error("Error Whilst saving document to " + choice, ex);
2326
2327         } catch (Exception ex)
2328         {
2329           warnttl = "Problem saving Vamsas Document.";
2330           warnmsg = ex.toString();
2331           jalview.bin.Cache.log.warn(
2332                   "Exception Whilst saving document to " + choice, ex);
2333
2334         }
2335         removeProgressPanel(progpanel);
2336         if (warnmsg != null)
2337         {
2338           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2339
2340                   warnmsg, warnttl, JvOptionPane.ERROR_MESSAGE);
2341         }
2342       }
2343     }
2344   }
2345
2346   JPanel vamUpdate = null;
2347
2348   /**
2349    * hide vamsas user gui bits when a vamsas document event is being handled.
2350    *
2351    * @param b
2352    *          true to hide gui, false to reveal gui
2353    */
2354   public void setVamsasUpdate(boolean b)
2355   {
2356     Cache.log.debug("Setting gui for Vamsas update "
2357             + (b ? "in progress" : "finished"));
2358
2359     if (vamUpdate != null)
2360     {
2361       this.removeProgressPanel(vamUpdate);
2362     }
2363     if (b)
2364     {
2365       vamUpdate = this.addProgressPanel(
2366               MessageManager.getString("label.updating_vamsas_session"));
2367     }
2368     vamsasStart.setVisible(!b);
2369     vamsasStop.setVisible(!b);
2370     vamsasSave.setVisible(!b);
2371   }
2372
2373   public JInternalFrame[] getAllFrames()
2374   {
2375     return desktop.getAllFrames();
2376   }
2377
2378   /**
2379    * Checks the given url to see if it gives a response indicating that the user
2380    * should be informed of a new questionnaire.
2381    *
2382    * @param url
2383    */
2384   public void checkForQuestionnaire(String url)
2385   {
2386     UserQuestionnaireCheck jvq = new UserQuestionnaireCheck(url);
2387     // javax.swing.SwingUtilities.invokeLater(jvq);
2388     new Thread(jvq).start();
2389   }
2390
2391   public void checkURLLinks()
2392   {
2393     // Thread off the URL link checker
2394     addDialogThread(new Runnable()
2395     {
2396       @Override
2397       public void run()
2398       {
2399         if (Cache.getDefault("CHECKURLLINKS", true))
2400         {
2401           // check what the actual links are - if it's just the default don't
2402           // bother with the warning
2403           List<String> links = Preferences.sequenceUrlLinks
2404                   .getLinksForMenu();
2405
2406           // only need to check links if there is one with a
2407           // SEQUENCE_ID which is not the default EMBL_EBI link
2408           ListIterator<String> li = links.listIterator();
2409           boolean check = false;
2410           List<JLabel> urls = new ArrayList<>();
2411           while (li.hasNext())
2412           {
2413             String link = li.next();
2414             if (link.contains(SEQUENCE_ID)
2415                     && !UrlConstants.isDefaultString(link))
2416             {
2417               check = true;
2418               int barPos = link.indexOf("|");
2419               String urlMsg = barPos == -1 ? link
2420                       : link.substring(0, barPos) + ": "
2421                               + link.substring(barPos + 1);
2422               urls.add(new JLabel(urlMsg));
2423             }
2424           }
2425           if (!check)
2426           {
2427             return;
2428           }
2429
2430           // ask user to check in case URL links use old style tokens
2431           // ($SEQUENCE_ID$ for sequence id _or_ accession id)
2432           JPanel msgPanel = new JPanel();
2433           msgPanel.setLayout(new BoxLayout(msgPanel, BoxLayout.PAGE_AXIS));
2434           msgPanel.add(Box.createVerticalGlue());
2435           JLabel msg = new JLabel(MessageManager
2436                   .getString("label.SEQUENCE_ID_for_DB_ACCESSION1"));
2437           JLabel msg2 = new JLabel(MessageManager
2438                   .getString("label.SEQUENCE_ID_for_DB_ACCESSION2"));
2439           msgPanel.add(msg);
2440           for (JLabel url : urls)
2441           {
2442             msgPanel.add(url);
2443           }
2444           msgPanel.add(msg2);
2445
2446           final JCheckBox jcb = new JCheckBox(
2447                   MessageManager.getString("label.do_not_display_again"));
2448           jcb.addActionListener(new ActionListener()
2449           {
2450             @Override
2451             public void actionPerformed(ActionEvent e)
2452             {
2453               // update Cache settings for "don't show this again"
2454               boolean showWarningAgain = !jcb.isSelected();
2455               Cache.setProperty("CHECKURLLINKS",
2456                       Boolean.valueOf(showWarningAgain).toString());
2457             }
2458           });
2459           msgPanel.add(jcb);
2460
2461           JvOptionPane.showMessageDialog(Desktop.desktop, msgPanel,
2462                   MessageManager
2463                           .getString("label.SEQUENCE_ID_no_longer_used"),
2464                   JvOptionPane.WARNING_MESSAGE);
2465         }
2466       }
2467     });
2468   }
2469
2470   /**
2471    * Proxy class for JDesktopPane which optionally displays the current memory
2472    * usage and highlights the desktop area with a red bar if free memory runs
2473    * low.
2474    *
2475    * @author AMW
2476    */
2477   public class MyDesktopPane extends JDesktopPane implements Runnable
2478   {
2479
2480     private static final float ONE_MB = 1048576f;
2481
2482     boolean showMemoryUsage = false;
2483
2484     Runtime runtime;
2485
2486     java.text.NumberFormat df;
2487
2488     float maxMemory, allocatedMemory, freeMemory, totalFreeMemory,
2489             percentUsage;
2490
2491     public MyDesktopPane(boolean showMemoryUsage)
2492     {
2493       showMemoryUsage(showMemoryUsage);
2494     }
2495
2496     public void showMemoryUsage(boolean showMemory)
2497     {
2498       this.showMemoryUsage = showMemory;
2499       if (showMemory)
2500       {
2501         Thread worker = new Thread(this);
2502         worker.start();
2503       }
2504       repaint();
2505     }
2506
2507     public boolean isShowMemoryUsage()
2508     {
2509       return showMemoryUsage;
2510     }
2511
2512     @Override
2513     public void run()
2514     {
2515       df = java.text.NumberFormat.getNumberInstance();
2516       df.setMaximumFractionDigits(2);
2517       runtime = Runtime.getRuntime();
2518
2519       while (showMemoryUsage)
2520       {
2521         try
2522         {
2523           maxMemory = runtime.maxMemory() / ONE_MB;
2524           allocatedMemory = runtime.totalMemory() / ONE_MB;
2525           freeMemory = runtime.freeMemory() / ONE_MB;
2526           totalFreeMemory = freeMemory + (maxMemory - allocatedMemory);
2527
2528           percentUsage = (totalFreeMemory / maxMemory) * 100;
2529
2530           // if (percentUsage < 20)
2531           {
2532             // border1 = BorderFactory.createMatteBorder(12, 12, 12, 12,
2533             // Color.red);
2534             // instance.set.setBorder(border1);
2535           }
2536           repaint();
2537           // sleep after showing usage
2538           Thread.sleep(3000);
2539         } catch (Exception ex)
2540         {
2541           ex.printStackTrace();
2542         }
2543       }
2544     }
2545
2546     @Override
2547     public void paintComponent(Graphics g)
2548     {
2549       if (showMemoryUsage && g != null && df != null)
2550       {
2551         if (percentUsage < 20)
2552         {
2553           g.setColor(Color.red);
2554         }
2555         FontMetrics fm = g.getFontMetrics();
2556         if (fm != null)
2557         {
2558           g.drawString(MessageManager.formatMessage("label.memory_stats",
2559                   new Object[]
2560                   { df.format(totalFreeMemory), df.format(maxMemory),
2561                       df.format(percentUsage) }),
2562                   10, getHeight() - fm.getHeight());
2563         }
2564       }
2565     }
2566   }
2567
2568   /**
2569    * Accessor method to quickly get all the AlignmentFrames loaded.
2570    *
2571    * @return an array of AlignFrame, or null if none found
2572    */
2573   public static AlignFrame[] getAlignFrames()
2574   {
2575     if (Jalview.isHeadlessMode())
2576     {
2577       // Desktop.desktop is null in headless mode
2578       return new AlignFrame[] { Jalview.currentAlignFrame };
2579     }
2580
2581     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2582
2583     if (frames == null)
2584     {
2585       return null;
2586     }
2587     List<AlignFrame> avp = new ArrayList<>();
2588     // REVERSE ORDER
2589     for (int i = frames.length - 1; i > -1; i--)
2590     {
2591       if (frames[i] instanceof AlignFrame)
2592       {
2593         avp.add((AlignFrame) frames[i]);
2594       }
2595       else if (frames[i] instanceof SplitFrame)
2596       {
2597         /*
2598          * Also check for a split frame containing an AlignFrame
2599          */
2600         GSplitFrame sf = (GSplitFrame) frames[i];
2601         if (sf.getTopFrame() instanceof AlignFrame)
2602         {
2603           avp.add((AlignFrame) sf.getTopFrame());
2604         }
2605         if (sf.getBottomFrame() instanceof AlignFrame)
2606         {
2607           avp.add((AlignFrame) sf.getBottomFrame());
2608         }
2609       }
2610     }
2611     if (avp.size() == 0)
2612     {
2613       return null;
2614     }
2615     AlignFrame afs[] = avp.toArray(new AlignFrame[avp.size()]);
2616     return afs;
2617   }
2618
2619   /**
2620    * Returns an array of any AppJmol frames in the Desktop (or null if none).
2621    *
2622    * @return
2623    */
2624   public GStructureViewer[] getJmols()
2625   {
2626     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2627
2628     if (frames == null)
2629     {
2630       return null;
2631     }
2632     List<GStructureViewer> avp = new ArrayList<>();
2633     // REVERSE ORDER
2634     for (int i = frames.length - 1; i > -1; i--)
2635     {
2636       if (frames[i] instanceof AppJmol)
2637       {
2638         GStructureViewer af = (GStructureViewer) frames[i];
2639         avp.add(af);
2640       }
2641     }
2642     if (avp.size() == 0)
2643     {
2644       return null;
2645     }
2646     GStructureViewer afs[] = avp.toArray(new GStructureViewer[avp.size()]);
2647     return afs;
2648   }
2649
2650   /**
2651    * Add Groovy Support to Jalview
2652    */
2653   @Override
2654   public void groovyShell_actionPerformed()
2655   {
2656     try
2657     {
2658       openGroovyConsole();
2659     } catch (Exception ex)
2660     {
2661       jalview.bin.Cache.log.error("Groovy Shell Creation failed.", ex);
2662       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2663
2664               MessageManager.getString("label.couldnt_create_groovy_shell"),
2665               MessageManager.getString("label.groovy_support_failed"),
2666               JvOptionPane.ERROR_MESSAGE);
2667     }
2668   }
2669
2670   /**
2671    * Open the Groovy console
2672    */
2673   void openGroovyConsole()
2674   {
2675     if (groovyConsole == null)
2676     {
2677       groovyConsole = new groovy.ui.Console();
2678       groovyConsole.setVariable("Jalview", this);
2679       groovyConsole.run();
2680
2681       /*
2682        * We allow only one console at a time, so that AlignFrame menu option
2683        * 'Calculate | Run Groovy script' is unambiguous.
2684        * Disable 'Groovy Console', and enable 'Run script', when the console is
2685        * opened, and the reverse when it is closed
2686        */
2687       Window window = (Window) groovyConsole.getFrame();
2688       window.addWindowListener(new WindowAdapter()
2689       {
2690         @Override
2691         public void windowClosed(WindowEvent e)
2692         {
2693           /*
2694            * rebind CMD-Q from Groovy Console to Jalview Quit
2695            */
2696           addQuitHandler();
2697           enableExecuteGroovy(false);
2698         }
2699       });
2700     }
2701
2702     /*
2703      * show Groovy console window (after close and reopen)
2704      */
2705     ((Window) groovyConsole.getFrame()).setVisible(true);
2706
2707     /*
2708      * if we got this far, enable 'Run Groovy' in AlignFrame menus
2709      * and disable opening a second console
2710      */
2711     enableExecuteGroovy(true);
2712   }
2713
2714   /**
2715    * Bind Ctrl/Cmd-Q to Quit - for reset as Groovy Console takes over this
2716    * binding when opened
2717    */
2718   protected void addQuitHandler()
2719   {
2720     getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
2721             .put(KeyStroke.getKeyStroke(KeyEvent.VK_Q,
2722                     Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()),
2723                     "Quit");
2724     getRootPane().getActionMap().put("Quit", new AbstractAction()
2725     {
2726       @Override
2727       public void actionPerformed(ActionEvent e)
2728       {
2729         quit();
2730       }
2731     });
2732   }
2733
2734   /**
2735    * Enable or disable 'Run Groovy script' in AlignFrame calculate menus
2736    *
2737    * @param enabled
2738    *          true if Groovy console is open
2739    */
2740   public void enableExecuteGroovy(boolean enabled)
2741   {
2742     /*
2743      * disable opening a second Groovy console
2744      * (or re-enable when the console is closed)
2745      */
2746     groovyShell.setEnabled(!enabled);
2747
2748     AlignFrame[] alignFrames = getAlignFrames();
2749     if (alignFrames != null)
2750     {
2751       for (AlignFrame af : alignFrames)
2752       {
2753         af.setGroovyEnabled(enabled);
2754       }
2755     }
2756   }
2757
2758   /**
2759    * Progress bars managed by the IProgressIndicator method.
2760    */
2761   private Hashtable<Long, JPanel> progressBars;
2762
2763   private Hashtable<Long, IProgressIndicatorHandler> progressBarHandlers;
2764
2765   /*
2766    * (non-Javadoc)
2767    *
2768    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
2769    */
2770   @Override
2771   public void setProgressBar(String message, long id)
2772   {
2773     if (progressBars == null)
2774     {
2775       progressBars = new Hashtable<>();
2776       progressBarHandlers = new Hashtable<>();
2777     }
2778
2779     if (progressBars.get(new Long(id)) != null)
2780     {
2781       JPanel panel = progressBars.remove(new Long(id));
2782       if (progressBarHandlers.contains(new Long(id)))
2783       {
2784         progressBarHandlers.remove(new Long(id));
2785       }
2786       removeProgressPanel(panel);
2787     }
2788     else
2789     {
2790       progressBars.put(new Long(id), addProgressPanel(message));
2791     }
2792   }
2793
2794   /*
2795    * (non-Javadoc)
2796    *
2797    * @see jalview.gui.IProgressIndicator#registerHandler(long,
2798    * jalview.gui.IProgressIndicatorHandler)
2799    */
2800   @Override
2801   public void registerHandler(final long id,
2802           final IProgressIndicatorHandler handler)
2803   {
2804     if (progressBarHandlers == null
2805             || !progressBars.containsKey(new Long(id)))
2806     {
2807       throw new Error(MessageManager.getString(
2808               "error.call_setprogressbar_before_registering_handler"));
2809     }
2810     progressBarHandlers.put(new Long(id), handler);
2811     final JPanel progressPanel = progressBars.get(new Long(id));
2812     if (handler.canCancel())
2813     {
2814       JButton cancel = new JButton(
2815               MessageManager.getString("action.cancel"));
2816       final IProgressIndicator us = this;
2817       cancel.addActionListener(new ActionListener()
2818       {
2819
2820         @Override
2821         public void actionPerformed(ActionEvent e)
2822         {
2823           handler.cancelActivity(id);
2824           us.setProgressBar(MessageManager
2825                   .formatMessage("label.cancelled_params", new Object[]
2826                   { ((JLabel) progressPanel.getComponent(0)).getText() }),
2827                   id);
2828         }
2829       });
2830       progressPanel.add(cancel, BorderLayout.EAST);
2831     }
2832   }
2833
2834   /**
2835    *
2836    * @return true if any progress bars are still active
2837    */
2838   @Override
2839   public boolean operationInProgress()
2840   {
2841     if (progressBars != null && progressBars.size() > 0)
2842     {
2843       return true;
2844     }
2845     return false;
2846   }
2847
2848   /**
2849    * This will return the first AlignFrame holding the given viewport instance.
2850    * It will break if there are more than one AlignFrames viewing a particular
2851    * av.
2852    *
2853    * @param viewport
2854    * @return alignFrame for viewport
2855    */
2856   public static AlignFrame getAlignFrameFor(AlignViewportI viewport)
2857   {
2858     if (desktop != null)
2859     {
2860       AlignmentPanel[] aps = getAlignmentPanels(
2861               viewport.getSequenceSetId());
2862       for (int panel = 0; aps != null && panel < aps.length; panel++)
2863       {
2864         if (aps[panel] != null && aps[panel].av == viewport)
2865         {
2866           return aps[panel].alignFrame;
2867         }
2868       }
2869     }
2870     return null;
2871   }
2872
2873   public VamsasApplication getVamsasApplication()
2874   {
2875     return v_client;
2876
2877   }
2878
2879   /**
2880    * flag set if jalview GUI is being operated programmatically
2881    */
2882   private boolean inBatchMode = false;
2883
2884   /**
2885    * check if jalview GUI is being operated programmatically
2886    *
2887    * @return inBatchMode
2888    */
2889   public boolean isInBatchMode()
2890   {
2891     return inBatchMode;
2892   }
2893
2894   /**
2895    * set flag if jalview GUI is being operated programmatically
2896    *
2897    * @param inBatchMode
2898    */
2899   public void setInBatchMode(boolean inBatchMode)
2900   {
2901     this.inBatchMode = inBatchMode;
2902   }
2903
2904   public void startServiceDiscovery()
2905   {
2906     startServiceDiscovery(false);
2907   }
2908
2909   public void startServiceDiscovery(boolean blocking)
2910   {
2911     boolean alive = true;
2912     Thread t0 = null, t1 = null, t2 = null;
2913     // JAL-940 - JALVIEW 1 services are now being EOLed as of JABA 2.1 release
2914     if (true)
2915     {
2916       // todo: changesupport handlers need to be transferred
2917       if (discoverer == null)
2918       {
2919         discoverer = new jalview.ws.jws1.Discoverer();
2920         // register PCS handler for desktop.
2921         discoverer.addPropertyChangeListener(changeSupport);
2922       }
2923       // JAL-940 - disabled JWS1 service configuration - always start discoverer
2924       // until we phase out completely
2925       (t0 = new Thread(discoverer)).start();
2926     }
2927
2928     if (Cache.getDefault("SHOW_JWS2_SERVICES", true))
2929     {
2930       t2 = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2931               .startDiscoverer(changeSupport);
2932     }
2933     Thread t3 = null;
2934     {
2935       // TODO: do rest service discovery
2936     }
2937     if (blocking)
2938     {
2939       while (alive)
2940       {
2941         try
2942         {
2943           Thread.sleep(15);
2944         } catch (Exception e)
2945         {
2946         }
2947         alive = (t1 != null && t1.isAlive()) || (t2 != null && t2.isAlive())
2948                 || (t3 != null && t3.isAlive())
2949                 || (t0 != null && t0.isAlive());
2950       }
2951     }
2952   }
2953
2954   /**
2955    * called to check if the service discovery process completed successfully.
2956    *
2957    * @param evt
2958    */
2959   protected void JalviewServicesChanged(PropertyChangeEvent evt)
2960   {
2961     if (evt.getNewValue() == null || evt.getNewValue() instanceof Vector)
2962     {
2963       final String ermsg = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2964               .getErrorMessages();
2965       if (ermsg != null)
2966       {
2967         if (Cache.getDefault("SHOW_WSDISCOVERY_ERRORS", true))
2968         {
2969           if (serviceChangedDialog == null)
2970           {
2971             // only run if we aren't already displaying one of these.
2972             addDialogThread(serviceChangedDialog = new Runnable()
2973             {
2974               @Override
2975               public void run()
2976               {
2977
2978                 /*
2979                  * JalviewDialog jd =new JalviewDialog() {
2980                  *
2981                  * @Override protected void cancelPressed() { // TODO
2982                  * Auto-generated method stub
2983                  *
2984                  * }@Override protected void okPressed() { // TODO
2985                  * Auto-generated method stub
2986                  *
2987                  * }@Override protected void raiseClosed() { // TODO
2988                  * Auto-generated method stub
2989                  *
2990                  * } }; jd.initDialogFrame(new
2991                  * JLabel("<html><table width=\"450\"><tr><td>" + ermsg +
2992                  * "<br/>It may be that you have invalid JABA URLs in your web service preferences,"
2993                  * + " or mis-configured HTTP proxy settings.<br/>" +
2994                  * "Check the <em>Connections</em> and <em>Web services</em> tab of the"
2995                  * +
2996                  * " Tools->Preferences dialog box to change them.</td></tr></table></html>"
2997                  * ), true, true, "Web Service Configuration Problem", 450,
2998                  * 400);
2999                  *
3000                  * jd.waitForInput();
3001                  */
3002                 JvOptionPane.showConfirmDialog(Desktop.desktop,
3003                         new JLabel("<html><table width=\"450\"><tr><td>"
3004                                 + ermsg + "</td></tr></table>"
3005                                 + "<p>It may be that you have invalid JABA URLs<br/>in your web service preferences,"
3006                                 + "<br>or as a command-line argument, or mis-configured HTTP proxy settings.</p>"
3007                                 + "<p>Check the <em>Connections</em> and <em>Web services</em> tab<br/>of the"
3008                                 + " Tools->Preferences dialog box to change them.</p></html>"),
3009                         "Web Service Configuration Problem",
3010                         JvOptionPane.DEFAULT_OPTION,
3011                         JvOptionPane.ERROR_MESSAGE);
3012                 serviceChangedDialog = null;
3013
3014               }
3015             });
3016           }
3017         }
3018         else
3019         {
3020           Cache.log.error(
3021                   "Errors reported by JABA discovery service. Check web services preferences.\n"
3022                           + ermsg);
3023         }
3024       }
3025     }
3026   }
3027
3028   private Runnable serviceChangedDialog = null;
3029
3030   /**
3031    * start a thread to open a URL in the configured browser. Pops up a warning
3032    * dialog to the user if there is an exception when calling out to the browser
3033    * to open the URL.
3034    *
3035    * @param url
3036    */
3037   public static void showUrl(final String url)
3038   {
3039     showUrl(url, Desktop.instance);
3040   }
3041
3042   /**
3043    * Like showUrl but allows progress handler to be specified
3044    *
3045    * @param url
3046    * @param progress
3047    *          (null) or object implementing IProgressIndicator
3048    */
3049   public static void showUrl(final String url,
3050           final IProgressIndicator progress)
3051   {
3052     new Thread(new Runnable()
3053     {
3054       @Override
3055       public void run()
3056       {
3057         try
3058         {
3059           if (progress != null)
3060           {
3061             progress.setProgressBar(MessageManager
3062                     .formatMessage("status.opening_params", new Object[]
3063                     { url }), this.hashCode());
3064           }
3065           jalview.util.BrowserLauncher.openURL(url);
3066         } catch (Exception ex)
3067         {
3068           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
3069                   MessageManager
3070                           .getString("label.web_browser_not_found_unix"),
3071                   MessageManager.getString("label.web_browser_not_found"),
3072                   JvOptionPane.WARNING_MESSAGE);
3073
3074           ex.printStackTrace();
3075         }
3076         if (progress != null)
3077         {
3078           progress.setProgressBar(null, this.hashCode());
3079         }
3080       }
3081     }).start();
3082   }
3083
3084   public static WsParamSetManager wsparamManager = null;
3085
3086   public static ParamManager getUserParameterStore()
3087   {
3088     if (wsparamManager == null)
3089     {
3090       wsparamManager = new WsParamSetManager();
3091     }
3092     return wsparamManager;
3093   }
3094
3095   /**
3096    * static hyperlink handler proxy method for use by Jalview's internal windows
3097    *
3098    * @param e
3099    */
3100   public static void hyperlinkUpdate(HyperlinkEvent e)
3101   {
3102     if (e.getEventType() == EventType.ACTIVATED)
3103     {
3104       String url = null;
3105       try
3106       {
3107         url = e.getURL().toString();
3108         Desktop.showUrl(url);
3109       } catch (Exception x)
3110       {
3111         if (url != null)
3112         {
3113           if (Cache.log != null)
3114           {
3115             Cache.log.error("Couldn't handle string " + url + " as a URL.");
3116           }
3117           else
3118           {
3119             System.err.println(
3120                     "Couldn't handle string " + url + " as a URL.");
3121           }
3122         }
3123         // ignore any exceptions due to dud links.
3124       }
3125
3126     }
3127   }
3128
3129   /**
3130    * single thread that handles display of dialogs to user.
3131    */
3132   ExecutorService dialogExecutor = Executors.newSingleThreadExecutor();
3133
3134   /**
3135    * flag indicating if dialogExecutor should try to acquire a permit
3136    */
3137   private volatile boolean dialogPause = true;
3138
3139   /**
3140    * pause the queue
3141    */
3142   private java.util.concurrent.Semaphore block = new Semaphore(0);
3143
3144   private static groovy.ui.Console groovyConsole;
3145
3146   /**
3147    * add another dialog thread to the queue
3148    *
3149    * @param prompter
3150    */
3151   public void addDialogThread(final Runnable prompter)
3152   {
3153     dialogExecutor.submit(new Runnable()
3154     {
3155       @Override
3156       public void run()
3157       {
3158         if (dialogPause)
3159         {
3160           try
3161           {
3162             block.acquire();
3163           } catch (InterruptedException x)
3164           {
3165           }
3166           ;
3167         }
3168         if (instance == null)
3169         {
3170           return;
3171         }
3172         try
3173         {
3174           SwingUtilities.invokeAndWait(prompter);
3175         } catch (Exception q)
3176         {
3177           Cache.log.warn("Unexpected Exception in dialog thread.", q);
3178         }
3179       }
3180     });
3181   }
3182
3183   public void startDialogQueue()
3184   {
3185     // set the flag so we don't pause waiting for another permit and semaphore
3186     // the current task to begin
3187     dialogPause = false;
3188     block.release();
3189   }
3190
3191   @Override
3192   protected void snapShotWindow_actionPerformed(ActionEvent e)
3193   {
3194     invalidate();
3195     File of;
3196     ImageMaker im = new jalview.util.ImageMaker(
3197             this, ImageMaker.TYPE.EPS, "View of Desktop", getWidth(),
3198             getHeight(), of = new File("Jalview_snapshot"
3199                     + System.currentTimeMillis() + ".eps"),
3200             "View of desktop", null, 0, false);
3201     try
3202     {
3203       paintAll(im.getGraphics());
3204       im.writeImage();
3205     } catch (Exception q)
3206     {
3207       Cache.log.error("Couldn't write snapshot to " + of.getAbsolutePath(),
3208               q);
3209       return;
3210     }
3211     Cache.log.info("Successfully written snapshot to file "
3212             + of.getAbsolutePath());
3213   }
3214
3215   /**
3216    * Explode the views in the given SplitFrame into separate SplitFrame windows.
3217    * This respects (remembers) any previous 'exploded geometry' i.e. the size
3218    * and location last time the view was expanded (if any). However it does not
3219    * remember the split pane divider location - this is set to match the
3220    * 'exploding' frame.
3221    *
3222    * @param sf
3223    */
3224   public void explodeViews(SplitFrame sf)
3225   {
3226     AlignFrame oldTopFrame = (AlignFrame) sf.getTopFrame();
3227     AlignFrame oldBottomFrame = (AlignFrame) sf.getBottomFrame();
3228     List<? extends AlignmentViewPanel> topPanels = oldTopFrame
3229             .getAlignPanels();
3230     List<? extends AlignmentViewPanel> bottomPanels = oldBottomFrame
3231             .getAlignPanels();
3232     int viewCount = topPanels.size();
3233     if (viewCount < 2)
3234     {
3235       return;
3236     }
3237
3238     /*
3239      * Processing in reverse order works, forwards order leaves the first panels
3240      * not visible. I don't know why!
3241      */
3242     for (int i = viewCount - 1; i >= 0; i--)
3243     {
3244       /*
3245        * Make new top and bottom frames. These take over the respective
3246        * AlignmentPanel objects, including their AlignmentViewports, so the
3247        * cdna/protein relationships between the viewports is carried over to the
3248        * new split frames.
3249        *
3250        * explodedGeometry holds the (x, y) position of the previously exploded
3251        * SplitFrame, and the (width, height) of the AlignFrame component
3252        */
3253       AlignmentPanel topPanel = (AlignmentPanel) topPanels.get(i);
3254       AlignFrame newTopFrame = new AlignFrame(topPanel);
3255       newTopFrame.setSize(oldTopFrame.getSize());
3256       newTopFrame.setVisible(true);
3257       Rectangle geometry = ((AlignViewport) topPanel.getAlignViewport())
3258               .getExplodedGeometry();
3259       if (geometry != null)
3260       {
3261         newTopFrame.setSize(geometry.getSize());
3262       }
3263
3264       AlignmentPanel bottomPanel = (AlignmentPanel) bottomPanels.get(i);
3265       AlignFrame newBottomFrame = new AlignFrame(bottomPanel);
3266       newBottomFrame.setSize(oldBottomFrame.getSize());
3267       newBottomFrame.setVisible(true);
3268       geometry = ((AlignViewport) bottomPanel.getAlignViewport())
3269               .getExplodedGeometry();
3270       if (geometry != null)
3271       {
3272         newBottomFrame.setSize(geometry.getSize());
3273       }
3274
3275       topPanel.av.setGatherViewsHere(false);
3276       bottomPanel.av.setGatherViewsHere(false);
3277       JInternalFrame splitFrame = new SplitFrame(newTopFrame,
3278               newBottomFrame);
3279       if (geometry != null)
3280       {
3281         splitFrame.setLocation(geometry.getLocation());
3282       }
3283       Desktop.addInternalFrame(splitFrame, sf.getTitle(), -1, -1);
3284     }
3285
3286     /*
3287      * Clear references to the panels (now relocated in the new SplitFrames)
3288      * before closing the old SplitFrame.
3289      */
3290     topPanels.clear();
3291     bottomPanels.clear();
3292     sf.close();
3293   }
3294
3295   /**
3296    * Gather expanded split frames, sharing the same pairs of sequence set ids,
3297    * back into the given SplitFrame as additional views. Note that the gathered
3298    * frames may themselves have multiple views.
3299    *
3300    * @param source
3301    */
3302   public void gatherViews(GSplitFrame source)
3303   {
3304     /*
3305      * special handling of explodedGeometry for a view within a SplitFrame: - it
3306      * holds the (x, y) position of the enclosing SplitFrame, and the (width,
3307      * height) of the AlignFrame component
3308      */
3309     AlignFrame myTopFrame = (AlignFrame) source.getTopFrame();
3310     AlignFrame myBottomFrame = (AlignFrame) source.getBottomFrame();
3311     myTopFrame.viewport.setExplodedGeometry(new Rectangle(source.getX(),
3312             source.getY(), myTopFrame.getWidth(), myTopFrame.getHeight()));
3313     myBottomFrame.viewport
3314             .setExplodedGeometry(new Rectangle(source.getX(), source.getY(),
3315                     myBottomFrame.getWidth(), myBottomFrame.getHeight()));
3316     myTopFrame.viewport.setGatherViewsHere(true);
3317     myBottomFrame.viewport.setGatherViewsHere(true);
3318     String topViewId = myTopFrame.viewport.getSequenceSetId();
3319     String bottomViewId = myBottomFrame.viewport.getSequenceSetId();
3320
3321     JInternalFrame[] frames = desktop.getAllFrames();
3322     for (JInternalFrame frame : frames)
3323     {
3324       if (frame instanceof SplitFrame && frame != source)
3325       {
3326         SplitFrame sf = (SplitFrame) frame;
3327         AlignFrame topFrame = (AlignFrame) sf.getTopFrame();
3328         AlignFrame bottomFrame = (AlignFrame) sf.getBottomFrame();
3329         boolean gatherThis = false;
3330         for (int a = 0; a < topFrame.alignPanels.size(); a++)
3331         {
3332           AlignmentPanel topPanel = topFrame.alignPanels.get(a);
3333           AlignmentPanel bottomPanel = bottomFrame.alignPanels.get(a);
3334           if (topViewId.equals(topPanel.av.getSequenceSetId())
3335                   && bottomViewId.equals(bottomPanel.av.getSequenceSetId()))
3336           {
3337             gatherThis = true;
3338             topPanel.av.setGatherViewsHere(false);
3339             bottomPanel.av.setGatherViewsHere(false);
3340             topPanel.av.setExplodedGeometry(
3341                     new Rectangle(sf.getLocation(), topFrame.getSize()));
3342             bottomPanel.av.setExplodedGeometry(
3343                     new Rectangle(sf.getLocation(), bottomFrame.getSize()));
3344             myTopFrame.addAlignmentPanel(topPanel, false);
3345             myBottomFrame.addAlignmentPanel(bottomPanel, false);
3346           }
3347         }
3348
3349         if (gatherThis)
3350         {
3351           topFrame.getAlignPanels().clear();
3352           bottomFrame.getAlignPanels().clear();
3353           sf.close();
3354         }
3355       }
3356     }
3357
3358     /*
3359      * The dust settles...give focus to the tab we did this from.
3360      */
3361     myTopFrame.setDisplayedView(myTopFrame.alignPanel);
3362   }
3363
3364   public static groovy.ui.Console getGroovyConsole()
3365   {
3366     return groovyConsole;
3367   }
3368
3369   /**
3370    * handles the payload of a drag and drop event.
3371    *
3372    * TODO refactor to desktop utilities class
3373    *
3374    * @param files
3375    *          - Data source strings extracted from the drop event
3376    * @param protocols
3377    *          - protocol for each data source extracted from the drop event
3378    * @param evt
3379    *          - the drop event
3380    * @param t
3381    *          - the payload from the drop event
3382    * @throws Exception
3383    */
3384   public static void transferFromDropTarget(List<String> files,
3385           List<DataSourceType> protocols, DropTargetDropEvent evt,
3386           Transferable t) throws Exception
3387   {
3388
3389     DataFlavor uriListFlavor = new DataFlavor(
3390             "text/uri-list;class=java.lang.String"), urlFlavour = null;
3391     try
3392     {
3393       urlFlavour = new DataFlavor(
3394               "application/x-java-url; class=java.net.URL");
3395     } catch (ClassNotFoundException cfe)
3396     {
3397       Cache.log.debug("Couldn't instantiate the URL dataflavor.", cfe);
3398     }
3399
3400     if (urlFlavour != null && t.isDataFlavorSupported(urlFlavour))
3401     {
3402
3403       try
3404       {
3405         java.net.URL url = (URL) t.getTransferData(urlFlavour);
3406         // nb: java 8 osx bug https://bugs.openjdk.java.net/browse/JDK-8156099
3407         // means url may be null.
3408         if (url != null)
3409         {
3410           protocols.add(DataSourceType.URL);
3411           files.add(url.toString());
3412           Cache.log.debug("Drop handled as URL dataflavor "
3413                   + files.get(files.size() - 1));
3414           return;
3415         }
3416         else
3417         {
3418           if (Platform.isAMac())
3419           {
3420             System.err.println(
3421                     "Please ignore plist error - occurs due to problem with java 8 on OSX");
3422           }
3423           ;
3424         }
3425       } catch (Throwable ex)
3426       {
3427         Cache.log.debug("URL drop handler failed.", ex);
3428       }
3429     }
3430     if (t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
3431     {
3432       // Works on Windows and MacOSX
3433       Cache.log.debug("Drop handled as javaFileListFlavor");
3434       for (Object file : (List) t
3435               .getTransferData(DataFlavor.javaFileListFlavor))
3436       {
3437         files.add(((File) file).toString());
3438         protocols.add(DataSourceType.FILE);
3439       }
3440     }
3441     else
3442     {
3443       // Unix like behaviour
3444       boolean added = false;
3445       String data = null;
3446       if (t.isDataFlavorSupported(uriListFlavor))
3447       {
3448         Cache.log.debug("Drop handled as uriListFlavor");
3449         // This is used by Unix drag system
3450         data = (String) t.getTransferData(uriListFlavor);
3451       }
3452       if (data == null)
3453       {
3454         // fallback to text: workaround - on OSX where there's a JVM bug
3455         Cache.log.debug("standard URIListFlavor failed. Trying text");
3456         // try text fallback
3457         DataFlavor textDf = new DataFlavor(
3458                 "text/plain;class=java.lang.String");
3459         if (t.isDataFlavorSupported(textDf))
3460         {
3461           data = (String) t.getTransferData(textDf);
3462         }
3463
3464         Cache.log.debug("Plain text drop content returned "
3465                 + (data == null ? "Null - failed" : data));
3466
3467       }
3468       if (data != null)
3469       {
3470         while (protocols.size() < files.size())
3471         {
3472           Cache.log.debug("Adding missing FILE protocol for "
3473                   + files.get(protocols.size()));
3474           protocols.add(DataSourceType.FILE);
3475         }
3476         for (java.util.StringTokenizer st = new java.util.StringTokenizer(
3477                 data, "\r\n"); st.hasMoreTokens();)
3478         {
3479           added = true;
3480           String s = st.nextToken();
3481           if (s.startsWith("#"))
3482           {
3483             // the line is a comment (as per the RFC 2483)
3484             continue;
3485           }
3486           java.net.URI uri = new java.net.URI(s);
3487           if (uri.getScheme().toLowerCase().startsWith("http"))
3488           {
3489             protocols.add(DataSourceType.URL);
3490             files.add(uri.toString());
3491           }
3492           else
3493           {
3494             // otherwise preserve old behaviour: catch all for file objects
3495             java.io.File file = new java.io.File(uri);
3496             protocols.add(DataSourceType.FILE);
3497             files.add(file.toString());
3498           }
3499         }
3500       }
3501
3502       if (Cache.log.isDebugEnabled())
3503       {
3504         if (data == null || !added)
3505         {
3506
3507           if (t.getTransferDataFlavors() != null
3508                   && t.getTransferDataFlavors().length > 0)
3509           {
3510             Cache.log.debug(
3511                     "Couldn't resolve drop data. Here are the supported flavors:");
3512             for (DataFlavor fl : t.getTransferDataFlavors())
3513             {
3514               Cache.log.debug(
3515                       "Supported transfer dataflavor: " + fl.toString());
3516               Object df = t.getTransferData(fl);
3517               if (df != null)
3518               {
3519                 Cache.log.debug("Retrieves: " + df);
3520               }
3521               else
3522               {
3523                 Cache.log.debug("Retrieved nothing");
3524               }
3525             }
3526           }
3527           else
3528           {
3529             Cache.log.debug("Couldn't resolve dataflavor for drop: "
3530                     + t.toString());
3531           }
3532         }
3533       }
3534     }
3535     if (Platform.isWindows())
3536
3537     {
3538       Cache.log.debug("Scanning dropped content for Windows Link Files");
3539
3540       // resolve any .lnk files in the file drop
3541       for (int f = 0; f < files.size(); f++)
3542       {
3543         String source = files.get(f).toLowerCase();
3544         if (protocols.get(f).equals(DataSourceType.FILE)
3545                 && (source.endsWith(".lnk") || source.endsWith(".url")
3546                         || source.endsWith(".site")))
3547         {
3548           try
3549           {
3550             File lf = new File(files.get(f));
3551             // process link file to get a URL
3552             Cache.log.debug("Found potential link file: " + lf);
3553             WindowsShortcut wscfile = new WindowsShortcut(lf);
3554             String fullname = wscfile.getRealFilename();
3555             protocols.set(f, FormatAdapter.checkProtocol(fullname));
3556             files.set(f, fullname);
3557             Cache.log.debug("Parsed real filename " + fullname
3558                     + " to extract protocol: " + protocols.get(f));
3559           } catch (Exception ex)
3560           {
3561             Cache.log.error(
3562                     "Couldn't parse " + files.get(f) + " as a link file.",
3563                     ex);
3564           }
3565         }
3566       }
3567     }
3568   }
3569
3570   /**
3571    * Sets the Preferences property for experimental features to True or False
3572    * depending on the state of the controlling menu item
3573    */
3574   @Override
3575   protected void showExperimental_actionPerformed(boolean selected)
3576   {
3577     Cache.setProperty(EXPERIMENTAL_FEATURES, Boolean.toString(selected));
3578   }
3579
3580   /**
3581    * Answers a (possibly empty) list of any structure viewer frames (currently
3582    * for either Jmol or Chimera) which are currently open. This may optionally
3583    * be restricted to viewers of a specified class, or viewers linked to a
3584    * specified alignment panel.
3585    *
3586    * @param apanel
3587    *          if not null, only return viewers linked to this panel
3588    * @param structureViewerClass
3589    *          if not null, only return viewers of this class
3590    * @return
3591    */
3592   public List<StructureViewerBase> getStructureViewers(
3593           AlignmentPanel apanel,
3594           Class<? extends StructureViewerBase> structureViewerClass)
3595   {
3596     List<StructureViewerBase> result = new ArrayList<>();
3597     JInternalFrame[] frames = Desktop.instance.getAllFrames();
3598
3599     for (JInternalFrame frame : frames)
3600     {
3601       if (frame instanceof StructureViewerBase)
3602       {
3603         if (structureViewerClass == null
3604                 || structureViewerClass.isInstance(frame))
3605         {
3606           if (apanel == null
3607                   || ((StructureViewerBase) frame).isLinkedWith(apanel))
3608           {
3609             result.add((StructureViewerBase) frame);
3610           }
3611         }
3612       }
3613     }
3614     return result;
3615   }
3616 }