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);
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");
1718     chooser.setFileView(new JalviewFileView());
1719     chooser.setDialogTitle(MessageManager.getString("label.restore_state"));
1720
1721     int value = chooser.showOpenDialog(this);
1722
1723     if (value == JalviewFileChooser.APPROVE_OPTION)
1724     {
1725       final File selectedFile = chooser.getSelectedFile();
1726       setProjectFile(selectedFile);
1727       final String choice = selectedFile.getAbsolutePath();
1728       Cache.setProperty("LAST_DIRECTORY", selectedFile.getParent());
1729       new Thread(new Runnable()
1730       {
1731         @Override
1732         public void run()
1733         {
1734           setProgressBar(MessageManager.formatMessage(
1735                   "label.loading_jalview_project", new Object[]
1736                   { choice }), choice.hashCode());
1737           try
1738           {
1739             new Jalview2XML().loadJalviewAlign(choice);
1740           } catch (OutOfMemoryError oom)
1741           {
1742             new OOMWarning("Whilst loading project from " + choice, oom);
1743           } catch (Exception ex)
1744           {
1745             Cache.log.error(
1746                     "Problems whilst loading project from " + choice, ex);
1747             JvOptionPane.showMessageDialog(Desktop.desktop,
1748                     MessageManager.formatMessage(
1749                             "label.error_whilst_loading_project_from",
1750                             new Object[]
1751                             { choice }),
1752                     MessageManager.getString("label.couldnt_load_project"),
1753                     JvOptionPane.WARNING_MESSAGE);
1754           }
1755           setProgressBar(null, choice.hashCode());
1756         }
1757       }).start();
1758     }
1759   }
1760
1761   @Override
1762   public void inputSequence_actionPerformed(ActionEvent e)
1763   {
1764     new SequenceFetcher(this);
1765   }
1766
1767   JPanel progressPanel;
1768
1769   ArrayList<JPanel> fileLoadingPanels = new ArrayList<>();
1770
1771   public void startLoading(final String fileName)
1772   {
1773     if (fileLoadingCount == 0)
1774     {
1775       fileLoadingPanels.add(addProgressPanel(MessageManager
1776               .formatMessage("label.loading_file", new Object[]
1777               { fileName })));
1778     }
1779     fileLoadingCount++;
1780   }
1781
1782   private JPanel addProgressPanel(String string)
1783   {
1784     if (progressPanel == null)
1785     {
1786       progressPanel = new JPanel(new GridLayout(1, 1));
1787       totalProgressCount = 0;
1788       instance.getContentPane().add(progressPanel, BorderLayout.SOUTH);
1789     }
1790     JPanel thisprogress = new JPanel(new BorderLayout(10, 5));
1791     JProgressBar progressBar = new JProgressBar();
1792     progressBar.setIndeterminate(true);
1793
1794     thisprogress.add(new JLabel(string), BorderLayout.WEST);
1795
1796     thisprogress.add(progressBar, BorderLayout.CENTER);
1797     progressPanel.add(thisprogress);
1798     ((GridLayout) progressPanel.getLayout()).setRows(
1799             ((GridLayout) progressPanel.getLayout()).getRows() + 1);
1800     ++totalProgressCount;
1801     instance.validate();
1802     return thisprogress;
1803   }
1804
1805   int totalProgressCount = 0;
1806
1807   private void removeProgressPanel(JPanel progbar)
1808   {
1809     if (progressPanel != null)
1810     {
1811       synchronized (progressPanel)
1812       {
1813         progressPanel.remove(progbar);
1814         GridLayout gl = (GridLayout) progressPanel.getLayout();
1815         gl.setRows(gl.getRows() - 1);
1816         if (--totalProgressCount < 1)
1817         {
1818           this.getContentPane().remove(progressPanel);
1819           progressPanel = null;
1820         }
1821       }
1822     }
1823     validate();
1824   }
1825
1826   public void stopLoading()
1827   {
1828     fileLoadingCount--;
1829     if (fileLoadingCount < 1)
1830     {
1831       while (fileLoadingPanels.size() > 0)
1832       {
1833         removeProgressPanel(fileLoadingPanels.remove(0));
1834       }
1835       fileLoadingPanels.clear();
1836       fileLoadingCount = 0;
1837     }
1838     validate();
1839   }
1840
1841   public static int getViewCount(String alignmentId)
1842   {
1843     AlignmentViewport[] aps = getViewports(alignmentId);
1844     return (aps == null) ? 0 : aps.length;
1845   }
1846
1847   /**
1848    *
1849    * @param alignmentId
1850    *          - if null, all sets are returned
1851    * @return all AlignmentPanels concerning the alignmentId sequence set
1852    */
1853   public static AlignmentPanel[] getAlignmentPanels(String alignmentId)
1854   {
1855     if (Desktop.desktop == null)
1856     {
1857       // no frames created and in headless mode
1858       // TODO: verify that frames are recoverable when in headless mode
1859       return null;
1860     }
1861     List<AlignmentPanel> aps = new ArrayList<>();
1862     AlignFrame[] frames = getAlignFrames();
1863     if (frames == null)
1864     {
1865       return null;
1866     }
1867     for (AlignFrame af : frames)
1868     {
1869       for (AlignmentPanel ap : af.alignPanels)
1870       {
1871         if (alignmentId == null
1872                 || alignmentId.equals(ap.av.getSequenceSetId()))
1873         {
1874           aps.add(ap);
1875         }
1876       }
1877     }
1878     if (aps.size() == 0)
1879     {
1880       return null;
1881     }
1882     AlignmentPanel[] vap = aps.toArray(new AlignmentPanel[aps.size()]);
1883     return vap;
1884   }
1885
1886   /**
1887    * get all the viewports on an alignment.
1888    *
1889    * @param sequenceSetId
1890    *          unique alignment id (may be null - all viewports returned in that
1891    *          case)
1892    * @return all viewports on the alignment bound to sequenceSetId
1893    */
1894   public static AlignmentViewport[] getViewports(String sequenceSetId)
1895   {
1896     List<AlignmentViewport> viewp = new ArrayList<>();
1897     if (desktop != null)
1898     {
1899       AlignFrame[] frames = Desktop.getAlignFrames();
1900
1901       for (AlignFrame afr : frames)
1902       {
1903         if (sequenceSetId == null || afr.getViewport().getSequenceSetId()
1904                 .equals(sequenceSetId))
1905         {
1906           if (afr.alignPanels != null)
1907           {
1908             for (AlignmentPanel ap : afr.alignPanels)
1909             {
1910               if (sequenceSetId == null
1911                       || sequenceSetId.equals(ap.av.getSequenceSetId()))
1912               {
1913                 viewp.add(ap.av);
1914               }
1915             }
1916           }
1917           else
1918           {
1919             viewp.add(afr.getViewport());
1920           }
1921         }
1922       }
1923       if (viewp.size() > 0)
1924       {
1925         return viewp.toArray(new AlignmentViewport[viewp.size()]);
1926       }
1927     }
1928     return null;
1929   }
1930
1931   /**
1932    * Explode the views in the given frame into separate AlignFrame
1933    *
1934    * @param af
1935    */
1936   public static void explodeViews(AlignFrame af)
1937   {
1938     int size = af.alignPanels.size();
1939     if (size < 2)
1940     {
1941       return;
1942     }
1943
1944     for (int i = 0; i < size; i++)
1945     {
1946       AlignmentPanel ap = af.alignPanels.get(i);
1947       AlignFrame newaf = new AlignFrame(ap);
1948
1949       /*
1950        * Restore the view's last exploded frame geometry if known. Multiple
1951        * views from one exploded frame share and restore the same (frame)
1952        * position and size.
1953        */
1954       Rectangle geometry = ap.av.getExplodedGeometry();
1955       if (geometry != null)
1956       {
1957         newaf.setBounds(geometry);
1958       }
1959
1960       ap.av.setGatherViewsHere(false);
1961
1962       addInternalFrame(newaf, af.getTitle(), AlignFrame.DEFAULT_WIDTH,
1963               AlignFrame.DEFAULT_HEIGHT);
1964     }
1965
1966     af.alignPanels.clear();
1967     af.closeMenuItem_actionPerformed(true);
1968
1969   }
1970
1971   /**
1972    * Gather expanded views (separate AlignFrame's) with the same sequence set
1973    * identifier back in to this frame as additional views, and close the
1974    * expanded views. Note the expanded frames may themselves have multiple
1975    * views. We take the lot.
1976    *
1977    * @param source
1978    */
1979   public void gatherViews(AlignFrame source)
1980   {
1981     source.viewport.setGatherViewsHere(true);
1982     source.viewport.setExplodedGeometry(source.getBounds());
1983     JInternalFrame[] frames = desktop.getAllFrames();
1984     String viewId = source.viewport.getSequenceSetId();
1985
1986     for (int t = 0; t < frames.length; t++)
1987     {
1988       if (frames[t] instanceof AlignFrame && frames[t] != source)
1989       {
1990         AlignFrame af = (AlignFrame) frames[t];
1991         boolean gatherThis = false;
1992         for (int a = 0; a < af.alignPanels.size(); a++)
1993         {
1994           AlignmentPanel ap = af.alignPanels.get(a);
1995           if (viewId.equals(ap.av.getSequenceSetId()))
1996           {
1997             gatherThis = true;
1998             ap.av.setGatherViewsHere(false);
1999             ap.av.setExplodedGeometry(af.getBounds());
2000             source.addAlignmentPanel(ap, false);
2001           }
2002         }
2003
2004         if (gatherThis)
2005         {
2006           af.alignPanels.clear();
2007           af.closeMenuItem_actionPerformed(true);
2008         }
2009       }
2010     }
2011
2012   }
2013
2014   jalview.gui.VamsasApplication v_client = null;
2015
2016   @Override
2017   public void vamsasImport_actionPerformed(ActionEvent e)
2018   {
2019     if (v_client == null)
2020     {
2021       // Load and try to start a session.
2022       JalviewFileChooser chooser = new JalviewFileChooser(
2023               jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
2024
2025       chooser.setFileView(new JalviewFileView());
2026       chooser.setDialogTitle(
2027               MessageManager.getString("label.open_saved_vamsas_session"));
2028       chooser.setToolTipText(MessageManager.getString(
2029               "label.select_vamsas_session_opened_as_new_vamsas_session"));
2030
2031       int value = chooser.showOpenDialog(this);
2032
2033       if (value == JalviewFileChooser.APPROVE_OPTION)
2034       {
2035         String fle = chooser.getSelectedFile().toString();
2036         if (!vamsasImport(chooser.getSelectedFile()))
2037         {
2038           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2039                   MessageManager.formatMessage(
2040                           "label.couldnt_import_as_vamsas_session",
2041                           new Object[]
2042                           { fle }),
2043                   MessageManager
2044                           .getString("label.vamsas_document_import_failed"),
2045                   JvOptionPane.ERROR_MESSAGE);
2046         }
2047       }
2048     }
2049     else
2050     {
2051       jalview.bin.Cache.log.error(
2052               "Implementation error - load session from a running session is not supported.");
2053     }
2054   }
2055
2056   /**
2057    * import file into a new vamsas session (uses jalview.gui.VamsasApplication)
2058    *
2059    * @param file
2060    * @return true if import was a success and a session was started.
2061    */
2062   public boolean vamsasImport(URL url)
2063   {
2064     // TODO: create progress bar
2065     if (v_client != null)
2066     {
2067
2068       jalview.bin.Cache.log.error(
2069               "Implementation error - load session from a running session is not supported.");
2070       return false;
2071     }
2072
2073     try
2074     {
2075       // copy the URL content to a temporary local file
2076       // TODO: be a bit cleverer here with nio (?!)
2077       File file = File.createTempFile("vdocfromurl", ".vdj");
2078       FileOutputStream fos = new FileOutputStream(file);
2079       BufferedInputStream bis = new BufferedInputStream(url.openStream());
2080       byte[] buffer = new byte[2048];
2081       int ln;
2082       while ((ln = bis.read(buffer)) > -1)
2083       {
2084         fos.write(buffer, 0, ln);
2085       }
2086       bis.close();
2087       fos.close();
2088       v_client = new jalview.gui.VamsasApplication(this, file,
2089               url.toExternalForm());
2090     } catch (Exception ex)
2091     {
2092       jalview.bin.Cache.log.error(
2093               "Failed to create new vamsas session from contents of URL "
2094                       + url,
2095               ex);
2096       return false;
2097     }
2098     setupVamsasConnectedGui();
2099     v_client.initial_update(); // TODO: thread ?
2100     return v_client.inSession();
2101   }
2102
2103   /**
2104    * import file into a new vamsas session (uses jalview.gui.VamsasApplication)
2105    *
2106    * @param file
2107    * @return true if import was a success and a session was started.
2108    */
2109   public boolean vamsasImport(File file)
2110   {
2111     if (v_client != null)
2112     {
2113
2114       jalview.bin.Cache.log.error(
2115               "Implementation error - load session from a running session is not supported.");
2116       return false;
2117     }
2118
2119     setProgressBar(MessageManager.formatMessage(
2120             "status.importing_vamsas_session_from", new Object[]
2121             { file.getName() }), file.hashCode());
2122     try
2123     {
2124       v_client = new jalview.gui.VamsasApplication(this, file, null);
2125     } catch (Exception ex)
2126     {
2127       setProgressBar(MessageManager.formatMessage(
2128               "status.importing_vamsas_session_from", new Object[]
2129               { file.getName() }), file.hashCode());
2130       jalview.bin.Cache.log.error(
2131               "New vamsas session from existing session file failed:", ex);
2132       return false;
2133     }
2134     setupVamsasConnectedGui();
2135     v_client.initial_update(); // TODO: thread ?
2136     setProgressBar(MessageManager.formatMessage(
2137             "status.importing_vamsas_session_from", new Object[]
2138             { file.getName() }), file.hashCode());
2139     return v_client.inSession();
2140   }
2141
2142   public boolean joinVamsasSession(String mysesid)
2143   {
2144     if (v_client != null)
2145     {
2146       throw new Error(MessageManager
2147               .getString("error.try_join_vamsas_session_another"));
2148     }
2149     if (mysesid == null)
2150     {
2151       throw new Error(
2152               MessageManager.getString("error.invalid_vamsas_session_id"));
2153     }
2154     v_client = new VamsasApplication(this, mysesid);
2155     setupVamsasConnectedGui();
2156     v_client.initial_update();
2157     return (v_client.inSession());
2158   }
2159
2160   @Override
2161   public void vamsasStart_actionPerformed(ActionEvent e)
2162   {
2163     if (v_client == null)
2164     {
2165       // Start a session.
2166       // we just start a default session for moment.
2167       /*
2168        * JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.
2169        * getProperty("LAST_DIRECTORY"));
2170        *
2171        * chooser.setFileView(new JalviewFileView());
2172        * chooser.setDialogTitle("Load Vamsas file");
2173        * chooser.setToolTipText("Import");
2174        *
2175        * int value = chooser.showOpenDialog(this);
2176        *
2177        * if (value == JalviewFileChooser.APPROVE_OPTION) { v_client = new
2178        * jalview.gui.VamsasApplication(this, chooser.getSelectedFile());
2179        */
2180       v_client = new VamsasApplication(this);
2181       setupVamsasConnectedGui();
2182       v_client.initial_update(); // TODO: thread ?
2183     }
2184     else
2185     {
2186       // store current data in session.
2187       v_client.push_update(); // TODO: thread
2188     }
2189   }
2190
2191   protected void setupVamsasConnectedGui()
2192   {
2193     vamsasStart.setText(MessageManager.getString("label.session_update"));
2194     vamsasSave.setVisible(true);
2195     vamsasStop.setVisible(true);
2196     vamsasImport.setVisible(false); // Document import to existing session is
2197     // not possible for vamsas-client-1.0.
2198   }
2199
2200   protected void setupVamsasDisconnectedGui()
2201   {
2202     vamsasSave.setVisible(false);
2203     vamsasStop.setVisible(false);
2204     vamsasImport.setVisible(true);
2205     vamsasStart
2206             .setText(MessageManager.getString("label.new_vamsas_session"));
2207   }
2208
2209   @Override
2210   public void vamsasStop_actionPerformed(ActionEvent e)
2211   {
2212     if (v_client != null)
2213     {
2214       v_client.end_session();
2215       v_client = null;
2216       setupVamsasDisconnectedGui();
2217     }
2218   }
2219
2220   protected void buildVamsasStMenu()
2221   {
2222     if (v_client == null)
2223     {
2224       String[] sess = null;
2225       try
2226       {
2227         sess = VamsasApplication.getSessionList();
2228       } catch (Exception e)
2229       {
2230         jalview.bin.Cache.log.warn("Problem getting current sessions list.",
2231                 e);
2232         sess = null;
2233       }
2234       if (sess != null)
2235       {
2236         jalview.bin.Cache.log.debug(
2237                 "Got current sessions list: " + sess.length + " entries.");
2238         VamsasStMenu.removeAll();
2239         for (int i = 0; i < sess.length; i++)
2240         {
2241           JMenuItem sessit = new JMenuItem();
2242           sessit.setText(sess[i]);
2243           sessit.setToolTipText(MessageManager
2244                   .formatMessage("label.connect_to_session", new Object[]
2245                   { sess[i] }));
2246           final Desktop dsktp = this;
2247           final String mysesid = sess[i];
2248           sessit.addActionListener(new ActionListener()
2249           {
2250
2251             @Override
2252             public void actionPerformed(ActionEvent e)
2253             {
2254               if (dsktp.v_client == null)
2255               {
2256                 Thread rthr = new Thread(new Runnable()
2257                 {
2258
2259                   @Override
2260                   public void run()
2261                   {
2262                     dsktp.v_client = new VamsasApplication(dsktp, mysesid);
2263                     dsktp.setupVamsasConnectedGui();
2264                     dsktp.v_client.initial_update();
2265                   }
2266
2267                 });
2268                 rthr.start();
2269               }
2270             };
2271           });
2272           VamsasStMenu.add(sessit);
2273         }
2274         // don't show an empty menu.
2275         VamsasStMenu.setVisible(sess.length > 0);
2276
2277       }
2278       else
2279       {
2280         jalview.bin.Cache.log.debug("No current vamsas sessions.");
2281         VamsasStMenu.removeAll();
2282         VamsasStMenu.setVisible(false);
2283       }
2284     }
2285     else
2286     {
2287       // Not interested in the content. Just hide ourselves.
2288       VamsasStMenu.setVisible(false);
2289     }
2290   }
2291
2292   @Override
2293   public void vamsasSave_actionPerformed(ActionEvent e)
2294   {
2295     if (v_client != null)
2296     {
2297       // TODO: VAMSAS DOCUMENT EXTENSION is VDJ
2298       JalviewFileChooser chooser = new JalviewFileChooser("vdj",
2299               "Vamsas Document");
2300
2301       chooser.setFileView(new JalviewFileView());
2302       chooser.setDialogTitle(MessageManager
2303               .getString("label.save_vamsas_document_archive"));
2304
2305       int value = chooser.showSaveDialog(this);
2306
2307       if (value == JalviewFileChooser.APPROVE_OPTION)
2308       {
2309         java.io.File choice = chooser.getSelectedFile();
2310         JPanel progpanel = addProgressPanel(MessageManager
2311                 .formatMessage("label.saving_vamsas_doc", new Object[]
2312                 { choice.getName() }));
2313         Cache.setProperty("LAST_DIRECTORY", choice.getParent());
2314         String warnmsg = null;
2315         String warnttl = null;
2316         try
2317         {
2318           v_client.vclient.storeDocument(choice);
2319         } catch (Error ex)
2320         {
2321           warnttl = "Serious Problem saving Vamsas Document";
2322           warnmsg = ex.toString();
2323           jalview.bin.Cache.log
2324                   .error("Error Whilst saving document to " + choice, ex);
2325
2326         } catch (Exception ex)
2327         {
2328           warnttl = "Problem saving Vamsas Document.";
2329           warnmsg = ex.toString();
2330           jalview.bin.Cache.log.warn(
2331                   "Exception Whilst saving document to " + choice, ex);
2332
2333         }
2334         removeProgressPanel(progpanel);
2335         if (warnmsg != null)
2336         {
2337           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2338
2339                   warnmsg, warnttl, JvOptionPane.ERROR_MESSAGE);
2340         }
2341       }
2342     }
2343   }
2344
2345   JPanel vamUpdate = null;
2346
2347   /**
2348    * hide vamsas user gui bits when a vamsas document event is being handled.
2349    *
2350    * @param b
2351    *          true to hide gui, false to reveal gui
2352    */
2353   public void setVamsasUpdate(boolean b)
2354   {
2355     Cache.log.debug("Setting gui for Vamsas update "
2356             + (b ? "in progress" : "finished"));
2357
2358     if (vamUpdate != null)
2359     {
2360       this.removeProgressPanel(vamUpdate);
2361     }
2362     if (b)
2363     {
2364       vamUpdate = this.addProgressPanel(
2365               MessageManager.getString("label.updating_vamsas_session"));
2366     }
2367     vamsasStart.setVisible(!b);
2368     vamsasStop.setVisible(!b);
2369     vamsasSave.setVisible(!b);
2370   }
2371
2372   public JInternalFrame[] getAllFrames()
2373   {
2374     return desktop.getAllFrames();
2375   }
2376
2377   /**
2378    * Checks the given url to see if it gives a response indicating that the user
2379    * should be informed of a new questionnaire.
2380    *
2381    * @param url
2382    */
2383   public void checkForQuestionnaire(String url)
2384   {
2385     UserQuestionnaireCheck jvq = new UserQuestionnaireCheck(url);
2386     // javax.swing.SwingUtilities.invokeLater(jvq);
2387     new Thread(jvq).start();
2388   }
2389
2390   public void checkURLLinks()
2391   {
2392     // Thread off the URL link checker
2393     addDialogThread(new Runnable()
2394     {
2395       @Override
2396       public void run()
2397       {
2398         if (Cache.getDefault("CHECKURLLINKS", true))
2399         {
2400           // check what the actual links are - if it's just the default don't
2401           // bother with the warning
2402           List<String> links = Preferences.sequenceUrlLinks
2403                   .getLinksForMenu();
2404
2405           // only need to check links if there is one with a
2406           // SEQUENCE_ID which is not the default EMBL_EBI link
2407           ListIterator<String> li = links.listIterator();
2408           boolean check = false;
2409           List<JLabel> urls = new ArrayList<>();
2410           while (li.hasNext())
2411           {
2412             String link = li.next();
2413             if (link.contains(SEQUENCE_ID)
2414                     && !UrlConstants.isDefaultString(link))
2415             {
2416               check = true;
2417               int barPos = link.indexOf("|");
2418               String urlMsg = barPos == -1 ? link
2419                       : link.substring(0, barPos) + ": "
2420                               + link.substring(barPos + 1);
2421               urls.add(new JLabel(urlMsg));
2422             }
2423           }
2424           if (!check)
2425           {
2426             return;
2427           }
2428
2429           // ask user to check in case URL links use old style tokens
2430           // ($SEQUENCE_ID$ for sequence id _or_ accession id)
2431           JPanel msgPanel = new JPanel();
2432           msgPanel.setLayout(new BoxLayout(msgPanel, BoxLayout.PAGE_AXIS));
2433           msgPanel.add(Box.createVerticalGlue());
2434           JLabel msg = new JLabel(MessageManager
2435                   .getString("label.SEQUENCE_ID_for_DB_ACCESSION1"));
2436           JLabel msg2 = new JLabel(MessageManager
2437                   .getString("label.SEQUENCE_ID_for_DB_ACCESSION2"));
2438           msgPanel.add(msg);
2439           for (JLabel url : urls)
2440           {
2441             msgPanel.add(url);
2442           }
2443           msgPanel.add(msg2);
2444
2445           final JCheckBox jcb = new JCheckBox(
2446                   MessageManager.getString("label.do_not_display_again"));
2447           jcb.addActionListener(new ActionListener()
2448           {
2449             @Override
2450             public void actionPerformed(ActionEvent e)
2451             {
2452               // update Cache settings for "don't show this again"
2453               boolean showWarningAgain = !jcb.isSelected();
2454               Cache.setProperty("CHECKURLLINKS",
2455                       Boolean.valueOf(showWarningAgain).toString());
2456             }
2457           });
2458           msgPanel.add(jcb);
2459
2460           JvOptionPane.showMessageDialog(Desktop.desktop, msgPanel,
2461                   MessageManager
2462                           .getString("label.SEQUENCE_ID_no_longer_used"),
2463                   JvOptionPane.WARNING_MESSAGE);
2464         }
2465       }
2466     });
2467   }
2468
2469   /**
2470    * Proxy class for JDesktopPane which optionally displays the current memory
2471    * usage and highlights the desktop area with a red bar if free memory runs
2472    * low.
2473    *
2474    * @author AMW
2475    */
2476   public class MyDesktopPane extends JDesktopPane implements Runnable
2477   {
2478
2479     private static final float ONE_MB = 1048576f;
2480
2481     boolean showMemoryUsage = false;
2482
2483     Runtime runtime;
2484
2485     java.text.NumberFormat df;
2486
2487     float maxMemory, allocatedMemory, freeMemory, totalFreeMemory,
2488             percentUsage;
2489
2490     public MyDesktopPane(boolean showMemoryUsage)
2491     {
2492       showMemoryUsage(showMemoryUsage);
2493     }
2494
2495     public void showMemoryUsage(boolean showMemory)
2496     {
2497       this.showMemoryUsage = showMemory;
2498       if (showMemory)
2499       {
2500         Thread worker = new Thread(this);
2501         worker.start();
2502       }
2503       repaint();
2504     }
2505
2506     public boolean isShowMemoryUsage()
2507     {
2508       return showMemoryUsage;
2509     }
2510
2511     @Override
2512     public void run()
2513     {
2514       df = java.text.NumberFormat.getNumberInstance();
2515       df.setMaximumFractionDigits(2);
2516       runtime = Runtime.getRuntime();
2517
2518       while (showMemoryUsage)
2519       {
2520         try
2521         {
2522           maxMemory = runtime.maxMemory() / ONE_MB;
2523           allocatedMemory = runtime.totalMemory() / ONE_MB;
2524           freeMemory = runtime.freeMemory() / ONE_MB;
2525           totalFreeMemory = freeMemory + (maxMemory - allocatedMemory);
2526
2527           percentUsage = (totalFreeMemory / maxMemory) * 100;
2528
2529           // if (percentUsage < 20)
2530           {
2531             // border1 = BorderFactory.createMatteBorder(12, 12, 12, 12,
2532             // Color.red);
2533             // instance.set.setBorder(border1);
2534           }
2535           repaint();
2536           // sleep after showing usage
2537           Thread.sleep(3000);
2538         } catch (Exception ex)
2539         {
2540           ex.printStackTrace();
2541         }
2542       }
2543     }
2544
2545     @Override
2546     public void paintComponent(Graphics g)
2547     {
2548       if (showMemoryUsage && g != null && df != null)
2549       {
2550         if (percentUsage < 20)
2551         {
2552           g.setColor(Color.red);
2553         }
2554         FontMetrics fm = g.getFontMetrics();
2555         if (fm != null)
2556         {
2557           g.drawString(MessageManager.formatMessage("label.memory_stats",
2558                   new Object[]
2559                   { df.format(totalFreeMemory), df.format(maxMemory),
2560                       df.format(percentUsage) }),
2561                   10, getHeight() - fm.getHeight());
2562         }
2563       }
2564     }
2565   }
2566
2567   /**
2568    * Accessor method to quickly get all the AlignmentFrames loaded.
2569    *
2570    * @return an array of AlignFrame, or null if none found
2571    */
2572   public static AlignFrame[] getAlignFrames()
2573   {
2574     if (Jalview.isHeadlessMode())
2575     {
2576       // Desktop.desktop is null in headless mode
2577       return new AlignFrame[] { Jalview.currentAlignFrame };
2578     }
2579
2580     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2581
2582     if (frames == null)
2583     {
2584       return null;
2585     }
2586     List<AlignFrame> avp = new ArrayList<>();
2587     // REVERSE ORDER
2588     for (int i = frames.length - 1; i > -1; i--)
2589     {
2590       if (frames[i] instanceof AlignFrame)
2591       {
2592         avp.add((AlignFrame) frames[i]);
2593       }
2594       else if (frames[i] instanceof SplitFrame)
2595       {
2596         /*
2597          * Also check for a split frame containing an AlignFrame
2598          */
2599         GSplitFrame sf = (GSplitFrame) frames[i];
2600         if (sf.getTopFrame() instanceof AlignFrame)
2601         {
2602           avp.add((AlignFrame) sf.getTopFrame());
2603         }
2604         if (sf.getBottomFrame() instanceof AlignFrame)
2605         {
2606           avp.add((AlignFrame) sf.getBottomFrame());
2607         }
2608       }
2609     }
2610     if (avp.size() == 0)
2611     {
2612       return null;
2613     }
2614     AlignFrame afs[] = avp.toArray(new AlignFrame[avp.size()]);
2615     return afs;
2616   }
2617
2618   /**
2619    * Returns an array of any AppJmol frames in the Desktop (or null if none).
2620    *
2621    * @return
2622    */
2623   public GStructureViewer[] getJmols()
2624   {
2625     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
2626
2627     if (frames == null)
2628     {
2629       return null;
2630     }
2631     List<GStructureViewer> avp = new ArrayList<>();
2632     // REVERSE ORDER
2633     for (int i = frames.length - 1; i > -1; i--)
2634     {
2635       if (frames[i] instanceof AppJmol)
2636       {
2637         GStructureViewer af = (GStructureViewer) frames[i];
2638         avp.add(af);
2639       }
2640     }
2641     if (avp.size() == 0)
2642     {
2643       return null;
2644     }
2645     GStructureViewer afs[] = avp.toArray(new GStructureViewer[avp.size()]);
2646     return afs;
2647   }
2648
2649   /**
2650    * Add Groovy Support to Jalview
2651    */
2652   @Override
2653   public void groovyShell_actionPerformed()
2654   {
2655     try
2656     {
2657       openGroovyConsole();
2658     } catch (Exception ex)
2659     {
2660       jalview.bin.Cache.log.error("Groovy Shell Creation failed.", ex);
2661       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
2662
2663               MessageManager.getString("label.couldnt_create_groovy_shell"),
2664               MessageManager.getString("label.groovy_support_failed"),
2665               JvOptionPane.ERROR_MESSAGE);
2666     }
2667   }
2668
2669   /**
2670    * Open the Groovy console
2671    */
2672   void openGroovyConsole()
2673   {
2674     if (groovyConsole == null)
2675     {
2676       groovyConsole = new groovy.ui.Console();
2677       groovyConsole.setVariable("Jalview", this);
2678       groovyConsole.run();
2679
2680       /*
2681        * We allow only one console at a time, so that AlignFrame menu option
2682        * 'Calculate | Run Groovy script' is unambiguous.
2683        * Disable 'Groovy Console', and enable 'Run script', when the console is
2684        * opened, and the reverse when it is closed
2685        */
2686       Window window = (Window) groovyConsole.getFrame();
2687       window.addWindowListener(new WindowAdapter()
2688       {
2689         @Override
2690         public void windowClosed(WindowEvent e)
2691         {
2692           /*
2693            * rebind CMD-Q from Groovy Console to Jalview Quit
2694            */
2695           addQuitHandler();
2696           enableExecuteGroovy(false);
2697         }
2698       });
2699     }
2700
2701     /*
2702      * show Groovy console window (after close and reopen)
2703      */
2704     ((Window) groovyConsole.getFrame()).setVisible(true);
2705
2706     /*
2707      * if we got this far, enable 'Run Groovy' in AlignFrame menus
2708      * and disable opening a second console
2709      */
2710     enableExecuteGroovy(true);
2711   }
2712
2713   /**
2714    * Bind Ctrl/Cmd-Q to Quit - for reset as Groovy Console takes over this
2715    * binding when opened
2716    */
2717   protected void addQuitHandler()
2718   {
2719     getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
2720             .put(KeyStroke.getKeyStroke(KeyEvent.VK_Q,
2721                     Toolkit.getDefaultToolkit().getMenuShortcutKeyMask()),
2722                     "Quit");
2723     getRootPane().getActionMap().put("Quit", new AbstractAction()
2724     {
2725       @Override
2726       public void actionPerformed(ActionEvent e)
2727       {
2728         quit();
2729       }
2730     });
2731   }
2732
2733   /**
2734    * Enable or disable 'Run Groovy script' in AlignFrame calculate menus
2735    *
2736    * @param enabled
2737    *          true if Groovy console is open
2738    */
2739   public void enableExecuteGroovy(boolean enabled)
2740   {
2741     /*
2742      * disable opening a second Groovy console
2743      * (or re-enable when the console is closed)
2744      */
2745     groovyShell.setEnabled(!enabled);
2746
2747     AlignFrame[] alignFrames = getAlignFrames();
2748     if (alignFrames != null)
2749     {
2750       for (AlignFrame af : alignFrames)
2751       {
2752         af.setGroovyEnabled(enabled);
2753       }
2754     }
2755   }
2756
2757   /**
2758    * Progress bars managed by the IProgressIndicator method.
2759    */
2760   private Hashtable<Long, JPanel> progressBars;
2761
2762   private Hashtable<Long, IProgressIndicatorHandler> progressBarHandlers;
2763
2764   /*
2765    * (non-Javadoc)
2766    *
2767    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
2768    */
2769   @Override
2770   public void setProgressBar(String message, long id)
2771   {
2772     if (progressBars == null)
2773     {
2774       progressBars = new Hashtable<>();
2775       progressBarHandlers = new Hashtable<>();
2776     }
2777
2778     if (progressBars.get(new Long(id)) != null)
2779     {
2780       JPanel panel = progressBars.remove(new Long(id));
2781       if (progressBarHandlers.contains(new Long(id)))
2782       {
2783         progressBarHandlers.remove(new Long(id));
2784       }
2785       removeProgressPanel(panel);
2786     }
2787     else
2788     {
2789       progressBars.put(new Long(id), addProgressPanel(message));
2790     }
2791   }
2792
2793   /*
2794    * (non-Javadoc)
2795    *
2796    * @see jalview.gui.IProgressIndicator#registerHandler(long,
2797    * jalview.gui.IProgressIndicatorHandler)
2798    */
2799   @Override
2800   public void registerHandler(final long id,
2801           final IProgressIndicatorHandler handler)
2802   {
2803     if (progressBarHandlers == null
2804             || !progressBars.containsKey(new Long(id)))
2805     {
2806       throw new Error(MessageManager.getString(
2807               "error.call_setprogressbar_before_registering_handler"));
2808     }
2809     progressBarHandlers.put(new Long(id), handler);
2810     final JPanel progressPanel = progressBars.get(new Long(id));
2811     if (handler.canCancel())
2812     {
2813       JButton cancel = new JButton(
2814               MessageManager.getString("action.cancel"));
2815       final IProgressIndicator us = this;
2816       cancel.addActionListener(new ActionListener()
2817       {
2818
2819         @Override
2820         public void actionPerformed(ActionEvent e)
2821         {
2822           handler.cancelActivity(id);
2823           us.setProgressBar(MessageManager
2824                   .formatMessage("label.cancelled_params", new Object[]
2825                   { ((JLabel) progressPanel.getComponent(0)).getText() }),
2826                   id);
2827         }
2828       });
2829       progressPanel.add(cancel, BorderLayout.EAST);
2830     }
2831   }
2832
2833   /**
2834    *
2835    * @return true if any progress bars are still active
2836    */
2837   @Override
2838   public boolean operationInProgress()
2839   {
2840     if (progressBars != null && progressBars.size() > 0)
2841     {
2842       return true;
2843     }
2844     return false;
2845   }
2846
2847   /**
2848    * This will return the first AlignFrame holding the given viewport instance.
2849    * It will break if there are more than one AlignFrames viewing a particular
2850    * av.
2851    *
2852    * @param viewport
2853    * @return alignFrame for viewport
2854    */
2855   public static AlignFrame getAlignFrameFor(AlignViewportI viewport)
2856   {
2857     if (desktop != null)
2858     {
2859       AlignmentPanel[] aps = getAlignmentPanels(
2860               viewport.getSequenceSetId());
2861       for (int panel = 0; aps != null && panel < aps.length; panel++)
2862       {
2863         if (aps[panel] != null && aps[panel].av == viewport)
2864         {
2865           return aps[panel].alignFrame;
2866         }
2867       }
2868     }
2869     return null;
2870   }
2871
2872   public VamsasApplication getVamsasApplication()
2873   {
2874     return v_client;
2875
2876   }
2877
2878   /**
2879    * flag set if jalview GUI is being operated programmatically
2880    */
2881   private boolean inBatchMode = false;
2882
2883   /**
2884    * check if jalview GUI is being operated programmatically
2885    *
2886    * @return inBatchMode
2887    */
2888   public boolean isInBatchMode()
2889   {
2890     return inBatchMode;
2891   }
2892
2893   /**
2894    * set flag if jalview GUI is being operated programmatically
2895    *
2896    * @param inBatchMode
2897    */
2898   public void setInBatchMode(boolean inBatchMode)
2899   {
2900     this.inBatchMode = inBatchMode;
2901   }
2902
2903   public void startServiceDiscovery()
2904   {
2905     startServiceDiscovery(false);
2906   }
2907
2908   public void startServiceDiscovery(boolean blocking)
2909   {
2910     boolean alive = true;
2911     Thread t0 = null, t1 = null, t2 = null;
2912     // JAL-940 - JALVIEW 1 services are now being EOLed as of JABA 2.1 release
2913     if (true)
2914     {
2915       // todo: changesupport handlers need to be transferred
2916       if (discoverer == null)
2917       {
2918         discoverer = new jalview.ws.jws1.Discoverer();
2919         // register PCS handler for desktop.
2920         discoverer.addPropertyChangeListener(changeSupport);
2921       }
2922       // JAL-940 - disabled JWS1 service configuration - always start discoverer
2923       // until we phase out completely
2924       (t0 = new Thread(discoverer)).start();
2925     }
2926
2927     if (Cache.getDefault("SHOW_JWS2_SERVICES", true))
2928     {
2929       t2 = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2930               .startDiscoverer(changeSupport);
2931     }
2932     Thread t3 = null;
2933     {
2934       // TODO: do rest service discovery
2935     }
2936     if (blocking)
2937     {
2938       while (alive)
2939       {
2940         try
2941         {
2942           Thread.sleep(15);
2943         } catch (Exception e)
2944         {
2945         }
2946         alive = (t1 != null && t1.isAlive()) || (t2 != null && t2.isAlive())
2947                 || (t3 != null && t3.isAlive())
2948                 || (t0 != null && t0.isAlive());
2949       }
2950     }
2951   }
2952
2953   /**
2954    * called to check if the service discovery process completed successfully.
2955    *
2956    * @param evt
2957    */
2958   protected void JalviewServicesChanged(PropertyChangeEvent evt)
2959   {
2960     if (evt.getNewValue() == null || evt.getNewValue() instanceof Vector)
2961     {
2962       final String ermsg = jalview.ws.jws2.Jws2Discoverer.getDiscoverer()
2963               .getErrorMessages();
2964       if (ermsg != null)
2965       {
2966         if (Cache.getDefault("SHOW_WSDISCOVERY_ERRORS", true))
2967         {
2968           if (serviceChangedDialog == null)
2969           {
2970             // only run if we aren't already displaying one of these.
2971             addDialogThread(serviceChangedDialog = new Runnable()
2972             {
2973               @Override
2974               public void run()
2975               {
2976
2977                 /*
2978                  * JalviewDialog jd =new JalviewDialog() {
2979                  *
2980                  * @Override protected void cancelPressed() { // TODO
2981                  * Auto-generated method stub
2982                  *
2983                  * }@Override protected void okPressed() { // TODO
2984                  * Auto-generated method stub
2985                  *
2986                  * }@Override protected void raiseClosed() { // TODO
2987                  * Auto-generated method stub
2988                  *
2989                  * } }; jd.initDialogFrame(new
2990                  * JLabel("<html><table width=\"450\"><tr><td>" + ermsg +
2991                  * "<br/>It may be that you have invalid JABA URLs in your web service preferences,"
2992                  * + " or mis-configured HTTP proxy settings.<br/>" +
2993                  * "Check the <em>Connections</em> and <em>Web services</em> tab of the"
2994                  * +
2995                  * " Tools->Preferences dialog box to change them.</td></tr></table></html>"
2996                  * ), true, true, "Web Service Configuration Problem", 450,
2997                  * 400);
2998                  *
2999                  * jd.waitForInput();
3000                  */
3001                 JvOptionPane.showConfirmDialog(Desktop.desktop,
3002                         new JLabel("<html><table width=\"450\"><tr><td>"
3003                                 + ermsg + "</td></tr></table>"
3004                                 + "<p>It may be that you have invalid JABA URLs<br/>in your web service preferences,"
3005                                 + "<br>or as a command-line argument, or mis-configured HTTP proxy settings.</p>"
3006                                 + "<p>Check the <em>Connections</em> and <em>Web services</em> tab<br/>of the"
3007                                 + " Tools->Preferences dialog box to change them.</p></html>"),
3008                         "Web Service Configuration Problem",
3009                         JvOptionPane.DEFAULT_OPTION,
3010                         JvOptionPane.ERROR_MESSAGE);
3011                 serviceChangedDialog = null;
3012
3013               }
3014             });
3015           }
3016         }
3017         else
3018         {
3019           Cache.log.error(
3020                   "Errors reported by JABA discovery service. Check web services preferences.\n"
3021                           + ermsg);
3022         }
3023       }
3024     }
3025   }
3026
3027   private Runnable serviceChangedDialog = null;
3028
3029   /**
3030    * start a thread to open a URL in the configured browser. Pops up a warning
3031    * dialog to the user if there is an exception when calling out to the browser
3032    * to open the URL.
3033    *
3034    * @param url
3035    */
3036   public static void showUrl(final String url)
3037   {
3038     showUrl(url, Desktop.instance);
3039   }
3040
3041   /**
3042    * Like showUrl but allows progress handler to be specified
3043    *
3044    * @param url
3045    * @param progress
3046    *          (null) or object implementing IProgressIndicator
3047    */
3048   public static void showUrl(final String url,
3049           final IProgressIndicator progress)
3050   {
3051     new Thread(new Runnable()
3052     {
3053       @Override
3054       public void run()
3055       {
3056         try
3057         {
3058           if (progress != null)
3059           {
3060             progress.setProgressBar(MessageManager
3061                     .formatMessage("status.opening_params", new Object[]
3062                     { url }), this.hashCode());
3063           }
3064           jalview.util.BrowserLauncher.openURL(url);
3065         } catch (Exception ex)
3066         {
3067           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
3068                   MessageManager
3069                           .getString("label.web_browser_not_found_unix"),
3070                   MessageManager.getString("label.web_browser_not_found"),
3071                   JvOptionPane.WARNING_MESSAGE);
3072
3073           ex.printStackTrace();
3074         }
3075         if (progress != null)
3076         {
3077           progress.setProgressBar(null, this.hashCode());
3078         }
3079       }
3080     }).start();
3081   }
3082
3083   public static WsParamSetManager wsparamManager = null;
3084
3085   public static ParamManager getUserParameterStore()
3086   {
3087     if (wsparamManager == null)
3088     {
3089       wsparamManager = new WsParamSetManager();
3090     }
3091     return wsparamManager;
3092   }
3093
3094   /**
3095    * static hyperlink handler proxy method for use by Jalview's internal windows
3096    *
3097    * @param e
3098    */
3099   public static void hyperlinkUpdate(HyperlinkEvent e)
3100   {
3101     if (e.getEventType() == EventType.ACTIVATED)
3102     {
3103       String url = null;
3104       try
3105       {
3106         url = e.getURL().toString();
3107         Desktop.showUrl(url);
3108       } catch (Exception x)
3109       {
3110         if (url != null)
3111         {
3112           if (Cache.log != null)
3113           {
3114             Cache.log.error("Couldn't handle string " + url + " as a URL.");
3115           }
3116           else
3117           {
3118             System.err.println(
3119                     "Couldn't handle string " + url + " as a URL.");
3120           }
3121         }
3122         // ignore any exceptions due to dud links.
3123       }
3124
3125     }
3126   }
3127
3128   /**
3129    * single thread that handles display of dialogs to user.
3130    */
3131   ExecutorService dialogExecutor = Executors.newSingleThreadExecutor();
3132
3133   /**
3134    * flag indicating if dialogExecutor should try to acquire a permit
3135    */
3136   private volatile boolean dialogPause = true;
3137
3138   /**
3139    * pause the queue
3140    */
3141   private java.util.concurrent.Semaphore block = new Semaphore(0);
3142
3143   private static groovy.ui.Console groovyConsole;
3144
3145   /**
3146    * add another dialog thread to the queue
3147    *
3148    * @param prompter
3149    */
3150   public void addDialogThread(final Runnable prompter)
3151   {
3152     dialogExecutor.submit(new Runnable()
3153     {
3154       @Override
3155       public void run()
3156       {
3157         if (dialogPause)
3158         {
3159           try
3160           {
3161             block.acquire();
3162           } catch (InterruptedException x)
3163           {
3164           }
3165           ;
3166         }
3167         if (instance == null)
3168         {
3169           return;
3170         }
3171         try
3172         {
3173           SwingUtilities.invokeAndWait(prompter);
3174         } catch (Exception q)
3175         {
3176           Cache.log.warn("Unexpected Exception in dialog thread.", q);
3177         }
3178       }
3179     });
3180   }
3181
3182   public void startDialogQueue()
3183   {
3184     // set the flag so we don't pause waiting for another permit and semaphore
3185     // the current task to begin
3186     dialogPause = false;
3187     block.release();
3188   }
3189
3190   @Override
3191   protected void snapShotWindow_actionPerformed(ActionEvent e)
3192   {
3193     invalidate();
3194     File of;
3195     ImageMaker im = new jalview.util.ImageMaker(
3196             this, ImageMaker.TYPE.EPS, "View of Desktop", getWidth(),
3197             getHeight(), of = new File("Jalview_snapshot"
3198                     + System.currentTimeMillis() + ".eps"),
3199             "View of desktop", null, 0, false);
3200     try
3201     {
3202       paintAll(im.getGraphics());
3203       im.writeImage();
3204     } catch (Exception q)
3205     {
3206       Cache.log.error("Couldn't write snapshot to " + of.getAbsolutePath(),
3207               q);
3208       return;
3209     }
3210     Cache.log.info("Successfully written snapshot to file "
3211             + of.getAbsolutePath());
3212   }
3213
3214   /**
3215    * Explode the views in the given SplitFrame into separate SplitFrame windows.
3216    * This respects (remembers) any previous 'exploded geometry' i.e. the size
3217    * and location last time the view was expanded (if any). However it does not
3218    * remember the split pane divider location - this is set to match the
3219    * 'exploding' frame.
3220    *
3221    * @param sf
3222    */
3223   public void explodeViews(SplitFrame sf)
3224   {
3225     AlignFrame oldTopFrame = (AlignFrame) sf.getTopFrame();
3226     AlignFrame oldBottomFrame = (AlignFrame) sf.getBottomFrame();
3227     List<? extends AlignmentViewPanel> topPanels = oldTopFrame
3228             .getAlignPanels();
3229     List<? extends AlignmentViewPanel> bottomPanels = oldBottomFrame
3230             .getAlignPanels();
3231     int viewCount = topPanels.size();
3232     if (viewCount < 2)
3233     {
3234       return;
3235     }
3236
3237     /*
3238      * Processing in reverse order works, forwards order leaves the first panels
3239      * not visible. I don't know why!
3240      */
3241     for (int i = viewCount - 1; i >= 0; i--)
3242     {
3243       /*
3244        * Make new top and bottom frames. These take over the respective
3245        * AlignmentPanel objects, including their AlignmentViewports, so the
3246        * cdna/protein relationships between the viewports is carried over to the
3247        * new split frames.
3248        *
3249        * explodedGeometry holds the (x, y) position of the previously exploded
3250        * SplitFrame, and the (width, height) of the AlignFrame component
3251        */
3252       AlignmentPanel topPanel = (AlignmentPanel) topPanels.get(i);
3253       AlignFrame newTopFrame = new AlignFrame(topPanel);
3254       newTopFrame.setSize(oldTopFrame.getSize());
3255       newTopFrame.setVisible(true);
3256       Rectangle geometry = ((AlignViewport) topPanel.getAlignViewport())
3257               .getExplodedGeometry();
3258       if (geometry != null)
3259       {
3260         newTopFrame.setSize(geometry.getSize());
3261       }
3262
3263       AlignmentPanel bottomPanel = (AlignmentPanel) bottomPanels.get(i);
3264       AlignFrame newBottomFrame = new AlignFrame(bottomPanel);
3265       newBottomFrame.setSize(oldBottomFrame.getSize());
3266       newBottomFrame.setVisible(true);
3267       geometry = ((AlignViewport) bottomPanel.getAlignViewport())
3268               .getExplodedGeometry();
3269       if (geometry != null)
3270       {
3271         newBottomFrame.setSize(geometry.getSize());
3272       }
3273
3274       topPanel.av.setGatherViewsHere(false);
3275       bottomPanel.av.setGatherViewsHere(false);
3276       JInternalFrame splitFrame = new SplitFrame(newTopFrame,
3277               newBottomFrame);
3278       if (geometry != null)
3279       {
3280         splitFrame.setLocation(geometry.getLocation());
3281       }
3282       Desktop.addInternalFrame(splitFrame, sf.getTitle(), -1, -1);
3283     }
3284
3285     /*
3286      * Clear references to the panels (now relocated in the new SplitFrames)
3287      * before closing the old SplitFrame.
3288      */
3289     topPanels.clear();
3290     bottomPanels.clear();
3291     sf.close();
3292   }
3293
3294   /**
3295    * Gather expanded split frames, sharing the same pairs of sequence set ids,
3296    * back into the given SplitFrame as additional views. Note that the gathered
3297    * frames may themselves have multiple views.
3298    *
3299    * @param source
3300    */
3301   public void gatherViews(GSplitFrame source)
3302   {
3303     /*
3304      * special handling of explodedGeometry for a view within a SplitFrame: - it
3305      * holds the (x, y) position of the enclosing SplitFrame, and the (width,
3306      * height) of the AlignFrame component
3307      */
3308     AlignFrame myTopFrame = (AlignFrame) source.getTopFrame();
3309     AlignFrame myBottomFrame = (AlignFrame) source.getBottomFrame();
3310     myTopFrame.viewport.setExplodedGeometry(new Rectangle(source.getX(),
3311             source.getY(), myTopFrame.getWidth(), myTopFrame.getHeight()));
3312     myBottomFrame.viewport
3313             .setExplodedGeometry(new Rectangle(source.getX(), source.getY(),
3314                     myBottomFrame.getWidth(), myBottomFrame.getHeight()));
3315     myTopFrame.viewport.setGatherViewsHere(true);
3316     myBottomFrame.viewport.setGatherViewsHere(true);
3317     String topViewId = myTopFrame.viewport.getSequenceSetId();
3318     String bottomViewId = myBottomFrame.viewport.getSequenceSetId();
3319
3320     JInternalFrame[] frames = desktop.getAllFrames();
3321     for (JInternalFrame frame : frames)
3322     {
3323       if (frame instanceof SplitFrame && frame != source)
3324       {
3325         SplitFrame sf = (SplitFrame) frame;
3326         AlignFrame topFrame = (AlignFrame) sf.getTopFrame();
3327         AlignFrame bottomFrame = (AlignFrame) sf.getBottomFrame();
3328         boolean gatherThis = false;
3329         for (int a = 0; a < topFrame.alignPanels.size(); a++)
3330         {
3331           AlignmentPanel topPanel = topFrame.alignPanels.get(a);
3332           AlignmentPanel bottomPanel = bottomFrame.alignPanels.get(a);
3333           if (topViewId.equals(topPanel.av.getSequenceSetId())
3334                   && bottomViewId.equals(bottomPanel.av.getSequenceSetId()))
3335           {
3336             gatherThis = true;
3337             topPanel.av.setGatherViewsHere(false);
3338             bottomPanel.av.setGatherViewsHere(false);
3339             topPanel.av.setExplodedGeometry(
3340                     new Rectangle(sf.getLocation(), topFrame.getSize()));
3341             bottomPanel.av.setExplodedGeometry(
3342                     new Rectangle(sf.getLocation(), bottomFrame.getSize()));
3343             myTopFrame.addAlignmentPanel(topPanel, false);
3344             myBottomFrame.addAlignmentPanel(bottomPanel, false);
3345           }
3346         }
3347
3348         if (gatherThis)
3349         {
3350           topFrame.getAlignPanels().clear();
3351           bottomFrame.getAlignPanels().clear();
3352           sf.close();
3353         }
3354       }
3355     }
3356
3357     /*
3358      * The dust settles...give focus to the tab we did this from.
3359      */
3360     myTopFrame.setDisplayedView(myTopFrame.alignPanel);
3361   }
3362
3363   public static groovy.ui.Console getGroovyConsole()
3364   {
3365     return groovyConsole;
3366   }
3367
3368   /**
3369    * handles the payload of a drag and drop event.
3370    *
3371    * TODO refactor to desktop utilities class
3372    *
3373    * @param files
3374    *          - Data source strings extracted from the drop event
3375    * @param protocols
3376    *          - protocol for each data source extracted from the drop event
3377    * @param evt
3378    *          - the drop event
3379    * @param t
3380    *          - the payload from the drop event
3381    * @throws Exception
3382    */
3383   public static void transferFromDropTarget(List<String> files,
3384           List<DataSourceType> protocols, DropTargetDropEvent evt,
3385           Transferable t) throws Exception
3386   {
3387
3388     DataFlavor uriListFlavor = new DataFlavor(
3389             "text/uri-list;class=java.lang.String"), urlFlavour = null;
3390     try
3391     {
3392       urlFlavour = new DataFlavor(
3393               "application/x-java-url; class=java.net.URL");
3394     } catch (ClassNotFoundException cfe)
3395     {
3396       Cache.log.debug("Couldn't instantiate the URL dataflavor.", cfe);
3397     }
3398
3399     if (urlFlavour != null && t.isDataFlavorSupported(urlFlavour))
3400     {
3401
3402       try
3403       {
3404         java.net.URL url = (URL) t.getTransferData(urlFlavour);
3405         // nb: java 8 osx bug https://bugs.openjdk.java.net/browse/JDK-8156099
3406         // means url may be null.
3407         if (url != null)
3408         {
3409           protocols.add(DataSourceType.URL);
3410           files.add(url.toString());
3411           Cache.log.debug("Drop handled as URL dataflavor "
3412                   + files.get(files.size() - 1));
3413           return;
3414         }
3415         else
3416         {
3417           if (Platform.isAMac())
3418           {
3419             System.err.println(
3420                     "Please ignore plist error - occurs due to problem with java 8 on OSX");
3421           }
3422           ;
3423         }
3424       } catch (Throwable ex)
3425       {
3426         Cache.log.debug("URL drop handler failed.", ex);
3427       }
3428     }
3429     if (t.isDataFlavorSupported(DataFlavor.javaFileListFlavor))
3430     {
3431       // Works on Windows and MacOSX
3432       Cache.log.debug("Drop handled as javaFileListFlavor");
3433       for (Object file : (List) t
3434               .getTransferData(DataFlavor.javaFileListFlavor))
3435       {
3436         files.add(((File) file).toString());
3437         protocols.add(DataSourceType.FILE);
3438       }
3439     }
3440     else
3441     {
3442       // Unix like behaviour
3443       boolean added = false;
3444       String data = null;
3445       if (t.isDataFlavorSupported(uriListFlavor))
3446       {
3447         Cache.log.debug("Drop handled as uriListFlavor");
3448         // This is used by Unix drag system
3449         data = (String) t.getTransferData(uriListFlavor);
3450       }
3451       if (data == null)
3452       {
3453         // fallback to text: workaround - on OSX where there's a JVM bug
3454         Cache.log.debug("standard URIListFlavor failed. Trying text");
3455         // try text fallback
3456         DataFlavor textDf = new DataFlavor(
3457                 "text/plain;class=java.lang.String");
3458         if (t.isDataFlavorSupported(textDf))
3459         {
3460           data = (String) t.getTransferData(textDf);
3461         }
3462
3463         Cache.log.debug("Plain text drop content returned "
3464                 + (data == null ? "Null - failed" : data));
3465
3466       }
3467       if (data != null)
3468       {
3469         while (protocols.size() < files.size())
3470         {
3471           Cache.log.debug("Adding missing FILE protocol for "
3472                   + files.get(protocols.size()));
3473           protocols.add(DataSourceType.FILE);
3474         }
3475         for (java.util.StringTokenizer st = new java.util.StringTokenizer(
3476                 data, "\r\n"); st.hasMoreTokens();)
3477         {
3478           added = true;
3479           String s = st.nextToken();
3480           if (s.startsWith("#"))
3481           {
3482             // the line is a comment (as per the RFC 2483)
3483             continue;
3484           }
3485           java.net.URI uri = new java.net.URI(s);
3486           if (uri.getScheme().toLowerCase().startsWith("http"))
3487           {
3488             protocols.add(DataSourceType.URL);
3489             files.add(uri.toString());
3490           }
3491           else
3492           {
3493             // otherwise preserve old behaviour: catch all for file objects
3494             java.io.File file = new java.io.File(uri);
3495             protocols.add(DataSourceType.FILE);
3496             files.add(file.toString());
3497           }
3498         }
3499       }
3500
3501       if (Cache.log.isDebugEnabled())
3502       {
3503         if (data == null || !added)
3504         {
3505
3506           if (t.getTransferDataFlavors() != null
3507                   && t.getTransferDataFlavors().length > 0)
3508           {
3509             Cache.log.debug(
3510                     "Couldn't resolve drop data. Here are the supported flavors:");
3511             for (DataFlavor fl : t.getTransferDataFlavors())
3512             {
3513               Cache.log.debug(
3514                       "Supported transfer dataflavor: " + fl.toString());
3515               Object df = t.getTransferData(fl);
3516               if (df != null)
3517               {
3518                 Cache.log.debug("Retrieves: " + df);
3519               }
3520               else
3521               {
3522                 Cache.log.debug("Retrieved nothing");
3523               }
3524             }
3525           }
3526           else
3527           {
3528             Cache.log.debug("Couldn't resolve dataflavor for drop: "
3529                     + t.toString());
3530           }
3531         }
3532       }
3533     }
3534     if (Platform.isWindows())
3535
3536     {
3537       Cache.log.debug("Scanning dropped content for Windows Link Files");
3538
3539       // resolve any .lnk files in the file drop
3540       for (int f = 0; f < files.size(); f++)
3541       {
3542         String source = files.get(f).toLowerCase();
3543         if (protocols.get(f).equals(DataSourceType.FILE)
3544                 && (source.endsWith(".lnk") || source.endsWith(".url")
3545                         || source.endsWith(".site")))
3546         {
3547           try
3548           {
3549             File lf = new File(files.get(f));
3550             // process link file to get a URL
3551             Cache.log.debug("Found potential link file: " + lf);
3552             WindowsShortcut wscfile = new WindowsShortcut(lf);
3553             String fullname = wscfile.getRealFilename();
3554             protocols.set(f, FormatAdapter.checkProtocol(fullname));
3555             files.set(f, fullname);
3556             Cache.log.debug("Parsed real filename " + fullname
3557                     + " to extract protocol: " + protocols.get(f));
3558           } catch (Exception ex)
3559           {
3560             Cache.log.error(
3561                     "Couldn't parse " + files.get(f) + " as a link file.",
3562                     ex);
3563           }
3564         }
3565       }
3566     }
3567   }
3568
3569   /**
3570    * Sets the Preferences property for experimental features to True or False
3571    * depending on the state of the controlling menu item
3572    */
3573   @Override
3574   protected void showExperimental_actionPerformed(boolean selected)
3575   {
3576     Cache.setProperty(EXPERIMENTAL_FEATURES, Boolean.toString(selected));
3577   }
3578
3579   /**
3580    * Answers a (possibly empty) list of any structure viewer frames (currently
3581    * for either Jmol or Chimera) which are currently open. This may optionally
3582    * be restricted to viewers of a specified class, or viewers linked to a
3583    * specified alignment panel.
3584    *
3585    * @param apanel
3586    *          if not null, only return viewers linked to this panel
3587    * @param structureViewerClass
3588    *          if not null, only return viewers of this class
3589    * @return
3590    */
3591   public List<StructureViewerBase> getStructureViewers(
3592           AlignmentPanel apanel,
3593           Class<? extends StructureViewerBase> structureViewerClass)
3594   {
3595     List<StructureViewerBase> result = new ArrayList<>();
3596     JInternalFrame[] frames = Desktop.instance.getAllFrames();
3597
3598     for (JInternalFrame frame : frames)
3599     {
3600       if (frame instanceof StructureViewerBase)
3601       {
3602         if (structureViewerClass == null
3603                 || structureViewerClass.isInstance(frame))
3604         {
3605           if (apanel == null
3606                   || ((StructureViewerBase) frame).isLinkedWith(apanel))
3607           {
3608             result.add((StructureViewerBase) frame);
3609           }
3610         }
3611       }
3612     }
3613     return result;
3614   }
3615 }