asif/pilerBackup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cleanup printf formatting

Browse Source
This commit is contained in:
Asif Bacchus 2020-08-14 00:39:23 -06:00
parent 760399a0fd
commit 6fc82aac83
1 changed files with 82 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

164
pilerBackup/pilerbackup.sh
View File

@ -54,7 +54,7 @@ badDetails () {
badParam () { badParam () {
if [ "$1" = "dne" ]; then if [ "$1" = "dne" ]; then
printf "\n%sError: '%s %s'\n" "$err" "$2" "$3" printf "\n%sError: '%s %s'\n" "$err" "$2" "$3"
printf "file or directory does not exist.${norm}\n\n" printf "file or directory does not exist.%s\n\n" "$norm"
exit 1 exit 1
elif [ "$1" = "empty" ]; then elif [ "$1" = "empty" ]; then
printf "\n%sError: '%s' cannot have a NULL (empty) value.\n" "$err" "$2" printf "\n%sError: '%s' cannot have a NULL (empty) value.\n" "$err" "$2"
@ -336,8 +336,8 @@ while [ $# -gt 0 ]; do
fi fi
;; ;;
*) *)
printf "${err}\nUnknown option: %s\n" "$1" printf "%s\nUnknown option: %s\n" "$err" "$1"
printf "${cyan}Use '--help' for valid options.{$norm}\n\n" printf "%sUse '--help' for valid options.%s\n\n" "$cyan" "$norm"
exit 1 exit 1
;; ;;
esac esac
@ -348,13 +348,13 @@ done
### check pre-requisites and default values ### check pre-requisites and default values
# check if running as root, otherwise exit # check if running as root, otherwise exit
if [ $( id -u ) -ne 0 ]; then if [ $( id -u ) -ne 0 ]; then
printf "\n${err}ERROR: script MUST be run as ROOT${norm}\n\n" printf "\n%sERROR: script MUST be run as ROOT%s\n\n" "$err" "$norm"
exit 2 exit 2
fi fi
# find pilerexport, otherwise this is all pointless # find pilerexport, otherwise this is all pointless
pilerExport=$( command -v pilerexport ) pilerExport=$( command -v pilerexport )
if [ ! "$pilerExport" ]; then if [ ! "$pilerExport" ]; then
printf "\n${err}ERROR: cannot find 'pilerexport'${norm}\n\n" printf "\n%sERROR: cannot find 'pilerexport'%s\n\n" "$err" "$norm"
exit 4 exit 4
fi fi
# does the details file exist? # does the details file exist?
@ -363,7 +363,7 @@ if [ ! -f "$configDetails" ]; then
fi fi
# is borg installed? # is borg installed?
if ! command -v borg > /dev/null; then if ! command -v borg > /dev/null; then
printf "\n${err}ERROR: BORG is not installed on this system!${norm}\n\n" printf "\n%sERROR: BORG is not installed on this system!%s\n\n" "$err" "$norm"
exit 3 exit 3
fi fi
# if 503 functionality is enabled, do 503 related files exist? # if 503 functionality is enabled, do 503 related files exist?
@ -377,26 +377,26 @@ fi
### start logging ### start logging
printf "${magenta}[%s] --- Start %s execution ---${norm}\n" \ printf "%s[%s] --- Start %s execution ---%s\n" \
"$(stamp)" "$scriptName" >> "$logFile" "$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
printf "${cyan}[%s] -- [INFO] Log located at ${yellow}%s${cyan} --${norm}\n" \ printf "%s[%s] -- [INFO] Log located at %s%s%s --%s\n" \
"$(stamp)" "$logFile" >> "$logFile" "$cyan" "$(stamp)" "$yellow" "$logFile" "$cyan" "$norm" >> "$logFile"
### 503 functionality ### 503 functionality
if [ "$use503" -eq 1 ]; then if [ "$use503" -eq 1 ]; then
printf "${cyan}[%s] -- [INFO] Copying 503 error page to " \ printf "%s[%s] -- [INFO] Copying 503 error page to " \
"$(stamp)" >> "$logFile" "$cyan" "$(stamp)" >> "$logFile"
printf "webroot -- ${norm}\n" >> "$logFile" printf "webroot -- %s\n" "$norm" >> "$logFile"
if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>> "$logFile" if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>> "$logFile"
then then
printf "${warn}[%s] -- [WARNING] Failed to copy 503 error page. " \ printf "%s[%s] -- [WARNING] Failed to copy 503 error page. " \
"$(stamp)" >> "$logFile" "$warn" "$(stamp)" >> "$logFile"
printf "Web users will NOT be notified --${norm}\n" >> "$logFile" printf "Web users will NOT be notified --%s\n" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
else else
printf "${ok}[%s] -- [SUCCESS] 503 error page copied --${norm}\n" \ printf "%s[%s] -- [SUCCESS] 503 error page copied --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
# set cleanup flag # set cleanup flag
err503Copied=1 err503Copied=1
fi fi
@ -415,8 +415,8 @@ case "${configDetails}" in
. "./${configDetails}" . "./${configDetails}"
;; ;;
esac esac
printf "${cyan}[%s] -- [INFO] ${yellow}%s${cyan} imported --${norm}\n" \ printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
"$(stamp)" "$configDetails" >> "$logFile" "$cyan" "$(stamp)" "$yellow" "$configDetails" "$cyan" "$norm" >> "$logFile"
## create tmp directory and change to it for export operations ## create tmp directory and change to it for export operations
@ -431,36 +431,36 @@ fi
if ! cd "$exportDir"; then if ! cd "$exportDir"; then
exitError 113 "Unable to change to temporary export directory" exitError 113 "Unable to change to temporary export directory"
fi fi
printf "${cyan}[%s] -- [INFO] EML files will be temporarily stored in:" \ printf "%s[%s] -- [INFO] EML files will be temporarily stored in:" \
"$(stamp)" >> "$logFile" "$cyan" "$(stamp)" >> "$logFile"
printf "\n${yellow}%s/${cyan} --${norm}\n" "$exportDir" >> "$logFile" printf "\n\t%s%s/%s --%s\n" "$yellow" "$exportDir" "$cyan" "$norm" >> "$logFile"
## export EML from piler ## export EML from piler
printf "${cyan}[%s] -- [INFO] Exporting EML files from piler --${norm}\n" \ printf "%s[%s] -- [INFO] Exporting EML files from piler --%s\n" \
"$(stamp)" >> "$logFile" "$cyan" "$(stamp)" "$norm" >> "$logFile"
if [ "$exportAll" -eq 1 ]; then if [ "$exportAll" -eq 1 ]; then
if ! ${pilerExport} -A 2>>"$logFile"; then if ! ${pilerExport} -A 2>>"$logFile"; then
exitError 115 "There was a problem while exporting EML from piler" exitError 115 "There was a problem while exporting EML from piler"
fi fi
printf "${ok}[%s] -- [SUCCESS] Exported EML files from piler --${norm}\n" \ printf "%s[%s] -- [SUCCESS] Exported EML files from piler --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
else else
if ! ${pilerExport} -a "$exportStart" -b "$exportEnd" 2>>"$logFile"; then if ! ${pilerExport} -a "$exportStart" -b "$exportEnd" 2>>"$logFile"; then
exitError 115 "There was a problem while exporting EML from piler" exitError 115 "There was a problem while exporting EML from piler"
fi fi
printf "${ok}[%s] -- [SUCCESS] Exported EML files from piler --${norm}\n" \ printf "%s[%s] -- [SUCCESS] Exported EML files from piler --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
fi fi
### pre-backup tasks completed -- move to borg tasks ### pre-backup tasks completed -- move to borg tasks
printf "${ok}[%s] -- [SUCCESS] Pre-backup tasks completed --${norm}\n" \ printf "%s[%s] -- [SUCCESS] Pre-backup tasks completed --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
### Run borg variable checks ### Run borg variable checks
printf "${cyan}[%s] -- [INFO] Verifying supplied borg details --${norm}\n" \ printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
"$(stamp)" >> "$logFile" "$cyan" "$(stamp)" "$norm" >> "$logFile"
## verify borg base directory ## verify borg base directory
if [ -z "${borgBaseDir}" ]; then if [ -z "${borgBaseDir}" ]; then
@ -468,8 +468,8 @@ if [ -z "${borgBaseDir}" ]; then
elif [ ! -d "${borgBaseDir}" ]; then elif [ ! -d "${borgBaseDir}" ]; then
badDetails dne 'borgBaseDir' badDetails dne 'borgBaseDir'
fi fi
printf "${magenta}details:borgBaseDir ${norm}-- ${ok}[OK]${norm}\n" \ printf "%sdetails:borgBaseDir%s -- %s[OK]%s\n" \
>> "$logFile" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
export BORG_BASE_DIR="${borgBaseDir%/}" export BORG_BASE_DIR="${borgBaseDir%/}"
## check path to SSH keyfile ## check path to SSH keyfile
@ -478,28 +478,28 @@ if [ -z "${borgSSHKey}" ]; then
elif [ ! -f "${borgSSHKey}" ]; then elif [ ! -f "${borgSSHKey}" ]; then
badDetails dne 'borgSSHKey' badDetails dne 'borgSSHKey'
fi fi
printf "${magenta}details:borgSSHKey ${norm}-- ${ok}[OK]${norm}\n" \ printf "%sdetails:borgSSHKey%s -- %s[OK]%s\n" \
>> "$logFile" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
export BORG_RSH="ssh -i ${borgSSHKey}" export BORG_RSH="ssh -i ${borgSSHKey}"
## check borg repo connect string ## check borg repo connect string
if [ -z "${borgConnectRepo}" ]; then if [ -z "${borgConnectRepo}" ]; then
badDetails empty 'borgConnectRepo' badDetails empty 'borgConnectRepo'
fi fi
printf "${magenta}details:borgConnectRepo ${norm}-- ${ok}[OK]${norm}\n" \ printf "%sdetails:borgConnectRepo%s -- %s[OK]%s\n" \
>> "$logFile" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
export BORG_REPO="${borgConnectRepo}" export BORG_REPO="${borgConnectRepo}"
## check borg repo password ## check borg repo password
if [ -n "${borgRepoPassphrase}" ]; then if [ -n "${borgRepoPassphrase}" ]; then
printf "${magenta}details:borgRepoPassphrase ${norm}-- ${ok}[OK]${norm}\n" \ printf "%sdetails:borgRepoPassphrase%s -- %s[OK]%s\n" \
>> "$logFile" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
export BORG_PASSPHRASE="${borgRepoPassphrase}" export BORG_PASSPHRASE="${borgRepoPassphrase}"
else else
# if passwd is blank intentionally, this is insecure # if passwd is blank intentionally, this is insecure
printf "${warn} -- [WARNING] Using a borg repo without a password is an " \ printf "%s-- [WARNING] Using a borg repo without a password is an " \
>> "$logFile" "$warn" >> "$logFile"
printf "insecure configuration --${norm}\n" >> "$logFile" printf "insecure configuration --%s\n" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
# if this was an accident, we need to provide a bogus passwd so borg fails # if this was an accident, we need to provide a bogus passwd so borg fails
# otherwise it will sit forever just waiting for input # otherwise it will sit forever just waiting for input
@ -525,8 +525,8 @@ if [ -n "${borgXtraListPath}" ]; then
done <<EOF done <<EOF
$( sed -e '/^\s*#.*$/d' -e '/^\s*$/d' "${borgXtraListPath}" ) $( sed -e '/^\s*#.*$/d' -e '/^\s*$/d' "${borgXtraListPath}" )
EOF EOF
printf "${magenta}details:borgXtraListPath ${norm}-- ${ok}[OK]${norm}\n" \ printf "%sdetails:borgXtraListPath%s -- %s[OK]%s\n" \
>> "$logFile" "$magenta" "$norm" "$ok" "$norm" >> "$logFile"
includeXtra=1 includeXtra=1
fi fi
@ -551,9 +551,9 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
if ! mkdir "${borgBaseDir}/tmp"; then if ! mkdir "${borgBaseDir}/tmp"; then
exitError 132 "Unable to create borg ${borgBaseDir}/tmp directory" exitError 132 "Unable to create borg ${borgBaseDir}/tmp directory"
else else
printf "${cyan}[%s] -- [INFO] Created ${yellow}%s/tmp " \ printf "%s[%s] -- [INFO] Created %s%s/tmp " \
"$(stamp)" "${borgBaseDir}" >> "$logFile" "$cyan" "$(stamp)" "$yellow" "${borgBaseDir}" >> "$logFile"
printf "${cyan}--${norm}\n" >> "$logFile" printf "%s--%s\n" "$cyan" "$norm" >> "$logFile"
fi fi
fi fi
export TMPDIR="${borgBaseDir}/tmp" export TMPDIR="${borgBaseDir}/tmp"
@ -580,66 +580,66 @@ if [ "$includeXtra" -eq 1 ]; then
fi fi
# execute borg # execute borg
printf "${cyan}[%s] -- [INFO] Executing borg backup operation --${norm}\n" \ printf "%s[%s] -- [INFO] Executing borg backup operation --%s\n" \
"$(stamp)" >> "$logFile" "$cyan" "$(stamp)" "$norm" >> "$logFile"
${borgCMD} 2>> "$logFile" ${borgCMD} 2>> "$logFile"
borgResult="$?" borgResult="$?"
## check borg exit status ## check borg exit status
if [ "$borgResult" -eq 0 ]; then if [ "$borgResult" -eq 0 ]; then
printf "${ok}[%s] -- [SUCCESS] Borg backup completed --${norm}\n" \ printf "%s[%s] -- [SUCCESS] Borg backup completed --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
elif [ "$borgResult" -eq 1 ]; then elif [ "$borgResult" -eq 1 ]; then
printf "${warn}[%s] -- [WARNING] Borg completed with warnings. " \ printf "%s[%s] -- [WARNING] Borg completed with warnings. " \
"$(stamp)" >> "$logFile" "$warn" "$(stamp)" >> "$logFile"
printf "Review this logfile for details --${norm}\n" >> "$logFile" printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
elif [ "$borgResult" -ge 2 ]; then elif [ "$borgResult" -ge 2 ]; then
err_1="Borg exited with a critical error. Please review this log file" err_1="Borg exited with a critical error. Please review this log file"
err_2="for details." err_2="for details."
exitError 138 "$err_1 $err_2" exitError 138 "$err_1 $err_2"
else else
printf "${warn}[%s] -- [WARNING] Borg exited with unknown return code. " \ printf "%s[%s] -- [WARNING] Borg exited with unknown return code. " \
"$(stamp)" >> "$logFile" "$warn" "$(stamp)" >> "$logFile"
printf "Review this logfile for details --${norm}\n" >> "$logFile" printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
fi fi
### execute borg prune if paramters are provided, otherwise skip with a warning ### execute borg prune if paramters are provided, otherwise skip with a warning
if [ -n "${borgPruneSettings}" ]; then if [ -n "${borgPruneSettings}" ]; then
printf "${cyan}[%s] -- [INFO] Executing borg prune operation --${norm}\n" \ printf "%s[%s] -- [INFO] Executing borg prune operation --%s\n" \
"$(stamp)" >> "$logFile" "$cyan" "$(stamp)" "$norm" >> "$logFile"
borg prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \ borg prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
2>> "$logFile" 2>> "$logFile"
borgPruneResult="$?" borgPruneResult="$?"
else else
printf "${warn}[%s] -- [WARNING] No prune parameters provided. " \ printf "%s[%s] -- [WARNING] No prune parameters provided. " \
"$(stamp)" >> "$logFile" "$warn" "$(stamp)" >> "$logFile"
printf "Your archive will continue growing with each backup --${norm}\n" \ printf "Your archive will continue growing with each backup --%s\n" \
>> "$logFile" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
fi fi
## report on prune operation if executed ## report on prune operation if executed
if [ -n "${borgPruneResult}" ]; then if [ -n "${borgPruneResult}" ]; then
if [ "${borgPruneResult}" -eq 0 ]; then if [ "${borgPruneResult}" -eq 0 ]; then
printf "${ok}[%s] -- [SUCCESS] Borg prune completed --${norm}\n" \ printf "%s[%s] -- [SUCCESS] Borg prune completed --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
elif [ "$borgPruneResult" -eq 1 ]; then elif [ "$borgPruneResult" -eq 1 ]; then
printf "${warn}[%s] -- [WARNING] Borg prune completed with warnings. " \ printf "%s[%s] -- [WARNING] Borg prune completed with warnings. " \
"$(stamp)" >> "$logFile" "$warn" "$(stamp)" >> "$logFile"
printf "Review this logfile for details --${norm}\n" >> "$logFile" printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
elif [ "$borgPruneResult" -ge 2 ]; then elif [ "$borgPruneResult" -ge 2 ]; then
err_1="Borg prune exited with a critical error. Please review this" err_1="Borg prune exited with a critical error. Please review this"
err_2="log file for details." err_2="log file for details."
exitError 139 "$err_1 $err_2" exitError 139 "$err_1 $err_2"
else else
printf "${warn}[%s] -- [WARNING] Borg prune exited with an unknown " \ printf "%s[%s] -- [WARNING] Borg prune exited with an unknown " \
"$(stamp)" >> "$logFile" "$warn" "$(stamp)" >> "$logFile"
printf "return code. Review this logfile for details --${norm}\n" \ printf "return code. Review this logfile for details --%s\n" \
>> "$logFile" "$norm" >> "$logFile"
warnCount=$((warnCount+1)) warnCount=$((warnCount+1))
fi fi
fi fi
@ -648,21 +648,21 @@ fi
### all processes successfully completed, cleanup and exit gracefully ### all processes successfully completed, cleanup and exit gracefully
# note successful completion of borg commands # note successful completion of borg commands
printf "${ok}[%s] -- [SUCCESS] Backup operations completed --${norm}\n" \ printf "%s[%s] -- [SUCCESS] Backup operations completed --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
# cleanup # cleanup
cleanup cleanup
# note complete success, tally warnings and exit # note complete success, tally warnings and exit
printf "${ok}[%s] -- [SUCCESS] All processes completed --${norm}\n" \ printf "%s[%s] -- [SUCCESS] All processes completed --%s\n" \
"$(stamp)" >> "$logFile" "$ok" "$(stamp)" "$norm" >> "$logFile"
printf "${magenta}[%s] --- %s execution completed ---${norm}\n" \ printf "%s[%s] --- %s execution completed ---%s\n" \
"$(stamp)" "$scriptName" >> "$logFile" "$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
if [ "$warnCount" -gt 0 ]; then if [ "$warnCount" -gt 0 ]; then
printf "${warn}%s warnings issued!${norm}\n" "${warnCount}" >> "$logFile" printf "%s%s warnings issued!%s\n" "$warn" "${warnCount}" "$norm" >> "$logFile"
else else
printf "${ok}0 warnings issued.${norm}\n" >> "$logFile" printf "%s0 warnings issued.%s\n" "$ok" "$norm" >> "$logFile"
fi fi
exit 0 exit 0