Ticket #8228: rc.patch

src/org/openstreetmap/josm/io/remotecontrol/RemoteControl.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.io.remotecontrol;
 
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import com.sun.net.httpserver.HttpExchange;
+import com.sun.net.httpserver.HttpHandler;
+import com.sun.net.httpserver.HttpServer;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+import java.net.BindException;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
 import org.openstreetmap.josm.data.preferences.BooleanProperty;
+import org.openstreetmap.josm.io.remotecontrol.handler.AddNodeHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.AddWayHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.ImageryHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.ImportHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.LoadAndZoomHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.LoadObjectHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.OpenFileHandler;
 import org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler;
+import org.openstreetmap.josm.io.remotecontrol.handler.VersionHandler;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
  * Manager class for remote control operations.
@@ -10 +32 @@
  * IMPORTANT! increment the minor version on compatible API extensions
  * and increment the major version and set minor to 0 on incompatible changes.
  */
-public class RemoteControl
-{
+public class RemoteControl {
     /**
      * If the remote cotrol feature is enabled or disabled. If disabled,
      * it should not start the server.
@@ -19 +40 @@
     public static final BooleanProperty PROP_REMOTECONTROL_ENABLED = new BooleanProperty("remotecontrol.enabled", false);
 
     /**
+     * Default port for the HTTP server
+     */
+    public static final int DEFAULT_PORT = 8111;
+
+    /**
      * RemoteControl HTTP protocol version. Change minor number for compatible
      * interface extensions. Change major number in case of incompatible
      * changes.
@@ -27 +53 @@
     static final int protocolMinorVersion = 4;
 
     /**
+     * RemoteControl protocol version. Change minor number for compatible
+     * interface extensions. Change major number in case of incompatible
+     * changes.
+     */
+    public static final String PROTOCOLVERSION = "{\"protocolversion\": {\"major\": " +
+            RemoteControl.protocolMajorVersion + ", \"minor\": " +
+            RemoteControl.protocolMinorVersion +
+            "}, \"application\": \"JOSM RemoteControl\"}";
+
+    private static final Map<String, Class<? extends RequestHandler>> handlers = new HashMap<String, java.lang.Class<? extends RequestHandler>>();
+
+    public static HttpServer SERVER;
+
+    static {
+        try {
+            SERVER = HttpServer.create(new InetSocketAddress(InetAddress.getLocalHost(), DEFAULT_PORT), 0);
+            SERVER.createContext("/", new UsageHandler());
+            addRequestHandlerClass(LoadAndZoomHandler.command, LoadAndZoomHandler.class, true);
+            addRequestHandlerClass(LoadAndZoomHandler.command2, LoadAndZoomHandler.class, true);
+            addRequestHandlerClass(ImageryHandler.command, ImageryHandler.class, true);
+            addRequestHandlerClass(AddNodeHandler.command, AddNodeHandler.class, true);
+            addRequestHandlerClass(AddWayHandler.command, AddWayHandler.class, true);
+            addRequestHandlerClass(ImportHandler.command, ImportHandler.class, true);
+            addRequestHandlerClass(VersionHandler.command, VersionHandler.class, true);
+            addRequestHandlerClass(LoadObjectHandler.command, LoadObjectHandler.class, true);
+            addRequestHandlerClass(OpenFileHandler.command, OpenFileHandler.class, true);
+        } catch (BindException ex) {
+            System.err.println(tr("Warning: Cannot start remotecontrol server on port {0}: {1}",
+                    Integer.toString(DEFAULT_PORT), ex.getLocalizedMessage()));
+        } catch (IOException ioe) {
+            ioe.printStackTrace();
+        }
+    }
+
+    /**
      * Starts the remote control server
      */
     public static void start() {
-        RemoteControlHttpServer.restartRemoteControlHttpServer();
+        SERVER.start();
+        System.out.println("RemoteControl: Accepting connections on port " + DEFAULT_PORT);
+
     }
 
     /**
-     * Adds external request handler.
-     * Can be used by plugins that want to use remote control.
-     * 
-     * @param command The command name.
+     * Add external request handler. Message can be suppressed (for internal use)
+     *
+     * @param command      The command to handle.
      * @param handlerClass The additional request handler.
+     * @param silent       Don't show message if true.
      */
-    public void addRequestHandler(String command, Class<? extends RequestHandler> handlerClass)
-    {
-        RequestProcessor.addRequestHandlerClass(command, handlerClass);
+    public static void addRequestHandlerClass(String command, final Class<? extends RequestHandler> handlerClass, boolean silent) {
+        final String commandSlash = command.startsWith("/") ? command : ("/" + command);
+        handlers.put(commandSlash, handlerClass);
+        SERVER.createContext(commandSlash, new HttpHandler() {
+            @Override
+            public void handle(HttpExchange exchange) throws IOException {
+                try {
+                    System.out.println("RemoteControl received: " + exchange.getRequestURI());
+                    RequestHandler h = handlerClass.newInstance();
+                    h.setCommand(commandSlash);
+                    h.setUrl(exchange.getRequestURI().toString());
+                    h.handle();
+                    sendResponse(exchange, 200, h.getContentType(), h.getContent());
+                } catch (Exception e) {
+                    throw new RuntimeException(e);
+                }
+            }
+        });
+        if (!silent) {
+            System.out.println("RemoteControl: adding command \"" + command + "\" (handled by " + handlerClass.getSimpleName() + ")");
+        }
+    }
+
+    private static class UsageHandler implements HttpHandler {
+        @Override
+        public void handle(HttpExchange exchange) throws IOException {
+            try {
+                StringBuilder usage = new StringBuilder(1024);
+                for (Map.Entry<String, Class<? extends RequestHandler>> handler : handlers.entrySet()) {
+                    final RequestHandler handlerInstance = handler.getValue().newInstance();
+                    final String[] mandatory = handlerInstance.getMandatoryParams();
+                    usage.append("<li>");
+                    usage.append(handler.getKey());
+                    usage.append(": ");
+                    usage.append(handlerInstance.getUsage());
+                    if (mandatory != null) {
+                        usage.append("<br/>mandatory parameter: ").append(Utils.join(", ", Arrays.asList(mandatory)));
+                        usage.append("<br/>usage examples:").append(Utils.joinAsHtmlUnorderedList(handlerInstance.getUsageExamples()));
+                    }
+                    usage.append("</li>");
+                }
+                String help = "<h1>JOSM RemoteControl</h1>"
+                        + "No command specified! The following commands are available:<ul>"
+                        + usage.toString()
+                        + "</ul>";
+                sendResponse(exchange, 400, "text/html", help);
+            } catch (Exception e) {
+                throw new RuntimeException(e);
+            }
+        }
+    }
+
+    private static void sendResponse(HttpExchange exchange, int httpCode, String contentType, String data) throws IOException {
+        exchange.getResponseHeaders().set("Content-Type", contentType);
+        exchange.getResponseHeaders().set("Server", "JOSM RemoteControl");
+        exchange.getResponseHeaders().set("Access-Control-Allow-Origin", "*");
+        exchange.sendResponseHeaders(httpCode, data.length());
+        OutputStreamWriter out = new OutputStreamWriter(exchange.getResponseBody(), "UTF-8");
+        out.write(data);
+        out.close();
     }
 }

src/org/openstreetmap/josm/io/remotecontrol/handler/AddNodeHandler.java

@@ -3 +3 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.AutoScaleAction;
 import org.openstreetmap.josm.command.AddCommand;
@@ -30 +32 @@
     }
 
     @Override
+    public String getUsage() {
+        return "adds a node (given by its latitude and longitude) to the current dataset";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/add_node?lat=11&lon=22"
+        );
+    }
+
+    @Override
     public String getPermissionMessage() {
         return tr("Remote Control has been asked to create a new node.");
     }

