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