Use improved shutdown for daemon command

[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 7b6f243d74c24cdc66d6378b3ebd4cd7217c25c9..209b071c9f4045259a7e1cfcff504bdba99b75bb 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/DaemonCommand.java
+++ b/src/main/java/org/asamk/signal/commands/DaemonCommand.java
@@ -5,141 +5,448 @@ import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 
 import org.asamk.signal.DbusConfig;
 import net.sourceforge.argparse4j.inf.Subparser;
 
 import org.asamk.signal.DbusConfig;

-import org.asamk.signal.DbusReceiveMessageHandler;
-import org.asamk.signal.JsonDbusReceiveMessageHandler;
-import org.asamk.signal.JsonWriter;

 import org.asamk.signal.OutputType;
 import org.asamk.signal.OutputType;

-import org.asamk.signal.OutputWriter;
-import org.asamk.signal.PlainTextWriter;
+import org.asamk.signal.ReceiveMessageHandler;
+import org.asamk.signal.Shutdown;

 import org.asamk.signal.commands.exceptions.CommandException;
 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.UnexpectedErrorException;

+import org.asamk.signal.commands.exceptions.UserErrorException;

 import org.asamk.signal.dbus.DbusSignalControlImpl;
 import org.asamk.signal.dbus.DbusSignalImpl;
 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.asamk.signal.manager.MultiAccountManager;
+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.DBusConnection;

+import org.freedesktop.dbus.connections.impl.DBusConnectionBuilder;

 import org.freedesktop.dbus.exceptions.DBusException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 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.net.InetSocketAddress;
+import java.net.UnixDomainSocketAddress;
+import java.nio.channels.Channel;
+import java.nio.channels.Channels;
+import java.nio.channels.ClosedChannelException;
+import java.nio.channels.ServerSocketChannel;
+import java.nio.channels.SocketChannel;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;

 import java.util.List;
 import java.util.List;

-import java.util.Set;
-import java.util.concurrent.TimeUnit;
+import java.util.concurrent.Executors;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.Consumer;

 
 

-public class DaemonCommand implements MultiLocalCommand {
+import static org.asamk.signal.util.CommandUtil.getReceiveConfig;
+
+public class DaemonCommand implements MultiLocalCommand, LocalCommand {

 
     private final static Logger logger = LoggerFactory.getLogger(DaemonCommand.class);
 
     private final static Logger logger = LoggerFactory.getLogger(DaemonCommand.class);

-    private final OutputWriter outputWriter;

 
 

-    public static void attachToSubparser(final Subparser subparser) {
-        subparser.help("Run in daemon mode and provide an experimental dbus interface.");
-        subparser.addArgument("--system")
+    @Override
+    public String getName() {
+        return "daemon";
+    }
+
+    @Override
+    public void attachToSubparser(final Subparser subparser) {
+        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 (default localhost:8080).");
+        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());

-    }
-
-    public DaemonCommand(final OutputWriter outputWriter) {
-        this.outputWriter = outputWriter;
+        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
     }
 
     @Override

-    public Set<OutputType> getSupportedOutputTypes() {
-        return Set.of(OutputType.PLAIN_TEXT, OutputType.JSON);
+    public List<OutputType> getSupportedOutputTypes() {
+        return List.of(OutputType.PLAIN_TEXT, OutputType.JSON);

     }
 
     @Override
     }
 
     @Override

-    public void handleCommand(final Namespace ns, final Manager m) throws CommandException {
-        boolean ignoreAttachments = ns.getBoolean("ignore-attachments");
+    public void handleCommand(
+            final Namespace ns, final Manager m, final OutputWriter outputWriter
+    ) throws CommandException {
+        Shutdown.installHandler();
+        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 receiveConfig = getReceiveConfig(ns);

 
 

-        DBusConnection.DBusBusType busType;
-        if (ns.getBoolean("system")) {
-            busType = DBusConnection.DBusBusType.SYSTEM;
-        } else {
-            busType = DBusConnection.DBusBusType.SESSION;
-        }
+        m.setReceiveConfig(receiveConfig);
+        addDefaultReceiveHandler(m, noReceiveStdOut ? null : outputWriter, receiveMode != ReceiveMode.ON_START);

 
 

-        try (var conn = DBusConnection.getConnection(busType)) {
-            var objectPath = DbusConfig.getObjectPath();
-            var t = run(conn, objectPath, m, ignoreAttachments);
+        try (final var daemonHandler = new SingleAccountDaemonHandler(m, receiveMode)) {
+            setup(ns, daemonHandler);

 
 

-            conn.requestBusName(DbusConfig.getBusname());
+            m.addClosedListener(Shutdown::triggerShutdown);

 
             try {
 
             try {

-                t.join();
+                Shutdown.waitForShutdown();

             } catch (InterruptedException ignored) {
             }
             } catch (InterruptedException ignored) {
             }

-        } catch (DBusException | IOException e) {
-            logger.error("Dbus command failed", e);
-            throw new UnexpectedErrorException("Dbus command failed");

         }
     }
 
     @Override
     public void handleCommand(
         }
     }
 
     @Override
     public void handleCommand(

-            final Namespace ns, final List<Manager> managers, SignalCreator c
+            final Namespace ns, final MultiAccountManager c, final OutputWriter outputWriter

     ) throws CommandException {
     ) throws CommandException {

-        boolean ignoreAttachments = ns.getBoolean("ignore-attachments");
+        Shutdown.installHandler();
+        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 receiveConfig = getReceiveConfig(ns);
+        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);
+        });

 
 

-        DBusConnection.DBusBusType busType;
-        if (ns.getBoolean("system")) {
-            busType = DBusConnection.DBusBusType.SYSTEM;
-        } else {
-            busType = DBusConnection.DBusBusType.SESSION;
-        }
+        try (final var daemonHandler = new MultiAccountDaemonHandler(c, receiveMode)) {
+            setup(ns, daemonHandler);

 
 

-        try (var conn = DBusConnection.getConnection(busType)) {
-            final var signalControl = new DbusSignalControlImpl(c, m -> {
+            synchronized (this) {

                 try {
                 try {

-                    final var objectPath = DbusConfig.getObjectPath(m.getUsername());
-                    return run(conn, objectPath, m, ignoreAttachments);
-                } catch (DBusException e) {
-                    logger.error("Failed to export object", e);
-                    return null;
+                    Shutdown.waitForShutdown();
+                } catch (InterruptedException ignored) {

                 }
                 }

-            }, DbusConfig.getObjectPath());
-            conn.exportObject(signalControl);
+            }
+        }
+    }

 
 

-            for (var m : managers) {
-                signalControl.addManager(m);
+    private static void setup(final Namespace ns, final DaemonHandler daemonHandler) throws CommandException {
+        final Channel inheritedChannel;
+        try {
+            inheritedChannel = System.inheritedChannel();
+            if (inheritedChannel instanceof ServerSocketChannel serverChannel) {
+                logger.info("Using inherited socket: " + serverChannel.getLocalAddress());
+                daemonHandler.runSocket(serverChannel);

             }
             }

+        } catch (IOException e) {
+            throw new IOErrorException("Failed to use inherited socket", e);
+        }

 
 

-            conn.requestBusName(DbusConfig.getBusname());
+        final var socketFile = ns.<File>get("socket");
+        if (socketFile != null) {
+            final var address = UnixDomainSocketAddress.of(socketFile.toPath());
+            final var serverChannel = IOUtils.bindSocket(address);
+            daemonHandler.runSocket(serverChannel);
+        }

 
 

-            signalControl.run();
-        } catch (DBusException | IOException e) {
-            logger.error("Dbus command failed", e);
-            throw new UnexpectedErrorException("Dbus command failed");
+        final var tcpAddress = ns.getString("tcp");
+        if (tcpAddress != null) {
+            final var address = IOUtils.parseInetSocketAddress(tcpAddress);
+            final var serverChannel = IOUtils.bindSocket(address);
+            daemonHandler.runSocket(serverChannel);

         }
         }

+
+        final var httpAddress = ns.getString("http");
+        if (httpAddress != null) {
+            final var address = IOUtils.parseInetSocketAddress(httpAddress);
+            daemonHandler.runHttp(address);
+        }
+
+        final var isDbusSystem = Boolean.TRUE.equals(ns.getBoolean("dbus-system"));
+        if (isDbusSystem) {
+            daemonHandler.runDbus(true);
+        }
+
+        final var isDbusSession = Boolean.TRUE.equals(ns.getBoolean("dbus"));
+        if (isDbusSession || (
+                !isDbusSystem
+                        && socketFile == null
+                        && tcpAddress == null
+                        && httpAddress == null
+                        && !(inheritedChannel instanceof ServerSocketChannel)
+        )) {
+            daemonHandler.runDbus(false);
+        }
+    }
+
+    private void addDefaultReceiveHandler(Manager m, OutputWriter outputWriter, final boolean isWeakListener) {
+        final var handler = switch (outputWriter) {
+            case PlainTextWriter writer -> new ReceiveMessageHandler(m, writer);
+            case JsonWriter writer -> new JsonReceiveMessageHandler(m, writer);
+            case null -> Manager.ReceiveMessageHandler.EMPTY;
+        };
+        m.addReceiveHandler(handler, isWeakListener);

     }
 
     }
 

