JAL-3949 Complete new abstracted logging framework in jalview.log. Updated log calls...
[jalview.git] / src / jalview / io / BioJsHTMLOutput.java
index d4c9ba0..48988cf 100644 (file)
+/*
+ * 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.datamodel.AlignmentI;
-import jalview.datamodel.SequenceI;
-import jalview.gui.AlignViewport;
+import jalview.bin.Cache;
 import jalview.gui.AlignmentPanel;
-import jalview.gui.FeatureRenderer;
-import jalview.gui.SequenceRenderer;
-import jalview.json.binding.v1.BioJsAlignmentPojo;
-import jalview.json.binding.v1.BioJsSeqPojo;
+import jalview.gui.OOMWarning;
+import jalview.json.binding.biojs.BioJSReleasePojo;
+import jalview.json.binding.biojs.BioJSRepositoryPojo;
 import jalview.util.MessageManager;
 
+import java.io.BufferedInputStream;
 import java.io.BufferedReader;
+import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.PrintWriter;
+import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.Objects;
+import java.util.TreeMap;
 
-import com.json.JSONException;
-
-public class BioJsHTMLOutput
+public class BioJsHTMLOutput extends HTMLOutput
 {
-  private AlignViewport av;
+  private static File currentBJSTemplateFile;
+
+  private static TreeMap<String, File> bioJsMSAVersions;
+
+  public static final String DEFAULT_DIR = System.getProperty("user.home")
+          + File.separatorChar + ".biojs_templates" + File.separatorChar;
 
-  private FeatureRenderer fr;
+  public static final String BJS_TEMPLATES_LOCAL_DIRECTORY = Cache
+          .getDefault("biojs_template_directory", DEFAULT_DIR);
 
-  public BioJsHTMLOutput(AlignmentPanel ap, SequenceRenderer sr,
-          FeatureRenderer fr1)
+  public static final String BJS_TEMPLATE_GIT_REPO = Cache
+          .getDefault("biojs_template_git_repo",
+                  "https://raw.githubusercontent.com/jalview/exporter-templates/master/biojs/package.json");
+
+  public BioJsHTMLOutput(AlignmentPanel ap)
   {
-    this.av = ap.av;
-    this.fr = new FeatureRenderer(ap);
-    fr.transferSettings(fr1);
-    exportAsBioJsHtml();
+    super(ap, "BioJS MSA");
   }
 
-  private void exportAsBioJsHtml()
+  public static void refreshVersionInfo(String dirName)
+          throws URISyntaxException
   {
-    try
+    File directory = new File(BJS_TEMPLATES_LOCAL_DIRECTORY);
+    Objects.requireNonNull(dirName, "dirName MUST not be null!");
+    Objects.requireNonNull(directory, "directory MUST not be null!");
+    TreeMap<String, File> versionFileMap = new TreeMap<String, File>();
+
+    for (File file : directory.listFiles())
     {
-      JalviewFileChooser jvFileChooser = getJalviewFileChooserOption();
-      int fileChooserOpt = jvFileChooser.showSaveDialog(null);
-      if (fileChooserOpt == JalviewFileChooser.APPROVE_OPTION)
+      if (file.isFile())
       {
-        jalview.bin.Cache.setProperty("LAST_DIRECTORY", jvFileChooser
-                .getSelectedFile().getParent());
-        String selectedFile = jvFileChooser.getSelectedFile().getPath();
-        String generartedBioJs = generateBioJsAlignmentData(av
-                .getAlignment());
-        PrintWriter out = new java.io.PrintWriter(new java.io.FileWriter(
-                selectedFile));
-        out.print(generartedBioJs);
-        out.close();
-        jalview.util.BrowserLauncher.openURL("file:///" + selectedFile);
+        String fileName = file.getName().substring(0,
+                file.getName().lastIndexOf("."));
+        String fileMeta[] = fileName.split("_");
+        if (fileMeta.length > 2)
+        {
+          setCurrentBJSTemplateFile(file);
+          versionFileMap.put(fileMeta[2], file);
+        }
+        else if (fileMeta.length > 1)
+        {
+          versionFileMap.put(fileMeta[1], file);
+        }
       }
-    } catch (Exception ex)
+    }
+    if (getCurrentBJSTemplateFile() == null && versionFileMap.size() > 0)
     {
-      ex.printStackTrace();
+      setCurrentBJSTemplateFile(versionFileMap.lastEntry().getValue());
     }
+    setBioJsMSAVersions(versionFileMap);
   }
 
-  private JalviewFileChooser getJalviewFileChooserOption()
-  {
-    JalviewFileChooser chooser = new JalviewFileChooser(
-            jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
-            { "html" }, new String[]
-            { "HTML files" }, "HTML files");
-    chooser.setFileView(new JalviewFileView());
-
-    // TODO uncomment when supported by MassageManager
-    chooser.setDialogTitle(MessageManager
-            .getString("label.save_as_biojs_html"));
-    chooser.setDialogTitle("save as BioJs HTML");
-    chooser.setToolTipText(MessageManager.getString("action.save"));
-
-    return chooser;
-  }
-
-  private String generateBioJsAlignmentData(AlignmentI alignment)
-          throws IOException, JSONException
+  public static void updateBioJS()
   {
-    BioJsAlignmentPojo bjsAlignment = new BioJsAlignmentPojo();
-    int count = 0;
-    for (SequenceI seq : alignment.getSequences())
+    Thread updateThread = new Thread()
     {
-      StringBuilder name = new StringBuilder();
-      name.append(seq.getName()).append("/").append(seq.getStart())
-              .append("-").append(seq.getEnd());
-      bjsAlignment.getSeqs().add(
-              new BioJsSeqPojo(String.valueOf(++count), name.toString(),
-                      seq.getSequenceAsString()));
-    }
-
-    String seqs = new com.json.JSONObject(bjsAlignment).getString("seqs");
-    // String bioJSTemplate = new String(
-    // java.nio.file.Files.readAllBytes(java.nio.file.Paths
-    // .get("resources/templates/BioJSTemplate.txt")));
-    String bioJSTemplate = getBioJsTemplateAsString(alignment);
+      @Override
+      public void run()
+      {
+        try
+        {
+          String gitRepoPkgJson = getURLContentAsString(
+                  BJS_TEMPLATE_GIT_REPO);
+          if (gitRepoPkgJson != null)
+          {
+            BioJSRepositoryPojo release = new BioJSRepositoryPojo(
+                    gitRepoPkgJson);
+            syncUpdates(BJS_TEMPLATES_LOCAL_DIRECTORY, release);
+            refreshVersionInfo(BJS_TEMPLATES_LOCAL_DIRECTORY);
+          }
+        } catch (URISyntaxException e)
+        {
+          e.printStackTrace();
+        }
+      }
+    };
+    updateThread.start();
 
-    return bioJSTemplate.replaceAll("#sequenceData#", seqs).replaceAll(
-            "#scheme#", "zappo");
   }
 
-
-  public static String getBioJsTemplateAsString(AlignmentI bio)
-          throws IOException
+  public static void syncUpdates(String localDir, BioJSRepositoryPojo repo)
   {
-    InputStreamReader isReader = null;
-    BufferedReader buffReader = null;
-    StringBuilder sb = new StringBuilder();
-    URL url = bio.getClass().getResource(
-            "/templates/BioJSTemplate.txt");
-    if (url != null)
+    for (BioJSReleasePojo bjsRelease : repo.getReleases())
     {
-      try
+      String releaseUrl = bjsRelease.getUrl();
+      String releaseVersion = bjsRelease.getVersion();
+      String releaseFile = "BioJsMSA_" + releaseVersion + ".txt";
+      if (releaseVersion.equals(repo.getLatestReleaseVersion()))
+      {
+        releaseFile = "Latest_BioJsMSA_" + releaseVersion + ".txt";
+      }
+
+      File biojsDirectory = new File(BJS_TEMPLATES_LOCAL_DIRECTORY);
+      if (!biojsDirectory.exists())
       {
-        isReader = new InputStreamReader(url.openStream());
-        buffReader = new BufferedReader(isReader);
-        String line;
-        String lineSeparator = System.getProperty("line.separator");
-        while ((line = buffReader.readLine()) != null)
+        if (!biojsDirectory.mkdirs())
         {
-          sb.append(line).append(lineSeparator);
+          System.out.println("Couldn't create local directory : "
+                  + BJS_TEMPLATES_LOCAL_DIRECTORY);
+          return;
         }
+      }
 
-      } catch (Exception ex)
+      File file = new File(BJS_TEMPLATES_LOCAL_DIRECTORY + releaseFile);
+      if (!file.exists())
       {
-        ex.printStackTrace();
-      } finally
-      {
-        if (isReader != null)
+
+        PrintWriter out = null;
+        try
         {
-          isReader.close();
+          out = new java.io.PrintWriter(new java.io.FileWriter(file));
+          out.print(getURLContentAsString(releaseUrl));
+        } catch (IOException e)
+        {
+          e.printStackTrace();
+        } finally
+        {
+          if (out != null)
+          {
+            out.flush();
+            out.close();
+          }
         }
+      }
+    }
 
-        if (buffReader != null)
+  }
+
+  public static String getURLContentAsString(String url)
+          throws OutOfMemoryError
+  {
+    StringBuilder responseStrBuilder = null;
+    InputStream is = null;
+    try
+    {
+      URL resourceUrl = new URL(url);
+      is = new BufferedInputStream(resourceUrl.openStream());
+      BufferedReader br = new BufferedReader(new InputStreamReader(is));
+      responseStrBuilder = new StringBuilder();
+      String lineContent;
+
+      while ((lineContent = br.readLine()) != null)
+      {
+        responseStrBuilder.append(lineContent).append("\n");
+      }
+    } catch (OutOfMemoryError er)
+    {
+      er.printStackTrace();
+    } catch (Exception ex)
+    {
+      ex.printStackTrace();
+    } finally
+    {
+      if (is != null)
+      {
+        try
+        {
+          is.close();
+        } catch (IOException e)
         {
-          buffReader.close();
+          e.printStackTrace();
         }
       }
     }
+    return responseStrBuilder == null ? null
+            : responseStrBuilder.toString();
+  }
+
+  public static File getCurrentBJSTemplateFile()
+  {
+    return currentBJSTemplateFile;
+  }
+
+  public static void setCurrentBJSTemplateFile(File currentBJSTemplateFile)
+  {
+    BioJsHTMLOutput.currentBJSTemplateFile = currentBJSTemplateFile;
+  }
+
+  public static TreeMap<String, File> getBioJsMSAVersions()
+  {
+    return bioJsMSAVersions;
+  }
+
+  public static void setBioJsMSAVersions(
+          TreeMap<String, File> bioJsMSAVersions)
+  {
+    BioJsHTMLOutput.bioJsMSAVersions = bioJsMSAVersions;
+  }
+
+  @Override
+  public boolean isEmbedData()
+  {
+    return true;
+  }
+
+  @Override
+  public boolean isLaunchInBrowserAfterExport()
+  {
+    return true;
+  }
+
+  @Override
+  public void run()
+  {
+    try
+    {
+      String bioJSON = getBioJSONData();
+      String bioJSTemplateString = HTMLOutput
+              .readFileAsString(getCurrentBJSTemplateFile());
+      String generatedBioJsWithJalviewAlignmentAsJson = bioJSTemplateString
+              .replaceAll("#sequenceData#", bioJSON).toString();
+
+      PrintWriter out = new java.io.PrintWriter(
+              new java.io.FileWriter(generatedFile));
+      out.print(generatedBioJsWithJalviewAlignmentAsJson);
+      out.flush();
+      out.close();
+      setProgressMessage(MessageManager
+              .formatMessage("status.export_complete", getDescription()));
+      exportCompleted();
+
+    } catch (OutOfMemoryError err)
+    {
+      System.out.println("########################\n" + "OUT OF MEMORY "
+              + generatedFile + "\n" + "########################");
+      new OOMWarning("Creating Image for " + generatedFile, err);
+    } catch (Exception e)
+    {
+      setProgressMessage(MessageManager
+              .formatMessage("info.error_creating_file", getDescription()));
+      e.printStackTrace();
+    }
 
-    return sb.toString();
   }
 
 }