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