]> nmode's Git Repositories - signal-cli/blobdiff - src/main/java/org/asamk/signal/commands/ReceiveCommand.java
Handle rate limit exception correctly when querying usernames
[signal-cli] / src / main / java / org / asamk / signal / commands / ReceiveCommand.java
index 03f3d1b2ee42e78fd69703cd9f73b4877ac3be82..37da35e1397d663bea6f48c512896716a22d6582 100644 (file)
 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.OutputType;
 import org.asamk.signal.ReceiveMessageHandler;
+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.DBusConnection;
-import org.freedesktop.dbus.DBusSigHandler;
-import org.freedesktop.dbus.exceptions.DBusException;
-import org.whispersystems.signalservice.internal.util.Base64;
+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.concurrent.TimeUnit;
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+public class ReceiveCommand implements LocalCommand, JsonRpcSingleCommand<ReceiveCommand.ReceiveParams> {
 
-import static org.asamk.signal.util.ErrorUtils.handleAssertionError;
+    private static final Logger logger = LoggerFactory.getLogger(ReceiveCommand.class);
 
-public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
+    @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("Output 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) {
-        if (dbusconnection != null) {
-            try {
-                dbusconnection.addSigHandler(Signal.MessageReceived.class, new DBusSigHandler<Signal.MessageReceived>() {
-                    @Override
-                    public void handle(Signal.MessageReceived s) {
-                        System.out.print(String.format("Envelope from: %s\nTimestamp: %s\nBody: %s\n",
-                                s.getSender(), DateUtils.formatTimestamp(s.getTimestamp()), s.getMessage()));
-                        if (s.getGroupId().length > 0) {
-                            System.out.println("Group info:");
-                            System.out.println("  Id: " + Base64.encodeBytes(s.getGroupId()));
-                        }
-                        if (s.getAttachments().size() > 0) {
-                            System.out.println("Attachments: ");
-                            for (String attachment : s.getAttachments()) {
-                                System.out.println("-  Stored plaintext in: " + attachment);
-                            }
-                        }
-                        System.out.println();
-                    }
-                });
-                dbusconnection.addSigHandler(Signal.ReceiptReceived.class, new DBusSigHandler<Signal.ReceiptReceived>() {
-                    @Override
-                    public void handle(Signal.ReceiptReceived s) {
-                        System.out.print(String.format("Receipt from: %s\nTimestamp: %s\n",
-                                s.getSender(), DateUtils.formatTimestamp(s.getTimestamp())));
-                    }
-                });
-            } 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;
-                }
-            }
-        }
-        return 0;
+    @Override
+    public List<OutputType> getSupportedOutputTypes() {
+        return List.of(OutputType.PLAIN_TEXT, OutputType.JSON);
     }
 
     @Override
-    public int handleCommand(final Namespace ns, final Manager m) {
-        if (!m.isRegistered()) {
-            System.err.println("User is not registered.");
-            return 1;
-        }
-        double timeout = 5;
-        if (ns.getDouble("timeout") != null) {
-            timeout = ns.getDouble("timeout");
-        }
-        boolean returnOnTimeout = true;
-        if (timeout < 0) {
-            returnOnTimeout = false;
-            timeout = 3600;
+    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 {
+            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);
         }
-        boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
+    }
+
+    @Override
+    public TypeReference<ReceiveParams> getRequestType() {
+        return new TypeReference<>() {};
+    }
+
+    @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();
+
         try {
-            final Manager.ReceiveMessageHandler handler = ns.getBoolean("json") ? 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) {}
 }