mirror of
https://github.com/AsamK/signal-cli
synced 2025-08-29 18:40:39 +00:00
345 lines
15 KiB
Java
345 lines
15 KiB
Java
package org.asamk.signal;
|
|
|
|
import net.sourceforge.argparse4j.ArgumentParsers;
|
|
import net.sourceforge.argparse4j.impl.Arguments;
|
|
import net.sourceforge.argparse4j.inf.ArgumentParser;
|
|
import net.sourceforge.argparse4j.inf.Namespace;
|
|
|
|
import org.asamk.signal.commands.Command;
|
|
import org.asamk.signal.commands.CommandHandler;
|
|
import org.asamk.signal.commands.Commands;
|
|
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.RegistrationManager;
|
|
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.slf4j.Logger;
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
import java.io.BufferedWriter;
|
|
import java.io.File;
|
|
import java.io.IOException;
|
|
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 static final Logger logger = LoggerFactory.getLogger(App.class);
|
|
|
|
private final Namespace ns;
|
|
|
|
static ArgumentParser buildArgumentParser() {
|
|
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("--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("-a", "--account", "-u", "--username")
|
|
.help("Specify your phone number, that will be your identifier.");
|
|
|
|
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));
|
|
|
|
parser.addArgument("--service-environment")
|
|
.help("Choose the server environment to use.")
|
|
.type(Arguments.enumStringType(ServiceEnvironmentCli.class))
|
|
.setDefault(ServiceEnvironmentCli.LIVE);
|
|
|
|
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());
|
|
|
|
parser.epilog(
|
|
"The global arguments are shown with 'signal-cli -h' and need to come before the subcommand, while the subcommand-specific arguments (shown with 'signal-cli SUBCOMMAND -h') need to be given after the subcommand.");
|
|
|
|
var subparsers = parser.addSubparsers().title("subcommands").dest("command");
|
|
|
|
Commands.getCommandSubparserAttachers().forEach((key, value) -> {
|
|
var subparser = subparsers.addParser(key);
|
|
value.attachToSubparser(subparser);
|
|
});
|
|
|
|
return parser;
|
|
}
|
|
|
|
public App(final Namespace ns) {
|
|
this.ns = ns;
|
|
}
|
|
|
|
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) {
|
|
throw new UserErrorException("Command not implemented!");
|
|
}
|
|
|
|
final var outputWriter = getOutputWriter(command);
|
|
final var commandHandler = new CommandHandler(ns, outputWriter);
|
|
|
|
var account = ns.getString("account");
|
|
|
|
final var useDbus = Boolean.TRUE.equals(ns.getBoolean("global-dbus"));
|
|
final var useDbusSystem = Boolean.TRUE.equals(ns.getBoolean("global-dbus-system"));
|
|
if (useDbus || 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;
|
|
}
|
|
|
|
if (!Manager.isSignalClientAvailable()) {
|
|
throw new UserErrorException("Missing required native library dependency: libsignal-client");
|
|
}
|
|
|
|
final var signalAccountFiles = loadSignalAccountFiles();
|
|
|
|
handleCommand(command, commandHandler, account, signalAccountFiles);
|
|
}
|
|
|
|
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 (account == null) {
|
|
if (command instanceof MultiLocalCommand multiLocalCommand) {
|
|
handleMultiLocalCommand(multiLocalCommand, signalAccountFiles, commandHandler);
|
|
return;
|
|
}
|
|
|
|
account = getAccountIfOnlyOne(signalAccountFiles);
|
|
} else if (!Manager.isValidNumber(account, null)) {
|
|
throw new UserErrorException("Invalid account (phone number), make sure you include the country code.");
|
|
}
|
|
|
|
if (command instanceof RegistrationCommand registrationCommand) {
|
|
handleRegistrationCommand(registrationCommand, account, signalAccountFiles, commandHandler);
|
|
return;
|
|
}
|
|
|
|
if (command instanceof LocalCommand localCommand) {
|
|
handleLocalCommand(localCommand, account, signalAccountFiles, commandHandler);
|
|
return;
|
|
}
|
|
|
|
throw new UserErrorException("Command only works in multi-account mode");
|
|
}
|
|
|
|
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();
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
private SignalAccountFiles loadSignalAccountFiles() throws IOErrorException {
|
|
final File configPath;
|
|
final var config = ns.getString("config");
|
|
if (config != null) {
|
|
configPath = new File(config);
|
|
} else {
|
|
configPath = getDefaultConfigPath();
|
|
}
|
|
|
|
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 void handleProvisioningCommand(
|
|
final ProvisioningCommand command,
|
|
final SignalAccountFiles signalAccountFiles,
|
|
final CommandHandler commandHandler
|
|
) throws CommandException {
|
|
var pm = signalAccountFiles.initProvisioningManager();
|
|
commandHandler.handleProvisioningCommand(command, pm);
|
|
}
|
|
|
|
private void handleRegistrationCommand(
|
|
final RegistrationCommand command,
|
|
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.warn("Cleanup failed", e);
|
|
}
|
|
}
|
|
|
|
private void handleLocalCommand(
|
|
final LocalCommand command,
|
|
final String account,
|
|
final SignalAccountFiles signalAccountFiles,
|
|
final CommandHandler commandHandler
|
|
) throws CommandException {
|
|
try (var m = loadManager(account, signalAccountFiles)) {
|
|
commandHandler.handleLocalCommand(command, m);
|
|
}
|
|
}
|
|
|
|
private void handleMultiLocalCommand(
|
|
final MultiLocalCommand command,
|
|
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);
|
|
}
|
|
}
|
|
|
|
private RegistrationManager loadRegistrationManager(
|
|
final String account,
|
|
final SignalAccountFiles signalAccountFiles
|
|
) throws UnexpectedErrorException {
|
|
try {
|
|
return signalAccountFiles.initRegistrationManager(account);
|
|
} catch (Throwable e) {
|
|
throw new UnexpectedErrorException("Error loading or creating state file: "
|
|
+ e.getMessage()
|
|
+ " ("
|
|
+ e.getClass().getSimpleName()
|
|
+ ")", e);
|
|
}
|
|
}
|
|
|
|
private Manager loadManager(
|
|
final String account,
|
|
final SignalAccountFiles signalAccountFiles
|
|
) throws CommandException {
|
|
logger.trace("Loading account file for {}", account);
|
|
try {
|
|
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 {
|
|
throw new UnexpectedErrorException("Error while checking account " + account + ": " + ace.getMessage(),
|
|
ace);
|
|
}
|
|
} catch (Throwable e) {
|
|
throw new UnexpectedErrorException("Error loading state file for user "
|
|
+ account
|
|
+ ": "
|
|
+ e.getMessage()
|
|
+ " ("
|
|
+ e.getClass().getSimpleName()
|
|
+ ")", e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return the default data directory to be used by signal-cli.
|
|
*/
|
|
private static File getDefaultConfigPath() {
|
|
return new File(IOUtils.getDataHomeDir(), "signal-cli");
|
|
}
|
|
}
|