nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/App.java

   1 package org.asamk.signal;
   2
   3 import net.sourceforge.argparse4j.ArgumentParsers;
   4 import net.sourceforge.argparse4j.impl.Arguments;
   5 import net.sourceforge.argparse4j.inf.ArgumentParser;
   6 import net.sourceforge.argparse4j.inf.Namespace;
   7
   8 import org.asamk.signal.commands.Command;
   9 import org.asamk.signal.commands.CommandHandler;
  10 import org.asamk.signal.commands.Commands;
  11 import org.asamk.signal.commands.LocalCommand;
  12 import org.asamk.signal.commands.MultiLocalCommand;
  13 import org.asamk.signal.commands.ProvisioningCommand;
  14 import org.asamk.signal.commands.RegistrationCommand;
  15 import org.asamk.signal.commands.exceptions.CommandException;
  16 import org.asamk.signal.commands.exceptions.IOErrorException;
  17 import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
  18 import org.asamk.signal.commands.exceptions.UserErrorException;
  19 import org.asamk.signal.dbus.DbusCommandHandler;
  20 import org.asamk.signal.manager.Manager;
  21 import org.asamk.signal.manager.RegistrationManager;
  22 import org.asamk.signal.manager.Settings;
  23 import org.asamk.signal.manager.SignalAccountFiles;
  24 import org.asamk.signal.manager.api.AccountCheckException;
  25 import org.asamk.signal.manager.api.NotRegisteredException;
  26 import org.asamk.signal.manager.api.ServiceEnvironment;
  27 import org.asamk.signal.manager.api.TrustNewIdentity;
  28 import org.asamk.signal.output.JsonWriterImpl;
  29 import org.asamk.signal.output.OutputWriter;
  30 import org.asamk.signal.output.PlainTextWriterImpl;
  31 import org.asamk.signal.util.IOUtils;
  32 import org.freedesktop.dbus.connections.impl.DBusConnection;
  33 import org.freedesktop.dbus.connections.impl.DBusConnectionBuilder;
  34 import org.freedesktop.dbus.errors.ServiceUnknown;
  35 import org.freedesktop.dbus.exceptions.DBusException;
  36 import org.freedesktop.dbus.exceptions.DBusExecutionException;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 import java.io.BufferedWriter;
  41 import java.io.File;
  42 import java.io.IOException;
  43 import java.io.OutputStreamWriter;
  44 import java.util.Set;
  45
  46 import static net.sourceforge.argparse4j.DefaultSettings.VERSION_0_9_0_DEFAULT_SETTINGS;
  47
  48 public class App {
  49
  50     private final static Logger logger = LoggerFactory.getLogger(App.class);
  51
  52     private final Namespace ns;
  53
  54     static ArgumentParser buildArgumentParser() {
  55         var parser = ArgumentParsers.newFor("signal-cli", VERSION_0_9_0_DEFAULT_SETTINGS)
  56                 .includeArgumentNamesAsKeysInResult(true)
  57                 .build()
  58                 .defaultHelp(true)
  59                 .description("Commandline interface for Signal.")
  60                 .version(BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
  61
  62         parser.addArgument("--version").help("Show package version.").action(Arguments.version());
  63         parser.addArgument("-v", "--verbose")
  64                 .help("Raise log level and include lib signal logs. Specify multiple times for even more logs.")
  65                 .action(Arguments.count());
  66         parser.addArgument("--log-file")
  67                 .type(File.class)
  68                 .help("Write log output to the given file. If --verbose is also given, the detailed logs will only be written to the log file.");
  69         parser.addArgument("--scrub-log")
  70                 .action(Arguments.storeTrue())
  71                 .help("Scrub possibly sensitive information from the log, like phone numbers and UUIDs.");
  72         parser.addArgument("-c", "--config")
  73                 .help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli).");
  74
  75         parser.addArgument("-a", "--account", "-u", "--username")
  76                 .help("Specify your phone number, that will be your identifier.");
  77
  78         var mut = parser.addMutuallyExclusiveGroup();
  79         mut.addArgument("--dbus").dest("global-dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
  80         mut.addArgument("--dbus-system")
  81                 .dest("global-dbus-system")
  82                 .help("Make request via system dbus.")
  83                 .action(Arguments.storeTrue());
  84
  85         parser.addArgument("-o", "--output")
  86                 .help("Choose to output in plain text or JSON")
  87                 .type(Arguments.enumStringType(OutputType.class));
  88
  89         parser.addArgument("--service-environment")
  90                 .help("Choose the server environment to use.")
  91                 .type(Arguments.enumStringType(ServiceEnvironmentCli.class))
  92                 .setDefault(ServiceEnvironmentCli.LIVE);
  93
  94         parser.addArgument("--trust-new-identities")
  95                 .help("Choose when to trust new identities.")
  96                 .type(Arguments.enumStringType(TrustNewIdentityCli.class))
  97                 .setDefault(TrustNewIdentityCli.ON_FIRST_USE);
  98
  99         parser.addArgument("--disable-send-log")
 100                 .help("Disable message send log (for resending messages that recipient couldn't decrypt)")
 101                 .action(Arguments.storeTrue());
 102
 103         var subparsers = parser.addSubparsers().title("subcommands").dest("command");
 104
 105         Commands.getCommandSubparserAttachers().forEach((key, value) -> {
 106             var subparser = subparsers.addParser(key);
 107             value.attachToSubparser(subparser);
 108         });
 109
 110         return parser;
 111     }
 112
 113     public App(final Namespace ns) {
 114         this.ns = ns;
 115     }
 116
 117     public void init() throws CommandException {
 118         logger.debug("Starting {}", BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
 119         var commandKey = ns.getString("command");
 120         var command = Commands.getCommand(commandKey);
 121         if (command == null) {
 122             throw new UserErrorException("Command not implemented!");
 123         }
 124
 125         final var outputWriter = getOutputWriter(command);
 126         final var commandHandler = new CommandHandler(ns, outputWriter);
 127
 128         var account = ns.getString("account");
 129
 130         final var useDbus = Boolean.TRUE.equals(ns.getBoolean("global-dbus"));
 131         final var useDbusSystem = Boolean.TRUE.equals(ns.getBoolean("global-dbus-system"));
 132         if (useDbus || useDbusSystem) {
 133             // If account is null, it will connect to the default object path
 134             initDbusClient(command, account, useDbusSystem, commandHandler);
 135             return;
 136         }
 137
 138         if (!Manager.isSignalClientAvailable()) {
 139             throw new UserErrorException("Missing required native library dependency: libsignal-client");
 140         }
 141
 142         final var signalAccountFiles = loadSignalAccountFiles();
 143
 144         handleCommand(command, commandHandler, account, signalAccountFiles);
 145     }
 146
 147     private void handleCommand(
 148             final Command command,
 149             final CommandHandler commandHandler,
 150             String account,
 151             final SignalAccountFiles signalAccountFiles
 152     ) throws CommandException {
 153         if (command instanceof ProvisioningCommand provisioningCommand) {
 154             if (account != null) {
 155                 throw new UserErrorException("You cannot specify a account (phone number) when linking");
 156             }
 157
 158             handleProvisioningCommand(provisioningCommand, signalAccountFiles, commandHandler);
 159             return;
 160         }
 161
 162         if (account == null) {
 163             if (command instanceof MultiLocalCommand multiLocalCommand) {
 164                 handleMultiLocalCommand(multiLocalCommand, signalAccountFiles, commandHandler);
 165                 return;
 166             }
 167
 168             Set<String> accounts;
 169             try {
 170                 accounts = signalAccountFiles.getAllLocalAccountNumbers();
 171             } catch (IOException e) {
 172                 throw new IOErrorException("Failed to load local accounts file", e);
 173             }
 174             if (accounts.size() == 0) {
 175                 throw new UserErrorException("No local users found, you first need to register or link an account");
 176             } else if (accounts.size() > 1) {
 177                 throw new UserErrorException(
 178                         "Multiple users found, you need to specify an account (phone number) with -a");
 179             }
 180
 181             account = accounts.stream().findFirst().get();
 182         } else if (!Manager.isValidNumber(account, null)) {
 183             throw new UserErrorException("Invalid account (phone number), make sure you include the country code.");
 184         }
 185
 186         if (command instanceof RegistrationCommand registrationCommand) {
 187             handleRegistrationCommand(registrationCommand, account, signalAccountFiles, commandHandler);
 188             return;
 189         }
 190
 191         if (command instanceof LocalCommand localCommand) {
 192             handleLocalCommand(localCommand, account, signalAccountFiles, commandHandler);
 193         }
 194
 195         throw new UserErrorException("Command only works in multi-account mode");
 196     }
 197
 198     private OutputWriter getOutputWriter(final Command command) throws UserErrorException {
 199         final var outputTypeInput = ns.<OutputType>get("output");
 200         final var outputType = outputTypeInput == null ? command.getSupportedOutputTypes()
 201                 .stream()
 202                 .findFirst()
 203                 .orElse(null) : outputTypeInput;
 204         final var writer = new BufferedWriter(new OutputStreamWriter(System.out, IOUtils.getConsoleCharset()));
 205         final var outputWriter = outputType == null
 206                 ? null
 207                 : outputType == OutputType.JSON ? new JsonWriterImpl(writer) : new PlainTextWriterImpl(writer);
 208
 209         if (outputWriter != null && !command.getSupportedOutputTypes().contains(outputType)) {
 210             throw new UserErrorException("Command doesn't support output type " + outputType);
 211         }
 212         return outputWriter;
 213     }
 214
 215     private SignalAccountFiles loadSignalAccountFiles() throws IOErrorException {
 216         final File configPath;
 217         final var config = ns.getString("config");
 218         if (config != null) {
 219             configPath = new File(config);
 220         } else {
 221             configPath = getDefaultConfigPath();
 222         }
 223
 224         final var serviceEnvironmentCli = ns.<ServiceEnvironmentCli>get("service-environment");
 225         final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE
 226                 ? ServiceEnvironment.LIVE
 227                 : ServiceEnvironment.STAGING;
 228
 229         final var trustNewIdentityCli = ns.<TrustNewIdentityCli>get("trust-new-identities");
 230         final var trustNewIdentity = trustNewIdentityCli == TrustNewIdentityCli.ON_FIRST_USE
 231                 ? TrustNewIdentity.ON_FIRST_USE
 232                 : trustNewIdentityCli == TrustNewIdentityCli.ALWAYS ? TrustNewIdentity.ALWAYS : TrustNewIdentity.NEVER;
 233
 234         final var disableSendLog = Boolean.TRUE.equals(ns.getBoolean("disable-send-log"));
 235
 236         try {
 237             return new SignalAccountFiles(configPath,
 238                     serviceEnvironment,
 239                     BaseConfig.USER_AGENT,
 240                     new Settings(trustNewIdentity, disableSendLog));
 241         } catch (IOException e) {
 242             throw new IOErrorException("Failed to read local accounts list", e);
 243         }
 244     }
 245
 246     private void handleProvisioningCommand(
 247             final ProvisioningCommand command,
 248             final SignalAccountFiles signalAccountFiles,
 249             final CommandHandler commandHandler
 250     ) throws CommandException {
 251         var pm = signalAccountFiles.initProvisioningManager();
 252         commandHandler.handleProvisioningCommand(command, pm);
 253     }
 254
 255     private void handleRegistrationCommand(
 256             final RegistrationCommand command,
 257             final String account,
 258             final SignalAccountFiles signalAccountFiles,
 259             final CommandHandler commandHandler
 260     ) throws CommandException {
 261         try (final var rm = loadRegistrationManager(account, signalAccountFiles)) {
 262             commandHandler.handleRegistrationCommand(command, rm);
 263         } catch (IOException e) {
 264             logger.warn("Cleanup failed", e);
 265         }
 266     }
 267
 268     private void handleLocalCommand(
 269             final LocalCommand command,
 270             final String account,
 271             final SignalAccountFiles signalAccountFiles,
 272             final CommandHandler commandHandler
 273     ) throws CommandException {
 274         try (var m = loadManager(account, signalAccountFiles)) {
 275             commandHandler.handleLocalCommand(command, m);
 276         } catch (IOException e) {
 277             logger.warn("Cleanup failed", e);
 278         }
 279     }
 280
 281     private void handleMultiLocalCommand(
 282             final MultiLocalCommand command,
 283             final SignalAccountFiles signalAccountFiles,
 284             final CommandHandler commandHandler
 285     ) throws CommandException {
 286         try (var multiAccountManager = signalAccountFiles.initMultiAccountManager()) {
 287             commandHandler.handleMultiLocalCommand(command, multiAccountManager);
 288         } catch (IOException e) {
 289             throw new IOErrorException("Failed to load local accounts file", e);
 290         }
 291     }
 292
 293     private RegistrationManager loadRegistrationManager(
 294             final String account, final SignalAccountFiles signalAccountFiles
 295     ) throws UnexpectedErrorException {
 296         try {
 297             return signalAccountFiles.initRegistrationManager(account);
 298         } catch (Throwable e) {
 299             throw new UnexpectedErrorException("Error loading or creating state file: "
 300                     + e.getMessage()
 301                     + " ("
 302                     + e.getClass().getSimpleName()
 303                     + ")", e);
 304         }
 305     }
 306
 307     private Manager loadManager(
 308             final String account, final SignalAccountFiles signalAccountFiles
 309     ) throws CommandException {
 310         logger.trace("Loading account file for {}", account);
 311         try {
 312             return signalAccountFiles.initManager(account);
 313         } catch (NotRegisteredException e) {
 314             throw new UserErrorException("User " + account + " is not registered.");
 315         } catch (AccountCheckException ace) {
 316             if (ace.getCause() instanceof IOException e) {
 317                 throw new IOErrorException("Error while checking account " + account + ": " + e.getMessage(), e);
 318             } else {
 319                 throw new UnexpectedErrorException("Error while checking account " + account + ": " + ace.getMessage(),
 320                         ace);
 321             }
 322         } catch (Throwable e) {
 323             throw new UnexpectedErrorException("Error loading state file for user "
 324                     + account
 325                     + ": "
 326                     + e.getMessage()
 327                     + " ("
 328                     + e.getClass().getSimpleName()
 329                     + ")", e);
 330         }
 331     }
 332
 333     private void initDbusClient(
 334             final Command command, final String account, final boolean systemBus, final CommandHandler commandHandler
 335     ) throws CommandException {
 336         try {
 337             final var busType = systemBus ? DBusConnection.DBusBusType.SYSTEM : DBusConnection.DBusBusType.SESSION;
 338             try (var dBusConn = DBusConnectionBuilder.forType(busType).build()) {
 339                 DbusCommandHandler.handleCommand(command, account, dBusConn, commandHandler);
 340             }
 341         } catch (ServiceUnknown e) {
 342             throw new UserErrorException("signal-cli DBus daemon not running on "
 343                     + (systemBus ? "system" : "session")
 344                     + " bus: "
 345                     + e.getMessage(), e);
 346         } catch (DBusExecutionException | DBusException | IOException e) {
 347             throw new UnexpectedErrorException("Dbus client failed: " + e.getMessage(), e);
 348         }
 349     }
 350
 351     /**
 352      * @return the default data directory to be used by signal-cli.
 353      */
 354     private static File getDefaultConfigPath() {
 355         return new File(IOUtils.getDataHomeDir(), "signal-cli");
 356     }
 357 }