/* * 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 . * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.util; import jalview.javascript.json.JSON; import java.awt.Component; import java.awt.Dimension; 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; import java.util.HashMap; import java.util.HashSet; import java.util.Set; import java.util.logging.ConsoleHandler; import java.util.logging.Level; import java.util.logging.Logger; import com.stevesoft.pat.Regex; import swingjs.api.JSUtilI; /** * System platform information used by Applet and Application * * @author Jim Procter */ public class Platform { private static boolean isJS = /** @j2sNative true || */ false; private static JSUtilI jsutil = /** * @j2sNative new Clazz.new_("swingjs.JSUtil") * || */ null; private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null, isWin = null; private static Boolean isHeadless = null; /** * added to group mouse events into Windows and nonWindows (mac, unix, linux) * * @return */ public static boolean isMac() { return (isMac == null ? (isMac = (System.getProperty("os.name").indexOf("Mac") >= 0)) : isMac); } /** * added to group mouse events into Windows and nonWindows (mac, unix, linux) * * @return */ public static boolean isWin() { return (isWin == null ? (isWin = (System.getProperty("os.name").indexOf("Win") >= 0)) : isWin); } /** * * @return true if HTML5 JavaScript */ public static boolean isJS() { return isJS; } /** * sorry folks - Macs really are different * * BH: disabled for SwingJS -- will need to check key-press issues * * @return true if we do things in a special way. */ public static boolean isAMacAndNotJS() { return (isNoJSMac == null ? (isNoJSMac = !isJS && isMac()) : isNoJSMac); } /** * Check if we are on a Microsoft plaform... * * @return true if we have to cope with another platform variation */ public static boolean isWindowsAndNotJS() { return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin); } /** * * @return true if we are running in non-interactive no UI mode * based on System.getProperty("java.awt.headless") */ public static boolean isHeadless() { if (isHeadless == null) { isHeadless = "true".equals(System.getProperty("java.awt.headless")); } return isHeadless; } /** * * @return nominal maximum command line length for this platform */ public static int getMaxCommandLineLength() { // TODO: determine nominal limits for most platforms. return 2046; // this is the max length for a windows NT system. } /** * Answers the input with every backslash replaced with a double backslash (an * 'escaped' single backslash) * * @param s * @return */ public static String escapeBackslashes(String s) { 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 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on * Mac, you can use e.isPopupTrigger(). * * @param e * @return */ public static boolean isControlDown(MouseEvent e) { return isControlDown(e, isMac()); } /** * Overloaded version of method (to allow unit testing) * * @param e * @param aMac * @return */ protected static boolean isControlDown(MouseEvent e, boolean aMac) { if (!aMac) { return e.isControlDown(); } // answer false for right mouse button // shortcut key will be META for a Mac return !e.isPopupTrigger() && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask() & e.getModifiers()) != 0; // could we use e.isMetaDown() here? } // BH: I don't know about that previous method. Here is what SwingJS uses. // Notice the distinction in mouse events. (BUTTON3_MASK == META) // // private static boolean isPopupTrigger(int id, int mods, boolean isWin) { // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0); // if (isWin) { // if (id != MouseEvent.MOUSE_RELEASED) // return false; //// //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both. //// //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue, // because //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers. //// // return rt; // } else { // // mac, linux, unix // if (id != MouseEvent.MOUSE_PRESSED) // return false; // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0); // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0); // return rt || (ctrl && lt); // } // } // /** * Windows (not Mac, Linux, or Unix) and right button to test for the * right-mouse pressed event in Windows that would have opened a menu or a * Mac. * * @param e * @return */ public static boolean isWinRightButton(MouseEvent e) { // was !isAMac(), but that is true also for Linux and Unix and JS, return isWin() && SwingUtilities.isRightMouseButton(e); } /** * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling * without pressing the button. * * @param e * @return */ public static boolean isWinMiddleButton(MouseEvent e) { // was !isAMac(), but that is true also for Linux and Unix and JS return isWin() && SwingUtilities.isMiddleMouseButton(e); } public static boolean allowMnemonics() { return !isMac(); } public final static int TIME_RESET = 0; public final static int TIME_MARK = 1; public static final int TIME_SET = 2; public static final int TIME_GET = 3; public static long time, mark, set, duration; /** * typical usage: * * Platform.timeCheck(null, Platform.TIME_MARK); * * ... * * Platform.timeCheck("some message", Platform.TIME_MARK); * * reset...[set/mark]n...get * * @param msg * @param mode */ public static void timeCheck(String msg, int mode) { long t = System.currentTimeMillis(); switch (mode) { case TIME_RESET: time = mark = t; duration = 0; if (msg != null) { System.err.println("Platform: timer reset\t\t\t" + msg); } break; case TIME_MARK: if (set > 0) { // total time between set/mark points duration += (t - set); } else { if (time == 0) { time = mark = t; } if (msg != null) { System.err.println("Platform: timer mark\t" + ((t - time) / 1000f) + "\t" + ((t - mark) / 1000f) + "\t" + msg); } mark = t; } break; case TIME_SET: set = t; break; case TIME_GET: if (msg != null) { System.err.println("Platform: timer get\t" + ((t - time) / 1000f) + "\t" + ((duration) / 1000f) + "\t" + msg); } set = 0; break; } } ////// jsutil additions, simplifications public static void cacheFileData(String path, Object data) { if (isJS()) { jsutil.cachePathData(path, data); } } public static void cacheFileData(File file) { if (isJS()) { byte[] bytes = getFileBytes(file); if (bytes != null) { cacheFileData(file.toString(), bytes); } } } public static byte[] getFileBytes(File f) { return (isJS() && f != null ? jsutil.getBytes(f) : null); } public static byte[] getFileAsBytes(String fileStr) { byte[] bytes = (isJS() && fileStr != null ? (byte[]) jsutil.getFile(fileStr, false) : null); if (bytes != null) { cacheFileData(fileStr, bytes); } return bytes; } public static String getFileAsString(String url) { String ret = null; if (isJS()) { ret = (String) jsutil.getFile(url, true); if (ret != null) { cacheFileData(url, ret); } } return ret; } public static boolean setFileBytes(File f, String urlstring) { if (!isJS()) { return false; } byte[] bytes = getFileAsBytes(urlstring); boolean ok = false; try { jsutil.setFileBytes(f, bytes); } catch (Throwable t) { System.out.println("Platform.setFileBytes failed: " + t); } return ok; } public static void addJ2SBinaryType(String ext) { if (isJS()) { jsutil.addBinaryFileType(ext); } } /** * Encode the URI using JavaScript encodeURIComponent * * @param value * @return encoded value */ public static String encodeURI(String value) { /** * @j2sNative value = encodeURIComponent(value); */ return value; } /** * Open the URL using a simple window call if this is JavaScript * * @param url * @return true if window has been opened */ public static boolean openURL(String url) throws IOException { if (!isJS()) { BrowserLauncher.openURL(url); return false; } /** * @j2sNative * * * window.open(url); */ return true; } public static String getUniqueAppletID() { // Caution -- null here means using current thread instead of a known component. return jsutil.getAppletForComponent(null)._getID(); } /** * Read the Info block for this applet. * * @param prefix * "jalview_" * @param p * @return unique id for this applet */ public static void readInfoProperties(String prefix, Properties p) { if (isJS()) { jsutil.readInfoProperties(prefix, p); } } 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() && jsutil.streamToFile(is, outFile)) { 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()) { jsutil.addDirectDatabaseCall(domain); } } /** * 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. */ @SuppressWarnings("unused") public static void getURLCommandArguments() { if (!isJS()) { return; } String[] args = null; /** * @j2sNative args = * decodeURI((document.location.href.replace("&","?").split("?j2s")[0] * + "?").split("?")[1].split("#")[0]); args && (args = * args.split(" ")); */ if (args != null) { jsutil.setAppletInfo("args", args); } } /** * 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); } ///// new methods from applet branch only public static URL getDocumentBase() { return (isJS() ? jsutil.getDocumentBase() : null); } public static URL getCodeBase() { return (isJS() ? jsutil.getCodeBase() : null); } public static void ensureJmol() { if (isJS()) { jsutil.loadResourceIfClassUnknown("core/core_jvjmol.z.js", "org.jmol.viewer.Viewer"); } } public static void ensureRegex() { if (isJS()) { jsutil.loadResourceIfClassUnknown("core/core_stevesoft.z.js", "com.stevesoft.pat.Regex"); } } public static Regex newRegex(String searchString, String replaceString) { ensureRegex(); return (replaceString == null ? new Regex(searchString) : new Regex(searchString, replaceString)); } public static Regex newRegexPerl(String code) { ensureRegex(); return Regex.perlCode(code); } /** * Initialize Java debug logging. A representative sample -- adapt as desired. */ public static void startJavaLogging() { /** * @j2sIgnore */ { logClass("java.awt.EventDispatchThread", "java.awt.EventQueue", "java.awt.Component", "java.awt.focus.Component", "java.awt.event.Component", "java.awt.focus.DefaultKeyboardFocusManager"); } } /** * Initiate Java logging for a given class. Only for Java, not JavaScript; * Allows debugging of complex event processing. * * @param className */ public static void logClass(String... classNames) { /** * @j2sIgnore * * */ { Logger rootLogger = Logger.getLogger(""); rootLogger.setLevel(Level.ALL); ConsoleHandler consoleHandler = new ConsoleHandler(); consoleHandler.setLevel(Level.ALL); for (int i = classNames.length; --i >= 0;) { Logger logger = Logger.getLogger(classNames[i]); logger.setLevel(Level.ALL); logger.addHandler(consoleHandler); } } } /** * Set the "app" property of the HTML5 applet object, for example, * "testApplet.app", to point to the Jalview instance. This will be the object * that page developers use that is similar to the original Java applet object * that was accessed via LiveConnect. * * @param app */ public static void setAppClass(Object app) { if (isJS()) { jsutil.setAppletAttribute("app", app); } } /** * Retrieve the object's embedded size from a div's style on a page if * embedded in SwingJS. * * @param frame * JFrame or JInternalFrame * @param defaultWidth * use -1 to return null (no default size) * @param defaultHeight * @return the embedded dimensions or null (no default size or not embedded) */ public static Dimension getDimIfEmbedded(Component frame, int defaultWidth, int defaultHeight) { Dimension d = (Dimension) getEmbeddedAttribute(frame, "dim"); return (d == null && defaultWidth >= 0 ? new Dimension(defaultWidth, defaultHeight) : d); } /** * * If this frame Is this frame embedded in a web page, return a known type. * * @param frame * a JFrame or JInternalFrame * @param type * @return null if frame is not embedded. */ public static Object getEmbeddedAttribute(Component frame, String type) { return (isJS() ? jsutil.getEmbeddedAttribute(frame, type) : null); } /** * Only called for JavaScript. * * @return Map for static singleton classes unique to a given applet */ public static HashMap getJSSingletons() { return (isJS() ? jsutil.getJSContext("jssingletons") : null); } /** * By designating initialCapacity and loadFactor, we tell SwingJS to use a * standard (slower) Java HashMap to back this HashSet, thus providing exactly * the same iterator order (until a new Java version changes it!) * * @return a standard Java HashSet */ public static Set getJavaOrderedHashSet() { return new HashSet<>(16, 0.75f); } /** * Switch the flag in SwingJS to use or not use the JavaScript Map object in * any Hashtable, HashMap, or HashSet. Default is enabled. * * For testing purposes only. * */ public static boolean setJavaScriptMapObjectEnabled(boolean enabled) { if (!isJS()) { return false; } jsutil.setJavaScriptMapObjectEnabled(enabled); HashSet hs = new HashSet<>(); // Java hash table iterator in HashMap will return "one" before "two" // because of its hash code; // JavaScript Map object will return "two" first because it was added first. hs.add("two"); hs.add("one"); return (hs.iterator().next() == (enabled ? "two" : "one")); } public static void stackTrace() { new NullPointerException("testing only").printStackTrace(); } /** * escape a string according to the local platform's escape character * * @param file * @return escaped file */ public static String escapeString(String file) { 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(); } private static float javaVersion; public static float getJavaVersion() { if (javaVersion == 0) { try { return javaVersion = Float.parseFloat( System.getProperty("java.specification.version")); } catch (Exception e) { javaVersion = 1.8f; } } return javaVersion; } }