]> nmode's Git Repositories - signal-cli/blobdiff - src/main/java/org/asamk/signal/App.java
Refactor ReceiveCommand in dbus mode and remove ExtendedDbusCommand
[signal-cli] / src / main / java / org / asamk / signal / App.java
index 5f0f1cdfb40aa9735d9a434c4652f523dc737cdc..720a58499e9c12accc64ee329781704b3c865749 100644 (file)
@@ -8,30 +8,36 @@ import net.sourceforge.argparse4j.inf.Namespace;
 import org.asamk.Signal;
 import org.asamk.signal.commands.Command;
 import org.asamk.signal.commands.Commands;
-import org.asamk.signal.commands.DbusCommand;
-import org.asamk.signal.commands.ExtendedDbusCommand;
 import org.asamk.signal.commands.LocalCommand;
 import org.asamk.signal.commands.MultiLocalCommand;
 import org.asamk.signal.commands.ProvisioningCommand;
 import org.asamk.signal.commands.RegistrationCommand;
+import org.asamk.signal.commands.SignalCreator;
+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.commands.exceptions.UserErrorException;
+import org.asamk.signal.dbus.DbusManagerImpl;
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.NotRegisteredException;
 import org.asamk.signal.manager.ProvisioningManager;
 import org.asamk.signal.manager.RegistrationManager;
 import org.asamk.signal.manager.config.ServiceConfig;
 import org.asamk.signal.manager.config.ServiceEnvironment;
+import org.asamk.signal.manager.storage.identities.TrustNewIdentity;
 import org.asamk.signal.util.IOUtils;
 import org.freedesktop.dbus.connections.impl.DBusConnection;
 import org.freedesktop.dbus.exceptions.DBusException;
