Improve logging, organize (#5)

* Improve logging, reorganize s6-overlay structure

* Update packages in README.md

* Remove leftover debugging messages in swat4_startup.sh

Author: MisterCalvin

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Kevin Moore
+Copyright (c) 2024 MisterCalvin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -18,6 +18,7 @@ services:
     image: ghcr.io/mistercalvin/swat4-server-docker:latest
     container_name: swat4-server-docker
     environment: 
+      TZ: America/New_York
       PUID: 1000 # Optional: Set the UID for the user inside the container; Default: 1000
       PGID: 1000 # Optional: Set the GID for the user inside the container; Default: 1000
       CONTENT_VERSION: SWAT4 # Required: Choose SWAT4, TSS, or enter the name of your mod folder (case-sensitive); Default: SWAT4
@@ -36,7 +37,7 @@ services:
       QUICK_ROUND_RESET: False # Optional: If true, the server will perform a quick reset in between rounds on the same map, if false, the server will do a full SwitchLevel between rounds; Default: False
       ADDITIONAL_ARGS: # Optional: Comma-separated list of additional arguments to modify; Default: unset
     volumes: 
-      - /path/to/your/gamefiles:/container/swat4
+      - /path/to/your/gamefile:/container/swat4
       - swat4-wine:/container/.wine
     ports: 
       - 10480-10483:10480-10483/udp
@@ -55,6 +56,7 @@ docker run -d \
   --name=swat4-server-docker \
   -e PUID="1000" \
   -e PGID="1000" \
+  -e TZ="America/New_York" \
   -e CONTENT_VERSION="SWAT4" \
   -e SERVER_NAME="A SWAT 4 Docker Server" \
   -e SERVER_PASSWORD="" \
@@ -74,7 +76,7 @@ docker run -d \
   -v /path/to/gamefiles/:/container/swat4 \
   -v swat4-wine:/container/.wine \
   --restart unless-stopped \
-  git.sbotnas.io/kevin/swat4-server-docker:latest
+  ghcr.io/mistercalvin/swat4-server-docker:latest
 ```
 
 ## Server Ports
@@ -105,7 +107,9 @@ SERVER_NAME="[c=0000ff][u][b]A SWAT 4 Docker Server[\u][\b]"
 #### Using ADDITIONAL_ARGS
 Most common options such as Server name, password, admin password, etc., have been exposed as environment variables for convenience. If you would like to modify an option not exposed, you can use ADDITIONAL_ARGS. For example, if you wanted to disable showing teammate names and disable respawns, you would add the following to your docker-compose.yml or docker run command:
 
-> ADDITIONAL_ARGS="bShowTeammateNames=False,bNoRespawn=True"
+```
+ADDITIONAL_ARGS="bShowTeammateNames=False,bNoRespawn=True"
+```
 
 For a list other options, take a look at your `SwatGUIState.ini`, located in `GAME_DIR/System/`.  
 
@@ -134,19 +138,21 @@ Please note this does not change file permissions on the mounted volume (`/conta
 | 11-99 Enhancement 	| <a href="https://www.moddb.com/mods/11-99-enhancement-mod/downloads/11-99-enhancement-mod-v13" target="_blank">1.3</a>		|
 
 ## Building
-If you intend to build the Dockerfile yourself, I have not pinned the packages as Alpine does not keep old packages. At the time of writing (2024/04/18) I have built and tested the container with the following package versions:
-
-| Package   			  | Version  	 |
-|-------------------------|--------------|
-| i386/alpine		  | 3.19.1     	 |
-| wine (**x86_64 only**)     				  | 9.0-r0	     |
-| hangover-wine (**arm64 only**)     				  | 9.5-r0	     |
-| xvfb-run      		  | 1.20.10.3-r1 |
-| findutils      		  | 4.9.0-r5	 |
-| shadow                  | 4.14.2-r0      |
-| wget					  | 1.24.5-r0	 |
-| s6-overlay              | 3.1.6.2      |
-
+If you intend to build the Dockerfile yourself, I have not pinned the packages as Alpine does not keep old packages. At the time of writing (2024/06/24) I have built and tested the container with the following package versions:
+
+| Package   			               | Version      |
+| ------------------------------ | ------------ |
+| alpine                         | 3.20.1       |
+| wine (**i386 only**)           | 9.0-r0       |
+| hangover-wine (**arm64 only**) | 9.5-r0       |
+| bash                           | 5.2.26-r0    |
+| tzdata                         | 2024a-r1     |
+| shadow                         | 4.15.1-r0    |
+| wget                           | 1.36.1       |
+| figlet                         | 2.2.5-r3     |
+| xvfb-run                       | 1.20.10.3-r2 |
+| findutils                      | 4.9.0-r5     |
+| s6-overlay                     | 3.1.6.2      |
 
 ## ARM64 Support
 This container has been adapted for use on ARM64 processors by utilizing the project <a href="https://github.com/AndreRH/hangover" target="_blank">AndreRH/hangover</a>. ARM64 support is experimental and was only tested on a Raspberry Pi 4, you may experience additional bugs.

build/Dockerfile.arm64

@@ -1,4 +1,14 @@
-FROM arm64v8/alpine
+FROM arm64v8/alpine as builder
+RUN apk add --no-cache gcc musl-dev pcre-dev
+COPY ./simple_logger.c /src/
+WORKDIR /src
+RUN gcc -o simple_logger simple_logger.c /usr/lib/libpcre.a -static
+
+FROM --platform=aarch64 arm64v8/alpine
+
+ARG CONTAINER_MAJOR_VERSION=1
+ARG CONTAINER_MINOR_VERSION=1
+ARG CONTAINER_PATCH=1
 
 ARG S6_OVERLAY_VERSION=3.1.6.2
 ARG ARCH=aarch64
@@ -28,12 +38,15 @@ ENV \
   PGID="1000" \
   S6_VERBOSITY="0" \
   S6_CMD_WAIT_FOR_SERVICES_MAXTIME="0" \
-  CONTAINER_DEBUG="0"
+  CONTAINER_DEBUG="0" \
+  TZ=""
 
 RUN apk add --no-cache 'xvfb-run' \ 
 	'findutils' \ 
 	'shadow' \
 	'bash' \
+  'tzdata' \
+	'figlet' \
 	'dpkg' \
 	'wget' && \
 	apk add --no-cache --repository=https://dl-cdn.alpinelinux.org/alpine/edge/testing hangover-wine && \
@@ -52,11 +65,14 @@ RUN apk add --no-cache 'xvfb-run' \
 	mkdir -m 760 /container && \
 	addgroup --gid $PGID wine && \
 	adduser --uid $PUID --home /container --disabled-password --no-create-home --shell /bin/false --ingroup wine wine && \
+        touch /container/.CONTAINER_VERSION && \
+        echo "${CONTAINER_MAJOR_VERSION}.${CONTAINER_MINOR_VERSION}.${CONTAINER_PATCH}" > /container/.CONTAINER_VERSION && \
 	chown -R wine:wine /container
 
 WORKDIR /container/swat4
 
 COPY	./root /
+COPY --from=builder /src/simple_logger /usr/local/bin/simple_logger
 
 EXPOSE 10480-10483/udp
 
@@ -67,5 +83,5 @@ LABEL \
   org.opencontainers.image.title="SWAT 4 Docker" \
   org.opencontainers.image.description="Docker container for running a SWAT 4 Dedicated Server" \
   org.opencontainers.image.source=https://github.com/MisterCalvin/swat4-server-docker \
-  org.opencontainers.image.version="1.1" \
+  org.opencontainers.image.version="${CONTAINER_MAJOR_VERSION}.${CONTAINER_MINOR_VERSION}.${CONTAINER_PATCH}" \
   org.opencontainers.image.licenses=MIT

build/Dockerfile.i386

@@ -1,4 +1,14 @@
-FROM i386/alpine
+FROM i386/alpine as builder
+RUN apk add --no-cache gcc musl-dev pcre-dev
+COPY ./simple_logger.c /src/
+WORKDIR /src
+RUN gcc -o simple_logger simple_logger.c /usr/lib/libpcre.a -static
+
+FROM --platform=386 i386/alpine
+
+ARG CONTAINER_MAJOR_VERSION=1
+ARG CONTAINER_MINOR_VERSION=1
+ARG CONTAINER_PATCH=1
 
 ARG S6_OVERLAY_VERSION=3.1.6.2
 ARG ARCH=x86_64
@@ -27,14 +37,17 @@ ENV \
   PGID="1000" \
   S6_VERBOSITY="0" \
   S6_CMD_WAIT_FOR_SERVICES_MAXTIME="0" \
-  CONTAINER_DEBUG="0"
+  CONTAINER_DEBUG="0" \
+  TZ=""
 
 RUN apk add --no-cache \ 
   	'wine' \
 	'xvfb-run' \
 	'findutils' \
 	'shadow' \
 	'bash' \
+  'tzdata' \
+	'figlet' \
 	'wget' && \
 	mkdir /tmp/SWAT4 /tmp/TSS /tmp/build/ && \
 	wget -q -nc --show-progress --progress=bar:force:noscroll --no-hsts -O /tmp/SWAT4/Engine.dll --user-agent=Mozilla --content-disposition -E -c "https://raw.githubusercontent.com/sergeii/swat-patches/master/swat4stats-masterserver/1.1/Engine.dll" && \
@@ -46,14 +59,16 @@ RUN apk add --no-cache \
 	rm -rf /tmp/build/ && \
 	apk --purge del wget && \
 	mkdir -m 760 /container && \
-#	wineboot -i && \
 	addgroup --gid $PGID wine && \
 	adduser --uid $PUID --home /container --disabled-password --no-create-home --shell /bin/false --ingroup wine wine && \
+        touch /container/.CONTAINER_VERSION && \
+        echo "${CONTAINER_MAJOR_VERSION}.${CONTAINER_MINOR_VERSION}.${CONTAINER_PATCH}" > /container/.CONTAINER_VERSION && \
 	chown -R wine:wine /container
 
 WORKDIR /container/swat4
 
 COPY	./root /
+COPY --from=builder /src/simple_logger /usr/local/bin/simple_logger
 
 EXPOSE 10480-10483/udp
 
@@ -63,5 +78,5 @@ LABEL \
   org.opencontainers.image.title="SWAT 4 Docker" \
   org.opencontainers.image.description="Docker container for running a SWAT 4 Dedicated Server" \
   org.opencontainers.image.source=https://github.com/MisterCalvin/swat4-server-docker \
-  org.opencontainers.image.version="1.1" \
+  org.opencontainers.image.version="${CONTAINER_MAJOR_VERSION}.${CONTAINER_MINOR_VERSION}.${CONTAINER_PATCH}" \
   org.opencontainers.image.licenses=MIT

build/root/etc/s6-overlay/s6-rc.d/init-user/dependencies.d/base renamed to build/root/etc/s6-overlay/s6-rc.d/bootloader/dependencies.d/base

@@ -0,0 +1,7 @@
+#!/command/with-contenv bash
+
+source /usr/bin/debug.sh
+
+echo -e ""
+figlet -f ansi_shadow.flf "SWAT4"
+echo "A Docker container by MisterCalvin (v$(cat "/container/.CONTAINER_VERSION")) | discord.sbotnas.io"

build/root/etc/s6-overlay/s6-rc.d/bootloader/run

@@ -0,0 +1 @@
+oneshot

build/root/etc/s6-overlay/s6-rc.d/bootloader/type

@@ -0,0 +1 @@
+exec simple_logger -o -l "/container/swat4/swat4-container.log" "bootloader" "false" /etc/s6-overlay/s6-rc.d/bootloader/run 2>&1

build/root/etc/s6-overlay/s6-rc.d/bootloader/up

@@ -1,15 +1,29 @@
 #!/command/with-contenv bash
 
-PUID=${PUID:-1000}
-PGID=${PGID:-1000}
+source /usr/bin/debug.sh
+
+check_and_chown() {
+    local dir=$1
+    local uid=$(stat -c "%u" $dir)
+    local gid=$(stat -c "%g" $dir)
+
+    if [ "$uid" != "$PUID" ] || [ "$gid" != "$PGID" ]; then
+        echo "Changing ownership of $dir to $PUID:$PGID"
+        chown -R "$PUID:$PGID" $dir
+    fi
+}
 
 if [ ! "$PUID" = "1000" ] || [ ! "$PGID" = "1000" ]; then
-    	echo "New UID/GID specified, modifying current container user"
-	echo "Please note - this does not change file permissions on the mounted volume! This will only chown /container and /container/.wine to the specified UID/GID"
-	echo "If the server is crashing or refusing to boot, check file permissions on the host mount!"
-	groupmod --gid "$PGID" wine
-    	usermod --uid "$PUID" --gid "$PGID" wine
-	chown "$PUID:$PGID" /container 
+    echo "New UID/GID specified, modifying current container user"
+    echo "This will change file permissions on the mounted volume!"
+    groupmod --gid "$PGID" wine
+    usermod --uid "$PUID" --gid "$PGID" wine
+
+    # Ensure the root container directory is owned by wine user
+    chown "$PUID:$PGID" /container
 fi
 
-chown -R $PUID:$PGID /container/.wine
+# Check and change ownership recursively if necessary
+check_and_chown "/container"
+check_and_chown "/container/swat4"
+check_and_chown "/container/.wine"

build/root/etc/s6-overlay/s6-rc.d/init-user/run

@@ -1 +1 @@
-/etc/s6-overlay/s6-rc.d/init-user/run
+exec simple_logger -l "/container/swat4/swat4-container.log" "init-user" "true" /etc/s6-overlay/s6-rc.d/init-user/run 2>&1

build/root/etc/s6-overlay/s6-rc.d/init-user/up

@@ -1,10 +1,8 @@
 #!/command/with-contenv bash
 
+source /usr/bin/debug.sh
+
 if [ -z "$(ls -A /container/.wine)" ]; then
-        echo "Generating Wine prefix, it may take between 1-2 minutes before the server boots. Please be patient, this should be quicker on subsequent runs."
-        if [[ "$CONTAINER_DEBUG" -eq 1 ]]; then
-            wineboot -i 2>&1
-        else
-            wineboot -i 2>&1 | grep -v -e "starting Box64 based box64cpu.dll" -e "Hangover currently has issues with some ACM modules, disabling"
-        fi
-fi
+        echo "Initializing wine prefix, this may take a minute or two on slower systems. Be patient, this will be quicker on subsequent runs."
+	wineboot -u 2>&1
+fi

build/root/etc/s6-overlay/s6-rc.d/init-wine-prefix/dependencies.d/base renamed to build/root/etc/s6-overlay/s6-rc.d/init-wine-prefix/dependencies.d/bootloader

@@ -1 +1 @@
-/etc/s6-overlay/s6-rc.d/init-wine-prefix/run
+exec simple_logger -l "/container/swat4/swat4-container.log" "init-wine-prefix" "false" /etc/s6-overlay/s6-rc.d/init-wine-prefix/run 2>&1

build/root/etc/s6-overlay/s6-rc.d/init-wine-prefix/run

@@ -1,3 +1,2 @@
-#!/command/execlineb -P
-s6-setuidgid wine 
-"/usr/bin/swat4.sh"
+#!/bin/sh
+exec simple_logger -l "/container/swat4/swat4-container.log" "swat4-server" "true" s6-setuidgid wine /usr/bin/swat4_startup.sh 2>&1

build/root/etc/s6-overlay/s6-rc.d/init-wine-prefix/up

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+if [ "$CONTAINER_DEBUG" = "1" ]; then
+    export PS4=' Line ${LINENO}: '
+	set -x
+fi

build/root/etc/s6-overlay/s6-rc.d/swat4-svc/run

@@ -0,0 +1,9 @@
+BEGIN FILTERS
+starting Box64 based box64cpu.dll
+Hangover currently has issues with some ACM modules, disabling
+END FILTERS
+
+BEGIN ANONYMIZE
+(?<=Password=)[\w[$&+,:;=?@#|'<>.^*()%!-]+(?=\/g)
+(?<=\-n\s\').+?(?=\')
+END ANONYMIZE

build/root/etc/s6-overlay/s6-rc.d/swat4-svc/dependencies.d/base renamed to build/root/etc/s6-overlay/s6-rc.d/user/bootloader

@@ -1,16 +1,19 @@
 #!/command/with-contenv bash
-## File: SWAT 4 Docker Script - swat4.sh
+## File: SWAT 4 Docker Script - swat4_startup.sh
 ## Author: Kevin Moore <admin@sbotnas.io>
 ## Created: 2023/07/11
-## Modified: 2024/04/17
+## Modified: 2024/05/13
 ## License: MIT License
+exec 2>&1
+source /usr/bin/debug.sh
+
 GAME_DIR=/container/swat4
 NEW_SWAT4_ENGINEDLL=$(md5sum < /tmp/SWAT4/Engine.dll)
 NEW_TSS_ENGINEDLL=$(md5sum < /tmp/TSS/Engine.dll)
 OLD_SWAT4_ENGINEDLL=$(md5sum < "$GAME_DIR/Content/System/Engine.dll")
 OLD_TSS_ENGINEDLL=$(md5sum < "$GAME_DIR/ContentExpansion/System/Engine.dll")
 
-case $(echo "$CONTENT_VERSION" | tr '[:lower:]' '[:upper:]') in
+case "${CONTENT_VERSION}" in
 	"SWAT4"|0)
     	CONTENT_PATH=Content
         CONTENT_VERSION="SWAT 4"
@@ -24,7 +27,7 @@ case $(echo "$CONTENT_VERSION" | tr '[:lower:]' '[:upper:]') in
 
 	"$CONTENT_VERSION")
 	CONTENT_PATH=$CONTENT_VERSION
-	MOD_SYSTEM_FOLDER=$(find "$GAME_DIR/$CONTENT_VERSION" -type d -name System) 2> /dev/null || { echo "Cannot find Mod folder $GAME_DIR/$CONTENT_VERSION! Check that it exists, and that CONTENT_VERSION is set correctly!"; exit 1; }
+	MOD_SYSTEM_FOLDER=$(find "$GAME_DIR/$CONTENT_PATH" -type d -name System) 2> /dev/null || { echo "Cannot find Mod folder $GAME_DIR/$CONTENT_PATH! Check that it exists, and that CONTENT_VERSION is set correctly!"; exit 1; }
 	MOD_GAME_VERSION=$(find "$MOD_SYSTEM_FOLDER" -iregex '.*Swat4X?.ini' -type f -printf "%f")
 
 	case $MOD_GAME_VERSION in	
@@ -48,7 +51,7 @@ esac
 
 SwatGUIState=$(find "$GAME_DIR/$CONTENT_PATH/System" -type f -iname SwatGUIState.ini -printf "%f" -quit | grep .) && SwatGUIState="$GAME_DIR/$CONTENT_PATH/System/$SwatGUIState" || { echo "Cannot find $GAME_DIR/$CONTENT_VERSION/System/SwatGUIState.ini"; exit 1; }
 
-case $(echo "$GAME_TYPE" | tr '[:lower:]' '[:upper:]') in
+case "${GAME_TYPE^^}" in
     "BARRICADED SUSPECTS")
 	    GAME_TYPE=MPM_BarricadedSuspects
         sed -i "s/^GameType=.*$/GameType=$GAME_TYPE/g" "$SwatGUIState"
@@ -197,18 +200,6 @@ if [ -f "$SERVER_BINARY.log" ]; then
 	mv "$SERVER_BINARY.log" "$SERVER_BINARY.old.log"
 fi
 
-echo -e "███████╗██╗    ██╗ █████╗ ████████╗    ██╗  ██╗"
-echo "██╔════╝██║    ██║██╔══██╗╚══██╔══╝    ██║  ██║"
-echo "███████╗██║ █╗ ██║███████║   ██║       ███████║"
-echo "╚════██║██║███╗██║██╔══██║   ██║       ╚════██║"
-echo "███████║╚███╔███╔╝██║  ██║   ██║            ██║"
-echo "╚══════╝ ╚══╝╚══╝ ╚═╝  ╚═╝   ╚═╝            ╚═╝"
-echo "A Docker container by MisterCalvin | discord.sbotnas.io"
-
 echo "Starting $CONTENT_VERSION Server, it may take up to 30 seconds before you see any logs"
 
-if [ "$CONTAINER_DEBUG" = "1" ]; then
-	xvfb-run wine "$GAME_DIR/${CONTENT_PATH_MOD:-$CONTENT_PATH/System/}$SERVER_BINARY.exe" "${MAPLIST[0]}" & tail -F "$SERVER_BINARY.log" 2> /dev/null
-else
-	wine_wrapper.sh "$GAME_DIR/${CONTENT_PATH_MOD:-$CONTENT_PATH/System/}$SERVER_BINARY.exe" "${MAPLIST[0]}" &> /dev/null & tail -F "$SERVER_BINARY.log" 2> /dev/null
-fi
+xvfb-run wine "$GAME_DIR/${CONTENT_PATH_MOD:-$CONTENT_PATH/System/}$SERVER_BINARY.exe" "${MAPLIST[0]}" & tail -F "$SERVER_BINARY.log" 2> /dev/null