X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/0624d6a808b8b2a247aadd96450319bc94e3729f..5e16123632d839bc0fa0648d8fabbec48c03a7f9:/src/main/java/org/asamk/signal/commands/ReceiveCommand.java diff --git a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java index 9d718abb..37da35e1 100644 --- a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java +++ b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java @@ -1,197 +1,125 @@ package org.asamk.signal.commands; -import com.fasterxml.jackson.annotation.JsonAutoDetect; -import com.fasterxml.jackson.annotation.PropertyAccessor; -import com.fasterxml.jackson.core.JsonGenerator; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.node.ObjectNode; +import com.fasterxml.jackson.core.type.TypeReference; import net.sourceforge.argparse4j.impl.Arguments; import net.sourceforge.argparse4j.inf.Namespace; import net.sourceforge.argparse4j.inf.Subparser; -import org.asamk.Signal; -import org.asamk.signal.JsonReceiveMessageHandler; +import org.asamk.signal.OutputType; import org.asamk.signal.ReceiveMessageHandler; -import org.asamk.signal.json.JsonMessageEnvelope; +import org.asamk.signal.Shutdown; +import org.asamk.signal.commands.exceptions.CommandException; +import org.asamk.signal.commands.exceptions.IOErrorException; +import org.asamk.signal.commands.exceptions.UserErrorException; +import org.asamk.signal.json.JsonReceiveMessageHandler; import org.asamk.signal.manager.Manager; -import org.asamk.signal.util.DateUtils; -import org.freedesktop.dbus.connections.impl.DBusConnection; -import org.freedesktop.dbus.exceptions.DBusException; +import org.asamk.signal.manager.api.AlreadyReceivingException; +import org.asamk.signal.manager.api.ReceiveConfig; +import org.asamk.signal.output.JsonWriter; +import org.asamk.signal.output.OutputWriter; +import org.asamk.signal.output.PlainTextWriter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.whispersystems.util.Base64; import java.io.IOException; -import java.util.concurrent.TimeUnit; +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; -import static org.asamk.signal.util.ErrorUtils.handleAssertionError; +public class ReceiveCommand implements LocalCommand, JsonRpcSingleCommand { -public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand { + private static final Logger logger = LoggerFactory.getLogger(ReceiveCommand.class); - // TODO delete later when "json" variable is removed - private final static Logger logger = LoggerFactory.getLogger(ReceiveCommand.class); + @Override + public String getName() { + return "receive"; + } @Override public void attachToSubparser(final Subparser subparser) { + subparser.help("Query the server for new messages."); subparser.addArgument("-t", "--timeout") .type(double.class) + .setDefault(3.0) .help("Number of seconds to wait for new messages (negative values disable timeout)"); + subparser.addArgument("--max-messages") + .type(int.class) + .setDefault(-1) + .help("Maximum number of messages to receive, before returning."); subparser.addArgument("--ignore-attachments") .help("Don’t download attachments of received messages.") .action(Arguments.storeTrue()); - subparser.addArgument("--json") - .help("WARNING: This parameter is now deprecated! Please use the global \"--output=json\" option instead.\n\nOutput received messages in json format, one json object per line.") + subparser.addArgument("--ignore-stories") + .help("Don’t receive story messages from the server.") + .action(Arguments.storeTrue()); + subparser.addArgument("--send-read-receipts") + .help("Send read receipts for all incoming data messages (in addition to the default delivery receipts)") .action(Arguments.storeTrue()); } - public int handleCommand(final Namespace ns, final Signal signal, DBusConnection dbusconnection) { - final ObjectMapper jsonProcessor; - - boolean inJson = ns.getString("output").equals("json") || ns.getBoolean("json"); - - // TODO delete later when "json" variable is removed - if (ns.getBoolean("json")) { - logger.warn("\"--json\" option has been deprecated, please use the global \"--output=json\" instead."); - } + @Override + public List getSupportedOutputTypes() { + return List.of(OutputType.PLAIN_TEXT, OutputType.JSON); + } - if (inJson) { - jsonProcessor = new ObjectMapper(); - jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); - jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET); - } else { - jsonProcessor = null; - } + @Override + public void handleCommand( + final Namespace ns, + final Manager m, + final OutputWriter outputWriter + ) throws CommandException { + Shutdown.installHandler(); + final var timeout = ns.getDouble("timeout"); + final var maxMessagesRaw = ns.getInt("max-messages"); + final var ignoreAttachments = Boolean.TRUE.equals(ns.getBoolean("ignore-attachments")); + final var ignoreStories = Boolean.TRUE.equals(ns.getBoolean("ignore-stories")); + final var sendReadReceipts = Boolean.TRUE.equals(ns.getBoolean("send-read-receipts")); + m.setReceiveConfig(new ReceiveConfig(ignoreAttachments, ignoreStories, sendReadReceipts)); try { - dbusconnection.addSigHandler(Signal.MessageReceived.class, messageReceived -> { - if (jsonProcessor != null) { - JsonMessageEnvelope envelope = new JsonMessageEnvelope(messageReceived); - ObjectNode result = jsonProcessor.createObjectNode(); - result.putPOJO("envelope", envelope); - try { - jsonProcessor.writeValue(System.out, result); - System.out.println(); - } catch (IOException e) { - e.printStackTrace(); - } - } else { - System.out.print(String.format("Envelope from: %s\nTimestamp: %s\nBody: %s\n", - messageReceived.getSender(), - DateUtils.formatTimestamp(messageReceived.getTimestamp()), - messageReceived.getMessage())); - if (messageReceived.getGroupId().length > 0) { - System.out.println("Group info:"); - System.out.println(" Id: " + Base64.encodeBytes(messageReceived.getGroupId())); - } - if (messageReceived.getAttachments().size() > 0) { - System.out.println("Attachments: "); - for (String attachment : messageReceived.getAttachments()) { - System.out.println("- Stored plaintext in: " + attachment); - } - } - System.out.println(); - } - }); - - dbusconnection.addSigHandler(Signal.ReceiptReceived.class, receiptReceived -> { - if (jsonProcessor != null) { - JsonMessageEnvelope envelope = new JsonMessageEnvelope(receiptReceived); - ObjectNode result = jsonProcessor.createObjectNode(); - result.putPOJO("envelope", envelope); - try { - jsonProcessor.writeValue(System.out, result); - System.out.println(); - } catch (IOException e) { - e.printStackTrace(); - } - } else { - System.out.print(String.format("Receipt from: %s\nTimestamp: %s\n", - receiptReceived.getSender(), - DateUtils.formatTimestamp(receiptReceived.getTimestamp()))); - } - }); - - dbusconnection.addSigHandler(Signal.SyncMessageReceived.class, syncReceived -> { - if (jsonProcessor != null) { - JsonMessageEnvelope envelope = new JsonMessageEnvelope(syncReceived); - ObjectNode result = jsonProcessor.createObjectNode(); - result.putPOJO("envelope", envelope); - try { - jsonProcessor.writeValue(System.out, result); - System.out.println(); - } catch (IOException e) { - e.printStackTrace(); - } - } else { - System.out.print(String.format("Sync Envelope from: %s to: %s\nTimestamp: %s\nBody: %s\n", - syncReceived.getSource(), - syncReceived.getDestination(), - DateUtils.formatTimestamp(syncReceived.getTimestamp()), - syncReceived.getMessage())); - if (syncReceived.getGroupId().length > 0) { - System.out.println("Group info:"); - System.out.println(" Id: " + Base64.encodeBytes(syncReceived.getGroupId())); - } - if (syncReceived.getAttachments().size() > 0) { - System.out.println("Attachments: "); - for (String attachment : syncReceived.getAttachments()) { - System.out.println("- Stored plaintext in: " + attachment); - } - } - System.out.println(); - } - }); - } catch (UnsatisfiedLinkError e) { - System.err.println("Missing native library dependency for dbus service: " + e.getMessage()); - return 1; - } catch (DBusException e) { - e.printStackTrace(); - return 1; - } - while (true) { - try { - Thread.sleep(10000); - } catch (InterruptedException e) { - return 0; - } + final var handler = switch (outputWriter) { + case JsonWriter writer -> new JsonReceiveMessageHandler(m, writer); + case PlainTextWriter writer -> new ReceiveMessageHandler(m, writer); + }; + final var duration = timeout < 0 ? null : Duration.ofMillis((long) (timeout * 1000)); + final var maxMessages = maxMessagesRaw < 0 ? null : maxMessagesRaw; + Shutdown.registerShutdownListener(m::stopReceiveMessages); + m.receiveMessages(Optional.ofNullable(duration), Optional.ofNullable(maxMessages), handler); + } catch (IOException e) { + throw new IOErrorException("Error while receiving messages: " + e.getMessage(), e); + } catch (AlreadyReceivingException e) { + throw new UserErrorException("Receive command cannot be used if messages are already being received.", e); } } @Override - public int handleCommand(final Namespace ns, final Manager m) { - boolean inJson = ns.getString("output").equals("json") || ns.getBoolean("json"); + public TypeReference getRequestType() { + return new TypeReference<>() {}; + } - // TODO delete later when "json" variable is removed - if (ns.getBoolean("json")) { - logger.warn("\"--json\" option has been deprecated, please use the global \"--output=json\" instead."); - } + @Override + public void handleCommand( + final ReceiveParams request, + final Manager m, + final JsonWriter jsonWriter + ) throws CommandException { + final var timeout = request.timeout() == null ? 3.0 : request.timeout(); + final var maxMessagesRaw = request.maxMessages() == null ? -1 : request.maxMessages(); - double timeout = 5; - if (ns.getDouble("timeout") != null) { - timeout = ns.getDouble("timeout"); - } - boolean returnOnTimeout = true; - if (timeout < 0) { - returnOnTimeout = false; - timeout = 3600; - } - boolean ignoreAttachments = ns.getBoolean("ignore_attachments"); try { - final Manager.ReceiveMessageHandler handler = inJson - ? new JsonReceiveMessageHandler(m) - : new ReceiveMessageHandler(m); - m.receiveMessages((long) (timeout * 1000), - TimeUnit.MILLISECONDS, - returnOnTimeout, - ignoreAttachments, - handler); - return 0; + final var messages = new ArrayList<>(); + final var handler = new JsonReceiveMessageHandler(m, messages::add); + final var duration = timeout < 0 ? null : Duration.ofMillis((long) (timeout * 1000)); + final var maxMessages = maxMessagesRaw < 0 ? null : maxMessagesRaw; + m.receiveMessages(Optional.ofNullable(duration), Optional.ofNullable(maxMessages), handler); + jsonWriter.write(messages); } catch (IOException e) { - System.err.println("Error while receiving messages: " + e.getMessage()); - return 3; - } catch (AssertionError e) { - handleAssertionError(e); - return 1; + throw new IOErrorException("Error while receiving messages: " + e.getMessage(), e); + } catch (AlreadyReceivingException e) { + throw new UserErrorException("Receive command cannot be used if messages are already being received.", e); } } + + public record ReceiveParams(Double timeout, Integer maxMessages) {} }