Add new dbus message received signals with extendable extras map

[signal-cli] / 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 e2002258a245db55da73598a56ba44a23808d392..a69be7de90e60213b87680fd0a6003d7f52c2861 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
+++ b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
@@ -1,197 +1,178 @@
 package org.asamk.signal.commands;
 
 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 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 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.OutputWriter;
+import org.asamk.signal.PlainTextWriter;

 import org.asamk.signal.ReceiveMessageHandler;
 import org.asamk.signal.ReceiveMessageHandler;

+import org.asamk.signal.commands.exceptions.CommandException;
+import org.asamk.signal.commands.exceptions.IOErrorException;
+import org.asamk.signal.commands.exceptions.UnexpectedErrorException;

 import org.asamk.signal.json.JsonMessageEnvelope;
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.util.DateUtils;
 import org.asamk.signal.json.JsonMessageEnvelope;
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.util.DateUtils;

+import org.freedesktop.dbus.DBusMap;

 import org.freedesktop.dbus.connections.impl.DBusConnection;
 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.connections.impl.DBusConnection;
 import org.freedesktop.dbus.exceptions.DBusException;

+import org.freedesktop.dbus.types.Variant;

 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.util.Base64;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.util.Base64;

+import java.util.List;
+import java.util.Map;

 import java.util.concurrent.TimeUnit;
 
 import java.util.concurrent.TimeUnit;
 

-import static org.asamk.signal.util.ErrorUtils.handleAssertionError;
-

 public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
 
 public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
 

