Merge pull request automatic-ripping-machine#1730 from microtechno9000/bugfix_armui_service

[BUGFIX] Gracefull shutdown of armui service outside docker

Author: microtechno9000

VERSION

@@ -1 +1 @@
-2.23.1
+2.23.2

arm/runui.py

@@ -2,6 +2,7 @@
 """Main run page for armui"""
 import os
 import sys
+import signal
 
 # set the PATH to /arm/arm, so we can handle imports properly
 sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
@@ -13,24 +14,45 @@
 
 from arm.ui import app  # noqa E402
 
+shutdown_requested = False
+
 
 def startup():
+    """ARM UI Startup check on database config"""
     db_update = arm.ui.utils.arm_db_check()
     if db_update["db_current"]:
         app.logger.info("Updating Optical Drives")
         arm.ui.settings.DriveUtils.drives_update(startup=True)
 
 
+def handle_shutdown(signum, frame):
+    """ARM handle SIGTERM/SIGINT for graceful shutdown"""
+    global shutdown_requested
+    shutdown_requested = True
+    app.logger.info("Received shutdown signal (%s). Shutting down ARM-UI.", signum)
+    sys.exit(0)
+
+
+# Register signal handlers
+signal.signal(signal.SIGTERM, handle_shutdown)      # systemd shutdown command
+signal.signal(signal.SIGINT, handle_shutdown)       # keyboard interrupt
+
+
 def is_docker():
     """
     Test to check if running inside a docker/container
     returns: Boolean
     """
     path = '/proc/self/cgroup'
-    return (
-            os.path.exists('/.dockerenv') or
-            os.path.isfile(path) and any('docker' in line for line in open(path))
-    )
+
+    if os.path.exists('/.dockerenv'):
+        return True
+
+    if os.path.isfile(path):
+        with open(path) as f:
+            return any('docker' in line for line in f)
+
+    return False
 
 
 def get_host():
@@ -59,6 +81,15 @@ def get_host():
     host = get_host()
     port = cfg.arm_config['WEBSERVER_PORT']
     app.logger.info("Starting ARM-UI on interface address - %s:%s", host, port)
+
+    # Run ARM Startup
     startup()
+
     from waitress import serve
-    serve(app, host=host, port=port, threads=40)
+
+    try:
+        serve(app, host=host, port=port, threads=40)
+    except KeyboardInterrupt:
+        app.logger.info("Keyboard interrupt received, shutting down ARM-UI.")
+    finally:
+        app.logger.info("ARM-UI shutdown complete.")

scripts/installers/DebianInstaller.sh

@@ -960,7 +960,7 @@ function SetupFolders() {
 
 function CreateAndStartService() {
   echo -e "${RED}Installing ARM service${NC}"
-  cp /opt/arm/setup/arm.service /lib/systemd/system/armui.service
+  cp /opt/arm/setup/armui.service /lib/systemd/system/armui.service
   systemctl daemon-reload
   systemctl enable armui
   systemctl start armui

setup/arm.service

@@ -1,21 +1,31 @@
 [Unit]
-Description=Arm service
+Description=ARM service
 ## Added to force armui to wait for network
 After=network-online.target
 Wants=network-online.target
+## Shutdown ARM before system shutdown
+Before=shutdown.target
 
 [Service]
 Type=simple
 User=arm
 Group=arm
-## Add your path to your logfiles if you want to enable logging
-## Remember to remove the # at the start of the line
+## Define log paths
 StandardOutput=append:/home/arm/logs/WebUI.log
 StandardError=append:/home/arm/logs/WebUI.log
 Restart=always
 RestartSec=3
 ExecStartPre=/bin/bash -xc '/usr/bin/systemctl is-active --quiet armui.service && exit 1 || exit 0'
 ExecStart=/opt/arm/venv/bin/python3 /opt/arm/arm/runui.py
 
+## Allow ARM to run in protected ports (ei: ports 1~1024)
+AmbientCapabilities=CAP_NET_BIND_SERVICE
+
+## Graceful shutdown behaviour
+KillSignal=SIGTERM
+TimeoutStopSec=60
+KillMode=mixed
+SendSIGKILL=no
+
 [Install]
 WantedBy=multi-user.target