-    private Thread run(
-            DBusConnection conn, String objectPath, Manager m, boolean ignoreAttachments
-    ) throws DBusException {
-        conn.exportObject(new DbusSignalImpl(m, objectPath));
+    private static abstract class DaemonHandler implements AutoCloseable {
+
+        protected final ReceiveMode receiveMode;
+        protected final List<AutoCloseable> closeables = new ArrayList<>();
+
+        private static final AtomicInteger threadNumber = new AtomicInteger(0);
+
+        public DaemonHandler(final ReceiveMode receiveMode) {
+            this.receiveMode = receiveMode;
+        }
+
+        public abstract void runSocket(ServerSocketChannel serverChannel) throws CommandException;

 
 

-        logger.info("Exported dbus object: " + objectPath);
+        public abstract void runDbus(boolean isDbusSystem) throws CommandException;
+
+        public abstract void runHttp(InetSocketAddress address) throws CommandException;
+
+        protected void runSocket(final ServerSocketChannel serverChannel, Consumer<SocketChannel> socketHandler) {
+            final List<AutoCloseable> channels = new ArrayList<>();
+            final var thread = Thread.ofPlatform().name("daemon-listener").start(() -> {
+                try (final var executor = Executors.newCachedThreadPool()) {
+                    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 (ClosedChannelException ignored) {
+                            logger.trace("Listening socket has been closed");
+                            break;
+                        } catch (IOException e) {
+                            logger.error("Failed to accept new socket connection", e);
+                            break;
+                        }
+                        channels.add(channel);
+                        executor.submit(() -> {
+                            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);
+                            channels.remove(channel);
+                        });
+                    }
+                }
+            });
+            closeables.add(() -> {
+                serverChannel.close();
+                for (final var c : new ArrayList<>(channels)) {
+                    c.close();
+                }
+                thread.join();
+            });
+        }
+
+        protected SignalJsonRpcDispatcherHandler getSignalJsonRpcDispatcherHandler(final SocketChannel c) {
+            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,
+                    receiveMode == ReceiveMode.MANUAL);
+        }
+
+        protected Thread exportDbusObject(final DBusConnection conn, final String objectPath, final Manager m) {
+            final var signal = new DbusSignalImpl(m, conn, objectPath, receiveMode != ReceiveMode.ON_START);
+            closeables.add(signal);
+
+            return Thread.ofPlatform().name("dbus-init-" + m.getSelfNumber()).start(signal::initObjects);
+        }

 
 

