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             account = getAccountIfOnlyOne(signalAccountFiles);
 169         } else if (!Manager.isValidNumber(account, null)) {
 170             throw new UserErrorException("Invalid account (phone number), make sure you include the country code.");
 171         }
 172
 173         if (command instanceof RegistrationCommand registrationCommand) {
 174             handleRegistrationCommand(registrationCommand, account, signalAccountFiles, commandHandler);
 175             return;
 176         }
 177
 178         if (command instanceof LocalCommand localCommand) {
 179             handleLocalCommand(localCommand, account, signalAccountFiles, commandHandler);
 180             return;
 181         }
 182
 183         throw new UserErrorException("Command only works in multi-account mode");
 184     }
 185
 186     private static String getAccountIfOnlyOne(final SignalAccountFiles signalAccountFiles) throws IOErrorException, UserErrorException {
 187         Set<String> accounts;
 188         try {
 189             accounts = signalAccountFiles.getAllLocalAccountNumbers();
 190         } catch (IOException e) {
 191             throw new IOErrorException("Failed to load local accounts file", e);
 192         }
 193         if (accounts.isEmpty()) {
 194             throw new UserErrorException("No local users found, you first need to register or link an account");
 195         } else if (accounts.size() > 1) {
 196             throw new UserErrorException("Multiple users found, you need to specify an account (phone number) with -a");
 197         }
 198         return accounts.stream().findFirst().get();
 199     }
 200
 201     private OutputWriter getOutputWriter(final Command command) throws UserErrorException {
 202         final var outputTypeInput = ns.<OutputType>get("output");
 203         final var outputType = outputTypeInput == null ? command.getSupportedOutputTypes()
 204                 .stream()
 205                 .findFirst()
 206                 .orElse(null) : outputTypeInput;
 207         final var writer = new BufferedWriter(new OutputStreamWriter(System.out, IOUtils.getConsoleCharset()));
 208         final var outputWriter = outputType == null
 209                 ? null
 210                 : outputType == OutputType.JSON ? new JsonWriterImpl(writer) : new PlainTextWriterImpl(writer);
 211
 212         if (outputWriter != null && !command.getSupportedOutputTypes().contains(outputType)) {
 213             throw new UserErrorException("Command doesn't support output type " + outputType);
 214         }
 215         return outputWriter;
 216     }
 217
 218     private SignalAccountFiles loadSignalAccountFiles() throws IOErrorException {
 219         final File configPath;
 220         final var config = ns.getString("config");
 221         if (config != null) {
 222             configPath = new File(config);
 223         } else {
 224             configPath = getDefaultConfigPath();
 225         }
 226
 227         final var serviceEnvironmentCli = ns.<ServiceEnvironmentCli>get("service-environment");
 228         final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE
 229                 ? ServiceEnvironment.LIVE
 230                 : ServiceEnvironment.STAGING;
 231
 232         final var trustNewIdentityCli = ns.<TrustNewIdentityCli>get("trust-new-identities");
 233         final var trustNewIdentity = trustNewIdentityCli == TrustNewIdentityCli.ON_FIRST_USE
 234                 ? TrustNewIdentity.ON_FIRST_USE
 235                 : trustNewIdentityCli == TrustNewIdentityCli.ALWAYS ? TrustNewIdentity.ALWAYS : TrustNewIdentity.NEVER;
 236
 237         final var disableSendLog = Boolean.TRUE.equals(ns.getBoolean("disable-send-log"));
 238
 239         try {
 240             return new SignalAccountFiles(configPath,
 241                     serviceEnvironment,
 242                     BaseConfig.USER_AGENT,
 243                     new Settings(trustNewIdentity, disableSendLog));
 244         } catch (IOException e) {
 245             throw new IOErrorException("Failed to read local accounts list", e);
 246         }
 247     }
 248
 249     private void handleProvisioningCommand(
 250             final ProvisioningCommand command,
 251             final SignalAccountFiles signalAccountFiles,
 252             final CommandHandler commandHandler
 253     ) throws CommandException {
 254         var pm = signalAccountFiles.initProvisioningManager();
 255         commandHandler.handleProvisioningCommand(command, pm);
 256     }
 257
 258     private void handleRegistrationCommand(
 259             final RegistrationCommand command,
 260             final String account,
 261             final SignalAccountFiles signalAccountFiles,
 262             final CommandHandler commandHandler
 263     ) throws CommandException {
 264         try (final var rm = loadRegistrationManager(account, signalAccountFiles)) {
 265             commandHandler.handleRegistrationCommand(command, rm);
 266         } catch (IOException e) {
 267             logger.warn("Cleanup failed", e);
 268         }
 269     }
 270
 271     private void handleLocalCommand(
 272             final LocalCommand command,
 273             final String account,
 274             final SignalAccountFiles signalAccountFiles,
 275             final CommandHandler commandHandler
 276     ) throws CommandException {
 277         try (var m = loadManager(account, signalAccountFiles)) {
 278             commandHandler.handleLocalCommand(command, m);
 279         }
 280     }
 281
 282     private void handleMultiLocalCommand(
 283             final MultiLocalCommand command,
 284             final SignalAccountFiles signalAccountFiles,
 285             final CommandHandler commandHandler
 286     ) throws CommandException {
 287         try (var multiAccountManager = signalAccountFiles.initMultiAccountManager()) {
 288             commandHandler.handleMultiLocalCommand(command, multiAccountManager);
 289         } catch (IOException e) {
 290             throw new IOErrorException("Failed to load local accounts file", e);
 291         }
 292     }
 293
 294     private RegistrationManager loadRegistrationManager(
 295             final String account, final SignalAccountFiles signalAccountFiles
 296     ) throws UnexpectedErrorException {
 297         try {
 298             return signalAccountFiles.initRegistrationManager(account);
 299         } catch (Throwable e) {
 300             throw new UnexpectedErrorException("Error loading or creating state file: "
 301                     + e.getMessage()
 302                     + " ("
 303                     + e.getClass().getSimpleName()
 304                     + ")", e);
 305         }
 306     }
 307
 308     private Manager loadManager(
 309             final String account, final SignalAccountFiles signalAccountFiles
 310     ) throws CommandException {
 311         logger.trace("Loading account file for {}", account);
 312         try {
 313             return signalAccountFiles.initManager(account);
 314         } catch (NotRegisteredException e) {
 315             throw new UserErrorException("User " + account + " is not registered.");
 316         } catch (AccountCheckException ace) {
 317             if (ace.getCause() instanceof IOException e) {
 318                 throw new IOErrorException("Error while checking account " + account + ": " + e.getMessage(), e);
 319             } else {
 320                 throw new UnexpectedErrorException("Error while checking account " + account + ": " + ace.getMessage(),
 321                         ace);
 322             }
 323         } catch (Throwable e) {
 324             throw new UnexpectedErrorException("Error loading state file for user "
 325                     + account
 326                     + ": "
 327                     + e.getMessage()
 328                     + " ("
 329                     + e.getClass().getSimpleName()
 330                     + ")", e);
 331         }
 332     }
 333
 334     private void initDbusClient(
 335             final Command command, final String account, final boolean systemBus, final CommandHandler commandHandler
 336     ) throws CommandException {
 337         try {
 338             final var busType = systemBus ? DBusConnection.DBusBusType.SYSTEM : DBusConnection.DBusBusType.SESSION;
 339             try (var dBusConn = DBusConnectionBuilder.forType(busType).build()) {
 340                 DbusCommandHandler.handleCommand(command, account, dBusConn, commandHandler);
 341             }
 342         } catch (ServiceUnknown e) {
 343             throw new UserErrorException("signal-cli DBus daemon not running on "
 344                     + (systemBus ? "system" : "session")
 345                     + " bus: "
 346                     + e.getMessage(), e);
 347         } catch (DBusExecutionException | DBusException | IOException e) {
 348             throw new UnexpectedErrorException("Dbus client failed: " + e.getMessage(), e);
 349         }
 350     }
 351
 352     /**
 353      * @return the default data directory to be used by signal-cli.
 354      */
 355     private static File getDefaultConfigPath() {
 356         return new File(IOUtils.getDataHomeDir(), "signal-cli");
 357     }
 358 }