Add CommandException to abstract cli return codes for errors

[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 f85aea8b77857cd841d812639ecf10496ddc787f..8612a71b631d27a6d1632ef07b6cde58857e736e 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
+++ b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java
@@ -1,32 +1,38 @@
 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.PlainTextWriterImpl;

 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.DBusConnection;
+import org.freedesktop.dbus.connections.impl.DBusConnection;

 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusException;

-import org.whispersystems.util.Base64;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;

 
 import java.io.IOException;
 
 import java.io.IOException;

+import java.util.Base64;
+import java.util.Map;
+import java.util.Set;

 import java.util.concurrent.TimeUnit;
 
 import static org.asamk.signal.util.ErrorUtils.handleAssertionError;
 
 public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
 
 import java.util.concurrent.TimeUnit;
 
 import static org.asamk.signal.util.ErrorUtils.handleAssertionError;
 
 public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
 

+    private final static Logger logger = LoggerFactory.getLogger(ReceiveCommand.class);
+

     @Override
     public void attachToSubparser(final Subparser subparser) {
         subparser.addArgument("-t", "--timeout")
     @Override
     public void attachToSubparser(final Subparser subparser) {
         subparser.addArgument("-t", "--timeout")


@@ -36,135 +42,136 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand {
                 .help("Don’t download attachments of received messages.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--json")
                 .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.")
+                .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());
     }
 
                 .action(Arguments.storeTrue());
     }
 

-    public int handleCommand(final Namespace ns, final Signal signal, DBusConnection dbusconnection) {
-        final ObjectMapper jsonProcessor;
+    @Override
+    public Set<OutputType> getSupportedOutputTypes() {
+        return Set.of(OutputType.PLAIN_TEXT, OutputType.JSON);
+    }
+
+    public void handleCommand(
+            final Namespace ns, final Signal signal, DBusConnection dbusconnection
+    ) throws CommandException {
+        var inJson = ns.get("output") == OutputType.JSON || ns.getBoolean("json");
+
+        // TODO delete later when "json" variable is removed

         if (ns.getBoolean("json")) {
         if (ns.getBoolean("json")) {

-            jsonProcessor = new ObjectMapper();
-            jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); // disable autodetect
-            jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
-        } else {
-            jsonProcessor = null;
+            logger.warn("\"--json\" option has been deprecated, please use the global \"--output=json\" instead.");

         }
         }

+

         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 (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);
+                    jsonWriter.write(object);
+                });
+
+                dbusconnection.addSigHandler(Signal.ReceiptReceived.class, receiptReceived -> {
+                    var envelope = new JsonMessageEnvelope(receiptReceived);
+                    final var object = Map.of("envelope", envelope);
+                    jsonWriter.write(object);
+                });
+
+                dbusconnection.addSigHandler(Signal.SyncMessageReceived.class, syncReceived -> {
+                    var envelope = new JsonMessageEnvelope(syncReceived);
+                    final var object = Map.of("envelope", envelope);
+                    jsonWriter.write(object);
+                });
+            } else {
+                final var writer = new PlainTextWriterImpl(System.out);
+
+                dbusconnection.addSigHandler(Signal.MessageReceived.class, 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.encodeBytes(messageReceived.getGroupId()));
+                        writer.println("Group info:");
+                        writer.indentedWriter()
+                                .println("Id: {}", Base64.getEncoder().encodeToString(messageReceived.getGroupId()));

                     }
                     if (messageReceived.getAttachments().size() > 0) {
                     }
                     if (messageReceived.getAttachments().size() > 0) {

-                        System.out.println("Attachments: ");
-                        for (String attachment : messageReceived.getAttachments()) {
-                            System.out.println("-  Stored plaintext in: " + attachment);
+                        writer.println("Attachments:");
+                        for (var attachment : messageReceived.getAttachments()) {
+                            writer.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()));
+                    writer.println();
+                });
+
+                dbusconnection.addSigHandler(Signal.ReceiptReceived.class, receiptReceived -> {
+                    writer.println("Receipt from: {}", receiptReceived.getSender());
+                    writer.println("Timestamp: {}", DateUtils.formatTimestamp(receiptReceived.getTimestamp()));
+                });
+
+                dbusconnection.addSigHandler(Signal.SyncMessageReceived.class, syncReceived -> {
+                    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) {
                     if (syncReceived.getGroupId().length > 0) {

-                        System.out.println("Group info:");
-                        System.out.println("  Id: " + Base64.encodeBytes(syncReceived.getGroupId()));
+                        writer.println("Group info:");
+                        writer.indentedWriter()
+                                .println("Id: {}", Base64.getEncoder().encodeToString(syncReceived.getGroupId()));

                     }
                     if (syncReceived.getAttachments().size() > 0) {
                     }
                     if (syncReceived.getAttachments().size() > 0) {

-                        System.out.println("Attachments: ");
-                        for (String attachment : syncReceived.getAttachments()) {
-                            System.out.println("-  Stored plaintext in: " + attachment);
+                        writer.println("Attachments:");
+                        for (var attachment : syncReceived.getAttachments()) {
+                            writer.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;
+                    writer.println();
+                });
+            }

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

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

         }
         while (true) {
             try {
                 Thread.sleep(10000);
         }
         while (true) {
             try {
                 Thread.sleep(10000);

-            } catch (InterruptedException e) {
-                return 0;
+            } catch (InterruptedException ignored) {
+                return;

             }
         }
     }
 
     @Override
             }
         }
     }
 
     @Override

-    public int handleCommand(final Namespace ns, final Manager m) {
-        if (!m.isRegistered()) {
-            System.err.println("User is not registered.");
-            return 1;
+    public void handleCommand(final Namespace ns, final Manager m) throws CommandException {
+        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.");

         }
         }

+

         double timeout = 5;
         if (ns.getDouble("timeout") != null) {
             timeout = ns.getDouble("timeout");
         }
         double timeout = 5;
         if (ns.getDouble("timeout") != null) {
             timeout = ns.getDouble("timeout");
         }

-        boolean returnOnTimeout = true;
+        var returnOnTimeout = true;

         if (timeout < 0) {
             returnOnTimeout = false;
             timeout = 3600;
         }
         boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
         try {
         if (timeout < 0) {
             returnOnTimeout = false;
             timeout = 3600;
         }
         boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
         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 handler = inJson ? new JsonReceiveMessageHandler(m) : new ReceiveMessageHandler(m);
+            m.receiveMessages((long) (timeout * 1000),
+                    TimeUnit.MILLISECONDS,
+                    returnOnTimeout,
+                    ignoreAttachments,
+                    handler);

         } catch (IOException e) {
         } catch (IOException e) {

-            System.err.println("Error while receiving messages: " + e.getMessage());
-            return 3;
+            throw new IOErrorException("Error while receiving messages: " + e.getMessage());

         } catch (AssertionError e) {
             handleAssertionError(e);
         } catch (AssertionError e) {
             handleAssertionError(e);

-            return 1;
+            throw e;

         }
     }
 }
         }
     }
 }