New scripts integrating lumberjack. Complete rewrite.

This commit is contained in:
Darren 'Tadgy' Austin 2022-08-24 00:49:05 +01:00
commit ba480eccb9
2 changed files with 224 additions and 105 deletions

View file

@ -1,23 +1,36 @@
#!/bin/bash
# Version: 0.3.0
# Version: 0.3.0-proftpd
# Copyright (c) 2005-2022:
# Darren 'Tadgy' Austin <darren (at) afterdark.org.uk>
# Licensed under the terms of the GNU General Public License version 3.
EXEC="/usr/sbin/proftpd"
ARGS=()
PIDFILE="/run/proftpd.pid"
PROFTPD_EXEC="/usr/sbin/proftpd"
PROFTPD_ARGS=()
PROFTPD_PIDFILE="/run/proftpd.pid"
DAEMON_EXEC="/usr/bin/daemon"
DAEMON_ARGS=('-N' '-n' "lumberjack-${0##*rc.}" '-r' '-a' '60' '-A' '5' '-L' '1800' '-M' '3' '-l' 'daemon.err' '-b' 'daemon.debug' '-o' 'daemon.info' '--')
LUMBERJACK_EXEC="/opt/bin/lumberjack"
LUMBERJACK_ARGS=('-u' '${LUMBERJACK_RUNUSER:-logger}' '-z' '-i' '${LUMBERJACK_SOCK:-/run/proftpd-log.sock}' '-o' '${LUMBERJACK_RUNUSER:-logger}:ftp' '-mp' '006' '-l' '{}/logs/ftpd-access.log' '${LUMBERJACK_BASEDIR:-/data/sites}' '{}/logs/%Y/%m/ftpd-access.log')
LUMBERJACK_RUNUSER="logger"
LUMBERJACK_SOCK="/run/proftpd-log.sock"
LUMBERJACK_BASEDIR="/data/sites"
# Allow configuration in /etc/default to override.
# Additional available variables:
# ENVIRONMENT=() # Extra environment passed to $EXEC. Must be an array.
# EXTRA_ARGS=() # Extra arguments passed to $EXEC. Must be an array.
# SLAY_DELAY="" # Delay between the SIGTERM and SIGKILL on a 'stop'. Default: 2s.
# RESTART_DELAY="" # Delay between stopping and starting on a 'restart'. Default: 2s.
[[ -e "/etc/default/${0##*rc.}" ]] && source "/etc/default/${0##*rc.}"
# PROFTPD_ENVIRONMENT=() # Extra environment passed to $PROFTPD_EXEC. Must be an array.
# DAEMON_ENVIRONMENT=() # Extra environment passed to $DAEMON_EXEC. Must be an array.
# LUMBERJACK_RUNUSER="" # Username to run lumberjack as. Default: logger.
# LUMBERJACK_SOCK="" # Location of the socket for lumberjack to read data. Default: /run/proftpd-log.sock.
# LUMBERJACK_BASEDIR="" # The base directory where lumberjack should write logs. Default: /data/sites.
# SLAY_DELAY="" # Delay between the SIGTERM and SIGKILL on a 'stop'. Default: 2s.
# RESTART_DELAY="" # Delay between stopping and starting on a 'restart'. Default: 2s.
[[ -e "/etc/default/${0##*rc.}" ]] && { source "/etc/default/${0##*rc.}" || return 1 2>/dev/null || exit 1; }
# Now all possible variable changes are complete, expand out the embedded variables.
eval "$(declare -p LUMBERJACK_ARGS | sed -re 's/\\\$/$/g')"
error() {
printf "%s: %s: %s\\n" "${BASH_SOURCE##*/}" "${EXEC##*/}" "$*" >&2
printf "%s: %s\\n" "${BASH_SOURCE[0]##*/}" "$*" >&2
}
checkconfigured() {
@ -25,74 +38,119 @@ checkconfigured() {
# can start correctly, before actually trying to start it. A return value of 0 means the
# tests were passed and the daemon should be started. Any other value prevents the
# daemon from being started, and an error message will be emitted.
${ENVIRONMENT:+declare ${ENVIRONMENT[*]};} "$EXEC" -t >/dev/null 2>&1 || return 1
id "${LUMBERJACK_RUNUSER:-logger}" >/dev/null 2>&1 || return 1
[[ ! -e "${LUMBERJACK_BASEDIR:-/data/sites}" ]] && return 1
[[ ! -d "${LUMBERJACK_BASEDIR:-/data/sites}" ]] && return 1
${PROFTPD_ENVIRONMENT:+declare ${PROFTPD_ENVIRONMENT[*]};} "$PROFTPD_EXEC" -t >/dev/null 2>&1 || return 1
return 0
}
checkstatus() {
local RUNPIDS="$({ pgrep -f "$EXEC"; pgrep -F "$PIDFILE" 2>/dev/null; } | sort -u )"
local RET=0 RUNPIDS="$({ pgrep -f "$PROFTPD_EXEC"; pgrep -F "$PROFTPD_PIDFILE" 2>/dev/null; } | sort -u )"
if "$DAEMON_EXEC" --running -n "lumberjack-${0##*rc.}"; then
printf "%s: %s: %s\\n" "${BASH_SOURCE[0]##*/}" "${LUMBERJACK_EXEC##*/}" "running"
else
printf "%s: %s: %s\\n" "${BASH_SOURCE[0]##*/}" "${LUMBERJACK_EXEC##*/}" "stopped"
RET=1
fi
if [[ ! -z "$RUNPIDS" ]]; then
printf "%s: %s: %s" "${BASH_SOURCE##*/}" "${EXEC##*/}" "running"
if [[ ! -z "$PIDFILE" ]]; then
if [[ ! -e "$PIDFILE" ]]; then
printf "%s: %s: %s" "${BASH_SOURCE[0]##*/}" "${PROFTPD_EXEC##*/}" "running"
if [[ ! -z "$PROFTPD_PIDFILE" ]]; then
if [[ ! -e "$PROFTPD_PIDFILE" ]]; then
printf "%s" ", but .pid file does not exist"
elif ! grep "\<$(< "$PIDFILE")\>" <<<"$RUNPIDS" >/dev/null 2>&1; then
elif ! grep "\<$(<"$PROFTPD_PIDFILE")\>" <<<"$RUNPIDS" >/dev/null 2>&1; then
printf "%s" ", but .pid file is stale"
fi
fi
printf "\\n"
else
printf "%s: %s: %s\\n" "${BASH_SOURCE##*/}" "${EXEC##*/}" "stopped"
return 1
printf "%s: %s: %s\\n" "${BASH_SOURCE[0]##*/}" "${PROFTPD_EXEC##*/}" "stopped"
RET=$(( RET + 2))
fi
return 0
return $RET
}
startdaemon() {
if [[ ! -e "$EXEC" ]]; then
error "not found"
return 1
elif [[ ! -x "$EXEC" ]]; then
error "not executable"
return 1
elif ! checkconfigured; then
error "not started - pre-start checks failed"
return 1
fi
${ENVIRONMENT:+declare ${ENVIRONMENT[*]};} "$EXEC" ${ARGS[*]} ${EXTRA_ARGS[*]}
checkconfigured || {
error "${PROFTPD_EXEC##*/}: not started - pre-start checks failed"
return 2
}
${DAEMON_ENVIRONMENT:+declare ${DAEMON_ENVIRONMENT[*]};} "$DAEMON_EXEC" ${DAEMON_ARGS[*]} "$LUMBERJACK_EXEC" ${LUMBERJACK_ARGS[*]}
(( $? != 0 )) && {
error "error starting '${DAEMON_EXEC##*/}'"
return 2
}
${PROFTPD_ENVIRONMENT:+declare ${PROFTPD_ENVIRONMENT[*]};} "$PROFTPD_EXEC" ${PROFTPD_ARGS[*]}
if (( $? != 0 )); then
error "error starting daemon"
return 1
error "error starting '${PROFTPD_EXEC##*/}'"
return 2
else
return 0
fi
}
stopdaemon() {
[[ -e "$PIDFILE" ]] && kill -TERM "$(< "$PIDFILE")" >/dev/null 2>&1 || kill -TERM "$(pgrep -f "$EXEC" | tr $'\n' " ")" >/dev/null 2>&1
kill -TERM "$(pgrep -f "$PROFTPD_EXEC" | tr $'\n' ' ')" >/dev/null 2>&1
[[ -e "$PROFTPD_PIDFILE" ]] && {
sleep 0.5
kill -TERM "$(<"$PROFTPD_PIDFILE")" >/dev/null 2>&1
}
sleep "${SLAY_DELAY:-2}"
if checkstatus >/dev/null; then
error "failed to stop gracefully - slaying"
kill -KILL "$({ cat "$PIDFILE"; pgrep -f "$EXEC"; } 2>/dev/null | sort -u | tr $'\n' " ")" >/dev/null 2>&1
fi
checkstatus >/dev/null && {
error "${PROFTPD_EXEC##*/}: failed to stop gracefully - slaying"
kill -KILL "$({ cat "$PROFTPD_PIDFILE"; pgrep -f "$PROFTPD_EXEC"; } 2>/dev/null | sort -u | tr $'\n' ' ')" >/dev/null 2>&1
}
sleep 0.5
"$DAEMON_EXEC" -n "lumberjack-${0##*rc.}" --stop 2>/dev/null
sleep "${SLAY_DELAY:-2}"
checkstatus >/dev/null && {
error "${DAEMON_EXEC##*/}: failed to stop gracefully - slaying"
"$DAEMON_EXEC" -n "lumberjack-${0##*rc.}" --signal=kill 2>/dev/null
}
return 0
}
for EXEC in "$PROFTPD_EXEC" "$DAEMON_EXEC" "$LUMBERJACK_EXEC"; do
[[ ! -e "$EXEC" ]] && {
error "$EXEC: not found"
return 1 2>/dev/null || exit 1
}
[[ ! -x "$EXEC" ]] && {
error "$EXEC: not executable"
return 1 2>/dev/null || exit 1
}
done
case "$1" in
'start')
if checkstatus >/dev/null; then
error "already running"
printf " %s\\n" "Try: $BASH_SOURCE status" >&2
RET=1
else
checkstatus >/dev/null
ERR=$?
if (( ERR == 3 )); then
startdaemon
RET=$?
elif (( ERR == 2 )); then
error "${DAEMON_EXEC##*/}: already running"
error "${PROFTPD_EXEC##*/}: stopped"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} restart" >&2
RET=1
elif (( ERR == 1 )); then
error "${DAEMON_EXEC##*/}: stopped"
error "${PROFTPD_EXEC##*/}: already running"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} restart" >&2
RET=1
else
error "${DAEMON_EXEC##*/}: already running"
error "${PROFTPD_EXEC##*/}: already running"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} status" >&2
RET=1
fi
;;
'stop')
if ! checkstatus >/dev/null; then
error "not running"
printf " %s\\n" "Try: $BASH_SOURCE status" >&2
checkstatus >/dev/null
if (( $? == 3 )); then
error "${DAEMON_EXEC##*/}: not running"
error "${PROFTPD_EXEC##*/}: not running"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} status" >&2
RET=1
else
stopdaemon
@ -100,20 +158,20 @@ case "$1" in
fi
;;
'restart')
if checkstatus >/dev/null; then
stopdaemon && sleep "${RESTART_DELAY:-2}" && startdaemon
RET=$?
else
startdaemon
RET=$?
fi
checkstatus >/dev/null
(( $? != 3 )) && {
stopdaemon >/dev/null 2>&1
sleep "${RESTART_DELAY:-2}"
}
startdaemon
RET=$?
;;
'status')
checkstatus
RET=$?
;;
*)
printf "%s\\n" "Usage: $BASH_SOURCE <start|stop|restart|status>" >&2
printf "%s\\n" "Usage: ${BASH_SOURCE[0]} <start|stop|restart|status>" >&2
RET=1
;;
esac

