From 0fdf59b9f058789c3acf73bc7e95520655f9718a Mon Sep 17 00:00:00 2001
From: Sunil Mohan Adapa <sunil@medhas.org>
Date: Wed, 17 Sep 2025 13:52:14 -0700
Subject: [PATCH] privileged_daemon: Implement handling termination signal

- And gracefully terminate the process after finishing the current requests
underway.

Tests:

- Trigger a long operation such as an app installation. While the operation is
underway, run 'systemctl stop freedombox-privilved.service'. Journal will show
that the SIGTERM is handled and shutdown is more or less immediately complete.
However, the whole process will wait until the ongoing request is complete and
then exit.

- During the wait period, no new requests are accepted as experienced with
'freedombox-cmd plinth is_package_manager_busy --no-args' command.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Veiko Aasa <veiko17@disroot.org>
---
 plinth/privileged_daemon.py | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/plinth/privileged_daemon.py b/plinth/privileged_daemon.py
index 66102718e..3b31ec900 100644
--- a/plinth/privileged_daemon.py
+++ b/plinth/privileged_daemon.py
@@ -8,10 +8,12 @@ import logging
 import os
 import pathlib
 import pwd
+import signal
 import socket
 import socketserver
 import struct
 import sys
+import threading
 import time
 
 import systemd.daemon
@@ -28,6 +30,8 @@ FREEDOMBOX_PROCESS_USER = 'plinth'
 
 MAX_REQUEST_LENGTH = 1_000_000
 
+_server = None
+
 idle_shutdown_time: int | None = 5 * 60  # 5 minutes
 
 freedombox_develop = False
@@ -245,6 +249,25 @@ def client_main() -> None:
         sys.exit(1)
 
 
+def _on_sigterm(signal_number: int, frame) -> None:
+    """Handle SIGTERM signal. Issue server shutdown."""
+    threading.Thread(target=_shutdown_server).start()
+
+
+def _shutdown_server() -> None:
+    """Issue a shutdown request to the server.
+
+    This must be run in a thread separate from the server.serve_forever()
+    otherwise it will deadlock waiting for the shutdown to complete.
+    """
+    global _server
+    logger.info('SIGTERM received, shutting down the server.')
+    if _server:
+        _server.shutdown()
+
+    logger.info('Shutdown complete, some requests may be running.')
+
+
 def main() -> None:
     """Start the server, listen on socket, and serve forever."""
     global freedombox_develop, idle_shutdown_time
@@ -263,10 +286,15 @@ def main() -> None:
     if not systemd.daemon.listen_fds(unset_environment=False):
         idle_shutdown_time = None
 
+    signal.signal(signal.SIGTERM, _on_sigterm)
+
     module_loader.load_modules()
     app_module.apps_init()
 
     with Server(str(address), RequestHandler) as server:
+        global _server
+        _server = server  # Reference needed to shutdown the server.
+
         # systemd will wait until notification to proceed with other processes.
         # We have service Type=notify.
         systemd.daemon.notify('READY=1')
@@ -283,6 +311,11 @@ def main() -> None:
         else:
             logger.info('FreedomBox privileged daemon exiting.')
 
+        # Exit the context manager. This calls server.close() which waits on
+        # all pending request threads to complete.
+
+    logger.info('All requested completed. Exit.')
+
 
 if __name__ == '__main__':
     main()