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