JAL-3446 JavaScript interface
[jalview.git] / src / jalview / util / Platform.java
index cd24432..b1b6697 100644 (file)
@@ -33,10 +33,16 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.net.URL;
+import java.nio.channels.Channels;
+import java.nio.channels.ReadableByteChannel;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.Date;
+import java.util.Locale;
+import java.util.Map;
 import java.util.Properties;
 import java.util.logging.ConsoleHandler;
 import java.util.logging.Level;
@@ -49,6 +55,7 @@ import org.json.simple.parser.ParseException;
 
 import com.stevesoft.pat.Regex;
 
+import jalview.bin.Jalview;
 import jalview.javascript.json.JSON;
 import swingjs.api.JSUtilI;
 
@@ -67,14 +74,17 @@ public class Platform
           isWin = null;
 
   private static Boolean isHeadless = null;
-  
+
   private static swingjs.api.JSUtilI jsutil;
 
-  static {
-          if (isJS) {
+  static
+  {
+    if (isJS)
+    {
       try
       {
-        // this is ok - it's a highly embedded method in Java; the deprecation is
+        // this is ok - it's a highly embedded method in Java; the deprecation
+        // is
         // really a recommended best practice.
         jsutil = ((JSUtilI) Class.forName("swingjs.JSUtil").newInstance());
       } catch (InstantiationException | IllegalAccessException
@@ -82,7 +92,7 @@ public class Platform
       {
         e.printStackTrace();
       }
-          }
+    }
   }
   // private static Boolean isHeadless = null;
 
@@ -141,18 +151,18 @@ public class Platform
     return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
   }
 
- /**
- *
- * @return true if we are running in non-interactive no UI mode
- */
- public static boolean isHeadless()
- {
- if (isHeadless == null)
- {
- isHeadless = "true".equals(System.getProperty("java.awt.headless"));
- }
- return isHeadless;
- }
+  /**
+   *
+   * @return true if we are running in non-interactive no UI mode
+   */
+  public static boolean isHeadless()
+  {
+    if (isHeadless == null)
+    {
+      isHeadless = "true".equals(System.getProperty("java.awt.headless"));
+    }
+    return isHeadless;
+  }
 
   /**
    * 
@@ -175,7 +185,7 @@ public class Platform
   {
     return s == null ? null : s.replace("\\", "\\\\");
   }
-  
+
   /**
    * Answers true if the mouse event has Meta-down (Command key on Mac) or
    * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
@@ -365,7 +375,6 @@ public class Platform
     }
   }
 
-
   public static void cacheFileData(File file)
   {
     if (isJS)
@@ -395,7 +404,7 @@ public class Platform
     }
     return null;
   }
-  
+
   public static String getFileAsString(String url)
   {
     if (isJS && url != null)
@@ -419,7 +428,6 @@ public class Platform
     return false;
   }
 
-
   public static void addJ2SBinaryType(String ext)
   {
     if (isJS)
@@ -427,7 +435,7 @@ public class Platform
       jsutil.addBinaryFileType(ext);
     }
   }
-  
+
   /**
    * Encode the URI using JavaScript encodeURIComponent
    * 
@@ -468,7 +476,6 @@ public class Platform
     return (isJS ? (String) jsutil.getAppletAttribute("_uniqueId") : null);
   }
 
-
   /**
    * Read the Info block for this applet.
    * 
@@ -543,8 +550,7 @@ public class Platform
 
   public static Object parseJSON(String json) throws ParseException
   {
-    return (isJS() ? JSON.parse(json)
-            : new JSONParser().parse(json));
+    return (isJS() ? JSON.parse(json) : new JSONParser().parse(json));
   }
 
   public static Object parseJSON(Reader r)
@@ -575,8 +581,8 @@ public class Platform
    * @param is
    * @param outFile
    * @throws IOException
-   *                       if the file cannot be created or there is a problem
-   *                       reading the input stream.
+   *           if the file cannot be created or there is a problem reading the
+   *           input stream.
    */
   public static void streamToFile(InputStream is, File outFile)
           throws IOException
@@ -622,15 +628,20 @@ public class Platform
       jsutil.addDirectDatabaseCall(domain);
 
       System.out.println(
-            "Platform adding known access-control-allow-origin * for domain "
-                    + domain);
+              "Platform adding known access-control-allow-origin * for domain "
+                      + domain);
     }
 
   }
 
