Improve command line help

[signal-cli] / src / main / java / org / asamk / signal / commands / GetUserStatusCommand.java

diff --git a/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java b/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
index c4bdf3d9febc432f2493dfe5a462f5b82eade7c5..e6fc7c65a82706aad87991d5e56bac66469bfe3a 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
+++ b/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java
@@ -1,87 +1,89 @@
 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.DeserializationFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 import net.sourceforge.argparse4j.impl.Arguments;
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 
+import org.asamk.signal.JsonWriter;
+import org.asamk.signal.OutputType;
+import org.asamk.signal.PlainTextWriterImpl;
+import org.asamk.signal.commands.exceptions.CommandException;
+import org.asamk.signal.commands.exceptions.IOErrorException;
 import org.asamk.signal.manager.Manager;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
-import java.util.ArrayList;
 import java.util.HashSet;
-import java.util.Set;
 import java.util.Map;
-import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 public class GetUserStatusCommand implements LocalCommand {
 
+    private final static Logger logger = LoggerFactory.getLogger(GetUserStatusCommand.class);
+
     @Override
     public void attachToSubparser(final Subparser subparser) {
-        subparser.addArgument("number").help("Phone number").nargs("+");
         subparser.help("Check if the specified phone number/s have been registered");
+        subparser.addArgument("number").help("Phone number").nargs("+");
         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());
     }
 
     @Override
-    public int handleCommand(final Namespace ns, final Manager m) {
-        if (!m.isRegistered()) {
-            System.err.println("User is not registered.");
-            return 1;
-        }
+    public Set<OutputType> getSupportedOutputTypes() {
+        return Set.of(OutputType.PLAIN_TEXT, OutputType.JSON);
+    }
 
+    @Override
+    public void handleCommand(final Namespace ns, final Manager m) throws CommandException {
         // Setup the json object mapper
-        ObjectMapper jsonProcessor = new ObjectMapper();
-        jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); // disable autodetect
-        jsonProcessor.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
-        jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
+        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.");
+        }
 
         // Get a map of registration statuses
         Map<String, Boolean> registered;
         try {
-            registered = m.areUsersRegistered(new HashSet<>(ns.<String>getList("number")));
+            registered = m.areUsersRegistered(new HashSet<>(ns.getList("number")));
         } catch (IOException e) {
-            System.err.println("Unable to check if users are registered");
-            return 1;
+            logger.debug("Failed to check registered users", e);
+            throw new IOErrorException("Unable to check if users are registered");
         }
 
         // Output
-        if (ns.getBoolean("json")) {
-            List<JsonIsRegistered> objects = new ArrayList<>();
-            for (Map.Entry<String, Boolean> entry : registered.entrySet()) {
-                objects.add(new JsonIsRegistered(entry.getKey(), entry.getValue()));
-            }
+        if (inJson) {
+            final var jsonWriter = new JsonWriter(System.out);
 
-            try {
-                System.out.println(jsonProcessor.writeValueAsString(objects));
-            } catch (IOException e) {
-                System.err.println(e.getMessage());
-            }
+            var jsonUserStatuses = registered.entrySet()
+                    .stream()
+                    .map(entry -> new JsonUserStatus(entry.getKey(), entry.getValue()))
+                    .collect(Collectors.toList());
 
+            jsonWriter.write(jsonUserStatuses);
         } else {
-            for (Map.Entry<String, Boolean> entry : registered.entrySet()) {
-                System.out.println(entry.getKey() + ": " + entry.getValue());
+            final var writer = new PlainTextWriterImpl(System.out);
+
+            for (var entry : registered.entrySet()) {
+                writer.println("{}: {}", entry.getKey(), entry.getValue());
             }
         }
-
-        return 0;
     }
 
-    private class JsonIsRegistered {
-        String name;
-        boolean isRegistered;
+    private static final class JsonUserStatus {
+
+        public String name;
 
-        public JsonIsRegistered(String name, boolean isRegistered) {
+        public boolean isRegistered;
+
+        public JsonUserStatus(String name, boolean isRegistered) {
             this.name = name;
             this.isRegistered = isRegistered;
         }
     }
-
 }