Compare commits
9 Commits
3f08853826
...
6fc82aac83
| Author | SHA1 | Date | |
|---|---|---|---|
|
6fc82aac83 | ||
|
|
760399a0fd | ||
|
|
868398858e | ||
|
|
44e57df831 | ||
|
|
bbea5e871c | ||
|
|
e74971997f | ||
|
|
ffc7579666 | ||
|
|
acec0d6b23 | ||
|
|
5b1678c6ae |
@ -5,14 +5,34 @@
|
||||
#######
|
||||
|
||||
|
||||
### set environment variables
|
||||
if [ -z "$TERM" ]; then
|
||||
export TERM=dumb;
|
||||
fi
|
||||
export PATH=$PATH:/usr/local/bin
|
||||
|
||||
### text formatting presents
|
||||
norm=$(tput sgr0)
|
||||
err=$(tput bold)$(tput setaf 1)
|
||||
warn=$(tput bold)$(tput setaf 3)
|
||||
ok=$(tput setaf 2)
|
||||
yellow=$(tput setaf 3)
|
||||
cyan=$(tput setaf 6)
|
||||
magenta=$(tput setaf 5)
|
||||
if command -v tput > /dev/null; then
|
||||
bold=$(tput bold)
|
||||
cyan=$(tput setaf 6)
|
||||
err=$(tput bold)$(tput setaf 1)
|
||||
magenta=$(tput setaf 5)
|
||||
norm=$(tput sgr0)
|
||||
ok=$(tput setaf 2)
|
||||
warn=$(tput bold)$(tput setaf 3)
|
||||
width=$(tput cols)
|
||||
yellow=$(tput setaf 3)
|
||||
else
|
||||
bold=""
|
||||
cyan=""
|
||||
err=""
|
||||
magenta=""
|
||||
norm=""
|
||||
ok=""
|
||||
warn=""
|
||||
width=80
|
||||
yellow=""
|
||||
fi
|
||||
|
||||
|
||||
### trap
|
||||
@ -33,20 +53,20 @@ badDetails () {
|
||||
# bad parameter passed to script
|
||||
badParam () {
|
||||
if [ "$1" = "dne" ]; then
|
||||
printf "${err}\nError: '%s %s'\n" "$2" "$3"
|
||||
printf "file or directory does not exist.${norm}\n\n"
|
||||
printf "\n%sError: '%s %s'\n" "$err" "$2" "$3"
|
||||
printf "file or directory does not exist.%s\n\n" "$norm"
|
||||
exit 1
|
||||
elif [ "$1" = "empty" ]; then
|
||||
printf "${err}\nError: '%s' cannot have a NULL (empty) value.\n" "$2"
|
||||
printf "${cyan}Please use '--help' for assistance${norm}\n\n"
|
||||
printf "\n%sError: '%s' cannot have a NULL (empty) value.\n" "$err" "$2"
|
||||
printf "%sPlease use '--help' for assistance%s\n\n" "$cyan" "$norm"
|
||||
exit 1
|
||||
elif [ "$1" = "svc" ]; then
|
||||
printf "${err}\nError: '%s %s': Service does not exist!${norm}\n\n" \
|
||||
"$2" "$3"
|
||||
printf "\n%sError: '%s %s': Service does not exist!${norm}\n\n" \
|
||||
"$err" "$2" "$3"
|
||||
exit 1
|
||||
elif [ "$1" = "user" ]; then
|
||||
printf "${err}\nError: '%s %s': User does not exist!${norm}\n\n" \
|
||||
"$2" "$3"
|
||||
printf "\n%sError: '%s %s': User does not exist!${norm}\n\n" \
|
||||
"$err" "$2" "$3"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
@ -56,109 +76,97 @@ cleanup () {
|
||||
# cleanup 503 if copied
|
||||
if [ "$err503Copied" -eq 1 ]; then
|
||||
if ! rm -f "$webroot/$err503File" 2>>"$logFile"; then
|
||||
printf "${warn}[%s] -- [WARNING] Could not remove 503 error page." \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Could not remove 503 error page." \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf " Web interface will not function until this file is " \
|
||||
>> "$logFile"
|
||||
printf "removed --${norm}\n" >> "$logFile"
|
||||
printf "removed --%s\n" "$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
else
|
||||
printf "${cyan}[%s] -- [INFO] 503 error page removed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
fi
|
||||
printf "%s[%s] -- [INFO] 503 error page removed --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
fi
|
||||
fi
|
||||
# remove EML temporary directory
|
||||
if ! rm -rf "$exportDir" 2>>"$logFile"; then
|
||||
printf "${warn}[%s] -- [WARNING] Could not remove EML export tmp dir:" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Could not remove EML export tmp dir:" \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "\n%s\n" "$exportDir" >> "$logFile"
|
||||
printf "please remove this directory manually! --${norm}\n" \
|
||||
printf "please remove this directory manually! --%s\n" "$norm" \
|
||||
>> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
else
|
||||
printf "${cyan}[%s] -- [INFO] EML temp directory removed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] EML temp directory removed --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
fi
|
||||
}
|
||||
|
||||
# call cleanup and then exit with error report
|
||||
exitError () {
|
||||
printf "${err}[%s] -- [ERROR] %s: %s --${norm}\n" \
|
||||
"$(stamp)" "$1" "$2" >> "$logFile"
|
||||
printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
|
||||
"$err" "$(stamp)" "$1" "$2" "$norm" >> "$logFile"
|
||||
cleanup
|
||||
# note script completion with error
|
||||
printf "${err}[%s] --- %s execution completed with error ---${norm}\n" \
|
||||
"$(stamp)" "$scriptName" >> "$logFile"
|
||||
printf "%s[%s] --- %s execution completed with error ---%s\n" \
|
||||
"$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
|
||||
exit "$1"
|
||||
}
|
||||
|
||||
# display script help information
|
||||
scriptHelp () {
|
||||
printf "\n${cyan}%s\n" "--------------------------------------------------------------------------------"
|
||||
|
||||
printf "Usage:${norm} %s [parameters]\n\n" "$scriptName"
|
||||
printf "${cyan}Parameters ${yellow}(default value):${norm}\n"
|
||||
printf "There are NO mandatory parameters. If a parameter is not "
|
||||
printf "supplied, it's\n"
|
||||
printf "default value will be used. In the case of a switch parameter, "
|
||||
printf "it will\n"
|
||||
printf "remain deactivated if not specified.\n\n"
|
||||
|
||||
printf "${magenta}script related\n"
|
||||
printf "${cyan}-c, --config, --details${norm}\n"
|
||||
printf "Path to the configuration key/value pair file for this script.\n"
|
||||
printf "${yellow}(scriptPath/scriptName.details)${norm}\n\n"
|
||||
printf "${cyan}-h, -?, --help${norm}\n"
|
||||
printf "This help screen.\n\n"
|
||||
printf "${cyan}-l, --log${norm}\n"
|
||||
printf "Path to write log file.\n"
|
||||
printf "${yellow}(scriptPath/scriptName.log)${norm}\n\n"
|
||||
printf "${cyan}-v, --verbose${norm}\n"
|
||||
printf "Log borg output with increased verbosity (list all files). "
|
||||
printf "Careful! Your\n"
|
||||
printf "log file can get large very quickly! This is a switch value, "
|
||||
printf "specifying it\n"
|
||||
printf "will turn the option ON.\n"
|
||||
printf "${yellow}(normal output, option is OFF)${norm}\n\n"
|
||||
|
||||
printf "${magenta}export options\n"
|
||||
printf "${cyan}-a, --all${norm}\n"
|
||||
printf "Export ALL email saved by piler. This is generally only useful "
|
||||
printf "for an initial\n"
|
||||
printf "backup. This is a switch parameter and WILL override specified "
|
||||
printf "start/end dates.\n"
|
||||
printf "${yellow}(option is OFF, use start/end dates)${norm}\n\n"
|
||||
printf "${cyan}--start${norm}\n"
|
||||
printf "Export email starting from this date (inclusive)\n"
|
||||
printf "Date MUST be provided in the format 'YYYY.MM.DD'\n"
|
||||
printf "${yellow}(Yesterday's date)${norm}\n\n"
|
||||
printf "${cyan}--end${norm}\n"
|
||||
printf "Export email ending at this date (inclusive)\n"
|
||||
printf "Date MUST be provided in the format 'YYYY.MM.DD'\n"
|
||||
printf "${yellow}(Yesterday's date)${norm}\n\n"
|
||||
|
||||
printf "${magenta}503 functionality\n"
|
||||
printf "${cyan}-5, --use-503${norm}\n"
|
||||
printf "Copy an 'error 503' page to your webroot for your webserver to "
|
||||
printf "find. This is a\n"
|
||||
printf "switch value, specifying it will instruct the script to copy the "
|
||||
printf "error page.\n"
|
||||
printf "${yellow}(do NOT copy, option is OFF)${norm}\n\n"
|
||||
printf "${cyan}--503-path${norm}\n"
|
||||
printf "Path to the file you want copied to your webroot as the 'error "
|
||||
printf "503' page during\n"
|
||||
printf "backup operations.\n"
|
||||
printf "${yellow}(scriptPath/503_backup.html)${norm}\n\n"
|
||||
printf "${cyan}-w, --webroot${norm}\n"
|
||||
printf "Path to where the 'error 503' file should be copied during "
|
||||
printf "backups.\n"
|
||||
printf "${yellow}(/usr/share/nginx/html)${norm}\n\n"
|
||||
|
||||
printf "More details and examples of script usage can be found in the "
|
||||
printf "repo wiki at\n"
|
||||
printf "${yellow}https://git.asifbacchus.app/asif/pilerBackup/wiki${norm}\n"
|
||||
|
||||
printf "${cyan}%s${norm}\n\n" "--------------------------------------------------------------------------------"
|
||||
newline
|
||||
printf "%sUsage: %s [parameters]%s\n\n" "$bold" "$scriptName" "$norm"
|
||||
textblock "There are no mandatory parameters. If a parameter is not supplied, its default value will be used. In the case of a switch parameter, it will remain DEactivated by default."
|
||||
newline
|
||||
textblock "Parameters are listed then followed by a description of their effect on the following line. Finally, if a default value exists, it will be listed on the next line in (parentheses)."
|
||||
newline
|
||||
textblock "${magenta}--- script related ---${norm}"
|
||||
newline
|
||||
switchTextblock "-c | --config | --details"
|
||||
textblock "Path to the configuration key/value pair file for this script."
|
||||
defaultsTextblock "(scriptPath/scriptName.details)"
|
||||
newline
|
||||
switchTextblock "-h | -? | --help"
|
||||
textblock "This help screen."
|
||||
newline
|
||||
switchTextblock "-l | --log"
|
||||
textblock "Path to write log file."
|
||||
defaultsTextblock "(scriptPath/scriptName.log)"
|
||||
newline
|
||||
switchTextblock "[SWITCH] -v | --verbose"
|
||||
textblock "Log borg output with increased verbosity (list all files). Careful! Your log file can get very large very quickly!"
|
||||
defaultsTextblock "(normal output, option is OFF)"
|
||||
newline
|
||||
textblock "${magenta}--- export options ---${norm}"
|
||||
newline
|
||||
switchTextblock "[SWITCH] -a | --all"
|
||||
textblock "Export ALL email saved by piler. This is generally only useful for an initial backup. Setting this switch will override any specified start/end dates."
|
||||
defaultsTextblock "(use start/end dates, option is OFF)"
|
||||
newline
|
||||
switchTextblock "--start"
|
||||
textblock "Export email starting from this date (inclusive). Date MUST be provided in YYYY.MM.DD format."
|
||||
defaultsTextblock "(yesterday's date)"
|
||||
newline
|
||||
switchTextblock "--end"
|
||||
textblock "Export email ending at this date (inclusive). Date MUST be provided in YYYY.MM.DD format."
|
||||
defaultsTextblock "(yesterday's date)"
|
||||
newline
|
||||
textblock "${magenta}--- 503 functionality ---${norm}"
|
||||
newline
|
||||
switchTextblock "[SWITCH] -5 | --use-503"
|
||||
textblock "Copy an 'error 503' page/indicator file to your webroot for your webserver to find. Specifying this option will enable other 503 options."
|
||||
defaultsTextblock "(do NOT copy, option is OFF)"
|
||||
newline
|
||||
switchTextblock "--503-path"
|
||||
textblock "Path to the file you want copied to your webroot as the 'error 503' page."
|
||||
defaultsTextblock "(scriptPath/503_backup.html)"
|
||||
newline
|
||||
switchTextblock "-w | --webroot"
|
||||
textblock "Path to where the 'error 503' file should be copied."
|
||||
defaultsTextblock "(/usr/share/nginx/html/)"
|
||||
newline
|
||||
textblock "More details and examples of script usage can be found in the repo wiki at ${yellow}https://git.asifbacchus.app/asif/pilerBackup/wiki${norm}"
|
||||
newline
|
||||
}
|
||||
|
||||
# generate dynamic timestamps
|
||||
@ -166,14 +174,30 @@ stamp () {
|
||||
(date +%F" "%T)
|
||||
}
|
||||
|
||||
textblock() {
|
||||
printf "%s\n" "$1" | fold -w "$width" -s
|
||||
}
|
||||
|
||||
defaultsTextblock() {
|
||||
printf "%s%s%s\n" "$yellow" "$1" "$norm"
|
||||
}
|
||||
|
||||
switchTextblock() {
|
||||
printf "%s%s%s\n" "$cyan" "$1" "$norm"
|
||||
}
|
||||
|
||||
newline() {
|
||||
printf "\n"
|
||||
}
|
||||
|
||||
# same as exitError but for signal captures
|
||||
trapExit () {
|
||||
printf "${err}[%s] -- [ERROR] 99: Caught signal --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [ERROR] 99: Caught signal --%s\n" \
|
||||
"$err" "$(stamp)" "$norm" >> "$logFile"
|
||||
cleanup
|
||||
# note script completion with error
|
||||
printf "${err}[%s] --- %s execution was terminated via signal ---${norm}\n" \
|
||||
"$(stamp)" "$scriptName" >> "$logFile"
|
||||
printf "%s[%s] --- %s execution was terminated via signal ---%s\n" \
|
||||
"$err" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
|
||||
exit 99
|
||||
}
|
||||
|
||||
@ -312,8 +336,8 @@ while [ $# -gt 0 ]; do
|
||||
fi
|
||||
;;
|
||||
*)
|
||||
printf "${err}\nUnknown option: %s\n" "$1"
|
||||
printf "${cyan}Use '--help' for valid options.{$norm}\n\n"
|
||||
printf "%s\nUnknown option: %s\n" "$err" "$1"
|
||||
printf "%sUse '--help' for valid options.%s\n\n" "$cyan" "$norm"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
@ -324,13 +348,13 @@ done
|
||||
### check pre-requisites and default values
|
||||
# check if running as root, otherwise exit
|
||||
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
|
||||
fi
|
||||
# find pilerexport, otherwise this is all pointless
|
||||
pilerExport=$( command -v pilerexport )
|
||||
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
|
||||
fi
|
||||
# does the details file exist?
|
||||
@ -339,7 +363,7 @@ if [ ! -f "$configDetails" ]; then
|
||||
fi
|
||||
# is borg installed?
|
||||
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
|
||||
fi
|
||||
# if 503 functionality is enabled, do 503 related files exist?
|
||||
@ -353,26 +377,26 @@ fi
|
||||
|
||||
|
||||
### start logging
|
||||
printf "${magenta}[%s] --- Start %s execution ---${norm}\n" \
|
||||
"$(stamp)" "$scriptName" >> "$logFile"
|
||||
printf "${cyan}[%s] -- [INFO] Log located at ${yellow}%s${cyan} --${norm}\n" \
|
||||
"$(stamp)" "$logFile" >> "$logFile"
|
||||
printf "%s[%s] --- Start %s execution ---%s\n" \
|
||||
"$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Log located at %s%s%s --%s\n" \
|
||||
"$cyan" "$(stamp)" "$yellow" "$logFile" "$cyan" "$norm" >> "$logFile"
|
||||
|
||||
|
||||
### 503 functionality
|
||||
if [ "$use503" -eq 1 ]; then
|
||||
printf "${cyan}[%s] -- [INFO] Copying 503 error page to " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "webroot -- ${norm}\n" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Copying 503 error page to " \
|
||||
"$cyan" "$(stamp)" >> "$logFile"
|
||||
printf "webroot -- %s\n" "$norm" >> "$logFile"
|
||||
if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>> "$logFile"
|
||||
then
|
||||
printf "${warn}[%s] -- [WARNING] Failed to copy 503 error page. " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "Web users will NOT be notified --${norm}\n" >> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Failed to copy 503 error page. " \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "Web users will NOT be notified --%s\n" "$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
else
|
||||
printf "${ok}[%s] -- [SUCCESS] 503 error page copied --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] 503 error page copied --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
# set cleanup flag
|
||||
err503Copied=1
|
||||
fi
|
||||
@ -391,8 +415,8 @@ case "${configDetails}" in
|
||||
. "./${configDetails}"
|
||||
;;
|
||||
esac
|
||||
printf "${cyan}[%s] -- [INFO] ${yellow}%s${cyan} imported --${norm}\n" \
|
||||
"$(stamp)" "$configDetails" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
|
||||
"$cyan" "$(stamp)" "$yellow" "$configDetails" "$cyan" "$norm" >> "$logFile"
|
||||
|
||||
|
||||
## create tmp directory and change to it for export operations
|
||||
@ -407,36 +431,36 @@ fi
|
||||
if ! cd "$exportDir"; then
|
||||
exitError 113 "Unable to change to temporary export directory"
|
||||
fi
|
||||
printf "${cyan}[%s] -- [INFO] EML files will be temporarily stored in:" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "\n${yellow}%s/${cyan} --${norm}\n" "$exportDir" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] EML files will be temporarily stored in:" \
|
||||
"$cyan" "$(stamp)" >> "$logFile"
|
||||
printf "\n\t%s%s/%s --%s\n" "$yellow" "$exportDir" "$cyan" "$norm" >> "$logFile"
|
||||
|
||||
## export EML from piler
|
||||
printf "${cyan}[%s] -- [INFO] Exporting EML files from piler --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Exporting EML files from piler --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
if [ "$exportAll" -eq 1 ]; then
|
||||
if ! ${pilerExport} -A 2>>"$logFile"; then
|
||||
exitError 115 "There was a problem while exporting EML from piler"
|
||||
fi
|
||||
printf "${ok}[%s] -- [SUCCESS] Exported EML files from piler --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] Exported EML files from piler --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
else
|
||||
if ! ${pilerExport} -a "$exportStart" -b "$exportEnd" 2>>"$logFile"; then
|
||||
exitError 115 "There was a problem while exporting EML from piler"
|
||||
fi
|
||||
printf "${ok}[%s] -- [SUCCESS] Exported EML files from piler --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] Exported EML files from piler --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
fi
|
||||
|
||||
|
||||
### pre-backup tasks completed -- move to borg tasks
|
||||
printf "${ok}[%s] -- [SUCCESS] Pre-backup tasks completed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] Pre-backup tasks completed --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
|
||||
|
||||
### Run borg variable checks
|
||||
printf "${cyan}[%s] -- [INFO] Verifying supplied borg details --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
|
||||
## verify borg base directory
|
||||
if [ -z "${borgBaseDir}" ]; then
|
||||
@ -444,8 +468,8 @@ if [ -z "${borgBaseDir}" ]; then
|
||||
elif [ ! -d "${borgBaseDir}" ]; then
|
||||
badDetails dne 'borgBaseDir'
|
||||
fi
|
||||
printf "${magenta}details:borgBaseDir ${norm}-- ${ok}[OK]${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%sdetails:borgBaseDir%s -- %s[OK]%s\n" \
|
||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||
export BORG_BASE_DIR="${borgBaseDir%/}"
|
||||
|
||||
## check path to SSH keyfile
|
||||
@ -454,28 +478,28 @@ if [ -z "${borgSSHKey}" ]; then
|
||||
elif [ ! -f "${borgSSHKey}" ]; then
|
||||
badDetails dne 'borgSSHKey'
|
||||
fi
|
||||
printf "${magenta}details:borgSSHKey ${norm}-- ${ok}[OK]${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%sdetails:borgSSHKey%s -- %s[OK]%s\n" \
|
||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||
export BORG_RSH="ssh -i ${borgSSHKey}"
|
||||
|
||||
## check borg repo connect string
|
||||
if [ -z "${borgConnectRepo}" ]; then
|
||||
badDetails empty 'borgConnectRepo'
|
||||
fi
|
||||
printf "${magenta}details:borgConnectRepo ${norm}-- ${ok}[OK]${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%sdetails:borgConnectRepo%s -- %s[OK]%s\n" \
|
||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||
export BORG_REPO="${borgConnectRepo}"
|
||||
|
||||
## check borg repo password
|
||||
if [ -n "${borgRepoPassphrase}" ]; then
|
||||
printf "${magenta}details:borgRepoPassphrase ${norm}-- ${ok}[OK]${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%sdetails:borgRepoPassphrase%s -- %s[OK]%s\n" \
|
||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||
export BORG_PASSPHRASE="${borgRepoPassphrase}"
|
||||
else
|
||||
# if passwd is blank intentionally, this is insecure
|
||||
printf "${warn} -- [WARNING] Using a borg repo without a password is an " \
|
||||
>> "$logFile"
|
||||
printf "insecure configuration --${norm}\n" >> "$logFile"
|
||||
printf "%s-- [WARNING] Using a borg repo without a password is an " \
|
||||
"$warn" >> "$logFile"
|
||||
printf "insecure configuration --%s\n" "$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
# if this was an accident, we need to provide a bogus passwd so borg fails
|
||||
# otherwise it will sit forever just waiting for input
|
||||
@ -501,8 +525,8 @@ if [ -n "${borgXtraListPath}" ]; then
|
||||
done <<EOF
|
||||
$( sed -e '/^\s*#.*$/d' -e '/^\s*$/d' "${borgXtraListPath}" )
|
||||
EOF
|
||||
printf "${magenta}details:borgXtraListPath ${norm}-- ${ok}[OK]${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%sdetails:borgXtraListPath%s -- %s[OK]%s\n" \
|
||||
"$magenta" "$norm" "$ok" "$norm" >> "$logFile"
|
||||
includeXtra=1
|
||||
fi
|
||||
|
||||
@ -527,9 +551,9 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
|
||||
if ! mkdir "${borgBaseDir}/tmp"; then
|
||||
exitError 132 "Unable to create borg ${borgBaseDir}/tmp directory"
|
||||
else
|
||||
printf "${cyan}[%s] -- [INFO] Created ${yellow}%s/tmp " \
|
||||
"$(stamp)" "${borgBaseDir}" >> "$logFile"
|
||||
printf "${cyan}--${norm}\n" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Created %s%s/tmp " \
|
||||
"$cyan" "$(stamp)" "$yellow" "${borgBaseDir}" >> "$logFile"
|
||||
printf "%s--%s\n" "$cyan" "$norm" >> "$logFile"
|
||||
fi
|
||||
fi
|
||||
export TMPDIR="${borgBaseDir}/tmp"
|
||||
@ -556,66 +580,66 @@ if [ "$includeXtra" -eq 1 ]; then
|
||||
fi
|
||||
|
||||
# execute borg
|
||||
printf "${cyan}[%s] -- [INFO] Executing borg backup operation --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Executing borg backup operation --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
${borgCMD} 2>> "$logFile"
|
||||
borgResult="$?"
|
||||
|
||||
## check borg exit status
|
||||
if [ "$borgResult" -eq 0 ]; then
|
||||
printf "${ok}[%s] -- [SUCCESS] Borg backup completed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] Borg backup completed --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
elif [ "$borgResult" -eq 1 ]; then
|
||||
printf "${warn}[%s] -- [WARNING] Borg completed with warnings. " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "Review this logfile for details --${norm}\n" >> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Borg completed with warnings. " \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
elif [ "$borgResult" -ge 2 ]; then
|
||||
err_1="Borg exited with a critical error. Please review this log file"
|
||||
err_2="for details."
|
||||
exitError 138 "$err_1 $err_2"
|
||||
else
|
||||
printf "${warn}[%s] -- [WARNING] Borg exited with unknown return code. " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "Review this logfile for details --${norm}\n" >> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Borg exited with unknown return code. " \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
fi
|
||||
|
||||
|
||||
### execute borg prune if paramters are provided, otherwise skip with a warning
|
||||
if [ -n "${borgPruneSettings}" ]; then
|
||||
printf "${cyan}[%s] -- [INFO] Executing borg prune operation --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [INFO] Executing borg prune operation --%s\n" \
|
||||
"$cyan" "$(stamp)" "$norm" >> "$logFile"
|
||||
borg prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
|
||||
2>> "$logFile"
|
||||
borgPruneResult="$?"
|
||||
else
|
||||
printf "${warn}[%s] -- [WARNING] No prune parameters provided. " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "Your archive will continue growing with each backup --${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] No prune parameters provided. " \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "Your archive will continue growing with each backup --%s\n" \
|
||||
"$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
fi
|
||||
|
||||
## report on prune operation if executed
|
||||
if [ -n "${borgPruneResult}" ]; then
|
||||
if [ "${borgPruneResult}" -eq 0 ]; then
|
||||
printf "${ok}[%s] -- [SUCCESS] Borg prune completed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] Borg prune completed --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
elif [ "$borgPruneResult" -eq 1 ]; then
|
||||
printf "${warn}[%s] -- [WARNING] Borg prune completed with warnings. " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "Review this logfile for details --${norm}\n" >> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Borg prune completed with warnings. " \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "Review this logfile for details --%s\n" "$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
elif [ "$borgPruneResult" -ge 2 ]; then
|
||||
err_1="Borg prune exited with a critical error. Please review this"
|
||||
err_2="log file for details."
|
||||
exitError 139 "$err_1 $err_2"
|
||||
else
|
||||
printf "${warn}[%s] -- [WARNING] Borg prune exited with an unknown " \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "return code. Review this logfile for details --${norm}\n" \
|
||||
>> "$logFile"
|
||||
printf "%s[%s] -- [WARNING] Borg prune exited with an unknown " \
|
||||
"$warn" "$(stamp)" >> "$logFile"
|
||||
printf "return code. Review this logfile for details --%s\n" \
|
||||
"$norm" >> "$logFile"
|
||||
warnCount=$((warnCount+1))
|
||||
fi
|
||||
fi
|
||||
@ -624,21 +648,21 @@ fi
|
||||
### all processes successfully completed, cleanup and exit gracefully
|
||||
|
||||
# note successful completion of borg commands
|
||||
printf "${ok}[%s] -- [SUCCESS] Backup operations completed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] Backup operations completed --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
|
||||
# cleanup
|
||||
cleanup
|
||||
|
||||
# note complete success, tally warnings and exit
|
||||
printf "${ok}[%s] -- [SUCCESS] All processes completed --${norm}\n" \
|
||||
"$(stamp)" >> "$logFile"
|
||||
printf "${magenta}[%s] --- %s execution completed ---${norm}\n" \
|
||||
"$(stamp)" "$scriptName" >> "$logFile"
|
||||
printf "%s[%s] -- [SUCCESS] All processes completed --%s\n" \
|
||||
"$ok" "$(stamp)" "$norm" >> "$logFile"
|
||||
printf "%s[%s] --- %s execution completed ---%s\n" \
|
||||
"$magenta" "$(stamp)" "$scriptName" "$norm" >> "$logFile"
|
||||
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
|
||||
printf "${ok}0 warnings issued.${norm}\n" >> "$logFile"
|
||||
printf "%s0 warnings issued.%s\n" "$ok" "$norm" >> "$logFile"
|
||||
fi
|
||||
exit 0
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user