nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/Cli.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 Cli {
  41
  42     private final static Logger logger = LoggerFactory.getLogger(Main.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                 .choices("plain-text", "json")
  69                 .setDefault("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 Cli(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         String username = ns.getString("username");
  95
  96         final boolean useDbus = ns.getBoolean("dbus");
  97         final boolean useDbusSystem = ns.getBoolean("dbus_system");
  98         if (useDbus || useDbusSystem) {
  99             // If username is null, it will connect to the default object path
 100             return initDbusClient(command, username, useDbusSystem);
 101         }
 102
 103         final File dataPath;
 104         String config = ns.getString("config");
 105         if (config != null) {
 106             dataPath = new File(config);
 107         } else {
 108             dataPath = getDefaultDataPath();
 109         }
 110
 111         final SignalServiceConfiguration serviceConfiguration = ServiceConfig.createDefaultServiceConfiguration(
 112                 BaseConfig.USER_AGENT);
 113
 114         if (!ServiceConfig.getCapabilities().isGv2()) {
 115             logger.warn("WARNING: Support for new group V2 is disabled,"
 116                     + " because the required native library dependency is missing: libzkgroup");
 117         }
 118
 119         if (command instanceof ProvisioningCommand) {
 120             if (username != null) {
 121                 System.err.println("You cannot specify a username (phone number) when linking");
 122                 return 1;
 123             }
 124
 125             return handleProvisioningCommand((ProvisioningCommand) command, dataPath, serviceConfiguration);
 126         }
 127
 128         if (username == null) {
 129             List<String> usernames = Manager.getAllLocalUsernames(dataPath);
 130             if (usernames.size() == 0) {
 131                 System.err.println("No local users found, you first need to register or link an account");
 132                 return 1;
 133             }
 134
 135             if (command instanceof MultiLocalCommand) {
 136                 return handleMultiLocalCommand((MultiLocalCommand) command, dataPath, serviceConfiguration, usernames);
 137             }
 138
 139             if (usernames.size() > 1) {
 140                 System.err.println("Multiple users found, you need to specify a username (phone number) with -u");
 141                 return 1;
 142             }
 143
 144             username = usernames.get(0);
 145         } else if (!PhoneNumberFormatter.isValidNumber(username, null)) {
 146             System.err.println("Invalid username (phone number), make sure you include the country code.");
 147             return 1;
 148         }
 149
 150         if (command instanceof RegistrationCommand) {
 151             return handleRegistrationCommand((RegistrationCommand) command, username, dataPath, serviceConfiguration);
 152         }
 153
 154         if (!(command instanceof LocalCommand)) {
 155             System.err.println("Command only works via dbus");
 156             return 1;
 157         }
 158
 159         return handleLocalCommand((LocalCommand) command, username, dataPath, serviceConfiguration);
 160     }
 161
 162     private int handleProvisioningCommand(
 163             final ProvisioningCommand command,
 164             final File dataPath,
 165             final SignalServiceConfiguration serviceConfiguration
 166     ) {
 167         ProvisioningManager pm = new ProvisioningManager(dataPath, serviceConfiguration, BaseConfig.USER_AGENT);
 168         return command.handleCommand(ns, pm);
 169     }
 170
 171     private int handleRegistrationCommand(
 172             final RegistrationCommand command,
 173             final String username,
 174             final File dataPath,
 175             final SignalServiceConfiguration serviceConfiguration
 176     ) {
 177         final RegistrationManager manager;
 178         try {
 179             manager = RegistrationManager.init(username, dataPath, serviceConfiguration, BaseConfig.USER_AGENT);
 180         } catch (Throwable e) {
 181             logger.error("Error loading or creating state file: {}", e.getMessage());
 182             return 2;
 183         }
 184         try (RegistrationManager m = manager) {
 185             return command.handleCommand(ns, m);
 186         } catch (IOException e) {
 187             logger.error("Cleanup failed", e);
 188             return 2;
 189         }
 190     }
 191
 192     private int handleLocalCommand(
 193             final LocalCommand command,
 194             final String username,
 195             final File dataPath,
 196             final SignalServiceConfiguration serviceConfiguration
 197     ) {
 198         try (Manager m = loadManager(username, dataPath, serviceConfiguration)) {
 199             if (m == null) {
 200                 return 2;
 201             }
 202
 203             return command.handleCommand(ns, m);
 204         } catch (IOException e) {
 205             logger.error("Cleanup failed", e);
 206             return 2;
 207         }
 208     }
 209
 210     private int handleMultiLocalCommand(
 211             final MultiLocalCommand command,
 212             final File dataPath,
 213             final SignalServiceConfiguration serviceConfiguration,
 214             final List<String> usernames
 215     ) {
 216         final List<Manager> managers = usernames.stream()
 217                 .map(u -> loadManager(u, dataPath, serviceConfiguration))
 218                 .filter(Objects::nonNull)
 219                 .collect(Collectors.toList());
 220
 221         int result = command.handleCommand(ns, managers);
 222
 223         for (Manager m : managers) {
 224             try {
 225                 m.close();
 226             } catch (IOException e) {
 227                 logger.warn("Cleanup failed", e);
 228             }
 229         }
 230         return result;
 231     }
 232
 233     private Manager loadManager(
 234             final String username, final File dataPath, final SignalServiceConfiguration serviceConfiguration
 235     ) {
 236         Manager manager;
 237         try {
 238             manager = Manager.init(username, dataPath, serviceConfiguration, BaseConfig.USER_AGENT);
 239         } catch (NotRegisteredException e) {
 240             logger.error("User " + username + " is not registered.");
 241             return null;
 242         } catch (Throwable e) {
 243             logger.error("Error loading state file for user " + username + ": {}", e.getMessage());
 244             return null;
 245         }
 246
 247         try {
 248             manager.checkAccountState();
 249         } catch (IOException e) {
 250             logger.error("Error while checking account " + username + ": {}", e.getMessage());
 251             return null;
 252         }
 253
 254         return manager;
 255     }
 256
 257     private int initDbusClient(final Command command, final String username, final boolean systemBus) {
 258         try {
 259             DBusConnection.DBusBusType busType;
 260             if (systemBus) {
 261                 busType = DBusConnection.DBusBusType.SYSTEM;
 262             } else {
 263                 busType = DBusConnection.DBusBusType.SESSION;
 264             }
 265             try (DBusConnection dBusConn = DBusConnection.getConnection(busType)) {
 266                 Signal ts = dBusConn.getRemoteObject(DbusConfig.getBusname(),
 267                         DbusConfig.getObjectPath(username),
 268                         Signal.class);
 269
 270                 return handleCommand(command, ts, dBusConn);
 271             }
 272         } catch (DBusException | IOException e) {
 273             logger.error("Dbus client failed", e);
 274             return 2;
 275         }
 276     }
 277
 278     private int handleCommand(Command command, Signal ts, DBusConnection dBusConn) {
 279         if (command instanceof ExtendedDbusCommand) {
 280             return ((ExtendedDbusCommand) command).handleCommand(ns, ts, dBusConn);
 281         } else if (command instanceof DbusCommand) {
 282             return ((DbusCommand) command).handleCommand(ns, ts);
 283         } else {
 284             System.err.println("Command is not yet implemented via dbus");
 285             return 1;
 286         }
 287     }
 288
 289     /**
 290      * Uses $XDG_DATA_HOME/signal-cli if it exists, or if none of the legacy directories exist:
 291      * - $HOME/.config/signal
 292      * - $HOME/.config/textsecure
 293      *
 294      * @return the data directory to be used by signal-cli.
 295      */
 296     private static File getDefaultDataPath() {
 297         File dataPath = new File(IOUtils.getDataHomeDir(), "signal-cli");
 298         if (dataPath.exists()) {
 299             return dataPath;
 300         }
 301
 302         File configPath = new File(System.getProperty("user.home"), ".config");
 303
 304         File legacySettingsPath = new File(configPath, "signal");
 305         if (legacySettingsPath.exists()) {
 306             return legacySettingsPath;
 307         }
 308
 309         legacySettingsPath = new File(configPath, "textsecure");
 310         if (legacySettingsPath.exists()) {
 311             return legacySettingsPath;
 312         }
 313
 314         return dataPath;
 315     }
 316 }