+  /**
+   * Allow for URL-line command arguments. Untested.
+   * 
+   */
   public static void getURLCommandArguments()
   {
 
+    try {
     /**
      * Retrieve the first query field as command arguments to Jalview. Include
      * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
@@ -640,13 +651,16 @@ public class Platform
      *            decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
      *            + "?").split("?")[1].split("#")[0]); a &&
      *            (J2S.thisApplet.__Info.args = a.split(" "));
+     *            
+     *            System.out.println("URL arguments: " + a);
      */
-
+    } catch (Throwable t) {
+    }
   }
 
   /**
-   * A (case sensitive) file path comparator that ignores the difference between /
-   * and \
+   * A (case sensitive) file path comparator that ignores the difference between
+   * / and \
    * 
    * @param path1
    * @param path2
@@ -667,11 +681,8 @@ public class Platform
     return p1.equals(p2);
   }
 
+  ///////////// JAL-3253 Applet additions //////////////
 
-
-///////////// JAL-3253 Applet additions //////////////
-  
-  
   /**
    * Retrieve the object's embedded size from a div's style on a page if
    * embedded in SwingJS.
@@ -758,7 +769,6 @@ public class Platform
     }
   }
 
-
   /**
    * load a resource -- probably a core file -- if and only if a particular
    * class has not been instantialized. We use a String here because if we used
@@ -798,17 +808,17 @@ public class Platform
   {
     if (isJS)
     {
-      jsutil.setAppletAttribute("app", j);
+      jsutil.setAppClass(j);
     }
   }
 
   /**
    *
-   * If this frame ia embedded in a web page, return a known type.
+   * If this frame is embedded in a web page, return a known type.
    * 
    * @param frame
    *          a JFrame or JInternalFrame
-   * @param type
+   * @param type "name", "node", "init", "dim", or any DOM attribute, such as "id"
    * @return null if frame is not embedded.
    */
   public static Object getEmbeddedAttribute(Component frame, String type)
@@ -841,7 +851,8 @@ public class Platform
   public static String getUserPath(String subpath)
   {
     char sep = File.separatorChar;
-    return System.getProperty("user.home") + sep + subpath.replace('/', sep);
+    return System.getProperty("user.home") + sep
+            + subpath.replace('/', sep);
   }
 
   /**
@@ -856,8 +867,10 @@ public class Platform
    */
   public static boolean isFileOlderThanThreshold(File file, int noOfDays)
   {
-    if (isJS()) {
-      // not meaningful in SwingJS -- this is a session-specific temp file. It doesn't have a timestamp. 
+    if (isJS())
+    {
+      // not meaningful in SwingJS -- this is a session-specific temp file. It
+      // doesn't have a timestamp.
       return false;
     }
     Path filePath = file.toPath();
@@ -892,8 +905,10 @@ public class Platform
     {
       return failValue;
     }
-    if (isJS) {
-      int val = /** @j2sNative 1 ? parseInt(input) : */ 0; 
+    if (isJS)
+    {
+      int val = /** @j2sNative 1 ? parseInt(input) : */
+              0;
       return (val == val + 0 ? val : failValue);
     }
     // JavaScript does not support Regex ? lookahead
@@ -905,5 +920,88 @@ public class Platform
     return failValue;
   }
 
+  public static Map<String, Object> getAppletInfoAsMap()
+  {
+    return (isJS ? jsutil.getAppletInfoAsMap() : null);
+  }
+
+  /**
+   * Get the SwingJS applet ID and combine that with the frameType
+   * 
+   * @param frameType
+   *          "alignment", "desktop", etc., or null
+   * @return
+   */
+  public static String getAppID(String frameType)
+  {
+    
+    String id = Jalview.getInstance().j2sAppletID;
+    if (id == null)
+    {
+      Jalview.getInstance().j2sAppletID = id = (isJS ? (String) jsutil
+              .getAppletAttribute("_id") : "jalview");
+    }
+    return id + (frameType == null ? "" : "-" + frameType);
+  }
+
+
+  /**
+   * Option to avoid unnecessary seeking of nonexistent resources in JavaScript.
+   * Works in Java as well.
+   * 
+   * @param loc
+   * @return
+   */
+  public static Locale getLocaleOrNone(Locale loc)
+  {
+    return (isJS && loc.getLanguage() == "en" ? new Locale("") : loc);
+  }
+
+  /**
+   * From UrlDownloadClient; trivial in JavaScript; painful in Java.
+   * 
+   * @param urlstring
+   * @param outfile
+   * @throws IOException
+   */
+  public static void download(String urlstring, String outfile)
+          throws IOException
+  {
+    Path temp = null;
+    try (InputStream is = new URL(urlstring).openStream())
+    {
+      if (isJS)
+      { // so much easier!
+        streamToFile(is, new File(outfile));
+        return;
+      }
+      temp = Files.createTempFile(".jalview_", ".tmp");
+      try (FileOutputStream fos = new FileOutputStream(temp.toString());
+              ReadableByteChannel rbc = Channels.newChannel(is))
+      {
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        // copy tempfile to outfile once our download completes
+        // incase something goes wrong
+        Files.copy(temp, Paths.get(outfile),
+                StandardCopyOption.REPLACE_EXISTING);
+      }
+    } catch (IOException e)
+    {
+      throw e;
+    } finally
+    {
+      try
+      {
+        if (temp != null)
+        {
+          Files.deleteIfExists(temp);
+        }
+      } catch (IOException e)
+      {
+        System.out.println("Exception while deleting download temp file: "
+                + e.getMessage());
+      }
+    }
+  }
 
 }