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