+import org.freedesktop.dbus.exceptions.DBusExecutionException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.List;
-import java.util.Objects;
-import java.util.stream.Collectors;
+
+import static net.sourceforge.argparse4j.DefaultSettings.VERSION_0_9_0_DEFAULT_SETTINGS;
 
 public class App {
 
@@ -40,7 +46,8 @@ public class App {
     private final Namespace ns;
 
     static ArgumentParser buildArgumentParser() {
-        var parser = ArgumentParsers.newFor("signal-cli")
+        var parser = ArgumentParsers.newFor("signal-cli", VERSION_0_9_0_DEFAULT_SETTINGS)
+                .includeArgumentNamesAsKeysInResult(true)
                 .build()
                 .defaultHelp(true)
                 .description("Commandline interface for Signal.")
@@ -53,7 +60,7 @@ public class App {
         parser.addArgument("--config")
                 .help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli).");
 
-        parser.addArgument("-u", "--username").help("Specify your phone number, that will be used for verification.");
+        parser.addArgument("-u", "--username").help("Specify your phone number, that will be your identifier.");
 
         var mut = parser.addMutuallyExclusiveGroup();
         mut.addArgument("--dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
@@ -61,16 +68,24 @@ public class App {
 
         parser.addArgument("-o", "--output")
                 .help("Choose to output in plain text or JSON")
-                .type(Arguments.enumStringType(OutputType.class))
-                .setDefault(OutputType.PLAIN_TEXT);
+                .type(Arguments.enumStringType(OutputType.class));
+
+        parser.addArgument("--service-environment")
+                .help("Choose the server environment to use.")
+                .type(Arguments.enumStringType(ServiceEnvironmentCli.class))
+                .setDefault(ServiceEnvironmentCli.LIVE);
+
+        parser.addArgument("--trust-new-identities")
+                .help("Choose when to trust new identities.")
+                .type(Arguments.enumStringType(TrustNewIdentityCli.class))
+                .setDefault(TrustNewIdentityCli.ON_FIRST_USE);
 
         var subparsers = parser.addSubparsers().title("subcommands").dest("command");
 
-        final var commands = Commands.getCommands();
-        for (var entry : commands.entrySet()) {
-            var subparser = subparsers.addParser(entry.getKey());
-            entry.getValue().attachToSubparser(subparser);
-        }
+        Commands.getCommandSubparserAttachers().forEach((key, value) -> {
+            var subparser = subparsers.addParser(key);
+            value.attachToSubparser(subparser);
+        });
 
         return parser;
     }
@@ -79,27 +94,33 @@ public class App {
         this.ns = ns;
     }
 
-    public int init() {
+    public void init() throws CommandException {
         var commandKey = ns.getString("command");
         var command = Commands.getCommand(commandKey);
         if (command == null) {
-            logger.error("Command not implemented!");
-            return 1;
+            throw new UserErrorException("Command not implemented!");
         }
 
-        OutputType outputType = ns.get("output");
-        if (!command.getSupportedOutputTypes().contains(outputType)) {
-            logger.error("Command doesn't support output type {}", outputType.toString());
-            return 1;
+        var outputTypeInput = ns.<OutputType>get("output");
+        var outputType = outputTypeInput == null
+                ? command.getSupportedOutputTypes().stream().findFirst().orElse(null)
+                : outputTypeInput;
+        var outputWriter = outputType == null
+                ? null
+                : outputType == OutputType.JSON ? new JsonWriterImpl(System.out) : new PlainTextWriterImpl(System.out);
+
+        if (outputWriter != null && !command.getSupportedOutputTypes().contains(outputType)) {
+            throw new UserErrorException("Command doesn't support output type " + outputType);
         }
 
         var username = ns.getString("username");
 
-        final boolean useDbus = ns.getBoolean("dbus");
-        final boolean useDbusSystem = ns.getBoolean("dbus_system");
+        final var useDbus = Boolean.TRUE.equals(ns.getBoolean("dbus"));
+        final var useDbusSystem = Boolean.TRUE.equals(ns.getBoolean("dbus-system"));
         if (useDbus || useDbusSystem) {
             // If username is null, it will connect to the default object path
-            return initDbusClient(command, username, useDbusSystem);
+            initDbusClient(command, username, useDbusSystem, outputWriter);
+            return;
         }
 
         final File dataPath;
@@ -110,119 +131,152 @@ public class App {
             dataPath = getDefaultDataPath();
         }
 
-        final var serviceEnvironment = ServiceEnvironment.LIVE;
-
-        if (!ServiceConfig.getCapabilities().isGv2()) {
+        if (!ServiceConfig.isZkgroupAvailable()) {
             logger.warn("WARNING: Support for new group V2 is disabled,"
                     + " because the required native library dependency is missing: libzkgroup");
         }
 
         if (!ServiceConfig.isSignalClientAvailable()) {
-            logger.error("Missing required native library dependency: libsignal-client");
-            return 1;
+            throw new UserErrorException("Missing required native library dependency: libsignal-client");
         }
 
-        if (command instanceof ProvisioningCommand) {
+        final var serviceEnvironmentCli = ns.<ServiceEnvironmentCli>get("service-environment");
+        final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE
+                ? ServiceEnvironment.LIVE
+                : ServiceEnvironment.SANDBOX;
+
+        final var trustNewIdentityCli = ns.<TrustNewIdentityCli>get("trust-new-identities");
+        final var trustNewIdentity = trustNewIdentityCli == TrustNewIdentityCli.ON_FIRST_USE
+                ? TrustNewIdentity.ON_FIRST_USE
+                : trustNewIdentityCli == TrustNewIdentityCli.ALWAYS ? TrustNewIdentity.ALWAYS : TrustNewIdentity.NEVER;
+
+        if (command instanceof ProvisioningCommand provisioningCommand) {
             if (username != null) {
-                System.err.println("You cannot specify a username (phone number) when linking");
-                return 1;
+                throw new UserErrorException("You cannot specify a username (phone number) when linking");
             }
 
-            return handleProvisioningCommand((ProvisioningCommand) command, dataPath, serviceEnvironment);
+            handleProvisioningCommand(provisioningCommand, dataPath, serviceEnvironment, outputWriter);
+            return;
         }
 
         if (username == null) {
-            var usernames = Manager.getAllLocalUsernames(dataPath);
-            if (usernames.size() == 0) {
-                System.err.println("No local users found, you first need to register or link an account");
-                return 1;
+            var usernames = Manager.getAllLocalNumbers(dataPath);
+
+            if (command instanceof MultiLocalCommand multiLocalCommand) {
+                handleMultiLocalCommand(multiLocalCommand,
+                        dataPath,
+                        serviceEnvironment,
+                        usernames,
+                        outputWriter,
+                        trustNewIdentity);
+                return;
             }
 
-            if (command instanceof MultiLocalCommand) {
-                return handleMultiLocalCommand((MultiLocalCommand) command, dataPath, serviceEnvironment, usernames);
-            }
-
-            if (usernames.size() > 1) {
-                System.err.println("Multiple users found, you need to specify a username (phone number) with -u");
-                return 1;
+            if (usernames.size() == 0) {
+                throw new UserErrorException("No local users found, you first need to register or link an account");
+            } else if (usernames.size() > 1) {
+                throw new UserErrorException(
+                        "Multiple users found, you need to specify a username (phone number) with -u");
             }
 
             username = usernames.get(0);
-        } else if (!PhoneNumberFormatter.isValidNumber(username, null)) {
-            System.err.println("Invalid username (phone number), make sure you include the country code.");
-            return 1;
+        } else if (!Manager.isValidNumber(username, null)) {
+            throw new UserErrorException("Invalid username (phone number), make sure you include the country code.");
         }
 
-        if (command instanceof RegistrationCommand) {
-            return handleRegistrationCommand((RegistrationCommand) command, username, dataPath, serviceEnvironment);
+        if (command instanceof RegistrationCommand registrationCommand) {
+            handleRegistrationCommand(registrationCommand, username, dataPath, serviceEnvironment);
+            return;
         }
 
         if (!(command instanceof LocalCommand)) {
-            System.err.println("Command only works via dbus");
-            return 1;
+            throw new UserErrorException("Command only works via dbus");
         }
 
-        return handleLocalCommand((LocalCommand) command, username, dataPath, serviceEnvironment);
+        handleLocalCommand((LocalCommand) command,
+                username,
+                dataPath,
+                serviceEnvironment,
+                outputWriter,
+                trustNewIdentity);
     }
 
-    private int handleProvisioningCommand(
-            final ProvisioningCommand command, final File dataPath, final ServiceEnvironment serviceEnvironment
-    ) {
+    private void handleProvisioningCommand(
+            final ProvisioningCommand command,
+            final File dataPath,
+            final ServiceEnvironment serviceEnvironment,
+            final OutputWriter outputWriter
+    ) throws CommandException {
         var pm = ProvisioningManager.init(dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
-        return command.handleCommand(ns, pm);
+        command.handleCommand(ns, pm, outputWriter);
     }
 
-    private int handleRegistrationCommand(
+    private void handleRegistrationCommand(
             final RegistrationCommand command,
             final String username,
             final File dataPath,
             final ServiceEnvironment serviceEnvironment
-    ) {
+    ) throws CommandException {
         final RegistrationManager manager;
         try {
             manager = RegistrationManager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
         } catch (Throwable e) {
-            logger.error("Error loading or creating state file: {}", e.getMessage());
-            return 2;
+            throw new UnexpectedErrorException("Error loading or creating state file: "
+                    + e.getMessage()
+                    + " ("
+                    + e.getClass().getSimpleName()
+                    + ")", e);
         }
         try (var m = manager) {
-            return command.handleCommand(ns, m);
+            command.handleCommand(ns, m);
         } catch (IOException e) {
-            logger.error("Cleanup failed", e);
-            return 2;
+            logger.warn("Cleanup failed", e);
         }
     }
 
-    private int handleLocalCommand(
+    private void handleLocalCommand(
             final LocalCommand command,
             final String username,
             final File dataPath,
-            final ServiceEnvironment serviceEnvironment
-    ) {
-        try (var m = loadManager(username, dataPath, serviceEnvironment)) {
-            if (m == null) {
-                return 2;
-            }
-
-            return command.handleCommand(ns, m);
+            final ServiceEnvironment serviceEnvironment,
+            final OutputWriter outputWriter,
+            final TrustNewIdentity trustNewIdentity
+    ) throws CommandException {
+        try (var m = loadManager(username, dataPath, serviceEnvironment, trustNewIdentity)) {
+            command.handleCommand(ns, m, outputWriter);
         } catch (IOException e) {
-            logger.error("Cleanup failed", e);
-            return 2;
+            logger.warn("Cleanup failed", e);
         }
     }
 
-    private int handleMultiLocalCommand(
+    private void handleMultiLocalCommand(
             final MultiLocalCommand command,
             final File dataPath,
             final ServiceEnvironment serviceEnvironment,
-            final List<String> usernames
-    ) {
-        final var managers = usernames.stream()
-                .map(u -> loadManager(u, dataPath, serviceEnvironment))
-                .filter(Objects::nonNull)
-                .collect(Collectors.toList());
+            final List<String> usernames,
+            final OutputWriter outputWriter,
+            final TrustNewIdentity trustNewIdentity
+    ) throws CommandException {
+        final var managers = new ArrayList<Manager>();
+        for (String u : usernames) {
+            try {
+                managers.add(loadManager(u, dataPath, serviceEnvironment, trustNewIdentity));
+            } catch (CommandException e) {
+                logger.warn("Ignoring {}: {}", u, e.getMessage());
+            }
+        }
 
-        var result = command.handleCommand(ns, managers);
+        command.handleCommand(ns, managers, new SignalCreator() {
+            @Override
+            public ProvisioningManager getNewProvisioningManager() {
+                return ProvisioningManager.init(dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
+            }
+
+            @Override
+            public RegistrationManager getNewRegistrationManager(String username) throws IOException {
+                return RegistrationManager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
+            }
+        }, outputWriter);
 
         for (var m : managers) {
             try {
@@ -231,34 +285,41 @@ public class App {
                 logger.warn("Cleanup failed", e);
             }
         }
-        return result;
     }
 
     private Manager loadManager(
-            final String username, final File dataPath, final ServiceEnvironment serviceEnvironment
-    ) {
+            final String username,
+            final File dataPath,
+            final ServiceEnvironment serviceEnvironment,
+            final TrustNewIdentity trustNewIdentity
+    ) throws CommandException {
         Manager manager;
         try {
-            manager = Manager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
+            manager = Manager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT, trustNewIdentity);
         } catch (NotRegisteredException e) {
-            logger.error("User " + username + " is not registered.");
-            return null;
+            throw new UserErrorException("User " + username + " is not registered.");
         } catch (Throwable e) {
-            logger.error("Error loading state file for user " + username + ": {}", e.getMessage());
-            return null;
+            throw new UnexpectedErrorException("Error loading state file for user "
+                    + username
+                    + ": "
+                    + e.getMessage()
+                    + " ("
+                    + e.getClass().getSimpleName()
+                    + ")", e);
         }
 
         try {
             manager.checkAccountState();
         } catch (IOException e) {
-            logger.error("Error while checking account " + username + ": {}", e.getMessage());
-            return null;
+            throw new IOErrorException("Error while checking account " + username + ": " + e.getMessage(), e);
         }
 
         return manager;
     }
 
-    private int initDbusClient(final Command command, final String username, final boolean systemBus) {
+    private void initDbusClient(
+            final Command command, final String username, final boolean systemBus, final OutputWriter outputWriter
+    ) throws CommandException {
         try {
             DBusConnection.DBusBusType busType;
             if (systemBus) {
@@ -271,50 +332,34 @@ public class App {
                         DbusConfig.getObjectPath(username),
                         Signal.class);
 
-                return handleCommand(command, ts, dBusConn);
+                handleCommand(command, ts, dBusConn, outputWriter);
             }
         } catch (DBusException | IOException e) {
             logger.error("Dbus client failed", e);
-            return 2;
+            throw new UnexpectedErrorException("Dbus client failed", e);
         }
     }
 
-    private int handleCommand(Command command, Signal ts, DBusConnection dBusConn) {
-        if (command instanceof ExtendedDbusCommand) {
-            return ((ExtendedDbusCommand) command).handleCommand(ns, ts, dBusConn);
-        } else if (command instanceof DbusCommand) {
-            return ((DbusCommand) command).handleCommand(ns, ts);
+    private void handleCommand(
+            Command command, Signal ts, DBusConnection dBusConn, OutputWriter outputWriter
+    ) throws CommandException {
+        if (command instanceof LocalCommand localCommand) {
+            try {
+                localCommand.handleCommand(ns, new DbusManagerImpl(ts, dBusConn), outputWriter);
+            } catch (UnsupportedOperationException e) {
+                throw new UserErrorException("Command is not yet implemented via dbus", e);
+            } catch (DBusExecutionException e) {
+                throw new UnexpectedErrorException(e.getMessage(), e);
+            }
         } else {
-            System.err.println("Command is not yet implemented via dbus");
-            return 1;
+            throw new UserErrorException("Command is not yet implemented via dbus");
         }
     }
 
     /**
-     * Uses $XDG_DATA_HOME/signal-cli if it exists, or if none of the legacy directories exist:
-     * - $HOME/.config/signal
-     * - $HOME/.config/textsecure
-     *
-     * @return the data directory to be used by signal-cli.
+     * @return the default data directory to be used by signal-cli.
      */
     private static File getDefaultDataPath() {
-        var dataPath = new File(IOUtils.getDataHomeDir(), "signal-cli");
-        if (dataPath.exists()) {
-            return dataPath;
-        }
-
-        var configPath = new File(System.getProperty("user.home"), ".config");
-
-        var legacySettingsPath = new File(configPath, "signal");
-        if (legacySettingsPath.exists()) {
-            return legacySettingsPath;
-        }
-
-        legacySettingsPath = new File(configPath, "textsecure");
-        if (legacySettingsPath.exists()) {
-            return legacySettingsPath;
-        }
-
-        return dataPath;
+        return new File(IOUtils.getDataHomeDir(), "signal-cli");
     }
 }