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