-    // TODO delete later when "json" variable is removed

     private final static 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) {
     @Override
     public void attachToSubparser(final Subparser subparser) {

+        subparser.help("Query the server for new messages.");

         subparser.addArgument("-t", "--timeout")
                 .type(double.class)
         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("--ignore-attachments")
                 .help("Don’t download attachments of received messages.")
                 .action(Arguments.storeTrue());
                 .help("Number of seconds to wait for new messages (negative values disable timeout)");
         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.")
-                .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<OutputType> 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;
-        }
+    public void handleCommand(
+            final Namespace ns, final Signal signal, DBusConnection dbusconnection, final OutputWriter outputWriter
+    ) throws CommandException {

         try {
         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 (outputWriter instanceof JsonWriter jsonWriter) {
+
+                dbusconnection.addSigHandler(Signal.MessageReceived.class, signal, messageReceived -> {
+                    var envelope = JsonMessageEnvelope.from(messageReceived);
+                    final var object = Map.of("envelope", envelope);
+                    jsonWriter.write(object);
+                });
+
+                dbusconnection.addSigHandler(Signal.ReceiptReceived.class, signal, receiptReceived -> {
+                    var envelope = JsonMessageEnvelope.from(receiptReceived);
+                    final var object = Map.of("envelope", envelope);
+                    jsonWriter.write(object);
+                });
+
+                dbusconnection.addSigHandler(Signal.SyncMessageReceived.class, signal, syncReceived -> {
+                    var envelope = JsonMessageEnvelope.from(syncReceived);
+                    final var object = Map.of("envelope", envelope);
+                    jsonWriter.write(object);
+                });
+            } else {
+                final var writer = (PlainTextWriter) outputWriter;
+
+                dbusconnection.addSigHandler(Signal.MessageReceivedV2.class, signal, messageReceived -> {
+                    writer.println("Envelope from: {}", messageReceived.getSender());
+                    writer.println("Timestamp: {}", DateUtils.formatTimestamp(messageReceived.getTimestamp()));
+                    writer.println("Body: {}", messageReceived.getMessage());

                     if (messageReceived.getGroupId().length > 0) {
                     if (messageReceived.getGroupId().length > 0) {

-                        System.out.println("Group info:");
-                        System.out.println("  Id: " + Base64.getEncoder().encodeToString(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();
+                        writer.println("Group info:");
+                        writer.indentedWriter()
+                                .println("Id: {}", Base64.getEncoder().encodeToString(messageReceived.getGroupId()));

                     }
                     }

-                } else {
-                    System.out.print(String.format("Sync Envelope from: %s to: %s\nTimestamp: %s\nBody: %s\n",
+                    final var extras = messageReceived.getExtras();
+                    printMessageExtras(writer, extras);
+                    writer.println();
+                });
+
+                dbusconnection.addSigHandler(Signal.ReceiptReceivedV2.class, signal, receiptReceived -> {
+                    writer.println("Receipt from: {}", receiptReceived.getSender());
+                    writer.println("Timestamp: {}", DateUtils.formatTimestamp(receiptReceived.getTimestamp()));
+                    writer.println("Type: {}", receiptReceived.getReceiptType());
+                });
+
+                dbusconnection.addSigHandler(Signal.SyncMessageReceivedV2.class, signal, syncReceived -> {
+                    writer.println("Sync Envelope from: {} to: {}",

                             syncReceived.getSource(),
                             syncReceived.getSource(),

-                            syncReceived.getDestination(),
-                            DateUtils.formatTimestamp(syncReceived.getTimestamp()),
-                            syncReceived.getMessage()));
+                            syncReceived.getDestination());
+                    writer.println("Timestamp: {}", DateUtils.formatTimestamp(syncReceived.getTimestamp()));
+                    writer.println("Body: {}", syncReceived.getMessage());

                     if (syncReceived.getGroupId().length > 0) {
                     if (syncReceived.getGroupId().length > 0) {

-                        System.out.println("Group info:");
-                        System.out.println("  Id: " + Base64.getEncoder().encodeToString(syncReceived.getGroupId()));
+                        writer.println("Group info:");
+                        writer.indentedWriter()
+                                .println("Id: {}", Base64.getEncoder().encodeToString(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;
+                    final var extras = syncReceived.getExtras();
+                    printMessageExtras(writer, extras);
+                    writer.println();
+                });
+            }

         } catch (DBusException e) {
         } catch (DBusException e) {

-            e.printStackTrace();
-            return 1;
+            logger.error("Dbus client failed", e);
+            throw new UnexpectedErrorException("Dbus client failed", e);

         }
         }

+
+        double timeout = ns.getDouble("timeout");
+        long timeoutMilliseconds = timeout < 0 ? 10000 : (long) (timeout * 1000);
+

         while (true) {
             try {
         while (true) {
             try {

-                Thread.sleep(10000);
-            } catch (InterruptedException e) {
-                return 0;
+                Thread.sleep(timeoutMilliseconds);
+            } catch (InterruptedException ignored) {
+                break;
+            }
+            if (timeout >= 0) {
+                break;

             }
         }
     }
 
             }
         }
     }
 

-    @Override
-    public int handleCommand(final Namespace ns, final Manager m) {
-        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.");
+    private void printMessageExtras(final PlainTextWriter writer, final Map<String, Variant<?>> extras) {
+        if (extras.containsKey("attachments")) {
+            final List<DBusMap<String, Variant<?>>> attachments = getValue(extras, "attachments");
+            if (attachments.size() > 0) {
+                writer.println("Attachments:");
+                for (var attachment : attachments) {
+                    final String value = getValue(attachment, "file");
+                    writer.println("- Stored plaintext in: {}", value);
+                }
+            }

         }
         }

+    }

 
 

-        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");
+    @SuppressWarnings("unchecked")
+    private <T> T getValue(final Map<String, Variant<?>> stringVariantMap, final String field) {
+        return (T) stringVariantMap.get(field).getValue();
+    }
+
+    @Override
+    public void handleCommand(
+            final Namespace ns, final Manager m, final OutputWriter outputWriter
+    ) throws CommandException {
+        double timeout = ns.getDouble("timeout");
+        boolean ignoreAttachments = Boolean.TRUE.equals(ns.getBoolean("ignore-attachments"));
+        m.setIgnoreAttachments(ignoreAttachments);

         try {
         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 handler = outputWriter instanceof JsonWriter ? new JsonReceiveMessageHandler(m,
+                    (JsonWriter) outputWriter) : new ReceiveMessageHandler(m, (PlainTextWriter) outputWriter);
+            if (timeout < 0) {
+                m.receiveMessages(handler);
+            } else {
+                m.receiveMessages((long) (timeout * 1000), TimeUnit.MILLISECONDS, handler);
+            }

         } catch (IOException e) {
         } 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);

         }
     }
 }
         }
     }
 }