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 java.awt.Dimension;
  24 import java.io.File;
  25 import java.io.IOException;
  26 import java.util.StringTokenizer;
  27 import java.util.Vector;
  28
  29 import javax.swing.SwingUtilities;
  30
  31 import jalview.api.ComplexAlignFile;
  32 import jalview.api.FeatureSettingsModelI;
  33 import jalview.api.FeaturesDisplayedI;
  34 import jalview.api.FeaturesSourceI;
  35 import jalview.bin.Cache;
  36 import jalview.bin.Jalview;
  37 import jalview.datamodel.AlignmentI;
  38 import jalview.datamodel.HiddenColumns;
  39 import jalview.datamodel.PDBEntry;
  40 import jalview.datamodel.SequenceI;
  41 import jalview.gui.AlignFrame;
  42 import jalview.gui.AlignViewport;
  43 import jalview.gui.Desktop;
  44 import jalview.gui.JvOptionPane;
  45 import jalview.json.binding.biojson.v1.ColourSchemeMapper;
  46 import jalview.project.Jalview2XML;
  47 import jalview.schemes.ColourSchemeI;
  48 import jalview.structure.StructureSelectionManager;
  49 import jalview.util.MessageManager;
  50 import jalview.util.Platform;
  51 import jalview.ws.utils.UrlDownloadClient;
  52
  53 public class FileLoader implements Runnable
  54 {
  55   String file;
  56
  57   DataSourceType protocol;
  58
  59   FileFormatI format;
  60
  61   AlignmentFileReaderI source = null; // alternative specification of where data
  62                                       // comes
  63
  64   // from
  65
  66   AlignViewport viewport;
  67
  68   AlignFrame alignFrame;
  69
  70   long loadtime;
  71
  72   long memused;
  73
  74   boolean raiseGUI = true;
  75
  76   private File selectedFile;
  77
  78   /**
  79    * default constructor always raised errors in GUI dialog boxes
  80    */
  81   public FileLoader()
  82   {
  83     this(true);
  84   }
  85
  86   /**
  87    * construct a Fileloader that may raise errors non-interactively
  88    *
  89    * @param raiseGUI
  90    *          true if errors are to be raised as GUI dialog boxes
  91    */
  92   public FileLoader(boolean raiseGUI)
  93   {
  94     this.raiseGUI = raiseGUI;
  95   }
  96
  97   public void LoadFile(AlignViewport viewport, Object file,
  98           DataSourceType protocol, FileFormatI format)
  99   {
 100     this.viewport = viewport;
 101     if (file instanceof File) {
 102       this.selectedFile = (File) file;
 103       file = selectedFile.getPath();
 104     }
 105     LoadFile(file.toString(), protocol, format);
 106   }
 107
 108   public void LoadFile(String file, DataSourceType protocol,
 109           FileFormatI format)
 110   {
 111     this.file = file;
 112     this.protocol = protocol;
 113     this.format = format;
 114
 115     final Thread loader = new Thread(this);
 116
 117     SwingUtilities.invokeLater(new Runnable()
 118     {
 119       @Override
 120       public void run()
 121       {
 122         loader.start();
 123       }
 124     });
 125   }
 126
 127   /**
 128    * Load a (file, protocol) source of unknown type
 129    *
 130    * @param file
 131    * @param protocol
 132    */
 133   public void LoadFile(String file, DataSourceType protocol)
 134   {
 135     LoadFile(file, protocol, null);
 136   }
 137
 138   /**
 139    * Load alignment from (file, protocol) and wait till loaded
 140    *
 141    * @param file
 142    * @param sourceType
 143    * @return alignFrame constructed from file contents
 144    */
 145   public AlignFrame LoadFileWaitTillLoaded(String file,
 146           DataSourceType sourceType)
 147   {
 148     return LoadFileWaitTillLoaded(file, sourceType, null);
 149   }
 150
 151   /**
 152    * Load alignment from (file, protocol) of type format and wait till loaded
 153    *
 154    * @param file
 155    * @param sourceType
 156    * @param format
 157    * @return alignFrame constructed from file contents
 158    */
 159   public AlignFrame LoadFileWaitTillLoaded(String file,
 160           DataSourceType sourceType, FileFormatI format)
 161   {
 162     this.file = file;
 163     this.protocol = sourceType;
 164     this.format = format;
 165     return _LoadFileWaitTillLoaded();
 166   }
 167
 168   /**
 169    * Load alignment from (file, protocol) of type format and wait till loaded
 170    *
 171    * @param file
 172    * @param sourceType
 173    * @param format
 174    * @return alignFrame constructed from file contents
 175    */
 176   public AlignFrame LoadFileWaitTillLoaded(File file,
 177           DataSourceType sourceType, FileFormatI format)
 178   {
 179     this.selectedFile = file;
 180     this.file = file.getPath();
 181     this.protocol = sourceType;
 182     this.format = format;
 183     return _LoadFileWaitTillLoaded();
 184   }
 185
 186   /**
 187    * Load alignment from FileParse source of type format and wait till loaded
 188    *
 189    * @param source
 190    * @param format
 191    * @return alignFrame constructed from file contents
 192    */
 193   public AlignFrame LoadFileWaitTillLoaded(AlignmentFileReaderI source,
 194           FileFormatI format)
 195   {
 196     this.source = source;
 197
 198     file = source.getInFile();
 199     protocol = source.getDataSourceType();
 200     this.format = format;
 201     return _LoadFileWaitTillLoaded();
 202   }
 203
 204   /**
 205    * runs the 'run' method (in this thread), then return the alignFrame that's
 206    * (hopefully) been read
 207    *
 208    * @return
 209    */
 210   protected AlignFrame _LoadFileWaitTillLoaded()
 211   {
 212     this.run();
 213
 214     return alignFrame;
 215   }
 216
 217   public void updateRecentlyOpened()
 218   {
 219     Vector<String> recent = new Vector<>();
 220     if (protocol == DataSourceType.PASTE)
 221     {
 222       // do nothing if the file was pasted in as text... there is no filename to
 223       // refer to it as.
 224       return;
 225     }
 226     if (file != null
 227             && file.indexOf(System.getProperty("java.io.tmpdir")) > -1)
 228     {
 229       // ignore files loaded from the system's temporary directory
 230       return;
 231     }
 232     String type = protocol == DataSourceType.FILE ? "RECENT_FILE"
 233             : "RECENT_URL";
 234
 235     String historyItems = Cache.getProperty(type);
 236
 237     StringTokenizer st;
 238
 239     if (historyItems != null)
 240     {
 241       st = new StringTokenizer(historyItems, "\t");
 242
 243       while (st.hasMoreTokens())
 244       {
 245         recent.addElement(st.nextToken().trim());
 246       }
 247     }
 248
 249     if (recent.contains(file))
 250     {
 251       recent.remove(file);
 252     }
 253
 254     StringBuffer newHistory = new StringBuffer(file);
 255     for (int i = 0; i < recent.size() && i < 10; i++)
 256     {
 257       newHistory.append("\t");
 258       newHistory.append(recent.elementAt(i));
 259     }
 260
 261     Cache.setProperty(type, newHistory.toString());
 262
 263     if (protocol == DataSourceType.FILE)
 264     {
 265       Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
 266     }
 267   }
 268
 269   @Override
 270   public void run()
 271   {
 272     String title = protocol == DataSourceType.PASTE
 273             ? "Copied From Clipboard"
 274             : file;
 275     Runtime rt = Runtime.getRuntime();
 276     try
 277     {
 278       if (Desktop.getInstance() != null)
 279       {
 280         Desktop.getInstance().startLoading(file);
 281       }
 282       if (format == null)
 283       {
 284         // just in case the caller didn't identify the file for us
 285         if (source != null)
 286         {
 287           format = new IdentifyFile().identify(source, false);
 288           // identify stream and rewind rather than close
 289         }
 290         else if (selectedFile != null) {
 291           format = new IdentifyFile().identify(selectedFile, protocol);
 292         }
 293         else
 294         {
 295           format = new IdentifyFile().identify(file, protocol);
 296         }
 297
 298       }
 299
 300       if (format == null)
 301       {
 302         Desktop.getInstance().stopLoading();
 303         System.err.println("The input file \"" + file
 304                 + "\" has null or unidentifiable data content!");
 305         if (!Jalview.isHeadlessMode())
 306         {
 307           JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
 308                   MessageManager.getString("label.couldnt_read_data")
 309                           + " in " + file + "\n"
 310                           + AppletFormatAdapter.getSupportedFormats(),
 311                   MessageManager.getString("label.couldnt_read_data"),
 312                   JvOptionPane.WARNING_MESSAGE);
 313         }
 314         return;
 315       }
 316       // TODO: cache any stream datasources as a temporary file (eg. PDBs
 317       // retrieved via URL)
 318       if (Desktop.getDesktopPane() != null && Desktop.getDesktopPane().isShowMemoryUsage())
 319       {
 320         System.gc();
 321         memused = (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // free
 322         // memory
 323         // before
 324         // load
 325       }
 326       loadtime = -System.currentTimeMillis();
 327       AlignmentI al = null;
 328
 329       if (FileFormat.Jalview.equals(format))
 330       {
 331         if (source != null)
 332         {
 333           // Tell the user (developer?) that this is going to cause a problem
 334           System.err.println(
 335                   "IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
 336           // We read the data anyway - it might make sense.
 337         }
 338         // BH 2018 switch to File object here instead of filename
 339         alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(selectedFile == null ? file : selectedFile);
 340       }
 341       else
 342       {
 343         String error = AppletFormatAdapter.getSupportedFormats();
 344         try
 345         {
 346           if (source != null)
 347           {
 348             // read from the provided source
 349             al = new FormatAdapter().readFromFile(source, format);
 350           }
 351           else
 352           {
 353
 354             // open a new source and read from it
 355             FormatAdapter fa = new FormatAdapter();
 356             boolean downloadStructureFile = format.isStructureFile()
 357                     && protocol.equals(DataSourceType.URL);
 358             if (downloadStructureFile)
 359             {
 360               String structExt = format.getExtensions().split(",")[0];
 361               String urlLeafName = file.substring(
 362                       file.lastIndexOf(
 363                               System.getProperty("file.separator")),
 364                       file.lastIndexOf("."));
 365               String tempStructureFileStr = createNamedJvTempFile(
 366                       urlLeafName, structExt);
 367
 368               // BH - switching to File object here so as to hold
 369               // ._bytes array directly
 370               File tempFile = new File(tempStructureFileStr);
 371               UrlDownloadClient.download(file, tempFile);
 372
 373               al = fa.readFile(tempFile, DataSourceType.FILE,
 374                       format);
 375               source = fa.getAlignFile();
 376             }
 377             else
 378             {
 379               if (selectedFile == null) {
 380                 al = fa.readFile(file, protocol, format);
 381
 382               } else {
 383                 al = fa.readFile(selectedFile, protocol, format);
 384                              }
 385               source = fa.getAlignFile(); // keep reference for later if
 386
 387                                           // necessary.
 388             }
 389           }
 390         } catch (java.io.IOException ex)
 391         {
 392           error = ex.getMessage();
 393         }
 394
 395         if ((al != null) && (al.getHeight() > 0) && al.hasValidSequence())
 396         {
 397           // construct and register dataset sequences
 398           for (SequenceI sq : al.getSequences())
 399           {
 400             while (sq.getDatasetSequence() != null)
 401             {
 402               sq = sq.getDatasetSequence();
 403             }
 404             if (sq.getAllPDBEntries() != null)
 405             {
 406               for (PDBEntry pdbe : sq.getAllPDBEntries())
 407               {
 408                 // register PDB entries with desktop's structure selection
 409                 // manager
 410                 StructureSelectionManager
 411                         .getStructureSelectionManager(Desktop.getInstance())
 412                         .registerPDBEntry(pdbe);
 413               }
 414             }
 415           }
 416
 417           FeatureSettingsModelI proxyColourScheme = source
 418                   .getFeatureColourScheme();
 419           if (viewport != null)
 420           {
 421             if (proxyColourScheme != null)
 422             {
 423               viewport.applyFeaturesStyle(proxyColourScheme);
 424             }
 425             // append to existing alignment
 426             viewport.addAlignment(al, title);
 427           }
 428           else
 429           {
 430             // otherwise construct the alignFrame
 431
 432             if (source instanceof ComplexAlignFile)
 433             {
 434               HiddenColumns colSel = ((ComplexAlignFile) source)
 435                       .getHiddenColumns();
 436               SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
 437                       .getHiddenSequences();
 438               String colourSchemeName = ((ComplexAlignFile) source)
 439                       .getGlobalColourScheme();
 440               FeaturesDisplayedI fd = ((ComplexAlignFile) source)
 441                       .getDisplayedFeatures();
 442               alignFrame = new AlignFrame(al, hiddenSeqs, colSel,
 443                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 444               alignFrame.getViewport().setFeaturesDisplayed(fd);
 445               alignFrame.getViewport().setShowSequenceFeatures(
 446                       ((ComplexAlignFile) source).isShowSeqFeatures());
 447               ColourSchemeI cs = ColourSchemeMapper
 448                       .getJalviewColourScheme(colourSchemeName, al);
 449               if (cs != null)
 450               {
 451                 alignFrame.changeColour(cs);
 452               }
 453             }
 454             else
 455             {
 456               alignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 457                       AlignFrame.DEFAULT_HEIGHT);
 458               if (source instanceof FeaturesSourceI)
 459               {
 460                 alignFrame.getViewport().setShowSequenceFeatures(true);
 461               }
 462             }
 463             // add metadata and update ui
 464             if (!(protocol == DataSourceType.PASTE))
 465             {
 466               alignFrame.setFile(file, selectedFile, protocol, format);
 467             }
 468             if (proxyColourScheme != null)
 469             {
 470               alignFrame.getViewport()
 471                       .applyFeaturesStyle(proxyColourScheme);
 472             }
 473             alignFrame.setStatus(MessageManager.formatMessage(
 474                     "label.successfully_loaded_file", new String[]
 475                     { title }));
 476
 477             if (raiseGUI)
 478             {
 479               // add the window to the GUI
 480               // note - this actually should happen regardless of raiseGUI
 481               // status in Jalview 3
 482               // TODO: define 'virtual desktop' for benefit of headless scripts
 483               // that perform queries to find the 'current working alignment'
 484
 485               Dimension dim = Platform.getDimIfEmbedded(alignFrame,
 486                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 487               alignFrame.setSize(dim);
 488               Desktop.addInternalFrame(alignFrame, title, dim.width,
 489                       dim.height);
 490             }
 491
 492             try
 493             {
 494               alignFrame.setMaximum(jalview.bin.Cache
 495                       .getDefault("SHOW_FULLSCREEN", false));
 496             } catch (java.beans.PropertyVetoException ex)
 497             {
 498             }
 499           }
 500         }
 501         else
 502         {
 503           if (Desktop.getInstance() != null)
 504           {
 505             Desktop.getInstance().stopLoading();
 506           }
 507
 508           final String errorMessage = MessageManager.getString(
 509                   "label.couldnt_load_file") + " " + title + "\n" + error;
 510           // TODO: refactor FileLoader to be independent of Desktop / Applet GUI
 511           // bits ?
 512           if (raiseGUI && Desktop.getDesktopPane() != null)
 513           {
 514             javax.swing.SwingUtilities.invokeLater(new Runnable()
 515             {
 516               @Override
 517               public void run()
 518               {
 519                 JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
 520                         errorMessage,
 521                         MessageManager
 522                                 .getString("label.error_loading_file"),
 523                         JvOptionPane.WARNING_MESSAGE);
 524               }
 525             });
 526           }
 527           else
 528           {
 529             System.err.println(errorMessage);
 530           }
 531         }
 532       }
 533
 534       updateRecentlyOpened();
 535
 536     } catch (Exception er)
 537     {
 538       System.err.println("Exception whilst opening file '" + file);
 539       er.printStackTrace();
 540       if (raiseGUI)
 541       {
 542         javax.swing.SwingUtilities.invokeLater(new Runnable()
 543         {
 544           @Override
 545           public void run()
 546           {
 547             JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
 548                     MessageManager.formatMessage(
 549                             "label.problems_opening_file", new String[]
 550                             { file }),
 551                     MessageManager.getString("label.file_open_error"),
 552                     JvOptionPane.WARNING_MESSAGE);
 553           }
 554         });
 555       }
 556       alignFrame = null;
 557     } catch (OutOfMemoryError er)
 558     {
 559
 560       er.printStackTrace();
 561       alignFrame = null;
 562       if (raiseGUI)
 563       {
 564         javax.swing.SwingUtilities.invokeLater(new Runnable()
 565         {
 566           @Override
 567           public void run()
 568           {
 569             JvOptionPane.showInternalMessageDialog(Desktop.getDesktopPane(),
 570                     MessageManager.formatMessage(
 571                             "warn.out_of_memory_loading_file", new String[]
 572                             { file }),
 573                     MessageManager.getString("label.out_of_memory"),
 574                     JvOptionPane.WARNING_MESSAGE);
 575           }
 576         });
 577       }
 578       System.err.println("Out of memory loading file " + file + "!!");
 579
 580     }
 581     loadtime += System.currentTimeMillis();
 582     // TODO: Estimate percentage of memory used by a newly loaded alignment -
 583     // warn if more memory will be needed to work with it
 584     // System.gc();
 585     memused = memused
 586             - (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // difference
 587     // in free
 588     // memory
 589     // after
 590     // load
 591     if (Desktop.getDesktopPane() != null && Desktop.getDesktopPane().isShowMemoryUsage())
 592     {
 593       if (alignFrame != null)
 594       {
 595         AlignmentI al = alignFrame.getViewport().getAlignment();
 596
 597         System.out.println("Loaded '" + title + "' in "
 598                 + (loadtime / 1000.0) + "s, took an additional "
 599                 + (1.0 * memused / (1024.0 * 1024.0)) + " MB ("
 600                 + al.getHeight() + " seqs by " + al.getWidth() + " cols)");
 601       }
 602       else
 603       {
 604         // report that we didn't load anything probably due to an out of memory
 605         // error
 606         System.out.println("Failed to load '" + title + "' in "
 607                 + (loadtime / 1000.0) + "s, took an additional "
 608                 + (1.0 * memused / (1024.0 * 1024.0))
 609                 + " MB (alignment is null)");
 610       }
 611     }
 612     // remove the visual delay indicator
 613     if (Desktop.getInstance() != null)
 614     {
 615       Desktop.getInstance().stopLoading();
 616     }
 617
 618   }
 619
 620   /**
 621    * This method creates the file -
 622    * {tmpdir}/jalview/{current_timestamp}/fileName.exetnsion using the supplied
 623    * file name and extension
 624    *
 625    * @param fileName
 626    *          the name of the temp file to be created
 627    * @param extension
 628    *          the extension of the temp file to be created
 629    * @return
 630    */
 631   private static String createNamedJvTempFile(String fileName,
 632           String extension) throws IOException
 633   {
 634     String seprator = System.getProperty("file.separator");
 635     String jvTempDir = System.getProperty("java.io.tmpdir") + "jalview"
 636             + seprator + System.currentTimeMillis();
 637     File tempStructFile = new File(
 638             jvTempDir + seprator + fileName + "." + extension);
 639     tempStructFile.mkdirs();
 640     return tempStructFile.toString();
 641   }
 642
 643 }