Use Supervisord to manage processes

Dockerfile

@@ -52,6 +52,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     xdg-user-dirs=0.18-1 \
     jo=1.9-1 \
     netcat-traditional=1.10-47 \
+    supervisor=4.2.5-1 \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
@@ -71,6 +72,7 @@ RUN case ${TARGETARCH} in \
     && mv supercronic /usr/local/bin/supercronic
 
 ENV HOME=/home/steam \
+    ARCH=${TARGETARCH} \
     PORT= \
     PUID=1000 \
     PGID=1000 \
@@ -115,8 +117,9 @@ ENV HOME=/home/steam \
     DISABLE_GENERATE_ENGINE=true
 
 COPY ./scripts /home/steam/server/
+COPY ./services /home/steam/server/services/
 
-RUN chmod +x /home/steam/server/*.sh && \
+RUN chmod +x /home/steam/server/*.sh /home/steam/server/services/listener/*.sh && \
     mv /home/steam/server/backup.sh /usr/local/bin/backup && \
     mv /home/steam/server/update.sh /usr/local/bin/update && \
     mv /home/steam/server/restore.sh /usr/local/bin/restore
@@ -133,4 +136,4 @@ HEALTHCHECK --start-period=5m \
     CMD pgrep "PalServer-Linux" > /dev/null || exit 1
 
 EXPOSE ${PORT} ${RCON_PORT}
-ENTRYPOINT ["/home/steam/server/init.sh"]
+ENTRYPOINT [ "/home/steam/server/init.sh" ]

scripts/helper_functions.sh

@@ -103,6 +103,37 @@ get_player_count() {
     return "$return_val"
 }
 
+# Gets the status of a service via supervisorctl
+# Returns 0 if successfull
+# Returns 1 if the service was not found
+getServiceStatus() {
+    local processName="$1"
+    local status
+    status=$(supervisorctl status "$processName" | awk '{print $2}')
+    if [ -z "$status" ] || [ "$status" = "ERROR" ]; then
+        return 1
+    fi
+    echo "$status"
+    return 0
+}
+
+# Gets the PID of a service via supervisorctl
+# Returns 0 if successfull
+# Returns 1 if the service was not found or is not running
+getServicePID() {
+    local processName="$1"
+    local pid
+    if [ "$(getServiceStatus "$processName")" != "RUNNING" ]; then
+        return 1
+    fi
+    pid=$(supervisorctl status "$processName" | awk '{print $4}' | sed 's/,\+$//')
+    if [ -z "$pid" ] || [ "$pid" = "ERROR" ]; then
+        return 1
+    fi
+    echo "$pid"
+    return 0
+}
+
 #
 # Log Definitions
 #

scripts/helper_install.sh

@@ -141,3 +141,45 @@ InstallServer() {
   CreateACFFile "$targetManifest"
   DiscordMessage "Install" "${DISCORD_POST_UPDATE_BOOT_MESSAGE}" "success"
 }
+
+# Builds the start command of the palworld server
+# Returns 0 and outputs the start command if everything is ok
+# Returns 1 if the Server is not found or has the wrong permissions
+BuildStartCommand() {
+    local command
+    # Check if the architecture is arm64
+    if [ "${ARCH}" == "arm64" ]; then
+        command=("/palworld/PalServer-arm64.sh")
+    else
+        command=("/palworld/PalServer.sh")
+    fi
+
+    #Validate Installation
+    if ! fileExists "${command[0]}"; then
+        LogError "Server Not Installed Properly"
+        return 1
+    fi
+
+    isReadable "${command[0]}" || return 1
+    isExecutable "${command[0]}" || return 1
+
+    # Prepare Arguments
+    if [ -n "${PORT}" ]; then
+        command+=("-port=${PORT}")
+    fi
+
+    if [ -n "${QUERY_PORT}" ]; then
+        command+=("-queryport=${QUERY_PORT}")
+    fi
+
+    if [ "${COMMUNITY,,}" = true ]; then
+        command+=("EpicApp=PalServer")
+    fi
+
+    if [ "${MULTITHREADING,,}" = true ]; then
+        command+=("-useperfthreads" "-NoAsyncLoadingThread" "-UseMultithreadForDS")
+    fi
+
+    echo "${command[*]}"
+    return 0
+}

scripts/init.sh

@@ -23,42 +23,11 @@ if ! [ -w "/palworld" ]; then
 fi
 
 mkdir -p /palworld/backups
-
-# shellcheck disable=SC2317
-term_handler() {
-  DiscordMessage "Shutdown" "${DISCORD_PRE_SHUTDOWN_MESSAGE}" "in-progress"
-
-    if ! shutdown_server; then
-        # Does not save
-        kill -SIGTERM "$(pidof PalServer-Linux-Test)"
-    fi
-
-    tail --pid="$killpid" -f 2>/dev/null
-}
-
-trap 'term_handler' SIGTERM
-
 if [[ "$(id -u)" -eq 0 ]]; then
-    su steam -c ./start.sh &
+    su steam -c ./start.sh
 else
-    ./start.sh &
-fi
-# Process ID of su
-killpid="$!"
-wait "$killpid"
-
-mapfile -t backup_pids < <(pgrep backup)
-if [ "${#backup_pids[@]}" -ne 0 ]; then
-    LogInfo "Waiting for backup to finish"
-    for pid in "${backup_pids[@]}"; do
-        tail --pid="$pid" -f 2>/dev/null
-    done
+    ./start.sh
 fi
 
-mapfile -t restore_pids < <(pgrep restore)
-if [ "${#restore_pids[@]}" -ne 0 ]; then
-    LogInfo "Waiting for restore to finish"
-    for pid in "${restore_pids[@]}"; do
-        tail --pid="$pid" -f 2>/dev/null
-    done
-fi
+cp /home/steam/server/services/supervisord.conf /etc/supervisor/supervisord.conf
+exec /usr/bin/supervisord --configuration=/etc/supervisor/supervisord.conf

scripts/server.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+# shellcheck source=scripts/helper_functions.sh
+source "/home/steam/server/helper_functions.sh"
+
+# shellcheck source=scripts/helper_install.sh
+source "/home/steam/server/helper_install.sh"
+
+graceful_shutdown() {
+    if [ "${RCON_ENABLED,,}" = true ]; then
+        shutdown_server
+        wait "$PID"
+    fi
+    exit 0
+}
+
+trap 'graceful_shutdown' TERM INT
+
+STARTCOMMAND=$(BuildStartCommand)
+if [ "$!" == 1 ]; then
+    LogWarn "Server Not Installed Properly"
+    exit 1
+fi
+
+${STARTCOMMAND} &
+PID=$!
+wait "$PID"

scripts/start.sh

@@ -12,10 +12,7 @@ isExecutable "/palworld" || exit
 
 cd /palworld || exit
 
-# Get the architecture using dpkg
-architecture=$(dpkg --print-architecture)
-
-if [ "$architecture" == "arm64" ] && [ "${ARM_COMPATIBILITY_MODE,,}" = true ]; then
+if [ "${ARCH}" == "arm64" ] && [ "${ARM_COMPATIBILITY_MODE,,}" = true ]; then
     LogInfo "ARM compatibility mode enabled"
     export DEBUGGER="/usr/bin/qemu-i386-static"
 
@@ -31,18 +28,7 @@ if [ "$ServerInstalled" == 1 ]; then
     InstallServer
 fi
 
-# Update Only If Already Installed
-if [ "$ServerInstalled" == 0 ] && [ "${UPDATE_ON_BOOT,,}" == true ]; then
-    UpdateRequired
-    IsUpdateRequired=$?
-    if [ "$IsUpdateRequired" == 0 ]; then
-        LogAction "Starting Update"
-        InstallServer
-    fi
-fi
-
-# Check if the architecture is arm64
-if [ "$architecture" == "arm64" ]; then
+if [ "${ARCH}" == "arm64" ]; then
     # create an arm64 version of ./PalServer.sh
     cp ./PalServer.sh ./PalServer-arm64.sh
 
@@ -72,6 +58,18 @@ else
 fi
 
 
+# Update Only If Already Installed
+if [ "$ServerInstalled" == 0 ] && [ "${UPDATE_ON_BOOT,,}" == true ]; then
+    UpdateRequired
+    IsUpdateRequired=$?
+    if [ "$IsUpdateRequired" == 0 ]; then
+        LogAction "Starting Update"
+        InstallServer
+    fi
+fi
+
+
+
 #Validate Installation
 if ! fileExists "${STARTCOMMAND[0]}"; then
     LogError "Server Not Installed Properly"
@@ -111,7 +109,7 @@ if [ "${DISABLE_GENERATE_SETTINGS,,}" = true ]; then
   if [ ! "$(grep -s '[^[:space:]]' /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini)" ]; then
       LogAction "GENERATING CONFIG"
       # Server will generate all ini files after first run.
-      if [ "$architecture" == "arm64" ]; then
+      if [ "${ARCH}" == "arm64" ]; then
           timeout --preserve-status 15s ./PalServer-arm64.sh 1> /dev/null
       else
           timeout --preserve-status 15s ./PalServer.sh 1> /dev/null
@@ -153,34 +151,21 @@ if [ "${AUTO_REBOOT_ENABLED,,}" = true ] && [ "${RCON_ENABLED,,}" = true ]; then
     supercronic -quiet -test "/home/steam/server/crontab" || exit
 fi
 
-if { [ "${AUTO_UPDATE_ENABLED,,}" = true ] && [ "${UPDATE_ON_BOOT,,}" = true ]; } || [ "${BACKUP_ENABLED,,}" = true ] || \
-    [ "${AUTO_REBOOT_ENABLED,,}" = true ]; then
-    supercronic "/home/steam/server/crontab" &
-    LogInfo "Cronjobs started"
-else
-    LogInfo "No Cronjobs found"
-fi
-
 # Configure RCON settings
 cat >/home/steam/server/rcon.yaml  <<EOL
 default:
   address: "127.0.0.1:${RCON_PORT}"
   password: "${ADMIN_PASSWORD}"
 EOL
 
-if [ "${ENABLE_PLAYER_LOGGING,,}" = true ] && [[ "${PLAYER_LOGGING_POLL_PERIOD}" =~ ^[0-9]+$ ]] && [ "${RCON_ENABLED,,}" = true ]; then
-    if [[ "$(id -u)" -eq 0 ]]; then
-        su steam -c /home/steam/server/player_logging.sh &
+if [ "${ENABLE_PLAYER_LOGGING,,}" = true ]; then
+    if [[ "${PLAYER_LOGGING_POLL_PERIOD}" =~ ^[0-9]+$ ]] && [ "${RCON_ENABLED}" = true ]; then
+        LogInfo "Player Logging enabled"
+        mv -f /home/steam/server/services/conf.d/palworld_player_logging.disabled /home/steam/server/services/conf.d/palworld_player_logging.conf
     else
-        /home/steam/server/player_logging.sh &
+        LogWarn "Unable to enable player logging" 
+        mv -f /home/steam/server/services/conf.d/palworld_player_logging.conf /home/steam/server/services/conf.d/palworld_player_logging.disabled
     fi
 fi
 
-LogAction "Starting Server"
-DiscordMessage "Start" "${DISCORD_PRE_START_MESSAGE}" "success"
-
-echo "${STARTCOMMAND[*]}"
-"${STARTCOMMAND[@]}"
-
-DiscordMessage "Stop" "${DISCORD_POST_SHUTDOWN_MESSAGE}" "failure"
 exit 0

services/conf.d/crontab.conf

@@ -0,0 +1,8 @@
+[program:crontab]
+user=steam
+command=supercronic "/home/steam/server/crontab"
+autostart=true
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+stopsignal=INT

services/conf.d/palworld.conf

@@ -0,0 +1,22 @@
+[eventlistener:palworld-events]
+user=steam
+command=/home/steam/server/services/listener/palworld_state_handler.sh
+priority=1
+events=PROCESS_STATE
+autostart=true
+autorestart=true
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+startsecs=0
+buffer_size=50
+
+[program:palworld]
+user=steam
+command=/home/steam/server/server.sh
+autostart=true
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+stopsignal=INT
+startsecs=6
+stopwaitsecs=30

services/conf.d/palworld_player_logging.disabled

@@ -0,0 +1,8 @@
+[program:player_logging]
+user=steam
+command=/home/steam/server/player_logging.sh
+autostart=%(ENV_ENABLE_PLAYER_LOGGING)s
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+startsecs=0

services/listener/palworld_state_handler.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+# shellcheck source=/dev/null
+source "/home/steam/server/helper_functions.sh"
+
+# generates variables from header String
+# supervisor provides the following variables: ver, server, serial, pool, myeventpool, poolserial, processname, eventname, len
+parse_headers() {
+
+    IFS=' '
+    for part in $1; do
+        key=$(echo "$part" | cut -d':' -f1)
+        value=$(echo "$part" | cut -d':' -f2)
+        declare -g "$key=$value"
+    done
+}
+
+declare eventname
+declare processname
+
+while true; do
+    printf "READY\n"
+    read -r header
+    parse_headers "$header"
+
+    if [ "${processname}" = "palworld" ]; then
+        case $eventname in
+            PROCESS_STATE_STARTING)
+                #Ignore Starting Event
+                LogAction "*****STARTING SERVER*****" >&2
+                DiscordMessage "Server is starting" "in-progress" >&2
+                ;;
+            PROCESS_STATE_RUNNING)
+                LogAction "*****STARTED SERVER*****" >&2
+                DiscordMessage "${DISCORD_PRE_START_MESSAGE}" "success" >&2
+                ;;
+            PROCESS_STATE_STOPPING)
+                LogAction "*****STOPPING SERVER*****" >&2
+                DiscordMessage "${DISCORD_PRE_SHUTDOWN_MESSAGE}" "in-progress" >&2
+                ;;
+            PROCESS_STATE_STOPPED|PROCESS_STATE_EXITED)
+                LogAction "*****STOPPED SERVER*****" >&2
+                DiscordMessage "${DISCORD_POST_SHUTDOWN_MESSAGE}" "failure" >&2
+                ;;
+            PROCESS_STATE_BACKOFF)
+                LogAction "*****FAILED TO START (RETRY)*****" >&2
+                ;;
+            PROCESS_STATE_FATAL)
+                LogAction "*****COULD NOT START SERVER*****" >&2
+                DiscordMessage "Server was not able to Start. Please check your configuration." "failure" >&2
+                ;;
+            *)
+                LogError "Unkown event occured: $header" "failure" >&2
+                ;;
+        esac
+    fi
+    printf "RESULT 2\nOK"
+done
+exit 0