rt/launcher/src/main/java/org/apidesign/bck2brwsr/launcher/Bck2BrwsrLauncher.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Fri, 22 Mar 2013 17:03:32 +0100
branchmodel
changeset 878 ecbd252fd3a7
parent 762 launcher/src/main/java/org/apidesign/bck2brwsr/launcher/Bck2BrwsrLauncher.java@a758763f8415
parent 800 launcher/src/main/java/org/apidesign/bck2brwsr/launcher/Bck2BrwsrLauncher.java@3661b82478e0
child 924 a85e27899a80
permissions -rw-r--r--
Need to merge in default branch: It contains automatic conversion of boxed types to primitive values which is needed by Knockout to display elements of arrays properly.
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 2 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. Look for COPYING file in the top folder.
    16  * If not, see http://opensource.org/licenses/GPL-2.0.
    17  */
    18 package org.apidesign.bck2brwsr.launcher;
    19 
    20 import java.io.Closeable;
    21 import java.io.File;
    22 import java.io.IOException;
    23 import java.io.InputStream;
    24 import java.io.InterruptedIOException;
    25 import java.io.OutputStream;
    26 import java.io.UnsupportedEncodingException;
    27 import java.io.Writer;
    28 import java.net.URI;
    29 import java.net.URISyntaxException;
    30 import java.net.URL;
    31 import java.util.ArrayList;
    32 import java.util.Arrays;
    33 import java.util.Enumeration;
    34 import java.util.LinkedHashSet;
    35 import java.util.List;
    36 import java.util.Set;
    37 import java.util.concurrent.BlockingQueue;
    38 import java.util.concurrent.CountDownLatch;
    39 import java.util.concurrent.LinkedBlockingQueue;
    40 import java.util.concurrent.TimeUnit;
    41 import java.util.logging.Level;
    42 import java.util.logging.Logger;
    43 import org.apidesign.bck2brwsr.launcher.InvocationContext.Resource;
    44 import org.apidesign.vm4brwsr.Bck2Brwsr;
    45 import org.glassfish.grizzly.PortRange;
    46 import org.glassfish.grizzly.http.server.HttpHandler;
    47 import org.glassfish.grizzly.http.server.HttpServer;
    48 import org.glassfish.grizzly.http.server.NetworkListener;
    49 import org.glassfish.grizzly.http.server.Request;
    50 import org.glassfish.grizzly.http.server.Response;
    51 import org.glassfish.grizzly.http.server.ServerConfiguration;
    52 import org.glassfish.grizzly.http.util.HttpStatus;
    53 
    54 /**
    55  * Lightweight server to launch Bck2Brwsr applications and tests.
    56  * Supports execution in native browser as well as Java's internal 
    57  * execution engine.
    58  */
    59 final class Bck2BrwsrLauncher extends Launcher implements Closeable {
    60     private static final Logger LOG = Logger.getLogger(Bck2BrwsrLauncher.class.getName());
    61     private static final InvocationContext END = new InvocationContext(null, null, null);
    62     private final Set<ClassLoader> loaders = new LinkedHashSet<>();
    63     private final BlockingQueue<InvocationContext> methods = new LinkedBlockingQueue<>();
    64     private long timeOut;
    65     private final Res resources = new Res();
    66     private final String cmd;
    67     private Object[] brwsr;
    68     private HttpServer server;
    69     private CountDownLatch wait;
    70     
    71     public Bck2BrwsrLauncher(String cmd) {
    72         this.cmd = cmd;
    73     }
    74     
    75     @Override
    76     InvocationContext runMethod(InvocationContext c) throws IOException {
    77         loaders.add(c.clazz.getClassLoader());
    78         methods.add(c);
    79         try {
    80             c.await(timeOut);
    81         } catch (InterruptedException ex) {
    82             throw new IOException(ex);
    83         }
    84         return c;
    85     }
    86     
    87     public void setTimeout(long ms) {
    88         timeOut = ms;
    89     }
    90     
    91     public void addClassLoader(ClassLoader url) {
    92         this.loaders.add(url);
    93     }
    94 
    95     public void showURL(String startpage) throws IOException {
    96         if (!startpage.startsWith("/")) {
    97             startpage = "/" + startpage;
    98         }
    99         HttpServer s = initServer(".", true);
   100         int last = startpage.lastIndexOf('/');
   101         String simpleName = startpage.substring(last);
   102         s.getServerConfiguration().addHttpHandler(new Page(resources, startpage), simpleName);
   103         s.getServerConfiguration().addHttpHandler(new Page(resources, null), "/");
   104         try {
   105             launchServerAndBrwsr(s, simpleName);
   106         } catch (URISyntaxException | InterruptedException ex) {
   107             throw new IOException(ex);
   108         }
   109     }
   110 
   111     void showDirectory(File dir, String startpage) throws IOException {
   112         if (!startpage.startsWith("/")) {
   113             startpage = "/" + startpage;
   114         }
   115         HttpServer s = initServer(dir.getPath(), false);
   116         try {
   117             launchServerAndBrwsr(s, startpage);
   118         } catch (URISyntaxException | InterruptedException ex) {
   119             throw new IOException(ex);
   120         }
   121     }
   122 
   123     @Override
   124     public void initialize() throws IOException {
   125         try {
   126             executeInBrowser();
   127         } catch (InterruptedException ex) {
   128             final InterruptedIOException iio = new InterruptedIOException(ex.getMessage());
   129             iio.initCause(ex);
   130             throw iio;
   131         } catch (Exception ex) {
   132             if (ex instanceof IOException) {
   133                 throw (IOException)ex;
   134             }
   135             if (ex instanceof RuntimeException) {
   136                 throw (RuntimeException)ex;
   137             }
   138             throw new IOException(ex);
   139         }
   140     }
   141     
   142     private HttpServer initServer(String path, boolean addClasses) throws IOException {
   143         HttpServer s = HttpServer.createSimpleServer(path, new PortRange(8080, 65535));
   144 
   145         final ServerConfiguration conf = s.getServerConfiguration();
   146         if (addClasses) {
   147             conf.addHttpHandler(new VM(resources), "/bck2brwsr.js");
   148             conf.addHttpHandler(new Classes(resources), "/classes/");
   149         }
   150         return s;
   151     }
   152     
   153     private void executeInBrowser() throws InterruptedException, URISyntaxException, IOException {
   154         wait = new CountDownLatch(1);
   155         server = initServer(".", true);
   156         final ServerConfiguration conf = server.getServerConfiguration();
   157         
   158         class DynamicResourceHandler extends HttpHandler {
   159             private final InvocationContext ic;
   160             public DynamicResourceHandler(InvocationContext ic) {
   161                 if (ic == null || ic.resources.isEmpty()) {
   162                     throw new NullPointerException();
   163                 }
   164                 this.ic = ic;
   165                 for (Resource r : ic.resources) {
   166                     conf.addHttpHandler(this, r.httpPath);
   167                 }
   168             }
   169 
   170             public void close() {
   171                 conf.removeHttpHandler(this);
   172             }
   173             
   174             @Override
   175             public void service(Request request, Response response) throws Exception {
   176                 for (Resource r : ic.resources) {
   177                     if (r.httpPath.equals(request.getRequestURI())) {
   178                         LOG.log(Level.INFO, "Serving HttpResource for {0}", request.getRequestURI());
   179                         response.setContentType(r.httpType);
   180                         copyStream(r.httpContent, response.getOutputStream(), null);
   181                     }
   182                 }
   183             }
   184         }
   185         
   186         conf.addHttpHandler(new Page(resources, 
   187             "org/apidesign/bck2brwsr/launcher/harness.xhtml"
   188         ), "/execute");
   189         
   190         conf.addHttpHandler(new HttpHandler() {
   191             int cnt;
   192             List<InvocationContext> cases = new ArrayList<>();
   193             DynamicResourceHandler prev;
   194             @Override
   195             public void service(Request request, Response response) throws Exception {
   196                 String id = request.getParameter("request");
   197                 String value = request.getParameter("result");
   198                 if (value != null && value.indexOf((char)0xC5) != -1) {
   199                     value = toUTF8(value);
   200                 }
   201                 
   202                 
   203                 InvocationContext mi = null;
   204                 int caseNmbr = -1;
   205                 
   206                 if (id != null && value != null) {
   207                     LOG.log(Level.INFO, "Received result for case {0} = {1}", new Object[]{id, value});
   208                     value = decodeURL(value);
   209                     int indx = Integer.parseInt(id);
   210                     cases.get(indx).result(value, null);
   211                     if (++indx < cases.size()) {
   212                         mi = cases.get(indx);
   213                         LOG.log(Level.INFO, "Re-executing case {0}", indx);
   214                         caseNmbr = indx;
   215                     }
   216                 } else {
   217                     if (!cases.isEmpty()) {
   218                         LOG.info("Re-executing test cases");
   219                         mi = cases.get(0);
   220                         caseNmbr = 0;
   221                     }
   222                 }
   223                 
   224                 if (prev != null) {
   225                     prev.close();
   226                     prev = null;
   227                 }
   228                 
   229                 if (mi == null) {
   230                     mi = methods.take();
   231                     caseNmbr = cnt++;
   232                 }
   233                 if (mi == END) {
   234                     response.getWriter().write("");
   235                     wait.countDown();
   236                     cnt = 0;
   237                     LOG.log(Level.INFO, "End of data reached. Exiting.");
   238                     return;
   239                 }
   240                 
   241                 if (!mi.resources.isEmpty()) {
   242                     prev = new DynamicResourceHandler(mi);
   243                 }
   244                 
   245                 cases.add(mi);
   246                 final String cn = mi.clazz.getName();
   247                 final String mn = mi.methodName;
   248                 LOG.log(Level.INFO, "Request for {0} case. Sending {1}.{2}", new Object[]{caseNmbr, cn, mn});
   249                 response.getWriter().write("{"
   250                     + "className: '" + cn + "', "
   251                     + "methodName: '" + mn + "', "
   252                     + "request: " + caseNmbr
   253                 );
   254                 if (mi.html != null) {
   255                     response.getWriter().write(", html: '");
   256                     response.getWriter().write(encodeJSON(mi.html));
   257                     response.getWriter().write("'");
   258                 }
   259                 response.getWriter().write("}");
   260             }
   261         }, "/data");
   262 
   263         this.brwsr = launchServerAndBrwsr(server, "/execute");
   264     }
   265     
   266     private static String encodeJSON(String in) {
   267         StringBuilder sb = new StringBuilder();
   268         for (int i = 0; i < in.length(); i++) {
   269             char ch = in.charAt(i);
   270             if (ch < 32 || ch == '\'' || ch == '"') {
   271                 sb.append("\\u");
   272                 String hs = "0000" + Integer.toHexString(ch);
   273                 hs = hs.substring(hs.length() - 4);
   274                 sb.append(hs);
   275             } else {
   276                 sb.append(ch);
   277             }
   278         }
   279         return sb.toString();
   280     }
   281     
   282     @Override
   283     public void shutdown() throws IOException {
   284         methods.offer(END);
   285         for (;;) {
   286             int prev = methods.size();
   287             try {
   288                 if (wait != null && wait.await(timeOut, TimeUnit.MILLISECONDS)) {
   289                     break;
   290                 }
   291             } catch (InterruptedException ex) {
   292                 throw new IOException(ex);
   293             }
   294             if (prev == methods.size()) {
   295                 LOG.log(
   296                     Level.WARNING, 
   297                     "Timeout and no test has been executed meanwhile (at {0}). Giving up.", 
   298                     methods.size()
   299                 );
   300                 break;
   301             }
   302             LOG.log(Level.INFO, 
   303                 "Timeout, but tests got from {0} to {1}. Trying again.", 
   304                 new Object[]{prev, methods.size()}
   305             );
   306         }
   307         stopServerAndBrwsr(server, brwsr);
   308     }
   309     
   310     static void copyStream(InputStream is, OutputStream os, String baseURL, String... params) throws IOException {
   311         for (;;) {
   312             int ch = is.read();
   313             if (ch == -1) {
   314                 break;
   315             }
   316             if (ch == '$' && params.length > 0) {
   317                 int cnt = is.read() - '0';
   318                 if (cnt == 'U' - '0') {
   319                     os.write(baseURL.getBytes("UTF-8"));
   320                 } else {
   321                     if (cnt >= 0 && cnt < params.length) {
   322                         os.write(params[cnt].getBytes("UTF-8"));
   323                     } else {
   324                         os.write('$');
   325                         os.write(cnt + '0');
   326                     }
   327                 }
   328             } else {
   329                 os.write(ch);
   330             }
   331         }
   332     }
   333 
   334     private Object[] launchServerAndBrwsr(HttpServer server, final String page) throws IOException, URISyntaxException, InterruptedException {
   335         server.start();
   336         NetworkListener listener = server.getListeners().iterator().next();
   337         int port = listener.getPort();
   338         
   339         URI uri = new URI("http://localhost:" + port + page);
   340         LOG.log(Level.INFO, "Showing {0}", uri);
   341         if (cmd == null) {
   342             try {
   343                 LOG.log(Level.INFO, "Trying Desktop.browse on {0} {2} by {1}", new Object[] {
   344                     System.getProperty("java.vm.name"),
   345                     System.getProperty("java.vm.vendor"),
   346                     System.getProperty("java.vm.version"),
   347                 });
   348                 java.awt.Desktop.getDesktop().browse(uri);
   349                 LOG.log(Level.INFO, "Desktop.browse successfully finished");
   350                 return null;
   351             } catch (UnsupportedOperationException ex) {
   352                 LOG.log(Level.INFO, "Desktop.browse not supported: {0}", ex.getMessage());
   353                 LOG.log(Level.FINE, null, ex);
   354             }
   355         }
   356         {
   357             String cmdName = cmd == null ? "xdg-open" : cmd;
   358             String[] cmdArr = { 
   359                 cmdName, uri.toString()
   360             };
   361             LOG.log(Level.INFO, "Launching {0}", Arrays.toString(cmdArr));
   362             final Process process = Runtime.getRuntime().exec(cmdArr);
   363             return new Object[] { process, null };
   364         }
   365     }
   366     private static String toUTF8(String value) throws UnsupportedEncodingException {
   367         byte[] arr = new byte[value.length()];
   368         for (int i = 0; i < arr.length; i++) {
   369             arr[i] = (byte)value.charAt(i);
   370         }
   371         return new String(arr, "UTF-8");
   372     }
   373     
   374     private static String decodeURL(String s) {
   375         for (;;) {
   376             int pos = s.indexOf('%');
   377             if (pos == -1) {
   378                 return s;
   379             }
   380             int i = Integer.parseInt(s.substring(pos + 1, pos + 2), 16);
   381             s = s.substring(0, pos) + (char)i + s.substring(pos + 2);
   382         }
   383     }
   384     
   385     private void stopServerAndBrwsr(HttpServer server, Object[] brwsr) throws IOException {
   386         if (brwsr == null) {
   387             return;
   388         }
   389         Process process = (Process)brwsr[0];
   390         
   391         server.stop();
   392         InputStream stdout = process.getInputStream();
   393         InputStream stderr = process.getErrorStream();
   394         drain("StdOut", stdout);
   395         drain("StdErr", stderr);
   396         process.destroy();
   397         int res;
   398         try {
   399             res = process.waitFor();
   400         } catch (InterruptedException ex) {
   401             throw new IOException(ex);
   402         }
   403         LOG.log(Level.INFO, "Exit code: {0}", res);
   404 
   405         deleteTree((File)brwsr[1]);
   406     }
   407     
   408     private static void drain(String name, InputStream is) throws IOException {
   409         int av = is.available();
   410         if (av > 0) {
   411             StringBuilder sb = new StringBuilder();
   412             sb.append("v== ").append(name).append(" ==v\n");
   413             while (av-- > 0) {
   414                 sb.append((char)is.read());
   415             }
   416             sb.append("\n^== ").append(name).append(" ==^");
   417             LOG.log(Level.INFO, sb.toString());
   418         }
   419     }
   420 
   421     private void deleteTree(File file) {
   422         if (file == null) {
   423             return;
   424         }
   425         File[] arr = file.listFiles();
   426         if (arr != null) {
   427             for (File s : arr) {
   428                 deleteTree(s);
   429             }
   430         }
   431         file.delete();
   432     }
   433 
   434     @Override
   435     public void close() throws IOException {
   436         shutdown();
   437     }
   438 
   439     private class Res implements Bck2Brwsr.Resources {
   440         @Override
   441         public InputStream get(String resource) throws IOException {
   442             for (ClassLoader l : loaders) {
   443                 URL u = null;
   444                 Enumeration<URL> en = l.getResources(resource);
   445                 while (en.hasMoreElements()) {
   446                     u = en.nextElement();
   447                 }
   448                 if (u != null) {
   449                     return u.openStream();
   450                 }
   451             }
   452             throw new IOException("Can't find " + resource);
   453         }
   454     }
   455 
   456     private static class Page extends HttpHandler {
   457         private final String resource;
   458         private final String[] args;
   459         private final Res res;
   460         
   461         public Page(Res res, String resource, String... args) {
   462             this.res = res;
   463             this.resource = resource;
   464             this.args = args.length == 0 ? new String[] { "$0" } : args;
   465         }
   466 
   467         @Override
   468         public void service(Request request, Response response) throws Exception {
   469             String r = resource;
   470             if (r == null) {
   471                 r = request.getHttpHandlerPath();
   472             }
   473             if (r.startsWith("/")) {
   474                 r = r.substring(1);
   475             }
   476             String[] replace = {};
   477             if (r.endsWith(".html")) {
   478                 response.setContentType("text/html");
   479                 LOG.info("Content type text/html");
   480                 replace = args;
   481             }
   482             if (r.endsWith(".xhtml")) {
   483                 response.setContentType("application/xhtml+xml");
   484                 LOG.info("Content type application/xhtml+xml");
   485                 replace = args;
   486             }
   487             OutputStream os = response.getOutputStream();
   488             try (InputStream is = res.get(r)) {
   489                 copyStream(is, os, request.getRequestURL().toString(), replace);
   490             } catch (IOException ex) {
   491                 response.setDetailMessage(ex.getLocalizedMessage());
   492                 response.setError();
   493                 response.setStatus(404);
   494             }
   495         }
   496     }
   497 
   498     private static class VM extends HttpHandler {
   499         private final String bck2brwsr;
   500 
   501         public VM(Res loader) throws IOException {
   502             StringBuilder sb = new StringBuilder();
   503             Bck2Brwsr.generate(sb, loader);
   504             sb.append(
   505                   "(function WrapperVM(global) {"
   506                 + "  function ldCls(res) {\n"
   507                 + "    var request = new XMLHttpRequest();\n"
   508                 + "    request.open('GET', '/classes/' + res, false);\n"
   509                 + "    request.send();\n"
   510                 + "    if (request.status !== 200) return null;\n"
   511                 + "    var arr = eval('(' + request.responseText + ')');\n"
   512                 + "    return arr;\n"
   513                 + "  }\n"
   514                 + "  var prevvm = global.bck2brwsr;\n"
   515                 + "  global.bck2brwsr = function() {\n"
   516                 + "    var args = Array.prototype.slice.apply(arguments);\n"
   517                 + "    args.unshift(ldCls);\n"
   518                 + "    return prevvm.apply(null, args);\n"
   519                 + "  };\n"
   520                 + "})(this);\n"
   521             );
   522             this.bck2brwsr = sb.toString();
   523         }
   524 
   525         @Override
   526         public void service(Request request, Response response) throws Exception {
   527             response.setCharacterEncoding("UTF-8");
   528             response.setContentType("text/javascript");
   529             response.getWriter().write(bck2brwsr);
   530         }
   531     }
   532 
   533     private static class Classes extends HttpHandler {
   534         private final Res loader;
   535 
   536         public Classes(Res loader) {
   537             this.loader = loader;
   538         }
   539 
   540         @Override
   541         public void service(Request request, Response response) throws Exception {
   542             String res = request.getHttpHandlerPath();
   543             if (res.startsWith("/")) {
   544                 res = res.substring(1);
   545             }
   546             try (InputStream is = loader.get(res)) {
   547                 response.setContentType("text/javascript");
   548                 Writer w = response.getWriter();
   549                 w.append("[");
   550                 for (int i = 0;; i++) {
   551                     int b = is.read();
   552                     if (b == -1) {
   553                         break;
   554                     }
   555                     if (i > 0) {
   556                         w.append(", ");
   557                     }
   558                     if (i % 20 == 0) {
   559                         w.write("\n");
   560                     }
   561                     if (b > 127) {
   562                         b = b - 256;
   563                     }
   564                     w.append(Integer.toString(b));
   565                 }
   566                 w.append("\n]");
   567             } catch (IOException ex) {
   568                 response.setStatus(HttpStatus.NOT_FOUND_404);
   569                 response.setError();
   570                 response.setDetailMessage(ex.getMessage());
   571             }
   572         }
   573     }
   574 }