2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import java.awt.Component;
24 import java.awt.Dimension;
25 import java.awt.GraphicsEnvironment;
26 import java.awt.Toolkit;
27 import java.awt.event.KeyEvent;
28 import java.awt.event.MouseEvent;
29 import java.io.BufferedReader;
31 import java.io.FileOutputStream;
32 import java.io.FileReader;
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.io.InputStreamReader;
36 import java.io.Reader;
37 import java.lang.reflect.Method;
39 import java.nio.channels.Channels;
40 import java.nio.channels.ReadableByteChannel;
41 import java.nio.file.Files;
42 import java.nio.file.Path;
43 import java.nio.file.Paths;
44 import java.nio.file.StandardCopyOption;
45 import java.nio.file.attribute.BasicFileAttributes;
46 import java.util.Date;
47 import java.util.Locale;
49 import java.util.Properties;
50 import java.util.logging.ConsoleHandler;
51 import java.util.logging.Level;
52 import java.util.logging.Logger;
54 import javax.swing.SwingUtilities;
56 import org.json.simple.parser.JSONParser;
57 import org.json.simple.parser.ParseException;
59 import com.stevesoft.pat.Regex;
61 import jalview.bin.Jalview;
62 import jalview.javascript.json.JSON;
63 import swingjs.api.JSUtilI;
66 * System platform information used by Applet and Application
73 private static boolean isJS = /** @j2sNative true || */
76 private static Boolean isNoJSMac = null, isNoJSWin = null, isMac = null,
79 private static Boolean isHeadless = null;
81 private static swingjs.api.JSUtilI jsutil;
89 // this is ok - it's a highly embedded method in Java; the deprecation
91 // really a recommended best practice.
92 jsutil = ((JSUtilI) Class.forName("swingjs.JSUtil").newInstance());
93 } catch (InstantiationException | IllegalAccessException
94 | ClassNotFoundException e)
100 // private static Boolean isHeadless = null;
103 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
107 public static boolean isMac()
109 return (isMac == null
110 ? (isMac = (System.getProperty("os.name").indexOf("Mac") >= 0))
114 public static int SHORTCUT_KEY_MASK = (Platform.isMac() ? KeyEvent.META_DOWN_MASK : KeyEvent.CTRL_DOWN_MASK);
118 // Using non-deprecated Extended key mask modifiers, but Java 8 has no
119 // getMenuShortcutKeyMaskEx method
120 Toolkit tk = Toolkit.getDefaultToolkit();
121 Method method = null;
124 method = tk.getClass().getMethod("getMenuShortcutKeyMaskEx");
125 } catch (NoSuchMethodException e)
128 "Could not find Toolkit method getMenuShortcutKeyMaskEx. Trying getMenuShortcutKeyMask.");
134 method = tk.getClass().getMethod("getMenuShortcutKeyMask");
135 } catch (NoSuchMethodException e)
138 "Could not find Toolkit method getMenuShortcutKeyMaskEx or getMenuShortcutKeyMask.");
146 method.setAccessible(true);
147 SHORTCUT_KEY_MASK = ((int) method.invoke(tk, new Object[0]));
148 } catch (Exception e)
153 if (SHORTCUT_KEY_MASK <= 0xF)
155 // shift this into the extended region (was Java 8)
156 SHORTCUT_KEY_MASK = SHORTCUT_KEY_MASK << 6;
162 * added to group mouse events into Windows and nonWindows (mac, unix, linux)
166 public static boolean isWin()
168 return (isWin == null
169 ? (isWin = (System.getProperty("os.name").indexOf("Win") >= 0))
175 * @return true if HTML5 JavaScript
177 public static boolean isJS()
183 * sorry folks - Macs really are different
185 * BH: disabled for SwingJS -- will need to check key-press issues
187 * @return true if we do things in a special way.
189 public static boolean isAMacAndNotJS()
191 return (isNoJSMac == null ? (isNoJSMac = !isJS && isMac()) : isNoJSMac);
195 * Check if we are on a Microsoft plaform...
197 * @return true if we have to cope with another platform variation
199 public static boolean isWindowsAndNotJS()
201 return (isNoJSWin == null ? (isNoJSWin = !isJS && isWin()) : isNoJSWin);
206 * @return true if we are running in non-interactive no UI mode
208 public static boolean isHeadless()
210 if (isHeadless == null)
212 isHeadless = "true".equals(System.getProperty("java.awt.headless"));
219 * @return nominal maximum command line length for this platform
221 public static int getMaxCommandLineLength()
223 // TODO: determine nominal limits for most platforms.
224 return 2046; // this is the max length for a windows NT system.
228 * Answers the input with every backslash replaced with a double backslash (an
229 * 'escaped' single backslash)
234 public static String escapeBackslashes(String s)
236 return s == null ? null : s.replace("\\", "\\\\");
240 * Answers true if the mouse event has Meta-down (Command key on Mac) or
241 * Ctrl-down (on other o/s). Note this answers _false_ if the Ctrl key is
242 * pressed instead of the Meta/Cmd key on Mac. To test for Ctrl-pressed on
243 * Mac, you can use e.isPopupTrigger().
248 public static boolean isControlDown(MouseEvent e)
250 return isControlDown(e, isMac());
254 * Overloaded version of method (to allow unit testing)
260 protected static boolean isControlDown(MouseEvent e, boolean aMac)
263 // System.out.println(e.isPopupTrigger()
264 // + " " + ((SHORTCUT_KEY_MASK & e.getModifiersEx()) != 0)
265 // + " " + e.isControlDown());
266 return (aMac ? !e.isPopupTrigger()
267 && (SHORTCUT_KEY_MASK & e.getModifiersEx()) != 0
268 : e.isControlDown());
271 // BH: I don't know about that previous method. Here is what SwingJS uses.
272 // Notice the distinction in mouse events. (BUTTON3_MASK == META)
274 // private static boolean isPopupTrigger(int id, int mods, boolean isWin) {
275 // boolean rt = ((mods & InputEvent.BUTTON3_MASK) != 0);
277 // if (id != MouseEvent.MOUSE_RELEASED)
280 //// // Oddly, Windows returns InputEvent.META_DOWN_MASK on release, though
281 //// // BUTTON3_DOWN_MASK for pressed. So here we just accept both.
283 //// actually, we can use XXX_MASK, not XXX_DOWN_MASK and avoid this issue,
285 //// J2S adds the appropriate extended (0x3FC0) and simple (0x3F) modifiers.
289 // // mac, linux, unix
290 // if (id != MouseEvent.MOUSE_PRESSED)
292 // boolean lt = ((mods & InputEvent.BUTTON1_MASK) != 0);
293 // boolean ctrl = ((mods & InputEvent.CTRL_MASK) != 0);
294 // return rt || (ctrl && lt);
300 * Windows (not Mac, Linux, or Unix) and right button to test for the
301 * right-mouse pressed event in Windows that would have opened a menu or a
307 public static boolean isWinRightButton(MouseEvent e)
309 // was !isAMac(), but that is true also for Linux and Unix and JS,
311 return isWin() && SwingUtilities.isRightMouseButton(e);
315 * Windows (not Mac, Linux, or Unix) and middle button -- for mouse wheeling
316 * without pressing the button.
321 public static boolean isWinMiddleButton(MouseEvent e)
323 // was !isAMac(), but that is true also for Linux and Unix and JS
324 return isWin() && SwingUtilities.isMiddleMouseButton(e);
327 public static boolean allowMnemonics()
332 public final static int TIME_RESET = 0;
334 public final static int TIME_MARK = 1;
336 public static final int TIME_SET = 2;
338 public static final int TIME_GET = 3;
340 public static long time, mark, set, duration;
345 * Platform.timeCheck(null, Platform.TIME_MARK);
349 * Platform.timeCheck("some message", Platform.TIME_MARK);
351 * reset...[set/mark]n...get
356 public static void timeCheck(String msg, int mode)
358 long t = System.currentTimeMillis();
366 System.err.println("Platform: timer reset\t\t\t" + msg);
372 // total time between set/mark points
373 duration += (t - set);
383 System.err.println("Platform: timer mark\t" + ((t - time) / 1000f)
384 + "\t" + ((t - mark) / 1000f) + "\t" + msg);
395 System.err.println("Platform: timer dur\t" + ((t - time) / 1000f)
396 + "\t" + ((duration) / 1000f) + "\t" + msg);
403 public static void cacheFileData(String path, Object data)
405 if (isJS && data != null)
407 jsutil.cachePathData(path, data);
411 public static void cacheFileData(File file)
415 byte[] data = Platform.getFileBytes(file);
419 cacheFileData(file.toString(), data);
425 public static byte[] getFileBytes(File f)
427 return (isJS && f != null ? jsutil.getBytes(f) : null);
430 public static byte[] getFileAsBytes(String fileStr)
432 if (isJS && fileStr != null)
434 byte[] bytes = (byte[]) jsutil.getFile(fileStr, false);
435 cacheFileData(fileStr, bytes);
441 public static String getFileAsString(String url)
443 if (isJS && url != null)
445 String ret = (String) jsutil.getFile(url, true);
446 cacheFileData(url, ret);
452 public static boolean setFileBytes(File f, String urlstring)
454 if (isJS && f != null && urlstring != null)
456 @SuppressWarnings("unused")
457 byte[] bytes = getFileAsBytes(urlstring);
458 jsutil.setFileBytes(f, bytes);
464 public static void addJ2SBinaryType(String ext)
468 jsutil.addBinaryFileType(ext);
473 * Encode the URI using JavaScript encodeURIComponent
476 * @return encoded value
478 public static String encodeURI(String value)
481 * @j2sNative value = encodeURIComponent(value);
487 * Open the URL using a simple window call if this is JavaScript
490 * @return true if window has been opened
492 public static boolean openURL(String url) throws IOException
507 public static String getUniqueAppletID()
509 return (isJS ? (String) jsutil.getAppletAttribute("_uniqueId") : null);
513 * Read the Info block for this applet.
518 * @return unique id for this applet
520 public static void readInfoProperties(String prefix, Properties p)
524 String id = getUniqueAppletID();
528 @SuppressWarnings("unused")
529 Object info = jsutil.getAppletAttribute("__Info");
531 * @j2sNative for (key in info) { value = info[key];
534 if (key.indexOf(prefix) == 0)
536 System.out.println("Platform id=" + id + " reading Info." + key
548 public static void setAjaxJSON(URL url)
556 public static Object parseJSON(InputStream response)
557 throws IOException, ParseException
561 return JSON.parse(response);
564 BufferedReader br = null;
567 br = new BufferedReader(new InputStreamReader(response, "UTF-8"));
568 return new JSONParser().parse(br);
576 } catch (IOException e)
584 public static Object parseJSON(String json) throws ParseException
586 return (isJS() ? JSON.parse(json) : new JSONParser().parse(json));
589 public static Object parseJSON(Reader r)
590 throws IOException, ParseException
599 return new JSONParser().parse(r);
601 // Using a file reader is not currently supported in SwingJS JavaScript
603 if (r instanceof FileReader)
605 throw new IOException(
606 "StringJS does not support FileReader parsing for JSON -- but it could...");
608 return JSON.parse(r);
612 * Dump the input stream to an output file.
616 * @throws IOException
617 * if the file cannot be created or there is a problem reading the
620 public static void streamToFile(InputStream is, File outFile)
626 jsutil.setFileBytes(outFile, is);
630 FileOutputStream fio = new FileOutputStream(outFile);
633 byte[] bb = new byte[32 * 1024];
635 while ((l = is.read(bb)) > 0)
646 * Add a known domain that implements access-control-allow-origin:*
648 * These should be reviewed periodically.
651 * for a service that is not allowing ajax
653 * @author hansonr@stolaf.edu
656 public static void addJ2SDirectDatabaseCall(String domain)
661 jsutil.addDirectDatabaseCall(domain);
664 "Platform adding known access-control-allow-origin * for domain "
671 * Allow for URL-line command arguments. Untested.
674 public static void getURLCommandArguments()
679 * Retrieve the first query field as command arguments to Jalview. Include
680 * only if prior to "?j2s" or "&j2s" or "#". Assign the applet's __Info.args
681 * element to this value.
684 * decodeURI((document.location.href.replace("&","?").split("?j2s")[0]
685 * + "?").split("?")[1].split("#")[0]); a &&
686 * (J2S.thisApplet.__Info.args = a.split(" "));
688 * System.out.println("URL arguments: " + a);
690 } catch (Throwable t) {
695 * A (case sensitive) file path comparator that ignores the difference between
702 public static boolean pathEquals(String path1, String path2)
706 return path2 == null;
712 String p1 = path1.replace('\\', '/');
713 String p2 = path2.replace('\\', '/');
714 return p1.equals(p2);
717 ///////////// JAL-3253 Applet additions //////////////
720 * Retrieve the object's embedded size from a div's style on a page if
721 * embedded in SwingJS.
724 * JFrame or JInternalFrame
725 * @param defaultWidth
726 * use -1 to return null (no default size)
727 * @param defaultHeight
728 * @return the embedded dimensions or null (no default size or not embedded)
730 public static Dimension getDimIfEmbedded(Component frame,
731 int defaultWidth, int defaultHeight)
736 d = (Dimension) getEmbeddedAttribute(frame, "dim");
738 return (d == null && defaultWidth >= 0
739 ? new Dimension(defaultWidth, defaultHeight)
744 public static Regex newRegex(String regex)
746 return newRegex(regex, null);
749 public static Regex newRegex(String searchString, String replaceString)
752 return (replaceString == null ? new Regex(searchString)
753 : new Regex(searchString, replaceString));
756 public static Regex newRegexPerl(String code)
759 return Regex.perlCode(code);
763 * Initialize Java debug logging. A representative sample -- adapt as desired.
765 public static void startJavaLogging()
771 logClass("java.awt.EventDispatchThread", "java.awt.EventQueue",
772 "java.awt.Component", "java.awt.focus.Component",
773 "java.awt.event.Component",
774 "java.awt.focus.DefaultKeyboardFocusManager");
779 * Initiate Java logging for a given class. Only for Java, not JavaScript;
780 * Allows debugging of complex event processing.
784 public static void logClass(String... classNames)
792 Logger rootLogger = Logger.getLogger("");
793 rootLogger.setLevel(Level.ALL);
794 ConsoleHandler consoleHandler = new ConsoleHandler();
795 consoleHandler.setLevel(Level.ALL);
796 for (int i = classNames.length; --i >= 0;)
798 Logger logger = Logger.getLogger(classNames[i]);
799 logger.setLevel(Level.ALL);
800 logger.addHandler(consoleHandler);
806 * load a resource -- probably a core file -- if and only if a particular
807 * class has not been instantialized. We use a String here because if we used
808 * a .class object, that reference itself would simply load the class, and we
809 * want the core package to include that as well.
811 * @param resourcePath
814 public static void loadStaticResource(String resourcePath,
819 jsutil.loadResourceIfClassUnknown(resourcePath, className);
823 public static void ensureRegex()
827 loadStaticResource("core/core_stevesoft.z.js",
828 "com.stevesoft.pat.Regex");
833 * Set the "app" property of the HTML5 applet object, for example,
834 * "testApplet.app", to point to the Jalview instance. This will be the object
835 * that page developers use that is similar to the original Java applet object
836 * that was accessed via LiveConnect.
840 public static void setAppClass(Object j)
844 jsutil.setAppClass(j);
850 * If this frame is embedded in a web page, return a known type.
853 * a JFrame or JInternalFrame
854 * @param type "name", "node", "init", "dim", or any DOM attribute, such as "id"
855 * @return null if frame is not embedded.
857 public static Object getEmbeddedAttribute(Component frame, String type)
859 return (isJS ? jsutil.getEmbeddedAttribute(frame, type) : null);
862 public static void stackTrace()
866 throw new NullPointerException();
867 } catch (Exception e)
874 public static URL getDocumentBase()
876 return (isJS ? jsutil.getDocumentBase() : null);
879 public static URL getCodeBase()
881 return (isJS ? jsutil.getCodeBase() : null);
884 public static String getUserPath(String subpath)
886 char sep = File.separatorChar;
887 return System.getProperty("user.home") + sep
888 + subpath.replace('/', sep);
892 * This method enables checking if a cached file has exceeded a certain
898 * the threshold in days
901 public static boolean isFileOlderThanThreshold(File file, int noOfDays)
905 // not meaningful in SwingJS -- this is a session-specific temp file. It
906 // doesn't have a timestamp.
909 Path filePath = file.toPath();
910 BasicFileAttributes attr;
914 attr = Files.readAttributes(filePath, BasicFileAttributes.class);
915 diffInDays = (int) ((new Date().getTime()
916 - attr.lastModifiedTime().toMillis())
917 / (1000 * 60 * 60 * 24));
918 // System.out.println("Diff in days : " + diffInDays);
919 } catch (IOException e)
923 return noOfDays <= diffInDays;
927 * Get the leading integer part of a string that begins with an integer.
930 * - the string input to process
932 * - value returned if unsuccessful
935 public static int getLeadingIntegerValue(String input, int failValue)
943 int val = /** @j2sNative 1 ? parseInt(input) : */
945 return (val == val + 0 ? val : failValue);
947 // JavaScript does not support Regex ? lookahead
948 String[] parts = input.split("(?=\\D)(?<=\\d)");
949 if (parts != null && parts.length > 0 && parts[0].matches("[0-9]+"))
951 return Integer.valueOf(parts[0]);
956 public static Map<String, Object> getAppletInfoAsMap()
958 return (isJS ? jsutil.getAppletInfoAsMap() : null);
962 * Get the SwingJS applet ID and combine that with the frameType
965 * "alignment", "desktop", etc., or null
968 public static String getAppID(String frameType)
971 String id = Jalview.getInstance().j2sAppletID;
974 Jalview.getInstance().j2sAppletID = id = (isJS ? (String) jsutil
975 .getAppletAttribute("_id") : "jalview");
977 return id + (frameType == null ? "" : "-" + frameType);
982 * Option to avoid unnecessary seeking of nonexistent resources in JavaScript.
983 * Works in Java as well.
988 public static Locale getLocaleOrNone(Locale loc)
990 return (isJS && loc.getLanguage() == "en" ? new Locale("") : loc);
994 * From UrlDownloadClient; trivial in JavaScript; painful in Java.
998 * @throws IOException
1000 public static void download(String urlstring, String outfile)
1004 try (InputStream is = new URL(urlstring).openStream())
1007 { // so much easier!
1008 streamToFile(is, new File(outfile));
1011 temp = Files.createTempFile(".jalview_", ".tmp");
1012 try (FileOutputStream fos = new FileOutputStream(temp.toString());
1013 ReadableByteChannel rbc = Channels.newChannel(is))
1015 fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
1016 // copy tempfile to outfile once our download completes
1017 // incase something goes wrong
1018 Files.copy(temp, Paths.get(outfile),
1019 StandardCopyOption.REPLACE_EXISTING);
1021 } catch (IOException e)
1030 Files.deleteIfExists(temp);
1032 } catch (IOException e)
1034 System.out.println("Exception while deleting download temp file: "