JAL-3438 spotless for 2.11.2.0
[jalview.git] / src / jalview / util / Platform.java
index d80e3de..573e2d5 100644 (file)
  */
 package jalview.util;
 
+import jalview.javascript.json.JSON;
+
 import java.awt.Toolkit;
 import java.awt.event.MouseEvent;
+import java.io.BufferedReader;
 import java.io.File;
+import java.io.FileOutputStream;
+import java.io.FileReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.net.URL;
 import java.util.Properties;
 
 import javax.swing.SwingUtilities;
 
+import org.json.simple.parser.JSONParser;
+import org.json.simple.parser.ParseException;
+
 /**
  * System platform information used by Applet and Application
  * 
@@ -39,7 +52,7 @@ public class Platform
           false;
 
   private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
-          isWin = null;
+          isWin = null, isLinux = null;
 
   private static Boolean isHeadless = null;
 
@@ -68,6 +81,19 @@ public class Platform
   }
 
   /**
+   * added to check LaF for Linux
+   * 
+   * @return
+   */
+  public static boolean isLinux()
+  {
+    return (isLinux == null
+            ? (isLinux = (System.getProperty("os.name")
+                    .indexOf("Linux") >= 0))
+            : isLinux);
+  }
+
+  /**
    * 
    * @return true if HTML5 JavaScript
    */
@@ -122,23 +148,15 @@ public class Platform
   }
 
   /**
-   * escape a string according to the local platform's escape character
+   * Answers the input with every backslash replaced with a double backslash (an
+   * 'escaped' single backslash)
    * 
-   * @param file
-   * @return escaped file
+   * @param s
+   * @return
    */
-  public static String escapeString(String file)
+  public static String escapeBackslashes(String s)
   {
-    StringBuffer f = new StringBuffer();
-    int p = 0, lastp = 0;
-    while ((p = file.indexOf('\\', lastp)) > -1)
-    {
-      f.append(file.subSequence(lastp, p));
-      f.append("\\\\");
-      lastp = p + 1;
-    }
-    f.append(file.substring(lastp));
-    return f.toString();
+    return s == null ? null : s.replace("\\", "\\\\");
   }
 
   /**
@@ -167,6 +185,20 @@ public class Platform
     if (!aMac)
     {
       return e.isControlDown();
+
+      // Jalview 2.11 code below: above is as amended for JalviewJS
+      // /*
+      // * answer false for right mouse button
+      // */
+      // if (e.isPopupTrigger())
+      // {
+      // return false;
+      // }
+      // return
+      // (jalview.util.ShortcutKeyMaskExWrapper.getMenuShortcutKeyMaskEx() //
+      // .getMenuShortcutKeyMaskEx()
+      // & jalview.util.ShortcutKeyMaskExWrapper
+      // .getModifiersEx(e)) != 0; // getModifiers()) != 0;
     }
     // answer false for right mouse button
     // shortcut key will be META for a Mac
@@ -292,9 +324,9 @@ public class Platform
     }
   }
 
-  public static void cacheFileData(String path, byte[] data)
+  public static void cacheFileData(String path, Object data)
   {
-    if (!isJS())
+    if (!isJS() || data == null)
     {
       return;
     }
@@ -306,23 +338,46 @@ public class Platform
      */
   }
 
+  public static void cacheFileData(File file)
+  {
+    byte[] data;
+    if (!isJS() || (data = Platform.getFileBytes(file)) == null)
+    {
+      return;
+    }
+    cacheFileData(file.toString(), data);
+  }
+
   public static byte[] getFileBytes(File f)
   {
-    return /** @j2sNative f && f._bytes || */
+    return /** @j2sNative f && swingjs.JSUtil.getFileAsBytes$O(f) || */
     null;
   }
 
   public static byte[] getFileAsBytes(String fileStr)
   {
+    byte[] bytes = null;
     // BH 2018 hack for no support for access-origin
-    return /** @j2sNative swingjs.JSUtil.getFileAsBytes$O(fileStr) || */
-    null;
+    /**
+     * @j2sNative bytes = swingjs.JSUtil.getFileAsBytes$O(fileStr)
+     */
+    cacheFileData(fileStr, bytes);
+    return bytes;
   }
 
-  public static String getFileAsString(String data)
+  @SuppressWarnings("unused")
+  public static String getFileAsString(String url)
   {
-    return /** @j2sNative swingjs.JSUtil.getFileAsString$S(data) || */
-    null;
+    String ret = null;
+    /**
+     * @j2sNative
+     * 
+     *            ret = swingjs.JSUtil.getFileAsString$S(url);
+     * 
+     * 
+     */
+    cacheFileData(url, ret);
+    return ret;
   }
 
   public static boolean setFileBytes(File f, String urlstring)
@@ -333,8 +388,10 @@ public class Platform
     }
     @SuppressWarnings("unused")
     byte[] bytes = getFileAsBytes(urlstring);
+    // TODO temporary doubling of ç§˜bytes and _bytes;
+    // just remove _bytes when new transpiler has been installed
     /**
-     * @j2sNative f._bytes = bytes;
+     * @j2sNative f.\u79d8bytes = f._bytes = bytes;
      */
     return true;
   }
