mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
b1594a8b1c
This PR does two small things: 1. The log level, in case it is unset, will now be "calculated" from `/etc/dms-settings` and not always default to `info`. This way, we can ensure that more often than not, the log level the user chose when starting DMS is used everywhere. 2. I noticed that the way I obtained the log level could be used to obtain any env variable's log level. I therefore added a function to `utils.sh` in case we use it in the future.
103 lines
2.3 KiB
Bash
103 lines
2.3 KiB
Bash
#! /bin/bash
|
|
|
|
LOG_RESET='\e[0m'
|
|
LOG_LGRAY='\e[37m'
|
|
LOG_LBLUE='\e[94m'
|
|
LOG_BLUE='\e[34m'
|
|
LOG_LYELLOW='\e[93m'
|
|
LOG_RED='\e[91m'
|
|
|
|
# ### DMS Logging Functionality
|
|
#
|
|
# This function provides the logging for scripts used by DMS.
|
|
# It adheres to the convention for log levels.
|
|
# Valid values (in order of increasing verbosity) are: `error`,
|
|
# `warn`, `info`, `debug` and `trace`. The default log level
|
|
# is `info`.
|
|
#
|
|
# #### Arguments
|
|
#
|
|
# $1 :: the log level to log the message with
|
|
# $2 :: the message
|
|
#
|
|
# #### Panics
|
|
#
|
|
# If the first argument is not set or invalid, an error
|
|
# message is logged. Likewise when the second argument
|
|
# is missing. Both failures will return with exit code '1'.
|
|
function _log
|
|
{
|
|
if [[ -z ${1+set} ]]
|
|
then
|
|
echo "Call to '_log' is missing a valid log level" >&2
|
|
return 1
|
|
fi
|
|
|
|
if [[ -z ${2+set} ]]
|
|
then
|
|
echo "Call to '_log' is missing a message to log" >&2
|
|
return 1
|
|
fi
|
|
|
|
local MESSAGE LEVEL_AS_INT LOG_LEVEL_FALLBACK
|
|
MESSAGE="${LOG_RESET}["
|
|
|
|
if [[ -e /etc/dms-settings ]]
|
|
then
|
|
LOG_LEVEL_FALLBACK=$(grep "^LOG_LEVEL=" /etc/dms-settings | cut -d '=' -f 2)
|
|
LOG_LEVEL_FALLBACK="${LOG_LEVEL_FALLBACK:1:-1}"
|
|
else
|
|
LOG_LEVEL_FALLBACK='info'
|
|
fi
|
|
|
|
case "${LOG_LEVEL:-${LOG_LEVEL_FALLBACK}}" in
|
|
( 'trace' ) LEVEL_AS_INT=5 ;;
|
|
( 'debug' ) LEVEL_AS_INT=4 ;;
|
|
( 'warn' ) LEVEL_AS_INT=2 ;;
|
|
( 'error' ) LEVEL_AS_INT=1 ;;
|
|
( * ) LEVEL_AS_INT=3 ;;
|
|
esac
|
|
|
|
case "${1}" in
|
|
( 'trace' )
|
|
[[ ${LEVEL_AS_INT} -ge 5 ]] || return 0
|
|
MESSAGE+=" ${LOG_LGRAY}TRACE "
|
|
;;
|
|
|
|
( 'debug' )
|
|
[[ ${LEVEL_AS_INT} -ge 4 ]] || return 0
|
|
MESSAGE+=" ${LOG_LBLUE}DEBUG "
|
|
;;
|
|
|
|
( 'info' )
|
|
[[ ${LEVEL_AS_INT} -ge 3 ]] || return 0
|
|
MESSAGE+=" ${LOG_BLUE}INF "
|
|
;;
|
|
|
|
( 'warn' )
|
|
[[ ${LEVEL_AS_INT} -ge 2 ]] || return 0
|
|
MESSAGE+=" ${LOG_LYELLOW}WARNING "
|
|
;;
|
|
|
|
( 'error' )
|
|
[[ ${LEVEL_AS_INT} -ge 1 ]] || return 0
|
|
MESSAGE+=" ${LOG_RED}ERROR " ;;
|
|
|
|
( * )
|
|
echo "Call to '_log' with invalid log level argument '${1}'" >&2
|
|
return 1
|
|
;;
|
|
esac
|
|
|
|
MESSAGE+="${LOG_RESET}] ${2}"
|
|
|
|
if [[ ${1} =~ ^(warn|error)$ ]]
|
|
then
|
|
echo -e "${MESSAGE}" >&2
|
|
else
|
|
echo -e "${MESSAGE}"
|
|
fi
|
|
}
|
|
|
|
function _log_with_date { _log "${1}" "$(date '+%Y-%m-%d %H:%M:%S') ${2}" ; }
|