import net.sourceforge.argparse4j.ArgumentParsers;
import net.sourceforge.argparse4j.impl.Arguments;
import net.sourceforge.argparse4j.inf.ArgumentParser;
-import net.sourceforge.argparse4j.inf.MutuallyExclusiveGroup;
import net.sourceforge.argparse4j.inf.Namespace;
-import net.sourceforge.argparse4j.inf.Subparser;
-import net.sourceforge.argparse4j.inf.Subparsers;
-import org.asamk.Signal;
import org.asamk.signal.commands.Command;
+import org.asamk.signal.commands.CommandHandler;
import org.asamk.signal.commands.Commands;
-import org.asamk.signal.commands.DbusCommand;
-import org.asamk.signal.commands.ExtendedDbusCommand;
import org.asamk.signal.commands.LocalCommand;
import org.asamk.signal.commands.MultiLocalCommand;
import org.asamk.signal.commands.ProvisioningCommand;
import org.asamk.signal.commands.RegistrationCommand;
+import org.asamk.signal.commands.exceptions.CommandException;
+import org.asamk.signal.commands.exceptions.IOErrorException;
+import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
+import org.asamk.signal.commands.exceptions.UserErrorException;
import org.asamk.signal.manager.Manager;
-import org.asamk.signal.manager.NotRegisteredException;
-import org.asamk.signal.manager.ProvisioningManager;
import org.asamk.signal.manager.RegistrationManager;
-import org.asamk.signal.manager.config.ServiceConfig;
-import org.asamk.signal.manager.config.ServiceEnvironment;
+import org.asamk.signal.manager.Settings;
+import org.asamk.signal.manager.SignalAccountFiles;
+import org.asamk.signal.manager.api.AccountCheckException;
+import org.asamk.signal.manager.api.NotRegisteredException;
+import org.asamk.signal.manager.api.ServiceEnvironment;
+import org.asamk.signal.manager.api.TrustNewIdentity;
+import org.asamk.signal.output.JsonWriterImpl;
+import org.asamk.signal.output.OutputWriter;
+import org.asamk.signal.output.PlainTextWriterImpl;
import org.asamk.signal.util.IOUtils;
-import org.freedesktop.dbus.connections.impl.DBusConnection;
-import org.freedesktop.dbus.exceptions.DBusException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
+import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.stream.Collectors;
+import java.io.OutputStreamWriter;
+import java.util.Set;
+
+import static net.sourceforge.argparse4j.DefaultSettings.VERSION_0_9_0_DEFAULT_SETTINGS;
+import static org.asamk.signal.dbus.DbusCommandHandler.initDbusClient;
public class App {
- private final static Logger logger = LoggerFactory.getLogger(App.class);
+ private static final Logger logger = LoggerFactory.getLogger(App.class);
private final Namespace ns;
static ArgumentParser buildArgumentParser() {
- ArgumentParser parser = ArgumentParsers.newFor("signal-cli")
+ var parser = ArgumentParsers.newFor("signal-cli", VERSION_0_9_0_DEFAULT_SETTINGS)
+ .includeArgumentNamesAsKeysInResult(true)
.build()
.defaultHelp(true)
.description("Commandline interface for Signal.")
.version(BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
- parser.addArgument("-v", "--version").help("Show package version.").action(Arguments.version());
- parser.addArgument("--verbose")
- .help("Raise log level and include lib signal logs.")
- .action(Arguments.storeTrue());
- parser.addArgument("--config")
+ parser.addArgument("--version").help("Show package version.").action(Arguments.version());
+ parser.addArgument("-v", "--verbose")
+ .help("Raise log level and include lib signal logs. Specify multiple times for even more logs.")
+ .action(Arguments.count());
+ parser.addArgument("--log-file")
+ .type(File.class)
+ .help("Write log output to the given file. If --verbose is also given, the detailed logs will only be written to the log file.");
+ parser.addArgument("--scrub-log")
+ .action(Arguments.storeTrue())
+ .help("Scrub possibly sensitive information from the log, like phone numbers and UUIDs.");
+ parser.addArgument("-c", "--config")
.help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli).");
- parser.addArgument("-u", "--username").help("Specify your phone number, that will be used for verification.");
+ parser.addArgument("-a", "--account", "-u", "--username")
+ .help("Specify your phone number, that will be your identifier.");
- MutuallyExclusiveGroup mut = parser.addMutuallyExclusiveGroup();
- mut.addArgument("--dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
- mut.addArgument("--dbus-system").help("Make request via system dbus.").action(Arguments.storeTrue());
+ var mut = parser.addMutuallyExclusiveGroup();
+ mut.addArgument("--dbus").dest("global-dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
+ mut.addArgument("--dbus-system")
+ .dest("global-dbus-system")
+ .help("Make request via system dbus.")
+ .action(Arguments.storeTrue());
+ parser.addArgument("--bus-name")
+ .dest("global-bus-name")
+ .setDefault(DbusConfig.getBusname())
+ .help("Specify the D-Bus bus name to connect to.");
parser.addArgument("-o", "--output")
.help("Choose to output in plain text or JSON")
- .type(Arguments.enumStringType(OutputType.class))
- .setDefault(OutputType.PLAIN_TEXT);
+ .type(Arguments.enumStringType(OutputType.class));
- Subparsers subparsers = parser.addSubparsers().title("subcommands").dest("command");
+ parser.addArgument("--service-environment")
+ .help("Choose the server environment to use.")
+ .type(Arguments.enumStringType(ServiceEnvironmentCli.class))
+ .setDefault(ServiceEnvironmentCli.LIVE);
- final Map<String, Command> commands = Commands.getCommands();
- for (Map.Entry<String, Command> entry : commands.entrySet()) {
- Subparser subparser = subparsers.addParser(entry.getKey());
- entry.getValue().attachToSubparser(subparser);
- }
+ parser.addArgument("--trust-new-identities")
+ .help("Choose when to trust new identities.")
+ .type(Arguments.enumStringType(TrustNewIdentityCli.class))
+ .setDefault(TrustNewIdentityCli.ON_FIRST_USE);
+
+ parser.addArgument("--disable-send-log")
+ .help("Disable message send log (for resending messages that recipient couldn't decrypt)")
+ .action(Arguments.storeTrue());
+
+ var subparsers = parser.addSubparsers().title("subcommands").dest("command");
+
+ Commands.getCommandSubparserAttachers().forEach((key, value) -> {
+ var subparser = subparsers.addParser(key);
+ value.attachToSubparser(subparser);
+ });
return parser;
}
this.ns = ns;
}
- public int init() {
- String commandKey = ns.getString("command");
- Command command = Commands.getCommand(commandKey);
+ public void init() throws CommandException {
+ logger.debug("Starting {}", BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
+ var commandKey = ns.getString("command");
+ var command = Commands.getCommand(commandKey);
if (command == null) {
- logger.error("Command not implemented!");
- return 1;
+ throw new UserErrorException("Command not implemented!");
}
- OutputType outputType = ns.get("output");
- if (!command.getSupportedOutputTypes().contains(outputType)) {
- logger.error("Command doesn't support output type {}", outputType.toString());
- return 1;
- }
+ final var outputWriter = getOutputWriter(command);
+ final var commandHandler = new CommandHandler(ns, outputWriter);
- String username = ns.getString("username");
+ var account = ns.getString("account");
- final boolean useDbus = ns.getBoolean("dbus");
- final boolean useDbusSystem = ns.getBoolean("dbus_system");
+ final var useDbus = Boolean.TRUE.equals(ns.getBoolean("global-dbus"));
+ final var useDbusSystem = Boolean.TRUE.equals(ns.getBoolean("global-dbus-system"));
if (useDbus || useDbusSystem) {
- // If username is null, it will connect to the default object path
- return initDbusClient(command, username, useDbusSystem);
+ final var busName = ns.getString("global-bus-name");
+ // If account is null, it will connect to the default object path
+ initDbusClient(command, account, useDbusSystem, busName, commandHandler);
+ return;
}
- final File dataPath;
- String config = ns.getString("config");
- if (config != null) {
- dataPath = new File(config);
- } else {
- dataPath = getDefaultDataPath();
+ if (!Manager.isSignalClientAvailable()) {
+ throw new UserErrorException("Missing required native library dependency: libsignal-client");
}
- final ServiceEnvironment serviceEnvironment = ServiceEnvironment.LIVE;
+ final var signalAccountFiles = loadSignalAccountFiles();
- if (!ServiceConfig.getCapabilities().isGv2()) {
- logger.warn("WARNING: Support for new group V2 is disabled,"
- + " because the required native library dependency is missing: libzkgroup");
- }
+ handleCommand(command, commandHandler, account, signalAccountFiles);
+ }
- if (!ServiceConfig.isSignalClientAvailable()) {
- logger.error("Missing required native library dependency: libsignal-client");
- return 1;
+ private void handleCommand(
+ final Command command,
+ final CommandHandler commandHandler,
+ String account,
+ final SignalAccountFiles signalAccountFiles
+ ) throws CommandException {
+ if (command instanceof ProvisioningCommand provisioningCommand) {
+ if (account != null) {
+ throw new UserErrorException("You cannot specify a account (phone number) when linking");
+ }
+
+ handleProvisioningCommand(provisioningCommand, signalAccountFiles, commandHandler);
+ return;
}
- if (command instanceof ProvisioningCommand) {
- if (username != null) {
- System.err.println("You cannot specify a username (phone number) when linking");
- return 1;
+ if (account == null) {
+ if (command instanceof MultiLocalCommand multiLocalCommand) {
+ handleMultiLocalCommand(multiLocalCommand, signalAccountFiles, commandHandler);
+ return;
}
- return handleProvisioningCommand((ProvisioningCommand) command, dataPath, serviceEnvironment);
+ account = getAccountIfOnlyOne(signalAccountFiles);
+ } else if (!Manager.isValidNumber(account, null)) {
+ throw new UserErrorException("Invalid account (phone number), make sure you include the country code.");
}
- if (username == null) {
- List<String> usernames = Manager.getAllLocalUsernames(dataPath);
- if (usernames.size() == 0) {
- System.err.println("No local users found, you first need to register or link an account");
- return 1;
- }
+ if (command instanceof RegistrationCommand registrationCommand) {
+ handleRegistrationCommand(registrationCommand, account, signalAccountFiles, commandHandler);
+ return;
+ }
- if (command instanceof MultiLocalCommand) {
- return handleMultiLocalCommand((MultiLocalCommand) command, dataPath, serviceEnvironment, usernames);
- }
+ if (command instanceof LocalCommand localCommand) {
+ handleLocalCommand(localCommand, account, signalAccountFiles, commandHandler);
+ return;
+ }
- if (usernames.size() > 1) {
- System.err.println("Multiple users found, you need to specify a username (phone number) with -u");
- return 1;
- }
+ throw new UserErrorException("Command only works in multi-account mode");
+ }
- username = usernames.get(0);
- } else if (!PhoneNumberFormatter.isValidNumber(username, null)) {
- System.err.println("Invalid username (phone number), make sure you include the country code.");
- return 1;
+ private static String getAccountIfOnlyOne(final SignalAccountFiles signalAccountFiles) throws IOErrorException, UserErrorException {
+ Set<String> accounts;
+ try {
+ accounts = signalAccountFiles.getAllLocalAccountNumbers();
+ } catch (IOException e) {
+ throw new IOErrorException("Failed to load local accounts file", e);
}
+ if (accounts.isEmpty()) {
+ throw new UserErrorException("No local users found, you first need to register or link an account");
+ } else if (accounts.size() > 1) {
+ throw new UserErrorException("Multiple users found, you need to specify an account (phone number) with -a");
+ }
+ return accounts.stream().findFirst().get();
+ }
- if (command instanceof RegistrationCommand) {
- return handleRegistrationCommand((RegistrationCommand) command, username, dataPath, serviceEnvironment);
+ private OutputWriter getOutputWriter(final Command command) throws UserErrorException {
+ final var outputTypeInput = ns.<OutputType>get("output");
+ final var outputType = outputTypeInput == null ? command.getSupportedOutputTypes()
+ .stream()
+ .findFirst()
+ .orElse(null) : outputTypeInput;
+ final var writer = new BufferedWriter(new OutputStreamWriter(System.out, IOUtils.getConsoleCharset()));
+ final var outputWriter = outputType == null
+ ? null
+ : outputType == OutputType.JSON ? new JsonWriterImpl(writer) : new PlainTextWriterImpl(writer);
+
+ if (outputWriter != null && !command.getSupportedOutputTypes().contains(outputType)) {
+ throw new UserErrorException("Command doesn't support output type " + outputType);
}
+ return outputWriter;
+ }
- if (!(command instanceof LocalCommand)) {
- System.err.println("Command only works via dbus");
- return 1;
+ private SignalAccountFiles loadSignalAccountFiles() throws IOErrorException {
+ final File configPath;
+ final var config = ns.getString("config");
+ if (config != null) {
+ configPath = new File(config);
+ } else {
+ configPath = getDefaultConfigPath();
}
- return handleLocalCommand((LocalCommand) command, username, dataPath, serviceEnvironment);
+ final var serviceEnvironmentCli = ns.<ServiceEnvironmentCli>get("service-environment");
+ final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE
+ ? ServiceEnvironment.LIVE
+ : ServiceEnvironment.STAGING;
+
+ final var trustNewIdentityCli = ns.<TrustNewIdentityCli>get("trust-new-identities");
+ final var trustNewIdentity = trustNewIdentityCli == TrustNewIdentityCli.ON_FIRST_USE
+ ? TrustNewIdentity.ON_FIRST_USE
+ : trustNewIdentityCli == TrustNewIdentityCli.ALWAYS ? TrustNewIdentity.ALWAYS : TrustNewIdentity.NEVER;
+
+ final var disableSendLog = Boolean.TRUE.equals(ns.getBoolean("disable-send-log"));
+
+ try {
+ return new SignalAccountFiles(configPath,
+ serviceEnvironment,
+ BaseConfig.USER_AGENT,
+ new Settings(trustNewIdentity, disableSendLog));
+ } catch (IOException e) {
+ throw new IOErrorException("Failed to read local accounts list", e);
+ }
}
- private int handleProvisioningCommand(
- final ProvisioningCommand command, final File dataPath, final ServiceEnvironment serviceEnvironment
- ) {
- ProvisioningManager pm = ProvisioningManager.init(dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
- return command.handleCommand(ns, pm);
+ private void handleProvisioningCommand(
+ final ProvisioningCommand command,
+ final SignalAccountFiles signalAccountFiles,
+ final CommandHandler commandHandler
+ ) throws CommandException {
+ var pm = signalAccountFiles.initProvisioningManager();
+ commandHandler.handleProvisioningCommand(command, pm);
}
- private int handleRegistrationCommand(
+ private void handleRegistrationCommand(
final RegistrationCommand command,
- final String username,
- final File dataPath,
- final ServiceEnvironment serviceEnvironment
- ) {
- final RegistrationManager manager;
- try {
- manager = RegistrationManager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
- } catch (Throwable e) {
- logger.error("Error loading or creating state file: {}", e.getMessage());
- return 2;
- }
- try (RegistrationManager m = manager) {
- return command.handleCommand(ns, m);
+ final String account,
+ final SignalAccountFiles signalAccountFiles,
+ final CommandHandler commandHandler
+ ) throws CommandException {
+ try (final var rm = loadRegistrationManager(account, signalAccountFiles)) {
+ commandHandler.handleRegistrationCommand(command, rm);
} catch (IOException e) {
- logger.error("Cleanup failed", e);
- return 2;
+ logger.warn("Cleanup failed", e);
}
}
- private int handleLocalCommand(
+ private void handleLocalCommand(
final LocalCommand command,
- final String username,
- final File dataPath,
- final ServiceEnvironment serviceEnvironment
- ) {
- try (Manager m = loadManager(username, dataPath, serviceEnvironment)) {
- if (m == null) {
- return 2;
- }
-
- return command.handleCommand(ns, m);
- } catch (IOException e) {
- logger.error("Cleanup failed", e);
- return 2;
+ final String account,
+ final SignalAccountFiles signalAccountFiles,
+ final CommandHandler commandHandler
+ ) throws CommandException {
+ try (var m = loadManager(account, signalAccountFiles)) {
+ commandHandler.handleLocalCommand(command, m);
}
}
- private int handleMultiLocalCommand(
+ private void handleMultiLocalCommand(
final MultiLocalCommand command,
- final File dataPath,
- final ServiceEnvironment serviceEnvironment,
- final List<String> usernames
- ) {
- final List<Manager> managers = usernames.stream()
- .map(u -> loadManager(u, dataPath, serviceEnvironment))
- .filter(Objects::nonNull)
- .collect(Collectors.toList());
-
- int result = command.handleCommand(ns, managers);
-
- for (Manager m : managers) {
- try {
- m.close();
- } catch (IOException e) {
- logger.warn("Cleanup failed", e);
- }
+ final SignalAccountFiles signalAccountFiles,
+ final CommandHandler commandHandler
+ ) throws CommandException {
+ try (var multiAccountManager = signalAccountFiles.initMultiAccountManager()) {
+ commandHandler.handleMultiLocalCommand(command, multiAccountManager);
+ } catch (IOException e) {
+ throw new IOErrorException("Failed to load local accounts file", e);
}
- return result;
}
- private Manager loadManager(
- final String username, final File dataPath, final ServiceEnvironment serviceEnvironment
- ) {
- Manager manager;
+ private RegistrationManager loadRegistrationManager(
+ final String account, final SignalAccountFiles signalAccountFiles
+ ) throws UnexpectedErrorException {
try {
- manager = Manager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT);
- } catch (NotRegisteredException e) {
- logger.error("User " + username + " is not registered.");
- return null;
+ return signalAccountFiles.initRegistrationManager(account);
} catch (Throwable e) {
- logger.error("Error loading state file for user " + username + ": {}", e.getMessage());
- return null;
- }
-
- try {
- manager.checkAccountState();
- } catch (IOException e) {
- logger.error("Error while checking account " + username + ": {}", e.getMessage());
- return null;
+ throw new UnexpectedErrorException("Error loading or creating state file: "
+ + e.getMessage()
+ + " ("
+ + e.getClass().getSimpleName()
+ + ")", e);
}
-
- return manager;
}
- private int initDbusClient(final Command command, final String username, final boolean systemBus) {
+ private Manager loadManager(
+ final String account, final SignalAccountFiles signalAccountFiles
+ ) throws CommandException {
+ logger.trace("Loading account file for {}", account);
try {
- DBusConnection.DBusBusType busType;
- if (systemBus) {
- busType = DBusConnection.DBusBusType.SYSTEM;
+ return signalAccountFiles.initManager(account);
+ } catch (NotRegisteredException e) {
+ throw new UserErrorException("User " + account + " is not registered.");
+ } catch (AccountCheckException ace) {
+ if (ace.getCause() instanceof IOException e) {
+ throw new IOErrorException("Error while checking account " + account + ": " + e.getMessage(), e);
} else {
- busType = DBusConnection.DBusBusType.SESSION;
- }
- try (DBusConnection dBusConn = DBusConnection.getConnection(busType)) {
- Signal ts = dBusConn.getRemoteObject(DbusConfig.getBusname(),
- DbusConfig.getObjectPath(username),
- Signal.class);
-
- return handleCommand(command, ts, dBusConn);
+ throw new UnexpectedErrorException("Error while checking account " + account + ": " + ace.getMessage(),
+ ace);
}
- } catch (DBusException | IOException e) {
- logger.error("Dbus client failed", e);
- return 2;
- }
- }
-
- private int handleCommand(Command command, Signal ts, DBusConnection dBusConn) {
- if (command instanceof ExtendedDbusCommand) {
- return ((ExtendedDbusCommand) command).handleCommand(ns, ts, dBusConn);
- } else if (command instanceof DbusCommand) {
- return ((DbusCommand) command).handleCommand(ns, ts);
- } else {
- System.err.println("Command is not yet implemented via dbus");
- return 1;
+ } catch (Throwable e) {
+ throw new UnexpectedErrorException("Error loading state file for user "
+ + account
+ + ": "
+ + e.getMessage()
+ + " ("
+ + e.getClass().getSimpleName()
+ + ")", e);
}
}
/**
- * Uses $XDG_DATA_HOME/signal-cli if it exists, or if none of the legacy directories exist:
- * - $HOME/.config/signal
- * - $HOME/.config/textsecure
- *
- * @return the data directory to be used by signal-cli.
+ * @return the default data directory to be used by signal-cli.
*/
- private static File getDefaultDataPath() {
- File dataPath = new File(IOUtils.getDataHomeDir(), "signal-cli");
- if (dataPath.exists()) {
- return dataPath;
- }
-
- File configPath = new File(System.getProperty("user.home"), ".config");
-
- File legacySettingsPath = new File(configPath, "signal");
- if (legacySettingsPath.exists()) {
- return legacySettingsPath;
- }
-
- legacySettingsPath = new File(configPath, "textsecure");
- if (legacySettingsPath.exists()) {
- return legacySettingsPath;
- }
-
- return dataPath;
+ private static File getDefaultConfigPath() {
+ return new File(IOUtils.getDataHomeDir(), "signal-cli");
}
}
git.nmode.ca / signal-cli / blobdiff
