2019-07-25 00:03:32 -06:00
#!/bin/sh
#######
### Backup exported email from piler (bare-metal)
#######
2020-08-13 23:48:52 -06:00
### set environment variables
if [ -z " $TERM " ] ; then
export TERM = dumb;
fi
export PATH = $PATH :/usr/local/bin
2019-07-25 00:03:32 -06:00
### text formatting presents
2020-08-13 23:51:36 -06:00
if command -v tput > /dev/null; then
2020-08-14 00:20:49 -06:00
bold = $( tput bold)
2020-08-13 23:51:36 -06:00
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
2020-08-14 00:20:49 -06:00
bold = ""
2020-08-13 23:51:36 -06:00
cyan = ""
err = ""
magenta = ""
norm = ""
ok = ""
warn = ""
width = 80
yellow = ""
fi
2019-07-25 00:03:32 -06:00
### trap
trap trapExit 1 2 3 6
### functions
# bad configuration value passed in details file
badDetails ( ) {
if [ " $1 " = "empty" ] ; then
exitError 130 " details: ${ 2 } cannot be NULL (undefined) "
elif [ " $1 " = "dne" ] ; then
exitError 131 " details: ${ 2 } file or directory does not exist. "
fi
}
# bad parameter passed to script
badParam ( ) {
if [ " $1 " = "dne" ] ; then
2020-08-13 23:53:51 -06:00
printf "\n%sError: '%s %s'\n" " $err " " $2 " " $3 "
2020-08-14 00:39:23 -06:00
printf "file or directory does not exist.%s\n\n" " $norm "
2019-07-25 00:03:32 -06:00
exit 1
elif [ " $1 " = "empty" ] ; then
2020-08-13 23:53:51 -06:00
printf "\n%sError: '%s' cannot have a NULL (empty) value.\n" " $err " " $2 "
printf "%sPlease use '--help' for assistance%s\n\n" " $cyan " " $norm "
2019-07-25 00:03:32 -06:00
exit 1
elif [ " $1 " = "svc" ] ; then
2020-08-13 23:53:51 -06:00
printf " \n%sError: '%s %s': Service does not exist! ${ norm } \n\n " \
" $err " " $2 " " $3 "
2019-07-25 12:30:11 -06:00
exit 1
elif [ " $1 " = "user" ] ; then
2020-08-13 23:53:51 -06:00
printf " \n%sError: '%s %s': User does not exist! ${ norm } \n\n " \
" $err " " $2 " " $3 "
2019-07-25 12:30:11 -06:00
exit 1
2019-07-25 00:03:32 -06:00
fi
}
# cleanup
cleanup ( ) {
# cleanup 503 if copied
if [ " $err503Copied " -eq 1 ] ; then
if ! rm -f " $webroot / $err503File " 2>>" $logFile " ; then
2020-08-14 00:00:09 -06:00
printf "%s[%s] -- [WARNING] Could not remove 503 error page." \
" $warn " " $( stamp) " >> " $logFile "
2019-07-25 00:03:32 -06:00
printf " Web interface will not function until this file is " \
>> " $logFile "
2020-08-14 00:00:09 -06:00
printf "removed --%s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
warnCount = $(( warnCount+1))
else
2020-08-14 00:00:09 -06:00
printf "%s[%s] -- [INFO] 503 error page removed --%s\n" \
" $cyan " " $( stamp) " " $norm " >> " $logFile "
2020-08-13 23:48:52 -06:00
fi
2019-07-25 00:03:32 -06:00
fi
2019-07-25 00:26:42 -06:00
# remove EML temporary directory
2019-07-25 12:16:09 -06:00
if ! rm -rf " $exportDir " 2>>" $logFile " ; then
2020-08-14 00:00:09 -06:00
printf "%s[%s] -- [WARNING] Could not remove EML export tmp dir:" \
" $warn " " $( stamp) " >> " $logFile "
2019-07-25 00:26:42 -06:00
printf "\n%s\n" " $exportDir " >> " $logFile "
2020-08-14 00:00:09 -06:00
printf "please remove this directory manually! --%s\n" " $norm " \
2019-07-25 00:26:42 -06:00
>> " $logFile "
warnCount = $(( warnCount+1))
else
2020-08-14 00:00:09 -06:00
printf "%s[%s] -- [INFO] EML temp directory removed --%s\n" \
" $cyan " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:26:42 -06:00
fi
2019-07-25 00:03:32 -06:00
}
# call cleanup and then exit with error report
exitError ( ) {
2020-08-14 00:00:09 -06:00
printf "%s[%s] -- [ERROR] %s: %s --%s\n" \
" $err " " $( stamp) " " $1 " " $2 " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
cleanup
# note script completion with error
2020-08-14 00:00:09 -06:00
printf "%s[%s] --- %s execution completed with error ---%s\n" \
" $err " " $( stamp) " " $scriptName " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
exit " $1 "
}
# display script help information
scriptHelp ( ) {
2020-08-14 00:20:49 -06:00
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
2019-07-25 00:03:32 -06:00
}
# generate dynamic timestamps
stamp ( ) {
( date +%F" " %T)
}
2020-08-14 00:02:36 -06:00
textblock( ) {
printf "%s\n" " $1 " | fold -w " $width " -s
}
2020-08-14 00:10:48 -06:00
defaultsTextblock( ) {
2020-08-14 00:02:36 -06:00
printf "%s%s%s\n" " $yellow " " $1 " " $norm "
}
2020-08-14 00:10:48 -06:00
switchTextblock( ) {
printf "%s%s%s\n" " $cyan " " $1 " " $norm "
}
2020-08-14 00:02:36 -06:00
newline( ) {
printf "\n"
}
2019-07-25 00:03:32 -06:00
# same as exitError but for signal captures
trapExit ( ) {
2020-08-14 00:03:32 -06:00
printf "%s[%s] -- [ERROR] 99: Caught signal --%s\n" \
" $err " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
cleanup
# note script completion with error
2020-08-14 00:03:32 -06:00
printf "%s[%s] --- %s execution was terminated via signal ---%s\n" \
" $err " " $( stamp) " " $scriptName " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
exit 99
}
### end of functions
### default variable values
## script related
# store logfile in the same directory as this script file using the same file
# name as the script but with the extension '.log'
scriptPath = " $( CDPATH = '' cd -- " $( dirname -- " $0 " ) " && pwd -P ) "
scriptName = " $( basename " $0 " ) "
logFile = " $scriptPath / ${ scriptName %.* } .log "
warnCount = 0
configDetails = " $scriptPath / ${ scriptName %.* } .details "
err503Copied = 0
includeXtra = 0
exclusions = 0
# borg output verbosity -- normal
borgCreateParams = '--stats'
borgPruneParams = '--list'
# 503 related
use503 = 0
err503Path = " $scriptPath /503_backup.html "
err503File = " ${ err503Path ##*/ } "
webroot = "/usr/share/nginx/html"
2019-07-25 00:41:23 -06:00
# piler-export related
exportAll = 0
2019-07-25 12:11:38 -06:00
exportStart = $( date -d 'yesterday' +'%Y.%m.%d' )
exportEnd = $( date -d 'yesterday' +'%Y.%m.%d' )
2019-07-25 12:30:11 -06:00
pilerUser = 'piler'
2019-07-25 00:41:23 -06:00
2019-07-25 00:03:32 -06:00
### process startup parameters
while [ $# -gt 0 ] ; do
case " $1 " in
-h| -\? | --help)
# display help
scriptHelp
exit 0
; ;
-l| --log)
# set log file location
if [ -n " $2 " ] ; then
logFile = " ${ 2 %/ } "
shift
else
badParam empty " $@ "
fi
; ;
-v| --verbose)
# set verbose logging from borg
borgCreateParams = '--list --stats'
borgPruneParams = '--list'
; ;
-c| --config| --details)
# location of config details file
if [ -n " $2 " ] ; then
if [ -f " $2 " ] ; then
configDetails = " ${ 2 %/ } "
shift
else
badParam dne " $@ "
fi
else
badParam empty " $@ "
fi
; ;
-5| --use-503)
# enable copying 503 error page to webroot
use503 = 1
; ;
--503-path)
# FULL path to 503 file
if [ -n " $2 " ] ; then
if [ -f " $2 " ] ; then
err503Path = " ${ 2 %/ } "
err503File = " ${ 2 ##*/ } "
shift
else
badParam dne " $@ "
fi
else
badParam empty " $@ "
fi
; ;
-w| --webroot)
# path to webroot (copy 503)
if [ -n " $2 " ] ; then
if [ -d " $2 " ] ; then
webroot = " ${ 2 %/ } "
shift
else
badParam dne " $@ "
fi
else
badParam empty " $@ "
fi
; ;
2019-07-25 00:41:23 -06:00
-a| --all)
# export ALL email stored in piler
exportAll = 1
; ;
--start)
# export starting at this date
if [ -n " $2 " ] ; then
exportStart = " $2 "
shift
else
badParam empty " $@ "
fi
; ;
--end)
# export ending at this date
if [ -n " $2 " ] ; then
exportEnd = " $2 "
shift
else
badParam empty " $@ "
fi
; ;
2019-07-25 12:30:11 -06:00
--user)
# specify piler user account name
if [ -n " $2 " ] ; then
if id ${ pilerUser } > /dev/null 2>& 1; then
pilerUser = " $2 "
shift
else
badParam user " $@ "
fi
else
badParam empty " $@ "
fi
; ;
2019-07-25 00:03:32 -06:00
*)
2020-08-14 00:39:23 -06:00
printf "%s\nUnknown option: %s\n" " $err " " $1 "
printf "%sUse '--help' for valid options.%s\n\n" " $cyan " " $norm "
2019-07-25 00:03:32 -06:00
exit 1
; ;
esac
shift
done
### check pre-requisites and default values
2019-07-26 02:33:57 -06:00
# check if running as root, otherwise exit
if [ $( id -u ) -ne 0 ] ; then
2020-08-14 00:39:23 -06:00
printf "\n%sERROR: script MUST be run as ROOT%s\n\n" " $err " " $norm "
2019-07-26 02:33:57 -06:00
exit 2
fi
2019-07-26 02:29:05 -06:00
# find pilerexport, otherwise this is all pointless
pilerExport = $( command -v pilerexport )
if [ ! " $pilerExport " ] ; then
2020-08-14 00:39:23 -06:00
printf "\n%sERROR: cannot find 'pilerexport'%s\n\n" " $err " " $norm "
2019-07-26 02:29:05 -06:00
exit 4
fi
2019-07-25 00:03:32 -06:00
# does the details file exist?
if [ ! -f " $configDetails " ] ; then
badParam dne "(--details default)" " $configDetails "
fi
# is borg installed?
if ! command -v borg > /dev/null; then
2020-08-14 00:39:23 -06:00
printf "\n%sERROR: BORG is not installed on this system!%s\n\n" " $err " " $norm "
2019-07-25 00:03:32 -06:00
exit 3
fi
# if 503 functionality is enabled, do 503 related files exist?
if [ " $use503 " -eq 1 ] ; then
if [ ! -f " $err503Path " ] ; then
badParam dne "(--503-path default)" " $err503Path "
elif [ ! -d " $webroot " ] ; then
badParam dne "(--webroot default)" " $webroot "
fi
fi
### start logging
2020-08-14 00:39:23 -06:00
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 "
2019-07-25 00:03:32 -06:00
### 503 functionality
if [ " $use503 " -eq 1 ] ; then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] Copying 503 error page to " \
" $cyan " " $( stamp) " >> " $logFile "
printf "webroot -- %s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
if ! \c p --force " ${ err503Path } " " ${ webroot } / ${ err503File } " 2>> " $logFile "
then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [WARNING] Failed to copy 503 error page. " \
" $warn " " $( stamp) " >> " $logFile "
printf "Web users will NOT be notified --%s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
warnCount = $(( warnCount+1))
else
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] 503 error page copied --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
# set cleanup flag
err503Copied = 1
fi
fi
### read details file to get variables needed to dump sql and run borg
# check if config details file was provided as a relative or absolute path
case " ${ configDetails } " in
/*)
# absolute path, no need to rewrite variable
. " ${ configDetails } "
; ;
*)
# relative path, prepend './' to create absolute path
. " ./ ${ configDetails } "
; ;
esac
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] %s%s%s imported --%s\n" \
" $cyan " " $( stamp) " " $yellow " " $configDetails " " $cyan " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
2019-07-25 00:26:42 -06:00
## create tmp directory and change to it for export operations
2019-07-25 12:46:31 -06:00
# create temporary directory to dump exported email from piler
2019-07-25 00:26:42 -06:00
if ! exportDir = $( mktemp -d 2>>" $logFile " ) ; then
exitError 111 "Could not create temporary directory for exported EML files"
2019-07-25 00:03:32 -06:00
fi
2019-07-25 12:42:20 -06:00
# grant pilerUser permission to write to temporary directory
2019-07-25 13:06:49 -06:00
if ! ( chown root:${ pilerUser } " $exportDir " && chmod 770 " $exportDir " ) ; then
2019-07-25 12:42:20 -06:00
exitError 112 "Could not set permissions on temporary directory"
fi
2019-07-25 00:26:42 -06:00
if ! cd " $exportDir " ; then
2019-07-25 12:42:02 -06:00
exitError 113 "Unable to change to temporary export directory"
2019-07-25 00:03:32 -06:00
fi
2020-08-14 00:39:23 -06:00
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 "
2019-07-25 00:26:42 -06:00
## export EML from piler
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] Exporting EML files from piler --%s\n" \
" $cyan " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:26:42 -06:00
if [ " $exportAll " -eq 1 ] ; then
2019-07-26 02:29:05 -06:00
if ! ${ pilerExport } -A 2>>" $logFile " ; then
2019-07-25 00:26:42 -06:00
exitError 115 "There was a problem while exporting EML from piler"
fi
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] Exported EML files from piler --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:26:42 -06:00
else
2019-07-26 02:29:05 -06:00
if ! ${ pilerExport } -a " $exportStart " -b " $exportEnd " 2>>" $logFile " ; then
2019-07-25 00:26:42 -06:00
exitError 115 "There was a problem while exporting EML from piler"
fi
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] Exported EML files from piler --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:26:42 -06:00
fi
2019-07-25 00:03:32 -06:00
### pre-backup tasks completed -- move to borg tasks
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] Pre-backup tasks completed --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
### Run borg variable checks
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] Verifying supplied borg details --%s\n" \
" $cyan " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
## verify borg base directory
if [ -z " ${ borgBaseDir } " ] ; then
badDetails empty 'borgBaseDir'
elif [ ! -d " ${ borgBaseDir } " ] ; then
badDetails dne 'borgBaseDir'
fi
2020-08-14 00:39:23 -06:00
printf "%sdetails:borgBaseDir%s -- %s[OK]%s\n" \
" $magenta " " $norm " " $ok " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
export BORG_BASE_DIR = " ${ borgBaseDir %/ } "
## check path to SSH keyfile
if [ -z " ${ borgSSHKey } " ] ; then
badDetails empty 'borgSSHKey'
elif [ ! -f " ${ borgSSHKey } " ] ; then
badDetails dne 'borgSSHKey'
fi
2020-08-14 00:39:23 -06:00
printf "%sdetails:borgSSHKey%s -- %s[OK]%s\n" \
" $magenta " " $norm " " $ok " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
export BORG_RSH = " ssh -i ${ borgSSHKey } "
## check borg repo connect string
if [ -z " ${ borgConnectRepo } " ] ; then
badDetails empty 'borgConnectRepo'
fi
2020-08-14 00:39:23 -06:00
printf "%sdetails:borgConnectRepo%s -- %s[OK]%s\n" \
" $magenta " " $norm " " $ok " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
export BORG_REPO = " ${ borgConnectRepo } "
## check borg repo password
if [ -n " ${ borgRepoPassphrase } " ] ; then
2020-08-14 00:39:23 -06:00
printf "%sdetails:borgRepoPassphrase%s -- %s[OK]%s\n" \
" $magenta " " $norm " " $ok " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
export BORG_PASSPHRASE = " ${ borgRepoPassphrase } "
else
# if passwd is blank intentionally, this is insecure
2020-08-14 00:39:23 -06:00
printf "%s-- [WARNING] Using a borg repo without a password is an " \
" $warn " >> " $logFile "
printf "insecure configuration --%s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
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
export BORG_PASSPHRASE = "DummyPasswordSoBorgFails"
fi
2020-08-14 00:42:00 -06:00
## check borg repository keyfile location
if [ -z " ${ borgKeyfileLocation } " ] ; then
printf "%sdetails:borgKeyfileLocation %s-- %s[DEFAULT]%s\n" " $magenta " " $norm " " $ok " " $norm " >> " $logFile "
else
# check if keyfile location exists
if [ ! -f " ${ borgKeyfileLocation } " ] ; then
badDetails dne 'borgKeyfileLocation'
fi
printf "%sdetails:borgKeyfileLocation %s-- %s[OK]%s\n" " $magenta " " $norm " " $ok " " $norm " >> " $logFile "
export BORG_KEY_FILE = " ${ borgKeyfileLocation } "
fi
2019-07-25 00:03:32 -06:00
## export borg remote path, if specified
if [ -n " ${ borgRemote } " ] ; then export BORG_REMOTE_PATH = " ${ borgRemote } " ; fi
## read additional files
if [ -n " ${ borgXtraListPath } " ] ; then
# check if file actually exists
if [ ! -f " ${ borgXtraListPath } " ] ; then
badDetails dne 'borgXtraListPath'
fi
# read file contents into concatenated list for echo to cmdline
while read -r xtraItem; do
if [ -z " ${ xtraList } " ] ; then
xtraList = " ${ xtraItem } "
else
xtraList = " ${ xtraList } ${ xtraItem } "
fi
done <<EOF
$( sed -e '/^\s*#.*$/d' -e '/^\s*$/d' " ${ borgXtraListPath } " )
EOF
2020-08-14 00:39:23 -06:00
printf "%sdetails:borgXtraListPath%s -- %s[OK]%s\n" \
" $magenta " " $norm " " $ok " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
includeXtra = 1
fi
## check if exlusion list file is specified
if [ -n " ${ borgExcludeListPath } " ] ; then
# check if the file actually exists
if [ ! -f " ${ borgExcludeListPath } " ] ; then
badDetails dne 'borgExcludeListPath'
fi
exclusions = 1
fi
### create borg temp dir:
## python requires a writable temporary directory when unpacking borg and
## executing commands. This defaults to /tmp but many systems mount /tmp with
## the 'noexec' option for security. Thus, we will use/create a 'tmp' folder
## within the BORG_BASE_DIR and instruct python to use that instead of /tmp
# check if BORG_BASE_DIR/tmp exists, if not, create it
if [ ! -d " ${ borgBaseDir } /tmp " ] ; then
if ! mkdir " ${ borgBaseDir } /tmp " ; then
exitError 132 " Unable to create borg ${ borgBaseDir } /tmp directory "
else
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] Created %s%s/tmp " \
" $cyan " " $( stamp) " " $yellow " " ${ borgBaseDir } " >> " $logFile "
printf "%s--%s\n" " $cyan " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
fi
fi
export TMPDIR = " ${ borgBaseDir } /tmp "
### execute borg depending on whether extra files and/or exclusions are defined
## construct the proper borg commandline
# base command
if [ " $exclusions " -eq 0 ] ; then
borgCMD = " borg --show-rc create ${ borgCreateParams } \
::$( date +%Y-%m-%d_%H%M%S) \
2019-07-25 00:56:49 -06:00
${ exportDir } "
2019-07-25 00:03:32 -06:00
elif [ " $exclusions " -eq 1 ] ; then
borgCMD = " borg --show-rc create ${ borgCreateParams } \
--exclude-from ${ borgExcludeListPath } \
::$( date +%Y-%m-%d_%H%M%S) \
2019-07-25 00:56:49 -06:00
${ exportDir } "
2019-07-25 00:03:32 -06:00
fi
# add extra locations if defined
if [ " $includeXtra " -eq 1 ] ; then
borgCMD = " ${ borgCMD } ${ xtraList } "
fi
# execute borg
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] Executing borg backup operation --%s\n" \
" $cyan " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
${ borgCMD } 2>> " $logFile "
borgResult = " $? "
## check borg exit status
if [ " $borgResult " -eq 0 ] ; then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] Borg backup completed --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
elif [ " $borgResult " -eq 1 ] ; then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [WARNING] Borg completed with warnings. " \
" $warn " " $( stamp) " >> " $logFile "
printf "Review this logfile for details --%s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
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
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [WARNING] Borg exited with unknown return code. " \
" $warn " " $( stamp) " >> " $logFile "
printf "Review this logfile for details --%s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
warnCount = $(( warnCount+1))
fi
### execute borg prune if paramters are provided, otherwise skip with a warning
if [ -n " ${ borgPruneSettings } " ] ; then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [INFO] Executing borg prune operation --%s\n" \
" $cyan " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
borg prune --show-rc -v ${ borgPruneParams } ${ borgPruneSettings } \
2>> " $logFile "
borgPruneResult = " $? "
else
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [WARNING] No prune parameters provided. " \
" $warn " " $( stamp) " >> " $logFile "
printf "Your archive will continue growing with each backup --%s\n" \
" $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
warnCount = $(( warnCount+1))
fi
## report on prune operation if executed
if [ -n " ${ borgPruneResult } " ] ; then
if [ " ${ borgPruneResult } " -eq 0 ] ; then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] Borg prune completed --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
elif [ " $borgPruneResult " -eq 1 ] ; then
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [WARNING] Borg prune completed with warnings. " \
" $warn " " $( stamp) " >> " $logFile "
printf "Review this logfile for details --%s\n" " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
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
2020-08-14 00:39:23 -06:00
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 "
2019-07-25 00:03:32 -06:00
warnCount = $(( warnCount+1))
fi
fi
### all processes successfully completed, cleanup and exit gracefully
# note successful completion of borg commands
2020-08-14 00:39:23 -06:00
printf "%s[%s] -- [SUCCESS] Backup operations completed --%s\n" \
" $ok " " $( stamp) " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
# cleanup
cleanup
# note complete success, tally warnings and exit
2020-08-14 00:39:23 -06:00
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 "
2019-07-25 00:03:32 -06:00
if [ " $warnCount " -gt 0 ] ; then
2020-08-14 00:39:23 -06:00
printf "%s%s warnings issued!%s\n" " $warn " " ${ warnCount } " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
else
2020-08-14 00:39:23 -06:00
printf "%s0 warnings issued.%s\n" " $ok " " $norm " >> " $logFile "
2019-07-25 00:03:32 -06:00
fi
exit 0
### error codes
# 1: parameter error
# 2: not run as root
# 3: borg not installed
2019-07-26 02:29:05 -06:00
# 4: cannot find pilerexport executable
2019-07-25 00:03:32 -06:00
# 99: TERM signal trapped
# 111: could not create tmp dir for EML dump from piler-export
2019-07-25 12:42:02 -06:00
# 112: could not set permissions on tmp dir
# 113: could not change to tmp dir to start export operation
2019-07-25 00:26:42 -06:00
# 115: problem during piler-export operation
2019-07-25 00:03:32 -06:00
# 130: null configuration variable in details file
# 131: invalid configuration variable in details file
# 138: borg exited with a critical error
# 139: borg prune exited with a critical error