]> nmode's Git Repositories - signal-cli/blobdiff - src/main/java/org/asamk/signal/App.java
Add option to disable adding message to send log
[signal-cli] / src / main / java / org / asamk / signal / App.java
index e97f28d91fd849a9d7475fa6762ab6086081e5fc..058ae6bb6936484ae588c8084e2a3a737c5de23a 100644 (file)
@@ -6,6 +6,7 @@ import net.sourceforge.argparse4j.inf.ArgumentParser;
 import net.sourceforge.argparse4j.inf.Namespace;
 
 import org.asamk.Signal;
+import org.asamk.SignalControl;
 import org.asamk.signal.commands.Command;
 import org.asamk.signal.commands.Commands;
 import org.asamk.signal.commands.LocalCommand;
@@ -17,11 +18,15 @@ 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.dbus.DbusMultiAccountManagerImpl;
+import org.asamk.signal.dbus.DbusProvisioningManagerImpl;
+import org.asamk.signal.dbus.DbusRegistrationManagerImpl;
 import org.asamk.signal.manager.Manager;
-import org.asamk.signal.manager.MultiAccountManagerImpl;
-import org.asamk.signal.manager.NotRegisteredException;
-import org.asamk.signal.manager.ProvisioningManager;
 import org.asamk.signal.manager.RegistrationManager;
+import org.asamk.signal.manager.Settings;
+import org.asamk.signal.manager.SignalAccountFiles;
+import org.asamk.signal.manager.api.AccountCheckException;
+import org.asamk.signal.manager.api.NotRegisteredException;
 import org.asamk.signal.manager.config.ServiceConfig;
 import org.asamk.signal.manager.config.ServiceEnvironment;
 import org.asamk.signal.manager.storage.identities.TrustNewIdentity;
@@ -30,6 +35,9 @@ import org.asamk.signal.output.OutputWriter;
 import org.asamk.signal.output.PlainTextWriterImpl;
 import org.asamk.signal.util.IOUtils;
 import org.freedesktop.dbus.connections.impl.DBusConnection;
+import org.freedesktop.dbus.connections.impl.DBusConnectionBuilder;
+import org.freedesktop.dbus.errors.ServiceUnknown;
+import org.freedesktop.dbus.errors.UnknownMethod;
 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusExecutionException;
 import org.slf4j.Logger;
@@ -39,9 +47,7 @@ import java.io.BufferedWriter;
 import java.io.File;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
-import java.nio.charset.Charset;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.Set;
 
 import static net.sourceforge.argparse4j.DefaultSettings.VERSION_0_9_0_DEFAULT_SETTINGS;
 
