p4dtg_instance_init.template #1

#!/bin/bash
#==============================================================================
# Copyright and license info is available in the LICENSE file included with
# the Server Deployment Package (SDP), and also available online:
# https://workshop.perforce.com/view/p4-sdp/main/LICENSE
#------------------------------------------------------------------------------
#
# P4DTG server init script

# p4dtg Init Script.
# chkconfig: - 90 30
# description: P4DTG Start Up Script

export TMP="$P4TMP"
declare OpMode="${1:-usage}"
export OS_INIT_MECHANISM="${OS_INIT_MECHANISM:-Unset}"
declare -i UseSystemd=0
declare ServiceName=
declare RunFile=
declare StopFile=
declare ErrorFile=
declare MovedErrorFile=
declare ForceStartFile=
declare ForceStartMovedFile=
declare -i ForceStart=0

# Load SDP controlled shell environment.
# shellcheck disable=SC1091
source /p4/common/bin/p4_vars REPL_SDP_INSTANCE ||\
   { echo -e "\\nError: Failed to load SDP environment for instance REPL_SDP_INSTANCE.\n"; exit 1; }

# shellcheck disable=SC1091
source "$P4CBIN/ps_functions.sh" ||\
   { echo -e "\\nError: Failed to load SDP ps_functions.sh lib.\n"; exit 1; }

if [[ $(id -u) -eq 0 ]]; then
   exec su - "$OSUSER" -c "$0 $*"
elif [[ $(id -u -n) != "$OSUSER" ]]; then
   echo "$0 can only be run by root or $OSUSER"
   exit 1
fi

cd "$P4DTG_ROOT" ||\
   { echo -e "\\nError: Could not cd to P4DTG_ROOT directory [$P4DTG_ROOT]."; exit 1; }

StopFile="$P4DTG_ROOT/repl/stop-$P4DTG_CFG"
ErrorFile="$P4DTG_ROOT/repl/err-$P4DTG_CFG"
RunFile="${P4DTG_ROOT}/repl/run-${P4DTG_CFG}"

# Determine if systemd is configured for this instance and config.
if [[ -n "$(command -v systemctl)" ]]; then
   ServiceName="${P4DTGBIN##*/}"
   if [[ -n "$(systemctl is-enabled "$ServiceName" 2>/dev/null)" ]]; then
      UseSystemd=1
      MustUseSystemdMsg="\\nError: It appears an attempt was made to start or stop the $ServiceName\\nservice without using systemd. When a systemd unit file is configured, only the\\nsystemd init mechanism can be used to start and stop the service, so that\\nsystemd maintains a more reliable indication of the status of the service. Run\\nas root or as $OSUSER with sudo. For example:\\n\\n\\tsudo systemctl start $ServiceName\\nsudo systemctl stop $ServiceName\\n\\tsystemctl status $ServiceName\\n\\nNote that the 'status' check does not require sudo.\\n\\nThe systemd unit file is:\\n\\n$(systemctl cat "$ServiceName")"
   else
      UseSystemd=0
   fi
fi

ForceStartFile="$P4CCFG/force_start.${SDP_INSTANCE}.p4dtg"

