Merge branch 'develop' into bug/JAL-2323disulfideOverview
[jalview.git] / src / jalview / io / BioJsHTMLOutput.java
index b49c2e0..1be97f5 100644 (file)
@@ -1,11 +1,30 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.io;
 
 import jalview.exceptions.NoFileSelectedException;
-import jalview.gui.AlignViewport;
 import jalview.gui.AlignmentPanel;
-import jalview.gui.FeatureRenderer;
-import jalview.json.binding.v1.BioJSReleasePojo;
-import jalview.json.binding.v1.BioJSRepositoryPojo;
+import jalview.gui.OOMWarning;
+import jalview.json.binding.biojs.BioJSReleasePojo;
+import jalview.json.binding.biojs.BioJSRepositoryPojo;
 import jalview.util.MessageManager;
 
 import java.io.BufferedInputStream;
@@ -20,10 +39,8 @@ import java.net.URL;
 import java.util.Objects;
 import java.util.TreeMap;
 
-
-public class BioJsHTMLOutput
+public class BioJsHTMLOutput extends HTMLOutput
 {
-  private AlignViewport av;
 
   private static File currentBJSTemplateFile;
 
@@ -38,117 +55,59 @@ public class BioJsHTMLOutput
   public static final String BJS_TEMPLATE_GIT_REPO = jalview.bin.Cache
           .getDefault(
                   "biojs_template_git_repo",
-                  "https://raw.githubusercontent.com/tcofoegbu/bjs-template/master/package.json");
+                  "https://raw.githubusercontent.com/jalview/exporter-templates/master/biojs/package.json");
 
-  public BioJsHTMLOutput(AlignmentPanel ap, FeatureRenderer fr1)
+  public BioJsHTMLOutput(AlignmentPanel ap)
   {
-    if (ap != null)
-    {
-      this.av = ap.av;
-      av.setFeatureRenderer(new FeatureRenderer(ap));
-    }
+    super(ap);
   }
 
-  public void exportJalviewAlignmentAsBioJsHtmlFile()
+  @Override
+  public void exportHTML(String outputFile)
   {
+    exportStarted();
     try
     {
-      String outputFile = getOutputFile();
-      String jalviewAlignmentJson = JSONFile.getJSONData(av);
-      String bioJSTemplateString = getBioJsTemplateAsString();
+
+      if (outputFile == null)
+      {
+        outputFile = getOutputFile();
+      }
+      generatedFile = new File(outputFile);
+
+      String bioJSON = getBioJSONData();
+      String bioJSTemplateString = HTMLOutput.readFileAsString(getCurrentBJSTemplateFile());
       String generatedBioJsWithJalviewAlignmentAsJson = bioJSTemplateString
-              .replaceAll(
-"#sequenceData#", jalviewAlignmentJson)
-              .toString();
+              .replaceAll("#sequenceData#", bioJSON).toString();
 
       PrintWriter out = new java.io.PrintWriter(new java.io.FileWriter(
-              outputFile));
+              generatedFile));
       out.print(generatedBioJsWithJalviewAlignmentAsJson);
       out.flush();
       out.close();
-      jalview.util.BrowserLauncher.openURL("file:///" + outputFile);
+      exportCompleted();
+      setProgressMessage(MessageManager.formatMessage(
+              "status.export_complete", "BioJS"));
+
     } catch (NoFileSelectedException ex)
     {
       // do noting if no file was selected
+    } catch (OutOfMemoryError err)
+    {
+      System.out.println("########################\n" + "OUT OF MEMORY "
+              + outputFile + "\n" + "########################");
+      new OOMWarning("Creating Image for " + outputFile, err);
     } catch (Exception e)
     {
+      setProgressMessage(MessageManager.formatMessage(
+              "info.error_creating_file", "HTML"));
       e.printStackTrace();
     }
   }
 