src/org/openstreetmap/josm/io/remotecontrol/handler/AddWayHandler.java

@@ -2 +2 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
 import org.openstreetmap.josm.Main;
@@ -27 +28 @@
     }
 
     @Override
+    public String getUsage() {
+        return "adds a way (given by a semicolon separated sequence of lat,lon pairs) to the current dataset";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/add_way?way=lat1,lon2;lat2,lon2"
+        );
+    }
+
+    @Override
     protected void handleRequest() throws RequestHandlerErrorException, RequestHandlerBadRequestException {
         Way way = new Way();
         List<Command> commands = new LinkedList<Command>();

src/org/openstreetmap/josm/io/remotecontrol/handler/ImageryHandler.java

@@ -5 +5 @@
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
+import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.imagery.ImageryInfo;
 import org.openstreetmap.josm.gui.layer.ImageryLayer;
 import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
  * Adds an imagery (WMS/TMS) layer. For instance, {@code /imagery?title=...&type=...&url=...}.
@@ -35 +38 @@
     }
 
     @Override
+    public String getUsage() {
+        return "adds an imagery layer (e.g. WMS, TMS))";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        final String types = Utils.join("|", Utils.transform(Arrays.asList(ImageryInfo.ImageryType.values()), new Utils.Function<ImageryInfo.ImageryType, String>() {
+            @Override
+            public String apply(ImageryInfo.ImageryType x) {
+                return x.getUrlString();
+            }
+        }));
+        return Arrays.asList(
+                "/imagery?title=...&type={"+types+"}&url=....[&cookies=...][&min_zoom=...][&max_zoom=...]"
+        );
+    }
+
+    @Override
     public PermissionPrefWithDefault getPermissionPref() {
         return PermissionPrefWithDefault.LOAD_IMAGERY;
     }

