Changeset 9738db7

Timestamp:

Dec 12, 2018 8:12:07 PM (16 months ago)

Author:

zzz <zzz@…>

Branches:

master

Children:

6c3c227c

Parents:

51bf23a

Message:

UrlLauncher?:

• Use arrays for exec
• Randomize temp file name
• Require quotes around args containing spaces in routerconsole.browser property
• Add debug logging
• Add chromium-browser to the default list
• Parse and use full command line from Windows registry
• Replace %1 with url in registry line and routerconsole.browser property

ShellCommand?:

• Switch to i2p logging

Files:

• apps/systray/java/src/net/i2p/apps/systray/UrlLauncher.java (modified) (12 diffs)
• core/java/src/net/i2p/util/ShellCommand.java (modified) (9 diffs)
• history.txt (modified) (1 diff)
• router/java/src/net/i2p/router/RouterVersion.java (modified) (1 diff)

apps/systray/java/src/net/i2p/apps/systray/UrlLauncher.java

@@ -21 +21 @@
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.Arrays;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Locale;
 
@@ -27 +30 @@
 import static net.i2p.app.ClientAppState.*;
 import net.i2p.util.I2PAppThread;
+import net.i2p.util.Log;
 import net.i2p.util.ShellCommand;
 import net.i2p.util.SystemVersion;
@@ -47 +51 @@
     private final ClientAppManager _mgr;
     private final String[] _args;
+    private final Log _log;
 
     private static final int WAIT_TIME = 5*1000;
@@ -70 +75 @@
             "opera -newpage",
             "firefox",
+            "chromium-browser",
             "mozilla",
             "netscape",
@@ -83 +89 @@
      *  ClientApp constructor used from clients.config
      *
+     *  @param mgr null OK
+     *  @param args URL in args[0] or null args for router console
      *  @since 0.9.18
      */
@@ -88 +96 @@
         _state = UNINITIALIZED;
         _context = context;
+        _log = _context.logManager().getLog(UrlLauncher.class);
         _mgr = mgr;
         if (args == null || args.length <= 0)
@@ -104 +113 @@
         _state = UNINITIALIZED;
         _context = I2PAppContext.getGlobalContext();
+        _log = _context.logManager().getLog(UrlLauncher.class);
         _mgr = null;
         _args = null;
@@ -168 +178 @@
      * browsers.
      * 
-     * BLOCKING
+     * BLOCKING. This repeatedly probes the server port at the given url
+     * until it is apparently ready.
      * 
      * @param  url The URL to open.
