JAL-1760 JAL-1641 Serialisation of Hidden Seqs and Cols in JSON output. Added ability...
[jalview.git] / src / jalview / io / BioJsHTMLOutput.java
index 669054d..a026c57 100644 (file)
@@ -4,30 +4,49 @@ 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.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;
+
 
 public class BioJsHTMLOutput
 {
   private AlignViewport av;
 
+  private static File currentBJSTemplateFile;
 
-  public BioJsHTMLOutput(AlignmentPanel ap,
-          FeatureRenderer fr1)
-  {
+  private static TreeMap<String, File> bioJsMSAVersions;
+
+  public static final String DEFAULT_DIR = System.getProperty("user.home")
+          + File.separatorChar + ".biojs_templates" + File.separatorChar;
 
+  public static final String BJS_TEMPLATES_LOCAL_DIRECTORY = jalview.bin.Cache
+          .getDefault("biojs_template_directory", DEFAULT_DIR);
+
+  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");
+
+  public BioJsHTMLOutput(AlignmentPanel ap, FeatureRenderer fr1)
+  {
     if (ap != null)
     {
-
       this.av = ap.av;
       av.setFeatureRenderer(new FeatureRenderer(ap));
     }
-
   }
 
   public void exportJalviewAlignmentAsBioJsHtmlFile()
@@ -36,7 +55,7 @@ public class BioJsHTMLOutput
     {
       String outputFile = getOutputFile();
       String jalviewAlignmentJson = JSONFile.getJSONData(av);
-      String bioJSTemplateString = getBioJsTemplateAsString(this);
+      String bioJSTemplateString = getBioJsTemplateAsString();
       String generatedBioJsWithJalviewAlignmentAsJson = bioJSTemplateString
               .replaceAll(
 "#sequenceData#", jalviewAlignmentJson)
@@ -87,14 +106,16 @@ public class BioJsHTMLOutput
   }
 
 
-  public static String getBioJsTemplateAsString(Object currentObj)
+  public static String getBioJsTemplateAsString()
           throws IOException
   {
     InputStreamReader isReader = null;
     BufferedReader buffReader = null;
     StringBuilder sb = new StringBuilder();
-    URL url = currentObj.getClass().getResource(
-            "/templates/BioJSTemplate.txt");
+    Objects.requireNonNull(getCurrentBJSTemplateFile(),
+            "BioJsTemplate File not initialized!");
+    @SuppressWarnings("deprecation")
+    URL url = getCurrentBJSTemplateFile().toURL();
     if (url != null)
     {
       try
@@ -126,4 +147,171 @@ public class BioJsHTMLOutput
     }
     return sb.toString();
   }
+
+  public static void refreshBioJSVersionsInfo(String dirName)
+          throws URISyntaxException
+  {
+    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())
+    {
+      if (file.isFile())
+      {
+        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);
+        }
+      }
+    }
+    if (getCurrentBJSTemplateFile() == null && versionFileMap.size() > 0)
+    {
+      setCurrentBJSTemplateFile(versionFileMap.lastEntry().getValue());
+    }
+    setBioJsMSAVersions(versionFileMap);
+  }
+
+  public static void updateBioJS()
+  {
+    Thread updateThread = new Thread()
+    {
+      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);
+        } catch (URISyntaxException e)
+        {
+          e.printStackTrace();
+        }
+      }
+    };
+    updateThread.start();
+
+  }
+
+
+  public static void syncUpdates(String localDir, BioJSRepositoryPojo repo)
+  {
+    for (BioJSReleasePojo bjsRelease : repo.getReleases())
+    {
+      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())
+      {
+        if (!biojsDirectory.mkdirs())
+        {
+          System.out.println("Couldn't create local directory : "
+                  + BJS_TEMPLATES_LOCAL_DIRECTORY);
+          return;
+        }
+      }
+
+      File file = new File(BJS_TEMPLATES_LOCAL_DIRECTORY + releaseFile);
+      if (!file.exists())
+      {
+
+        PrintWriter out = null;
+        try
+        {
+          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();
+          }
+        }
+      }
+    }
+
+  }
+
+  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)
+        {
+          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;
+  }
+
 }