-        final var thread = new Thread(() -> {
-            while (!Thread.interrupted()) {
+        protected void runDbus(
+                final boolean isDbusSystem, MultiAccountDaemonHandler.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);
+            }
+            closeables.add(conn);
+
+            logger.info("DBus daemon running on {} bus: {}", busType, DbusConfig.getBusname());
+        }
+
+        @Override
+        public void close() {
+            for (final var closeable : new ArrayList<>(closeables)) {

                 try {
                 try {

-                    final var receiveMessageHandler = outputWriter instanceof JsonWriter
-                            ? new JsonDbusReceiveMessageHandler(m, (JsonWriter) outputWriter, conn, objectPath)
-                            : new DbusReceiveMessageHandler(m, (PlainTextWriter) outputWriter, conn, objectPath);
-                    m.receiveMessages(1, TimeUnit.HOURS, false, ignoreAttachments, receiveMessageHandler);
-                    break;
-                } catch (IOException e) {
-                    logger.warn("Receiving messages failed, retrying", e);
+                    closeable.close();
+                } catch (Exception e) {
+                    logger.warn("Failed to close daemon handler", e);
+                }
+            }
+            closeables.clear();
+        }
+    }
+
+    private static final class SingleAccountDaemonHandler extends DaemonHandler {
+
+        private final Manager m;
+
+        private SingleAccountDaemonHandler(final Manager m, final ReceiveMode receiveMode) {
+            super(receiveMode);
+            this.m = m;
+        }
+
+        @Override
+        public void runSocket(final ServerSocketChannel serverChannel) {
+            runSocket(serverChannel, channel -> {
+                final var handler = getSignalJsonRpcDispatcherHandler(channel);
+                handler.handleConnection(m);
+            });
+        }
+
+        @Override
+        public void runDbus(final boolean isDbusSystem) throws CommandException {
+            runDbus(isDbusSystem, (conn, objectPath) -> {
+                try {
+                    exportDbusObject(conn, objectPath, m).join();

                 } catch (InterruptedException ignored) {
                 } catch (InterruptedException ignored) {

-                    break;

                 }
                 }

+            });
+        }
+
+        @Override
+        public void runHttp(InetSocketAddress address) throws CommandException {
+            final var handler = new HttpServerHandler(address, m);
+            try {
+                handler.init();
+            } catch (IOException ex) {
+                throw new IOErrorException("Failed to initialize HTTP Server", ex);
+            }
+            this.closeables.add(handler);
+        }
+    }
+
+    private static final class MultiAccountDaemonHandler extends DaemonHandler {
+
+        private final MultiAccountManager c;
+
+        private MultiAccountDaemonHandler(final MultiAccountManager c, final ReceiveMode receiveMode) {
+            super(receiveMode);
+            this.c = c;
+        }
+
+        public void runSocket(final ServerSocketChannel serverChannel) {
+            runSocket(serverChannel, channel -> {
+                final var handler = getSignalJsonRpcDispatcherHandler(channel);
+                handler.handleConnection(c);
+            });
+        }
+
+        public void runDbus(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 = exportManager(connection, m);
+                    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();
+                            closeables.remove(dbusSignal);
+                        }
+                    } catch (DBusException ignored) {
+                    }
+                });
+
+                final var initThreads = c.getManagers().stream().map(m -> exportManager(connection, m)).toList();
+
+                for (var t : initThreads) {
+                    try {
+                        t.join();
+                    } catch (InterruptedException ignored) {
+                    }
+                }
+            });
+        }
+
+        @Override
+        public void runHttp(final InetSocketAddress address) throws CommandException {
+            final var handler = new HttpServerHandler(address, c);
+            try {
+                handler.init();
+            } catch (IOException ex) {
+                throw new IOErrorException("Failed to initialize HTTP Server", ex);

             }
             }

-        });
+            this.closeables.add(handler);
+        }

 
 

-        thread.start();
+        private Thread exportManager(
+                final DBusConnection conn, final Manager m
+        ) {
+            final var objectPath = DbusConfig.getObjectPath(m.getSelfNumber());
+            return exportDbusObject(conn, objectPath, m);
+        }

 
 

-        return thread;
+        interface DbusRunner {
+
+            void run(DBusConnection connection, String objectPath) throws DBusException;
+        }

     }
 }
     }
 }