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.io.File;
  24 import java.io.IOException;
  25 import java.util.StringTokenizer;
  26 import java.util.Vector;
  27
  28 import javax.swing.SwingUtilities;
  29
  30 import jalview.api.ComplexAlignFile;
  31 import jalview.api.FeatureSettingsModelI;
  32 import jalview.api.FeaturesDisplayedI;
  33 import jalview.api.FeaturesSourceI;
  34 import jalview.bin.Cache;
  35 import jalview.bin.Jalview;
  36 import jalview.datamodel.AlignmentI;
  37 import jalview.datamodel.HiddenColumns;
  38 import jalview.datamodel.PDBEntry;
  39 import jalview.datamodel.SequenceI;
  40 import jalview.gui.AlignFrame;
  41 import jalview.gui.AlignViewport;
  42 import jalview.gui.Desktop;
  43 import jalview.gui.JvOptionPane;
  44 import jalview.gui.QuitHandler;
  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.ws.utils.UrlDownloadClient;
  51
  52 public class FileLoader implements Runnable
  53 {
  54   String file;
  55
  56   DataSourceType protocol;
  57
  58   FileFormatI format;
  59
  60   AlignmentFileReaderI source = null; // alternative specification of where data
  61                                       // comes
  62
  63   // from
  64
  65   AlignViewport viewport;
  66
  67   AlignFrame alignFrame;
  68
  69   long loadtime;
  70
  71   long memused;
  72
  73   boolean raiseGUI = true;
  74
  75   private File selectedFile;
  76
  77   /**
  78    * default constructor always raised errors in GUI dialog boxes
  79    */
  80   public FileLoader()
  81   {
  82     this(true);
  83   }
  84
  85   /**
  86    * construct a Fileloader that may raise errors non-interactively
  87    *
  88    * @param raiseGUI
  89    *          true if errors are to be raised as GUI dialog boxes
  90    */
  91   public FileLoader(boolean raiseGUI)
  92   {
  93     this.raiseGUI = raiseGUI;
  94   }
  95
  96   public void LoadFile(AlignViewport viewport, Object file,
  97           DataSourceType protocol, FileFormatI format)
  98   {
  99     this.viewport = viewport;
 100     if (file instanceof File)
 101     {
 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
 277     try
 278     {
 279       if (Desktop.instance != null)
 280       {
 281         Desktop.instance.startLoading(file);
 282       }
 283       if (format == null)
 284       {
 285         // just in case the caller didn't identify the file for us
 286         if (source != null)
 287         {
 288           format = new IdentifyFile().identify(source, false);
 289           // identify stream and rewind rather than close
 290         }
 291         else if (selectedFile != null)
 292         {
 293           format = new IdentifyFile().identify(selectedFile, protocol);
 294         }
 295         else
 296         {
 297           format = new IdentifyFile().identify(file, protocol);
 298         }
 299
 300       }
 301
 302       if (format == null)
 303       {
 304         Desktop.instance.stopLoading();
 305         System.err.println("The input file \"" + file
 306                 + "\" has null or unidentifiable data content!");
 307         if (!Jalview.isHeadlessMode())
 308         {
 309           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 310                   MessageManager.getString("label.couldnt_read_data")
 311                           + " in " + file + "\n"
 312                           + AppletFormatAdapter.getSupportedFormats(),
 313                   MessageManager.getString("label.couldnt_read_data"),
 314                   JvOptionPane.WARNING_MESSAGE);
 315         }
 316         this.setShouldBeSaved();
 317         return;
 318       }
 319       // TODO: cache any stream datasources as a temporary file (eg. PDBs
 320       // retrieved via URL)
 321       if (Desktop.desktop != null && Desktop.desktop.isShowMemoryUsage())
 322       {
 323         System.gc();
 324         memused = (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // free
 325         // memory
 326         // before
 327         // load
 328       }
 329       loadtime = -System.currentTimeMillis();
 330       AlignmentI al = null;
 331
 332       if (FileFormat.Jalview.equals(format))
 333       {
 334         if (source != null)
 335         {
 336           // Tell the user (developer?) that this is going to cause a problem
 337           System.err.println(
 338                   "IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
 339           // We read the data anyway - it might make sense.
 340         }
 341         // BH 2018 switch to File object here instead of filename
 342         alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(
 343                 selectedFile == null ? file : selectedFile);
 344       }
 345       else
 346       {
 347         String error = AppletFormatAdapter.getSupportedFormats();
 348         try
 349         {
 350           if (source != null)
 351           {
 352             // read from the provided source
 353             al = new FormatAdapter().readFromFile(source, format);
 354           }
 355           else
 356           {
 357
 358             // open a new source and read from it
 359             FormatAdapter fa = new FormatAdapter();
 360             boolean downloadStructureFile = format.isStructureFile()
 361                     && protocol.equals(DataSourceType.URL);
 362             if (downloadStructureFile)
 363             {
 364               String structExt = format.getExtensions().split(",")[0];
 365               String urlLeafName = file.substring(
 366                       file.lastIndexOf(
 367                               System.getProperty("file.separator")),
 368                       file.lastIndexOf("."));
 369               String tempStructureFileStr = createNamedJvTempFile(
 370                       urlLeafName, structExt);
 371
 372               // BH - switching to File object here so as to hold
 373               // ._bytes array directly
 374               File tempFile = new File(tempStructureFileStr);
 375               UrlDownloadClient.download(file, tempFile);
 376
 377               al = fa.readFile(tempFile, DataSourceType.FILE, format);
 378               source = fa.getAlignFile();
 379             }
 380             else
 381             {
 382               if (selectedFile == null)
 383               {
 384                 al = fa.readFile(null, file, protocol, format);
 385
 386               }
 387               else
 388               {
 389                 al = fa.readFile(selectedFile, null, protocol, format);
 390               }
 391               source = fa.getAlignFile(); // keep reference for later if
 392
 393               // necessary.
 394             }
 395           }
 396         } catch (java.io.IOException ex)
 397         {
 398           error = ex.getMessage();
 399         }
 400
 401         if ((al != null) && (al.getHeight() > 0) && al.hasValidSequence())
 402         {
 403           // construct and register dataset sequences
 404           for (SequenceI sq : al.getSequences())
 405           {
 406             while (sq.getDatasetSequence() != null)
 407             {
 408               sq = sq.getDatasetSequence();
 409             }
 410             if (sq.getAllPDBEntries() != null)
 411             {
 412               for (PDBEntry pdbe : sq.getAllPDBEntries())
 413               {
 414                 // register PDB entries with desktop's structure selection
 415                 // manager
 416                 StructureSelectionManager
 417                         .getStructureSelectionManager(Desktop.instance)
 418                         .registerPDBEntry(pdbe);
 419               }
 420             }
 421           }
 422
 423           FeatureSettingsModelI proxyColourScheme = source
 424                   .getFeatureColourScheme();
 425           if (viewport != null)
 426           {
 427             // append to existing alignment
 428             viewport.addAlignment(al, title);
 429             viewport.applyFeaturesStyle(proxyColourScheme);
 430           }
 431           else
 432           {
 433             // otherwise construct the alignFrame
 434
 435             if (source instanceof ComplexAlignFile)
 436             {
 437               HiddenColumns colSel = ((ComplexAlignFile) source)
 438                       .getHiddenColumns();
 439               SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
 440                       .getHiddenSequences();
 441               String colourSchemeName = ((ComplexAlignFile) source)
 442                       .getGlobalColourScheme();
 443               FeaturesDisplayedI fd = ((ComplexAlignFile) source)
 444                       .getDisplayedFeatures();
 445               alignFrame = new AlignFrame(al, hiddenSeqs, colSel,
 446                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 447               alignFrame.getViewport().setFeaturesDisplayed(fd);
 448               alignFrame.getViewport().setShowSequenceFeatures(
 449                       ((ComplexAlignFile) source).isShowSeqFeatures());
 450               ColourSchemeI cs = ColourSchemeMapper
 451                       .getJalviewColourScheme(colourSchemeName, al);
 452               if (cs != null)
 453               {
 454                 alignFrame.changeColour(cs);
 455               }
 456             }
 457             else
 458             {
 459               alignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 460                       AlignFrame.DEFAULT_HEIGHT);
 461               if (source instanceof FeaturesSourceI)
 462               {
 463                 alignFrame.getViewport().setShowSequenceFeatures(true);
 464               }
 465             }
 466             // add metadata and update ui
 467             if (!(protocol == DataSourceType.PASTE))
 468             {
 469               alignFrame.setFileName(file, format);
 470               alignFrame.setFileObject(selectedFile); // BH 2018 SwingJS
 471             }
 472             if (proxyColourScheme != null)
 473             {
 474               alignFrame.getViewport()
 475                       .applyFeaturesStyle(proxyColourScheme);
 476             }
 477             alignFrame.setStatus(MessageManager.formatMessage(
 478                     "label.successfully_loaded_file", new String[]
 479                     { title }));
 480
 481             if (raiseGUI)
 482             {
 483               // add the window to the GUI
 484               // note - this actually should happen regardless of raiseGUI
 485               // status in Jalview 3
 486               // TODO: define 'virtual desktop' for benefit of headless scripts
 487               // that perform queries to find the 'current working alignment'
 488               Desktop.addInternalFrame(alignFrame, title,
 489                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 490
 491               /*
 492                * for an Overview automatically opened with alignment,
 493                * set its title now alignFrame title has been set
 494                */
 495               alignFrame.alignPanel.setOverviewTitle(alignFrame);
 496             }
 497
 498             try
 499             {
 500               alignFrame.setMaximum(
 501                       Cache.getDefault("SHOW_FULLSCREEN", false));
 502             } catch (java.beans.PropertyVetoException ex)
 503             {
 504             }
 505           }
 506         }
 507         else
 508         {
 509           if (Desktop.instance != null)
 510           {
 511             Desktop.instance.stopLoading();
 512           }
 513
 514           final String errorMessage = MessageManager.getString(
 515                   "label.couldnt_load_file") + " " + title + "\n" + error;
 516           // TODO: refactor FileLoader to be independent of Desktop / Applet GUI
 517           // bits ?
 518           if (raiseGUI && Desktop.desktop != null)
 519           {
 520             javax.swing.SwingUtilities.invokeLater(new Runnable()
 521             {
 522               @Override
 523               public void run()
 524               {
 525                 JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 526                         errorMessage,
 527                         MessageManager
 528                                 .getString("label.error_loading_file"),
 529                         JvOptionPane.WARNING_MESSAGE);
 530               }
 531             });
 532           }
 533           else
 534           {
 535             System.err.println(errorMessage);
 536           }
 537         }
 538       }
 539
 540       updateRecentlyOpened();
 541
 542     } catch (Exception er)
 543     {
 544       System.err.println("Exception whilst opening file '" + file);
 545       er.printStackTrace();
 546       if (raiseGUI)
 547       {
 548         javax.swing.SwingUtilities.invokeLater(new Runnable()
 549         {
 550           @Override
 551           public void run()
 552           {
 553             JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 554                     MessageManager.formatMessage(
 555                             "label.problems_opening_file", new String[]
 556                             { file }),
 557                     MessageManager.getString("label.file_open_error"),
 558                     JvOptionPane.WARNING_MESSAGE);
 559           }
 560         });
 561       }
 562       alignFrame = null;
 563     } catch (OutOfMemoryError er)
 564     {
 565
 566       er.printStackTrace();
 567       alignFrame = null;
 568       if (raiseGUI)
 569       {
 570         javax.swing.SwingUtilities.invokeLater(new Runnable()
 571         {
 572           @Override
 573           public void run()
 574           {
 575             JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 576                     MessageManager.formatMessage(
 577                             "warn.out_of_memory_loading_file", new String[]
 578                             { file }),
 579                     MessageManager.getString("label.out_of_memory"),
 580                     JvOptionPane.WARNING_MESSAGE);
 581           }
 582         });
 583       }
 584       System.err.println("Out of memory loading file " + file + "!!");
 585
 586     }
 587     loadtime += System.currentTimeMillis();
 588     // TODO: Estimate percentage of memory used by a newly loaded alignment -
 589     // warn if more memory will be needed to work with it
 590     // System.gc();
 591     memused = memused
 592             - (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // difference
 593     // in free
 594     // memory
 595     // after
 596     // load
 597     if (Desktop.desktop != null && Desktop.desktop.isShowMemoryUsage())
 598     {
 599       if (alignFrame != null)
 600       {
 601         AlignmentI al = alignFrame.getViewport().getAlignment();
 602
 603         System.out.println("Loaded '" + title + "' in "
 604                 + (loadtime / 1000.0) + "s, took an additional "
 605                 + (1.0 * memused / (1024.0 * 1024.0)) + " MB ("
 606                 + al.getHeight() + " seqs by " + al.getWidth() + " cols)");
 607       }
 608       else
 609       {
 610         // report that we didn't load anything probably due to an out of memory
 611         // error
 612         System.out.println("Failed to load '" + title + "' in "
 613                 + (loadtime / 1000.0) + "s, took an additional "
 614                 + (1.0 * memused / (1024.0 * 1024.0))
 615                 + " MB (alignment is null)");
 616       }
 617     }
 618     // remove the visual delay indicator
 619     if (Desktop.instance != null)
 620     {
 621       Desktop.instance.stopLoading();
 622     }
 623
 624     this.setShouldBeSaved();
 625   }
 626
 627   /**
 628    * This method creates the file -
 629    * {tmpdir}/jalview/{current_timestamp}/fileName.exetnsion using the supplied
 630    * file name and extension
 631    *
 632    * @param fileName
 633    *          the name of the temp file to be created
 634    * @param extension
 635    *          the extension of the temp file to be created
 636    * @return
 637    */
 638   private static String createNamedJvTempFile(String fileName,
 639           String extension) throws IOException
 640   {
 641     String seprator = System.getProperty("file.separator");
 642     String jvTempDir = System.getProperty("java.io.tmpdir") + "jalview"
 643             + seprator + System.currentTimeMillis();
 644     File tempStructFile = new File(
 645             jvTempDir + seprator + fileName + "." + extension);
 646     tempStructFile.mkdirs();
 647     return tempStructFile.toString();
 648   }
 649
 650   /*
 651    * set whether quit should ask to save when just loaded this source
 652    */
 653   private void setShouldBeSaved()
 654   {
 655     if (protocol == null)
 656       return;
 657     AlignFrame af = this.alignFrame;
 658     if (af == null)
 659       return;
 660     AlignViewport avp = af.getViewport();
 661     if (avp == null)
 662       return;
 663     avp.setSavedUpToDate(!protocol.isDynamic(),
 664             QuitHandler.Message.UNSAVED_ALIGNMENTS);
 665   }
 666
 667 }