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.DbusCommand;
  12 import org.asamk.signal.commands.ExtendedDbusCommand;
  13 import org.asamk.signal.commands.LocalCommand;
  14 import org.asamk.signal.commands.MultiLocalCommand;
  15 import org.asamk.signal.commands.ProvisioningCommand;
  16 import org.asamk.signal.commands.RegistrationCommand;
  17 import org.asamk.signal.manager.Manager;
  18 import org.asamk.signal.manager.NotRegisteredException;
  19 import org.asamk.signal.manager.ProvisioningManager;
  20 import org.asamk.signal.manager.RegistrationManager;
  21 import org.asamk.signal.manager.config.ServiceConfig;
  22 import org.asamk.signal.manager.config.ServiceEnvironment;
  23 import org.asamk.signal.util.IOUtils;
  24 import org.freedesktop.dbus.connections.impl.DBusConnection;
  25 import org.freedesktop.dbus.exceptions.DBusException;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28 import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
  29
  30 import java.io.File;
  31 import java.io.IOException;
  32 import java.util.List;
  33 import java.util.Objects;
  34 import java.util.stream.Collectors;
  35
  36 public class App {
  37
  38     private final static Logger logger = LoggerFactory.getLogger(App.class);
  39
  40     private final Namespace ns;
  41
  42     static ArgumentParser buildArgumentParser() {
  43         var parser = ArgumentParsers.newFor("signal-cli")
  44                 .build()
  45                 .defaultHelp(true)
  46                 .description("Commandline interface for Signal.")
  47                 .version(BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
  48
  49         parser.addArgument("-v", "--version").help("Show package version.").action(Arguments.version());
  50         parser.addArgument("--verbose")
  51                 .help("Raise log level and include lib signal logs.")
  52                 .action(Arguments.storeTrue());
  53         parser.addArgument("--config")
  54                 .help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli).");
  55
  56         parser.addArgument("-u", "--username").help("Specify your phone number, that will be used for verification.");
  57
  58         var mut = parser.addMutuallyExclusiveGroup();
  59         mut.addArgument("--dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
  60         mut.addArgument("--dbus-system").help("Make request via system dbus.").action(Arguments.storeTrue());
  61
  62         parser.addArgument("-o", "--output")
  63                 .help("Choose to output in plain text or JSON")
  64                 .type(Arguments.enumStringType(OutputType.class))
  65                 .setDefault(OutputType.PLAIN_TEXT);
  66
  67         var subparsers = parser.addSubparsers().title("subcommands").dest("command");
  68
  69         final var commands = Commands.getCommands();
  70         for (var entry : commands.entrySet()) {
  71             var subparser = subparsers.addParser(entry.getKey());
  72             entry.getValue().attachToSubparser(subparser);
  73         }
  74
  75         return parser;
  76     }
  77
  78     public App(final Namespace ns) {
  79         this.ns = ns;
  80     }
  81
  82     public int init() {
  83         var commandKey = ns.getString("command");
  84         var command = Commands.getCommand(commandKey);
  85         if (command == null) {
  86             logger.error("Command not implemented!");
  87             return 1;
  88         }
  89
  90         OutputType outputType = ns.get("output");
  91         if (!command.getSupportedOutputTypes().contains(outputType)) {
  92             logger.error("Command doesn't support output type {}", outputType.toString());
  93             return 1;
  94         }
  95
  96         var username = ns.getString("username");
  97
  98         final boolean useDbus = ns.getBoolean("dbus");
  99         final boolean useDbusSystem = ns.getBoolean("dbus_system");
 100         if (useDbus || useDbusSystem) {
 101             // If username is null, it will connect to the default object path
 102             return initDbusClient(command, username, useDbusSystem);
 103         }
 104
 105         final File dataPath;
 106         var config = ns.getString("config");
 107         if (config != null) {
 108             dataPath = new File(config);
 109         } else {
 110             dataPath = getDefaultDataPath();
 111         }
 112
 113         final var serviceEnvironment = ServiceEnvironment.LIVE;
 114
 115         if (!ServiceConfig.getCapabilities().isGv2()) {
 116             logger.warn("WARNING: Support for new group V2 is disabled,"
 117                     + " because the required native library dependency is missing: libzkgroup");
 118         }
 119
 120         if (!ServiceConfig.isSignalClientAvailable()) {
 121             logger.error("Missing required native library dependency: libsignal-client");
 122             return 1;
 123         }
 124
 125         if (command instanceof ProvisioningCommand) {
 126             if (username != null) {
 127                 System.err.println("You cannot specify a username (phone number) when linking");
 128                 return 1;
 129             }
 130
 131             return handleProvisioningCommand((ProvisioningCommand) command, dataPath, serviceEnvironment);
 132         }
 133
 134         if (username == null) {
 135             var usernames = Manager.getAllLocalUsernames(dataPath);
 136             if (usernames.size() == 0) {
 137                 System.err.println("No local users found, you first need to register or link an account");
 138                 return 1;
 139             }
 140
 141             if (command instanceof MultiLocalCommand) {
 142                 return handleMultiLocalCommand((MultiLocalCommand) command, dataPath, serviceEnvironment, usernames);
 143             }
 144
 145             if (usernames.size() > 1) {
 146                 System.err.println("Multiple users found, you need to specify a username (phone number) with -u");
 147                 return 1;
 148             }
 149
 150             username = usernames.get(0);
 151         } else if (!PhoneNumberFormatter.isValidNumber(username, null)) {
 152             System.err.println("Invalid username (phone number), make sure you include the country code.");
 153             return 1;
 154         }
 155
 156         if (command instanceof RegistrationCommand) {
 157             return handleRegistrationCommand((RegistrationCommand) command, username, dataPath, serviceEnvironment);
 158         }
 159
 160         if (!(command instanceof LocalCommand)) {
 161             System.err.println("Command only works via dbus");
 162             return 1;
 163         }
 164
 165         return handleLocalCommand((LocalCommand) command, username, dataPath, serviceEnvironment);
 166     }
 167
 168     private int handleProvisioningCommand(
 169             final ProvisioningCommand command, final File dataPath, final ServiceEnvironment serviceEnvironment
 170     ) {
 171         var pm = ProvisioningManager.init(dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
 172         return command.handleCommand(ns, pm);
 173     }
 174
 175     private int handleRegistrationCommand(
 176             final RegistrationCommand command,
 177             final String username,
 178             final File dataPath,
 179             final ServiceEnvironment serviceEnvironment
 180     ) {
 181         final RegistrationManager manager;
 182         try {
 183             manager = RegistrationManager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
 184         } catch (Throwable e) {
 185             logger.error("Error loading or creating state file: {}", e.getMessage());
 186             return 2;
 187         }
 188         try (var m = manager) {
 189             return command.handleCommand(ns, m);
 190         } catch (IOException e) {
 191             logger.error("Cleanup failed", e);
 192             return 2;
 193         }
 194     }
 195
 196     private int handleLocalCommand(
 197             final LocalCommand command,
 198             final String username,
 199             final File dataPath,
 200             final ServiceEnvironment serviceEnvironment
 201     ) {
 202         try (var m = loadManager(username, dataPath, serviceEnvironment)) {
 203             if (m == null) {
 204                 return 2;
 205             }
 206
 207             return command.handleCommand(ns, m);
 208         } catch (IOException e) {
 209             logger.error("Cleanup failed", e);
 210             return 2;
 211         }
 212     }
 213
 214     private int handleMultiLocalCommand(
 215             final MultiLocalCommand command,
 216             final File dataPath,
 217             final ServiceEnvironment serviceEnvironment,
 218             final List<String> usernames
 219     ) {
 220         final var managers = usernames.stream()
 221                 .map(u -> loadManager(u, dataPath, serviceEnvironment))
 222                 .filter(Objects::nonNull)
 223                 .collect(Collectors.toList());
 224
 225         var result = command.handleCommand(ns, managers);
 226
 227         for (var m : managers) {
 228             try {
 229                 m.close();
 230             } catch (IOException e) {
 231                 logger.warn("Cleanup failed", e);
 232             }
 233         }
 234         return result;
 235     }
 236
 237     private Manager loadManager(
 238             final String username, final File dataPath, final ServiceEnvironment serviceEnvironment
 239     ) {
 240         Manager manager;
 241         try {
 242             manager = Manager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
 243         } catch (NotRegisteredException e) {
 244             logger.error("User " + username + " is not registered.");
 245             return null;
 246         } catch (Throwable e) {
 247             logger.error("Error loading state file for user " + username + ": {}", e.getMessage());
 248             return null;
 249         }
 250
 251         try {
 252             manager.checkAccountState();
 253         } catch (IOException e) {
 254             logger.error("Error while checking account " + username + ": {}", e.getMessage());
 255             return null;
 256         }
 257
 258         return manager;
 259     }
 260
 261     private int initDbusClient(final Command command, final String username, final boolean systemBus) {
 262         try {
 263             DBusConnection.DBusBusType busType;
 264             if (systemBus) {
 265                 busType = DBusConnection.DBusBusType.SYSTEM;
 266             } else {
 267                 busType = DBusConnection.DBusBusType.SESSION;
 268             }
 269             try (var dBusConn = DBusConnection.getConnection(busType)) {
 270                 var ts = dBusConn.getRemoteObject(DbusConfig.getBusname(),
 271                         DbusConfig.getObjectPath(username),
 272                         Signal.class);
 273
 274                 return handleCommand(command, ts, dBusConn);
 275             }
 276         } catch (DBusException | IOException e) {
 277             logger.error("Dbus client failed", e);
 278             return 2;
 279         }
 280     }
 281
 282     private int handleCommand(Command command, Signal ts, DBusConnection dBusConn) {
 283         if (command instanceof ExtendedDbusCommand) {
 284             return ((ExtendedDbusCommand) command).handleCommand(ns, ts, dBusConn);
 285         } else if (command instanceof DbusCommand) {
 286             return ((DbusCommand) command).handleCommand(ns, ts);
 287         } else {
 288             System.err.println("Command is not yet implemented via dbus");
 289             return 1;
 290         }
 291     }
 292
 293     /**
 294      * Uses $XDG_DATA_HOME/signal-cli if it exists, or if none of the legacy directories exist:
 295      * - $HOME/.config/signal
 296      * - $HOME/.config/textsecure
 297      *
 298      * @return the data directory to be used by signal-cli.
 299      */
 300     private static File getDefaultDataPath() {
 301         var dataPath = new File(IOUtils.getDataHomeDir(), "signal-cli");
 302         if (dataPath.exists()) {
 303             return dataPath;
 304         }
 305
 306         var configPath = new File(System.getProperty("user.home"), ".config");
 307
 308         var legacySettingsPath = new File(configPath, "signal");
 309         if (legacySettingsPath.exists()) {
 310             return legacySettingsPath;
 311         }
 312
 313         legacySettingsPath = new File(configPath, "textsecure");
 314         if (legacySettingsPath.exists()) {
 315             return legacySettingsPath;
 316         }
 317
 318         return dataPath;
 319     }
 320 }