View file

@ -1,23 +1,38 @@
#!/bin/bash
# Version: 0.3.0
# Version: 0.3.0-rsync
# Copyright (c) 2005-2022:
# Darren 'Tadgy' Austin <darren (at) afterdark.org.uk>
# Licensed under the terms of the GNU General Public License version 3.
EXEC="/usr/bin/rsync"
ARGS=('--daemon' '--config=/etc/rsyncd/rsyncd.conf')
PIDFILE="/run/rsyncd.pid"
RSYNC_EXEC="/usr/bin/rsync"
RSYNC_ARGS=('--daemon' '${RSYNC_CONF:---config=/etc/rsyncd/rsyncd.conf}')
RSYNC_PIDFILE="/run/rsyncd.pid"
DAEMON_EXEC="/usr/bin/daemon"
DAEMON_ARGS=('-N' '-n' "lumberjack-${0##*rc.}" '-r' '-a' '60' '-A' '5' '-L' '1800' '-M' '3' '-l' 'daemon.err' '-b' 'daemon.debug' '-o' 'daemon.info' '--')
LUMBERJACK_EXEC="/opt/bin/lumberjack"
LUMBERJACK_ARGS=('-u' '${LUMBERJACK_RUNUSER:-logger}' '-z' '-r' '-i' '${LUMBERJACK_SOCK:-/run/rsyncd-log.sock}' '-o' '${LUMBERJACK_RUNUSER:-logger}:mirror' '-mp' '006' '-l' 'logs/rsyncd-transfers.log' '${LUMBERJACK_BASEDIR:-/data/sites/slackware.uk}' 'logs/%Y/%m/rsyncd-transfers.log')
LUMBERJACK_RUNUSER="logger"
LUMBERJACK_SOCK="/run/rsyncd-log.sock"
LUMBERJACK_BASEDIR="/data/sites/slackware.uk"
# Allow configuration in /etc/default to override.
# Additional available variables:
# ENVIRONMENT=() # Extra environment passed to $EXEC. Must be an array.
# EXTRA_ARGS=() # Extra arguments passed to $EXEC. Must be an array.
# SLAY_DELAY="" # Delay between the SIGTERM and SIGKILL on a 'stop'. Default: 2s.
# RESTART_DELAY="" # Delay between stopping and starting on a 'restart'. Default: 2s.
[[ -e "/etc/default/${0##*rc.}" ]] && source "/etc/default/${0##*rc.}"
# RSYNC_ENVIRONMENT=() # Extra environment passed to $RSYNC_EXEC. Must be an array.
# RSYNC_CONF="" # Path to the config file for RSYNC_EXEC. Default: /etc/rsyncd/rsyncd.conf.
# DAEMON_ENVIRONMENT=() # Extra environment passed to $DAEMON_EXEC. Must be an array.
# LUMBERJACK_RUNUSER="" # Username to run lumberjack as. Default: logger.
# LUMBERJACK_SOCK="" # Location of the socket for lumberjack to read data. Default: /run/rsyncd-log.sock.
# LUMBERJACK_BASEDIR="" # The base directory where lumberjack should write logs. Default: /data/sites/slackware.uk.
# SLAY_DELAY="" # Delay between the SIGTERM and SIGKILL on a 'stop'. Default: 2s.
# RESTART_DELAY="" # Delay between stopping and starting on a 'restart'. Default: 2s.
[[ -e "/etc/default/${0##*rc.}" ]] && { source "/etc/default/${0##*rc.}" || return 1 2>/dev/null || exit 1; }
# Now all possible variable changes are complete, expand out the embedded variables.
eval "$(declare -p RSYNC_ARGS | sed -re 's/\\\$/$/g')"
eval "$(declare -p LUMBERJACK_ARGS | sed -re 's/\\\$/$/g')"
error() {
printf "%s: %s: %s\\n" "${BASH_SOURCE##*/}" "${EXEC##*/}" "$*" >&2
printf "%s: %s\\n" "${BASH_SOURCE[0]##*/}" "$*" >&2
}
checkconfigured() {
@ -25,73 +40,119 @@ checkconfigured() {
# can start correctly, before actually trying to start it. A return value of 0 means the
# tests were passed and the daemon should be started. Any other value prevents the
# daemon from being started, and an error message will be emitted.
id "${LUMBERJACK_RUNUSER:-logger}" >/dev/null 2>&1 || return 1
[[ ! -e "${LUMBERJACK_BASEDIR:-/data/sites/slackware.uk}" ]] && return 1
[[ ! -d "${LUMBERJACK_BASEDIR:-/data/sites/slackware.uk}" ]] && return 1
[[ ! -e "${RSYNC_CONF:-/etc/rsyncd/rsyncd.conf}" ]] && return 1
return 0
}
checkstatus() {
local RUNPIDS="$({ pgrep -f "$EXEC"; pgrep -F "$PIDFILE" 2>/dev/null; } | sort -u )"
local RET=0 RUNPIDS="$({ pgrep -f "$RSYNC_EXEC"; pgrep -F "$RSYNC_PIDFILE" 2>/dev/null; } | sort -u )"
if "$DAEMON_EXEC" --running -n "lumberjack-${0##*rc.}"; then
printf "%s: %s: %s\\n" "${BASH_SOURCE[0]##*/}" "${LUMBERJACK_EXEC##*/}" "running"
else
printf "%s: %s: %s\\n" "${BASH_SOURCE[0]##*/}" "${LUMBERJACK_EXEC##*/}" "stopped"
RET=1
fi
if [[ ! -z "$RUNPIDS" ]]; then
printf "%s: %s: %s" "${BASH_SOURCE##*/}" "${EXEC##*/}" "running"
if [[ ! -z "$PIDFILE" ]]; then
if [[ ! -e "$PIDFILE" ]]; then
printf "%s: %s: %s" "${BASH_SOURCE[0]##*/}" "${RSYNC_EXEC##*/}" "running"
if [[ ! -z "$RSYNC_PIDFILE" ]]; then
if [[ ! -e "$RSYNC_PIDFILE" ]]; then
printf "%s" ", but .pid file does not exist"
elif ! grep "\<$(< "$PIDFILE")\>" <<<"$RUNPIDS" >/dev/null 2>&1; then
elif ! grep "\<$(<"$RSYNC_PIDFILE")\>" <<<"$RUNPIDS" >/dev/null 2>&1; then
printf "%s" ", but .pid file is stale"
fi
fi
printf "\\n"
else
printf "%s: %s: %s\\n" "${BASH_SOURCE##*/}" "${EXEC##*/}" "stopped"
return 1
printf "%s: %s: %s\\n" "${BASH_SOURCE[0]##*/}" "${RSYNC_EXEC##*/}" "stopped"
RET=$(( RET + 2))
fi
return 0
return $RET
}
startdaemon() {
if [[ ! -e "$EXEC" ]]; then
error "not found"
return 1
elif [[ ! -x "$EXEC" ]]; then
error "not executable"
return 1
elif ! checkconfigured; then
error "not started - pre-start checks failed"
return 1
fi
${ENVIRONMENT:+declare ${ENVIRONMENT[*]};} "$EXEC" ${ARGS[*]} ${EXTRA_ARGS[*]}
checkconfigured || {
error "${RSYNC_EXEC##*/}: not started - pre-start checks failed"
return 2
}
${DAEMON_ENVIRONMENT:+declare ${DAEMON_ENVIRONMENT[*]};} "$DAEMON_EXEC" ${DAEMON_ARGS[*]} "$LUMBERJACK_EXEC" ${LUMBERJACK_ARGS[*]}
(( $? != 0 )) && {
error "error starting '${DAEMON_EXEC##*/}'"
return 2
}
${RSYNC_ENVIRONMENT:+declare ${RSYNC_ENVIRONMENT[*]};} "$RSYNC_EXEC" ${RSYNC_ARGS[*]}
if (( $? != 0 )); then
error "error starting daemon"
return 1
error "error starting '${RSYNC_EXEC##*/}'"
return 2
else
return 0
fi
}
stopdaemon() {
[[ -e "$PIDFILE" ]] && kill -TERM "$(< "$PIDFILE")" >/dev/null 2>&1 || kill -TERM "$(pgrep -f "$EXEC" | tr $'\n' " ")" >/dev/null 2>&1
kill -TERM "$(pgrep -f "$RSYNC_EXEC" | tr $'\n' ' ')" >/dev/null 2>&1
[[ -e "$RSYNC_PIDFILE" ]] && {
sleep 0.5
kill -TERM "$(<"$RSYNC_PIDFILE")" >/dev/null 2>&1
}
sleep "${SLAY_DELAY:-2}"
if checkstatus >/dev/null; then
error "failed to stop gracefully - slaying"
kill -KILL "$({ cat "$PIDFILE"; pgrep -f "$EXEC"; } 2>/dev/null | sort -u | tr $'\n' " ")" >/dev/null 2>&1
fi
checkstatus >/dev/null && {
error "${RSYNC_EXEC##*/}: failed to stop gracefully - slaying"
kill -KILL "$({ cat "$RSYNC_PIDFILE"; pgrep -f "$RSYNC_EXEC"; } 2>/dev/null | sort -u | tr $'\n' ' ')" >/dev/null 2>&1
}
sleep 0.5
"$DAEMON_EXEC" -n "lumberjack-${0##*rc.}" --stop 2>/dev/null
sleep "${SLAY_DELAY:-2}"
checkstatus >/dev/null && {
error "${DAEMON_EXEC##*/}: failed to stop gracefully - slaying"
"$DAEMON_EXEC" -n "lumberjack-${0##*rc.}" --signal=kill 2>/dev/null
}
return 0
}
for EXEC in "$RSYNC_EXEC" "$DAEMON_EXEC" "$LUMBERJACK_EXEC"; do
[[ ! -e "$EXEC" ]] && {
error "$EXEC: not found"
return 1 2>/dev/null || exit 1
}
[[ ! -x "$EXEC" ]] && {
error "$EXEC: not executable"
return 1 2>/dev/null || exit 1
}
done
case "$1" in
'start')
if checkstatus >/dev/null; then
error "already running"
printf " %s\\n" "Try: $BASH_SOURCE status" >&2
RET=1
else
checkstatus >/dev/null
ERR=$?
if (( ERR == 3 )); then
startdaemon
RET=$?
elif (( ERR == 2 )); then
error "${DAEMON_EXEC##*/}: already running"
error "${RSYNC_EXEC##*/}: stopped"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} restart" >&2
RET=1
elif (( ERR == 1 )); then
error "${DAEMON_EXEC##*/}: stopped"
error "${RSYNC_EXEC##*/}: already running"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} restart" >&2
RET=1
else
error "${DAEMON_EXEC##*/}: already running"
error "${RSYNC_EXEC##*/}: already running"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} status" >&2
RET=1
fi
;;
'stop')
if ! checkstatus >/dev/null; then
error "not running"
printf " %s\\n" "Try: $BASH_SOURCE status" >&2
checkstatus >/dev/null
if (( $? == 3 )); then
error "${DAEMON_EXEC##*/}: not running"
error "${RSYNC_EXEC##*/}: not running"
printf " %s\\n" "Try: ${BASH_SOURCE[0]} status" >&2
RET=1
else
stopdaemon
@ -99,20 +160,20 @@ case "$1" in
fi
;;
'restart')
if checkstatus >/dev/null; then
stopdaemon && sleep "${RESTART_DELAY:-2}" && startdaemon
RET=$?
else
startdaemon
RET=$?
fi
checkstatus >/dev/null
(( $? != 3 )) && {
stopdaemon >/dev/null 2>&1
sleep "${RESTART_DELAY:-2}"
}
startdaemon
RET=$?
;;
'status')
checkstatus
RET=$?
;;
*)
printf "%s\\n" "Usage: $BASH_SOURCE <start|stop|restart|status>" >&2
printf "%s\\n" "Usage: ${BASH_SOURCE[0]} <start|stop|restart|status>" >&2
RET=1
;;
esac