@@ -177 +188 @@
      */ 
     public boolean openUrl(String url) throws IOException {
+        if (_log.shouldDebug()) _log.debug("Waiting for server");
         waitForServer(url);
+        if (_log.shouldDebug()) _log.debug("Done waiting for server");
         if (validateUrlFormat(url)) {
             String cbrowser = _context.getProperty(PROP_BROWSER);
@@ -186 +199 @@
                 String osName = System.getProperty("os.name");
                 if (osName.toLowerCase(Locale.US).startsWith("mac os x")) {
-
-                    if (_shellCommand.executeSilentAndWaitTimed("open " + url, 5))
+                    String[] args = new String[] { "open", url };
+                    if (_log.shouldDebug()) _log.debug("Execute: " + Arrays.toString(args));
+                    if (_shellCommand.executeSilentAndWaitTimed(args , 5))
                         return true;
-
                 } else {
                     return false;
                 }
-
-                if (_shellCommand.executeSilentAndWaitTimed("iexplore " + url, 5))
+                String[] args = new String[] { "iexplore", url };
+                if (_log.shouldDebug()) _log.debug("Execute: " + Arrays.toString(args));
+                if (_shellCommand.executeSilentAndWaitTimed(args , 5))
                     return true;
             } else if (SystemVersion.isWindows()) {
-                String         browserString  = "\"C:\\Program Files\\Internet Explorer\\iexplore.exe\" -nohome";
-                BufferedReader bufferedReader = null;
-
-                File foo = new File(_context.getTempDir(), "browser.reg");
-                _shellCommand.executeSilentAndWait("regedit /E \"" + foo.getAbsolutePath() + "\" \"HKEY_CLASSES_ROOT\\http\\shell\\open\\command\"");
-
-                try {
-                    bufferedReader = new BufferedReader(new InputStreamReader(new FileInputStream(foo), "UTF-16"));
-                    for (String line; (line = bufferedReader.readLine()) != null; ) {
-                        if (line.startsWith("@=")) {
-                            // we should really use the whole line and replace %1 with the url
-                            browserString = line.substring(3, line.toLowerCase(Locale.US).indexOf(".exe") + 4);
-                            if (browserString.startsWith("\\\""))
-                                browserString = browserString.substring(2);
-                            browserString = "\"" + browserString + "\"";
+                String[] browserString  = new String[] { "C:\\Program Files\\Internet Explorer\\iexplore.exe", "-nohome", url };
+                File foo = new File(_context.getTempDir(), "browser" + _context.random().nextLong() + ".reg");
+                String[] args = new String[] { "regedit", "/E", foo.getAbsolutePath(), "HKEY_CLASSES_ROOT\\http\\shell\\open\\command" };
+                if (_log.shouldDebug()) _log.debug("Execute: " + Arrays.toString(args));
+                boolean ok = _shellCommand.executeSilentAndWait(args);
+                if (ok) {
+                    BufferedReader bufferedReader = null;
+                    try {
+                        bufferedReader = new BufferedReader(new InputStreamReader(new FileInputStream(foo), "UTF-16"));
+                        for (String line; (line = bufferedReader.readLine()) != null; ) {
+                            // @="\"C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe\" -osint -url \"%1\""
+                            if (line.startsWith("@=")) {
+                                if (_log.shouldDebug()) _log.debug("From RegEdit: " + line);
+                                line = line.substring(2).trim();
+                                if (line.startsWith("\"") && line.endsWith("\""))
+                                    line = line.substring(1, line.length() - 1);
+                                line = line.replace("\\\\", "\\");
+                                line = line.replace("\\\"", "\"");
+                                if (_log.shouldDebug()) _log.debug("Mod RegEdit: " + line);
+                                // "C:\Program Files (x86)\Mozilla Firefox\firefox.exe" -osint -url "%1"
+                                // use the whole line
+                                String[] aarg = parseArgs(line, url);
+                                if (aarg.length > 0) {
+                                    browserString = aarg;
+                                    break;
+                                }
+                            }
                         }
+                    } catch (IOException e) {
+                        if (_log.shouldWarn())
+                            _log.warn("Reading regedit output", e);
+                    } finally {
+                        if (bufferedReader != null)
+                            try { bufferedReader.close(); } catch (IOException ioe) {}
+                        foo.delete();
                     }
-                    try {
-                        bufferedReader.close();
-                    } catch (IOException e) {
-                        // No worries.
-                    }
-                    foo.delete();
-                } catch (IOException e) {
-                    // Defaults to IE.
-                } finally {
-                    if (bufferedReader != null)
-                        try { bufferedReader.close(); } catch (IOException ioe) {}
+                } else if (_log.shouldWarn()) {
+                    _log.warn("Regedit Failed: " + Arrays.toString(args));
                 }
-                if (_shellCommand.executeSilentAndWaitTimed(browserString + ' ' + url, 5))
+                if (_log.shouldDebug()) _log.debug("Execute: " + Arrays.toString(browserString));
+                if (_shellCommand.executeSilentAndWaitTimed(browserString, 5))
                     return true;
+                if (_log.shouldInfo()) _log.info("Failed: " + Arrays.toString(browserString));
             } else {
                 // fall through
             }
+            String[] args = new String[2];
+            args[1] = url;
             for (int i = 0; i < BROWSERS.length; i++) {
-                if (_shellCommand.executeSilentAndWaitTimed(BROWSERS[i] + ' ' + url, 5))
+                args[0] = BROWSERS[i];
+                if (_log.shouldDebug()) _log.debug("Execute: " + Arrays.toString(args));
+                if (_shellCommand.executeSilentAndWaitTimed(args, 5))
                     return true;
+                if (_log.shouldInfo()) _log.info("Failed: " + Arrays.toString(args));
             }
         }
@@ -241 +272 @@
     /**
      * Opens the given URL with the given browser.
-     * 
-     * BLOCKING
+     * As of 0.9.38, the browser parameter will be parsed into arguments
+     * separated by spaces or tabs.
+     * %1, if present, will be replaced with the url.
+     * Arguments may be surrounded by single or double quotes if
+     * they contain spaces or tabs.
+     * There is no mechanism to escape quotes or other chars with backslashes.
+     * 
+     * BLOCKING. However, this does NOT probe the server port to see if it is ready.
      * 
      * @param  url     The URL to open.
-     * @param  browser The browser to use.
+     * @param  browser The browser to use. See above for quoting rules.
      * @return         <code>true</code> if the operation was successful,
      *                 otherwise <code>false</code>.
@@ -254 +291 @@
         waitForServer(url);
         if (validateUrlFormat(url)) {
-            if (_shellCommand.executeSilentAndWaitTimed(browser + " " + url, 5))
-                return true;
+            String[] args = parseArgs(browser, url);
+            if (args.length > 0) {
+                if (_log.shouldDebug()) _log.debug("Execute: " + Arrays.toString(args));
+                if (_shellCommand.executeSilentAndWaitTimed(args, 5))
+                    return true;
+            }
         }
         return false;
+    }
+
+    /**
+     *  Parse args into arguments
+     *  separated by spaces or tabs.
+     *  %1, if present, will be replaced with the url,
+     *  otherwise it will be added as the last argument.
+     *  Arguments may be surrounded by single or double quotes if
+     *  they contain spaces or tabs.
+     *  There is no mechanism to escape quotes or other chars with backslashes.
+     *  Adapted from i2ptunnel SSLHelper.
+     *
+     *  @return param args non-null
+     *  @return non-null
+     *  @since 0.9.38
+     */
+    private static String[] parseArgs(String args, String url) {
+        List<String> argList = new ArrayList<String>(4);
+        StringBuilder buf = new StringBuilder(32);
+        boolean isQuoted = false;
+        for (int j = 0; j < args.length(); j++) {
+            char c = args.charAt(j);
+            switch (c) {
+                case '\'':
+                case '"':
+                    if (isQuoted) {
+                        String str = buf.toString().trim();
+                        if (str.length() > 0)
+                            argList.add(str);
+                        buf.setLength(0);
+                    }
+                    isQuoted = !isQuoted;
+                    break;
+                case ' ':
+                case '\t':
+                    // whitespace - if we're in a quoted section, keep this as part of the quote,
+                    // otherwise use it as a delim
+                    if (isQuoted) {
+                        buf.append(c);
+                    } else {
+                        String str = buf.toString().trim();
+                        if (str.length() > 0)
+                            argList.add(str);
+                        buf.setLength(0);
+                    }
+                    break;
+                default:
+                    buf.append(c);
+                    break;
+            }
+        }
+        if (buf.length() > 0) {
+            String str = buf.toString().trim();
+            if (str.length() > 0)
+                argList.add(str);
+        }
+        if (argList.isEmpty())
+            return new String[] {};
+        boolean foundpct = false;
+        // replace %1 with the url
+        for (int i = 0; i < argList.size(); i++) {
+            String arg = argList.get(i);
+            if (arg.contains("%1")) {
+                argList.set(i, arg.replace("%1", url));
+                foundpct = true;
+            }
+        }
+        // add url if no %1
+        if (!foundpct)
+            argList.add(url);
+        return argList.toArray(new String[argList.size()]);
     }
 

core/java/src/net/i2p/util/ShellCommand.java

@@ -18 +18 @@
 import java.io.OutputStreamWriter;
 import java.util.Arrays;
+
+import net.i2p.I2PAppContext;
 
 /**
@@ -29 +31 @@
 public class ShellCommand {
 
-    private static final boolean DEBUG = false;
     private static final boolean CONSUME_OUTPUT    = true;
     private static final boolean NO_CONSUME_OUTPUT = false;
@@ -359 +360 @@
         String name = null;
         long begin = 0;
-        if (DEBUG) {
+        Log log = I2PAppContext.getGlobalContext().logManager().getLog(ShellCommand.class);
+        if (log.shouldDebug()) {
             if (shellCommand instanceof String) {
                 name = (String) shellCommand;
@@ -375 +377 @@
                 commandThread.join(seconds * 1000);
                 if (commandThread.isAlive()) {
-                    if (DEBUG)
-                        System.out.println("ShellCommand gave up waiting for \"" + name + "\" after " + seconds + " seconds");
+                    if (log.shouldDebug())
+                        log.debug("ShellCommand gave up waiting for \"" + name + "\" after " + seconds + " seconds");
                     return true;
                 }
@@ -383 +385 @@
             // Wake up, time to die.
         }
-        if (DEBUG)
-            System.out.println("ShellCommand returning " + result.commandSuccessful + " for \"" + name + "\" after " + (System.currentTimeMillis() - begin) + " ms");
+        if (log.shouldDebug())
+            log.debug("ShellCommand returning " + result.commandSuccessful + " for \"" + name + "\" after " + (System.currentTimeMillis() - begin) + " ms");
         return result.commandSuccessful;
     }
@@ -427 +429 @@
         Process process;
         String name = null;  // for debugging only
+        Log log = I2PAppContext.getGlobalContext().logManager().getLog(ShellCommand.class);
         try {
             // easy way so we don't have to copy this whole method
             if (shellCommand instanceof String) {
                 name = (String) shellCommand;
-                if (DEBUG)
-                    System.out.println("ShellCommand exec \"" + name + "\" consume? " + consumeOutput + " wait? " + waitForExitStatus);
+                if (log.shouldDebug())
+                    log.debug("ShellCommand exec \"" + name + "\" consume? " + consumeOutput + " wait? " + waitForExitStatus);
                 process = Runtime.getRuntime().exec(name);
             } else if (shellCommand instanceof String[]) {
                 String[] arr = (String[]) shellCommand;
-                if (DEBUG) {
+                if (log.shouldDebug()) {
                     name = Arrays.toString(arr);
-                    System.out.println("ShellCommand exec \"" + name + "\" consume? " + consumeOutput + " wait? " + waitForExitStatus);
+                    log.debug("ShellCommand exec \"" + name + "\" consume? " + consumeOutput + " wait? " + waitForExitStatus);
                 }
                 process = Runtime.getRuntime().exec(arr);
@@ -462 +465 @@
             }
             if (waitForExitStatus) {
-                if (DEBUG)
-                    System.out.println("ShellCommand waiting for \"" + name + '\"');
+                if (log.shouldDebug())
+                    log.debug("ShellCommand waiting for \"" + name + '\"');
                 try {
                     process.waitFor();
                 } catch (InterruptedException e) {
-                    if (DEBUG) {
-                        System.out.println("ShellCommand exception waiting for \"" + name + '\"');
-                        e.printStackTrace();
+                    if (log.shouldWarn()) {
+                        log.warn("ShellCommand exception waiting for \"" + name + '"', e);
                     }
                     if (!consumeOutput)
@@ -479 +481 @@
                     killStreams();
 
-                if (DEBUG)
-                    System.out.println("ShellCommand exit value is " + process.exitValue() + " for \"" + name + '\"');
+                if (log.shouldDebug())
+                    log.debug("ShellCommand exit value is " + process.exitValue() + " for \"" + name + '\"');
                 if (process.exitValue() > 0)
                     return false;
@@ -486 +488 @@
         } catch (IOException e) {
             // probably IOException, file not found from exec()
-            if (DEBUG) {
-                System.out.println("ShellCommand execute exception for \"" + name + '\"');
-                e.printStackTrace();
+            if (log.shouldWarn()) {
+                log.warn("ShellCommand execute exception for \"" + name + '"', e);
             }
             return false;

history.txt

@@ +1 @@
+2018-12-12 zzz
+ * DTG: Use UrlLauncher to launch browser
+ * Installer: Drop unused systray.config
+ * UrlLauncher: Improvements and cleanups
+ * Util: Add another ShellCommand String[] method
+
+2018-12-11 zzz
+ * Crypto: HMAC-SHA256 cleanup
+ * Debian: Add conffiles list
+ * Utils: Enable TLSv1.3 for SSL sockets
+
+2018-12-08 zzz
+ * Console: Hide I2CP config if disabled
+ * NetDb: Allow longer expiration for Meta LS2
+ * Transport:
+   - Don't repeatedly publish RI if IPv6-only but
+     not configured IPv6-only
+   - Don't set status to disconnected if IPv6-only but
+     not configured IPv6-only
+
+2018-12-05 zzz
+ * I2CP:
+   - Propagate error from disconnect message to session listener
+   - Set offline keys in generated LS2
+   - Set and validate offline sig in SessionConfig
+
 2018-12-04 zzz
  * Data: Add preliminary PrivateKeyFile support for LS2 offline keys (proposal #123)

router/java/src/net/i2p/router/RouterVersion.java

@@ -19 +19 @@
     public final static String ID = "Monotone";
     public final static String VERSION = CoreVersion.VERSION;
-    public final static long BUILD = 8;
+    public final static long BUILD = 9;
 
     /** for example "-test" */