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.FeatureSettingsModelI;
  25 import jalview.api.FeaturesDisplayedI;
  26 import jalview.api.FeaturesSourceI;
  27 import jalview.bin.Cache;
  28 import jalview.bin.Jalview;
  29 import jalview.datamodel.AlignmentI;
  30 import jalview.datamodel.HiddenColumns;
  31 import jalview.datamodel.PDBEntry;
  32 import jalview.datamodel.SequenceI;
  33 import jalview.gui.AlignFrame;
  34 import jalview.gui.AlignViewport;
  35 import jalview.gui.Desktop;
  36 import jalview.gui.JvOptionPane;
  37 import jalview.json.binding.biojson.v1.ColourSchemeMapper;
  38 import jalview.project.Jalview2XML;
  39 import jalview.schemes.ColourSchemeI;
  40 import jalview.structure.StructureSelectionManager;
  41 import jalview.util.MessageManager;
  42 import jalview.ws.utils.UrlDownloadClient;
  43
  44 import java.io.BufferedReader;
  45 import java.io.ByteArrayInputStream;
  46 import java.io.File;
  47 import java.io.FileNotFoundException;
  48 import java.io.FileReader;
  49 import java.io.IOException;
  50 import java.io.InputStream;
  51 import java.io.InputStreamReader;
  52 import java.util.StringTokenizer;
  53 import java.util.Vector;
  54
  55 import javax.swing.SwingUtilities;
  56
  57 public class FileLoader implements Runnable
  58 {
  59   String file;
  60
  61   DataSourceType protocol;
  62
  63   FileFormatI format;
  64
  65   AlignmentFileReaderI source = null; // alternative specification of where data
  66                                       // comes
  67
  68   // from
  69
  70   AlignViewport viewport;
  71
  72   AlignFrame alignFrame;
  73
  74   long loadtime;
  75
  76   long memused;
  77
  78   boolean raiseGUI = true;
  79
  80   private File selectedFile;
  81
  82   /**
  83    * default constructor always raised errors in GUI dialog boxes
  84    */
  85   public FileLoader()
  86   {
  87     this(true);
  88   }
  89
  90   /**
  91    * construct a Fileloader that may raise errors non-interactively
  92    *
  93    * @param raiseGUI
  94    *          true if errors are to be raised as GUI dialog boxes
  95    */
  96   public FileLoader(boolean raiseGUI)
  97   {
  98     this.raiseGUI = raiseGUI;
  99   }
 100
 101   public void LoadFile(AlignViewport viewport, Object file,
 102           DataSourceType protocol, FileFormatI format)
 103   {
 104     this.viewport = viewport;
 105     if (file instanceof File) {
 106       this.selectedFile = (File) file;
 107       file = selectedFile.getPath();
 108     }
 109     LoadFile(file.toString(), protocol, format);
 110   }
 111
 112   public void LoadFile(String file, DataSourceType protocol,
 113           FileFormatI format)
 114   {
 115     this.file = file;
 116     this.protocol = protocol;
 117     this.format = format;
 118
 119     final Thread loader = new Thread(this);
 120
 121     SwingUtilities.invokeLater(new Runnable()
 122     {
 123       @Override
 124       public void run()
 125       {
 126         loader.start();
 127       }
 128     });
 129   }
 130
 131   /**
 132    * Load a (file, protocol) source of unknown type
 133    *
 134    * @param file
 135    * @param protocol
 136    */
 137   public void LoadFile(String file, DataSourceType protocol)
 138   {
 139     LoadFile(file, protocol, null);
 140   }
 141
 142   /**
 143    * Load alignment from (file, protocol) and wait till loaded
 144    *
 145    * @param file
 146    * @param sourceType
 147    * @return alignFrame constructed from file contents
 148    */
 149   public AlignFrame LoadFileWaitTillLoaded(String file,
 150           DataSourceType sourceType)
 151   {
 152     return LoadFileWaitTillLoaded(file, sourceType, null);
 153   }
 154
 155   /**
 156    * Load alignment from (file, protocol) of type format and wait till loaded
 157    *
 158    * @param file
 159    * @param sourceType
 160    * @param format
 161    * @return alignFrame constructed from file contents
 162    */
 163   public AlignFrame LoadFileWaitTillLoaded(String file,
 164           DataSourceType sourceType, FileFormatI format)
 165   {
 166     this.file = file;
 167     this.protocol = sourceType;
 168     this.format = format;
 169     return _LoadFileWaitTillLoaded();
 170   }
 171
 172   /**
 173    * Load alignment from (file, protocol) of type format and wait till loaded
 174    *
 175    * @param file
 176    * @param sourceType
 177    * @param format
 178    * @return alignFrame constructed from file contents
 179    */
 180   public AlignFrame LoadFileWaitTillLoaded(File file,
 181           DataSourceType sourceType, FileFormatI format)
 182   {
 183     this.selectedFile = file;
 184     this.file = file.getPath();
 185     this.protocol = sourceType;
 186     this.format = format;
 187     return _LoadFileWaitTillLoaded();
 188   }
 189
 190   /**
 191    * Load alignment from FileParse source of type format and wait till loaded
 192    *
 193    * @param source
 194    * @param format
 195    * @return alignFrame constructed from file contents
 196    */
 197   public AlignFrame LoadFileWaitTillLoaded(AlignmentFileReaderI source,
 198           FileFormatI format)
 199   {
 200     this.source = source;
 201
 202     file = source.getInFile();
 203     protocol = source.getDataSourceType();
 204     this.format = format;
 205     return _LoadFileWaitTillLoaded();
 206   }
 207
 208   /**
 209    * runs the 'run' method (in this thread), then return the alignFrame that's
 210    * (hopefully) been read
 211    *
 212    * @return
 213    */
 214   protected AlignFrame _LoadFileWaitTillLoaded()
 215   {
 216     this.run();
 217     return alignFrame;
 218   }
 219
 220   public void updateRecentlyOpened()
 221   {
 222     Vector<String> recent = new Vector<>();
 223     if (protocol == DataSourceType.PASTE)
 224     {
 225       // do nothing if the file was pasted in as text... there is no filename to
 226       // refer to it as.
 227       return;
 228     }
 229     if (file != null
 230             && file.indexOf(System.getProperty("java.io.tmpdir")) > -1)
 231     {
 232       // ignore files loaded from the system's temporary directory
 233       return;
 234     }
 235     String type = protocol == DataSourceType.FILE ? "RECENT_FILE"
 236             : "RECENT_URL";
 237
 238     String historyItems = Cache.getProperty(type);
 239
 240     StringTokenizer st;
 241
 242     if (historyItems != null)
 243     {
 244       st = new StringTokenizer(historyItems, "\t");
 245
 246       while (st.hasMoreTokens())
 247       {
 248         recent.addElement(st.nextToken().trim());
 249       }
 250     }
 251
 252     if (recent.contains(file))
 253     {
 254       recent.remove(file);
 255     }
 256
 257     StringBuffer newHistory = new StringBuffer(file);
 258     for (int i = 0; i < recent.size() && i < 10; i++)
 259     {
 260       newHistory.append("\t");
 261       newHistory.append(recent.elementAt(i));
 262     }
 263
 264     Cache.setProperty(type, newHistory.toString());
 265
 266     if (protocol == DataSourceType.FILE)
 267     {
 268       Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
 269     }
 270   }
 271
 272   @Override
 273   public void run()
 274   {
 275     String title = protocol == DataSourceType.PASTE
 276             ? "Copied From Clipboard"
 277             : file;
 278     Runtime rt = Runtime.getRuntime();
 279     try
 280     {
 281       if (Desktop.instance != null)
 282       {
 283         Desktop.instance.startLoading(file);
 284       }
 285       if (format == null)
 286       {
 287         // just in case the caller didn't identify the file for us
 288         if (source != null)
 289         {
 290           format = new IdentifyFile().identify(source, false);
 291           // identify stream and rewind rather than close
 292         }
 293         else if (selectedFile != null) {
 294           format = new IdentifyFile().identify(selectedFile, protocol);
 295         }
 296         else
 297         {
 298           format = new IdentifyFile().identify(file, protocol);
 299         }
 300
 301       }
 302
 303       if (format == null)
 304       {
 305         Desktop.instance.stopLoading();
 306         System.err.println("The input file \"" + file
 307                 + "\" has null or unidentifiable data content!");
 308         if (!Jalview.isHeadlessMode())
 309         {
 310           JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 311                   MessageManager.getString("label.couldnt_read_data")
 312                           + " in " + file + "\n"
 313                           + AppletFormatAdapter.getSupportedFormats(),
 314                   MessageManager.getString("label.couldnt_read_data"),
 315                   JvOptionPane.WARNING_MESSAGE);
 316         }
 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(selectedFile == null ? file : selectedFile);
 343       }
 344       else
 345       {
 346         String error = AppletFormatAdapter.getSupportedFormats();
 347         try
 348         {
 349           if (source != null)
 350           {
 351             // read from the provided source
 352             al = new FormatAdapter().readFromFile(source, format);
 353           }
 354           else
 355           {
 356
 357             // open a new source and read from it
 358             FormatAdapter fa = new FormatAdapter();
 359             boolean downloadStructureFile = format.isStructureFile()
 360                     && protocol.equals(DataSourceType.URL);
 361             if (downloadStructureFile)
 362             {
 363               String structExt = format.getExtensions().split(",")[0];
 364               String urlLeafName = file.substring(
 365                       file.lastIndexOf(
 366                               System.getProperty("file.separator")),
 367                       file.lastIndexOf("."));
 368               String tempStructureFileStr = createNamedJvTempFile(
 369                       urlLeafName, structExt);
 370
 371               // BH - switching to File object here so as to hold
 372               // ._bytes array directly
 373               File tempFile = new File(tempStructureFileStr);
 374               UrlDownloadClient.download(file, tempFile);
 375
 376               al = fa.readFile(tempFile, DataSourceType.FILE,
 377                       format);
 378               source = fa.getAlignFile();
 379             }
 380             else
 381             {
 382               if (selectedFile == null) {
 383                 al = fa.readFile(file, protocol, format);
 384
 385               } else {
 386                 al = fa.readFile(selectedFile, protocol, format);
 387                              }
 388               source = fa.getAlignFile(); // keep reference for later if
 389
 390                                           // necessary.
 391             }
 392           }
 393         } catch (java.io.IOException ex)
 394         {
 395           error = ex.getMessage();
 396         }
 397
 398         if ((al != null) && (al.getHeight() > 0) && al.hasValidSequence())
 399         {
 400           // construct and register dataset sequences
 401           for (SequenceI sq : al.getSequences())
 402           {
 403             while (sq.getDatasetSequence() != null)
 404             {
 405               sq = sq.getDatasetSequence();
 406             }
 407             if (sq.getAllPDBEntries() != null)
 408             {
 409               for (PDBEntry pdbe : sq.getAllPDBEntries())
 410               {
 411                 // register PDB entries with desktop's structure selection
 412                 // manager
 413                 StructureSelectionManager
 414                         .getStructureSelectionManager(Desktop.instance)
 415                         .registerPDBEntry(pdbe);
 416               }
 417             }
 418           }
 419
 420           FeatureSettingsModelI proxyColourScheme = source
 421                   .getFeatureColourScheme();
 422           if (viewport != null)
 423           {
 424             if (proxyColourScheme != null)
 425             {
 426               viewport.applyFeaturesStyle(proxyColourScheme);
 427             }
 428             // append to existing alignment
 429             viewport.addAlignment(al, title);
 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             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.instance != null)
 504           {
 505             Desktop.instance.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.desktop != null)
 513           {
 514             javax.swing.SwingUtilities.invokeLater(new Runnable()
 515             {
 516               @Override
 517               public void run()
 518               {
 519                 JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 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.desktop,
 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.desktop,
 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.desktop != null && Desktop.desktop.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.instance != null)
 614     {
 615       Desktop.instance.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   /**
 644    *
 645    * @param file a File, or a String which is a name of a file
 646    * @return
 647    * @throws FileNotFoundException
 648    */
 649   @SuppressWarnings("unused")
 650   public static BufferedReader getBuffereReader(Object file) throws FileNotFoundException {
 651     if (file instanceof String)
 652       return new BufferedReader(new FileReader((String) file));
 653
 654     byte[] bytes = /** @j2sNative file._bytes || */ null;
 655     if (bytes != null)
 656       return new BufferedReader(new InputStreamReader(new ByteArrayInputStream(bytes)));
 657     return  new BufferedReader(new FileReader((File) file));
 658   }
 659
 660 }