Move RunAndLog to main.sh

Author: CLHatch

main.sh

@@ -456,6 +456,94 @@ fatal() {
 [[ -f "${SCRIPTPATH}/.includes/usage.sh" ]] && source "${SCRIPTPATH}/.includes/usage.sh"
 [[ -f "${SCRIPTPATH}/.includes/cmdline.sh" ]] && source "${SCRIPTPATH}/.includes/cmdline.sh"
 
+PrefixFileLines() {
+	local Prefix="${1}"
+	local FileName="${2}"
+
+	# Count lines in the Content string using process substitution
+	local LineCount
+	LineCount=$(wc -l < "${FileName}")
+
+	# Join the repeated prefix stream and the content stream
+	paste -d '' <(yes "${Prefix}" | head -n "${LineCount}" || true) "${FileName}"
+}
+
+RunAndLog() {
+	# RunAndLog [RunningNoticeType] [Prefix:[OutputNoticeType]] [ErrorNoticeType] [ErrorMessage] [Command]
+	# To skip an optional argument, pass an empty string
+	local -l RunningNoticeType=${1-}
+	local -l OutputNoticeType=${2-}
+	local -l ErrorNoticeType=${3-}
+	local ErrorMessage=${4-}
+	shift 4
+	local -a Command=("${@}")
+
+	local NoticeTypes_Regex='info|notice|warn|error|debug|trace'
+
+	local Prefix=''
+	if [[ ${OutputNoticeType} == *:* ]]; then
+		Prefix="${OutputNoticeType%%:*}:"
+		OutputNoticeType=${OutputNoticeType#"${Prefix}"}
+		Prefix="${C["RunningCommand"]}${Prefix}${NC-} "
+	fi
+
+	local OutputFile
+
+	local CommandText
+	CommandText="$(printf '%q ' "${Command[@]}" | xargs 2> /dev/null)"
+
+	# If the running notice type is set, log the command being run
+	[[ -n ${RunningNoticeType-} ]] &&
+		"${RunningNoticeType}" \
+			"Running: ${C["RunningCommand"]}${CommandText}"
+
+	local ErrToNull=false
+	local OutToNull=false
+	if [[ ${OutputNoticeType-} =~ errtonull|bothtonull ]]; then
+		ErrToNull=true
+	fi
+	if [[ ${OutputNoticeType-} =~ outtonull|bothtonull ]]; then
+		OutToNull=true
+	fi
+	if [[ ${ErrToNull} != true || ${OutToNull} != true ]] && [[ ${OutputNoticeType-} =~ ${NoticeTypes_Regex} ]]; then
+		# If the output notice type is set, save the output to a file
+		OutputFile=$(mktemp -t "${APPLICATION_NAME}.${FUNCNAME[0]}.RunAndLogOutputFile.XXXXXXXXXX")
+	fi
+	local -i result=0
+	if [[ ${ErrToNull} == true && ${OutToNull} == true ]]; then
+		# Both stdout and stderr are redirected to /dev/null
+		"${Command[@]}" &> /dev/null || result=$?
+	elif [[ ${ErrToNull} == true && -n ${OutputFile-} ]]; then
+		# stderr redircted to /dev/null, stdout redirected to output file
+		"${Command[@]}" > "${OutputFile}" 2> /dev/null || result=$?
+	elif [[ ${OutToNull} == true && -n ${OutputFile-} ]]; then
+		# stdout redircted to /dev/null, stderr redirected to output file
+		"${Command[@]}" 2> "${OutputFile}" > /dev/null || result=$?
+	elif [[ -n ${OutputFile-} ]]; then
+		# Both stdout and stderr redirected to output file
+		"${Command[@]}" &> "${OutputFile}" || result=$?
+	else
+		# No redirection
+		"${Command[@]}" || result=$?
+	fi
+
+	if [[ -n ${OutputFile-} && -n $(cat "${OutputFile}") ]]; then
+		"${OutputNoticeType}" \
+			"$(PrefixFileLines "${Prefix}" "${OutputFile}")"
+		rm -f "${OutputFile}"
+	fi
+
+	[[ ${result} -eq 0 ]] && return
+
+	if [[ -n ${ErrorNoticeType-} ]]; then
+		# If the error notice type is set, log the error
+		${ErrorNoticeType} \
+			"${ErrorMessage}" \
+			"Failing command: ${C["FailingCommand"]}${CommandText}"
+	fi
+	return ${result}
+}
+
 # Check for supported CPU architecture
 check_arch() {
 	if [[ ${ARCH} != "arm64" ]] && [[ ${ARCH} != "aarch64" ]] && [[ ${ARCH} != "x86_64" ]]; then