-  public String getOutputFile() throws NoFileSelectedException
-  {
-    String selectedFile = null;
-    JalviewFileChooser jvFileChooser = new JalviewFileChooser(
-            jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
-            { "html" }, new String[]
-            { "HTML files" }, "HTML files");
-    jvFileChooser.setFileView(new JalviewFileView());
-
-    // TODO uncomment when supported by MassageManager
-    jvFileChooser.setDialogTitle(MessageManager
-            .getString("label.save_as_biojs_html"));
-    jvFileChooser.setDialogTitle("save as BioJs HTML");
-    jvFileChooser.setToolTipText(MessageManager.getString("action.save"));
-
-    int fileChooserOpt = jvFileChooser.showSaveDialog(null);
-    if (fileChooserOpt == JalviewFileChooser.APPROVE_OPTION)
-    {
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY", jvFileChooser
-              .getSelectedFile().getParent());
-      selectedFile = jvFileChooser.getSelectedFile().getPath();
-    }
-    else
-    {
-      throw new NoFileSelectedException("No file was selected.");
-    }
-    return selectedFile;
-  }
-
-
-  public static String getBioJsTemplateAsString()
-          throws IOException
-  {
-    InputStreamReader isReader = null;
-    BufferedReader buffReader = null;
-    StringBuilder sb = new StringBuilder();
-    Objects.requireNonNull(getCurrentBJSTemplateFile(),
-            "BioJsTemplate File not initialized!");
-    @SuppressWarnings("deprecation")
-    URL url = getCurrentBJSTemplateFile().toURL();
-    if (url != null)
-    {
-      try
-      {
-        isReader = new InputStreamReader(url.openStream());
-        buffReader = new BufferedReader(isReader);
-        String line;
-        String lineSeparator = System.getProperty("line.separator");
-        while ((line = buffReader.readLine()) != null)
-        {
-          sb.append(line).append(lineSeparator);
-        }
-
-      } catch (Exception ex)
-      {
-        ex.printStackTrace();
-      } finally
-      {
-        if (isReader != null)
-        {
-          isReader.close();
-        }
 
-        if (buffReader != null)
-        {
-          buffReader.close();
-        }
-      }
-    }
-    return sb.toString();
-  }
 
-  public void refreshBioJSVersionsInfo(String dirName)
+  public static void refreshVersionInfo(String dirName)
           throws URISyntaxException
   {
     File directory = new File(BJS_TEMPLATES_LOCAL_DIRECTORY);
@@ -181,19 +140,23 @@ public class BioJsHTMLOutput
     setBioJsMSAVersions(versionFileMap);
   }
 
-  public void updateBioJS()
+  public static void updateBioJS()
   {
     Thread updateThread = new Thread()
     {
+      @Override
       public void run()
       {
         try
         {
           String gitRepoPkgJson = getURLContentAsString(BJS_TEMPLATE_GIT_REPO);
-          BioJSRepositoryPojo release = new BioJSRepositoryPojo(
-                  gitRepoPkgJson);
-          syncUpdates(BJS_TEMPLATES_LOCAL_DIRECTORY, release);
-          refreshBioJSVersionsInfo(BJS_TEMPLATES_LOCAL_DIRECTORY);
+          if (gitRepoPkgJson != null)
+          {
+            BioJSRepositoryPojo release = new BioJSRepositoryPojo(
+                    gitRepoPkgJson);
+            syncUpdates(BJS_TEMPLATES_LOCAL_DIRECTORY, release);
+            refreshVersionInfo(BJS_TEMPLATES_LOCAL_DIRECTORY);
+          }
         } catch (URISyntaxException e)
         {
           e.printStackTrace();
@@ -204,8 +167,7 @@ public class BioJsHTMLOutput
 
   }
 
-
-  public void syncUpdates(String localDir, BioJSRepositoryPojo repo)
+  public static void syncUpdates(String localDir, BioJSRepositoryPojo repo)
   {
     for (BioJSReleasePojo bjsRelease : repo.getReleases())
     {
@@ -314,4 +276,22 @@ public class BioJsHTMLOutput
     BioJsHTMLOutput.bioJsMSAVersions = bioJsMSAVersions;
   }
 
+  @Override
+  public boolean isEmbedData()
+  {
+    return true;
+  }
+
+  @Override
+  public boolean isLaunchInBrowserAfterExport()
+  {
+    return true;
+  }
+
+  @Override
+  public File getExportedFile()
+  {
+    return generatedFile;
+  }
+
 }