From ae678871ec976f2bcf1cee969e555ca00239f7d8 Mon Sep 17 00:00:00 2001 From: AsamK Date: Tue, 1 Nov 2022 17:10:15 +0100 Subject: [PATCH] Extract JSON-RPC command handler --- .../jsonrpc/SignalJsonRpcCommandHandler.java | 257 ++++++++++++++++++ .../SignalJsonRpcDispatcherHandler.java | 221 +-------------- 2 files changed, 261 insertions(+), 217 deletions(-) create mode 100644 src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcCommandHandler.java diff --git a/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcCommandHandler.java b/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcCommandHandler.java new file mode 100644 index 00000000..0f6a00bd --- /dev/null +++ b/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcCommandHandler.java @@ -0,0 +1,257 @@ +package org.asamk.signal.jsonrpc; + +import com.fasterxml.jackson.core.TreeNode; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.JsonMappingException; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ContainerNode; +import com.fasterxml.jackson.databind.node.ObjectNode; + +import org.asamk.signal.commands.Command; +import org.asamk.signal.commands.JsonRpcMultiCommand; +import org.asamk.signal.commands.JsonRpcRegistrationCommand; +import org.asamk.signal.commands.JsonRpcSingleCommand; +import org.asamk.signal.commands.exceptions.CommandException; +import org.asamk.signal.commands.exceptions.IOErrorException; +import org.asamk.signal.commands.exceptions.UntrustedKeyErrorException; +import org.asamk.signal.commands.exceptions.UserErrorException; +import org.asamk.signal.manager.Manager; +import org.asamk.signal.manager.MultiAccountManager; +import org.asamk.signal.manager.RegistrationManager; +import org.asamk.signal.output.JsonWriter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.nio.channels.OverlappingFileLockException; +import java.util.Map; +import java.util.function.Function; + +public class SignalJsonRpcCommandHandler { + + private final static Logger logger = LoggerFactory.getLogger(SignalJsonRpcDispatcherHandler.class); + + private static final int USER_ERROR = -1; + private static final int IO_ERROR = -3; + private static final int UNTRUSTED_KEY_ERROR = -4; + + private final Manager m; + private final MultiAccountManager c; + private final Function commandProvider; + + public SignalJsonRpcCommandHandler(final Manager m, final Function commandProvider) { + this.c = null; + this.m = m; + this.commandProvider = commandProvider; + } + + public SignalJsonRpcCommandHandler(final MultiAccountManager c, final Function commandProvider) { + this.c = c; + this.m = null; + this.commandProvider = commandProvider; + } + + JsonNode handleRequest( + final ObjectMapper objectMapper, final String method, ContainerNode params + ) throws JsonRpcException { + var command = getCommand(method); + if (c != null) { + if (command instanceof JsonRpcSingleCommand jsonRpcCommand) { + final var manager = getManagerFromParams(params); + if (manager != null) { + return runCommand(objectMapper, params, new CommandRunnerImpl<>(manager, jsonRpcCommand)); + } + } + if (command instanceof JsonRpcMultiCommand jsonRpcCommand) { + return runCommand(objectMapper, params, new MultiCommandRunnerImpl<>(c, jsonRpcCommand)); + } + if (command instanceof JsonRpcRegistrationCommand jsonRpcCommand) { + try (var manager = getRegistrationManagerFromParams(params)) { + if (manager != null) { + return runCommand(objectMapper, + params, + new RegistrationCommandRunnerImpl<>(manager, c, jsonRpcCommand)); + } else { + throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_PARAMS, + "Method requires valid account parameter", + null)); + } + } catch (IOException e) { + logger.warn("Failed to close registration manager", e); + } + } + } + if (command instanceof JsonRpcSingleCommand jsonRpcCommand) { + if (m != null) { + return runCommand(objectMapper, params, new CommandRunnerImpl<>(m, jsonRpcCommand)); + } + + final var manager = getManagerFromParams(params); + if (manager != null) { + return runCommand(objectMapper, params, new CommandRunnerImpl<>(manager, jsonRpcCommand)); + } else { + throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_PARAMS, + "Method requires valid account parameter", + null)); + } + } + + throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.METHOD_NOT_FOUND, + "Method not implemented", + null)); + } + + private Manager getManagerFromParams(final ContainerNode params) throws JsonRpcException { + if (params != null && params.hasNonNull("account")) { + final var manager = c.getManager(params.get("account").asText()); + ((ObjectNode) params).remove("account"); + if (manager == null) { + throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_PARAMS, + "Specified account does not exist", + null)); + } + return manager; + } + return null; + } + + private RegistrationManager getRegistrationManagerFromParams(final ContainerNode params) { + if (params != null && params.has("account")) { + try { + final var registrationManager = c.getNewRegistrationManager(params.get("account").asText()); + ((ObjectNode) params).remove("account"); + return registrationManager; + } catch (OverlappingFileLockException e) { + logger.warn("Account is already in use"); + return null; + } catch (IOException | IllegalStateException e) { + logger.warn("Failed to load registration manager", e); + return null; + } + } + return null; + } + + private Command getCommand(final String method) { + return commandProvider.apply(method); + } + + private record CommandRunnerImpl(Manager m, JsonRpcSingleCommand command) implements CommandRunner { + + @Override + public void handleCommand(final T request, final JsonWriter jsonWriter) throws CommandException { + command.handleCommand(request, m, jsonWriter); + } + + @Override + public TypeReference getRequestType() { + return command.getRequestType(); + } + } + + private record RegistrationCommandRunnerImpl( + RegistrationManager m, MultiAccountManager c, JsonRpcRegistrationCommand command + ) implements CommandRunner { + + @Override + public void handleCommand(final T request, final JsonWriter jsonWriter) throws CommandException { + command.handleCommand(request, m, jsonWriter); + } + + @Override + public TypeReference getRequestType() { + return command.getRequestType(); + } + } + + private record MultiCommandRunnerImpl( + MultiAccountManager c, JsonRpcMultiCommand command + ) implements CommandRunner { + + @Override + public void handleCommand(final T request, final JsonWriter jsonWriter) throws CommandException { + command.handleCommand(request, c, jsonWriter); + } + + @Override + public TypeReference getRequestType() { + return command.getRequestType(); + } + } + + interface CommandRunner { + + void handleCommand(T request, JsonWriter jsonWriter) throws CommandException; + + TypeReference getRequestType(); + } + + private JsonNode runCommand( + final ObjectMapper objectMapper, final ContainerNode params, final CommandRunner command + ) throws JsonRpcException { + final Object[] result = {null}; + final JsonWriter commandJsonWriter = s -> { + if (result[0] != null) { + throw new AssertionError("Command may only write one json result"); + } + + result[0] = s; + }; + + try { + parseParamsAndRunCommand(objectMapper, params, commandJsonWriter, command); + } catch (JsonMappingException e) { + throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_REQUEST, + e.getMessage(), + null)); + } catch (UserErrorException e) { + throw new JsonRpcException(new JsonRpcResponse.Error(USER_ERROR, + e.getMessage(), + getErrorDataNode(objectMapper, result))); + } catch (IOErrorException e) { + throw new JsonRpcException(new JsonRpcResponse.Error(IO_ERROR, + e.getMessage(), + getErrorDataNode(objectMapper, result))); + } catch (UntrustedKeyErrorException e) { + throw new JsonRpcException(new JsonRpcResponse.Error(UNTRUSTED_KEY_ERROR, + e.getMessage(), + getErrorDataNode(objectMapper, result))); + } catch (Throwable e) { + logger.error("Command execution failed", e); + throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INTERNAL_ERROR, + e.getMessage(), + getErrorDataNode(objectMapper, result))); + } + + Object output = result[0] == null ? Map.of() : result[0]; + return objectMapper.valueToTree(output); + } + + private JsonNode getErrorDataNode(final ObjectMapper objectMapper, final Object[] result) { + if (result[0] == null) { + return null; + } + return objectMapper.valueToTree(Map.of("response", result[0])); + } + + private void parseParamsAndRunCommand( + final ObjectMapper objectMapper, + final TreeNode params, + final JsonWriter jsonWriter, + final CommandRunner command + ) throws CommandException, JsonMappingException { + T requestParams = null; + final var requestType = command.getRequestType(); + if (params != null && requestType != null) { + try { + requestParams = objectMapper.readValue(objectMapper.treeAsTokens(params), requestType); + } catch (JsonMappingException e) { + throw e; + } catch (IOException e) { + throw new AssertionError(e); + } + } + command.handleCommand(requestParams, jsonWriter); + } +} diff --git a/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcDispatcherHandler.java b/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcDispatcherHandler.java index 181233bc..3548f655 100644 --- a/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcDispatcherHandler.java +++ b/src/main/java/org/asamk/signal/jsonrpc/SignalJsonRpcDispatcherHandler.java @@ -1,8 +1,6 @@ package org.asamk.signal.jsonrpc; -import com.fasterxml.jackson.core.TreeNode; import com.fasterxml.jackson.core.type.TypeReference; -import com.fasterxml.jackson.databind.JsonMappingException; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.node.ArrayNode; @@ -13,25 +11,19 @@ import com.fasterxml.jackson.databind.node.ObjectNode; import org.asamk.signal.commands.Command; import org.asamk.signal.commands.Commands; import org.asamk.signal.commands.JsonRpcMultiCommand; -import org.asamk.signal.commands.JsonRpcRegistrationCommand; import org.asamk.signal.commands.JsonRpcSingleCommand; import org.asamk.signal.commands.exceptions.CommandException; -import org.asamk.signal.commands.exceptions.IOErrorException; -import org.asamk.signal.commands.exceptions.UntrustedKeyErrorException; import org.asamk.signal.commands.exceptions.UserErrorException; import org.asamk.signal.json.JsonReceiveMessageHandler; import org.asamk.signal.manager.Manager; import org.asamk.signal.manager.MultiAccountManager; -import org.asamk.signal.manager.RegistrationManager; import org.asamk.signal.manager.api.Pair; import org.asamk.signal.output.JsonWriter; import org.asamk.signal.util.Util; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import java.io.IOException; import java.nio.channels.ClosedChannelException; -import java.nio.channels.OverlappingFileLockException; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -42,19 +34,13 @@ public class SignalJsonRpcDispatcherHandler { private final static Logger logger = LoggerFactory.getLogger(SignalJsonRpcDispatcherHandler.class); - private static final int USER_ERROR = -1; - private static final int IO_ERROR = -3; - private static final int UNTRUSTED_KEY_ERROR = -4; - private final ObjectMapper objectMapper; private final JsonRpcSender jsonRpcSender; private final JsonRpcReader jsonRpcReader; private final boolean noReceiveOnStart; - private MultiAccountManager c; private final Map>> receiveHandlers = new HashMap<>(); - - private Manager m; + private SignalJsonRpcCommandHandler commandHandler; public SignalJsonRpcDispatcherHandler( final JsonWriter jsonWriter, final Supplier lineSupplier, final boolean noReceiveOnStart @@ -66,7 +52,7 @@ public class SignalJsonRpcDispatcherHandler { } public void handleConnection(final MultiAccountManager c) { - this.c = c; + this.commandHandler = new SignalJsonRpcCommandHandler(c, this::getCommand); if (!noReceiveOnStart) { this.subscribeReceive(c.getManagers()); @@ -78,7 +64,7 @@ public class SignalJsonRpcDispatcherHandler { } public void handleConnection(final Manager m) { - this.m = m; + this.commandHandler = new SignalJsonRpcCommandHandler(m, this::getCommand); if (!noReceiveOnStart) { subscribeReceive(m); @@ -141,7 +127,7 @@ public class SignalJsonRpcDispatcherHandler { private void handleConnection() { try { - jsonRpcReader.readMessages((method, params) -> handleRequest(objectMapper, method, params), + jsonRpcReader.readMessages((method, params) -> commandHandler.handleRequest(objectMapper, method, params), response -> logger.debug("Received unexpected response for id {}", response.getId())); } finally { receiveHandlers.forEach((_subscriptionId, handlers) -> handlers.forEach(this::unsubscribeReceiveHandler)); @@ -155,87 +141,6 @@ public class SignalJsonRpcDispatcherHandler { m.removeReceiveHandler(handler); } - private JsonNode handleRequest( - final ObjectMapper objectMapper, final String method, ContainerNode params - ) throws JsonRpcException { - var command = getCommand(method); - if (c != null) { - if (command instanceof JsonRpcSingleCommand jsonRpcCommand) { - final var manager = getManagerFromParams(params); - if (manager != null) { - return runCommand(objectMapper, params, new CommandRunnerImpl<>(manager, jsonRpcCommand)); - } - } - if (command instanceof JsonRpcMultiCommand jsonRpcCommand) { - return runCommand(objectMapper, params, new MultiCommandRunnerImpl<>(c, jsonRpcCommand)); - } - if (command instanceof JsonRpcRegistrationCommand jsonRpcCommand) { - try (var manager = getRegistrationManagerFromParams(params)) { - if (manager != null) { - return runCommand(objectMapper, - params, - new RegistrationCommandRunnerImpl<>(manager, c, jsonRpcCommand)); - } else { - throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_PARAMS, - "Method requires valid account parameter", - null)); - } - } catch (IOException e) { - logger.warn("Failed to close registration manager", e); - } - } - } - if (command instanceof JsonRpcSingleCommand jsonRpcCommand) { - if (m != null) { - return runCommand(objectMapper, params, new CommandRunnerImpl<>(m, jsonRpcCommand)); - } - - final var manager = getManagerFromParams(params); - if (manager != null) { - return runCommand(objectMapper, params, new CommandRunnerImpl<>(manager, jsonRpcCommand)); - } else { - throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_PARAMS, - "Method requires valid account parameter", - null)); - } - } - - throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.METHOD_NOT_FOUND, - "Method not implemented", - null)); - } - - private Manager getManagerFromParams(final ContainerNode params) throws JsonRpcException { - if (params != null && params.hasNonNull("account")) { - final var manager = c.getManager(params.get("account").asText()); - ((ObjectNode) params).remove("account"); - if (manager == null) { - throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_PARAMS, - "Specified account does not exist", - null)); - } - return manager; - } - return null; - } - - private RegistrationManager getRegistrationManagerFromParams(final ContainerNode params) { - if (params != null && params.has("account")) { - try { - final var registrationManager = c.getNewRegistrationManager(params.get("account").asText()); - ((ObjectNode) params).remove("account"); - return registrationManager; - } catch (OverlappingFileLockException e) { - logger.warn("Account is already in use"); - return null; - } catch (IOException | IllegalStateException e) { - logger.warn("Failed to load registration manager", e); - return null; - } - } - return null; - } - private Command getCommand(final String method) { if ("subscribeReceive".equals(method)) { return new SubscribeReceiveCommand(); @@ -246,124 +151,6 @@ public class SignalJsonRpcDispatcherHandler { return Commands.getCommand(method); } - private record CommandRunnerImpl(Manager m, JsonRpcSingleCommand command) implements CommandRunner { - - @Override - public void handleCommand(final T request, final JsonWriter jsonWriter) throws CommandException { - command.handleCommand(request, m, jsonWriter); - } - - @Override - public TypeReference getRequestType() { - return command.getRequestType(); - } - } - - private record RegistrationCommandRunnerImpl( - RegistrationManager m, MultiAccountManager c, JsonRpcRegistrationCommand command - ) implements CommandRunner { - - @Override - public void handleCommand(final T request, final JsonWriter jsonWriter) throws CommandException { - command.handleCommand(request, m, jsonWriter); - } - - @Override - public TypeReference getRequestType() { - return command.getRequestType(); - } - } - - private record MultiCommandRunnerImpl( - MultiAccountManager c, JsonRpcMultiCommand command - ) implements CommandRunner { - - @Override - public void handleCommand(final T request, final JsonWriter jsonWriter) throws CommandException { - command.handleCommand(request, c, jsonWriter); - } - - @Override - public TypeReference getRequestType() { - return command.getRequestType(); - } - } - - interface CommandRunner { - - void handleCommand(T request, JsonWriter jsonWriter) throws CommandException; - - TypeReference getRequestType(); - } - - private JsonNode runCommand( - final ObjectMapper objectMapper, final ContainerNode params, final CommandRunner command - ) throws JsonRpcException { - final Object[] result = {null}; - final JsonWriter commandJsonWriter = s -> { - if (result[0] != null) { - throw new AssertionError("Command may only write one json result"); - } - - result[0] = s; - }; - - try { - parseParamsAndRunCommand(objectMapper, params, commandJsonWriter, command); - } catch (JsonMappingException e) { - throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INVALID_REQUEST, - e.getMessage(), - null)); - } catch (UserErrorException e) { - throw new JsonRpcException(new JsonRpcResponse.Error(USER_ERROR, - e.getMessage(), - getErrorDataNode(objectMapper, result))); - } catch (IOErrorException e) { - throw new JsonRpcException(new JsonRpcResponse.Error(IO_ERROR, - e.getMessage(), - getErrorDataNode(objectMapper, result))); - } catch (UntrustedKeyErrorException e) { - throw new JsonRpcException(new JsonRpcResponse.Error(UNTRUSTED_KEY_ERROR, - e.getMessage(), - getErrorDataNode(objectMapper, result))); - } catch (Throwable e) { - logger.error("Command execution failed", e); - throw new JsonRpcException(new JsonRpcResponse.Error(JsonRpcResponse.Error.INTERNAL_ERROR, - e.getMessage(), - getErrorDataNode(objectMapper, result))); - } - - Object output = result[0] == null ? Map.of() : result[0]; - return objectMapper.valueToTree(output); - } - - private JsonNode getErrorDataNode(final ObjectMapper objectMapper, final Object[] result) { - if (result[0] == null) { - return null; - } - return objectMapper.valueToTree(Map.of("response", result[0])); - } - - private void parseParamsAndRunCommand( - final ObjectMapper objectMapper, - final TreeNode params, - final JsonWriter jsonWriter, - final CommandRunner command - ) throws CommandException, JsonMappingException { - T requestParams = null; - final var requestType = command.getRequestType(); - if (params != null && requestType != null) { - try { - requestParams = objectMapper.readValue(objectMapper.treeAsTokens(params), requestType); - } catch (JsonMappingException e) { - throw e; - } catch (IOException e) { - throw new AssertionError(e); - } - } - command.handleCommand(requestParams, jsonWriter); - } - private class SubscribeReceiveCommand implements JsonRpcSingleCommand, JsonRpcMultiCommand { @Override -- 2.50.1