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