warbler 2.1.0 → 2.1.1

data/ext/JarMain.java

@@ -5,10 +5,12 @@
  * See the file LICENSE.txt for details.
  */
 
+import java.io.Closeable;
 import java.io.File;
-import java.io.IOException;
 import java.io.FileOutputStream;
+import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.io.PrintStream;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -18,14 +20,18 @@ import java.net.URL;
 import java.net.URLClassLoader;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Deque;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.Callable;
+import java.util.concurrent.ConcurrentLinkedDeque;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
 
-public class JarMain implements Runnable {
+public class JarMain implements Closeable {
 
     static final String MAIN = '/' + JarMain.class.getName().replace('.', '/') + ".class";
 
@@ -34,66 +40,61 @@ public class JarMain implements Runnable {
     private final String path;
 
     protected File extractRoot;
-
-    protected URLClassLoader classLoader;
+    final Deque<Closeable> closeables = new ConcurrentLinkedDeque<>();
 
     JarMain(String[] args) {
         this.args = args;
-        URL mainClass = getClass().getResource(MAIN);
+        URL mainClass = Objects.requireNonNull(getClass().getResource(MAIN), MAIN + " not found!");
         URI uri;
-        File file;
         String pathWithoutMain;
 
         try {
             this.path = mainClass.toURI().getSchemeSpecificPart();
             pathWithoutMain = mainClass.toURI().getRawSchemeSpecificPart().replace("!" + MAIN, "");
             uri = new URI(pathWithoutMain);
-        }
-        catch (URISyntaxException e) {
+        } catch (URISyntaxException e) {
             throw new RuntimeException(e);
         }
 
         archive = new File(uri.getPath()).getAbsolutePath();
 
-        Runtime.getRuntime().addShutdownHook(new Thread(this));
+        Runtime.getRuntime().addShutdownHook(new Thread(this::close, "Warbler-Shutdown"));
     }
 
     protected URL[] extractArchive() throws Exception {
-        final JarFile jarFile = new JarFile(archive);
-        try {
-            Map<String, JarEntry> jarNames = new HashMap<String, JarEntry>();
+        try (JarFile jarFile = new JarFile(archive)) {
+            Map<String, JarEntry> jarNames = new HashMap<>();
             for (Enumeration<JarEntry> e = jarFile.entries(); e.hasMoreElements(); ) {
                 JarEntry entry = e.nextElement();
                 String extractPath = getExtractEntryPath(entry);
-                if ( extractPath != null ) jarNames.put(extractPath, entry);
+                if (extractPath != null) jarNames.put(extractPath, entry);
             }
 
             extractRoot = File.createTempFile("jruby", "extract");
-            extractRoot.delete(); extractRoot.mkdirs();
+            extractRoot.delete();
+            extractRoot.mkdirs();
+            closeables.add(() -> deleteAll(extractRoot));
 
-            final List<URL> urls = new ArrayList<URL>(jarNames.size());
+            final List<URL> urls = new ArrayList<>(jarNames.size());
             for (Map.Entry<String, JarEntry> e : jarNames.entrySet()) {
                 URL entryURL = extractEntry(e.getValue(), e.getKey());
-                if (entryURL != null) urls.add( entryURL );
+                if (entryURL != null) urls.add(entryURL);
             }
-            return urls.toArray(new URL[urls.size()]);
-        }
-        finally {
-            jarFile.close();
+            return urls.toArray(new URL[0]);
         }
     }
 
     protected String getExtractEntryPath(final JarEntry entry) {
         final String name = entry.getName();
-        if ( name.startsWith("META-INF/lib") && name.endsWith(".jar") ) {
+        if (name.startsWith("META-INF/lib") && name.endsWith(".jar")) {
             return name.substring(name.lastIndexOf('/') + 1);
         }
         return null; // do not extract entry
     }
 
-    protected URL extractEntry(final JarEntry entry, final String path) throws Exception {
-        final File file = new File(extractRoot, path);
-        if ( entry.isDirectory() ) {
+    protected URL extractEntry(final JarEntry entry, String path) throws Exception {
+        File file = new File(extractRoot, path);
+        if (entry.isDirectory()) {
             file.mkdirs();
             return null;
         }
@@ -101,44 +102,34 @@ public class JarMain implements Runnable {
         final InputStream entryStream;
         try {
             entryStream = new URI("jar", entryPath, null).toURL().openStream();
-        }
-        catch (IllegalArgumentException e) {
+        } catch (IllegalArgumentException e) {
             // TODO gems '%' file name "encoding" ?!
             debug("failed to open jar:" + entryPath + " skipping entry: " + entry.getName(), e);
             return null;
         }
         final File parent = file.getParentFile();
-        if ( parent != null ) parent.mkdirs();
-        FileOutputStream outStream = new FileOutputStream(file);
-        final byte[] buf = new byte[65536];
-        try {
-            int bytesRead;
-            while ((bytesRead = entryStream.read(buf)) != -1) {
-                outStream.write(buf, 0, bytesRead);
-            }
-        }
-        finally {
-            entryStream.close();
-            outStream.close();
-            file.deleteOnExit();
-        }
+        if (parent != null) parent.mkdirs();
+
+        transferAndClose(() -> entryStream, () -> new FileOutputStream(file));
+        file.deleteOnExit();
         // if (false) debug(entry.getName() + " extracted to " + file.getPath());
         return file.toURI().toURL();
     }
 
     protected String entryPath(String name) {
-        if ( ! name.startsWith("/") ) name = "/" + name;
+        if (!name.startsWith("/")) name = "/" + name;
         return path.replace(MAIN, name);
     }
 
     protected Object newScriptingContainer(final URL[] jars) throws Exception {
         setSystemProperty("org.jruby.embed.class.path", "");
-        classLoader = new URLClassLoader(jars);
-        Class scriptingContainerClass = Class.forName("org.jruby.embed.ScriptingContainer", true, classLoader);
+        URLClassLoader scriptingClassLoader = new URLClassLoader(jars);
+        closeables.add(scriptingClassLoader);
+        Class<?> scriptingContainerClass = Class.forName("org.jruby.embed.ScriptingContainer", true, scriptingClassLoader);
         Object scriptingContainer = scriptingContainerClass.newInstance();
         debug("scripting container class loader urls: " + Arrays.toString(jars));
         invokeMethod(scriptingContainer, "setArgv", (Object) args);
-        invokeMethod(scriptingContainer, "setClassLoader", new Class[] { ClassLoader.class }, classLoader);
+        invokeMethod(scriptingContainer, "setClassLoader", new Class[]{ClassLoader.class}, scriptingClassLoader);
         return scriptingContainer;
     }
 
@@ -146,18 +137,18 @@ public class JarMain implements Runnable {
         final Object scriptingContainer = newScriptingContainer(jars);
         debug("invoking " + archive + " with: " + Arrays.deepToString(args));
         Object outcome = invokeMethod(scriptingContainer, "runScriptlet", launchScript());
-        return ( outcome instanceof Number ) ? ( (Number) outcome ).intValue() : 0;
+        return (outcome instanceof Number) ? ((Number) outcome).intValue() : 0;
     }
 
     protected String launchScript() {
         return
-        "begin\n" +
-        "  require 'META-INF/init.rb'\n" +
-        "  require 'META-INF/main.rb'\n" +
-        "  0\n" +
-        "rescue SystemExit => e\n" +
-        "  e.status\n" +
-        "end";
+            "begin\n" +
+                "  require 'META-INF/init.rb'\n" +
+                "  require 'META-INF/main.rb'\n" +
+                "  0\n" +
+                "rescue SystemExit => e\n" +
+                "  e.status\n" +
+                "end";
     }
 
     protected int start() throws Exception {
@@ -170,8 +161,8 @@ public class JarMain implements Runnable {
     }
 
     protected void debug(String msg, Throwable t) {
-        if ( isDebug() ) System.out.println(msg);
-        if ( isDebug() && t != null ) t.printStackTrace(System.out);
+        if (isDebug()) System.out.println(msg);
+        if (isDebug() && t != null) t.printStackTrace(System.out);
     }
 
     protected static void debug(Throwable t) {
@@ -179,7 +170,7 @@ public class JarMain implements Runnable {
     }
 
     private static void debug(Throwable t, PrintStream out) {
-        if ( isDebug() ) t.printStackTrace(out);
+        if (isDebug()) t.printStackTrace(out);
     }
 
     protected void warn(String msg) {
@@ -195,39 +186,42 @@ public class JarMain implements Runnable {
         debug(t, System.err);
     }
 
-    protected void delete(File f) {
+    protected void deleteAll(File f) {
         try {
-          if (f.isDirectory() && !isSymlink(f)) {
-              File[] children = f.listFiles();
-              for (int i = 0; i < children.length; i++) {
-                  delete(children[i]);
-              }
-          }
-          f.delete();
+            if (f.isDirectory() && !isSymlink(f)) {
+                File[] children = f.listFiles();
+                if (children != null) {
+                    for (File child : children) {
+                        deleteAll(child);
+                    }
+                }
+            }
+            f.delete();
+        } catch (IOException e) {
+            error(e);
         }
-        catch (IOException e) { error(e); }
     }
 
     protected boolean isSymlink(File file) throws IOException {
         if (file == null) throw new NullPointerException("File must not be null");
         final File canonical;
-        if ( file.getParent() == null ) canonical = file;
+        if (file.getParent() == null) canonical = file;
         else {
             File parentDir = file.getParentFile().getCanonicalFile();
             canonical = new File(parentDir, file.getName());
         }
-        return ! canonical.getCanonicalFile().equals( canonical.getAbsoluteFile() );
+        return !canonical.getCanonicalFile().equals(canonical.getAbsoluteFile());
     }
 
-    public void run() {
-        // If the URLClassLoader isn't closed, on Windows, temp JARs won't be cleaned up
-        try {
-            invokeMethod(classLoader, "close");
-        }
-        catch (NoSuchMethodException e) { } // We're not being run on Java >= 7
-        catch (Exception e) { error(e); }
-
-        if ( extractRoot != null ) delete(extractRoot);
+    @Override
+    public void close() {
+        closeables.descendingIterator().forEachRemaining(closeableResource -> {
+            try {
+                closeableResource.close();
+            } catch (Exception e) {
+                error("Error during shutdown", e);
+            }
+        });
     }
 
     public static void main(String[] args) {
@@ -238,38 +232,35 @@ public class JarMain implements Runnable {
         int exit;
         try {
             exit = main.start();
-        }
-        catch (Exception e) {
+        } catch (Exception e) {
             Throwable t = e;
-            while ( t.getCause() != null && t.getCause() != t ) {
+            while (t.getCause() != null && t.getCause() != t) {
                 t = t.getCause();
             }
             error(e.toString(), t);
             exit = 1;
         }
         try {
-            if ( isSystemExitEnabled() ) System.exit(exit);
-        }
-        catch (SecurityException e) {
+            if (isSystemExitEnabled()) System.exit(exit);
+        } catch (SecurityException e) {
             debug(e);
         }
     }
 
     protected static Object invokeMethod(final Object self, final String name, final Object... args)
-        throws NoSuchMethodException, IllegalAccessException, Exception {
+        throws Exception {
 
-        final Class[] signature = new Class[args.length];
-        for ( int i = 0; i < args.length; i++ ) signature[i] = args[i].getClass();
+        final Class<?>[] signature = new Class[args.length];
+        for (int i = 0; i < args.length; i++) signature[i] = args[i].getClass();
         return invokeMethod(self, name, signature, args);
     }
 
-    protected static Object invokeMethod(final Object self, final String name, final Class[] signature, final Object... args)
-        throws NoSuchMethodException, IllegalAccessException, Exception {
+    protected static Object invokeMethod(final Object self, final String name, final Class<?>[] signature, final Object... args)
+        throws Exception {
         Method method = self.getClass().getDeclaredMethod(name, signature);
         try {
             return method.invoke(self, args);
-        }
-        catch (InvocationTargetException e) {
+        } catch (InvocationTargetException e) {
             Throwable target = e.getTargetException();
             if (target instanceof Exception) {
                 throw (Exception) target;
@@ -279,18 +270,21 @@ public class JarMain implements Runnable {
     }
 
     private static final boolean debug;
+
     static {
-        debug = Boolean.parseBoolean( getSystemProperty("warbler.debug", "false") );
+        debug = Boolean.parseBoolean(getSystemProperty("warbler.debug", "false"));
     }
 
-    static boolean isDebug() { return debug; }
+    static boolean isDebug() {
+        return debug;
+    }
 
     /**
      * if warbler.skip_system_exit system property is defined, we will not
      * call System.exit in the normal flow. System.exit can cause problems
      * for wrappers like procrun
      */
-    private static boolean isSystemExitEnabled(){
+    private static boolean isSystemExitEnabled() {
         return getSystemProperty("warbler.skip_system_exit") == null; //omission enables System.exit use
     }
 
@@ -301,8 +295,7 @@ public class JarMain implements Runnable {
     static String getSystemProperty(final String name, final String defaultValue) {
         try {
             return System.getProperty(name, defaultValue);
-        }
-        catch (SecurityException e) {
+        } catch (SecurityException e) {
             return defaultValue;
         }
     }
@@ -311,8 +304,7 @@ public class JarMain implements Runnable {
         try {
             System.setProperty(name, value);
             return true;
-        }
-        catch (SecurityException e) {
+        } catch (SecurityException e) {
             return false;
         }
     }
@@ -323,14 +315,23 @@ public class JarMain implements Runnable {
 
     static String getENV(final String name, final String defaultValue) {
         try {
-            if ( System.getenv().containsKey(name) ) {
+            if (System.getenv().containsKey(name)) {
                 return System.getenv().get(name);
             }
             return defaultValue;
-        }
-        catch (SecurityException e) {
+        } catch (SecurityException e) {
             return defaultValue;
         }
     }
 
+    // Can be replaced with InputStream.transferTo(OutputStream) in Java 11+
+    static void transferAndClose(Callable<InputStream> is, Callable<OutputStream> os) throws Exception {
+        try (InputStream input = is.call(); OutputStream output = os.call()) {
+            byte[] buf = new byte[16384];
+            int bytesRead;
+            while ((bytesRead = input.read(buf)) != -1) {
+                output.write(buf, 0, bytesRead);
+            }
+        }
+    }
 }

data/ext/WarMain.java

@@ -5,38 +5,39 @@
  * See the file LICENSE.txt for details.
  */
 
-import java.lang.reflect.Method;
-import java.io.InputStream;
 import java.io.ByteArrayInputStream;
-import java.io.SequenceInputStream;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.SequenceInputStream;
+import java.lang.reflect.Method;
 import java.net.URI;
-import java.net.URLClassLoader;
 import java.net.URL;
+import java.net.URLClassLoader;
 import java.util.Arrays;
 import java.util.List;
-import java.util.Properties;
 import java.util.Map;
+import java.util.Properties;
 import java.util.jar.JarEntry;
 
 /**
  * Used as a Main-Class in the manifest for a .war file, so that you can run
  * a .war file with <tt>java -jar</tt>.
- *
+ * <p/>
  * WarMain can be used with different web server libraries. WarMain expects
  * to have two files present in the .war file,
  * <tt>WEB-INF/webserver.properties</tt> and <tt>WEB-INF/webserver.jar</tt>.
- *
+ * <p/>
  * When WarMain starts up, it extracts the webserver jar to a temporary
  * directory, and creates a temporary work directory for the webapp. Both
  * are deleted on exit.
- *
+ * <p/>
  * It then reads webserver.properties into a java.util.Properties object,
  * creates a URL classloader holding the jar, and loads and invokes the
  * <tt>main</tt> method of the main class mentioned in the properties.
- *
+ * <p/>
  * An example webserver.properties follows for Jetty. The <tt>args</tt>
  * property indicates the names and ordering of other properties to be used
  * as command-line arguments. The special tokens <tt>{{warfile}}</tt> and
@@ -63,7 +64,6 @@ import java.util.jar.JarEntry;
  */
 public class WarMain extends JarMain {
 
-    static final String MAIN = '/' + WarMain.class.getName().replace('.', '/') + ".class";
     static final String WEBSERVER_PROPERTIES = "/WEB-INF/webserver.properties";
     static final String WEBSERVER_JAR = "/WEB-INF/webserver.jar";
     static final String WEBSERVER_CONFIG = "/WEB-INF/webserver.xml";
@@ -85,8 +85,6 @@ public class WarMain extends JarMain {
     private final String executable;
     private final String[] executableArgv;
 
-    private File webroot;
-
     WarMain(final String[] args) {
         super(args);
         final List<String> argsList = Arrays.asList(args);
@@ -115,36 +113,40 @@ public class WarMain extends JarMain {
         }
     }
 
-    private URL extractWebserver() throws Exception {
-        this.webroot = File.createTempFile("warbler", "webroot");
-        this.webroot.delete();
-        this.webroot.mkdirs();
-        this.webroot = new File(this.webroot, new File(archive).getName());
-        debug("webroot directory is " + this.webroot.getPath());
-        InputStream jarStream = new URI("jar", entryPath(WEBSERVER_JAR), null).toURL().openStream();
+    private void launchWebServer() throws Exception {
+        File webroot = createWebRoot();
+        File jarFile = extractWebServerJar();
+
+        doLaunchWebServer(jarFile, webroot);
+    }
+
+    private File createWebRoot() throws IOException {
+        File warblerRoot = File.createTempFile("warbler", "webroot");
+        warblerRoot.delete();
+        warblerRoot.mkdirs();
+        closeables.add(() -> deleteAll(warblerRoot));
+
+        File webroot = new File(warblerRoot, new File(archive).getName());
+        debug("webroot directory is " + webroot.getPath());
+        return webroot;
+    }
+
+    private File extractWebServerJar() throws Exception {
         File jarFile = File.createTempFile("webserver", ".jar");
         jarFile.deleteOnExit();
-        FileOutputStream outStream = new FileOutputStream(jarFile);
-        try {
-            byte[] buf = new byte[4096];
-            int bytesRead;
-            while ((bytesRead = jarStream.read(buf)) != -1) {
-                outStream.write(buf, 0, bytesRead);
-            }
-        } finally {
-            jarStream.close();
-            outStream.close();
-        }
+
+        transferAndClose(
+            () -> new URI("jar", entryPath(WEBSERVER_JAR), null).toURL().openStream(),
+            () -> new FileOutputStream(jarFile));
         debug("webserver.jar extracted to " + jarFile.getPath());
-        return jarFile.toURI().toURL();
+        return jarFile;
     }
 
-    private Properties getWebserverProperties() throws Exception {
+    private Properties getWebserverProperties(File webRoot) throws Exception {
         Properties props = new Properties();
-        try {
-            InputStream is = getClass().getResourceAsStream(WEBSERVER_PROPERTIES);
+        try (InputStream is = getClass().getResourceAsStream(WEBSERVER_PROPERTIES)) {
             if ( is != null ) props.load(is);
-        } catch (Exception e) { }
+        } catch (Exception ignore) { }
 
         String port = getSystemProperty("warbler.port", getENV("PORT"));
         port = port == null ? "8080" : port;
@@ -152,13 +154,13 @@ public class WarMain extends JarMain {
         String webserverConfig = getSystemProperty("warbler.webserver_config", getENV("WARBLER_WEBSERVER_CONFIG"));
         String embeddedWebserverConfig = new URI("jar", entryPath(WEBSERVER_CONFIG), null).toURL().toString();
         webserverConfig = webserverConfig == null ? embeddedWebserverConfig : webserverConfig;
-        for ( Map.Entry entry : props.entrySet() ) {
+        for ( Map.Entry<Object, Object> entry : props.entrySet() ) {
             String val = (String) entry.getValue();
             val = val.replace("{{warfile}}", archive).
                       replace("{{port}}", port).
                       replace("{{host}}", host).
                       replace("{{config}}", webserverConfig).
-                      replace("{{webroot}}", webroot.getAbsolutePath());
+                      replace("{{webroot}}", webRoot.getAbsolutePath());
             entry.setValue(val);
         }
 
@@ -172,10 +174,11 @@ public class WarMain extends JarMain {
         return props;
     }
 
-    private void launchWebServer(URL jar) throws Exception {
-        URLClassLoader loader = new URLClassLoader(new URL[] {jar});
+
+    private void doLaunchWebServer(File jar, File webRoot) throws Exception {
+        URLClassLoader loader = new URLClassLoader(new URL[] {jar.toURI().toURL()});
         Thread.currentThread().setContextClassLoader(loader);
-        Properties props = getWebserverProperties();
+        Properties props = getWebserverProperties(webRoot);
         String mainClass = props.getProperty("mainclass");
         if (mainClass == null) {
             throw new IllegalArgumentException("unknown webserver main class ("
@@ -183,7 +186,7 @@ public class WarMain extends JarMain {
                                                + " is missing 'mainclass' property)");
         }
         Class<?> klass = Class.forName(mainClass, true, loader);
-        Method main = klass.getDeclaredMethod("main", new Class[] { String[].class });
+        Method main = klass.getDeclaredMethod("main", String[].class);
         String[] newArgs = launchWebServerArguments(props);
         debug("invoking webserver with: " + Arrays.deepToString(newArgs));
         main.invoke(null, new Object[] { newArgs });
@@ -227,7 +230,7 @@ public class WarMain extends JarMain {
     }
 
     @Override
-    protected URL extractEntry(final JarEntry entry, final String path) throws Exception {
+    protected URL extractEntry(final JarEntry entry, String path) throws Exception {
         // always extract but only return class-path entry URLs :
         final URL entryURL = super.extractEntry(entry, path);
         return path.endsWith(".jar") && path.startsWith("/lib/") ? entryURL : null;
@@ -256,7 +259,7 @@ public class WarMain extends JarMain {
 
         invokeMethod(rubyInstanceConfig, "processArguments", (Object) arguments);
 
-        Object runtime = invokeMethod(scriptingContainer, "getRuntime");
+        Object runtime = invokeMethod(provider, "getRuntime");
 
         debug("loading resource: " + executablePath);
         Object executableInput =
@@ -272,21 +275,6 @@ public class WarMain extends JarMain {
         return ( outcome instanceof Number ) ? ( (Number) outcome ).intValue() : 0;
     }
 
-    @Deprecated
-    protected String locateExecutable(final Object scriptingContainer) throws Exception {
-        if ( executable == null ) {
-            throw new IllegalStateException("no executable");
-        }
-        final File exec = new File(extractRoot, executable);
-        if ( exec.exists() ) {
-            return exec.getAbsolutePath();
-        }
-        else {
-            final String script = locateExecutableScript(executable, executableScriptEnvPrefix());
-            return (String) invokeMethod(scriptingContainer, "runScriptlet", script);
-        }
-    }
-
     protected String locateExecutable(final Object scriptingContainer, final CharSequence envPreScript)
         throws Exception {
         if ( executable == null ) {
@@ -346,8 +334,7 @@ public class WarMain extends JarMain {
     protected int start() throws Exception {
         if ( executable == null ) {
             try {
-                URL server = extractWebserver();
-                launchWebServer(server);
+                launchWebServer();
             }
             catch (FileNotFoundException e) {
                 final String msg = e.getMessage();
@@ -362,12 +349,6 @@ public class WarMain extends JarMain {
         return super.start();
     }
 
-    @Override
-    public void run() {
-        super.run();
-        if ( webroot != null ) delete(webroot.getParentFile());
-    }
-
     public static void main(String[] args) {
         doStart(new WarMain(args));
     }

data/lib/warbler/bundler_helper.rb

@@ -7,14 +7,7 @@
 module Warbler
   module BundlerHelper
     def to_spec(spec)
-      # JRuby <= 1.7.20 does not handle respond_to? with method_missing right
-      # thus a `spec.respond_to?(:to_spec) ? spec.to_spec : spec` won't do :
-      if ::Bundler.const_defined?(:StubSpecification) # since Bundler 1.10.1
-        spec = spec.to_spec if spec.is_a?(::Bundler::StubSpecification)
-      else
-        spec = spec.to_spec if spec.respond_to?(:to_spec)
-      end
-      spec
+      spec.respond_to?(:to_spec) ? spec.to_spec : spec
     end
     module_function :to_spec
   end