# See how we were called.
case "$OpMode" in
   (prep)
      if [[ -f "$RunFile" ]]; then
         if ! get_pids "$P4DTGBIN" >/dev/null 2>&1; then
            mv -f "$RunFile" "${RunFile}.stale.$(date +%Y%m%d-%H%M%S)" || rm -f "$RunFile"
         fi
      fi

      [[ -e "$StopFile" ]] && rm -f "$StopFile"

      if [[ -e "$ErrorFile" ]]; then
         if [[ -w "$ForceStartFile" ]]; then
            ForceStart=1
            ForceStartMovedFile="${ForceStartFile}.used.$(date +'%Y-%m-%d-%H%M%S')"
            if mv -f "$ForceStartFile" "$ForceStartMovedFile"; then
               echo -e "\\nWarning: The force_start mode is active (one time due to existence of the writable file $ForceStartFile). The P4DTG error file \"$ErrorFile\" will be moved aside and ignored."
            else
               echo -e "\\nWarning: The force_start mode is active due to existence of the file $ForceStartFile. The P4DTG error file \"$ErrorFile\" will be moved aside and ignored."
               echo -e "\\nError: Could not disable force_start mode for subsequent operations. Despite the file being writable, this failed: mv -f \"$ForceStartFile\" \"$ForceStartMovedFile\""
            fi
         elif [[ -e "$ForceStartFile" ]]; then
            ForceStart=1
            echo -e "\\nWarning: The force_start mode is active (persistent due to existence of non-writable file $ForceStartFile). The P4DTG error file \"$ErrorFile\" will be moved aside and ignored."
         elif [[ "${2:-Unset}" == "-f" ]]; then
            ForceStart=1
            echo -e "\\nWarning: The force_start mode is active (due to '-f' option). The P4DTG error file \"$ErrorFile\" will be moved aside and ignored."
         fi

         if [[ "$ForceStart" -eq 1 ]]; then
            MovedErrorFile="$P4DTG_ROOT/repl/MOVED_FILE_err-$(date +'%Y%m%d-%H%M')"
            mv -f "$ErrorFile" "$MovedErrorFile"
            echo -e "\\nWarning: P4DTG Error File detected and moved aside to: $MovedErrorFile\\nStarting anyway due to -f.\\n"
         else
            echo -e "\\nError: Refusing to start because a P4DTG error file was found:\\n\\t$ErrorFile\\nReview this file.\\nTo start P4DTG after reviewing this file, try again with -f which will the error file aside first, i.e.: $0 start -f\\n"
            exit 1
         fi
      fi

      exit 0
   ;;

   (start)
      if [[ "$UseSystemd" -eq 1 && "$OS_INIT_MECHANISM" != "systemd" ]]; then
         echo -e "$MustUseSystemdMsg"
         exit 1
      fi

      p4dtg_pids=$(get_pids "$P4DTGBIN")
      if [[ -n "$p4dtg_pids" ]]; then
         echo -e "Error: ${P4DTGBIN} is already running as pids: $p4dtg_pids."
         exit 1
      fi

      if [[ -f "$RunFile" ]]; then
         # If DTG is truly running, keep the file. If not, it's stale and must be removed.
         if ! get_pids "$P4DTGBIN" >/dev/null 2>&1; then
            mv -f "$RunFile" "${RunFile}.stale.$(date +%Y%m%d-%H%M%S)" || rm -f "$RunFile"
         fi
      fi

      [[ -e "$StopFile" ]] && rm -f "$StopFile"

      if [[ -e "$ErrorFile" ]]; then
         if [[ "${2:-Unset}" == "-f" ]]; then
            MovedErrorFile="$P4DTG_ROOT/repl/MOVED_FILE_err-$(date +'%Y%m%d-%H%M')"
            mv -f "$ErrorFile" "$MovedErrorFile"
            echo -e "\\nWarning: P4DTG Error File detected and moved aside to: $MovedErrorFile\\nStarting anyway due to -f.\\n"
         else
            echo -e "\\nError: Refusing to start because a P4DTG error file was found:\\n\\t$ErrorFile\\nReview this file.\\nTo start P4DTG after reviewing this file, try again with -f which will the error file aside first, i.e.: $0 start -f\\n"
            exit 1
         fi
      fi

      ulimit -c unlimited || true

      # If running with systemd, run the process in the foreground and let systemd handle the
      # process forking. Otherwise, start the service in the background with '&'.
      echo -e "\\nStarting P4DTG with: $P4DTGBIN $P4DTG_CFG $P4DTG_ROOT"
      if [[ "$UseSystemd" -eq 1 ]]; then
         $P4DTGBIN "$P4DTG_CFG" "$P4DTG_ROOT"
      else
         $P4DTGBIN "$P4DTG_CFG" "$P4DTG_ROOT" &
      fi
   ;;

   (stop)
      if [[ "$UseSystemd" -eq 1 && "$OS_INIT_MECHANISM" != "systemd" ]]; then
         echo -e "$MustUseSystemdMsg"
         exit 1
      fi

      p4dtg_pids=$(get_pids "$P4DTGBIN")
      if [[ -z "$p4dtg_pids" ]]; then
         echo -e "Info: ${P4DTGBIN} was NOT running.\\n"
         exit 0
      fi

      echo -e -n "\\nShutting down P4DTG instance P4DTG_CFG ..."
      cd "$P4DTG_ROOT/repl" || { echo -e "\\n\\nError: Could not cd to $P4DTG_ROOT/repl\\n"; exit 1; }
      touch "stop-$P4DTG_CFG" || { echo -e "\\n\\nError: Could not touch stop file: stop-$P4DTG_CFG\\n"; exit 1; }
      p4dtg_pids=$(get_pids "$P4DTGBIN")
      while [[ -n "$p4dtg_pids" ]]; do
         sleep 2
         echo -n "."
         p4dtg_pids=$(get_pids "$P4DTGBIN")
      done
      echo -e "\\n\\nShutdown of P4DTG confirmed.\\n"
   ;;

   (restart)
      $0 stop
      sleep 1
      $0 start
   ;;

   (status)
      p4dtg_pids=$(get_pids "$P4DTGBIN")
      if [[ -n "$p4dtg_pids" ]]; then
         echo "${P4DTGBIN} is running as pids: $p4dtg_pids."
         exit 0
      else
         echo "${P4DTGBIN} is NOT running."
         exit 1
      fi
   ;;

   (*)
      echo -e "\\nUsage: $0 {start [-f] | stop | status | restart}\n"
      exit 1
   ;;
esac

exit 0