src/jalview/io/FileLoader.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.io;
  22
  23 import jalview.api.ComplexAlignFile;
  24 import jalview.api.FeaturesDisplayedI;
  25 import jalview.bin.Jalview;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.ColumnSelection;
  28 import jalview.datamodel.PDBEntry;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.gui.AlignFrame;
  31 import jalview.gui.AlignViewport;
  32 import jalview.gui.Desktop;
  33 import jalview.gui.Jalview2XML;
  34 import jalview.schemes.ColourSchemeI;
  35 import jalview.structure.StructureSelectionManager;
  36 import jalview.util.MessageManager;
  37
  38 import java.util.StringTokenizer;
  39 import java.util.Vector;
  40
  41 import javax.swing.JOptionPane;
  42 import javax.swing.SwingUtilities;
  43
  44 public class FileLoader implements Runnable
  45 {
  46   String file;
  47
  48   String protocol;
  49
  50   String format;
  51
  52   FileParse source = null; // alternative specification of where data comes
  53
  54   // from
  55
  56   AlignViewport viewport;
  57
  58   AlignFrame alignFrame;
  59
  60   long loadtime;
  61
  62   long memused;
  63
  64   boolean raiseGUI = true;
  65
  66   /**
  67    * default constructor always raised errors in GUI dialog boxes
  68    */
  69   public FileLoader()
  70   {
  71     this(true);
  72   }
  73
  74   /**
  75    * construct a Fileloader that may raise errors non-interactively
  76    *
  77    * @param raiseGUI
  78    *          true if errors are to be raised as GUI dialog boxes
  79    */
  80   public FileLoader(boolean raiseGUI)
  81   {
  82     this.raiseGUI = raiseGUI;
  83   }
  84
  85   public void LoadFile(AlignViewport viewport, String file,
  86           String protocol, String format)
  87   {
  88     this.viewport = viewport;
  89     LoadFile(file, protocol, format);
  90   }
  91
  92   public void LoadFile(String file, String protocol, String format)
  93   {
  94     this.file = file;
  95     this.protocol = protocol;
  96     this.format = format;
  97
  98     final Thread loader = new Thread(this);
  99
 100     SwingUtilities.invokeLater(new Runnable()
 101     {
 102       public void run()
 103       {
 104         loader.start();
 105       }
 106     });
 107   }
 108
 109   /**
 110    * Load a (file, protocol) source of unknown type
 111    *
 112    * @param file
 113    * @param protocol
 114    */
 115   public void LoadFile(String file, String protocol)
 116   {
 117     LoadFile(file, protocol, null);
 118   }
 119
 120   /**
 121    * Load alignment from (file, protocol) and wait till loaded
 122    *
 123    * @param file
 124    * @param protocol
 125    * @return alignFrame constructed from file contents
 126    */
 127   public AlignFrame LoadFileWaitTillLoaded(String file, String protocol)
 128   {
 129     return LoadFileWaitTillLoaded(file, protocol, null);
 130   }
 131
 132   /**
 133    * Load alignment from (file, protocol) of type format and wait till loaded
 134    *
 135    * @param file
 136    * @param protocol
 137    * @param format
 138    * @return alignFrame constructed from file contents
 139    */
 140   public AlignFrame LoadFileWaitTillLoaded(String file, String protocol,
 141           String format)
 142   {
 143     this.file = file;
 144     this.protocol = protocol;
 145     this.format = format;
 146     return _LoadFileWaitTillLoaded();
 147   }
 148
 149   /**
 150    * Load alignment from FileParse source of type format and wait till loaded
 151    *
 152    * @param source
 153    * @param format
 154    * @return alignFrame constructed from file contents
 155    */
 156   public AlignFrame LoadFileWaitTillLoaded(FileParse source, String format)
 157   {
 158     this.source = source;
 159
 160     file = source.getInFile();
 161     protocol = source.type;
 162     this.format = format;
 163     return _LoadFileWaitTillLoaded();
 164   }
 165
 166   /**
 167    * start thread and wait until finished, then return the alignFrame that's
 168    * (hopefully) been read.
 169    *
 170    * @return
 171    */
 172   protected AlignFrame _LoadFileWaitTillLoaded()
 173   {
 174     Thread loader = new Thread(this);
 175     loader.start();
 176
 177     while (loader.isAlive())
 178     {
 179       try
 180       {
 181         Thread.sleep(500);
 182       } catch (Exception ex)
 183       {
 184       }
 185     }
 186
 187     return alignFrame;
 188   }
 189
 190   public void updateRecentlyOpened()
 191   {
 192     Vector recent = new Vector();
 193     if (protocol.equals(FormatAdapter.PASTE))
 194     {
 195       // do nothing if the file was pasted in as text... there is no filename to
 196       // refer to it as.
 197       return;
 198     }
 199     String type = protocol.equals(FormatAdapter.FILE) ? "RECENT_FILE"
 200             : "RECENT_URL";
 201
 202     String historyItems = jalview.bin.Cache.getProperty(type);
 203
 204     StringTokenizer st;
 205
 206     if (historyItems != null)
 207     {
 208       st = new StringTokenizer(historyItems, "\t");
 209
 210       while (st.hasMoreTokens())
 211       {
 212         recent.addElement(st.nextElement().toString().trim());
 213       }
 214     }
 215
 216     if (recent.contains(file))
 217     {
 218       recent.remove(file);
 219     }
 220
 221     StringBuffer newHistory = new StringBuffer(file);
 222     for (int i = 0; i < recent.size() && i < 10; i++)
 223     {
 224       newHistory.append("\t");
 225       newHistory.append(recent.elementAt(i));
 226     }
 227
 228     jalview.bin.Cache.setProperty(type, newHistory.toString());
 229
 230     if (protocol.equals(FormatAdapter.FILE))
 231     {
 232       jalview.bin.Cache.setProperty("DEFAULT_FILE_FORMAT", format);
 233     }
 234   }
 235
 236   public void run()
 237   {
 238     String title = protocol.equals(AppletFormatAdapter.PASTE) ? "Copied From Clipboard"
 239             : file;
 240     Runtime rt = Runtime.getRuntime();
 241     try
 242     {
 243       if (Desktop.instance != null)
 244       {
 245         Desktop.instance.startLoading(file);
 246       }
 247       if (format == null)
 248       {
 249         // just in case the caller didn't identify the file for us
 250         if (source != null)
 251         {
 252           format = new IdentifyFile().Identify(source, false); // identify
 253           // stream and
 254           // rewind rather
 255           // than close
 256         }
 257         else
 258         {
 259           format = new IdentifyFile().Identify(file, protocol);
 260         }
 261
 262       }
 263
 264       if (format == null || format.equalsIgnoreCase("EMPTY DATA FILE"))
 265       {
 266         Desktop.instance.stopLoading();
 267         System.err.println("The input file \"" + file
 268                 + "\" has no data content!");
 269         if (!Jalview.isHeadlessMode())
 270         {
 271           JOptionPane.showMessageDialog(null, "The input file \""
 272                   + file + "\" has no data content!", "Empty data file",
 273                   JOptionPane.ERROR_MESSAGE);
 274         }
 275         return;
 276       }
 277       // TODO: cache any stream datasources as a temporary file (eg. PDBs
 278       // retrieved via URL)
 279       if (Desktop.desktop != null && Desktop.desktop.isShowMemoryUsage())
 280       {
 281         System.gc();
 282         memused = (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // free
 283         // memory
 284         // before
 285         // load
 286       }
 287       loadtime = -System.currentTimeMillis();
 288       AlignmentI al = null;
 289
 290       if (format.equalsIgnoreCase("Jalview"))
 291       {
 292         if (source != null)
 293         {
 294           // Tell the user (developer?) that this is going to cause a problem
 295           System.err
 296                   .println("IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
 297           // We read the data anyway - it might make sense.
 298         }
 299         alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(file);
 300       }
 301       else
 302       {
 303         String error = AppletFormatAdapter.SUPPORTED_FORMATS;
 304         if (FormatAdapter.isValidFormat(format))
 305         {
 306           try
 307           {
 308             if (source != null)
 309             {
 310               // read from the provided source
 311               al = new FormatAdapter().readFromFile(source, format);
 312             }
 313             else
 314             {
 315
 316               // open a new source and read from it
 317               FormatAdapter fa = new FormatAdapter();
 318               al = fa.readFile(file, protocol, format);
 319               source = fa.getAlignFile(); // keep reference for later if
 320                                           // necessary.
 321             }
 322           } catch (java.io.IOException ex)
 323           {
 324             error = ex.getMessage();
 325           }
 326         }
 327         else
 328         {
 329           if (format != null && format.length() > 7)
 330           {
 331             // ad hoc message in format.
 332             error = format + "\n" + error;
 333           }
 334         }
 335
 336         if ((al != null) && (al.getHeight() > 0))
 337         {
 338           // construct and register dataset sequences
 339           for (SequenceI sq : al.getSequences())
 340           {
 341             while (sq.getDatasetSequence() != null)
 342             {
 343               sq = sq.getDatasetSequence();
 344             }
 345             if (sq.getPDBId() != null)
 346             {
 347               for (PDBEntry pdbe : sq.getPDBId())
 348               {
 349                 // register PDB entries with desktop's structure selection
 350                 // manager
 351                 StructureSelectionManager.getStructureSelectionManager(
 352                         Desktop.instance).registerPDBEntry(pdbe);
 353               }
 354             }
 355           }
 356
 357           if (viewport != null)
 358           {
 359             // append to existing alignment
 360             viewport.addAlignment(al, title);
 361           }
 362           else
 363           {
 364             // otherwise construct the alignFrame
 365
 366             if (source instanceof ComplexAlignFile)
 367             {
 368               ColumnSelection colSel = ((ComplexAlignFile) source)
 369                       .getColumnSelection();
 370               SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
 371                       .getHiddenSequences();
 372               boolean showSeqFeatures = ((ComplexAlignFile) source)
 373                       .isShowSeqFeatures();
 374               ColourSchemeI cs = ((ComplexAlignFile) source)
 375                       .getColourScheme();
 376               FeaturesDisplayedI fd = ((ComplexAlignFile) source)
 377                       .getDisplayedFeatures();
 378               alignFrame = new AlignFrame(al, hiddenSeqs, colSel,
 379                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 380
 381               alignFrame.getViewport().setShowSequenceFeatures(
 382                       showSeqFeatures);
 383               alignFrame.getViewport().setFeaturesDisplayed(fd);
 384               alignFrame.changeColour(cs);
 385             }
 386             else
 387             {
 388               alignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 389                       AlignFrame.DEFAULT_HEIGHT);
 390             }
 391             // add metadata and update ui
 392             if (!protocol.equals(AppletFormatAdapter.PASTE))
 393             {
 394               alignFrame.setFileName(file, format);
 395             }
 396
 397             alignFrame.statusBar.setText(MessageManager.formatMessage(
 398                     "label.successfully_loaded_file", new String[]
 399                     { title }));
 400
 401             if (raiseGUI)
 402             {
 403               // add the window to the GUI
 404               // note - this actually should happen regardless of raiseGUI
 405               // status in Jalview 3
 406               // TODO: define 'virtual desktop' for benefit of headless scripts
 407               // that perform queries to find the 'current working alignment'
 408               Desktop.addInternalFrame(alignFrame, title,
 409                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 410             }
 411
 412             try
 413             {
 414               alignFrame.setMaximum(jalview.bin.Cache.getDefault(
 415                       "SHOW_FULLSCREEN", false));
 416             } catch (java.beans.PropertyVetoException ex)
 417             {
 418             }
 419           }
 420         }
 421         else
 422         {
 423           if (Desktop.instance != null)
 424           {
 425             Desktop.instance.stopLoading();
 426           }
 427
 428           final String errorMessage = "Couldn't load file " + title + "\n"
 429                   + error;
 430           // TODO: refactor FileLoader to be independent of Desktop / Applet GUI
 431           // bits ?
 432           if (raiseGUI && Desktop.desktop != null)
 433           {
 434             javax.swing.SwingUtilities.invokeLater(new Runnable()
 435             {
 436               public void run()
 437               {
 438                 JOptionPane.showInternalMessageDialog(Desktop.desktop,
 439                         errorMessage, MessageManager
 440                                 .getString("label.error_loading_file"),
 441                         JOptionPane.WARNING_MESSAGE);
 442               }
 443             });
 444           }
 445           else
 446           {
 447             System.err.println(errorMessage);
 448           }
 449         }
 450       }
 451
 452       updateRecentlyOpened();
 453
 454     } catch (Exception er)
 455     {
 456       System.err.println("Exception whilst opening file '" + file);
 457       er.printStackTrace();
 458       if (raiseGUI)
 459       {
 460         javax.swing.SwingUtilities.invokeLater(new Runnable()
 461         {
 462           public void run()
 463           {
 464             javax.swing.JOptionPane.showInternalMessageDialog(
 465                     Desktop.desktop, MessageManager.formatMessage(
 466                             "label.problems_opening_file", new String[]
 467                             { file }), MessageManager
 468                             .getString("label.file_open_error"),
 469                     javax.swing.JOptionPane.WARNING_MESSAGE);
 470           }
 471         });
 472       }
 473       alignFrame = null;
 474     } catch (OutOfMemoryError er)
 475     {
 476
 477       er.printStackTrace();
 478       alignFrame = null;
 479       if (raiseGUI)
 480       {
 481         javax.swing.SwingUtilities.invokeLater(new Runnable()
 482         {
 483           public void run()
 484           {
 485             javax.swing.JOptionPane.showInternalMessageDialog(
 486                     Desktop.desktop, MessageManager.formatMessage(
 487                             "warn.out_of_memory_loading_file", new String[]
 488                             { file }), MessageManager
 489                             .getString("label.out_of_memory"),
 490                     javax.swing.JOptionPane.WARNING_MESSAGE);
 491           }
 492         });
 493       }
 494       System.err.println("Out of memory loading file " + file + "!!");
 495
 496     }
 497     loadtime += System.currentTimeMillis();
 498     // TODO: Estimate percentage of memory used by a newly loaded alignment -
 499     // warn if more memory will be needed to work with it
 500     // System.gc();
 501     memused = memused
 502             - (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // difference
 503     // in free
 504     // memory
 505     // after
 506     // load
 507     if (Desktop.desktop != null && Desktop.desktop.isShowMemoryUsage())
 508     {
 509       if (alignFrame != null)
 510       {
 511         AlignmentI al = alignFrame.getViewport().getAlignment();
 512
 513         System.out.println("Loaded '" + title + "' in "
 514                 + (loadtime / 1000.0) + "s, took an additional "
 515                 + (1.0 * memused / (1024.0 * 1024.0)) + " MB ("
 516                 + al.getHeight() + " seqs by " + al.getWidth() + " cols)");
 517       }
 518       else
 519       {
 520         // report that we didn't load anything probably due to an out of memory
 521         // error
 522         System.out.println("Failed to load '" + title + "' in "
 523                 + (loadtime / 1000.0) + "s, took an additional "
 524                 + (1.0 * memused / (1024.0 * 1024.0))
 525                 + " MB (alignment is null)");
 526       }
 527     }
 528     // remove the visual delay indicator
 529     if (Desktop.instance != null)
 530     {
 531       Desktop.instance.stopLoading();
 532     }
 533
 534   }
 535
 536   /*
 537    * (non-Javadoc)
 538    *
 539    * @see java.lang.Object#finalize()
 540    */
 541   protected void finalize() throws Throwable
 542   {
 543     source = null;
 544     alignFrame = null;
 545     viewport = null;
 546     super.finalize();
 547   }
 548
 549 }