JAL-3949 Complete new abstracted logging framework in jalview.log. Updated log calls...
[jalview.git] / src / jalview / io / FileLoader.java
index 73c10df..3d2dded 100755 (executable)
  */
 package jalview.io;
 
+import java.io.File;
+import java.io.IOException;
+import java.util.StringTokenizer;
+import java.util.Vector;
+
+import javax.swing.SwingUtilities;
+
 import jalview.api.ComplexAlignFile;
+import jalview.api.FeatureSettingsModelI;
 import jalview.api.FeaturesDisplayedI;
+import jalview.api.FeaturesSourceI;
+import jalview.bin.Cache;
 import jalview.bin.Jalview;
 import jalview.datamodel.AlignmentI;
-import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
 import jalview.gui.AlignFrame;
 import jalview.gui.AlignViewport;
 import jalview.gui.Desktop;
-import jalview.gui.Jalview2XML;
+import jalview.gui.JvOptionPane;
+import jalview.json.binding.biojson.v1.ColourSchemeMapper;
+import jalview.project.Jalview2XML;
 import jalview.schemes.ColourSchemeI;
 import jalview.structure.StructureSelectionManager;
 import jalview.util.MessageManager;
-
-import java.util.StringTokenizer;
-import java.util.Vector;
-
-import javax.swing.JOptionPane;
-import javax.swing.SwingUtilities;
+import jalview.ws.utils.UrlDownloadClient;
 
 public class FileLoader implements Runnable
 {
   String file;
 
-  String protocol;
+  DataSourceType protocol;
 
-  String format;
+  FileFormatI format;
 
-  FileParse source = null; // alternative specification of where data comes
+  AlignmentFileReaderI source = null; // alternative specification of where data
+                                      // comes
 
   // from
 
@@ -63,6 +71,8 @@ public class FileLoader implements Runnable
 
   boolean raiseGUI = true;
 
+  private File selectedFile;
+
   /**
    * default constructor always raised errors in GUI dialog boxes
    */
@@ -82,14 +92,19 @@ public class FileLoader implements Runnable
     this.raiseGUI = raiseGUI;
   }
 
-  public void LoadFile(AlignViewport viewport, String file,
-          String protocol, String format)
+  public void LoadFile(AlignViewport viewport, Object file,
+          DataSourceType protocol, FileFormatI format)
   {
     this.viewport = viewport;
-    LoadFile(file, protocol, format);
+    if (file instanceof File) {
+      this.selectedFile = (File) file;
+      file = selectedFile.getPath();
+    }
+    LoadFile(file.toString(), protocol, format);
   }
 
