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