Exposing Signal CLI as HTTP Server (#1078)

[signal-cli] / src / main / java / org / asamk / signal / commands / DaemonCommand.java

diff --git a/src/main/java/org/asamk/signal/commands/DaemonCommand.java b/src/main/java/org/asamk/signal/commands/DaemonCommand.java
index 9b6c0d63b331a66ee766d27ffd7684c4f0e7510d..bd6b9386779e15e06bec0557fd24e12f1c8d7374 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/DaemonCommand.java
+++ b/src/main/java/org/asamk/signal/commands/DaemonCommand.java
@@ -3,74 +3,421 @@ package org.asamk.signal.commands;
 import net.sourceforge.argparse4j.impl.Arguments;
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 import net.sourceforge.argparse4j.impl.Arguments;
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;

-import org.asamk.signal.DbusReceiveMessageHandler;
-import org.asamk.signal.JsonDbusReceiveMessageHandler;
+
+import org.asamk.signal.DbusConfig;
+import org.asamk.signal.OutputType;
+import org.asamk.signal.ReceiveMessageHandler;
+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.dbus.DbusSignalControlImpl;
+import org.asamk.signal.dbus.DbusSignalImpl;
+import org.asamk.signal.http.HttpServerHandler;
+import org.asamk.signal.json.JsonReceiveMessageHandler;
+import org.asamk.signal.jsonrpc.SignalJsonRpcDispatcherHandler;

 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.Manager;

-import org.freedesktop.dbus.DBusConnection;
+import org.asamk.signal.manager.MultiAccountManager;
+import org.asamk.signal.manager.api.ReceiveConfig;
+import org.asamk.signal.output.JsonWriter;
+import org.asamk.signal.output.JsonWriterImpl;
+import org.asamk.signal.output.OutputWriter;
+import org.asamk.signal.output.PlainTextWriter;
+import org.asamk.signal.util.IOUtils;
+import org.freedesktop.dbus.connections.impl.DBusConnection;
+import org.freedesktop.dbus.connections.impl.DBusConnectionBuilder;

 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusException;

+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;

 
 

+import java.io.File;

 import java.io.IOException;
 import java.io.IOException;

-import java.util.concurrent.TimeUnit;
+import java.net.UnixDomainSocketAddress;
+import java.nio.channels.Channel;
+import java.nio.channels.Channels;
+import java.nio.channels.ServerSocketChannel;
+import java.nio.channels.SocketChannel;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.Consumer;
+
+public class DaemonCommand implements MultiLocalCommand, LocalCommand {

 
 

-import static org.asamk.signal.DbusConfig.SIGNAL_BUSNAME;
-import static org.asamk.signal.DbusConfig.SIGNAL_OBJECTPATH;
-import static org.asamk.signal.util.ErrorUtils.handleAssertionError;
+    private final static Logger logger = LoggerFactory.getLogger(DaemonCommand.class);

 
 

-public class DaemonCommand implements LocalCommand {
+    @Override
+    public String getName() {
+        return "daemon";
+    }

 
     @Override
     public void attachToSubparser(final Subparser subparser) {
 
     @Override
     public void attachToSubparser(final Subparser subparser) {

-        subparser.addArgument("--system")
+        final var defaultSocketPath = new File(new File(IOUtils.getRuntimeDir(), "signal-cli"), "socket");
+        subparser.help("Run in daemon mode and provide an experimental dbus or JSON-RPC interface.");
+        subparser.addArgument("--dbus")
+                .action(Arguments.storeTrue())
+                .help("Expose a DBus interface on the user bus (the default, if no other options are given).");
+        subparser.addArgument("--dbus-system", "--system")

                 .action(Arguments.storeTrue())
                 .action(Arguments.storeTrue())

-                .help("Use DBus system bus instead of user bus.");
+                .help("Expose a DBus interface on the system bus.");
+        subparser.addArgument("--socket")
+                .nargs("?")
+                .type(File.class)
+                .setConst(defaultSocketPath)
+                .help("Expose a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket).");
+        subparser.addArgument("--tcp")
+                .nargs("?")
+                .setConst("localhost:7583")
+                .help("Expose a JSON-RPC interface on a TCP socket (default localhost:7583).");
+        subparser.addArgument("--http")
+                .nargs("?")
+                .setConst("localhost:8080")
+                .help("Expose a JSON-RPC interface as http endpoint.");
+        subparser.addArgument("--no-receive-stdout")
+                .help("Don’t print received messages to stdout.")
+                .action(Arguments.storeTrue());
+        subparser.addArgument("--receive-mode")
+                .help("Specify when to start receiving messages.")
+                .type(Arguments.enumStringType(ReceiveMode.class))
+                .setDefault(ReceiveMode.ON_START);

         subparser.addArgument("--ignore-attachments")
                 .help("Don’t download attachments of received messages.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--ignore-attachments")
                 .help("Don’t download attachments of received messages.")
                 .action(Arguments.storeTrue());

-        subparser.addArgument("--json")
-                .help("Output received messages in json format, one json object per line.")
+        subparser.addArgument("--ignore-stories")
+                .help("Don’t receive story messages from the server.")
+                .action(Arguments.storeTrue());
+        subparser.addArgument("--send-read-receipts")
+                .help("Send read receipts for all incoming data messages (in addition to the default delivery receipts)")

                 .action(Arguments.storeTrue());
     }
 
     @Override
                 .action(Arguments.storeTrue());
     }
 
     @Override

-    public int handleCommand(final Namespace ns, final Manager m) {
-        if (!m.isRegistered()) {
-            System.err.println("User is not registered.");
-            return 1;
+    public List<OutputType> getSupportedOutputTypes() {
+        return List.of(OutputType.PLAIN_TEXT, OutputType.JSON);
+    }
+
+    @Override
+    public void handleCommand(
+            final Namespace ns, final Manager m, final OutputWriter outputWriter
+    ) throws CommandException {
+        logger.info("Starting daemon in single-account mode for " + m.getSelfNumber());
+        final var noReceiveStdOut = Boolean.TRUE.equals(ns.getBoolean("no-receive-stdout"));
+        final var receiveMode = ns.<ReceiveMode>get("receive-mode");
+        final var ignoreAttachments = Boolean.TRUE.equals(ns.getBoolean("ignore-attachments"));
+        final var ignoreStories = Boolean.TRUE.equals(ns.getBoolean("ignore-stories"));
+        final var sendReadReceipts = Boolean.TRUE.equals(ns.getBoolean("send-read-receipts"));
+
+        m.setReceiveConfig(new ReceiveConfig(ignoreAttachments, ignoreStories, sendReadReceipts));
+        addDefaultReceiveHandler(m, noReceiveStdOut ? null : outputWriter, receiveMode != ReceiveMode.ON_START);
+
+        final Channel inheritedChannel;
+        try {
+            inheritedChannel = System.inheritedChannel();
+            if (inheritedChannel instanceof ServerSocketChannel serverChannel) {
+                logger.info("Using inherited socket: " + serverChannel.getLocalAddress());
+                runSocketSingleAccount(m, serverChannel, receiveMode == ReceiveMode.MANUAL);
+            }
+        } catch (IOException e) {
+            throw new IOErrorException("Failed to use inherited socket", e);
+        }
+        final var socketFile = ns.<File>get("socket");
+        if (socketFile != null) {
+            final var address = UnixDomainSocketAddress.of(socketFile.toPath());
+            final var serverChannel = IOUtils.bindSocket(address);
+            runSocketSingleAccount(m, serverChannel, receiveMode == ReceiveMode.MANUAL);
+        }
+        final var tcpAddress = ns.getString("tcp");
+        if (tcpAddress != null) {
+            final var address = IOUtils.parseInetSocketAddress(tcpAddress);
+            final var serverChannel = IOUtils.bindSocket(address);
+            runSocketSingleAccount(m, serverChannel, receiveMode == ReceiveMode.MANUAL);
+        }
+        final var httpAddress = ns.getString("http");
+        if (httpAddress != null) {
+            final var address = IOUtils.parseInetSocketAddress(httpAddress);
+            final var handler = new HttpServerHandler(address, m);
+            try {
+                handler.init();
+            } catch (IOException ex) {
+                throw new IOErrorException("Failed to initialize HTTP Server", ex);
+            }
+        }
+        final var isDbusSystem = Boolean.TRUE.equals(ns.getBoolean("dbus-system"));
+        if (isDbusSystem) {
+            runDbusSingleAccount(m, true, receiveMode != ReceiveMode.ON_START);
+        }
+        final var isDbusSession = Boolean.TRUE.equals(ns.getBoolean("dbus"));
+        if (isDbusSession || (
+                !isDbusSystem
+                        && socketFile == null
+                        && tcpAddress == null
+                        && !(inheritedChannel instanceof ServerSocketChannel)
+        )) {
+            runDbusSingleAccount(m, false, receiveMode != ReceiveMode.ON_START);

         }
         }

-        DBusConnection conn = null;
+
+        m.addClosedListener(() -> {
+            synchronized (this) {
+                notifyAll();
+            }
+        });
+
+        synchronized (this) {
+            try {
+                wait();
+            } catch (InterruptedException ignored) {
+            }
+        }
+    }
+
+    @Override
+    public void handleCommand(
+            final Namespace ns, final MultiAccountManager c, final OutputWriter outputWriter
+    ) throws CommandException {
+        logger.info("Starting daemon in multi-account mode");
+        final var noReceiveStdOut = Boolean.TRUE.equals(ns.getBoolean("no-receive-stdout"));
+        final var receiveMode = ns.<ReceiveMode>get("receive-mode");
+        final var ignoreAttachments = Boolean.TRUE.equals(ns.getBoolean("ignore-attachments"));
+        final var ignoreStories = Boolean.TRUE.equals(ns.getBoolean("ignore-stories"));
+        final var sendReadReceipts = Boolean.TRUE.equals(ns.getBoolean("send-read-receipts"));
+
+        final var receiveConfig = new ReceiveConfig(ignoreAttachments, ignoreStories, sendReadReceipts);
+        c.getManagers().forEach(m -> {
+            m.setReceiveConfig(receiveConfig);
+            addDefaultReceiveHandler(m, noReceiveStdOut ? null : outputWriter, receiveMode != ReceiveMode.ON_START);
+        });
+        c.addOnManagerAddedHandler(m -> {
+            m.setReceiveConfig(receiveConfig);
+            addDefaultReceiveHandler(m, noReceiveStdOut ? null : outputWriter, receiveMode != ReceiveMode.ON_START);
+        });
+
+        final Channel inheritedChannel;

         try {
         try {

+            inheritedChannel = System.inheritedChannel();
+            if (inheritedChannel instanceof ServerSocketChannel serverChannel) {
+                logger.info("Using inherited socket: " + serverChannel.getLocalAddress());
+                runSocketMultiAccount(c, serverChannel, receiveMode == ReceiveMode.MANUAL);
+            }
+        } catch (IOException e) {
+            throw new IOErrorException("Failed to use inherited socket", e);
+        }
+        final var socketFile = ns.<File>get("socket");
+        if (socketFile != null) {
+            final var address = UnixDomainSocketAddress.of(socketFile.toPath());
+            final var serverChannel = IOUtils.bindSocket(address);
+            runSocketMultiAccount(c, serverChannel, receiveMode == ReceiveMode.MANUAL);
+        }
+        final var tcpAddress = ns.getString("tcp");
+        if (tcpAddress != null) {
+            final var address = IOUtils.parseInetSocketAddress(tcpAddress);
+            final var serverChannel = IOUtils.bindSocket(address);
+            runSocketMultiAccount(c, serverChannel, receiveMode == ReceiveMode.MANUAL);
+        }
+        final var httpAddress = ns.getString("http");
+        if (httpAddress != null) {
+            final var address = IOUtils.parseInetSocketAddress(httpAddress);
+            final var handler = new HttpServerHandler(address, c);
+            try {
+                handler.init();
+            } catch (IOException ex) {
+                throw new IOErrorException("Failed to initialize HTTP Server", ex);
+            }
+        }
+        final var isDbusSystem = Boolean.TRUE.equals(ns.getBoolean("dbus-system"));
+        if (isDbusSystem) {
+            runDbusMultiAccount(c, receiveMode != ReceiveMode.ON_START, true);
+        }
+        final var isDbusSession = Boolean.TRUE.equals(ns.getBoolean("dbus"));
+        if (isDbusSession || (
+                !isDbusSystem
+                        && socketFile == null
+                        && tcpAddress == null
+                        && !(inheritedChannel instanceof ServerSocketChannel)
+        )) {
+            runDbusMultiAccount(c, receiveMode != ReceiveMode.ON_START, false);
+        }
+
+        synchronized (this) {

             try {
             try {

-                int busType;
-                if (ns.getBoolean("system")) {
-                    busType = DBusConnection.SYSTEM;
-                } else {
-                    busType = DBusConnection.SESSION;
+                wait();
+            } catch (InterruptedException ignored) {
+            }
+        }
+    }
+
+    private void addDefaultReceiveHandler(Manager m, OutputWriter outputWriter, final boolean isWeakListener) {
+        final var handler = outputWriter instanceof JsonWriter o
+                ? new JsonReceiveMessageHandler(m, o)
+                : outputWriter instanceof PlainTextWriter o
+                        ? new ReceiveMessageHandler(m, o)
+                        : Manager.ReceiveMessageHandler.EMPTY;
+        m.addReceiveHandler(handler, isWeakListener);
+    }
+
+    private void runSocketSingleAccount(
+            final Manager m, final ServerSocketChannel serverChannel, final boolean noReceiveOnStart
+    ) {
+        runSocket(serverChannel, channel -> {
+            final var handler = getSignalJsonRpcDispatcherHandler(channel, noReceiveOnStart);
+            handler.handleConnection(m);
+        });
+    }
+
+    private void runSocketMultiAccount(
+            final MultiAccountManager c, final ServerSocketChannel serverChannel, final boolean noReceiveOnStart
+    ) {
+        runSocket(serverChannel, channel -> {
+            final var handler = getSignalJsonRpcDispatcherHandler(channel, noReceiveOnStart);
+            handler.handleConnection(c);
+        });
+    }
+
+    private static final AtomicInteger threadNumber = new AtomicInteger(0);
+
+    private void runSocket(final ServerSocketChannel serverChannel, Consumer<SocketChannel> socketHandler) {
+        final var thread = new Thread(() -> {
+            while (true) {
+                final var connectionId = threadNumber.getAndIncrement();
+                final SocketChannel channel;
+                final String clientString;
+                try {
+                    channel = serverChannel.accept();
+                    clientString = channel.getRemoteAddress() + " " + IOUtils.getUnixDomainPrincipal(channel);
+                    logger.info("Accepted new client connection {}: {}", connectionId, clientString);
+                } catch (IOException e) {
+                    logger.error("Failed to accept new socket connection", e);
+                    synchronized (this) {
+                        notifyAll();
+                    }
+                    break;

                 }
                 }

-                conn = DBusConnection.getConnection(busType);
-                conn.exportObject(SIGNAL_OBJECTPATH, m);
-                conn.requestBusName(SIGNAL_BUSNAME);
-            } catch (UnsatisfiedLinkError e) {
-                System.err.println("Missing native library dependency for dbus service: " + e.getMessage());
-                return 1;
-            } catch (DBusException e) {
-                e.printStackTrace();
-                return 2;
+                final var connectionThread = new Thread(() -> {
+                    try (final var c = channel) {
+                        socketHandler.accept(c);
+                    } catch (IOException e) {
+                        logger.warn("Failed to close channel", e);
+                    } catch (Throwable e) {
+                        logger.warn("Connection handler failed, closing connection", e);
+                    }
+                    logger.info("Connection {} closed: {}", connectionId, clientString);
+                });
+                connectionThread.setName("daemon-connection-" + connectionId);
+                connectionThread.start();

             }
             }

-            boolean ignoreAttachments = ns.getBoolean("ignore_attachments");
+        });
+        thread.setName("daemon-listener");
+        thread.start();
+    }
+
+    private SignalJsonRpcDispatcherHandler getSignalJsonRpcDispatcherHandler(
+            final SocketChannel c, final boolean noReceiveOnStart
+    ) {
+        final var lineSupplier = IOUtils.getLineSupplier(Channels.newReader(c, StandardCharsets.UTF_8));
+        final var jsonOutputWriter = new JsonWriterImpl(Channels.newWriter(c, StandardCharsets.UTF_8));
+
+        return new SignalJsonRpcDispatcherHandler(jsonOutputWriter, lineSupplier, noReceiveOnStart);
+    }
+
+    private void runDbusSingleAccount(
+            final Manager m, final boolean isDbusSystem, final boolean noReceiveOnStart
+    ) throws CommandException {
+        runDbus(isDbusSystem, (conn, objectPath) -> {

             try {
             try {

-                m.receiveMessages(1, TimeUnit.HOURS, false, ignoreAttachments, ns.getBoolean("json") ? new JsonDbusReceiveMessageHandler(m, conn, SIGNAL_OBJECTPATH) : new DbusReceiveMessageHandler(m, conn, SIGNAL_OBJECTPATH));
-                return 0;
-            } catch (IOException e) {
-                System.err.println("Error while receiving messages: " + e.getMessage());
-                return 3;
-            } catch (AssertionError e) {
-                handleAssertionError(e);
-                return 1;
+                exportDbusObject(conn, objectPath, m, noReceiveOnStart).join();
+            } catch (InterruptedException ignored) {

             }
             }

-        } finally {
-            if (conn != null) {
-                conn.disconnect();
+        });
+    }
+
+    private void runDbusMultiAccount(
+            final MultiAccountManager c, final boolean noReceiveOnStart, final boolean isDbusSystem
+    ) throws CommandException {
+        runDbus(isDbusSystem, (connection, objectPath) -> {
+            final var signalControl = new DbusSignalControlImpl(c, objectPath);
+            connection.exportObject(signalControl);
+
+            c.addOnManagerAddedHandler(m -> {
+                final var thread = exportMultiAccountManager(connection, m, noReceiveOnStart);
+                try {
+                    thread.join();
+                } catch (InterruptedException ignored) {
+                }
+            });
+            c.addOnManagerRemovedHandler(m -> {
+                final var path = DbusConfig.getObjectPath(m.getSelfNumber());
+                try {
+                    final var object = connection.getExportedObject(null, path);
+                    if (object instanceof DbusSignalImpl dbusSignal) {
+                        dbusSignal.close();
+                    }
+                } catch (DBusException ignored) {
+                }
+            });
+
+            final var initThreads = c.getManagers()
+                    .stream()
+                    .map(m -> exportMultiAccountManager(connection, m, noReceiveOnStart))
+                    .toList();
+
+            for (var t : initThreads) {
+                try {
+                    t.join();
+                } catch (InterruptedException ignored) {
+                }

             }
             }

+        });
+    }
+
+    private void runDbus(
+            final boolean isDbusSystem, DbusRunner dbusRunner
+    ) throws CommandException {
+        DBusConnection.DBusBusType busType;
+        if (isDbusSystem) {
+            busType = DBusConnection.DBusBusType.SYSTEM;
+        } else {
+            busType = DBusConnection.DBusBusType.SESSION;
+        }
+        DBusConnection conn;
+        try {
+            conn = DBusConnectionBuilder.forType(busType).build();
+            dbusRunner.run(conn, DbusConfig.getObjectPath());
+        } catch (DBusException e) {
+            throw new UnexpectedErrorException("Dbus command failed: " + e.getMessage(), e);
+        } catch (UnsupportedOperationException e) {
+            throw new UserErrorException("Failed to connect to Dbus: " + e.getMessage(), e);
+        }
+
+        try {
+            conn.requestBusName(DbusConfig.getBusname());
+        } catch (DBusException e) {
+            throw new UnexpectedErrorException("Dbus command failed, maybe signal-cli dbus daemon is already running: "
+                    + e.getMessage(), e);

         }
         }

+
+        logger.info("DBus daemon running on {} bus: {}", busType, DbusConfig.getBusname());
+    }
+
+    private Thread exportMultiAccountManager(
+            final DBusConnection conn, final Manager m, final boolean noReceiveOnStart
+    ) {
+        final var objectPath = DbusConfig.getObjectPath(m.getSelfNumber());
+        return exportDbusObject(conn, objectPath, m, noReceiveOnStart);
+    }
+
+    private Thread exportDbusObject(
+            final DBusConnection conn, final String objectPath, final Manager m, final boolean noReceiveOnStart
+    ) {
+        final var signal = new DbusSignalImpl(m, conn, objectPath, noReceiveOnStart);
+        final var initThread = new Thread(signal::initObjects);
+        initThread.setName("dbus-init");
+        initThread.start();
+
+        return initThread;
+    }
+
+    interface DbusRunner {
+
+        void run(DBusConnection connection, String objectPath) throws DBusException;

     }
 }
     }
 }