-  public void LoadFile(String file, String protocol, String format)
+  public void LoadFile(String file, DataSourceType protocol,
+          FileFormatI format)
   {
     this.file = file;
     this.protocol = protocol;
@@ -99,6 +114,7 @@ public class FileLoader implements Runnable
 
     SwingUtilities.invokeLater(new Runnable()
     {
+      @Override
       public void run()
       {
         loader.start();
@@ -112,7 +128,7 @@ public class FileLoader implements Runnable
    * @param file
    * @param protocol
    */
-  public void LoadFile(String file, String protocol)
+  public void LoadFile(String file, DataSourceType protocol)
   {
     LoadFile(file, protocol, null);
   }
@@ -121,27 +137,46 @@ public class FileLoader implements Runnable
    * Load alignment from (file, protocol) and wait till loaded
    * 
    * @param file
-   * @param protocol
+   * @param sourceType
    * @return alignFrame constructed from file contents
    */
-  public AlignFrame LoadFileWaitTillLoaded(String file, String protocol)
+  public AlignFrame LoadFileWaitTillLoaded(String file,
+          DataSourceType sourceType)
   {
-    return LoadFileWaitTillLoaded(file, protocol, null);
+    return LoadFileWaitTillLoaded(file, sourceType, null);
   }
 
   /**
    * Load alignment from (file, protocol) of type format and wait till loaded
    * 
    * @param file
-   * @param protocol
+   * @param sourceType
    * @param format
    * @return alignFrame constructed from file contents
    */
-  public AlignFrame LoadFileWaitTillLoaded(String file, String protocol,
-          String format)
+  public AlignFrame LoadFileWaitTillLoaded(String file,
+          DataSourceType sourceType, FileFormatI format)
   {
     this.file = file;
-    this.protocol = protocol;
+    this.protocol = sourceType;
+    this.format = format;
+    return _LoadFileWaitTillLoaded();
+  }
+
+  /**
+   * Load alignment from (file, protocol) of type format and wait till loaded
+   * 
+   * @param file
+   * @param sourceType
+   * @param format
+   * @return alignFrame constructed from file contents
+   */
+  public AlignFrame LoadFileWaitTillLoaded(File file,
+          DataSourceType sourceType, FileFormatI format)
+  {
+    this.selectedFile = file;
+    this.file = file.getPath();
+    this.protocol = sourceType;
     this.format = format;
     return _LoadFileWaitTillLoaded();
   }
@@ -153,53 +188,49 @@ public class FileLoader implements Runnable
    * @param format
    * @return alignFrame constructed from file contents
    */
-  public AlignFrame LoadFileWaitTillLoaded(FileParse source, String format)
+  public AlignFrame LoadFileWaitTillLoaded(AlignmentFileReaderI source,
+          FileFormatI format)
   {
     this.source = source;
 
     file = source.getInFile();
-    protocol = source.type;
+    protocol = source.getDataSourceType();
     this.format = format;
     return _LoadFileWaitTillLoaded();
   }
 
   /**
-   * start thread and wait until finished, then return the alignFrame that's
-   * (hopefully) been read.
+   * runs the 'run' method (in this thread), then return the alignFrame that's
+   * (hopefully) been read
    * 
    * @return
    */
   protected AlignFrame _LoadFileWaitTillLoaded()
   {
-    Thread loader = new Thread(this);
-    loader.start();
-
-    while (loader.isAlive())
-    {
-      try
-      {
-        Thread.sleep(500);
-      } catch (Exception ex)
-      {
-      }
-    }
+    this.run();
 
     return alignFrame;
   }
 
   public void updateRecentlyOpened()
   {
-    Vector recent = new Vector();
-    if (protocol.equals(FormatAdapter.PASTE))
+    Vector<String> recent = new Vector<>();
+    if (protocol == DataSourceType.PASTE)
     {
       // do nothing if the file was pasted in as text... there is no filename to
       // refer to it as.
       return;
     }
-    String type = protocol.equals(FormatAdapter.FILE) ? "RECENT_FILE"
+    if (file != null
+            && file.indexOf(System.getProperty("java.io.tmpdir")) > -1)
+    {
+      // ignore files loaded from the system's temporary directory
+      return;
+    }
+    String type = protocol == DataSourceType.FILE ? "RECENT_FILE"
             : "RECENT_URL";
 
-    String historyItems = jalview.bin.Cache.getProperty(type);
+    String historyItems = Cache.getProperty(type);
 
     StringTokenizer st;
 
@@ -209,7 +240,7 @@ public class FileLoader implements Runnable
 
       while (st.hasMoreTokens())
       {
-        recent.addElement(st.nextElement().toString().trim());
+        recent.addElement(st.nextToken().trim());
       }
     }
 
@@ -225,17 +256,19 @@ public class FileLoader implements Runnable
       newHistory.append(recent.elementAt(i));
     }
 
-    jalview.bin.Cache.setProperty(type, newHistory.toString());
+    Cache.setProperty(type, newHistory.toString());
 
-    if (protocol.equals(FormatAdapter.FILE))
+    if (protocol == DataSourceType.FILE)
     {
-      jalview.bin.Cache.setProperty("DEFAULT_FILE_FORMAT", format);
+      Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
     }
   }
 
+  @Override
   public void run()
   {
-    String title = protocol.equals(AppletFormatAdapter.PASTE) ? "Copied From Clipboard"
+    String title = protocol == DataSourceType.PASTE
+            ? "Copied From Clipboard"
             : file;
     Runtime rt = Runtime.getRuntime();
     try
@@ -249,29 +282,32 @@ public class FileLoader implements Runnable
         // just in case the caller didn't identify the file for us
         if (source != null)
         {
-          format = new IdentifyFile().Identify(source, false); // identify
-          // stream and
-          // rewind rather
-          // than close
+          format = new IdentifyFile().identify(source, false);
+          // identify stream and rewind rather than close
+        }
+        else if (selectedFile != null) {
+          format = new IdentifyFile().identify(selectedFile, protocol);
         }
         else
         {
-          format = new IdentifyFile().Identify(file, protocol);
+          format = new IdentifyFile().identify(file, protocol);
         }
 
       }
 
-      if (format == null || format.equalsIgnoreCase("EMPTY DATA FILE"))
+      if (format == null)
       {
         Desktop.instance.stopLoading();
         System.err.println("The input file \"" + file
                 + "\" has null or unidentifiable data content!");
         if (!Jalview.isHeadlessMode())
         {
-          JOptionPane.showMessageDialog(null, "The input file \"" + file
-                  + "\" has null or unidentifiable data content!",
-                  "Empty data file",
-                  JOptionPane.ERROR_MESSAGE);
+          JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+                  MessageManager.getString("label.couldnt_read_data")
+                          + " in " + file + "\n"
+                          + AppletFormatAdapter.getSupportedFormats(),
+                  MessageManager.getString("label.couldnt_read_data"),
+                  JvOptionPane.WARNING_MESSAGE);
         }
         return;
       }
@@ -288,53 +324,73 @@ public class FileLoader implements Runnable
       loadtime = -System.currentTimeMillis();
       AlignmentI al = null;
 
-      if (format.equalsIgnoreCase("Jalview"))
+      if (FileFormat.Jalview.equals(format))
       {
         if (source != null)
         {
           // Tell the user (developer?) that this is going to cause a problem
-          System.err
-                  .println("IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
+          System.err.println(
+                  "IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
           // We read the data anyway - it might make sense.
         }
-        alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(file);
+        // BH 2018 switch to File object here instead of filename
+        alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(selectedFile == null ? file : selectedFile);
       }
       else
       {
-        String error = AppletFormatAdapter.SUPPORTED_FORMATS;
-        if (FormatAdapter.isValidFormat(format))
+        String error = AppletFormatAdapter.getSupportedFormats();
+        try
         {
-          try
+          if (source != null)
           {
-            if (source != null)
+            // read from the provided source
+            al = new FormatAdapter().readFromFile(source, format);
+          }
+          else
+          {
+
+            // open a new source and read from it
+            FormatAdapter fa = new FormatAdapter();
+            boolean downloadStructureFile = format.isStructureFile()
+                    && protocol.equals(DataSourceType.URL);
+            if (downloadStructureFile)
             {
-              // read from the provided source
-              al = new FormatAdapter().readFromFile(source, format);
+              String structExt = format.getExtensions().split(",")[0];
+              String urlLeafName = file.substring(
+                      file.lastIndexOf(
+                              System.getProperty("file.separator")),
+                      file.lastIndexOf("."));
+              String tempStructureFileStr = createNamedJvTempFile(
+                      urlLeafName, structExt);
+              
+              // BH - switching to File object here so as to hold
+              // ._bytes array directly
+              File tempFile = new File(tempStructureFileStr);
+              UrlDownloadClient.download(file, tempFile);
+              
+              al = fa.readFile(tempFile, DataSourceType.FILE,
+                      format);
+              source = fa.getAlignFile();
             }
             else
             {
-
-              // open a new source and read from it
-              FormatAdapter fa = new FormatAdapter();
-              al = fa.readFile(file, protocol, format);
+              if (selectedFile == null) {
+                al = fa.readFile(file, protocol, format);
+                
+              } else {
+                al = fa.readFile(selectedFile, protocol, format);
+                             }
               source = fa.getAlignFile(); // keep reference for later if
+              
                                           // necessary.
             }
-          } catch (java.io.IOException ex)
-          {
-            error = ex.getMessage();
           }
-        }
-        else
+        } catch (java.io.IOException ex)
         {
-          if (format != null && format.length() > 7)
-          {
-            // ad hoc message in format.
-            error = format + "\n" + error;
-          }
+          error = ex.getMessage();
         }
 
-        if ((al != null) && (al.getHeight() > 0))
+        if ((al != null) && (al.getHeight() > 0) && al.hasValidSequence())
         {
           // construct and register dataset sequences
           for (SequenceI sq : al.getSequences())
@@ -343,22 +399,26 @@ public class FileLoader implements Runnable
             {
               sq = sq.getDatasetSequence();
             }
-            if (sq.getPDBId() != null)
+            if (sq.getAllPDBEntries() != null)
             {
-              for (PDBEntry pdbe : sq.getPDBId())
+              for (PDBEntry pdbe : sq.getAllPDBEntries())
               {
                 // register PDB entries with desktop's structure selection
                 // manager
-                StructureSelectionManager.getStructureSelectionManager(
-                        Desktop.instance).registerPDBEntry(pdbe);
+                StructureSelectionManager
+                        .getStructureSelectionManager(Desktop.instance)
+                        .registerPDBEntry(pdbe);
               }
             }
           }
 
+          FeatureSettingsModelI proxyColourScheme = source
+                  .getFeatureColourScheme();
           if (viewport != null)
           {
             // append to existing alignment
             viewport.addAlignment(al, title);
+            viewport.applyFeaturesStyle(proxyColourScheme);
           }
           else
           {
@@ -366,36 +426,47 @@ public class FileLoader implements Runnable
 
             if (source instanceof ComplexAlignFile)
             {
-              ColumnSelection colSel = ((ComplexAlignFile) source)
-                      .getColumnSelection();
+              HiddenColumns colSel = ((ComplexAlignFile) source)
+                      .getHiddenColumns();
               SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
                       .getHiddenSequences();
-              boolean showSeqFeatures = ((ComplexAlignFile) source)
-                      .isShowSeqFeatures();
-              ColourSchemeI cs = ((ComplexAlignFile) source)
-                      .getColourScheme();
+              String colourSchemeName = ((ComplexAlignFile) source)
+                      .getGlobalColourScheme();
               FeaturesDisplayedI fd = ((ComplexAlignFile) source)
                       .getDisplayedFeatures();
               alignFrame = new AlignFrame(al, hiddenSeqs, colSel,
                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
-
-              alignFrame.getViewport().setShowSequenceFeatures(
-                      showSeqFeatures);
               alignFrame.getViewport().setFeaturesDisplayed(fd);
-              alignFrame.changeColour(cs);
+              alignFrame.getViewport().setShowSequenceFeatures(
+                      ((ComplexAlignFile) source).isShowSeqFeatures());
+              ColourSchemeI cs = ColourSchemeMapper
+                      .getJalviewColourScheme(colourSchemeName, al);
+              if (cs != null)
+              {
+                alignFrame.changeColour(cs);
+              }
             }
             else
             {
               alignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
                       AlignFrame.DEFAULT_HEIGHT);
+              if (source instanceof FeaturesSourceI)
+              {
+                alignFrame.getViewport().setShowSequenceFeatures(true);
+              }
             }
             // add metadata and update ui
-            if (!protocol.equals(AppletFormatAdapter.PASTE))
+            if (!(protocol == DataSourceType.PASTE))
             {
               alignFrame.setFileName(file, format);
+              alignFrame.setFileObject(selectedFile); // BH 2018 SwingJS
             }
-
-            alignFrame.statusBar.setText(MessageManager.formatMessage(
+            if (proxyColourScheme != null)
+            {
+              alignFrame.getViewport()
+                      .applyFeaturesStyle(proxyColourScheme);
+            }
+            alignFrame.setStatus(MessageManager.formatMessage(
                     "label.successfully_loaded_file", new String[]
                     { title }));
 
@@ -412,8 +483,8 @@ public class FileLoader implements Runnable
 
             try
             {
-              alignFrame.setMaximum(jalview.bin.Cache.getDefault(
-                      "SHOW_FULLSCREEN", false));
+              alignFrame.setMaximum(Cache
+                      .getDefault("SHOW_FULLSCREEN", false));
             } catch (java.beans.PropertyVetoException ex)
             {
             }
@@ -426,20 +497,22 @@ public class FileLoader implements Runnable
             Desktop.instance.stopLoading();
           }
 
-          final String errorMessage = "Couldn't load file " + title + "\n"
-                  + error;
+          final String errorMessage = MessageManager.getString(
+                  "label.couldnt_load_file") + " " + title + "\n" + error;
           // TODO: refactor FileLoader to be independent of Desktop / Applet GUI
           // bits ?
           if (raiseGUI && Desktop.desktop != null)
           {
             javax.swing.SwingUtilities.invokeLater(new Runnable()
             {
+              @Override
               public void run()
               {
-                JOptionPane.showInternalMessageDialog(Desktop.desktop,
-                        errorMessage, MessageManager
+                JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+                        errorMessage,
+                        MessageManager
                                 .getString("label.error_loading_file"),
-                        JOptionPane.WARNING_MESSAGE);
+                        JvOptionPane.WARNING_MESSAGE);
               }
             });
           }
@@ -460,14 +533,15 @@ public class FileLoader implements Runnable
       {
         javax.swing.SwingUtilities.invokeLater(new Runnable()
         {
+          @Override
           public void run()
           {
-            javax.swing.JOptionPane.showInternalMessageDialog(
-                    Desktop.desktop, MessageManager.formatMessage(
+            JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+                    MessageManager.formatMessage(
                             "label.problems_opening_file", new String[]
-                            { file }), MessageManager
-                            .getString("label.file_open_error"),
-                    javax.swing.JOptionPane.WARNING_MESSAGE);
+                            { file }),
+                    MessageManager.getString("label.file_open_error"),
+                    JvOptionPane.WARNING_MESSAGE);
           }
         });
       }
@@ -481,14 +555,15 @@ public class FileLoader implements Runnable
       {
         javax.swing.SwingUtilities.invokeLater(new Runnable()
         {
+          @Override
           public void run()
           {
-            javax.swing.JOptionPane.showInternalMessageDialog(
-                    Desktop.desktop, MessageManager.formatMessage(
+            JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+                    MessageManager.formatMessage(
                             "warn.out_of_memory_loading_file", new String[]
-                            { file }), MessageManager
-                            .getString("label.out_of_memory"),
-                    javax.swing.JOptionPane.WARNING_MESSAGE);
+                            { file }),
+                    MessageManager.getString("label.out_of_memory"),
+                    JvOptionPane.WARNING_MESSAGE);
           }
         });
       }
@@ -534,17 +609,27 @@ public class FileLoader implements Runnable
 
   }
 
-  /*
-   * (non-Javadoc)
+  /**
+   * This method creates the file -
+   * {tmpdir}/jalview/{current_timestamp}/fileName.exetnsion using the supplied
+   * file name and extension
    * 
-   * @see java.lang.Object#finalize()
+   * @param fileName
+   *          the name of the temp file to be created
+   * @param extension
+   *          the extension of the temp file to be created
+   * @return
    */
-  protected void finalize() throws Throwable
+  private static String createNamedJvTempFile(String fileName,
+          String extension) throws IOException
   {
-    source = null;
-    alignFrame = null;
-    viewport = null;
-    super.finalize();
+    String seprator = System.getProperty("file.separator");
+    String jvTempDir = System.getProperty("java.io.tmpdir") + "jalview"
+            + seprator + System.currentTimeMillis();
+    File tempStructFile = new File(
+            jvTempDir + seprator + fileName + "." + extension);
+    tempStructFile.mkdirs();
+    return tempStructFile.toString();
   }
 
 }