@@ -386,10 +443,8 @@ public class Platform
 
   public static String getUniqueAppletID()
   {
-    @SuppressWarnings("unused")
-    ThreadGroup g = Thread.currentThread().getThreadGroup();
     /**
-     * @j2sNative return g.html5Applet._uniqueId;
+     * @j2sNative return swingjs.JSUtil.getApplet$()._uniqueId;
      *
      */
     return null;
@@ -406,13 +461,16 @@ public class Platform
    */
   public static void readInfoProperties(String prefix, Properties p)
   {
-    @SuppressWarnings("unused")
-    ThreadGroup g = Thread.currentThread().getThreadGroup();
+    if (!isJS())
+    {
+      return;
+    }
     String id = getUniqueAppletID();
     String key = "", value = "";
     /**
-     * @j2sNative var info = g.html5Applet.__Info || {}; for (var key in info) {
-     *            if (key.indexOf(prefix) == 0) { value = "" + info[key];
+     * @j2sNative var info = swingjs.JSUtil.getApplet$().__Info || {}; for (var
+     *            key in info) { if (key.indexOf(prefix) == 0) { value = "" +
+     *            info[key];
      */
 
     System.out.println(
@@ -427,4 +485,176 @@ public class Platform
      */
   }
 
+  public static void setAjaxJSON(URL url)
+  {
+    if (isJS())
+    {
+      JSON.setAjax(url);
+    }
+  }
+
+  public static Object parseJSON(InputStream response)
+          throws IOException, ParseException
+  {
+    if (isJS())
+    {
+      return JSON.parse(response);
+    }
+
+    BufferedReader br = null;
+    try
+    {
+      br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
+      return new JSONParser().parse(br);
+    } finally
+    {
+      if (br != null)
+      {
+        try
+        {
+          br.close();
+        } catch (IOException e)
+        {
+          // ignore
+        }
+      }
+    }
+  }
+
+  public static Object parseJSON(String json) throws ParseException
+  {
+    return (isJS() ? JSON.parse(json) : new JSONParser().parse(json));
+  }
+
+  public static Object parseJSON(Reader r)
+          throws IOException, ParseException
+  {
+    if (r == null)
+    {
+      return null;
+    }
+
+    if (!isJS())
+    {
+      return new JSONParser().parse(r);
+    }
+    // Using a file reader is not currently supported in SwingJS JavaScript
+
+    if (r instanceof FileReader)
+    {
+      throw new IOException(
+              "StringJS does not support FileReader parsing for JSON -- but it could...");
+    }
+    return JSON.parse(r);
+
+  }
+
+  /**
+   * Dump the input stream to an output file.
+   * 
+   * @param is
+   * @param outFile
+   * @throws IOException
+   *           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
+  {
+    if (isJS() && /**
+                   * @j2sNative outFile.setBytes$O && outFile.setBytes$O(is) &&
+                   */
+            true)
+    {
+      return;
+    }
+    FileOutputStream fio = new FileOutputStream(outFile);
+    try
+    {
+      byte[] bb = new byte[32 * 1024];
+      int l;
+      while ((l = is.read(bb)) > 0)
+      {
+        fio.write(bb, 0, l);
+      }
+    } finally
+    {
+      fio.close();
+    }
+  }
+
+  /**
+   * Add a known domain that implements access-control-allow-origin:*
+   * 
+   * These should be reviewed periodically.
+   * 
+   * @param domain
+   *          for a service that is not allowing ajax
+   * 
+   * @author hansonr@stolaf.edu
+   * 
+   */
+  public static void addJ2SDirectDatabaseCall(String domain)
+  {
+
+    if (isJS())
+    {
+      System.out.println(
+              "Platform adding known access-control-allow-origin * for domain "
+                      + domain);
+      /**
+       * @j2sNative
+       * 
+       *            J2S.addDirectDatabaseCall(domain);
+       */
+    }
+
+  }
+
+  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 element to this value.
+       * 
+       * @j2sNative var a =
+       *            decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
+       *            + "?").split("?")[1].split("#")[0]); a &&
+       *            (System.out.println("URL arguments detected were "+a)) &&
+       *            (J2S.thisApplet.__Info.urlargs = a.split(" "));
+       *            (!J2S.thisApplet.__Info.args || J2S.thisApplet.__Info.args
+       *            == "" || J2S.thisApplet.__Info.args == "??") &&
+       *            (J2S.thisApplet.__Info.args = a) && (System.out.println("URL
+       *            arguments were passed to J2S main."));
+       */
+    } catch (Throwable t)
+    {
+    }
+  }
+
+  /**
+   * A (case sensitive) file path comparator that ignores the difference between
+   * / and \
+   * 
+   * @param path1
+   * @param path2
+   * @return
+   */
+  public static boolean pathEquals(String path1, String path2)
+  {
+    if (path1 == null)
+    {
+      return path2 == null;
+    }
+    if (path2 == null)
+    {
+      return false;
+    }
+    String p1 = path1.replace('\\', '/');
+    String p2 = path2.replace('\\', '/');
+    return p1.equals(p2);
+  }
 }