@@ -59,11 +65,17 @@ public class App {
                 .description("Commandline interface for Signal.")
                 .version(BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
 
-        parser.addArgument("-v", "--version").help("Show package version.").action(Arguments.version());
-        parser.addArgument("--verbose")
-                .help("Raise log level and include lib signal logs.")
-                .action(Arguments.storeTrue());
-        parser.addArgument("--config")
+        parser.addArgument("--version").help("Show package version.").action(Arguments.version());
+        parser.addArgument("-v", "--verbose")
+                .help("Raise log level and include lib signal logs. Specify multiple times for even more logs.")
+                .action(Arguments.count());
+        parser.addArgument("--log-file")
+                .type(File.class)
+                .help("Write log output to the given file. If --verbose is also given, the detailed logs will only be written to the log file.");
+        parser.addArgument("--scrub-log")
+                .action(Arguments.storeTrue())
+                .help("Scrub possibly sensitive information from the log, like phone numbers and UUIDs.");
+        parser.addArgument("-c", "--config")
                 .help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli).");
 
         parser.addArgument("-a", "--account", "-u", "--username")
@@ -90,6 +102,10 @@ public class App {
                 .type(Arguments.enumStringType(TrustNewIdentityCli.class))
                 .setDefault(TrustNewIdentityCli.ON_FIRST_USE);
 
+        parser.addArgument("--disable-send-log")
+                .help("Disable message send log (for resending messages that recipient couldn't decrypt)")
+                .action(Arguments.storeTrue());
+
         var subparsers = parser.addSubparsers().title("subcommands").dest("command");
 
         Commands.getCommandSubparserAttachers().forEach((key, value) -> {
@@ -115,7 +131,7 @@ public class App {
         var outputType = outputTypeInput == null
                 ? command.getSupportedOutputTypes().stream().findFirst().orElse(null)
                 : outputTypeInput;
-        var writer = new BufferedWriter(new OutputStreamWriter(System.out, Charset.defaultCharset()));
+        var writer = new BufferedWriter(new OutputStreamWriter(System.out, IOUtils.getConsoleCharset()));
         var outputWriter = outputType == null
                 ? null
                 : outputType == OutputType.JSON ? new JsonWriterImpl(writer) : new PlainTextWriterImpl(writer);
@@ -134,55 +150,61 @@ public class App {
             return;
         }
 
-        final File dataPath;
+        if (!ServiceConfig.isSignalClientAvailable()) {
+            throw new UserErrorException("Missing required native library dependency: libsignal-client");
+        }
+
+        final File configPath;
         var config = ns.getString("config");
         if (config != null) {
-            dataPath = new File(config);
+            configPath = new File(config);
         } else {
-            dataPath = getDefaultDataPath();
-        }
-
-        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()) {
-            throw new UserErrorException("Missing required native library dependency: libsignal-client");
+            configPath = getDefaultConfigPath();
         }
 
         final var serviceEnvironmentCli = ns.<ServiceEnvironmentCli>get("service-environment");
         final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE
                 ? ServiceEnvironment.LIVE
-                : ServiceEnvironment.SANDBOX;
+                : ServiceEnvironment.STAGING;
 
         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;
 
+        final var disableSendLog = Boolean.TRUE.equals(ns.getBoolean("disable-send-log"));
+
+        final SignalAccountFiles signalAccountFiles;
+        try {
+            signalAccountFiles = new SignalAccountFiles(configPath,
+                    serviceEnvironment,
+                    BaseConfig.USER_AGENT,
+                    new Settings(trustNewIdentity, disableSendLog));
+        } catch (IOException e) {
+            throw new IOErrorException("Failed to read local accounts list", e);
+        }
+
         if (command instanceof ProvisioningCommand provisioningCommand) {
             if (account != null) {
                 throw new UserErrorException("You cannot specify a account (phone number) when linking");
             }
 
-            handleProvisioningCommand(provisioningCommand, dataPath, serviceEnvironment, outputWriter);
+            handleProvisioningCommand(provisioningCommand, signalAccountFiles, outputWriter);
             return;
         }
 
         if (account == null) {
-            var accounts = Manager.getAllLocalAccountNumbers(dataPath);
-
             if (command instanceof MultiLocalCommand multiLocalCommand) {
-                handleMultiLocalCommand(multiLocalCommand,
-                        dataPath,
-                        serviceEnvironment,
-                        accounts,
-                        outputWriter,
-                        trustNewIdentity);
+                handleMultiLocalCommand(multiLocalCommand, signalAccountFiles, outputWriter);
                 return;
             }
 
+            Set<String> accounts = null;
+            try {
+                accounts = signalAccountFiles.getAllLocalAccountNumbers();
+            } catch (IOException e) {
+                throw new IOErrorException("Failed to load local accounts file", e);
+            }
             if (accounts.size() == 0) {
                 throw new UserErrorException("No local users found, you first need to register or link an account");
             } else if (accounts.size() > 1) {
@@ -190,112 +212,156 @@ public class App {
                         "Multiple users found, you need to specify an account (phone number) with -a");
             }
 
-            account = accounts.get(0);
+            account = accounts.stream().findFirst().get();
         } else if (!Manager.isValidNumber(account, null)) {
             throw new UserErrorException("Invalid account (phone number), make sure you include the country code.");
         }
 
         if (command instanceof RegistrationCommand registrationCommand) {
-            handleRegistrationCommand(registrationCommand, account, dataPath, serviceEnvironment);
+            handleRegistrationCommand(registrationCommand, account, signalAccountFiles);
             return;
         }
 
         if (!(command instanceof LocalCommand)) {
-            throw new UserErrorException("Command only works via dbus");
+            throw new UserErrorException("Command only works in multi-account mode");
         }
 
-        handleLocalCommand((LocalCommand) command,
-                account,
-                dataPath,
-                serviceEnvironment,
-                outputWriter,
-                trustNewIdentity);
+        handleLocalCommand((LocalCommand) command, account, signalAccountFiles, outputWriter);
     }
 
     private void handleProvisioningCommand(
             final ProvisioningCommand command,
-            final File dataPath,
-            final ServiceEnvironment serviceEnvironment,
+            final SignalAccountFiles signalAccountFiles,
             final OutputWriter outputWriter
     ) throws CommandException {
-        var pm = ProvisioningManager.init(dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
+        var pm = signalAccountFiles.initProvisioningManager();
         command.handleCommand(ns, pm, outputWriter);
     }
 
-    private void handleRegistrationCommand(
-            final RegistrationCommand command,
-            final String account,
-            final File dataPath,
-            final ServiceEnvironment serviceEnvironment
-    ) throws CommandException {
-        final RegistrationManager manager;
+    private void handleProvisioningCommand(
+            final ProvisioningCommand c, final DBusConnection dBusConn, final OutputWriter outputWriter
+    ) throws CommandException, DBusException {
+        final var signalControl = dBusConn.getRemoteObject(DbusConfig.getBusname(),
+                DbusConfig.getObjectPath(),
+                SignalControl.class);
+        final var provisioningManager = new DbusProvisioningManagerImpl(signalControl, dBusConn);
         try {
-            manager = RegistrationManager.init(account, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
-        } catch (Throwable e) {
-            throw new UnexpectedErrorException("Error loading or creating state file: "
-                    + e.getMessage()
-                    + " ("
-                    + e.getClass().getSimpleName()
-                    + ")", e);
+            c.handleCommand(ns, provisioningManager, outputWriter);
+        } catch (UnsupportedOperationException e) {
+            throw new UserErrorException("Command is not yet implemented via dbus", e);
+        } catch (DBusExecutionException e) {
+            throw new UnexpectedErrorException(e.getMessage(), e);
         }
-        try (manager) {
+    }
+
+    private void handleRegistrationCommand(
+            final RegistrationCommand command, final String account, final SignalAccountFiles signalAccountFiles
+    ) throws CommandException {
+        try (final var manager = loadRegistrationManager(account, signalAccountFiles)) {
             command.handleCommand(ns, manager);
         } catch (IOException e) {
             logger.warn("Cleanup failed", e);
         }
     }
 
+    private void handleRegistrationCommand(
+            final RegistrationCommand c, String account, final DBusConnection dBusConn, final OutputWriter outputWriter
+    ) throws CommandException, DBusException {
+        final var signalControl = dBusConn.getRemoteObject(DbusConfig.getBusname(),
+                DbusConfig.getObjectPath(),
+                SignalControl.class);
+        try (final var registrationManager = new DbusRegistrationManagerImpl(account, signalControl, dBusConn)) {
+            c.handleCommand(ns, registrationManager);
+        } catch (UnsupportedOperationException e) {
+            throw new UserErrorException("Command is not yet implemented via dbus", e);
+        } catch (DBusExecutionException e) {
+            throw new UnexpectedErrorException(e.getMessage(), e);
+        }
+    }
+
     private void handleLocalCommand(
             final LocalCommand command,
             final String account,
-            final File dataPath,
-            final ServiceEnvironment serviceEnvironment,
-            final OutputWriter outputWriter,
-            final TrustNewIdentity trustNewIdentity
+            final SignalAccountFiles signalAccountFiles,
+            final OutputWriter outputWriter
     ) throws CommandException {
-        try (var m = loadManager(account, dataPath, serviceEnvironment, trustNewIdentity)) {
+        try (var m = loadManager(account, signalAccountFiles)) {
             command.handleCommand(ns, m, outputWriter);
         } catch (IOException e) {
             logger.warn("Cleanup failed", e);
         }
     }
 
+    private void handleLocalCommand(
+            final LocalCommand c,
+            String accountObjectPath,
+            final DBusConnection dBusConn,
+            final OutputWriter outputWriter
+    ) throws CommandException, DBusException {
+        var signal = dBusConn.getRemoteObject(DbusConfig.getBusname(), accountObjectPath, Signal.class);
+        try (final var m = new DbusManagerImpl(signal, dBusConn)) {
+            c.handleCommand(ns, m, outputWriter);
+        } catch (UnsupportedOperationException e) {
+            throw new UserErrorException("Command is not yet implemented via dbus", e);
+        } catch (DBusExecutionException e) {
+            throw new UnexpectedErrorException(e.getMessage(), e);
+        }
+    }
+
     private void handleMultiLocalCommand(
             final MultiLocalCommand command,
-            final File dataPath,
-            final ServiceEnvironment serviceEnvironment,
-            final List<String> accounts,
-            final OutputWriter outputWriter,
-            final TrustNewIdentity trustNewIdentity
+            final SignalAccountFiles signalAccountFiles,
+            final OutputWriter outputWriter
     ) throws CommandException {
-        final var managers = new ArrayList<Manager>();
-        for (String a : accounts) {
-            try {
-                managers.add(loadManager(a, dataPath, serviceEnvironment, trustNewIdentity));
-            } catch (CommandException e) {
-                logger.warn("Ignoring {}: {}", a, e.getMessage());
-            }
+        try (var multiAccountManager = signalAccountFiles.initMultiAccountManager()) {
+            command.handleCommand(ns, multiAccountManager, outputWriter);
+        } catch (IOException e) {
+            throw new IOErrorException("Failed to load local accounts file", e);
         }
+    }
 
-        try (var multiAccountManager = new MultiAccountManagerImpl(managers,
-                dataPath,
-                serviceEnvironment,
-                BaseConfig.USER_AGENT)) {
-            command.handleCommand(ns, multiAccountManager, outputWriter);
+    private void handleMultiLocalCommand(
+            final MultiLocalCommand c, final DBusConnection dBusConn, final OutputWriter outputWriter
+    ) throws CommandException, DBusException {
+        final var signalControl = dBusConn.getRemoteObject(DbusConfig.getBusname(),
+                DbusConfig.getObjectPath(),
+                SignalControl.class);
+        try (final var multiAccountManager = new DbusMultiAccountManagerImpl(signalControl, dBusConn)) {
+            c.handleCommand(ns, multiAccountManager, outputWriter);
+        } catch (UnsupportedOperationException e) {
+            throw new UserErrorException("Command is not yet implemented via dbus", e);
+        }
+    }
+
+    private RegistrationManager loadRegistrationManager(
+            final String account, final SignalAccountFiles signalAccountFiles
+    ) throws UnexpectedErrorException {
+        try {
+            return signalAccountFiles.initRegistrationManager(account);
+        } catch (Throwable e) {
+            throw new UnexpectedErrorException("Error loading or creating state file: "
+                    + e.getMessage()
+                    + " ("
+                    + e.getClass().getSimpleName()
+                    + ")", e);
         }
     }
 
     private Manager loadManager(
-            final String account,
-            final File dataPath,
-            final ServiceEnvironment serviceEnvironment,
-            final TrustNewIdentity trustNewIdentity
+            final String account, final SignalAccountFiles signalAccountFiles
     ) throws CommandException {
-        Manager manager;
+        logger.trace("Loading account file for {}", account);
         try {
-            manager = Manager.init(account, dataPath, serviceEnvironment, BaseConfig.USER_AGENT, trustNewIdentity);
+            return signalAccountFiles.initManager(account);
         } catch (NotRegisteredException e) {
             throw new UserErrorException("User " + account + " is not registered.");
+        } catch (AccountCheckException ace) {
+            if (ace.getCause() instanceof IOException e) {
+                throw new IOErrorException("Error while checking account " + account + ": " + e.getMessage(), e);
+            } else {
+                throw new UnexpectedErrorException("Error while checking account " + account + ": " + ace.getMessage(),
+                        ace);
+            }
         } catch (Throwable e) {
             throw new UnexpectedErrorException("Error loading state file for user "
                     + account
@@ -305,19 +371,6 @@ public class App {
                     + e.getClass().getSimpleName()
                     + ")", e);
         }
-
-        try {
-            manager.checkAccountState();
-        } catch (IOException e) {
-            try {
-                manager.close();
-            } catch (IOException ie) {
-                logger.warn("Failed to close broken account", ie);
-            }
-            throw new IOErrorException("Error while checking account " + account + ": " + e.getMessage(), e);
-        }
-
-        return manager;
     }
 
     private void initDbusClient(
@@ -330,39 +383,68 @@ public class App {
             } else {
                 busType = DBusConnection.DBusBusType.SESSION;
             }
-            try (var dBusConn = DBusConnection.getConnection(busType)) {
-                var ts = dBusConn.getRemoteObject(DbusConfig.getBusname(),
-                        DbusConfig.getObjectPath(account),
-                        Signal.class);
-
-                handleCommand(command, ts, dBusConn, outputWriter);
+            try (var dBusConn = DBusConnectionBuilder.forType(busType).build()) {
+                if (command instanceof ProvisioningCommand c) {
+                    if (account != null) {
+                        throw new UserErrorException("You cannot specify a account (phone number) when linking");
+                    }
+
+                    handleProvisioningCommand(c, dBusConn, outputWriter);
+                    return;
+                }
+
+                if (account == null && command instanceof MultiLocalCommand c) {
+                    handleMultiLocalCommand(c, dBusConn, outputWriter);
+                    return;
+                }
+                if (account != null && command instanceof RegistrationCommand c) {
+                    handleRegistrationCommand(c, account, dBusConn, outputWriter);
+                    return;
+                }
+                if (!(command instanceof LocalCommand localCommand)) {
+                    throw new UserErrorException("Command only works in multi-account mode");
+                }
+
+                var accountObjectPath = account == null ? tryGetSingleAccountObjectPath(dBusConn) : null;
+                if (accountObjectPath == null) {
+                    accountObjectPath = DbusConfig.getObjectPath(account);
+                }
+                handleLocalCommand(localCommand, accountObjectPath, dBusConn, outputWriter);
             }
-        } catch (DBusException | IOException e) {
-            logger.error("Dbus client failed", e);
-            throw new UnexpectedErrorException("Dbus client failed", e);
+        } catch (ServiceUnknown e) {
+            throw new UserErrorException("signal-cli DBus daemon not running on "
+                    + (systemBus ? "system" : "session")
+                    + " bus: "
+                    + e.getMessage(), e);
+        } catch (DBusExecutionException | DBusException | IOException e) {
+            throw new UnexpectedErrorException("Dbus client failed: " + e.getMessage(), e);
         }
     }
 
-    private void handleCommand(
-            Command command, Signal ts, DBusConnection dBusConn, OutputWriter outputWriter
-    ) throws CommandException {
-        if (command instanceof LocalCommand localCommand) {
-            try (final var m = new DbusManagerImpl(ts, dBusConn)) {
-                localCommand.handleCommand(ns, m, outputWriter);
-            } catch (UnsupportedOperationException e) {
-                throw new UserErrorException("Command is not yet implemented via dbus", e);
-            } catch (IOException | DBusExecutionException e) {
-                throw new UnexpectedErrorException(e.getMessage(), e);
+    private String tryGetSingleAccountObjectPath(final DBusConnection dBusConn) throws DBusException, CommandException {
+        var control = dBusConn.getRemoteObject(DbusConfig.getBusname(),
+                DbusConfig.getObjectPath(),
+                SignalControl.class);
+        try {
+            final var accounts = control.listAccounts();
+            if (accounts.size() == 0) {
+                throw new UserErrorException("No local users found, you first need to register or link an account");
+            } else if (accounts.size() > 1) {
+                throw new UserErrorException(
+                        "Multiple users found, you need to specify an account (phone number) with -a");
             }
-        } else {
-            throw new UserErrorException("Command is not yet implemented via dbus");
+
+            return accounts.get(0).getPath();
+        } catch (UnknownMethod e) {
+            // dbus daemon not running in multi-account mode
+            return null;
         }
     }
 
     /**
      * @return the default data directory to be used by signal-cli.
      */
-    private static File getDefaultDataPath() {
+    private static File getDefaultConfigPath() {
         return new File(IOUtils.getDataHomeDir(), "signal-cli");
     }
 }