src/org/openstreetmap/josm/io/remotecontrol/handler/ImportHandler.java

@@ -5 +5 @@
 
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
+import java.util.Arrays;
 import java.util.HashMap;
 
+import java.util.List;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask;
 import org.openstreetmap.josm.actions.downloadtasks.DownloadTask;
 import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault;
@@ -36 +38 @@
     }
 
     @Override
+    public String getUsage() {
+        return "downloads the specified OSM file and adds it to the current data set";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/import?url=http://..."
+        );
+    }
+
+    @Override
     public String getPermissionMessage() {
         return tr("Remote Control has been asked to import data from the following URL:")
                 + "<br>" + request;

src/org/openstreetmap/josm/io/remotecontrol/handler/LoadAndZoomHandler.java

@@ -7 +7 @@
 import java.awt.geom.Rectangle2D;
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
+import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.Future;
 
@@ -50 +52 @@
     }
 
     @Override
+    public String getUsage() {
+        return "download a bounding box from the API, zoom to the downloaded area and optionally select one or more objects";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/load_and_zoom?left=...&right=...&top=...&bottom=...[&select=object[,object...][&addtags=...][&zoom_mode=(download|selection)]]",
+                "/zoom?left=...&right=...&top=...&bottom=...&select=object[,object...]"
+        );
+    }
+
+    @Override
     protected void handleRequest() throws RequestHandlerErrorException
     {
         DownloadTask osmTask = new DownloadOsmTask();

src/org/openstreetmap/josm/io/remotecontrol/handler/LoadObjectHandler.java

@@ -2 +2 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
 import org.openstreetmap.josm.Main;
@@ -25 +26 @@
     }
 
     @Override
+    public String getUsage() {
+        return "downloads the specified objects from the server";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/load_object?objects=n1,w2,r3[&new_layer=false][&relation_members=true]"
+        );
+    }
+
+    @Override
     protected void handleRequest() throws RequestHandlerErrorException, RequestHandlerBadRequestException {
         if (!PermissionPrefWithDefault.LOAD_DATA.isAllowed()) {
             System.out.println("RemoteControl: download forbidden by preferences");

src/org/openstreetmap/josm/io/remotecontrol/handler/OpenFileHandler.java

@@ -2 +2 @@
 
 import java.io.File;
 import java.util.Arrays;
+import java.util.List;
 import org.openstreetmap.josm.actions.OpenFileAction;
 import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault;
 import static org.openstreetmap.josm.tools.I18n.tr;
@@ -16 +17 @@
     }
 
     @Override
+    public String getUsage() {
+        return "opens a local file in JOSM";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/open_file?filename=/tmp/test.osm"
+        );
+    }
+
+    @Override
     public PermissionPrefWithDefault getPermissionPref() {
         return PermissionPrefWithDefault.OPEN_FILES;
     }

src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java

@@ -9 +9 @@
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
-
 import javax.swing.JOptionPane;
-
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault;
 import org.openstreetmap.josm.tools.Utils;
@@ -91 +89 @@
 
     abstract public String[] getMandatoryParams();
 
+    abstract public String getUsage();
+
+    abstract public List<String> getUsageExamples();
+
     /**
      * Check permissions in preferences and display error message
      * or ask for permission.

src/org/openstreetmap/josm/io/remotecontrol/handler/VersionHandler.java

@@ -3 +3 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.util.Arrays;
+import java.util.List;
 import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault;
-import org.openstreetmap.josm.io.remotecontrol.RequestProcessor;
+import org.openstreetmap.josm.io.remotecontrol.RemoteControl;
 
 /**
  * Handler for version request.
@@ -16 +18 @@
     @Override
     protected void handleRequest() throws RequestHandlerErrorException,
             RequestHandlerBadRequestException {
-        content = RequestProcessor.PROTOCOLVERSION;
+        content = RemoteControl.PROTOCOLVERSION;
         contentType = "application/json";
         if (args.containsKey("jsonp")) {
             content = args.get("jsonp") + " && " + args.get("jsonp") + "(" + content + ")";
@@ -37 +39 @@
     public String[] getMandatoryParams() {
         return null;
     }
+
+    @Override
+    public String getUsage() {
+        return "returns the current protocol version of the installed JOSM RemoteControl";
+    }
+
+    @Override
+    public List<String> getUsageExamples() {
+        return Arrays.asList(
+                "/version"
+        );
+    }
 }
+ No newline at end of file