package org.asamk.signal.commands;
+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.JsonWriter;
import org.asamk.signal.OutputType;
-import org.asamk.signal.PlainTextWriterImpl;
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 java.io.IOException;
-import java.util.Base64;
-import java.util.Map;
-import java.util.Set;
-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<ReceiveCommand.ReceiveParams> {
-public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
+ private static final Logger logger = LoggerFactory.getLogger(ReceiveCommand.class);
- 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());
}
@Override
- public Set<OutputType> getSupportedOutputTypes() {
- return Set.of(OutputType.PLAIN_TEXT, OutputType.JSON);
+ public List<OutputType> getSupportedOutputTypes() {
+ return List.of(OutputType.PLAIN_TEXT, OutputType.JSON);
}
- public int handleCommand(final Namespace ns, final Signal signal, DBusConnection dbusconnection) {
- var inJson = ns.get("output") == OutputType.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 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 {
- if (inJson) {
- final var jsonWriter = new JsonWriter(System.out);
-
- dbusconnection.addSigHandler(Signal.MessageReceived.class, messageReceived -> {
- var envelope = new JsonMessageEnvelope(messageReceived);
- final var object = Map.of("envelope", envelope);
- try {
- jsonWriter.write(object);
- } catch (IOException e) {
- logger.error("Failed to write json object: {}", e.getMessage());
- }
- });
-
- dbusconnection.addSigHandler(Signal.ReceiptReceived.class, receiptReceived -> {
- var envelope = new JsonMessageEnvelope(receiptReceived);
- final var object = Map.of("envelope", envelope);
- try {
- jsonWriter.write(object);
- } catch (IOException e) {
- logger.error("Failed to write json object: {}", e.getMessage());
- }
- });
-
- dbusconnection.addSigHandler(Signal.SyncMessageReceived.class, syncReceived -> {
- var envelope = new JsonMessageEnvelope(syncReceived);
- final var object = Map.of("envelope", envelope);
- try {
- jsonWriter.write(object);
- } catch (IOException e) {
- logger.error("Failed to write json object: {}", e.getMessage());
- }
- });
- } else {
- final var writer = new PlainTextWriterImpl(System.out);
-
- dbusconnection.addSigHandler(Signal.MessageReceived.class, messageReceived -> {
- try {
- writer.println("Envelope from: {}", messageReceived.getSender());
- writer.println("Timestamp: {}", DateUtils.formatTimestamp(messageReceived.getTimestamp()));
- writer.println("Body: {}", messageReceived.getMessage());
- if (messageReceived.getGroupId().length > 0) {
- writer.println("Group info:");
- writer.indentedWriter()
- .println("Id: {}",
- Base64.getEncoder().encodeToString(messageReceived.getGroupId()));
- }
- if (messageReceived.getAttachments().size() > 0) {
- writer.println("Attachments:");
- for (var attachment : messageReceived.getAttachments()) {
- writer.println("- Stored plaintext in: {}", attachment);
- }
- }
- writer.println();
- } catch (IOException e) {
- e.printStackTrace();
- }
- });
-
- dbusconnection.addSigHandler(Signal.ReceiptReceived.class, receiptReceived -> {
- try {
- writer.println("Receipt from: {}", receiptReceived.getSender());
- writer.println("Timestamp: {}", DateUtils.formatTimestamp(receiptReceived.getTimestamp()));
- } catch (IOException e) {
- e.printStackTrace();
- }
- });
-
- dbusconnection.addSigHandler(Signal.SyncMessageReceived.class, syncReceived -> {
- try {
- writer.println("Sync Envelope from: {} to: {}",
- syncReceived.getSource(),
- syncReceived.getDestination());
- writer.println("Timestamp: {}", DateUtils.formatTimestamp(syncReceived.getTimestamp()));
- writer.println("Body: {}", syncReceived.getMessage());
- if (syncReceived.getGroupId().length > 0) {
- writer.println("Group info:");
- writer.indentedWriter()
- .println("Id: {}", Base64.getEncoder().encodeToString(syncReceived.getGroupId()));
- }
- if (syncReceived.getAttachments().size() > 0) {
- writer.println("Attachments:");
- for (var attachment : syncReceived.getAttachments()) {
- writer.println("- Stored plaintext in: {}", attachment);
- }
- }
- writer.println();
- } catch (IOException e) {
- e.printStackTrace();
- }
- });
- }
- } catch (DBusException e) {
- e.printStackTrace();
- return 2;
- }
- 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) {
- var inJson = ns.get("output") == OutputType.JSON || ns.getBoolean("json");
+ public TypeReference<ReceiveParams> 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");
- }
- var returnOnTimeout = true;
- if (timeout < 0) {
- returnOnTimeout = false;
- timeout = 3600;
- }
- boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
try {
- final var 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) {}
}