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