X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FPlatform.java;h=458c02d9374db76875ae7b15fe7fb7f663433905;hb=2d1266a962258b42850b386095bd076d6fbfaf61;hp=e4348d54e4559902048e54b01557ca279706d89a;hpb=e71f64687c21da78cc64ebc3e1f05d0c10dd5580;p=jalview.git diff --git a/src/jalview/util/Platform.java b/src/jalview/util/Platform.java index e4348d5..458c02d 100644 --- a/src/jalview/util/Platform.java +++ b/src/jalview/util/Platform.java @@ -20,11 +20,11 @@ */ package jalview.util; -import jalview.javascript.json.JSON; - import java.awt.Component; import java.awt.Dimension; +import java.awt.GraphicsEnvironment; import java.awt.Toolkit; +import java.awt.event.KeyEvent; import java.awt.event.MouseEvent; import java.io.BufferedReader; import java.io.File; @@ -34,7 +34,18 @@ import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.io.Reader; +import java.lang.reflect.Method; 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; @@ -47,6 +58,8 @@ import org.json.simple.parser.ParseException; import com.stevesoft.pat.Regex; +import jalview.bin.Jalview; +import jalview.javascript.json.JSON; import swingjs.api.JSUtilI; /** @@ -64,20 +77,25 @@ 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 + // really a recommended best practice. jsutil = ((JSUtilI) Class.forName("swingjs.JSUtil").newInstance()); } catch (InstantiationException | IllegalAccessException | ClassNotFoundException e) { e.printStackTrace(); } - } + } } // private static Boolean isHeadless = null; @@ -93,6 +111,36 @@ public class Platform : isMac); } + public static int SHIFT_DOWN_MASK = KeyEvent.SHIFT_DOWN_MASK; + + public static int ALT_DOWN_MASK = KeyEvent.ALT_DOWN_MASK; + + public static int SHORTCUT_KEY_MASK = (Platform.isMac() ? KeyEvent.META_DOWN_MASK : KeyEvent.CTRL_DOWN_MASK); + + static + { + if (!GraphicsEnvironment.isHeadless()) + { + try + { + + Toolkit tk = Toolkit.getDefaultToolkit(); + Method method = tk.getClass().getMethod("getMenuShortcutKeyMaskEx"); + if (method == null) + method = tk.getClass().getMethod("getMenuShortcutKeyMask"); + SHORTCUT_KEY_MASK = ((int) method.invoke(tk, new Object[0])); + if (SHORTCUT_KEY_MASK <= 0xF) + { + // shift this into the extended region (was Java 8) + SHORTCUT_KEY_MASK = SHORTCUT_KEY_MASK << 6; + } + } catch (Exception e) + { + e.printStackTrace(); + } + } + } + /** * added to group mouse events into Windows and nonWindows (mac, unix, linux) * @@ -136,18 +184,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; + } /** * @@ -170,7 +218,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 @@ -194,30 +242,13 @@ public class Platform */ protected static boolean isControlDown(MouseEvent e, boolean aMac) { - 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 - return !e.isPopupTrigger() - && (Toolkit.getDefaultToolkit().getMenuShortcutKeyMask() - & e.getModifiers()) != 0; - // could we use e.isMetaDown() here? + System.out.println(e.isPopupTrigger() + + " " + ((SHORTCUT_KEY_MASK & e.getModifiersEx()) != 0) + + " " + e.isControlDown()); + return (aMac ? !e.isPopupTrigger() + && (SHORTCUT_KEY_MASK & e.getModifiersEx()) != 0 + : e.isControlDown()); } // BH: I don't know about that previous method. Here is what SwingJS uses. @@ -360,7 +391,6 @@ public class Platform } } - public static void cacheFileData(File file) { if (isJS) @@ -390,7 +420,7 @@ public class Platform } return null; } - + public static String getFileAsString(String url) { if (isJS && url != null) @@ -414,7 +444,6 @@ public class Platform return false; } - public static void addJ2SBinaryType(String ext) { if (isJS) @@ -422,7 +451,7 @@ public class Platform jsutil.addBinaryFileType(ext); } } - + /** * Encode the URI using JavaScript encodeURIComponent * @@ -447,8 +476,6 @@ public class Platform { if (!isJS()) { - // BH note -- this next line is brought into Platform, as it is Java-only. - BrowserLauncher.openURL(url); return false; } /** @@ -465,7 +492,6 @@ public class Platform return (isJS ? (String) jsutil.getAppletAttribute("_uniqueId") : null); } - /** * Read the Info block for this applet. * @@ -540,8 +566,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) @@ -572,8 +597,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 @@ -619,15 +644,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 @@ -637,13 +667,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 @@ -664,11 +697,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. @@ -694,6 +724,11 @@ public class Platform } + public static Regex newRegex(String regex) + { + return newRegex(regex, null); + } + public static Regex newRegex(String searchString, String replaceString) { ensureRegex(); @@ -750,7 +785,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 @@ -790,17 +824,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) @@ -820,6 +854,170 @@ public class Platform } - + public static URL getDocumentBase() + { + return (isJS ? jsutil.getDocumentBase() : null); + } + + public static URL getCodeBase() + { + return (isJS ? jsutil.getCodeBase() : null); + } + + public static String getUserPath(String subpath) + { + char sep = File.separatorChar; + return System.getProperty("user.home") + sep + + subpath.replace('/', sep); + } + + /** + * This method enables checking if a cached file has exceeded a certain + * threshold(in days) + * + * @param file + * the cached file + * @param noOfDays + * the threshold in days + * @return + */ + 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. + return false; + } + Path filePath = file.toPath(); + BasicFileAttributes attr; + int diffInDays = 0; + try + { + attr = Files.readAttributes(filePath, BasicFileAttributes.class); + diffInDays = (int) ((new Date().getTime() + - attr.lastModifiedTime().toMillis()) + / (1000 * 60 * 60 * 24)); + // System.out.println("Diff in days : " + diffInDays); + } catch (IOException e) + { + e.printStackTrace(); + } + return noOfDays <= diffInDays; + } + + /** + * Get the leading integer part of a string that begins with an integer. + * + * @param input + * - the string input to process + * @param failValue + * - value returned if unsuccessful + * @return + */ + public static int getLeadingIntegerValue(String input, int failValue) + { + if (input == null) + { + return failValue; + } + if (isJS) + { + int val = /** @j2sNative 1 ? parseInt(input) : */ + 0; + return (val == val + 0 ? val : failValue); + } + // JavaScript does not support Regex ? lookahead + String[] parts = input.split("(?=\\D)(?<=\\d)"); + if (parts != null && parts.length > 0 && parts[0].matches("[0-9]+")) + { + return Integer.valueOf(parts[0]); + } + return failValue; + } + + public static Map 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()); + } + } + } }