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