New logger with color and specific types. Code cleanup (itzg#3108)

Author: IronMine

bin/mc-send-to-console

@@ -3,26 +3,22 @@
 : "${CONSOLE_IN_NAMED_PIPE:=/tmp/minecraft-console-in}"
 
 if isFalse "${CREATE_CONSOLE_IN_PIPE:-false}"; then
-  echo "ERROR: console pipe needs to be enabled by setting CREATE_CONSOLE_IN_PIPE to true"
+  error "Console pipe needs to be enabled by setting CREATE_CONSOLE_IN_PIPE to true"
 fi
 
 
 if [ $# = 0 ]; then
-  echo "ERROR: pass console commands as arguments"
+  error "Pass console commands as arguments"
   exit 1
 fi
 
 if [ ! -p "${CONSOLE_IN_NAMED_PIPE}" ]; then
-  echo "ERROR: named pipe ${CONSOLE_IN_NAMED_PIPE} is missing"
+  error "Named pipe ${CONSOLE_IN_NAMED_PIPE} is missing"
   exit 1
 fi
 
 if [ "$(id -u)" = 0 -a $UID != 0 ]; then
-  if [[ $(getDistro) == alpine ]]; then
-    exec su-exec minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
-  else
-    exec gosu minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
-  fi
+  exec $(getSudoFromDistro) minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE}'"
 else
-  echo "$@" >"${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}"
+  echo "$@" >"${CONSOLE_IN_NAMED_PIPE}"
 fi

bin/mcstatus

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-echo "WARNING: mcstatus is deprecated; calling mc-monitor instead"
+warning "mcstatus is deprecated; calling mc-monitor instead"
 
 ##### mcstatus shim for mc-monitor
 # handles translating calls to
@@ -11,8 +11,8 @@ addr="$1"
 
 IFS=':'
 read -a parts <<< "${addr}"
+args=(--host ${parts[0]}) 
 if [[ ${#parts[*]} -gt 1 ]]; then
-  exec mc-monitor status --host ${parts[0]} --port ${parts[1]}
-else
-  exec mc-monitor status --host ${parts[0]}
+    args+=(--port ${parts[1]})
 fi
+exec mc-monitor ${args[@]}

scripts/start

@@ -55,6 +55,7 @@ if ! isTrue "${SKIP_SUDO:-false}" && [ "$(id -u)" = 0 ]; then
     echo "Starting DNS update..."
     exec gosu ${runAsUser}:${runAsGroup} "${SCRIPTS:-/}start-dns-update" "$@"
   fi
+  exec $(getSudoFromDistro) ${runAsUser}:${runAsGroup} "${SCRIPTS:-/}start-configuration" "$@"
 else
   exec "${SCRIPTS:-/}start-configuration" "$@"
 fi

scripts/start-autopause

@@ -26,60 +26,40 @@ isDebugging && set -x
 
 cp /auto/knockd-config.cfg /tmp/knockd-config.cfg
 
+function updatePort() {
+  regseq="^\s*sequence\s*=\s*$1\s*$"
+  linenum=$(grep -nm${2} sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
+  if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
+    sed -i "${linenum}s/sequence.*/sequence = $1/" /tmp/knockd-config.cfg
+    log "Updated $3 port in knockd config"
+  fi
+}
+
 # update server port to listen to
-regseq="^\s*sequence\s*=\s*$SERVER_PORT\s*$"
-linenum=$(grep -nm1 sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
-if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
-  sed -i "${linenum}s/sequence.*/sequence = $SERVER_PORT/" /tmp/knockd-config.cfg
-  log "Updated server port in knockd config"
-fi
+updatePort $SERVER_PORT 1 "server"
+
 # update rcon port to listen to
-regseq="^\s*sequence\s*=\s*$RCON_PORT\s*$"
-linenum=$(grep -nm2 sequence /tmp/knockd-config.cfg | cut -d : -f 1 | tail -n1)
-if ! [[ $(awk "NR==$linenum" /tmp/knockd-config.cfg) =~ $regseq ]]; then
-  sed -i "${linenum}s/sequence.*/sequence = $RCON_PORT/" /tmp/knockd-config.cfg
-  log "Updated rcon port in knockd config"
-fi
+updatePort $RCON_PORT 2 "rcon"
+
+isNumericElseSetToDefault "AUTOPAUSE_PERIOD" 10
+checkIfNotZeroElseSetToDefault "AUTOPAUSE_PERIOD" 10
+isNumericElseSetToDefault "AUTOPAUSE_TIMEOUT_KN" 120
+isNumericElseSetToDefault "AUTOPAUSE_TIMEOUT_EST" 3600
+isNumericElseSetToDefault "AUTOPAUSE_TIMEOUT_INIT" 600
 
-if ! [[ $AUTOPAUSE_PERIOD =~ ^[0-9]+$ ]]; then
-  AUTOPAUSE_PERIOD=10
-  export AUTOPAUSE_PERIOD
-  log "Warning: AUTOPAUSE_PERIOD is not numeric, set to 10 (seconds)"
-fi
-if [ "$AUTOPAUSE_PERIOD" -eq "0" ] ; then
-  AUTOPAUSE_PERIOD=10
-  export AUTOPAUSE_PERIOD
-  log "Warning: AUTOPAUSE_PERIOD must not be 0, set to 10 (seconds)"
-fi
-if ! [[ $AUTOPAUSE_TIMEOUT_KN =~ ^[0-9]+$ ]] ; then
-  AUTOPAUSE_TIMEOUT_KN=120
-  export AUTOPAUSE_TIMEOUT_KN
-  log "Warning: AUTOPAUSE_TIMEOUT_KN is not numeric, set to 120 (seconds)"
-fi
-if ! [[ $AUTOPAUSE_TIMEOUT_EST =~ ^[0-9]+$ ]] ; then
-  AUTOPAUSE_TIMEOUT_EST=3600
-  export AUTOPAUSE_TIMEOUT_EST
-  log "Warning: AUTOPAUSE_TIMEOUT_EST is not numeric, set to 3600 (seconds)"
-fi
-if ! [[ $AUTOPAUSE_TIMEOUT_INIT =~ ^[0-9]+$ ]] ; then
-  AUTOPAUSE_TIMEOUT_INIT=600
-  export AUTOPAUSE_TIMEOUT_INIT
-  log "Warning: AUTOPAUSE_TIMEOUT_INIT is not numeric, set to 600 (seconds)"
-fi
 if [[ "$AUTOPAUSE_KNOCK_INTERFACE" == "lo" ]] ; then
-  log "Warning: AUTOPAUSE_KNOCK_INTERFACE is set to the local loopback interface."
-  log "         This is not advisable, as incoming connections are likely not picked up there."
-  log "         Continuing with this setting."
+  logWarning "AUTOPAUSE_KNOCK_INTERFACE is set to the local loopback interface."
+  logWarning "         This is not advisable, as incoming connections are likely not picked up there."
+  logWarning "         Continuing with this setting."
 fi
 
 if [[ -n "$MAX_TICK_TIME" && "$MAX_TICK_TIME" != "-1" ]] ; then
-  log "Warning: MAX_TICK_TIME is non-default, for autopause to work properly, this check should be disabled (-1 for versions >= 1.8.1)"
+  logWarning "MAX_TICK_TIME is non-default, for autopause to work properly, this check should be disabled (-1 for versions >= 1.8.1)"
 elif [[ -z "$MAX_TICK_TIME" ]] ; then
+  MAX_TICK_TIME=-1
   if versionLessThan 1.8.1; then
     # 10 years
     MAX_TICK_TIME=315360000000
-  else
-    MAX_TICK_TIME=-1
   fi
   export MAX_TICK_TIME
 fi

scripts/start-autostop

@@ -20,25 +20,9 @@ log "Autostop functionality enabled"
 
 isDebugging && set -x
 
-if ! [[ $AUTOSTOP_PERIOD =~ ^[0-9]+$ ]]; then
-  AUTOSTOP_PERIOD=10
-  export AUTOSTOP_PERIOD
-  log "Warning: AUTOSTOP_PERIOD is not numeric, set to 10 (seconds)"
-fi
-if [ "$AUTOSTOP_PERIOD" -eq "0" ] ; then
-  AUTOSTOP_PERIOD=10
-  export AUTOSTOP_PERIOD
-  log "Warning: AUTOSTOP_PERIOD must not be 0, set to 10 (seconds)"
-fi
-if ! [[ $AUTOSTOP_TIMEOUT_EST =~ ^[0-9]+$ ]] ; then
-  AUTOSTOP_TIMEOUT_EST=3600
-  export AUTOSTOP_TIMEOUT_EST
-  log "Warning: AUTOSTOP_TIMEOUT_EST is not numeric, set to 3600 (seconds)"
-fi
-if ! [[ $AUTOSTOP_TIMEOUT_INIT =~ ^[0-9]+$ ]] ; then
-  AUTOSTOP_TIMEOUT_INIT=1800
-  export AUTOSTOP_TIMEOUT_INIT
-  log "Warning: AUTOSTOP_TIMEOUT_INIT is not numeric, set to 1800 (seconds)"
-fi
+isNumericElseSetToDefault "AUTOSTOP_PERIOD" 10
+checkIfNotZeroElseSetToDefault "AUTOSTOP_PERIOD" 10
+isNumericElseSetToDefault "AUTOSTOP_TIMEOUT_EST" 3600
+isNumericElseSetToDefault "AUTOSTOP_TIMEOUT_INIT" 1800
 
 /auto/autostop-daemon.sh &

scripts/start-configuration

@@ -35,10 +35,10 @@ log "Running as uid=$(id -u) gid=$(id -g) with /data as '$(ls -lnd /data)'"
 if [ ! -e /data/eula.txt ]; then
   if ! isTrue "$EULA"; then
     log ""
-    log "Please accept the Minecraft EULA at"
-    log "  https://account.mojang.com/documents/minecraft_eula"
-    log "by adding the following immediately after 'docker run':"
-    log "  -e EULA=TRUE"
+    logError "Please accept the Minecraft EULA at"
+    logError "  https://account.mojang.com/documents/minecraft_eula"
+    logError "by adding the following immediately after 'docker run':"
+    logError "  -e EULA=TRUE"
     log ""
     exit 1
   fi
@@ -62,10 +62,10 @@ if isTrue "${ENABLE_RCON:-true}"; then
   if [[ -v RCON_PASSWORD_FILE ]]; then
     if [ ! -e "${RCON_PASSWORD_FILE}" ]; then
       log ""
-      log "Initial RCON password file ${RCON_PASSWORD_FILE} does not seems to exist."
-      log "Please ensure your configuration."
-      log "If you are using Docker Secrets feature, please check this for further information: "
-      log " https://docs.docker.com/engine/swarm/secrets"
+      logError "Initial RCON password file ${RCON_PASSWORD_FILE} does not seems to exist."
+      logError "Please ensure your configuration."
+      logError "If you are using Docker Secrets feature, please check this for further information: "
+      logError " https://docs.docker.com/engine/swarm/secrets"
       log ""
       exit 1
     else
@@ -90,12 +90,12 @@ fi
 # Auto-pause/stop
 
 if isTrue "${ENABLE_AUTOPAUSE}" && isTrue "${EXEC_DIRECTLY:-false}"; then
-    log "EXEC_DIRECTLY=true is incompatible with ENABLE_AUTOPAUSE=true"
+    logError "EXEC_DIRECTLY=true is incompatible with ENABLE_AUTOPAUSE=true"
     exit 1
 fi
 
 if isTrue "${ENABLE_AUTOPAUSE}" && isTrue "${ENABLE_AUTOSTOP}"; then
-    log "ENABLE_AUTOPAUSE=true is incompatible with ENABLE_AUTOSTOP=true"
+    logError "ENABLE_AUTOPAUSE=true is incompatible with ENABLE_AUTOSTOP=true"
     exit 1
 fi
 
@@ -111,9 +111,9 @@ function fixJavaPath() {
   # Some Docker management UIs grab all the image declared variables and present them for configuration.
   # When upgrading images across Java versions, that creates a mismatch in PATH's expected by base image.
   if ! which java > /dev/null; then
-    log "ERROR: your Docker provider has an annoying flaw where it"
-    log "       tries to set PATH even though the container establishes"
-    log "       a very specific value."
+    logError "       Your Docker provider has an annoying flaw where it"
+    logError "       tries to set PATH even though the container establishes"
+    logError "       a very specific value."
     sleep 2
     # now find where java might be
     for d in /opt/java/openjdk/bin /usr/bin; do
@@ -128,7 +128,7 @@ function fixJavaPath() {
 
 
 if ! fixJavaPath; then
-  log "ERROR: could not locate path that contains java"
+  logError "could not locate path that contains java"
   exit 1
 fi
 
@@ -183,7 +183,7 @@ if [[ $MOD_PLATFORM ]]; then
       ;;
 
     *)
-      log "ERROR; Invalid MOD_PLATFORM: '$MOD_PLATFORM'"
+      logError "Invalid MOD_PLATFORM: '$MOD_PLATFORM'"
       exit 1
       ;;
   esac
@@ -272,11 +272,11 @@ case "${TYPE^^}" in
   ;;
 
   *)
-      log "ERROR: Invalid TYPE: '$TYPE'"
-      log "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FOLIA, PURPUR, FABRIC, QUILT,"
-      log "         SPONGEVANILLA, CUSTOM, MAGMA, MOHIST, CATSERVER, AIRPLANE, PUFFERFISH,"
-      log "         CANYON, LIMBO, CRUCIBLE"
+      logError "Invalid TYPE: '$TYPE'"
+      logError "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FOLIA, PURPUR, FABRIC, QUILT,"
+      logError "         SPONGEVANILLA, CUSTOM, MAGMA, MOHIST, CATSERVER, AIRPLANE, PUFFERFISH,"
+      logError "         CANYON, LIMBO, CRUCIBLE"
       exit 1
   ;;
 
-esac
+esac

scripts/start-deployAutoCF

@@ -57,15 +57,11 @@ setArg --exclude-include-file CF_EXCLUDE_INCLUDE_FILE
 setArg --downloads-repo CF_DOWNLOADS_REPO
 
 if ! mc-image-helper install-curseforge "${args[@]}"; then
-    log "ERROR failed to auto-install CurseForge modpack"
+    logError "Failed to auto-install CurseForge modpack"
     exit 1
 fi
 
-# grab SERVER, TYPE, VERSION and export it
-set -a
-# shellcheck disable=SC1090
-source "${resultsFile}"
-set +a
+applyResultsFile ${resultsFile}
 resolveFamily
 
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployBukkitSpigot

@@ -6,47 +6,56 @@ isDebugging && set -x
 
 set -eo pipefail
 
+spigotBuildLog="/data/spigot_build.log"
+
+function handleFailedSpigotBuild {
+  logError "Failed to build Spigot"
+  cat ${spigotBuildLog}
+  exit 1
+}
+
+
 function buildSpigotFromSource {
+  local tempDir="/data/temp"
+
   if [[ ${TYPE^^} = *BUKKIT ]] && ! versionLessThan "1.14"; then
-    log "ERR craftbukkit build is only supported for versions less than 1.14"
+    logError "Craftbukkit build is only supported for versions less than 1.14"
     exit 1
   fi
 
   log "Building Spigot $VANILLA_VERSION from source, might take a while, get some coffee"
-  rm -rf /data/temp
-  mkdir /data/temp
-  cd /data/temp
+  rm -rf ${tempDir}
+  mkdir ${tempDir}
+  cd ${tempDir}
 
   jvmOpts="-Xms${INIT_MEMORY:-$MEMORY} -Xmx${MAX_MEMORY:-$MEMORY}"
 
   logn ''
-  curl -sSL -o /data/temp/BuildTools.jar https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar && \
-    java $jvmOpts -jar /data/temp/BuildTools.jar --rev "$VERSION" 2>&1 |tee /data/spigot_build.log| while read l; do echo -n .; done; log "done"
+  curl -sSL -o ${tempDir}/BuildTools.jar https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar && \
+    java $jvmOpts -jar ${tempDir}/BuildTools.jar --rev "$VERSION" 2>&1 |tee ${spigotBuildLog}| while read l; do echo -n .; done; log "done"
 
   case ${TYPE^^} in
     SPIGOT)
       if ! mv spigot-*.jar "/data/${SERVER}"; then
-        log "ERR failed to build Spigot"
-        cat /data/spigot_build.log
-        exit 1
+        handleFailedSpigotBuild
       fi
       ;;
     *BUKKIT)
       if ! mv craftbukkit-*.jar "/data/${SERVER}"; then
-        log "ERR failed to build Spigot"
-        cat /data/spigot_build.log
-        exit 1
+        handleFailedSpigotBuild
       fi
       ;;
   esac
 
   log "Cleaning up"
-  rm -rf /data/temp
+  rm -rf ${tempDir}
   cd /data
 }
 
 function downloadSpigot {
   local match
+  local getBukkitBaseUrl="https://getbukkit.org/download/"
+  local getBukkitSpigotUrl="${getBukkitBaseUrl}spigot" 
   case "$TYPE" in
     *BUKKIT|*bukkit)
       match="CraftBukkit"
@@ -61,18 +70,21 @@ function downloadSpigot {
   esac
 
   if [[ ${VERSION^^} = LATEST ]]; then
-    if ! VERSION=$(restify https://getbukkit.org/download/spigot --attribute='property=og:title' | jq -r '.[0] | .attributes | select(.property == "og:title") | .content | split(" ") | .[-1]'); then
-      log "ERROR: failed to retrieve latest version from https://getbukkit.org/download/spigot -- site might be down"
+    if ! VERSION=$(restify ${getBukkitSpigotUrl} --attribute='property=og:title' | jq -r '.[0] | .attributes | select(.property == "og:title") | .content | split(" ") | .[-1]'); then
+      logError "Failed to retrieve latest version from ${getBukkitSpigotUrl} -- site might be down"
       exit 1
     fi
   fi
 
   if [[ -z $downloadUrl ]]; then
+    downloadBaseUrl="https://"
+    downloadSuffixUrl=".getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
     if versionLessThan 1.16.5 || { [[ ${getbukkitFlavor} = "craftbukkit" ]] && [[ ${VERSION} = "1.16.5" ]] ; }; then
-      downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
+      downloadBaseUrl+="cdn"
     else
-      downloadUrl="https://download.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
+      downloadBaseUrl+="download"
     fi
+    downloadUrl="${downloadBaseUrl}${downloadSuffixUrl}"
   fi
 
   setServerVar
@@ -94,7 +106,7 @@ function downloadSpigot {
     cat <<EOF
 
 ERROR: failed to download from $downloadUrl
-       Visit https://getbukkit.org/download/${getbukkitFlavor} to lookup the
+       Visit ${getBukkitBaseUrl}${getbukkitFlavor} to lookup the
        exact version or see if download site is unavailable.
        Click into the version entry to find the **exact** version.