2015-11-12 01:26:38 +01:00
#!/usr/bin/env bash
2013-07-16 23:10:27 +02:00
2017-01-04 09:00:47 +01:00
#TODO: do we rotate encrypted files too or only temp files in storage dir (pull / local question)
2016-09-08 22:51:24 +02:00
2015-11-12 01:26:38 +01:00
###### Remote push/pull (or local) backup script for files & databases
PROGRAM = "obackup"
2019-01-03 10:10:08 +01:00
AUTHOR = "(C) 2013-2019 by Orsiris de Jong"
2015-01-08 20:05:58 +01:00
CONTACT = "http://www.netpower.fr/obackup - ozy@netpower.fr"
2019-05-21 12:16:08 +02:00
PROGRAM_VERSION = 2.1-dev-postRC1
2020-05-03 10:08:02 +02:00
PROGRAM_BUILD = 2020050302
2019-02-26 12:09:50 +01:00
IS_STABLE = true
2015-11-12 01:26:38 +01:00
2019-05-21 12:16:08 +02:00
CONFIG_FILE_REVISION_REQUIRED = 2.1
2016-08-06 16:16:19 +02:00
2020-03-15 22:58:12 +01:00
_OFUNCTIONS_VERSION = 2.3.0-RC4
2020-05-03 10:08:02 +02:00
_OFUNCTIONS_BUILD = 2020050301
2017-01-04 09:00:47 +01:00
_OFUNCTIONS_BOOTSTRAP = true
2015-11-19 23:04:02 +01:00
if ! type " $BASH " > /dev/null; then
echo "Please run this script only with bash shell. Tested on bash >= 3.2"
exit 127
fi
2016-03-18 19:20:28 +01:00
## Correct output of sort command (language agnostic sorting)
export LC_ALL = C
2017-06-09 09:58:51 +02:00
## Default umask for file creation
umask 0077
2016-03-18 19:20:28 +01:00
# Standard alert mail body
MAIL_ALERT_MSG = " Execution of $PROGRAM instance $INSTANCE_ID on $( date) has warnings/errors. "
2016-08-06 16:16:19 +02:00
# Environment variables that can be overriden by programs
2016-08-31 11:26:21 +02:00
_DRYRUN = false
2016-11-17 21:02:15 +01:00
_LOGGER_SILENT = false
_LOGGER_VERBOSE = false
_LOGGER_ERR_ONLY = false
2016-08-06 16:16:19 +02:00
_LOGGER_PREFIX = "date"
2016-08-16 22:54:52 +02:00
if [ " $KEEP_LOGGING " = = "" ] ; then
2017-01-04 09:00:47 +01:00
KEEP_LOGGING = 1801
2016-08-16 22:40:02 +02:00
fi
2015-11-19 23:04:02 +01:00
# Initial error status, logging 'WARN', 'ERROR' or 'CRITICAL' will enable alerts flags
2016-08-31 11:26:21 +02:00
ERROR_ALERT = false
WARN_ALERT = false
2015-11-19 23:04:02 +01:00
2019-02-26 12:09:50 +01:00
## allow debugging from command line with _DEBUG=true
if [ ! " $_DEBUG " = = true ] ; then
_DEBUG = false
2016-11-17 21:02:15 +01:00
_LOGGER_VERBOSE = false
2015-11-19 23:04:02 +01:00
else
trap 'TrapError ${LINENO} $?' ERR
2016-11-17 21:02:15 +01:00
_LOGGER_VERBOSE = true
2015-11-19 23:04:02 +01:00
fi
2016-11-30 14:04:41 +01:00
if [ " $SLEEP_TIME " = = "" ] ; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
SLEEP_TIME = .05
fi
2020-03-15 22:58:12 +01:00
# The variables SCRIPT_PID and TSTAMP needs to be declared as soon as the program begins. The function PoorMansRandomGenerator is needed for TSTAMP (since some systems date function does not give nanoseconds)
2015-11-19 23:04:02 +01:00
SCRIPT_PID = $$
2017-06-09 09:58:51 +02:00
2020-03-15 22:58:12 +01:00
# Get a random number of digits length on Windows BusyBox alike, also works on most Unixes that have dd
function PoorMansRandomGenerator {
local digits = " ${ 1 } " # The number of digits to generate
local number
# Some read bytes can't be used, se we read twice the number of required bytes
dd if = /dev/urandom bs = $digits count = 2 2> /dev/null | while read -r -n1 char; do
number = $number $( printf "%d" " ' $char " )
if [ ${# number } -ge $digits ] ; then
echo ${ number : 0 : $digits }
break;
fi
done
}
# Initial TSTMAP value before function declaration
TSTAMP = $( date '+%Y%m%dT%H%M%S' ) .$( PoorMansRandomGenerator 5)
2015-11-19 23:04:02 +01:00
LOCAL_USER = $( whoami)
LOCAL_HOST = $( hostname)
2016-08-31 11:26:21 +02:00
if [ " $PROGRAM " = = "" ] ; then
PROGRAM = "ofunctions"
fi
2015-11-19 23:04:02 +01:00
## Default log file until config file is loaded
if [ -w /var/log ] ; then
LOG_FILE = " /var/log/ $PROGRAM .log "
2016-04-06 20:40:20 +02:00
elif ( [ " $HOME " != "" ] && [ -w " $HOME " ] ) ; then
LOG_FILE = " $HOME / $PROGRAM .log "
2017-01-04 09:00:47 +01:00
elif [ -w . ] ; then
2015-11-19 23:04:02 +01:00
LOG_FILE = " ./ $PROGRAM .log "
2017-01-04 09:00:47 +01:00
else
LOG_FILE = " /tmp/ $PROGRAM .log "
2015-11-19 23:04:02 +01:00
fi
## Default directory where to store temporary run files
2018-11-06 15:33:16 +01:00
2015-11-19 23:04:02 +01:00
if [ -w /tmp ] ; then
RUN_DIR = /tmp
elif [ -w /var/tmp ] ; then
RUN_DIR = /var/tmp
else
RUN_DIR = .
fi
2018-11-06 15:33:16 +01:00
## Special note when remote target is on the same host as initiator (happens for unit tests): we'll have to differentiate RUN_DIR so remote CleanUp won't affect initiator.
2020-03-15 22:58:12 +01:00
## If the same program gets remotely executed, add _REMOTE_EXECUTION=true to it's environment so it knows it has to write into a separate directory
## This will thus not affect local $RUN_DIR variables
2018-11-06 15:33:16 +01:00
if [ " $_REMOTE_EXECUTION " = = true ] ; then
2020-03-15 22:58:12 +01:00
mkdir -p " $RUN_DIR / $PROGRAM .remote. $SCRIPT_PID . $TSTAMP "
RUN_DIR = " $RUN_DIR / $PROGRAM .remote. $SCRIPT_PID . $TSTAMP "
2018-11-06 15:33:16 +01:00
fi
2015-11-19 23:04:02 +01:00
# Default alert attachment filename
2017-01-04 09:00:47 +01:00
ALERT_LOG_FILE = " $RUN_DIR / $PROGRAM . $SCRIPT_PID . $TSTAMP .last.log "
2015-11-19 23:04:02 +01:00
# Set error exit code if a piped command fails
2018-01-03 22:32:19 +01:00
set -o pipefail
set -o errtrace
2015-11-19 23:04:02 +01:00
2017-01-04 09:00:47 +01:00
# Array to string converter, see http://stackoverflow.com/questions/1527049/bash-join-elements-of-an-array
# usage: joinString separaratorChar Array
function joinString {
local IFS = " $1 " ; shift; echo " $* " ;
}
2016-05-26 11:11:43 +02:00
# Sub function of Logger
2015-11-19 23:04:02 +01:00
function _Logger {
2016-11-17 21:02:15 +01:00
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-03-14 22:31:15 +01:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2016-08-06 16:16:19 +02:00
2017-01-04 09:00:47 +01:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-07-30 15:36:53 +02:00
# Build current log file for alerts if we have a sufficient environment
2019-05-21 11:46:07 +02:00
if [ " $RUN_DIR / $PROGRAM " != "/" ] ; then
2020-03-15 22:58:12 +01:00
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP "
2018-07-30 15:36:53 +02:00
fi
2017-01-04 09:00:47 +01:00
fi
2015-11-19 23:04:02 +01:00
2016-11-17 21:02:15 +01:00
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-03-14 22:31:15 +01:00
if [ $toStdErr = = true ] ; then
2016-11-17 21:02:15 +01:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
else
echo -e " $stdValue "
fi
2015-11-19 23:04:02 +01:00
fi
}
2017-01-04 09:00:47 +01:00
# Remote logger similar to below Logger, without log to file and alert flags
function RemoteLogger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2018-11-06 15:33:16 +01:00
local prefix
2017-01-04 09:00:47 +01:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2020-03-15 22:58:12 +01:00
prefix = " RTIME: $SECONDS - "
2017-01-04 09:00:47 +01:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
prefix = " R $( date) - "
else
prefix = ""
fi
if [ " $level " = = "CRITICAL" ] ; then
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "WARN" ] ; then
_Logger "" " $prefix \e[33m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "NOTICE" ] ; then
if [ $_LOGGER_ERR_ONLY != true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "ALWAYS" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix $value "
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix $value "
return
fi
else
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
fi
}
2016-08-31 11:26:21 +02:00
# General log function with log levels:
2016-11-17 21:02:15 +01:00
# Environment variables
# _LOGGER_SILENT: Disables any output to stdout & stderr
2017-01-04 09:00:47 +01:00
# _LOGGER_ERR_ONLY: Disables any output to stdout except for ALWAYS loglevel
2016-11-17 21:02:15 +01:00
# _LOGGER_VERBOSE: Allows VERBOSE loglevel messages to be sent to stdout
# Loglevels
# Except for VERBOSE, all loglevels are ALWAYS sent to log file
# CRITICAL, ERROR, WARN sent to stderr, color depending on level, level also logged
# NOTICE sent to stdout
2019-02-26 12:09:50 +01:00
# VERBOSE sent to stdout if _LOGGER_VERBOSE=true
# ALWAYS is sent to stdout unless _LOGGER_SILENT=true
# DEBUG & PARANOIA_DEBUG are only sent to stdout if _DEBUG=true
2015-11-19 23:04:02 +01:00
function Logger {
2017-01-04 09:00:47 +01:00
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2015-11-19 23:04:02 +01:00
2018-11-06 15:33:16 +01:00
local prefix
2016-08-06 16:16:19 +02:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
prefix = " TIME: $SECONDS - "
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
2018-09-30 13:56:00 +02:00
prefix = " $( date '+%Y-%m-%d %H:%M:%S' ) - "
2015-11-19 23:04:02 +01:00
else
2016-08-06 16:16:19 +02:00
prefix = ""
2015-11-19 23:04:02 +01:00
fi
2017-03-14 22:31:15 +01:00
## Obfuscate _REMOTE_TOKEN in logs (for ssh_filter usage only in osync and obackup)
2020-05-03 10:08:02 +02:00
value = " ${ value /env _REMOTE_TOKEN= $_REMOTE_TOKEN /env _REMOTE_TOKEN=__o_O__ } "
value = " ${ value /env _REMOTE_TOKEN= \$ _REMOTE_TOKEN /env _REMOTE_TOKEN=__o_O__ } "
2017-03-14 22:31:15 +01:00
2015-11-19 23:04:02 +01:00
if [ " $level " = = "CRITICAL" ] ; then
2017-01-04 09:00:47 +01:00
_Logger " $prefix ( $level ): $value " " $prefix \e[1;33;41m $value \e[0m " true
2016-08-31 11:26:21 +02:00
ERROR_ALERT = true
2018-01-03 22:32:19 +01:00
# ERROR_ALERT / WARN_ALERT is not set in main when Logger is called from a subprocess. Need to keep this flag.
2017-01-04 09:00:47 +01:00
echo -e " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ \n $prefix ( $level ): $value " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2015-11-19 23:04:02 +01:00
return
elif [ " $level " = = "ERROR" ] ; then
2016-11-17 21:02:15 +01:00
_Logger " $prefix ( $level ): $value " " $prefix \e[91m $value \e[0m " true
2016-08-31 11:26:21 +02:00
ERROR_ALERT = true
2017-01-04 09:00:47 +01:00
echo -e " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ \n $prefix ( $level ): $value " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2015-11-19 23:04:02 +01:00
return
elif [ " $level " = = "WARN" ] ; then
2016-11-17 21:02:15 +01:00
_Logger " $prefix ( $level ): $value " " $prefix \e[33m $value \e[0m " true
2016-08-31 11:26:21 +02:00
WARN_ALERT = true
2017-01-04 09:00:47 +01:00
echo -e " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ \n $prefix ( $level ): $value " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .warn. $SCRIPT_PID . $TSTAMP "
2015-11-19 23:04:02 +01:00
return
elif [ " $level " = = "NOTICE" ] ; then
2016-11-17 21:02:15 +01:00
if [ " $_LOGGER_ERR_ONLY " != true ] ; then
_Logger " $prefix $value " " $prefix $value "
fi
2015-11-19 23:04:02 +01:00
return
2016-08-31 11:26:21 +02:00
elif [ " $level " = = "VERBOSE" ] ; then
2016-11-17 21:02:15 +01:00
if [ $_LOGGER_VERBOSE = = true ] ; then
2017-06-09 09:58:51 +02:00
_Logger " $prefix ( $level ): $value " " $prefix $value "
2016-08-31 11:26:21 +02:00
fi
return
2016-11-17 21:02:15 +01:00
elif [ " $level " = = "ALWAYS" ] ; then
2017-01-04 09:00:47 +01:00
_Logger " $prefix $value " " $prefix $value "
2016-11-17 21:02:15 +01:00
return
2015-11-19 23:04:02 +01:00
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2016-11-17 21:02:15 +01:00
_Logger " $prefix $value " " $prefix $value "
2015-11-19 23:04:02 +01:00
return
fi
else
2017-01-04 09:00:47 +01:00
_Logger " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger " Value was: $prefix $value " " Value was: $prefix $value " true
2015-11-19 23:04:02 +01:00
fi
}
2016-05-26 11:11:43 +02:00
2018-11-06 15:33:16 +01:00
# Function is busybox compatible since busybox ash does not understand direct regex, we use expr
function IsInteger {
local value = " ${ 1 } "
if type expr > /dev/null 2>& 1; then
expr " $value " : '^[0-9]\{1,\}$' > /dev/null 2>& 1
if [ $? -eq 0 ] ; then
echo 1
else
echo 0
fi
else
if [ [ $value = ~ ^[ 0-9] +$ ] ] ; then
echo 1
else
echo 0
fi
fi
}
2015-11-19 23:04:02 +01:00
# Portable child (and grandchild) kill function tester under Linux, BSD and MacOS X
function KillChilds {
2016-08-16 22:40:02 +02:00
local pid = " ${ 1 } " # Parent pid to kill childs
local self = " ${ 2 :- false } " # Should parent be killed too ?
2015-11-19 23:04:02 +01:00
2018-01-03 22:32:19 +01:00
# Paranoid checks, we can safely assume that $pid should not be 0 nor 1
if [ $( IsInteger " $pid " ) -eq 0 ] || [ " $pid " = = "" ] || [ " $pid " = = "0" ] || [ " $pid " = = "1" ] ; then
2017-06-09 09:58:51 +02:00
Logger " Bogus pid given [ $pid ]. " "CRITICAL"
return 1
fi
if kill -0 " $pid " > /dev/null 2>& 1; then
if children = " $( pgrep -P " $pid " ) " ; then
if [ [ " $pid " = = *" $children " * ] ] ; then
Logger "Bogus pgrep implementation." "CRITICAL"
children = " ${ children / $pid / } "
fi
for child in $children ; do
KillChilds " $child " true
done
fi
2015-11-19 23:04:02 +01:00
fi
2017-06-09 09:58:51 +02:00
# Try to kill nicely, if not, wait 15 seconds to let Trap actions happen before killing
2016-11-30 14:04:41 +01:00
if [ " $self " = = true ] ; then
2017-06-09 09:58:51 +02:00
# We need to check for pid again because it may have disappeared after recursive function call
2016-11-30 14:04:41 +01:00
if kill -0 " $pid " > /dev/null 2>& 1; then
kill -s TERM " $pid "
Logger " Sent SIGTERM to process [ $pid ]. " "DEBUG"
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-30 14:04:41 +01:00
sleep 15
Logger " Sending SIGTERM to process [ $pid ] failed. " "DEBUG"
kill -9 " $pid "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-30 14:04:41 +01:00
Logger " Sending SIGKILL to process [ $pid ] failed. " "DEBUG"
return 1
fi # Simplify the return 0 logic here
else
return 0
2016-04-12 09:14:44 +02:00
fi
2016-08-06 16:16:19 +02:00
else
return 0
2016-03-31 14:28:18 +02:00
fi
2016-04-12 09:41:16 +02:00
else
return 0
2015-11-19 23:04:02 +01:00
fi
}
2016-08-06 16:16:19 +02:00
function KillAllChilds {
local pids = " ${ 1 } " # List of parent pids to kill separated by semi-colon
2016-08-16 22:54:52 +02:00
local self = " ${ 2 :- false } " # Should parent be killed too ?
2016-08-06 16:16:19 +02:00
local errorcount = 0
IFS = ';' read -a pidsArray <<< " $pids "
for pid in " ${ pidsArray [@] } " ; do
2016-08-16 22:54:52 +02:00
KillChilds $pid $self
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-08-06 16:16:19 +02:00
errorcount = $(( errorcount+1))
fi
done
return $errorcount
}
2018-11-06 15:33:16 +01:00
function GenericTrapQuit {
local exitcode = 0
# Get ERROR / WARN alert flags from subprocesses that call Logger
if [ -f " $RUN_DIR / $PROGRAM .Logger.warn. $SCRIPT_PID . $TSTAMP " ] ; then
WARN_ALERT = true
exitcode = 2
fi
if [ -f " $RUN_DIR / $PROGRAM .Logger.error. $SCRIPT_PID . $TSTAMP " ] ; then
ERROR_ALERT = true
exitcode = 1
fi
CleanUp
exit $exitcode
}
2020-05-03 10:08:02 +02:00
#### TrapQuit SUBSET END ####
2018-11-06 15:33:16 +01:00
2020-03-15 22:58:12 +01:00
function CleanUp {
# Exit controlmaster before it's socket gets deleted
if [ " $SSH_CONTROLMASTER " = = true ] && [ " $SSH_CMD " != "" ] ; then
$SSH_CMD -O exit
fi
if [ " $_DEBUG " != true ] ; then
# Removing optional remote $RUN_DIR that goes into local $RUN_DIR
if [ -d " $RUN_DIR / $PROGRAM .remote. $SCRIPT_PID . $TSTAMP " ] ; then
rm -rf " $RUN_DIR / $PROGRAM .remote. $SCRIPT_PID . $TSTAMP "
fi
# Removing all temporary run files
rm -f " $RUN_DIR / $PROGRAM . " *" . $SCRIPT_PID . $TSTAMP "
# Fix for sed -i requiring backup extension for BSD & Mac (see all sed -i statements)
rm -f " $RUN_DIR / $PROGRAM . " *" . $SCRIPT_PID . $TSTAMP .tmp "
fi
}
2018-11-06 15:33:16 +01:00
2016-05-25 19:55:54 +02:00
# osync/obackup/pmocr script specific mail alert function, use SendEmail function for generic mail sending
2015-11-19 23:04:02 +01:00
function SendAlert {
2016-08-26 15:10:30 +02:00
local runAlert = " ${ 1 :- false } " # Specifies if current message is sent while running or at the end of a run
2019-05-21 11:46:07 +02:00
local attachment = " ${ 2 :- true } " # Should we send the log file as attachment
2016-08-26 15:10:30 +02:00
2015-11-19 23:04:02 +01:00
2016-11-17 21:02:15 +01:00
local attachmentFile
local subject
local body
2016-05-25 19:55:54 +02:00
2016-03-10 10:26:26 +01:00
if [ " $DESTINATION_MAILS " = = "" ] ; then
return 0
fi
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2016-05-25 19:55:54 +02:00
Logger "Debug mode, no warning mail will be sent." "NOTICE"
2015-11-19 23:04:02 +01:00
return 0
fi
2019-05-21 11:46:07 +02:00
if [ $attachment = = true ] ; then
attachmentFile = " $LOG_FILE "
if type " $COMPRESSION_PROGRAM " > /dev/null 2>& 1; then
eval " cat \" $LOG_FILE \" \" $COMPRESSION_PROGRAM \" > \" $ALERT_LOG_FILE \" "
if [ $? -eq 0 ] ; then
attachmentFile = " $ALERT_LOG_FILE "
fi
fi
2016-02-16 21:09:57 +01:00
fi
2018-02-24 17:41:57 +01:00
2020-03-15 22:58:12 +01:00
body = " $MAIL_ALERT_MSG " $'\n\n' "Last 1000 lines of current log" $'\n\n' " $( tail -n 1000 " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP " ) "
2016-08-26 15:10:30 +02:00
2016-08-31 11:26:21 +02:00
if [ $ERROR_ALERT = = true ] ; then
2015-11-19 23:04:02 +01:00
subject = " Error alert for $INSTANCE_ID "
2016-08-31 11:26:21 +02:00
elif [ $WARN_ALERT = = true ] ; then
2015-11-19 23:04:02 +01:00
subject = " Warning alert for $INSTANCE_ID "
else
subject = " Alert for $INSTANCE_ID "
fi
2016-08-26 15:10:30 +02:00
if [ $runAlert = = true ] ; then
subject = " Currently runing - $subject "
else
2017-01-04 09:00:47 +01:00
subject = " Finished run - $subject "
2016-08-26 15:10:30 +02:00
fi
2017-01-04 09:00:47 +01:00
SendEmail " $subject " " $body " " $DESTINATION_MAILS " " $attachmentFile " " $SENDER_MAIL " " $SMTP_SERVER " " $SMTP_PORT " " $SMTP_ENCRYPTION " " $SMTP_USER " " $SMTP_PASSWORD "
2015-11-19 23:04:02 +01:00
# Delete tmp log file
2016-11-17 21:02:15 +01:00
if [ " $attachment " = = true ] ; then
if [ -f " $ALERT_LOG_FILE " ] ; then
rm -f " $ALERT_LOG_FILE "
fi
2015-11-19 23:04:02 +01:00
fi
}
2016-05-25 19:55:54 +02:00
# Generic email sending function.
# Usage (linux / BSD), attachment is optional, can be "/path/to/my.file" or ""
# SendEmail "subject" "Body text" "receiver@example.com receiver2@otherdomain.com" "/path/to/attachment.file"
# Usage (Windows, make sure you have mailsend.exe in executable path, see http://github.com/muquit/mailsend)
# attachment is optional but must be in windows format like "c:\\some\path\\my.file", or ""
2016-11-10 16:25:37 +01:00
# smtp_server.domain.tld is mandatory, as is smtpPort (should be 25, 465 or 587)
2016-05-25 19:55:54 +02:00
# encryption can be set to tls, ssl or none
2016-11-10 16:25:37 +01:00
# smtpUser and smtpPassword are optional
# SendEmail "subject" "Body text" "receiver@example.com receiver2@otherdomain.com" "/path/to/attachment.file" "senderMail@example.com" "smtpServer.domain.tld" "smtpPort" "encryption" "smtpUser" "smtpPassword"
2018-07-30 15:36:53 +02:00
# If text is received as attachment ATT00001.bin or noname, consider adding the following to /etc/mail.rc
#set ttycharset=iso-8859-1
#set sendcharsets=iso-8859-1
#set encoding=8bit
2016-04-14 18:01:18 +02:00
function SendEmail {
local subject = " ${ 1 } "
local message = " ${ 2 } "
2016-11-10 16:25:37 +01:00
local destinationMails = " ${ 3 } "
2016-05-25 19:55:54 +02:00
local attachment = " ${ 4 } "
2016-11-10 16:25:37 +01:00
local senderMail = " ${ 5 } "
local smtpServer = " ${ 6 } "
local smtpPort = " ${ 7 } "
2016-07-19 10:53:55 +02:00
local encryption = " ${ 8 } "
2016-11-10 16:25:37 +01:00
local smtpUser = " ${ 9 } "
local smtpPassword = " ${ 10 } "
2016-04-14 18:01:18 +02:00
local mail_no_attachment =
local attachment_command =
2016-05-25 19:55:54 +02:00
local encryption_string =
local auth_string =
2018-02-24 17:41:57 +01:00
local i
2019-02-26 12:09:50 +01:00
if [ " ${ destinationMails } " != "" ] ; then
2019-05-21 11:46:07 +02:00
for i in " ${ destinationMails [@] } " ; do
2018-07-30 15:36:53 +02:00
if [ $( CheckRFC822 " $i " ) -ne 1 ] ; then
Logger " Given email [ $i ] does not seem to be valid. " "WARN"
fi
done
else
2020-03-15 22:58:12 +01:00
Logger "No valid email addresses given." "WARN"
2018-07-30 15:36:53 +02:00
return 1
fi
2018-02-24 17:41:57 +01:00
# Prior to sending an email, convert its body if needed
if [ " $MAIL_BODY_CHARSET " != "" ] ; then
if type iconv > /dev/null 2>& 1; then
echo " $message " | iconv -f UTF-8 -t $MAIL_BODY_CHARSET -o " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .iconv. $SCRIPT_PID . $TSTAMP "
2020-03-15 22:58:12 +01:00
message = " $( cat " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .iconv. $SCRIPT_PID . $TSTAMP " ) "
2018-02-24 17:41:57 +01:00
else
Logger "iconv utility not installed. Will not convert email charset." "NOTICE"
fi
fi
2016-04-14 18:01:18 +02:00
if [ ! -f " $attachment " ] ; then
2016-11-10 16:25:37 +01:00
attachment_command = " -a $attachment "
2016-04-14 18:01:18 +02:00
mail_no_attachment = 1
else
mail_no_attachment = 0
fi
2016-11-30 14:04:41 +01:00
if [ " $LOCAL_OS " = = "Busybox" ] || [ " $LOCAL_OS " = = "Android" ] ; then
2017-01-04 09:00:47 +01:00
if [ " $smtpPort " = = "" ] ; then
Logger "Missing smtp port, assuming 25." "WARN"
smtpPort = 25
fi
2016-11-10 16:25:37 +01:00
if type sendmail > /dev/null 2>& 1; then
2017-01-04 09:00:47 +01:00
if [ " $encryption " = = "tls" ] ; then
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $senderMail " -H " exec openssl s_client -quiet -tls1_2 -starttls smtp -connect $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
elif [ " $encryption " = = "ssl" ] ; then
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $senderMail " -H " exec openssl s_client -quiet -connect $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
2020-03-15 22:58:12 +01:00
elif [ " $encryption " = = "none" ] ; then
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $senderMail " -S " $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
2016-11-10 16:25:37 +01:00
else
2017-01-04 09:00:47 +01:00
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $senderMail " -S " $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
2020-03-15 22:58:12 +01:00
Logger " Bogus email encryption used [ $encryption ]. " "WARN"
2016-11-10 16:25:37 +01:00
fi
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-10 16:25:37 +01:00
Logger " Cannot send alert mail via $( type -p sendmail) !!! " "WARN"
2018-01-03 22:32:19 +01:00
# Do not bother try other mail systems with busybox
2016-11-10 16:25:37 +01:00
return 1
else
return 0
fi
else
2018-01-03 22:32:19 +01:00
Logger "Sendmail not present. Will not send any mail" "WARN"
2016-11-10 16:25:37 +01:00
return 1
fi
fi
2016-04-14 18:01:18 +02:00
if type mutt > /dev/null 2>& 1 ; then
2017-01-04 09:00:47 +01:00
# We need to replace spaces with comma in order for mutt to be able to process multiple destinations
echo " $message " | $( type -p mutt) -x -s " $subject " " ${ destinationMails // /, } " $attachment_command
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p mutt) !!! " "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using mutt." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
if type mail > /dev/null 2>& 1 ; then
2016-11-30 14:04:41 +01:00
# We need to detect which version of mail is installed
if ! $( type -p mail) -V > /dev/null 2>& 1; then
# This may be MacOS mail program
attachment_command = ""
elif [ " $mail_no_attachment " -eq 0 ] && $( type -p mail) -V | grep "GNU" > /dev/null; then
2016-04-14 18:01:18 +02:00
attachment_command = " -A $attachment "
elif [ " $mail_no_attachment " -eq 0 ] && $( type -p mail) -V > /dev/null; then
attachment_command = " -a $attachment "
else
attachment_command = ""
fi
2016-11-30 14:04:41 +01:00
2016-11-10 16:25:37 +01:00
echo " $message " | $( type -p mail) $attachment_command -s " $subject " " $destinationMails "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p mail) with attachments !!! " "WARN"
2016-11-10 16:25:37 +01:00
echo " $message " | $( type -p mail) -s " $subject " " $destinationMails "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p mail) without attachments !!! " "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using mail command without attachment." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using mail command." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
if type sendmail > /dev/null 2>& 1 ; then
2016-11-10 16:25:37 +01:00
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) " $destinationMails "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p sendmail) !!! " "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using sendmail command without attachment." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
2016-05-25 19:55:54 +02:00
# Windows specific
2016-08-08 15:49:48 +02:00
if type "mailsend.exe" > /dev/null 2>& 1 ; then
2016-11-10 16:25:37 +01:00
if [ " $senderMail " = = "" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Missing sender email." "ERROR"
return 1
fi
2016-11-10 16:25:37 +01:00
if [ " $smtpServer " = = "" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Missing smtp port." "ERROR"
return 1
fi
2016-11-10 16:25:37 +01:00
if [ " $smtpPort " = = "" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Missing smtp port, assuming 25." "WARN"
2016-11-10 16:25:37 +01:00
smtpPort = 25
2016-05-25 19:55:54 +02:00
fi
if [ " $encryption " != "tls" ] && [ " $encryption " != "ssl" ] && [ " $encryption " != "none" ] ; then
Logger "Bogus smtp encryption, assuming none." "WARN"
encryption_string =
elif [ " $encryption " = = "tls" ] ; then
encryption_string = -starttls
elif [ " $encryption " = = "ssl" ] :; then
encryption_string = -ssl
fi
2016-11-10 16:25:37 +01:00
if [ " $smtpUser " != "" ] && [ " $smtpPassword " != "" ] ; then
auth_string = " -auth -user \" $smtpUser \" -pass \" $smtpPassword \" "
2016-05-25 19:55:54 +02:00
fi
2016-11-10 16:25:37 +01:00
$( type mailsend.exe) -f " $senderMail " -t " $destinationMails " -sub " $subject " -M " $message " -attach " $attachment " -smtp " $smtpServer " -port " $smtpPort " $encryption_string $auth_string
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-08-08 15:49:48 +02:00
Logger " Cannot send mail via $( type mailsend.exe) !!! " "WARN"
else
Logger "Sent mail using mailsend.exe command with attachment." "NOTICE"
return 0
fi
fi
2016-05-25 19:55:54 +02:00
2016-04-14 18:01:18 +02:00
# pfSense specific
if [ -f /usr/local/bin/mail.php ] ; then
echo " $message " | /usr/local/bin/mail.php -s= " $subject "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger "Cannot send mail via /usr/local/bin/mail.php (pfsense) !!!" "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using pfSense mail.php." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
2016-08-06 16:16:19 +02:00
# If function has not returned 0 yet, assume it is critical that no alert can be sent
2016-05-25 19:55:54 +02:00
Logger "Cannot send mail (neither mutt, mail, sendmail, sendemail, mailsend (windows) or pfSense mail.php could be used)." "ERROR" # Is not marked critical because execution must continue
2016-04-14 18:01:18 +02:00
}
2016-03-04 09:34:02 +01:00
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
2016-11-10 16:25:37 +01:00
2016-11-17 21:02:15 +01:00
if [ $_LOGGER_SILENT = = false ] ; then
2017-01-04 09:00:47 +01:00
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
2016-03-04 09:34:02 +01:00
fi
}
2016-03-18 19:20:28 +01:00
function LoadConfigFile {
2016-09-08 22:51:24 +02:00
local configFile = " ${ 1 } "
2019-01-03 10:10:08 +01:00
local revisionRequired = " ${ 2 } "
2016-03-18 19:20:28 +01:00
2019-01-03 10:10:08 +01:00
local revisionPresent
2016-11-10 16:25:37 +01:00
2016-09-08 22:51:24 +02:00
if [ ! -f " $configFile " ] ; then
Logger " Cannot load configuration file [ $configFile ]. Cannot start. " "CRITICAL"
2016-03-18 19:20:28 +01:00
exit 1
2016-09-08 22:51:24 +02:00
elif [ [ " $configFile " != *".conf" ] ] ; then
Logger " Wrong configuration file supplied [ $configFile ]. Cannot start. " "CRITICAL"
2016-03-18 19:20:28 +01:00
exit 1
else
2019-05-21 11:46:07 +02:00
revisionPresent = " $( GetConfFileValue " $configFile " "CONFIG_FILE_REVISION" true ) "
if [ " $( IsNumeric " ${ revisionPresent %%.* } " ) " -eq 0 ] ; then
Logger "Missing CONFIG_FILE_REVISION. Please provide a valid config file, or run the config update script." "WARN"
2019-02-26 12:09:50 +01:00
Logger " CONFIG_FILE_REVISION does not seem numeric [ $revisionPresent ]. " "DEBUG"
2019-05-21 11:46:07 +02:00
elif [ " $revisionRequired " != "" ] ; then
2019-01-03 10:10:08 +01:00
if [ $( VerComp " $revisionPresent " " $revisionRequired " ) -eq 2 ] ; then
Logger " Configuration file seems out of date. Required version [ $revisionRequired ]. Actual version [ $revisionPresent ]. " "CRITICAL"
exit 1
fi
fi
2016-09-08 22:51:24 +02:00
# Remove everything that is not a variable assignation
2017-01-04 09:00:47 +01:00
grep '^[^ ]*=[^;&]*' " $configFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP "
source " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP "
2016-03-18 19:20:28 +01:00
fi
2016-09-08 22:51:24 +02:00
CONFIG_FILE = " $configFile "
2016-03-18 19:20:28 +01:00
}
2018-01-03 22:32:19 +01:00
# Quick and dirty performance logger only used for debugging
2017-01-04 09:00:47 +01:00
_OFUNCTIONS_SPINNER = "|/-\\"
2016-03-04 09:34:02 +01:00
function Spinner {
2020-03-15 22:58:12 +01:00
if [ $_LOGGER_SILENT = = true ] || [ " $_LOGGER_ERR_ONLY " = = true ] || [ " $_SYNC_ON_CHANGES " = = "initiator" ] || [ " $_SYNC_ON_CHANGES " = = "target" ] ; then
2016-03-04 09:34:02 +01:00
return 0
2017-01-04 09:00:47 +01:00
else
printf " [%c] \b\b\b\b\b\b" " $_OFUNCTIONS_SPINNER "
_OFUNCTIONS_SPINNER = ${ _OFUNCTIONS_SPINNER #? } ${ _OFUNCTIONS_SPINNER %%??? }
return 0
2016-03-04 09:34:02 +01:00
fi
}
2018-01-03 22:32:19 +01:00
# WaitForTaskCompletion function emulation, now uses ExecTasks
function WaitForTaskCompletion {
2018-02-24 17:41:57 +01:00
local pids = " ${ 1 } "
local softMaxTime = " ${ 2 :- 0 } "
local hardMaxTime = " ${ 3 :- 0 } "
local sleepTime = " ${ 4 :- .05 } "
local keepLogging = " ${ 5 :- 0 } "
local counting = " ${ 6 :- true } "
local spinner = " ${ 7 :- true } "
local noErrorLog = " ${ 8 :- false } "
local id = " ${ 9 -base } "
ExecTasks " $pids " " $id " false 0 0 " $softMaxTime " " $hardMaxTime " " $counting " " $sleepTime " " $keepLogging " " $spinner " " $noErrorlog "
2018-01-03 22:32:19 +01:00
}
2016-08-08 15:49:48 +02:00
2018-01-03 22:32:19 +01:00
# ParallelExec function emulation, now uses ExecTasks
function ParallelExec {
2018-02-24 17:41:57 +01:00
local numberOfProcesses = " ${ 1 } "
local commandsArg = " ${ 2 } "
local readFromFile = " ${ 3 :- false } "
local softMaxTime = " ${ 4 :- 0 } "
local hardMaxTime = " ${ 5 :- 0 } "
local sleepTime = " ${ 6 :- .05 } "
local keepLogging = " ${ 7 :- 0 } "
local counting = " ${ 8 :- true } "
local spinner = " ${ 9 :- false } "
local noErrorLog = " ${ 10 :- false } "
2018-01-03 22:32:19 +01:00
if [ $readFromFile = = true ] ; then
2018-02-24 17:41:57 +01:00
ExecTasks " $commandsArg " "base" $readFromFile 0 0 " $softMaxTime " " $hardMaxTime " " $counting " " $sleepTime " " $keepLogging " " $spinner " " $noErrorLog " false " $numberOfProcesses "
2018-01-03 22:32:19 +01:00
else
2018-02-24 17:41:57 +01:00
ExecTasks " $commandsArg " "base" $readFromFile 0 0 " $softMaxTime " " $hardMaxTime " " $counting " " $sleepTime " " $keepLogging " " $spinner " " $noErrorLog " false " $numberOfProcesses "
2018-01-03 22:32:19 +01:00
fi
}
2017-06-09 09:58:51 +02:00
2018-01-03 22:32:19 +01:00
## Main asynchronous execution function
2018-02-24 17:41:57 +01:00
## Function can work in:
## WaitForTaskCompletion mode: monitors given pid in background, and stops them if max execution time is reached. Suitable for multiple synchronous pids to monitor and wait for
## ParallExec mode: takes list of commands to execute in parallel per batch, and stops them if max execution time is reahed.
## Example of improved wait $!
## ExecTasks $! "some_identifier" false 0 0 0 0 true 1 1800 false
## Example: monitor two sleep processes, warn if execution time is higher than 10 seconds, stop after 20 seconds
## sleep 15 &
## pid=$!
## sleep 20 &
## pid2=$!
## ExecTasks "some_identifier" 0 0 10 20 1 1800 true true false false 1 "$pid;$pid2"
## Example of parallel execution of four commands, only if directories exist. Warn if execution takes more than 300 seconds. Stop if takes longer than 900 seconds. Exeute max 3 commands in parallel.
## commands="du -csh /var;du -csh /etc;du -csh /home;du -csh /usr"
## conditions="[ -d /var ];[ -d /etc ];[ -d /home];[ -d /usr]"
## ExecTasks "$commands" "some_identifier" false 0 0 300 900 true 1 1800 true false false 3 "$conditions"
## Bear in mind that given commands and conditions need to be quoted
## ExecTasks has the following ofunctions subfunction requirements:
2018-01-03 22:32:19 +01:00
## Spinner
## Logger
## JoinString
## KillChilds
2018-02-24 17:41:57 +01:00
## Full call
##ExecTasks "$mainInput" "$id" $readFromFile $softPerProcessTime $hardPerProcessTime $softMaxTime $hardMaxTime $counting $sleepTime $keepLogging $spinner $noTimeErrorLog $noErrorLogsAtAll $numberOfProcesses $auxInput $maxPostponeRetries $minTimeBetweenRetries $validExitCodes
2018-01-03 22:32:19 +01:00
function ExecTasks {
2018-02-24 17:41:57 +01:00
# Mandatory arguments
2018-07-30 15:36:53 +02:00
local mainInput = " ${ 1 } " # Contains list of pids / commands separated by semicolons or filepath to list of pids / commands
2018-02-24 17:41:57 +01:00
# Optional arguments
2018-07-30 15:36:53 +02:00
local id = " ${ 2 :- base } " # Optional ID in order to identify global variables from this run (only bash variable names, no '-'). Global variables are WAIT_FOR_TASK_COMPLETION_$id and HARD_MAX_EXEC_TIME_REACHED_$id
local readFromFile = " ${ 3 :- false } " # Is mainInput / auxInput a semicolon separated list (true) or a filepath (false)
local softPerProcessTime = " ${ 4 :- 0 } " # Max time (in seconds) a pid or command can run before a warning is logged, unless set to 0
local hardPerProcessTime = " ${ 5 :- 0 } " # Max time (in seconds) a pid or command can run before the given command / pid is stopped, unless set to 0
local softMaxTime = " ${ 6 :- 0 } " # Max time (in seconds) for the whole function to run before a warning is logged, unless set to 0
local hardMaxTime = " ${ 7 :- 0 } " # Max time (in seconds) for the whole function to run before all pids / commands given are stopped, unless set to 0
local counting = " ${ 8 :- true } " # Should softMaxTime and hardMaxTime be accounted since function begin (true) or since script begin (false)
local sleepTime = " ${ 9 :- .5 } " # Seconds between each state check. The shorter the value, the snappier ExecTasks will be, but as a tradeoff, more cpu power will be used (good values are between .05 and 1)
local keepLogging = " ${ 10 :- 1800 } " # Every keepLogging seconds, an alive message is logged. Setting this value to zero disables any alive logging
local spinner = " ${ 11 :- true } " # Show spinner (true) or do not show anything (false) while running
local noTimeErrorLog = " ${ 12 :- false } " # Log errors when reaching soft / hard execution times (false) or do not log errors on those triggers (true)
local noErrorLogsAtAll = " ${ 13 :- false } " # Do not log any errros at all (useful for recursive ExecTasks checks)
2018-02-24 17:41:57 +01:00
# Parallelism specific arguments
2018-07-30 15:36:53 +02:00
local numberOfProcesses = " ${ 14 :- 0 } " # Number of simulanteous commands to run, given as mainInput. Set to 0 by default (WaitForTaskCompletion mode). Setting this value enables ParallelExec mode.
local auxInput = " ${ 15 } " # Contains list of commands separated by semicolons or filepath fo list of commands. Exit code of those commands decide whether main commands will be executed or not
local maxPostponeRetries = " ${ 16 :- 3 } " # If a conditional command fails, how many times shall we try to postpone the associated main command. Set this to 0 to disable postponing
local minTimeBetweenRetries = " ${ 17 :- 300 } " # Time (in seconds) between postponed command retries
local validExitCodes = " ${ 18 :- 0 } " # Semi colon separated list of valid main command exit codes which will not trigger errors
2016-08-31 11:26:21 +02:00
2018-11-06 15:33:16 +01:00
2018-01-03 22:32:19 +01:00
local i
2016-11-30 14:04:41 +01:00
2016-08-06 16:16:19 +02:00
2018-02-24 17:41:57 +01:00
# Since ExecTasks takes up to 17 arguments, do a quick preflight check in DEBUG mode
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2018-02-24 17:41:57 +01:00
declare -a booleans = ( readFromFile counting spinner noTimeErrorLog noErrorLogsAtAll)
for i in " ${ booleans [@] } " ; do
test = " if [ \$ $i != false ] && [ \$ $i != true ]; then Logger \"Bogus $i value [\$ $i ] given to ${ FUNCNAME [0] } .\" \"CRITICAL\"; exit 1; fi "
eval " $test "
done
declare -a integers = ( softPerProcessTime hardPerProcessTime softMaxTime hardMaxTime keepLogging numberOfProcesses maxPostponeRetries minTimeBetweenRetries)
2018-01-03 22:32:19 +01:00
for i in " ${ integers [@] } " ; do
test = " if [ $( IsNumericExpand \" \$ $i \" ) -eq 0 ]; then Logger \"Bogus $i value [\$ $i ] given to ${ FUNCNAME [0] } .\" \"CRITICAL\"; exit 1; fi "
eval " $test "
done
fi
2016-08-06 16:16:19 +02:00
2018-02-24 17:41:57 +01:00
# Expand validExitCodes into array
IFS = ';' read -r -a validExitCodes <<< " $validExitCodes "
2018-01-03 22:32:19 +01:00
# ParallelExec specific variables
2018-07-30 15:36:53 +02:00
local auxItemCount = 0 # Number of conditional commands
local commandsArray = ( ) # Array containing commands
2018-02-24 17:41:57 +01:00
local commandsConditionArray = ( ) # Array containing conditional commands
2018-07-30 15:36:53 +02:00
local currentCommand # Variable containing currently processed command
local currentCommandCondition # Variable containing currently processed conditional command
2019-01-03 10:10:08 +01:00
local commandsArrayPid = ( ) # Array containing commands indexed by pids
2020-03-15 22:58:12 +01:00
local commandsArrayOutput = ( ) # Array containing command results indexed by pids
2018-07-30 15:36:53 +02:00
local postponedRetryCount = 0 # Number of current postponed commands retries
local postponedItemCount = 0 # Number of commands that have been postponed (keep at least one in order to check once)
2018-02-24 17:41:57 +01:00
local postponedCounter = 0
2018-07-30 15:36:53 +02:00
local isPostponedCommand = false # Is the current command from a postponed file ?
local postponedExecTime = 0 # How much time has passed since last postponed condition was checked
local needsPostponing # Does currentCommand need to be postponed
2018-02-24 17:41:57 +01:00
local temp
2016-08-06 16:16:19 +02:00
2018-01-03 22:32:19 +01:00
# Common variables
2018-07-30 15:36:53 +02:00
local pid # Current pid working on
local pidState # State of the process
local mainItemCount = 0 # number of given items (pids or commands)
local readFromFile # Should we read pids / commands from a file (true)
2018-02-24 17:41:57 +01:00
local counter = 0
2018-07-30 15:36:53 +02:00
local log_ttime = 0 # local time instance for comparaison
2016-08-06 16:16:19 +02:00
2018-07-30 15:36:53 +02:00
local seconds_begin = $SECONDS # Seconds since the beginning of the script
local exec_time = 0 # Seconds since the beginning of this function
2016-08-06 16:16:19 +02:00
2018-07-30 15:36:53 +02:00
local retval = 0 # return value of monitored pid process
local subRetval = 0 # return value of condition commands
local errorcount = 0 # Number of pids that finished with errors
local pidsArray # Array of currently running pids
local newPidsArray # New array of currently running pids for next iteration
local pidsTimeArray # Array containing execution begin time of pids
local executeCommand # Boolean to check if currentCommand can be executed given a condition
2018-01-03 22:32:19 +01:00
local functionMode
2019-01-03 10:10:08 +01:00
local softAlert = false # Does a soft alert need to be triggered, if yes, send an alert once
2018-11-06 15:33:16 +01:00
local failedPidsList # List containing failed pids with exit code separated by semicolons (eg : 2355:1;4534:2;2354:3)
2019-01-03 10:10:08 +01:00
local randomOutputName # Random filename for command outputs
2020-03-15 22:58:12 +01:00
local currentRunningPids # String of pids running, used for debugging purposes only
2016-11-30 14:04:41 +01:00
2018-01-03 22:32:19 +01:00
# Initialise global variable
eval " WAIT_FOR_TASK_COMPLETION_ $id =\"\" "
eval " HARD_MAX_EXEC_TIME_REACHED_ $id =false "
2016-08-06 16:16:19 +02:00
2018-02-24 17:41:57 +01:00
# Init function variables depending on mode
if [ $numberOfProcesses -gt 0 ] ; then
2018-01-03 22:32:19 +01:00
functionMode = ParallelExec
2018-02-24 17:41:57 +01:00
else
functionMode = WaitForTaskCompletion
fi
if [ $readFromFile = = false ] ; then
if [ $functionMode = = "WaitForTaskCompletion" ] ; then
IFS = ';' read -r -a pidsArray <<< " $mainInput "
mainItemCount = " ${# pidsArray [@] } "
else
IFS = ';' read -r -a commandsArray <<< " $mainInput "
mainItemCount = " ${# commandsArray [@] } "
IFS = ';' read -r -a commandsConditionArray <<< " $auxInput "
auxItemCount = " ${# commandsConditionArray [@] } "
fi
else
2018-01-03 22:32:19 +01:00
if [ -f " $mainInput " ] ; then
2018-02-24 17:41:57 +01:00
mainItemCount = $( wc -l < " $mainInput " )
2018-01-03 22:32:19 +01:00
readFromFile = true
2018-02-24 17:41:57 +01:00
else
Logger " Cannot read main file [ $mainInput ]. " "WARN"
fi
if [ " $auxInput " != "" ] ; then
if [ -f " $auxInput " ] ; then
auxItemCount = $( wc -l < " $auxInput " )
else
Logger " Cannot read aux file [ $auxInput ]. " "WARN"
fi
fi
fi
2016-08-15 10:29:13 +02:00
2018-02-24 17:41:57 +01:00
if [ $functionMode = = "WaitForTaskCompletion" ] ; then
# Force first while loop condition to be true because we don't deal with counters but pids in WaitForTaskCompletion mode
counter = $mainItemCount
fi
2018-01-03 22:32:19 +01:00
2016-08-06 16:16:19 +02:00
2018-02-24 17:41:57 +01:00
# soft / hard execution time checks that needs to be a subfunction since it is called both from main loop and from parallelExec sub loop
function _ExecTasksTimeCheck {
2016-11-30 14:04:41 +01:00
if [ $spinner = = true ] ; then
Spinner
fi
2016-08-07 23:47:21 +02:00
if [ $counting = = true ] ; then
2017-01-04 09:00:47 +01:00
exec_time = $(( SECONDS - seconds_begin))
2016-08-07 23:47:21 +02:00
else
exec_time = $SECONDS
fi
2016-11-10 16:25:37 +01:00
if [ $keepLogging -ne 0 ] ; then
2019-05-21 11:46:07 +02:00
# This log solely exists for readability purposes before having next set of logs
if [ ${# pidsArray [@] } -eq $numberOfProcesses ] && [ $log_ttime -eq 0 ] ; then
log_ttime = $exec_time
Logger " There are $(( mainItemCount-counter+postponedItemCount)) / $mainItemCount tasks in the queue of which $postponedItemCount are postponed. Currently, ${# pidsArray [@] } tasks running with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "NOTICE"
fi
2018-02-24 17:41:57 +01:00
if [ $(( ( exec_time + 1 ) % keepLogging)) -eq 0 ] ; then
2018-01-03 22:32:19 +01:00
if [ $log_ttime -ne $exec_time ] ; then # Fix when sleep time lower than 1 second
2016-08-16 20:39:49 +02:00
log_ttime = $exec_time
2019-05-21 11:46:07 +02:00
if [ $functionMode = = "WaitForTaskCompletion" ] ; then
2018-01-03 22:32:19 +01:00
Logger " Current tasks still running with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "NOTICE"
elif [ $functionMode = = "ParallelExec" ] ; then
2019-05-21 11:46:07 +02:00
Logger " There are $(( mainItemCount-counter+postponedItemCount)) / $mainItemCount tasks in the queue of which $postponedItemCount are postponed. Currently, ${# pidsArray [@] } tasks running with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "NOTICE"
2018-01-03 22:32:19 +01:00
fi
2016-08-16 20:39:49 +02:00
fi
2016-08-06 16:16:19 +02:00
fi
fi
2016-11-10 16:25:37 +01:00
if [ $exec_time -gt $softMaxTime ] ; then
2018-01-03 22:32:19 +01:00
if [ " $softAlert " != true ] && [ $softMaxTime -ne 0 ] && [ $noTimeErrorLog != true ] ; then
2018-02-24 17:41:57 +01:00
Logger " Max soft execution time [ $softMaxTime ] exceeded for task [ $id ] with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "WARN"
2018-01-03 22:32:19 +01:00
softAlert = true
2016-08-26 15:10:30 +02:00
SendAlert true
2016-08-06 16:16:19 +02:00
fi
2016-11-30 14:04:41 +01:00
fi
if [ $exec_time -gt $hardMaxTime ] && [ $hardMaxTime -ne 0 ] ; then
2018-01-03 22:32:19 +01:00
if [ $noTimeErrorLog != true ] ; then
2018-02-24 17:41:57 +01:00
Logger " Max hard execution time [ $hardMaxTime ] exceeded for task [ $id ] with pids [ $( joinString , ${ pidsArray [@] } ) ]. Stopping task execution. " "ERROR"
2016-11-30 14:04:41 +01:00
fi
for pid in " ${ pidsArray [@] } " ; do
KillChilds $pid true
2019-05-21 11:46:07 +02:00
if [ $? -eq 0 ] ; then
2016-11-30 14:04:41 +01:00
Logger " Task with pid [ $pid ] stopped successfully. " "NOTICE"
else
2018-02-24 17:41:57 +01:00
if [ $noErrorLogsAtAll != true ] ; then
Logger " Could not stop task with pid [ $pid ]. " "ERROR"
fi
2016-11-30 14:04:41 +01:00
fi
errorcount = $(( errorcount+1))
done
2018-01-03 22:32:19 +01:00
if [ $noTimeErrorLog != true ] ; then
2016-08-26 15:10:30 +02:00
SendAlert true
2016-08-06 16:16:19 +02:00
fi
2018-01-03 22:32:19 +01:00
eval " HARD_MAX_EXEC_TIME_REACHED_ $id =true "
if [ $functionMode = = "WaitForTaskCompletion" ] ; then
return $errorcount
2018-02-24 17:41:57 +01:00
else
return 129
2018-01-03 22:32:19 +01:00
fi
fi
2018-02-24 17:41:57 +01:00
}
2018-01-03 22:32:19 +01:00
2018-02-24 17:41:57 +01:00
function _ExecTasksPidsCheck {
newPidsArray = ( )
2016-08-06 16:16:19 +02:00
2020-03-15 22:58:12 +01:00
if [ " $currentRunningPids " != " $( joinString " " ${ pidsArray [@] } ) " ] ; then
Logger " ExecTask running for pids [ $( joinString " " ${ pidsArray [@] } ) ]. " "DEBUG"
currentRunningPids = " $( joinString " " ${ pidsArray [@] } ) "
fi
2016-08-22 09:11:32 +02:00
for pid in " ${ pidsArray [@] } " ; do
2016-09-08 22:51:24 +02:00
if [ $( IsInteger $pid ) -eq 1 ] ; then
2016-08-31 11:26:21 +02:00
if kill -0 $pid > /dev/null 2>& 1; then
# Handle uninterruptible sleep state or zombies by ommiting them from running process array (How to kill that is already dead ? :)
2016-11-10 16:25:37 +01:00
pidState = " $( eval $PROCESS_STATE_CMD ) "
2016-08-31 11:26:21 +02:00
if [ " $pidState " != "D" ] && [ " $pidState " != "Z" ] ; then
2018-02-24 17:41:57 +01:00
# Check if pid hasn't run more than soft/hard perProcessTime
pidsTimeArray[ $pid ] = $(( SECONDS - seconds_begin))
if [ ${ pidsTimeArray [ $pid ] } -gt $softPerProcessTime ] ; then
if [ " $softAlert " != true ] && [ $softPerProcessTime -ne 0 ] && [ $noTimeErrorLog != true ] ; then
Logger " Max soft execution time [ $softPerProcessTime ] exceeded for pid [ $pid ]. " "WARN"
if [ " ${ commandsArrayPid [ $pid ] } ] " != "" ] ; then
Logger " Command was [ ${ commandsArrayPid [ $pid ] } ]]. " "WARN"
fi
softAlert = true
SendAlert true
fi
fi
if [ ${ pidsTimeArray [ $pid ] } -gt $hardPerProcessTime ] && [ $hardPerProcessTime -ne 0 ] ; then
if [ $noTimeErrorLog != true ] && [ $noErrorLogsAtAll != true ] ; then
Logger " Max hard execution time [ $hardPerProcessTime ] exceeded for pid [ $pid ]. Stopping command execution. " "ERROR"
if [ " ${ commandsArrayPid [ $pid ] } ] " != "" ] ; then
Logger " Command was [ ${ commandsArrayPid [ $pid ] } ]]. " "WARN"
fi
fi
KillChilds $pid true
2019-05-21 11:46:07 +02:00
if [ $? -eq 0 ] ; then
2018-02-24 17:41:57 +01:00
Logger " Command with pid [ $pid ] stopped successfully. " "NOTICE"
else
if [ $noErrorLogsAtAll != true ] ; then
Logger " Could not stop command with pid [ $pid ]. " "ERROR"
fi
fi
errorcount = $(( errorcount+1))
if [ $noTimeErrorLog != true ] ; then
SendAlert true
fi
fi
2016-08-31 11:26:21 +02:00
newPidsArray += ( $pid )
fi
else
2018-01-03 22:32:19 +01:00
# pid is dead, get its exit code from wait command
2016-08-31 11:26:21 +02:00
wait $pid
retval = $?
2018-02-24 17:41:57 +01:00
# Check for valid exit codes
if [ $( ArrayContains $retval " ${ validExitCodes [@] } " ) -eq 0 ] ; then
if [ $noErrorLogsAtAll != true ] ; then
2018-11-06 15:33:16 +01:00
Logger " ${ FUNCNAME [0] } called by [ $id ] finished monitoring pid [ $pid ] with exitcode [ $retval ]. " "ERROR"
2018-02-24 17:41:57 +01:00
if [ " $functionMode " = = "ParallelExec" ] ; then
Logger " Command was [ ${ commandsArrayPid [ $pid ] } ]. " "ERROR"
fi
2019-01-03 10:10:08 +01:00
if [ -f " ${ commandsArrayOutput [ $pid ] } " ] ; then
2020-03-15 22:58:12 +01:00
Logger " Truncated output:\n $( head -c16384 " ${ commandsArrayOutput [ $pid ] } " ) " "ERROR"
2019-01-03 10:10:08 +01:00
fi
2018-02-24 17:41:57 +01:00
fi
2017-01-04 09:00:47 +01:00
errorcount = $(( errorcount+1))
# Welcome to variable variable bash hell
2018-11-06 15:33:16 +01:00
if [ " $failedPidsList " = = "" ] ; then
failedPidsList = " $pid : $retval "
2016-08-31 11:26:21 +02:00
else
2018-11-06 15:33:16 +01:00
failedPidsList = " $failedPidsList ; $pid : $retval "
2016-08-31 11:26:21 +02:00
fi
2018-01-03 22:32:19 +01:00
else
2018-02-24 17:41:57 +01:00
Logger " ${ FUNCNAME [0] } called by [ $id ] finished monitoring pid [ $pid ] with exitcode [ $retval ]. " "DEBUG"
2016-08-22 09:11:32 +02:00
fi
fi
fi
done
2018-02-24 17:41:57 +01:00
# hasPids can be false on last iteration in ParallelExec mode
2016-08-06 16:16:19 +02:00
pidsArray = ( " ${ newPidsArray [@] } " )
2018-01-03 22:32:19 +01:00
2016-08-31 11:26:21 +02:00
# Trivial wait time for bash to not eat up all CPU
2016-11-30 14:04:41 +01:00
sleep $sleepTime
2017-06-09 09:58:51 +02:00
2018-02-24 17:41:57 +01:00
}
while [ ${# pidsArray [@] } -gt 0 ] || [ $counter -lt $mainItemCount ] || [ $postponedItemCount -ne 0 ] ; do
_ExecTasksTimeCheck
retval = $?
if [ $retval -ne 0 ] ; then
return $retval ;
fi
# The following execution bloc is only needed in ParallelExec mode since WaitForTaskCompletion does not execute commands, but only monitors them
if [ $functionMode = = "ParallelExec" ] ; then
while [ ${# pidsArray [@] } -lt $numberOfProcesses ] && ( [ $counter -lt $mainItemCount ] || [ $postponedItemCount -ne 0 ] ) ; do
_ExecTasksTimeCheck
retval = $?
if [ $retval -ne 0 ] ; then
return $retval ;
fi
executeCommand = false
isPostponedCommand = false
currentCommand = ""
currentCommandCondition = ""
needsPostponing = false
if [ $readFromFile = = true ] ; then
# awk identifies first line as 1 instead of 0 so we need to increase counter
currentCommand = $( awk 'NR == num_line {print; exit}' num_line = $(( counter+1)) " $mainInput " )
if [ $auxItemCount -ne 0 ] ; then
currentCommandCondition = $( awk 'NR == num_line {print; exit}' num_line = $(( counter+1)) " $auxInput " )
fi
# Check if we need to fetch postponed commands
if [ " $currentCommand " = = "" ] ; then
currentCommand = $( awk 'NR == num_line {print; exit}' num_line = $(( postponedCounter+1)) " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } -postponedMain. $id . $SCRIPT_PID . $TSTAMP " )
currentCommandCondition = $( awk 'NR == num_line {print; exit}' num_line = $(( postponedCounter+1)) " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } -postponedAux. $id . $SCRIPT_PID . $TSTAMP " )
isPostponedCommand = true
fi
else
currentCommand = " ${ commandsArray [ $counter ] } "
if [ $auxItemCount -ne 0 ] ; then
currentCommandCondition = " ${ commandsConditionArray [ $counter ] } "
fi
if [ " $currentCommand " = = "" ] ; then
currentCommand = " ${ postponedCommandsArray [ $postponedCounter ] } "
currentCommandCondition = " ${ postponedCommandsConditionArray [ $postponedCounter ] } "
isPostponedCommand = true
fi
fi
# Check if we execute postponed commands, or if we delay them
if [ $isPostponedCommand = = true ] ; then
# Get first value before '@'
postponedExecTime = " ${ currentCommand %%@* } "
postponedExecTime = $(( SECONDS-postponedExecTime))
# Get everything after first '@'
temp = " ${ currentCommand #*@ } "
# Get first value before '@'
postponedRetryCount = " ${ temp %%@* } "
# Replace currentCommand with actual filtered currentCommand
currentCommand = " ${ temp #*@ } "
# Since we read a postponed command, we may decrase postponedItemCounter
postponedItemCount = $(( postponedItemCount-1))
#Since we read one line, we need to increase the counter
postponedCounter = $(( postponedCounter+1))
else
postponedRetryCount = 0
postponedExecTime = 0
fi
2020-03-15 22:58:12 +01:00
if ( [ $postponedRetryCount -lt $maxPostponeRetries ] && [ $postponedExecTime -ge $minTimeBetweenRetries ] ) || [ $isPostponedCommand = = false ] ; then
2018-02-24 17:41:57 +01:00
if [ " $currentCommandCondition " != "" ] ; then
Logger " Checking condition [ $currentCommandCondition ] for command [ $currentCommand ]. " "DEBUG"
eval " $currentCommandCondition " &
ExecTasks $! "subConditionCheck" false 0 0 1800 3600 true $SLEEP_TIME $KEEP_LOGGING true true true
subRetval = $?
if [ $subRetval -ne 0 ] ; then
# is postponing enabled ?
if [ $maxPostponeRetries -gt 0 ] ; then
Logger " Condition [ $currentCommandCondition ] not met for command [ $currentCommand ]. Exit code [ $subRetval ]. Postponing command. " "NOTICE"
postponedRetryCount = $(( postponedRetryCount+1))
if [ $postponedRetryCount -ge $maxPostponeRetries ] ; then
Logger " Max retries reached for postponed command [ $currentCommand ]. Skipping command. " "NOTICE"
else
needsPostponing = true
fi
postponedExecTime = 0
else
Logger " Condition [ $currentCommandCondition ] not met for command [ $currentCommand ]. Exit code [ $subRetval ]. Ignoring command. " "NOTICE"
fi
else
executeCommand = true
fi
else
executeCommand = true
fi
else
needsPostponing = true
fi
if [ $needsPostponing = = true ] ; then
postponedItemCount = $(( postponedItemCount+1))
if [ $readFromFile = = true ] ; then
echo " $(( SECONDS-postponedExecTime)) @ $postponedRetryCount @ $currentCommand " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } -postponedMain. $id . $SCRIPT_PID . $TSTAMP "
echo " $currentCommandCondition " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } -postponedAux. $id . $SCRIPT_PID . $TSTAMP "
else
postponedCommandsArray += ( " $(( SECONDS-postponedExecTime)) @ $postponedRetryCount @ $currentCommand " )
postponedCommandsConditionArray += ( " $currentCommandCondition " )
fi
fi
if [ $executeCommand = = true ] ; then
Logger " Running command [ $currentCommand ]. " "DEBUG"
2019-01-03 10:10:08 +01:00
randomOutputName = $( date '+%Y%m%dT%H%M%S' ) .$( PoorMansRandomGenerator 5)
2019-05-21 11:46:07 +02:00
eval " $currentCommand " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $id . $pid . $randomOutputName . $SCRIPT_PID . $TSTAMP " 2>& 1 &
2018-02-24 17:41:57 +01:00
pid = $!
pidsArray += ( $pid )
commandsArrayPid[ $pid ] = " $currentCommand "
2019-05-21 11:46:07 +02:00
commandsArrayOutput[ $pid ] = " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $id . $pid . $randomOutputName . $SCRIPT_PID . $TSTAMP "
2018-02-24 17:41:57 +01:00
# Initialize pid execution time array
pidsTimeArray[ $pid ] = 0
else
Logger " Skipping command [ $currentCommand ]. " "DEBUG"
fi
if [ $isPostponedCommand = = false ] ; then
counter = $(( counter+1))
fi
_ExecTasksPidsCheck
done
fi
_ExecTasksPidsCheck
2016-08-06 16:16:19 +02:00
done
2016-08-22 09:11:32 +02:00
# Return exit code if only one process was monitored, else return number of errors
2016-11-30 14:04:41 +01:00
# As we cannot return multiple values, a global variable WAIT_FOR_TASK_COMPLETION contains all pids with their return value
2018-01-03 22:32:19 +01:00
2018-11-06 15:33:16 +01:00
eval " WAIT_FOR_TASK_COMPLETION_ $id =\" $failedPidsList \" "
2018-01-03 22:32:19 +01:00
if [ $mainItemCount -eq 1 ] ; then
2016-11-30 14:04:41 +01:00
return $retval
2016-08-22 09:11:32 +02:00
else
return $errorcount
fi
2016-08-06 16:16:19 +02:00
}
2016-04-14 18:01:18 +02:00
# Usage: var=$(StripSingleQuotes "$var")
2016-03-04 09:34:02 +01:00
function StripSingleQuotes {
local string = " ${ 1 } "
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
string = " ${ string /# \' / } " # Remove singlequote if it begins string
string = " ${ string /% \' / } " # Remove singlequote if it ends string
echo " $string "
}
2016-04-14 18:01:18 +02:00
# Usage: var=$(StripDoubleQuotes "$var")
2016-03-04 09:34:02 +01:00
function StripDoubleQuotes {
local string = " ${ 1 } "
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
string = " ${ string /# \" / } "
string = " ${ string /% \" / } "
echo " $string "
}
function StripQuotes {
local string = " ${ 1 } "
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
echo " $( StripSingleQuotes $( StripDoubleQuotes $string ) ) "
}
2016-09-08 22:51:24 +02:00
# Usage var=$(EscapeSpaces "$var") or var="$(EscapeSpaces "$var")"
2016-03-04 09:34:02 +01:00
function EscapeSpaces {
local string = " ${ 1 } " # String on which spaces will be escaped
2016-11-10 16:25:37 +01:00
2016-09-08 22:51:24 +02:00
echo " ${ string // / \\ } "
2016-03-04 09:34:02 +01:00
}
2018-07-30 15:36:53 +02:00
# Usage var=$(EscapeDoubleQuotes "$var") or var="$(EscapeDoubleQuotes "$var")"
function EscapeDoubleQuotes {
local value = " ${ 1 } "
2019-01-03 10:10:08 +01:00
2018-07-30 15:36:53 +02:00
echo " ${ value // \" / \\ \" } "
}
2016-11-10 16:25:37 +01:00
# Usage [ $(IsNumeric $var) -eq 1 ]
2016-09-08 22:51:24 +02:00
function IsNumeric {
local value = " ${ 1 } "
2018-07-30 15:36:53 +02:00
if type expr > /dev/null 2>& 1; then
2018-11-06 15:33:16 +01:00
expr " $value " : '^[-+]\{0,1\}[0-9]*\.\{0,1\}[0-9]\{1,\}$' > /dev/null 2>& 1
2018-07-30 15:36:53 +02:00
if [ $? -eq 0 ] ; then
echo 1
else
echo 0
fi
2016-11-10 16:25:37 +01:00
else
2018-11-06 15:33:16 +01:00
if [ [ $value = ~ ^[ -+] ?[ 0-9] +( [ .] [ 0-9] +) ?$ ] ] ; then
2018-07-30 15:36:53 +02:00
echo 1
else
echo 0
fi
2016-11-10 16:25:37 +01:00
fi
}
2018-11-06 15:33:16 +01:00
function IsNumericExpand {
eval " local value=\" ${ 1 } \" " # Needed eval so variable variables can be processed
echo $( IsNumeric " $value " )
}
2016-11-10 16:25:37 +01:00
# Converts human readable sizes into integer kilobyte sizes
# Usage numericSize="$(HumanToNumeric $humanSize)"
function HumanToNumeric {
local value = " ${ 1 } "
local notation
local suffix
local suffixPresent
local multiplier
notation = ( K M G T P E)
for suffix in " ${ notation [@] } " ; do
multiplier = $(( multiplier+1))
if [ [ " $value " = = *" $suffix " * ] ] ; then
suffixPresent = $suffix
break;
fi
done
if [ " $suffixPresent " != "" ] ; then
value = ${ value % $suffix * }
value = ${ value %.* }
# /1024 since we convert to kilobytes instead of bytes
value = $(( value*( 1024 * * multiplier/1024)) )
2016-09-08 22:51:24 +02:00
else
2016-11-10 16:25:37 +01:00
value = ${ value %.* }
2016-09-08 22:51:24 +02:00
fi
2016-11-10 16:25:37 +01:00
echo $value
2016-09-08 22:51:24 +02:00
}
2018-07-30 15:36:53 +02:00
# Checks email address validity
function CheckRFC822 {
local mail = " ${ 1 } "
local rfc822 = " ^[a-z0-9!#\$%&'*+/=?^_\`{|}~-]+(\.[a-z0-9!# $%&'*+/=?^_\`{|}~-]+)*@([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z0-9]([a-z0-9-]*[a-z0-9])?\$ "
if [ [ $mail = ~ $rfc822 ] ] ; then
echo 1
else
echo 0
fi
}
## Modified version of https://gist.github.com/cdown/1163649
2017-01-04 09:00:47 +01:00
function UrlEncode {
2016-05-26 22:34:08 +02:00
local length = " ${# 1 } "
2018-07-30 15:36:53 +02:00
local i
2016-05-26 22:34:08 +02:00
local LANG = C
2018-07-30 15:36:53 +02:00
for i in $( seq 0 $(( length-1)) ) ; do
2016-05-26 22:34:08 +02:00
local c = " ${ 1 : i : 1 } "
case $c in
[ a-zA-Z0-9.~_-] )
printf " $c "
; ;
*)
printf '%%%02X' " ' $c "
; ;
esac
done
}
2017-01-04 09:00:47 +01:00
function UrlDecode {
2016-11-10 16:25:37 +01:00
local urlEncoded = " ${ 1 //+/ } "
printf '%b' " ${ urlEncoded //%/ \\ x } "
}
## Modified version of http://stackoverflow.com/a/8574392
2017-01-04 09:00:47 +01:00
## Usage: [ $(ArrayContains "needle" "${haystack[@]}") -eq 1 ]
function ArrayContains ( ) {
local needle = " ${ 1 } "
local haystack = " ${ 2 } "
2016-11-10 16:25:37 +01:00
local e
2017-01-04 09:00:47 +01:00
if [ " $needle " != "" ] && [ " $haystack " != "" ] ; then
for e in " ${ @ : 2 } " ; do
if [ " $e " = = " $needle " ] ; then
echo 1
return
fi
done
2016-11-10 16:25:37 +01:00
fi
2017-01-04 09:00:47 +01:00
echo 0
return
2016-05-26 22:34:08 +02:00
}
2015-11-19 23:04:02 +01:00
function GetLocalOS {
2016-11-10 16:25:37 +01:00
local localOsVar
2017-03-14 22:31:15 +01:00
local localOsName
local localOsVer
2016-02-19 22:14:13 +01:00
2018-01-03 22:32:19 +01:00
# There is no good way to tell if currently running in BusyBox shell. Using sluggish way.
2016-11-17 21:02:15 +01:00
if ls --help 2>& 1 | grep -i "BusyBox" > /dev/null; then
2016-11-10 16:25:37 +01:00
localOsVar = "BusyBox"
2018-11-06 15:33:16 +01:00
elif set -o | grep "winxp" > /dev/null; then
localOsVar = "BusyBox-w32"
2016-11-10 16:25:37 +01:00
else
2016-11-30 14:04:41 +01:00
# Detecting the special ubuntu userland in Windows 10 bash
if grep -i Microsoft /proc/sys/kernel/osrelease > /dev/null 2>& 1; then
localOsVar = "Microsoft"
else
2017-01-04 09:00:47 +01:00
localOsVar = " $( uname -spior 2>& 1) "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-30 14:04:41 +01:00
localOsVar = " $( uname -v 2>& 1) "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-30 14:04:41 +01:00
localOsVar = " $( uname) "
fi
2016-11-10 16:25:37 +01:00
fi
2015-11-19 23:04:02 +01:00
fi
fi
2016-11-10 16:25:37 +01:00
case $localOsVar in
2016-11-30 14:04:41 +01:00
# Android uname contains both linux and android, keep it before linux entry
*"Android" *)
LOCAL_OS = "Android"
; ;
2015-11-19 23:04:02 +01:00
*"Linux" *)
LOCAL_OS = "Linux"
; ;
*"BSD" *)
LOCAL_OS = "BSD"
; ;
2017-06-09 09:58:51 +02:00
*"MINGW32" *| *"MINGW64" *| *"MSYS" *)
2015-11-19 23:04:02 +01:00
LOCAL_OS = "msys"
; ;
2017-01-04 09:00:47 +01:00
*"CYGWIN" *)
LOCAL_OS = "Cygwin"
; ;
2018-11-06 15:33:16 +01:00
*"Microsoft" *| *"MS/Windows" *)
2016-11-30 14:04:41 +01:00
LOCAL_OS = "WinNT10"
; ;
2015-11-19 23:04:02 +01:00
*"Darwin" *)
LOCAL_OS = "MacOSX"
; ;
2016-11-10 16:25:37 +01:00
*"BusyBox" *)
2016-11-30 14:04:41 +01:00
LOCAL_OS = "BusyBox"
2016-11-10 16:25:37 +01:00
; ;
2015-11-19 23:04:02 +01:00
*)
2019-02-26 12:09:50 +01:00
if [ " $IGNORE_OS_TYPE " = = true ] ; then
2016-11-10 16:25:37 +01:00
Logger " Running on unknown local OS [ $localOsVar ]. " "WARN"
2016-03-20 16:49:29 +01:00
return
fi
2017-01-04 09:00:47 +01:00
if [ " $_OFUNCTIONS_VERSION " != "" ] ; then
Logger " Running on >> $localOsVar << not supported. Please report to the author. " "ERROR"
fi
2015-11-19 23:04:02 +01:00
exit 1
; ;
esac
2017-01-04 09:00:47 +01:00
2017-03-14 22:31:15 +01:00
# Get linux versions
if [ -f "/etc/os-release" ] ; then
2020-03-15 22:58:12 +01:00
localOsName = " $( GetConfFileValue "/etc/os-release" "NAME" true ) "
localOsVer = " $( GetConfFileValue "/etc/os-release" "VERSION" true ) "
2018-07-30 15:36:53 +02:00
elif [ " $LOCAL_OS " = = "BusyBox" ] ; then
2020-03-15 22:58:12 +01:00
localOsVer = " $( ls --help 2>& 1 | head -1 | cut -f2 -d' ' ) "
2018-07-30 15:36:53 +02:00
localOsName = "BusyBox"
fi
# Get Host info for Windows
2018-11-06 15:33:16 +01:00
if [ " $LOCAL_OS " = = "msys" ] || [ " $LOCAL_OS " = = "BusyBox" ] || [ " $LOCAL_OS " = = "Cygwin" ] || [ " $LOCAL_OS " = = "WinNT10" ] ; then
localOsVar = " $localOsVar $( uname -a) "
2018-07-30 15:36:53 +02:00
if [ " $PROGRAMW6432 " != "" ] ; then
LOCAL_OS_BITNESS = 64
LOCAL_OS_FAMILY = "Windows"
elif [ " $PROGRAMFILES " != "" ] ; then
LOCAL_OS_BITNESS = 32
LOCAL_OS_FAMILY = "Windows"
# Case where running on BusyBox but no program files defined
elif [ " $LOCAL_OS " = = "BusyBox" ] ; then
LOCAL_OS_FAMILY = "Unix"
fi
# Get Host info for Unix
else
LOCAL_OS_FAMILY = "Unix"
2018-11-06 15:33:16 +01:00
fi
if [ " $LOCAL_OS_FAMILY " = = "Unix" ] ; then
2018-07-30 15:36:53 +02:00
if uname -m | grep '64' > /dev/null 2>& 1; then
LOCAL_OS_BITNESS = 64
else
LOCAL_OS_BITNESS = 32
fi
2017-03-14 22:31:15 +01:00
fi
2018-07-30 15:36:53 +02:00
LOCAL_OS_FULL = " $localOsVar ( $localOsName $localOsVer ) $LOCAL_OS_BITNESS -bit $LOCAL_OS_FAMILY "
2017-06-09 09:58:51 +02:00
if [ " $_OFUNCTIONS_VERSION " != "" ] ; then
Logger " Local OS: [ $LOCAL_OS_FULL ]. " "DEBUG"
fi
2015-11-19 23:04:02 +01:00
}
2017-06-09 09:58:51 +02:00
2016-11-10 16:25:37 +01:00
function GetRemoteOS {
2016-02-19 22:14:13 +01:00
2019-02-26 12:09:50 +01:00
if [ " $REMOTE_OPERATION " != true ] ; then
2016-11-30 14:04:41 +01:00
return 0
fi
2016-11-10 16:25:37 +01:00
local remoteOsVar
2016-02-19 22:14:13 +01:00
2017-06-09 09:58:51 +02:00
$SSH_CMD env LC_ALL = C env _REMOTE_TOKEN = " $_REMOTE_TOKEN " bash -s << 'ENDSSH' >> "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID .$TSTAMP " 2>&1
2020-03-15 22:58:12 +01:00
_REMOTE_TOKEN = "(o_0)"
2016-11-10 16:25:37 +01:00
2016-11-17 21:02:15 +01:00
function GetOs {
local localOsVar
2017-03-14 22:31:15 +01:00
local localOsName
local localOsVer
2018-07-30 15:36:53 +02:00
local localOsBitness
local localOsFamily
2016-11-17 21:02:15 +01:00
2017-06-09 09:58:51 +02:00
local osInfo = "/etc/os-release"
2018-01-03 22:32:19 +01:00
# There is no good way to tell if currently running in BusyBox shell. Using sluggish way.
2016-11-17 21:02:15 +01:00
if ls --help 2>& 1 | grep -i "BusyBox" > /dev/null; then
localOsVar = "BusyBox"
else
2016-11-30 14:04:41 +01:00
# Detecting the special ubuntu userland in Windows 10 bash
if grep -i Microsoft /proc/sys/kernel/osrelease > /dev/null 2>& 1; then
localOsVar = "Microsoft"
else
2017-01-04 09:00:47 +01:00
localOsVar = " $( uname -spior 2>& 1) "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-30 14:04:41 +01:00
localOsVar = " $( uname -v 2>& 1) "
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2016-11-30 14:04:41 +01:00
localOsVar = " $( uname) "
fi
2015-11-19 23:04:02 +01:00
fi
fi
2016-11-17 21:02:15 +01:00
fi
2017-03-14 22:31:15 +01:00
# Get linux versions
2017-06-09 09:58:51 +02:00
if [ -f " $osInfo " ] ; then
localOsName = $( grep "^NAME=" " $osInfo " )
2018-02-24 17:41:57 +01:00
localOsName = " ${ localOsName ##*= } "
2017-06-09 09:58:51 +02:00
localOsVer = $( grep "^VERSION=" " $osInfo " )
localOsVer = " ${ localOsVer ##*= } "
2018-07-30 15:36:53 +02:00
elif [ " $localOsVar " = = "BusyBox" ] ; then
2020-03-15 22:58:12 +01:00
localOsVer = $( ls --help 2>& 1 | head -1 | cut -f2 -d' ' )
2018-07-30 15:36:53 +02:00
localOsName = "BusyBox"
2017-03-14 22:31:15 +01:00
fi
2018-07-30 15:36:53 +02:00
# Get Host info for Windows
case $localOsVar in
*"MINGW32" *| *"MINGW64" *| *"MSYS" *| *"CYGWIN*" | *"Microsoft" *| *"WinNT10*" )
if [ " $PROGRAMW6432 " != "" ] ; then
localOsBitness = 64
localOsFamily = "Windows"
elif [ " $PROGRAMFILES " != "" ] ; then
localOsBitness = 32
localOsFamily = "Windows"
# Case where running on BusyBox but no program files defined
elif [ " $localOsVar " = = "BusyBox" ] ; then
localOsFamily = "Unix"
fi
; ;
*)
localOsFamily = "Unix"
if uname -m | grep '64' > /dev/null 2>& 1; then
localOsBitness = 64
else
localOsBitness = 32
fi
; ;
esac
echo " $localOsVar ( $localOsName $localOsVer ) $localOsBitness -bit $localOsFamily "
2016-11-17 21:02:15 +01:00
}
GetOs
ENDSSH
2019-05-21 11:46:07 +02:00
if [ $? -ne 0 ] ; then
2020-03-15 22:58:12 +01:00
Logger " Cannot connect to remote system [ $REMOTE_HOST ] port [ $REMOTE_PORT ] as [ $REMOTE_USER ]. " "CRITICAL"
2018-07-30 15:36:53 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-03-15 22:58:12 +01:00
Logger " $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2018-07-30 15:36:53 +02:00
fi
2018-02-24 17:41:57 +01:00
exit 1
fi
2015-11-19 23:04:02 +01:00
2017-01-04 09:00:47 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-03-15 22:58:12 +01:00
remoteOsVar = " $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) "
2016-11-10 16:25:37 +01:00
case $remoteOsVar in
2016-11-30 14:04:41 +01:00
*"Android" *)
REMOTE_OS = "Android"
; ;
2015-11-19 23:04:02 +01:00
*"Linux" *)
REMOTE_OS = "Linux"
; ;
*"BSD" *)
REMOTE_OS = "BSD"
; ;
2017-06-09 09:58:51 +02:00
*"MINGW32" *| *"MINGW64" *| *"MSYS" *)
2015-11-19 23:04:02 +01:00
REMOTE_OS = "msys"
; ;
2017-01-04 09:00:47 +01:00
*"CYGWIN" *)
REMOTE_OS = "Cygwin"
; ;
2016-11-30 14:04:41 +01:00
*"Microsoft" *)
REMOTE_OS = "WinNT10"
; ;
2015-11-19 23:04:02 +01:00
*"Darwin" *)
REMOTE_OS = "MacOSX"
; ;
2016-11-10 16:25:37 +01:00
*"BusyBox" *)
2016-11-30 14:04:41 +01:00
REMOTE_OS = "BusyBox"
2016-11-10 16:25:37 +01:00
; ;
2015-11-19 23:04:02 +01:00
*"ssh" *| *"SSH" *)
Logger "Cannot connect to remote system." "CRITICAL"
exit 1
; ;
*)
2019-02-26 12:09:50 +01:00
if [ " $IGNORE_OS_TYPE " = = true ] ; then #DOC: Undocumented debug only setting
2016-11-10 16:25:37 +01:00
Logger " Running on unknown remote OS [ $remoteOsVar ]. " "WARN"
2016-03-20 16:49:29 +01:00
return
fi
2015-11-19 23:04:02 +01:00
Logger "Running on remote OS failed. Please report to the author if the OS is not supported." "CRITICAL"
2016-11-10 16:25:37 +01:00
Logger " Remote OS said:\n $remoteOsVar " "CRITICAL"
2015-11-19 23:04:02 +01:00
exit 1
esac
2016-11-10 16:25:37 +01:00
Logger " Remote OS: [ $remoteOsVar ]. " "DEBUG"
2016-11-17 21:02:15 +01:00
else
Logger "Cannot get Remote OS" "CRITICAL"
2015-11-19 23:04:02 +01:00
fi
}
function RunLocalCommand {
local command = " ${ 1 } " # Command to run
2016-11-10 16:25:37 +01:00
local hardMaxTime = " ${ 2 } " # Max time to wait for command to compleet
2015-11-19 23:04:02 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = true ] ; then
2015-11-19 23:04:02 +01:00
Logger " Dryrun: Local command [ $command ] not run. " "NOTICE"
return 0
fi
Logger " Running command [ $command ] on local host. " "NOTICE"
2017-01-04 09:00:47 +01:00
eval " $command " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " 2>& 1 &
2016-11-30 14:04:41 +01:00
2018-03-15 10:01:34 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 0 $hardMaxTime true $SLEEP_TIME $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
if [ $retval -eq 0 ] ; then
Logger "Command succeded." "NOTICE"
else
Logger "Command failed." "ERROR"
fi
2016-11-17 21:02:15 +01:00
if [ $_LOGGER_VERBOSE = = true ] || [ $retval -ne 0 ] ; then
2020-03-15 22:58:12 +01:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "NOTICE"
2015-11-19 23:04:02 +01:00
fi
2020-05-03 10:08:02 +02:00
return $retval
2015-11-19 23:04:02 +01:00
}
## Runs remote command $1 and waits for completition in $2 seconds
function RunRemoteCommand {
local command = " ${ 1 } " # Command to run
2016-11-10 16:25:37 +01:00
local hardMaxTime = " ${ 2 } " # Max time to wait for command to compleet
2015-11-19 23:04:02 +01:00
2017-03-14 22:31:15 +01:00
2019-02-26 12:09:50 +01:00
if [ " $REMOTE_OPERATION " != true ] ; then
2017-03-14 22:31:15 +01:00
Logger " Ignoring remote command [ $command ] because remote host is not configured. " "WARN"
return 0
fi
2015-11-19 23:04:02 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = true ] ; then
2015-11-19 23:04:02 +01:00
Logger " Dryrun: Local command [ $command ] not run. " "NOTICE"
return 0
fi
Logger " Running command [ $command ] on remote host. " "NOTICE"
2017-06-09 09:58:51 +02:00
cmd = $SSH_CMD ' "env LC_ALL=C env _REMOTE_TOKEN="' $_REMOTE_TOKEN '" $command" > "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID .$TSTAMP '" 2>&1'
2015-11-19 23:04:02 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2018-03-15 10:01:34 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 0 $hardMaxTime true $SLEEP_TIME $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
if [ $retval -eq 0 ] ; then
Logger "Command succeded." "NOTICE"
else
Logger "Command failed." "ERROR"
fi
2020-05-03 10:08:02 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] && ( [ $_LOGGER_VERBOSE = = true ] || [ $retval -ne 0 ] ) ; then
2020-03-15 22:58:12 +01:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "NOTICE"
2015-11-19 23:04:02 +01:00
fi
2020-05-03 10:08:02 +02:00
return $retval
2015-11-19 23:04:02 +01:00
}
function RunBeforeHook {
2016-11-10 16:25:37 +01:00
local pids
2016-08-06 16:16:19 +02:00
2015-11-19 23:04:02 +01:00
if [ " $LOCAL_RUN_BEFORE_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunLocalCommand " $LOCAL_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE &
pids = " $! "
2015-11-19 23:04:02 +01:00
fi
if [ " $REMOTE_RUN_BEFORE_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunRemoteCommand " $REMOTE_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE &
pids = " $pids ; $! "
fi
if [ " $pids " != "" ] ; then
2018-03-15 10:01:34 +01:00
ExecTasks $pids " ${ FUNCNAME [0] } " false 0 0 0 0 true $SLEEP_TIME $KEEP_LOGGING
2020-05-03 10:08:02 +02:00
retval = $?
fi
echo " ert= $retval "
if [ " $STOP_ON_CMD_ERROR " = = true ] && [ $retval -ne 0 ] ; then
Logger "Stopping on command execution error." "CRITICAL"
exit 1
2015-11-19 23:04:02 +01:00
fi
}
function RunAfterHook {
2016-08-06 16:16:19 +02:00
local pids
2015-11-19 23:04:02 +01:00
if [ " $LOCAL_RUN_AFTER_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunLocalCommand " $LOCAL_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER &
pids = " $! "
2015-11-19 23:04:02 +01:00
fi
if [ " $REMOTE_RUN_AFTER_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunRemoteCommand " $REMOTE_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER &
pids = " $pids ; $! "
fi
if [ " $pids " != "" ] ; then
2018-03-15 10:01:34 +01:00
ExecTasks $pids " ${ FUNCNAME [0] } " false 0 0 0 0 true $SLEEP_TIME $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
fi
}
function CheckConnectivityRemoteHost {
2016-09-08 22:51:24 +02:00
local retval
2015-11-19 23:04:02 +01:00
2019-02-26 12:09:50 +01:00
if [ " $REMOTE_HOST_PING " != false ] && [ " $REMOTE_OPERATION " != false ] ; then
2015-11-19 23:04:02 +01:00
eval " $PING_CMD $REMOTE_HOST > /dev/null 2>&1 " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 60 180 true $SLEEP_TIME $KEEP_LOGGING
2016-09-08 22:51:24 +02:00
retval = $?
2019-05-21 11:46:07 +02:00
if [ $retval -ne 0 ] ; then
2016-11-10 16:25:37 +01:00
Logger " Cannot ping [ $REMOTE_HOST ]. Return code [ $retval ]. " "WARN"
2016-09-08 22:51:24 +02:00
return $retval
2015-11-19 23:04:02 +01:00
fi
fi
}
function CheckConnectivity3rdPartyHosts {
2016-11-10 16:25:37 +01:00
local remote3rdPartySuccess
2016-09-08 22:51:24 +02:00
local retval
2018-01-03 22:32:19 +01:00
local i
2016-08-08 15:49:48 +02:00
2015-11-19 23:04:02 +01:00
if [ " $REMOTE_3RD_PARTY_HOSTS " != "" ] ; then
2016-11-10 16:25:37 +01:00
remote3rdPartySuccess = false
2015-11-19 23:04:02 +01:00
for i in $REMOTE_3RD_PARTY_HOSTS
do
eval " $PING_CMD $i > /dev/null 2>&1 " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 60 180 true $SLEEP_TIME $KEEP_LOGGING
2016-09-08 22:51:24 +02:00
retval = $?
2019-05-21 11:46:07 +02:00
if [ $retval -ne 0 ] ; then
2016-09-08 22:51:24 +02:00
Logger " Cannot ping 3rd party host [ $i ]. Return code [ $retval ]. " "NOTICE"
2015-11-19 23:04:02 +01:00
else
2016-11-10 16:25:37 +01:00
remote3rdPartySuccess = true
2015-11-19 23:04:02 +01:00
fi
done
2016-08-08 15:49:48 +02:00
2016-11-10 16:25:37 +01:00
if [ $remote3rdPartySuccess = = false ] ; then
Logger "No remote 3rd party host responded to ping. No internet ?" "WARN"
2015-11-19 23:04:02 +01:00
return 1
2016-08-08 15:49:48 +02:00
else
return 0
2015-11-19 23:04:02 +01:00
fi
fi
}
2016-03-01 19:35:40 +01:00
function RsyncPatternsAdd {
2016-11-10 16:25:37 +01:00
local patternType = " ${ 1 } " # exclude or include
2016-04-01 21:22:18 +02:00
local pattern = " ${ 2 } "
2016-03-01 19:35:40 +01:00
2016-08-08 15:49:48 +02:00
local rest
2016-03-01 19:35:40 +01:00
# Disable globbing so wildcards from exclusions do not get expanded
set -f
rest = " $pattern "
while [ -n " $rest " ]
do
# Take the string until first occurence until $PATH_SEPARATOR_CHAR
2017-01-04 09:00:47 +01:00
str = " ${ rest %% $PATH_SEPARATOR_CHAR * } "
2016-03-01 19:35:40 +01:00
# Handle the last case
2017-01-04 09:00:47 +01:00
if [ " $rest " = = " ${ rest / $PATH_SEPARATOR_CHAR / } " ] ; then
2016-03-01 19:35:40 +01:00
rest =
else
# Cut everything before the first occurence of $PATH_SEPARATOR_CHAR
2017-01-04 09:00:47 +01:00
rest = " ${ rest #* $PATH_SEPARATOR_CHAR } "
2016-03-01 19:35:40 +01:00
fi
if [ " $RSYNC_PATTERNS " = = "" ] ; then
2018-10-01 15:12:32 +02:00
RSYNC_PATTERNS = " -- $patternType =\" $str \" "
2016-03-01 19:35:40 +01:00
else
2018-10-01 15:12:32 +02:00
RSYNC_PATTERNS = " $RSYNC_PATTERNS -- $patternType =\" $str \" "
2016-03-01 19:35:40 +01:00
fi
done
set +f
}
function RsyncPatternsFromAdd {
2016-11-10 16:25:37 +01:00
local patternType = " ${ 1 } "
local patternFrom = " ${ 2 } "
2016-03-01 19:35:40 +01:00
2016-08-08 15:49:48 +02:00
## Check if the exclude list has a full path, and if not, add the config file path if there is one
2020-03-15 22:58:12 +01:00
if [ " $( basename " $patternFrom " ) " = = " $patternFrom " ] ; then
patternFrom = " $( dirname " $CONFIG_FILE " ) / $patternFrom "
2016-08-08 15:49:48 +02:00
fi
2016-03-01 19:35:40 +01:00
2016-11-10 16:25:37 +01:00
if [ -e " $patternFrom " ] ; then
2018-10-01 15:12:32 +02:00
RSYNC_PATTERNS = " $RSYNC_PATTERNS -- $patternType -from=\" $patternFrom \" "
2016-08-08 15:49:48 +02:00
fi
2016-03-01 19:35:40 +01:00
}
function RsyncPatterns {
2016-08-08 15:49:48 +02:00
if [ " $RSYNC_PATTERN_FIRST " = = "exclude" ] ; then
if [ " $RSYNC_EXCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd "exclude" " $RSYNC_EXCLUDE_PATTERN "
fi
if [ " $RSYNC_EXCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "exclude" " $RSYNC_EXCLUDE_FROM "
fi
if [ " $RSYNC_INCLUDE_PATTERN " != "" ] ; then
2018-01-03 22:32:19 +01:00
RsyncPatternsAdd "include" " $RSYNC_INCLUDE_PATTERN "
2016-08-08 15:49:48 +02:00
fi
if [ " $RSYNC_INCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "include" " $RSYNC_INCLUDE_FROM "
fi
2016-11-10 16:25:37 +01:00
# Use default include first for quicksync runs
elif [ " $RSYNC_PATTERN_FIRST " = = "include" ] || [ " $_QUICK_SYNC " = = "2" ] ; then
2016-08-08 15:49:48 +02:00
if [ " $RSYNC_INCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd "include" " $RSYNC_INCLUDE_PATTERN "
fi
if [ " $RSYNC_INCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "include" " $RSYNC_INCLUDE_FROM "
fi
if [ " $RSYNC_EXCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd "exclude" " $RSYNC_EXCLUDE_PATTERN "
fi
if [ " $RSYNC_EXCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "exclude" " $RSYNC_EXCLUDE_FROM "
fi
else
2020-03-15 22:58:12 +01:00
# osync target-helper specific clause
if [ " $_SYNC_ON_CHANGES " != "target" ] ; then
Logger "Bogus RSYNC_PATTERN_FIRST value in config file. Will not use rsync patterns." "WARN"
fi
2016-08-08 15:49:48 +02:00
fi
2016-03-01 19:35:40 +01:00
}
2015-11-19 23:04:02 +01:00
function PreInit {
2016-11-10 16:25:37 +01:00
local compressionString
2015-11-19 23:04:02 +01:00
## SSH compression
2019-02-26 12:09:50 +01:00
if [ " $SSH_COMPRESSION " != false ] ; then
2016-08-08 15:49:48 +02:00
SSH_COMP = -C
else
SSH_COMP =
fi
2015-11-19 23:04:02 +01:00
2016-03-25 20:07:27 +01:00
## Ignore SSH known host verification
2019-02-26 12:09:50 +01:00
if [ " $SSH_IGNORE_KNOWN_HOSTS " = = true ] ; then
2016-03-25 20:07:27 +01:00
SSH_OPTS = "-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
fi
2020-03-15 22:58:12 +01:00
## SSH ControlMaster Multiplexing
if [ " $SSH_CONTROLMASTER " = = true ] ; then
SSH_OPTS = " $SSH_OPTS -o ControlMaster=auto -o ControlPersist=yes -o ControlPath=\" $RUN_DIR / $PROGRAM .ctrlm.%r@%h. $SCRIPT_PID . $TSTAMP \" "
fi
## Optional SSH arguments
if [ " $SSH_OPTIONAL_ARGS " != "" ] ; then
SSH_OPTS = " $SSH_OPTS $SSH_OPTIONAL_ARGS "
fi
2016-08-08 15:49:48 +02:00
## Support for older config files without RSYNC_EXECUTABLE option
if [ " $RSYNC_EXECUTABLE " = = "" ] ; then
RSYNC_EXECUTABLE = rsync
fi
## Sudo execution option
2019-02-26 12:09:50 +01:00
if [ " $SUDO_EXEC " = = true ] ; then
2016-08-08 15:49:48 +02:00
if [ " $RSYNC_REMOTE_PATH " != "" ] ; then
RSYNC_PATH = " sudo $RSYNC_REMOTE_PATH / $RSYNC_EXECUTABLE "
else
RSYNC_PATH = " sudo $RSYNC_EXECUTABLE "
fi
2017-01-04 09:00:47 +01:00
COMMAND_SUDO = "sudo -E"
2016-08-08 15:49:48 +02:00
else
if [ " $RSYNC_REMOTE_PATH " != "" ] ; then
RSYNC_PATH = " $RSYNC_REMOTE_PATH / $RSYNC_EXECUTABLE "
else
RSYNC_PATH = " $RSYNC_EXECUTABLE "
fi
COMMAND_SUDO = ""
fi
2015-11-19 23:04:02 +01:00
2016-11-30 14:04:41 +01:00
## Set compression executable and extension
2020-05-03 10:08:02 +02:00
if [ " $( IsInteger " $COMPRESSION_LEVEL " ) " -eq 0 ] ; then
2016-11-10 16:25:37 +01:00
COMPRESSION_LEVEL = 3
fi
2017-01-04 09:00:47 +01:00
}
function PostInit {
# Define remote commands
if [ -f " $SSH_RSA_PRIVATE_KEY " ] ; then
2017-06-09 09:58:51 +02:00
SSH_CMD = " $( type -p ssh) $SSH_COMP -q -i $SSH_RSA_PRIVATE_KEY $SSH_OPTS $REMOTE_USER @ $REMOTE_HOST -p $REMOTE_PORT "
SCP_CMD = " $( type -p scp) $SSH_COMP -q -i $SSH_RSA_PRIVATE_KEY -P $REMOTE_PORT "
RSYNC_SSH_CMD = " $( type -p ssh) $SSH_COMP -q -i $SSH_RSA_PRIVATE_KEY $SSH_OPTS -p $REMOTE_PORT "
2017-01-04 09:00:47 +01:00
elif [ -f " $SSH_PASSWORD_FILE " ] ; then
2017-06-09 09:58:51 +02:00
SSH_CMD = " $( type -p sshpass) -f $SSH_PASSWORD_FILE $( type -p ssh) $SSH_COMP -q $SSH_OPTS $REMOTE_USER @ $REMOTE_HOST -p $REMOTE_PORT "
SCP_CMD = " $( type -p sshpass) -f $SSH_PASSWORD_FILE $( type -p scp) $SSH_COMP -q -P $REMOTE_PORT "
RSYNC_SSH_CMD = " $( type -p sshpass) -f $SSH_PASSWORD_FILE $( type -p ssh) $SSH_COMP -q $SSH_OPTS -p $REMOTE_PORT "
2017-01-04 09:00:47 +01:00
else
SSH_PASSWORD = ""
SSH_CMD = ""
SCP_CMD = ""
RSYNC_SSH_CMD = ""
fi
}
2016-11-10 16:25:37 +01:00
2017-01-04 09:00:47 +01:00
function SetCompression {
2018-01-03 22:32:19 +01:00
## Busybox fix (Termux xz command does not support compression at all)
2016-11-30 14:04:41 +01:00
if [ " $LOCAL_OS " = = "BusyBox" ] || [ " $REMOTE_OS " = = "Busybox" ] || [ " $LOCAL_OS " = = "Android" ] || [ " $REMOTE_OS " = = "Android" ] ; then
2016-11-10 16:25:37 +01:00
compressionString = ""
if type gzip > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | gzip -c $compressionString "
COMPRESSION_EXTENSION = .gz
# obackup specific
else
COMPRESSION_PROGRAM =
COMPRESSION_EXTENSION =
fi
2016-08-08 15:49:48 +02:00
else
2016-11-10 16:25:37 +01:00
compressionString = " - $COMPRESSION_LEVEL "
if type xz > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | xz -c $compressionString "
COMPRESSION_EXTENSION = .xz
elif type lzma > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | lzma -c $compressionString "
COMPRESSION_EXTENSION = .lzma
elif type pigz > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | pigz -c $compressionString "
COMPRESSION_EXTENSION = .gz
# obackup specific
2017-06-09 09:58:51 +02:00
COMPRESSION_OPTIONS = --rsyncable
2016-11-10 16:25:37 +01:00
elif type gzip > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | gzip -c $compressionString "
COMPRESSION_EXTENSION = .gz
# obackup specific
2017-06-09 09:58:51 +02:00
COMPRESSION_OPTIONS = --rsyncable
2016-11-10 16:25:37 +01:00
else
COMPRESSION_PROGRAM =
COMPRESSION_EXTENSION =
fi
2016-08-08 15:49:48 +02:00
fi
2017-06-09 11:50:10 +02:00
if [ " . ${ ALERT_LOG_FILE ##*. } " != " $COMPRESSION_EXTENSION " ] ; then
ALERT_LOG_FILE = " $ALERT_LOG_FILE $COMPRESSION_EXTENSION "
fi
2015-11-19 23:04:02 +01:00
}
2017-01-04 09:00:47 +01:00
function InitLocalOSDependingSettings {
2015-11-19 23:04:02 +01:00
2016-08-08 15:49:48 +02:00
## If running under Msys, some commands do not run the same way
## Using mingw version of find instead of windows one
## Getting running processes is quite different
## Ping command is not the same
2018-07-30 15:36:53 +02:00
if [ " $LOCAL_OS " = = "msys" ] || [ " $LOCAL_OS " = = "Cygwin" ] || [ " $LOCAL_OS " = = "Microsoft" ] || [ " $LOCAL_OS " = = "WinNT10" ] ; then
2020-03-15 22:58:12 +01:00
# Newer bash on Win10 finally uses integrated find command instead of windows one
if [ -f "/usr/bin/find" ] ; then
FIND_CMD = "/usr/bin/find"
elif [ -f "/bin/find" ] ; then
FIND_CMD = "/bin/find"
else
FIND_CMD = " $( dirname $BASH ) /find "
fi
# Newer bash on Windows 10 uses integrated ping whereas cygwin & msys use Windows version
if [ " $LOCAL_OS " = = "WinNT10" ] ; then
PING_CMD = "ping -c 2 -i 1"
else
PING_CMD = '$SYSTEMROOT\system32\ping -n 2'
fi
2017-03-14 22:31:15 +01:00
# On BSD, when not root, min ping interval is 1s
elif [ " $LOCAL_OS " = = "BSD" ] && [ " $LOCAL_USER " != "root" ] ; then
FIND_CMD = find
PING_CMD = "ping -c 2 -i 1"
2016-08-08 15:49:48 +02:00
else
FIND_CMD = find
PING_CMD = "ping -c 2 -i .2"
fi
2017-01-04 09:00:47 +01:00
if [ " $LOCAL_OS " = = "BusyBox" ] || [ " $LOCAL_OS " = = "Android" ] || [ " $LOCAL_OS " = = "msys" ] || [ " $LOCAL_OS " = = "Cygwin" ] ; then
2016-11-10 16:25:37 +01:00
PROCESS_STATE_CMD = "echo none"
2016-11-30 14:04:41 +01:00
DF_CMD = "df"
2016-11-10 16:25:37 +01:00
else
PROCESS_STATE_CMD = 'ps -p$pid -o state= 2 > /dev/null'
2016-11-30 14:04:41 +01:00
# CentOS 5 needs -P for one line output
DF_CMD = "df -P"
2016-11-10 16:25:37 +01:00
fi
2016-08-08 15:49:48 +02:00
## Stat command has different syntax on Linux and FreeBSD/MacOSX
if [ " $LOCAL_OS " = = "MacOSX" ] || [ " $LOCAL_OS " = = "BSD" ] ; then
2016-11-10 16:25:37 +01:00
# Tested on BSD and Mac
2016-08-08 15:49:48 +02:00
STAT_CMD = "stat -f \"%Sm\""
2016-04-06 20:40:20 +02:00
STAT_CTIME_MTIME_CMD = "stat -f %N;%c;%m"
2018-02-24 17:41:57 +01:00
SED_REGEX_ARG = "-E"
2016-08-08 15:49:48 +02:00
else
2016-11-30 14:04:41 +01:00
# Tested on GNU stat, busybox and Cygwin
2016-11-10 16:25:37 +01:00
STAT_CMD = "stat -c %y"
2016-04-06 20:40:20 +02:00
STAT_CTIME_MTIME_CMD = "stat -c %n;%Z;%Y"
2018-02-24 17:41:57 +01:00
SED_REGEX_ARG = "-r"
2016-08-08 15:49:48 +02:00
fi
2017-01-04 09:00:47 +01:00
# Set compression first time when we know what local os we have
SetCompression
2015-11-19 23:04:02 +01:00
}
2018-01-03 22:32:19 +01:00
# Gets executed regardless of the need of remote connections. It is just that this code needs to get executed after we know if there is a remote os, and if yes, which one
2017-01-04 09:00:47 +01:00
function InitRemoteOSDependingSettings {
2015-11-19 23:04:02 +01:00
2018-11-06 15:33:16 +01:00
if [ " $REMOTE_OS " = = "msys" ] || [ " $REMOTE_OS " = = "Cygwin" ] ; then
2020-03-15 22:58:12 +01:00
REMOTE_FIND_CMD = " $( dirname $BASH ) /find "
2016-08-08 15:49:48 +02:00
else
REMOTE_FIND_CMD = find
fi
2016-04-06 20:40:20 +02:00
2016-08-08 15:49:48 +02:00
## Stat command has different syntax on Linux and FreeBSD/MacOSX
2018-11-06 15:33:16 +01:00
if [ " $REMOTE_OS " = = "MacOSX" ] || [ " $REMOTE_OS " = = "BSD" ] ; then
2016-08-08 15:49:48 +02:00
REMOTE_STAT_CMD = "stat -f \"%Sm\""
2016-04-06 20:40:20 +02:00
REMOTE_STAT_CTIME_MTIME_CMD = "stat -f \\\"%N;%c;%m\\\""
2016-08-08 15:49:48 +02:00
else
REMOTE_STAT_CMD = "stat --format %y"
2016-04-06 20:40:20 +02:00
REMOTE_STAT_CTIME_MTIME_CMD = "stat -c \\\"%n;%Z;%Y\\\""
2016-08-08 15:49:48 +02:00
fi
2016-04-06 20:40:20 +02:00
2018-09-30 13:56:00 +02:00
## Set rsync default arguments (complete with -r or -d depending on recursivity later)
2018-09-30 14:01:28 +02:00
RSYNC_DEFAULT_ARGS = "-ltD -8"
2016-11-30 14:04:41 +01:00
if [ " $_DRYRUN " = = true ] ; then
RSYNC_DRY_ARG = "-n"
DRY_WARNING = "/!\ DRY RUN "
else
RSYNC_DRY_ARG = ""
fi
RSYNC_ATTR_ARGS = ""
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_PERMISSIONS " != false ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -p"
fi
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_OWNER " != false ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -o"
fi
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_GROUP " != false ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -g"
fi
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_EXECUTABILITY " != false ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " --executability"
fi
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_ACL " = = true ] ; then
2017-01-04 09:00:47 +01:00
if [ " $LOCAL_OS " != "MacOSX" ] && [ " $REMOTE_OS " != "MacOSX" ] && [ " $LOCAL_OS " != "msys" ] && [ " $REMOTE_OS " != "msys" ] && [ " $LOCAL_OS " != "Cygwin" ] && [ " $REMOTE_OS " != "Cygwin" ] && [ " $LOCAL_OS " != "BusyBox" ] && [ " $REMOTE_OS " != "BusyBox" ] && [ " $LOCAL_OS " != "Android" ] && [ " $REMOTE_OS " != "Android" ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -A"
2017-01-04 09:00:47 +01:00
else
Logger " Disabling ACL synchronization on [ $LOCAL_OS ] due to lack of support. " "NOTICE"
2016-11-30 14:04:41 +01:00
fi
2017-01-04 09:00:47 +01:00
fi
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_XATTR " = = true ] ; then
2017-01-04 09:00:47 +01:00
if [ " $LOCAL_OS " != "MacOSX" ] && [ " $REMOTE_OS " != "MacOSX" ] && [ " $LOCAL_OS " != "msys" ] && [ " $REMOTE_OS " != "msys" ] && [ " $LOCAL_OS " != "Cygwin" ] && [ " $REMOTE_OS " != "Cygwin" ] && [ " $LOCAL_OS " != "BusyBox" ] && [ " $REMOTE_OS " != "BusyBox" ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -X"
2017-01-04 09:00:47 +01:00
else
Logger " Disabling extended attributes synchronization on [ $LOCAL_OS ] due to lack of support. " "NOTICE"
2016-11-30 14:04:41 +01:00
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $RSYNC_COMPRESS " = = true ] ; then
2017-01-04 09:00:47 +01:00
if [ " $LOCAL_OS " != "MacOSX" ] && [ " $REMOTE_OS " != "MacOSX" ] ; then
2020-03-15 22:58:12 +01:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -zz --skip-compress=3fr/3g2/3gp/3gpp/7z/aac/ace/amr/apk/appx/appxbundle/arc/arj/arw/asf/avi/bz/bz2/cab/cr2/crypt[5678]/dat/dcr/deb/dmg/drc/ear/erf/flac/flv/gif/gpg/gz/iiq/jar/jp2/jpeg/jpg/h26[45]/k25/kdc/kgb/lha/lz/lzma/lzo/lzx/m4[apv]/mef/mkv/mos/mov/mp[34]/mpeg/mp[gv]/msi/nef/oga/ogg/ogv/opus/orf/pak/pef/png/qt/rar/r[0-9][0-9]/rz/rpm/rw2/rzip/s7z/sfark/sfx/sr2/srf/svgz/t[gb]z/tlz/txz/vob/wim/wma/wmv/xz/zip"
2017-01-04 09:00:47 +01:00
else
Logger " Disabling compression skips on synchronization on [ $LOCAL_OS ] due to lack of support. " "NOTICE"
fi
2016-11-30 14:04:41 +01:00
fi
2019-02-26 12:09:50 +01:00
if [ " $COPY_SYMLINKS " = = true ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -L"
2016-11-30 14:04:41 +01:00
fi
2019-02-26 12:09:50 +01:00
if [ " $KEEP_DIRLINKS " = = true ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -K"
2016-11-30 14:04:41 +01:00
fi
2017-01-04 09:00:47 +01:00
if [ " $RSYNC_OPTIONAL_ARGS " != "" ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " " $RSYNC_OPTIONAL_ARGS
2017-01-04 09:00:47 +01:00
fi
2019-02-26 12:09:50 +01:00
if [ " $PRESERVE_HARDLINKS " = = true ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -H"
2016-11-30 14:04:41 +01:00
fi
2019-02-26 12:09:50 +01:00
if [ " $CHECKSUM " = = true ] ; then
2016-11-30 14:04:41 +01:00
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " --checksum"
fi
if [ " $BANDWIDTH " != "" ] && [ " $BANDWIDTH " != "0" ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --bwlimit= $BANDWIDTH "
2016-11-30 14:04:41 +01:00
fi
2019-02-26 12:09:50 +01:00
if [ " $PARTIAL " = = true ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --partial --partial-dir=\" $PARTIAL_DIR \" "
2016-11-30 14:04:41 +01:00
RSYNC_PARTIAL_EXCLUDE = " --exclude=\" $PARTIAL_DIR \" "
fi
2019-02-26 12:09:50 +01:00
if [ " $DELTA_COPIES " != false ] ; then
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --no-whole-file"
2016-11-30 14:04:41 +01:00
else
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --whole-file"
2016-11-30 14:04:41 +01:00
fi
2017-01-04 09:00:47 +01:00
2018-01-03 22:32:19 +01:00
# Set compression options again after we know what remote OS we are dealing with
2017-01-04 09:00:47 +01:00
SetCompression
2018-09-30 13:56:00 +02:00
2018-09-30 14:24:50 +02:00
# Set recursive options
2018-09-30 13:56:00 +02:00
RSYNC_DEFAULT_NONRECURSIVE_ARGS = " -d $RSYNC_DEFAULT_ARGS "
2018-09-30 14:24:50 +02:00
RSYNC_DEFAULT_ARGS = " -r $RSYNC_DEFAULT_ARGS "
2016-11-30 14:04:41 +01:00
}
2016-08-18 14:23:57 +02:00
## IFS debug function
function PrintIFS {
printf "IFS is: %q" " $IFS "
}
2016-11-10 16:25:37 +01:00
# Process debugging
# Recursive function to get all parents from a pid
function ParentPid {
local pid = " ${ 1 } " # Pid to analyse
local parent
parent = $( ps -p $pid -o ppid = )
echo " $pid is a child of $parent "
if [ $parent -gt 0 ] ; then
ParentPid $parent
fi
}
2017-03-14 22:31:15 +01:00
# Neat version compare function found at http://stackoverflow.com/a/4025065/2635443
# Returns 0 if equal, 1 if $1 > $2 and 2 if $1 < $2
2017-06-09 09:58:51 +02:00
function VerComp ( ) {
if [ " $1 " = = "" ] || [ " $2 " = = "" ] ; then
Logger " Bogus Vercomp values [ $1 ] and [ $2 ]. " "WARN"
return 1
fi
2018-10-01 15:12:32 +02:00
if [ [ " $1 " = = " $2 " ] ]
2017-06-09 09:58:51 +02:00
then
echo 0
return
fi
local IFS = .
local i ver1 = ( $1 ) ver2 = ( $2 )
# fill empty fields in ver1 with zeros
for ( ( i = ${# ver1 [@] } ; i<${# ver2 [@] } ; i++) )
do
2018-02-24 17:41:57 +01:00
ver1[ i] = 0
2017-06-09 09:58:51 +02:00
done
for ( ( i = 0; i<${# ver1 [@] } ; i++) )
do
if [ [ -z ${ ver2 [i] } ] ]
then
# fill empty fields in ver2 with zeros
ver2[ i] = 0
fi
if ( ( 10#${ ver1 [i] } > 10#${ ver2 [i] } ) )
then
echo 1
return
2018-02-24 17:41:57 +01:00
fi
if ( ( 10#${ ver1 [i] } < 10#${ ver2 [i] } ) )
then
2017-06-09 09:58:51 +02:00
echo 2
2018-02-24 17:41:57 +01:00
return
fi
done
2017-06-09 09:58:51 +02:00
2018-02-24 17:41:57 +01:00
echo 0
2017-06-09 09:58:51 +02:00
return
2017-03-14 22:31:15 +01:00
}
function GetConfFileValue ( ) {
2018-02-24 17:41:57 +01:00
local file = " ${ 1 } "
local name = " ${ 2 } "
2018-01-03 22:32:19 +01:00
local noError = " ${ 3 :- false } "
2018-02-24 17:41:57 +01:00
local value
2017-03-14 22:31:15 +01:00
2018-02-24 17:41:57 +01:00
value = $( grep " ^ $name = " " $file " )
2019-05-21 11:46:07 +02:00
if [ $? -eq 0 ] ; then
2018-02-24 17:41:57 +01:00
value = " ${ value ##*= } "
echo " $value "
else
2018-01-03 22:32:19 +01:00
if [ $noError = = true ] ; then
2018-02-24 17:41:57 +01:00
Logger " Cannot get value for [ $name ] in config file [ $file ]. " "NOTICE"
2018-01-03 22:32:19 +01:00
else
Logger " Cannot get value for [ $name ] in config file [ $file ]. " "ERROR"
fi
2018-02-24 17:41:57 +01:00
fi
2017-03-14 22:31:15 +01:00
}
2018-01-03 22:32:19 +01:00
2017-03-14 22:31:15 +01:00
function SetConfFileValue ( ) {
2018-02-24 17:41:57 +01:00
local file = " ${ 1 } "
local name = " ${ 2 } "
local value = " ${ 3 } "
2017-03-14 22:31:15 +01:00
local separator = " ${ 4 :- # } "
2018-11-06 15:33:16 +01:00
if [ -f " $file " ] ; then
if grep " ^ $name = " " $file " > /dev/null 2>& 1; then
# Using -i.tmp for BSD compat
sed -i.tmp " s $separator ^ $name =.* $separator $name = $value $separator " " $file "
if [ $? -ne 0 ] ; then
Logger " Cannot update value [ $name ] to [ $value ] in config file [ $file ]. " "ERROR"
fi
rm -f " $file .tmp "
Logger " Set [ $name ] to [ $value ] in config file [ $file ]. " "DEBUG"
else
echo " $name = $value " >> " $file "
if [ $? -ne 0 ] ; then
Logger " Cannot create value [ $name ] to [ $value ] in config file [ $file ]. " "ERROR"
fi
fi
2018-02-24 17:41:57 +01:00
else
2018-11-06 15:33:16 +01:00
echo " $name = $value " > " $file "
if [ $? -ne 0 ] ; then
Logger " Config file [ $file ] does not exist. Failed to create it witn value [ $name ]. " "ERROR"
fi
2018-02-24 17:41:57 +01:00
fi
2017-03-14 22:31:15 +01:00
}
2017-01-04 09:00:47 +01:00
2017-06-09 09:58:51 +02:00
# Function can replace [ -f /some/file* ] tests
# Modified version of http://stackoverflow.com/a/6364244/2635443
function WildcardFileExists ( ) {
2018-02-24 17:41:57 +01:00
local file = " ${ 1 } "
local exists = 0
for f in $file ; do
## Check if the glob gets expanded to existing files.
## If not, f here will be exactly the pattern above
## and the exists test will evaluate to false.
if [ -e " $f " ] ; then
exists = 1
break
fi
done
if [ $exists -eq 1 ] ; then
echo 1
else
echo 0
fi
2017-06-09 09:58:51 +02:00
}
2020-03-15 22:58:12 +01:00
# Some MacOS versions might loose file ownsership when using mv from /tmp dir (see #175)
# This is a "mv" function wrapper that helps out with macOS
function FileMove ( ) {
local source = " ${ 1 } "
local dest = " ${ 2 } "
# If file is symlink or OS is not Mac, just make a standard mv
if [ -L " $source " ] || [ " $LOCAL_OS " != "MacOSX" ] ; then
mv -f " $source " " $dest "
return $?
elif [ -w " $source " ] ; then
[ -f " $dest " ] && rm -f " $dest "
cp -p " $source " " $dest " && rm -f " $source "
return $?
else
return -1
fi
}
2017-01-04 09:00:47 +01:00
# If using "include" statements, make sure the script does not get executed unless it's loaded by bootstrap
_OFUNCTIONS_BOOTSTRAP = true
[ " $_OFUNCTIONS_BOOTSTRAP " != true ] && echo " Please use bootstrap.sh to load this dev version of $( basename $0 ) " && exit 1
2015-11-12 01:26:38 +01:00
2016-08-06 14:04:35 +02:00
_LOGGER_PREFIX = "time"
2015-11-12 01:26:38 +01:00
## Working directory for partial downloads
PARTIAL_DIR = ".obackup_workdir_partial"
2016-09-08 22:51:24 +02:00
## File extension for encrypted files
2017-01-04 09:00:47 +01:00
CRYPT_FILE_EXTENSION = " . $PROGRAM .gpg "
2016-09-08 22:51:24 +02:00
2015-11-12 01:26:38 +01:00
# List of runtime created global variables
# $SQL_DISK_SPACE, disk space available on target for sql backups
# $FILE_DISK_SPACE, disk space available on target for file backups
# $SQL_BACKUP_TASKS, list of all databases to backup, space separated
# $SQL_EXCLUDED_TASKS, list of all database to exclude from backup, space separated
# $FILE_BACKUP_TASKS list of directories to backup, found in config file
# $FILE_RECURSIVE_BACKUP_TASKS, list of directories to backup, computed from config file recursive list
# $FILE_RECURSIVE_EXCLUDED_TASKS, list of all directories excluded from recursive list
2017-01-04 09:00:47 +01:00
# $FILE_SIZE_LIST, list of all directories to include in GetDirectoriesSize, enclosed by escaped doublequotes
2015-11-12 01:26:38 +01:00
2017-01-04 09:00:47 +01:00
# Assume that anything can be backed up unless proven otherwise
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = true
CAN_BACKUP_FILES = true
2015-11-12 01:26:38 +01:00
function TrapStop {
2016-03-03 16:33:59 +01:00
Logger "/!\ Manual exit of backup script. Backups may be in inconsistent state." "WARN"
2016-08-17 10:01:55 +02:00
exit 2
2015-11-12 01:26:38 +01:00
}
function TrapQuit {
2016-02-19 22:14:13 +01:00
local exitcode
2016-11-30 14:04:41 +01:00
# Get ERROR / WARN alert flags from subprocesses that call Logger
2017-01-04 09:00:47 +01:00
if [ -f " $RUN_DIR / $PROGRAM .Logger.warn. $SCRIPT_PID . $TSTAMP " ] ; then
WARN_ALERT = true
2016-11-30 14:04:41 +01:00
fi
2017-01-04 09:00:47 +01:00
if [ -f " $RUN_DIR / $PROGRAM .Logger.error. $SCRIPT_PID . $TSTAMP " ] ; then
ERROR_ALERT = true
2016-11-30 14:04:41 +01:00
fi
2016-08-31 11:26:21 +02:00
if [ $ERROR_ALERT = = true ] ; then
2019-02-26 12:09:50 +01:00
if [ " $RUN_AFTER_CMD_ON_ERROR " = = true ] ; then
2016-04-06 20:47:04 +02:00
RunAfterHook
fi
2016-09-08 22:51:24 +02:00
Logger " $PROGRAM finished with errors. " "ERROR"
2016-08-26 15:10:30 +02:00
SendAlert
2016-02-19 22:14:13 +01:00
exitcode = 1
2016-08-31 11:26:21 +02:00
elif [ $WARN_ALERT = = true ] ; then
2019-02-26 12:09:50 +01:00
if [ " $RUN_AFTER_CMD_ON_ERROR " = = true ] ; then
2016-04-06 20:47:04 +02:00
RunAfterHook
fi
2016-09-08 22:51:24 +02:00
Logger " $PROGRAM finished with warnings. " "WARN"
2016-08-26 15:10:30 +02:00
SendAlert
2016-02-19 22:14:13 +01:00
exitcode = 2
2013-07-16 23:10:27 +02:00
else
2016-08-22 09:11:32 +02:00
RunAfterHook
2017-01-04 09:00:47 +01:00
Logger " $PROGRAM finshed. " "ALWAYS"
2016-02-19 22:14:13 +01:00
exitcode = 0
2013-07-16 23:10:27 +02:00
fi
2013-09-22 12:04:09 +02:00
2016-03-03 16:06:27 +01:00
if [ -f " $RUN_DIR / $PROGRAM . $INSTANCE_ID " ] ; then
rm -f " $RUN_DIR / $PROGRAM . $INSTANCE_ID "
fi
2016-11-30 14:04:41 +01:00
CleanUp
2015-11-12 01:26:38 +01:00
KillChilds $$ > /dev/null 2>& 1
2016-02-19 22:14:13 +01:00
exit $exitcode
2015-11-12 01:26:38 +01:00
}
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
function CheckEnvironment {
2019-02-26 12:09:50 +01:00
if [ " $REMOTE_OPERATION " = = true ] ; then
2015-11-12 01:26:38 +01:00
if ! type ssh > /dev/null 2>& 1 ; then
Logger "ssh not present. Cannot start backup." "CRITICAL"
exit 1
fi
2017-01-04 09:00:47 +01:00
if [ " $SSH_PASSWORD_FILE " != "" ] && ! type sshpass > /dev/null 2>& 1 ; then
Logger "sshpass not present. Cannot use password authentication." "CRITICAL"
exit 1
fi
else
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] ; then
2015-11-12 01:26:38 +01:00
if ! type mysqldump > /dev/null 2>& 1 ; then
Logger "mysqldump not present. Cannot backup SQL." "CRITICAL"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
fi
if ! type mysql > /dev/null 2>& 1 ; then
Logger "mysql not present. Cannot backup SQL." "CRITICAL"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
fi
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2016-09-08 22:51:24 +02:00
if ! type rsync > /dev/null 2>& 1 ; then
Logger "rsync not present. Cannot backup files." "CRITICAL"
CAN_BACKUP_FILES = false
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] ; then
2016-09-08 22:51:24 +02:00
CheckCryptEnvironnment
fi
2017-03-14 22:31:15 +01:00
if ! type pgrep > /dev/null 2>& 1 ; then
Logger " pgrep not present. $0 cannot start. " "CRITICAL"
exit 1
fi
2016-09-08 22:51:24 +02:00
}
function CheckCryptEnvironnment {
if ! type gpg2 > /dev/null 2>& 1 ; then
if ! type gpg > /dev/null 2>& 1; then
2016-09-09 08:31:29 +02:00
Logger "Programs gpg2 nor gpg not present. Cannot encrypt backup files." "CRITICAL"
2016-09-08 22:51:24 +02:00
CAN_BACKUP_FILES = false
2013-07-16 23:10:27 +02:00
else
2016-09-09 08:31:29 +02:00
Logger "Program gpg2 not present, falling back to gpg." "NOTICE"
2016-09-08 22:51:24 +02:00
CRYPT_TOOL = gpg
2013-07-16 23:10:27 +02:00
fi
2016-09-08 22:51:24 +02:00
else
CRYPT_TOOL = gpg2
2015-11-12 01:26:38 +01:00
fi
}
function CheckCurrentConfig {
2019-02-26 12:09:50 +01:00
local test
local booleans
local num_vars
2015-11-12 01:26:38 +01:00
if [ " $INSTANCE_ID " = = "" ] ; then
Logger "No INSTANCE_ID defined in config file." "CRITICAL"
exit 1
fi
2019-02-26 12:09:50 +01:00
# v2 config will use true / false instead of yes / no
# Check all variables that should contain "yes" or "no", true or false
declare -a booleans = ( SQL_BACKUP FILE_BACKUP ENCRYPTION CREATE_DIRS KEEP_ABSOLUTE_PATHS GET_BACKUP_SIZE SSH_COMPRESSION SSH_IGNORE_KNOWN_HOSTS REMOTE_HOST_PING SUDO_EXEC DATABASES_ALL PRESERVE_PERMISSIONS PRESERVE_OWNER PRESERVE_GROUP PRESERVE_EXECUTABILITY PRESERVE_ACL PRESERVE_XATTR COPY_SYMLINKS KEEP_DIRLINKS PRESERVE_HARDLINKS RSYNC_COMPRESS PARTIAL DELETE_VANISHED_FILES DELTA_COPIES ROTATE_SQL_BACKUPS ROTATE_FILE_BACKUPS STOP_ON_CMD_ERROR RUN_AFTER_CMD_ON_ERROR)
for i in " ${ booleans [@] } " ; do
test = " if [ \"\$ $i \" != \"yes\" ] && [ \"\$ $i \" != \"no\" ] && [ \"\$ $i \" != true ] && [ \"\$ $i \" != false ]; then Logger \"Bogus $i value [\$ $i ] defined in config file. Correct your config file or update it with the update script if using and old version.\" \"CRITICAL\"; exit 1; fi "
2015-11-12 01:26:38 +01:00
eval " $test "
2013-09-22 12:04:09 +02:00
done
2013-11-02 18:55:17 +01:00
2015-11-12 01:26:38 +01:00
if [ " $BACKUP_TYPE " != "local" ] && [ " $BACKUP_TYPE " != "pull" ] && [ " $BACKUP_TYPE " != "push" ] ; then
Logger "Bogus BACKUP_TYPE value in config file." "CRITICAL"
exit 1
2013-11-02 18:55:17 +01:00
fi
2015-11-12 01:26:38 +01:00
# Check all variables that should contain a numerical value >= 0
2016-08-17 10:01:55 +02:00
declare -a num_vars = ( BACKUP_SIZE_MINIMUM SQL_WARN_MIN_SPACE FILE_WARN_MIN_SPACE SOFT_MAX_EXEC_TIME_DB_TASK HARD_MAX_EXEC_TIME_DB_TASK COMPRESSION_LEVEL SOFT_MAX_EXEC_TIME_FILE_TASK HARD_MAX_EXEC_TIME_FILE_TASK BANDWIDTH SOFT_MAX_EXEC_TIME_TOTAL HARD_MAX_EXEC_TIME_TOTAL ROTATE_SQL_COPIES ROTATE_FILE_COPIES KEEP_LOGGING MAX_EXEC_TIME_PER_CMD_BEFORE MAX_EXEC_TIME_PER_CMD_AFTER)
2016-02-19 22:14:13 +01:00
for i in " ${ num_vars [@] } " ; do
2017-01-04 09:00:47 +01:00
test = " if [ $( IsNumericExpand \" \$ $i \" ) -eq 0 ]; then Logger \"Bogus $i value [\$ $i ] defined in config file. Correct your config file or update it with the update script if using and old version.\" \"CRITICAL\"; exit 1; fi "
2015-11-12 01:26:38 +01:00
eval " $test "
done
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " = = true ] ; then
2015-11-21 13:22:14 +01:00
if [ " $DIRECTORY_LIST " = = "" ] && [ " $RECURSIVE_DIRECTORY_LIST " = = "" ] ; then
Logger "No directories specified in config file, no files to backup." "ERROR"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_FILES = false
2015-11-21 13:22:14 +01:00
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $REMOTE_OPERATION " = = true ] && [ ! -f " $SSH_RSA_PRIVATE_KEY " ] ; then
2016-08-26 15:10:30 +02:00
Logger " Cannot find rsa private key [ $SSH_RSA_PRIVATE_KEY ]. Cannot connect to remote system. " "CRITICAL"
exit 1
fi
2016-09-08 22:51:24 +02:00
#WIP: Encryption use key file instead of recipient ?
#if [ ! -f "$ENCRYPT_GPG_PYUBKEY" ]; then
# Logger "Cannot find gpg pubkey [$ENCRYPT_GPG_PUBKEY]. Cannot encrypt backup files." "CRITICAL"
# exit 1
#fi
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " = = true ] && [ " $SQL_STORAGE " = = "" ] ; then
2016-09-08 22:51:24 +02:00
Logger "SQL_STORAGE not defined." "CRITICAL"
exit 1
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " = = true ] && [ " $FILE_STORAGE " = = "" ] ; then
2016-09-08 22:51:24 +02:00
Logger "FILE_STORAGE not defined." "CRITICAL"
exit 1
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] ; then
2016-09-09 08:31:29 +02:00
if [ " $CRYPT_STORAGE " = = "" ] ; then
Logger "CRYPT_STORAGE not defined." "CRITICAL"
exit 1
fi
if [ " $GPG_RECIPIENT " = = "" ] ; then
Logger "No GPG recipient defined." "CRITICAL"
exit 1
fi
2016-08-26 15:10:30 +02:00
fi
2016-09-08 22:51:24 +02:00
2019-02-26 12:09:50 +01:00
if [ " $REMOTE_OPERATION " = = true ] && ( [ ! -f " $SSH_RSA_PRIVATE_KEY " ] && [ ! -f " $SSH_PASSWORD_FILE " ] ) ; then
2016-11-10 16:25:37 +01:00
Logger " Cannot find rsa private key [ $SSH_RSA_PRIVATE_KEY ] nor password file [ $SSH_PASSWORD_FILE ]. No authentication method provided. " "CRITICAL"
exit 1
fi
2013-07-16 23:10:27 +02:00
}
2019-02-26 12:09:50 +01:00
# Change all booleans with "yes" or "no" to true / false for v2 config syntax compatibility
function UpdateBooleans {
local update
local booleans
declare -a booleans = ( SQL_BACKUP FILE_BACKUP ENCRYPTION CREATE_DIRS KEEP_ABSOLUTE_PATHS GET_BACKUP_SIZE SSH_COMPRESSION SSH_IGNORE_KNOWN_HOSTS REMOTE_HOST_PING SUDO_EXEC DATABASES_ALL PRESERVE_PERMISSIONS PRESERVE_OWNER PRESERVE_GROUP PRESERVE_EXECUTABILITY PRESERVE_ACL PRESERVE_XATTR COPY_SYMLINKS KEEP_DIRLINKS PRESERVE_HARDLINKS RSYNC_COMPRESS PARTIAL DELETE_VANISHED_FILES DELTA_COPIES ROTATE_SQL_BACKUPS ROTATE_FILE_BACKUPS STOP_ON_CMD_ERROR RUN_AFTER_CMD_ON_ERROR)
for i in " ${ booleans [@] } " ; do
update = " if [ \"\$ $i \" == \"yes\" ]; then $i =true; fi; if [ \"\$ $i \" == \"no\" ]; then $i =false; fi "
eval " $update "
done
}
2016-03-03 16:06:27 +01:00
function CheckRunningInstances {
if [ -f " $RUN_DIR / $PROGRAM . $INSTANCE_ID " ] ; then
2020-03-15 22:58:12 +01:00
pid = " $( head -c16384 " $RUN_DIR / $PROGRAM . $INSTANCE_ID " ) "
2016-03-03 16:06:27 +01:00
if ps aux | awk '{print $2}' | grep $pid > /dev/null; then
Logger " Another instance [ $INSTANCE_ID ] of obackup is already running. " "CRITICAL"
exit 1
fi
fi
echo $SCRIPT_PID > " $RUN_DIR / $PROGRAM . $INSTANCE_ID "
}
2015-11-12 01:26:38 +01:00
function _ListDatabasesLocal {
2017-01-04 09:00:47 +01:00
local retval
local sqlCmd
2016-02-19 22:14:13 +01:00
2017-01-04 09:00:47 +01:00
sqlCmd = " mysql -u $SQL_USER -Bse 'SELECT table_schema, round(sum( data_length + index_length ) / 1024) FROM information_schema.TABLES GROUP by table_schema;' > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP 2>&1 "
Logger " Launching command [ $sqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $sqlCmd " &
2018-07-30 15:36:53 +02:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -eq 0 ] ; then
2015-11-12 01:26:38 +01:00
Logger "Listing databases succeeded." "NOTICE"
else
Logger "Listing databases failed." "ERROR"
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $sqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
return 1
fi
}
function _ListDatabasesRemote {
2017-01-04 09:00:47 +01:00
local sqlCmd
local retval
2016-02-19 22:14:13 +01:00
2013-07-16 23:10:27 +02:00
CheckConnectivity3rdPartyHosts
2015-11-12 01:26:38 +01:00
CheckConnectivityRemoteHost
2017-03-14 22:31:15 +01:00
sqlCmd = " $SSH_CMD \"env _REMOTE_TOKEN= $_REMOTE_TOKEN mysql -u $SQL_USER -Bse 'SELECT table_schema, round(sum( data_length + index_length ) / 1024) FROM information_schema.TABLES GROUP by table_schema;'\" > \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP \" 2>&1 "
2017-01-04 09:00:47 +01:00
Logger " Command output: $sqlCmd " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $sqlCmd " &
2018-07-30 15:36:53 +02:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -eq 0 ] ; then
2015-11-12 01:26:38 +01:00
Logger "Listing databases succeeded." "NOTICE"
else
Logger "Listing databases failed." "ERROR"
2017-01-04 09:00:47 +01:00
Logger " Command output: $sqlCmd " "WARN"
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2013-07-16 23:10:27 +02:00
fi
2017-01-04 09:00:47 +01:00
return $retval
2015-11-12 01:26:38 +01:00
fi
}
function ListDatabases {
2016-08-08 19:00:52 +02:00
local outputFile # Return of subfunction
local dbName
local dbSize
local dbBackup
2017-01-04 09:00:47 +01:00
local missingDatabases = false
2016-08-08 19:00:52 +02:00
local dbArray
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $CAN_BACKUP_SQL = = false ] ; then
2015-11-12 01:26:38 +01:00
Logger "Cannot list databases." "ERROR"
return 1
fi
Logger "Listing databases." "NOTICE"
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ; then
_ListDatabasesLocal
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-08 19:00:52 +02:00
outputFile = ""
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
outputFile = " $RUN_DIR / $PROGRAM ._ListDatabasesLocal. $SCRIPT_PID . $TSTAMP "
2015-11-12 01:26:38 +01:00
fi
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
_ListDatabasesRemote
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-08 19:00:52 +02:00
outputFile = ""
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
outputFile = " $RUN_DIR / $PROGRAM ._ListDatabasesRemote. $SCRIPT_PID . $TSTAMP "
2013-07-16 23:10:27 +02:00
fi
fi
2013-11-02 18:55:17 +01:00
2016-08-31 11:26:21 +02:00
if [ -f " $outputFile " ] && [ $CAN_BACKUP_SQL = = true ] ; then
2016-08-08 19:00:52 +02:00
while read -r line; do
while read -r name size; do dbName = $name ; dbSize = $size ; done <<< " $line "
2015-11-12 01:26:38 +01:00
2019-02-26 12:09:50 +01:00
if [ " $DATABASES_ALL " = = true ] ; then
2017-01-04 09:00:47 +01:00
dbBackup = true
2016-08-18 11:53:18 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a dbArray <<< " $DATABASES_ALL_EXCLUDE_LIST "
2016-08-08 19:00:52 +02:00
for j in " ${ dbArray [@] } " ; do
if [ " $dbName " = = " $j " ] ; then
2017-01-04 09:00:47 +01:00
dbBackup = false
2015-11-12 01:26:38 +01:00
fi
done
else
2017-01-04 09:00:47 +01:00
dbBackup = false
2016-08-18 11:53:18 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a dbArray <<< " $DATABASES_LIST "
2016-08-08 19:00:52 +02:00
for j in " ${ dbArray [@] } " ; do
if [ " $dbName " = = " $j " ] ; then
2017-01-04 09:00:47 +01:00
dbBackup = true
2015-11-12 01:26:38 +01:00
fi
done
2017-01-04 09:00:47 +01:00
if [ $dbBackup = = false ] ; then
missingDatabases = true
fi
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
if [ $dbBackup = = true ] ; then
2015-11-12 01:26:38 +01:00
if [ " $SQL_BACKUP_TASKS " != "" ] ; then
2016-08-08 19:00:52 +02:00
SQL_BACKUP_TASKS = " $SQL_BACKUP_TASKS $dbName "
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
SQL_BACKUP_TASKS = " $dbName "
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
TOTAL_DATABASES_SIZE = $(( TOTAL_DATABASES_SIZE+dbSize))
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
SQL_EXCLUDED_TASKS = " $SQL_EXCLUDED_TASKS $dbName "
2015-11-12 01:26:38 +01:00
fi
2016-08-08 19:00:52 +02:00
done < " $outputFile "
2015-11-12 01:26:38 +01:00
2017-01-04 09:00:47 +01:00
if [ $missingDatabases = = true ] ; then
IFS = $PATH_SEPARATOR_CHAR read -r -a dbArray <<< " $DATABASES_LIST "
for i in " ${ dbArray [@] } " ; do
if ! grep " $i " " $outputFile " > /dev/null 2>& 1; then
Logger " Missing database [ $i ]. " "CRITICAL"
fi
done
fi
2015-11-12 01:26:38 +01:00
Logger " Database backup list: $SQL_BACKUP_TASKS " "DEBUG"
Logger " Database exclude list: $SQL_EXCLUDED_TASKS " "DEBUG"
2014-11-27 14:40:30 +01:00
else
2015-11-12 01:26:38 +01:00
Logger "Will not execute database backup." "ERROR"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2014-11-27 14:40:30 +01:00
fi
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _ListRecursiveBackupDirectoriesLocal {
2016-02-19 22:14:13 +01:00
local cmd
2016-08-06 14:04:35 +02:00
local directories
local directory
local retval
2017-01-04 09:00:47 +01:00
local successfulRun = false
local failuresPresent = false
2016-02-19 22:14:13 +01:00
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a directories <<< " $RECURSIVE_DIRECTORY_LIST "
2016-08-06 14:04:35 +02:00
for directory in " ${ directories [@] } " ; do
2018-07-30 16:22:20 +02:00
# Make sure there is only one trailing slash
directory = " ${ directory %/ } / "
2015-11-18 10:52:43 +01:00
# No sudo here, assuming you should have all necessary rights for local checks
2018-07-30 16:39:23 +02:00
cmd = " $FIND_CMD -L $directory -mindepth 1 -maxdepth 1 -type d >> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $cmd ]. " "DEBUG"
eval " $cmd "
retval = $?
if [ $retval -ne 0 ] ; then
2015-11-12 01:26:38 +01:00
Logger " Could not enumerate directories in [ $directory ]. " "ERROR"
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $cmd ]. " "WARN"
2020-05-03 10:08:02 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2020-05-03 10:08:02 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
failuresPresent = true
2013-07-16 23:10:27 +02:00
else
2017-01-04 09:00:47 +01:00
successfulRun = true
2013-07-16 23:10:27 +02:00
fi
done
2017-01-04 09:00:47 +01:00
if [ $successfulRun = = true ] && [ $failuresPresent = = true ] ; then
return 2
elif [ $successfulRun = = true ] && [ $failuresPresent = = false ] ; then
return 0
else
return 1
fi
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _ListRecursiveBackupDirectoriesRemote {
2016-08-06 14:04:35 +02:00
local retval
2016-02-19 22:14:13 +01:00
2017-03-14 22:31:15 +01:00
$SSH_CMD env _REMOTE_TOKEN = $_REMOTE_TOKEN \
env _DEBUG = " ' $_DEBUG ' " env _PARANOIA_DEBUG = " ' $_PARANOIA_DEBUG ' " env _LOGGER_SILENT = " ' $_LOGGER_SILENT ' " env _LOGGER_VERBOSE = " ' $_LOGGER_VERBOSE ' " env _LOGGER_PREFIX = " ' $_LOGGER_PREFIX ' " env _LOGGER_ERR_ONLY = " ' $_LOGGER_ERR_ONLY ' " \
2018-11-06 15:33:16 +01:00
env _REMOTE_EXECUTION = "true" env PROGRAM = " ' $PROGRAM ' " env SCRIPT_PID = " ' $SCRIPT_PID ' " env TSTAMP = " ' $TSTAMP ' " \
2017-01-04 09:00:47 +01:00
env RECURSIVE_DIRECTORY_LIST = " ' $RECURSIVE_DIRECTORY_LIST ' " env PATH_SEPARATOR_CHAR = " ' $PATH_SEPARATOR_CHAR ' " \
env REMOTE_FIND_CMD = " ' $REMOTE_FIND_CMD ' " $COMMAND_SUDO ' bash -s' << 'ENDSSH' > "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID .$TSTAMP " 2> " $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID .$TSTAMP "
2020-03-15 22:58:12 +01:00
_REMOTE_TOKEN = "(o_0)"
2015-11-12 01:26:38 +01:00
2019-02-26 12:09:50 +01:00
## allow debugging from command line with _DEBUG=true
if [ ! " $_DEBUG " = = true ] ; then
_DEBUG = false
2017-01-04 09:00:47 +01:00
_LOGGER_VERBOSE = false
else
trap 'TrapError ${LINENO} $?' ERR
_LOGGER_VERBOSE = true
fi
2015-11-12 01:26:38 +01:00
2017-01-04 09:00:47 +01:00
if [ " $SLEEP_TIME " = = "" ] ; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
SLEEP_TIME = .05
fi
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
2016-08-08 19:00:52 +02:00
2017-01-04 09:00:47 +01:00
if [ $_LOGGER_SILENT = = false ] ; then
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
}
2013-07-16 23:10:27 +02:00
2017-01-04 09:00:47 +01:00
# Array to string converter, see http://stackoverflow.com/questions/1527049/bash-join-elements-of-an-array
# usage: joinString separaratorChar Array
function joinString {
local IFS = " $1 " ; shift; echo " $* " ;
}
2014-09-22 22:45:18 +02:00
2017-01-04 09:00:47 +01:00
# Sub function of Logger
function _Logger {
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-03-14 22:31:15 +01:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2017-01-04 09:00:47 +01:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-07-30 15:36:53 +02:00
# Build current log file for alerts if we have a sufficient environment
2019-05-21 11:46:07 +02:00
if [ " $RUN_DIR / $PROGRAM " != "/" ] ; then
2020-03-15 22:58:12 +01:00
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP "
2018-07-30 15:36:53 +02:00
fi
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-03-14 22:31:15 +01:00
if [ $toStdErr = = true ] ; then
2017-01-04 09:00:47 +01:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
2016-08-18 11:53:18 +02:00
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
echo -e " $stdValue "
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
fi
2015-11-12 01:26:38 +01:00
}
2017-01-04 09:00:47 +01:00
# Remote logger similar to below Logger, without log to file and alert flags
function RemoteLogger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2016-02-19 22:14:13 +01:00
2018-11-06 15:33:16 +01:00
local prefix
2017-01-04 09:00:47 +01:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2020-03-15 22:58:12 +01:00
prefix = " RTIME: $SECONDS - "
2017-01-04 09:00:47 +01:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
prefix = " R $( date) - "
else
prefix = ""
fi
if [ " $level " = = "CRITICAL" ] ; then
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "WARN" ] ; then
_Logger "" " $prefix \e[33m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "NOTICE" ] ; then
if [ $_LOGGER_ERR_ONLY != true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "ALWAYS" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix $value "
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix $value "
return
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
else
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
fi
}
function _ListRecursiveBackupDirectoriesRemoteSub {
local directories
local directory
local retval
local successfulRun = false
local failuresPresent = false
local cmd
IFS = $PATH_SEPARATOR_CHAR read -r -a directories <<< " $RECURSIVE_DIRECTORY_LIST "
for directory in " ${ directories [@] } " ; do
2018-07-30 16:22:20 +02:00
# Make sure there is only one trailing slash
directory = " ${ directory %/ } / "
2018-07-30 16:39:23 +02:00
cmd = " $REMOTE_FIND_CMD -L \" $directory \" -mindepth 1 -maxdepth 1 -type d "
2018-07-30 16:22:20 +02:00
Logger " Launching command [ $cmd ]. " "DEBUG"
2017-01-04 09:00:47 +01:00
eval $cmd
retval = $?
if [ $retval -ne 0 ] ; then
RemoteLogger " Could not enumerate directories in [ $directory ]. " "ERROR"
RemoteLogger " Command was [ $cmd ]. " "WARN"
failuresPresent = true
else
successfulRun = true
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
done
if [ $successfulRun = = true ] && [ $failuresPresent = = true ] ; then
return 2
elif [ $successfulRun = = true ] && [ $failuresPresent = = false ] ; then
return 0
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
return 1
fi
}
_ListRecursiveBackupDirectoriesRemoteSub
exit $?
ENDSSH
retval = $?
if [ $retval -ne 0 ] ; then
2020-05-03 10:08:02 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
fi
2020-05-03 10:08:02 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
fi
fi
return $retval
}
function ListRecursiveBackupDirectories {
local output_file
local file_exclude
local excluded
local fileArray
if [ " $RECURSIVE_DIRECTORY_LIST " != "" ] ; then
# Return values from subfunctions can be 0 (no error), 1 (only errors) or 2 (some errors). Do process output except on 1 return code
Logger "Listing directories to backup." "NOTICE"
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ; then
_ListRecursiveBackupDirectoriesLocal &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -eq 1 ] ; then
output_file = ""
else
output_file = " $RUN_DIR / $PROGRAM ._ListRecursiveBackupDirectoriesLocal. $SCRIPT_PID . $TSTAMP "
fi
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
_ListRecursiveBackupDirectoriesRemote &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -eq 1 ] ; then
output_file = ""
else
output_file = " $RUN_DIR / $PROGRAM ._ListRecursiveBackupDirectoriesRemote. $SCRIPT_PID . $TSTAMP "
fi
fi
if [ -f " $output_file " ] ; then
while read -r line; do
file_exclude = 0
IFS = $PATH_SEPARATOR_CHAR read -r -a fileArray <<< " $RECURSIVE_EXCLUDE_LIST "
for excluded in " ${ fileArray [@] } " ; do
if [ " $excluded " = = " $line " ] ; then
file_exclude = 1
fi
done
if [ $file_exclude -eq 0 ] ; then
if [ " $FILE_RECURSIVE_BACKUP_TASKS " = = "" ] ; then
FILE_SIZE_LIST = " \" $line \" "
FILE_RECURSIVE_BACKUP_TASKS = " $line "
else
FILE_SIZE_LIST = " $FILE_SIZE_LIST \" $line \" "
FILE_RECURSIVE_BACKUP_TASKS = " $FILE_RECURSIVE_BACKUP_TASKS $PATH_SEPARATOR_CHAR $line "
fi
else
FILE_RECURSIVE_EXCLUDED_TASKS = " $FILE_RECURSIVE_EXCLUDED_TASKS $PATH_SEPARATOR_CHAR $line "
fi
done < " $output_file "
fi
fi
if [ " $DIRECTORY_LIST " != "" ] ; then
IFS = $PATH_SEPARATOR_CHAR read -r -a fileArray <<< " $DIRECTORY_LIST "
for directory in " ${ fileArray [@] } " ; do
if [ " $FILE_SIZE_LIST " = = "" ] ; then
FILE_SIZE_LIST = " \" $directory \" "
else
FILE_SIZE_LIST = " $FILE_SIZE_LIST \" $directory \" "
fi
if [ " $FILE_BACKUP_TASKS " = = "" ] ; then
FILE_BACKUP_TASKS = " $directory "
else
FILE_BACKUP_TASKS = " $FILE_BACKUP_TASKS $PATH_SEPARATOR_CHAR $directory "
fi
done
fi
}
function _GetDirectoriesSizeLocal {
local dirList = " ${ 1 } "
local cmd
local retval
# No sudo here, assuming you should have all the necessary rights
# This is not pretty, but works with all supported systems
cmd = " du -cs $dirList | tail -n1 | cut -f1 > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
Logger " Launching command [ $cmd ]. " "DEBUG"
eval " $cmd " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
# $cmd will return 0 even if some errors found, so we need to check if there is an error output
retval = $?
2018-01-03 22:32:19 +01:00
if [ $retval -ne 0 ] || [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
2017-01-04 09:00:47 +01:00
Logger "Could not get files size for some or all local directories." "ERROR"
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $cmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
fi
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
fi
2017-03-14 22:31:15 +01:00
else
2015-11-12 01:26:38 +01:00
Logger "File size fetched successfully." "NOTICE"
fi
2017-01-04 09:00:47 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
TOTAL_FILES_SIZE = " $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) "
if [ $( IsInteger " $TOTAL_FILES_SIZE " ) -eq 0 ] ; then
TOTAL_FILES_SIZE = " $( HumanToNumeric " $TOTAL_FILES_SIZE " ) "
2016-11-10 16:25:37 +01:00
fi
2015-11-12 01:26:38 +01:00
else
TOTAL_FILES_SIZE = -1
fi
}
function _GetDirectoriesSizeRemote {
2017-01-04 09:00:47 +01:00
local dirList = " ${ 1 } "
2015-11-12 01:26:38 +01:00
2016-02-19 22:14:13 +01:00
local cmd
2017-01-04 09:00:47 +01:00
local retval
2016-02-19 22:14:13 +01:00
2015-11-12 01:26:38 +01:00
# Error output is different from stdout because not all files in list may fail at once
2017-03-14 22:31:15 +01:00
$SSH_CMD env _REMOTE_TOKEN = $_REMOTE_TOKEN \
env _DEBUG = " ' $_DEBUG ' " env _PARANOIA_DEBUG = " ' $_PARANOIA_DEBUG ' " env _LOGGER_SILENT = " ' $_LOGGER_SILENT ' " env _LOGGER_VERBOSE = " ' $_LOGGER_VERBOSE ' " env _LOGGER_PREFIX = " ' $_LOGGER_PREFIX ' " env _LOGGER_ERR_ONLY = " ' $_LOGGER_ERR_ONLY ' " \
2018-11-06 15:33:16 +01:00
env _REMOTE_EXECUTION = "true" env PROGRAM = " ' $PROGRAM ' " env SCRIPT_PID = " ' $SCRIPT_PID ' " env TSTAMP = " ' $TSTAMP ' " \
dirList = " ' $dirList ' " \
2017-01-04 09:00:47 +01:00
$COMMAND_SUDO ' bash -s' << 'ENDSSH' > "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID .$TSTAMP " 2> " $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID .$TSTAMP " &
2020-03-15 22:58:12 +01:00
_REMOTE_TOKEN = "(o_0)"
2017-01-04 09:00:47 +01:00
2019-02-26 12:09:50 +01:00
## allow debugging from command line with _DEBUG=true
if [ ! " $_DEBUG " = = true ] ; then
_DEBUG = false
2017-01-04 09:00:47 +01:00
_LOGGER_VERBOSE = false
else
trap 'TrapError ${LINENO} $?' ERR
_LOGGER_VERBOSE = true
fi
if [ " $SLEEP_TIME " = = "" ] ; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
SLEEP_TIME = .05
fi
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
if [ $_LOGGER_SILENT = = false ] ; then
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
fi
}
# Array to string converter, see http://stackoverflow.com/questions/1527049/bash-join-elements-of-an-array
# usage: joinString separaratorChar Array
function joinString {
local IFS = " $1 " ; shift; echo " $* " ;
}
# Sub function of Logger
function _Logger {
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-03-14 22:31:15 +01:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2017-01-04 09:00:47 +01:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-07-30 15:36:53 +02:00
# Build current log file for alerts if we have a sufficient environment
2019-05-21 11:46:07 +02:00
if [ " $RUN_DIR / $PROGRAM " != "/" ] ; then
2020-03-15 22:58:12 +01:00
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP "
2018-07-30 15:36:53 +02:00
fi
2017-01-04 09:00:47 +01:00
fi
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-03-14 22:31:15 +01:00
if [ $toStdErr = = true ] ; then
2017-01-04 09:00:47 +01:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
else
echo -e " $stdValue "
fi
fi
}
# Remote logger similar to below Logger, without log to file and alert flags
function RemoteLogger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2018-11-06 15:33:16 +01:00
local prefix
2017-01-04 09:00:47 +01:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2020-03-15 22:58:12 +01:00
prefix = " RTIME: $SECONDS - "
2017-01-04 09:00:47 +01:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
prefix = " R $( date) - "
else
prefix = ""
fi
if [ " $level " = = "CRITICAL" ] ; then
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "WARN" ] ; then
_Logger "" " $prefix \e[33m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "NOTICE" ] ; then
if [ $_LOGGER_ERR_ONLY != true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "ALWAYS" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix $value "
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix $value "
return
fi
else
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
fi
}
cmd = " du -cs $dirList | tail -n1 | cut -f1 "
eval " $cmd "
retval = $?
if [ $retval != 0 ] ; then
RemoteLogger " Command was [ $cmd ]. " "WARN"
fi
exit $retval
ENDSSH
2015-11-12 01:26:38 +01:00
# $cmd will return 0 even if some errors found, so we need to check if there is an error output
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
2018-01-03 22:32:19 +01:00
if [ $retval -ne 0 ] || [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
2017-01-04 09:00:47 +01:00
Logger "Could not get files size for some or all remote directories." "ERROR"
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
else
Logger "File size fetched successfully." "NOTICE"
fi
2017-01-04 09:00:47 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
2020-05-03 10:08:02 +02:00
TOTAL_FILES_SIZE = " $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) "
if [ $( IsInteger " $TOTAL_FILES_SIZE " ) -eq 0 ] ; then
TOTAL_FILES_SIZE = " $( HumanToNumeric " $TOTAL_FILES_SIZE " ) "
2016-11-10 16:25:37 +01:00
fi
2015-11-12 01:26:38 +01:00
else
TOTAL_FILES_SIZE = -1
fi
}
function GetDirectoriesSize {
Logger "Getting files size" "NOTICE"
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2017-01-04 09:00:47 +01:00
_GetDirectoriesSizeLocal " $FILE_SIZE_LIST "
2015-11-12 01:26:38 +01:00
fi
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2017-01-04 09:00:47 +01:00
_GetDirectoriesSizeRemote " $FILE_SIZE_LIST "
2015-11-12 01:26:38 +01:00
fi
fi
}
2015-11-19 22:14:15 +01:00
function _CreateDirectoryLocal {
2017-01-04 09:00:47 +01:00
local dirToCreate = " ${ 1 } "
local retval
2015-11-12 01:26:38 +01:00
2017-01-04 09:00:47 +01:00
if [ ! -d " $dirToCreate " ] ; then
2015-11-18 10:52:43 +01:00
# No sudo, you should have all necessary rights
2020-05-03 10:08:02 +02:00
mkdir -p " $dirToCreate " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " 2>& 1 &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 720 1800 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -ne 0 ] ; then
Logger " Cannot create directory [ $dirToCreate ] " "CRITICAL"
2020-05-03 10:08:02 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
Logger " Truncated output: $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
return $retval
2015-11-12 01:26:38 +01:00
fi
fi
}
2015-11-19 22:14:15 +01:00
function _CreateDirectoryRemote {
2017-01-04 09:00:47 +01:00
local dirToCreate = " ${ 1 } "
2015-11-12 01:26:38 +01:00
2016-02-19 22:14:13 +01:00
local cmd
2017-01-04 09:00:47 +01:00
local retval
2016-02-19 22:14:13 +01:00
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2017-01-04 09:00:47 +01:00
2017-03-14 22:31:15 +01:00
$SSH_CMD env _REMOTE_TOKEN = $_REMOTE_TOKEN \
env _DEBUG = " ' $_DEBUG ' " env _PARANOIA_DEBUG = " ' $_PARANOIA_DEBUG ' " env _LOGGER_SILENT = " ' $_LOGGER_SILENT ' " env _LOGGER_VERBOSE = " ' $_LOGGER_VERBOSE ' " env _LOGGER_PREFIX = " ' $_LOGGER_PREFIX ' " env _LOGGER_ERR_ONLY = " ' $_LOGGER_ERR_ONLY ' " \
2018-11-06 19:17:07 +01:00
env _REMOTE_EXECUTION = "true" env PROGRAM = " ' $PROGRAM ' " env SCRIPT_PID = " ' $SCRIPT_PID ' " env TSTAMP = " ' $TSTAMP ' " \
2017-01-04 09:00:47 +01:00
env dirToCreate = " ' $dirToCreate ' " $COMMAND_SUDO ' bash -s' << 'ENDSSH' > "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID .$TSTAMP " 2>&1 &
2020-03-15 22:58:12 +01:00
_REMOTE_TOKEN = "(o_0)"
2017-01-04 09:00:47 +01:00
2019-02-26 12:09:50 +01:00
## allow debugging from command line with _DEBUG=true
if [ ! " $_DEBUG " = = true ] ; then
_DEBUG = false
2017-01-04 09:00:47 +01:00
_LOGGER_VERBOSE = false
else
trap 'TrapError ${LINENO} $?' ERR
_LOGGER_VERBOSE = true
fi
if [ " $SLEEP_TIME " = = "" ] ; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
SLEEP_TIME = .05
fi
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
if [ $_LOGGER_SILENT = = false ] ; then
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
fi
}
# Array to string converter, see http://stackoverflow.com/questions/1527049/bash-join-elements-of-an-array
# usage: joinString separaratorChar Array
function joinString {
local IFS = " $1 " ; shift; echo " $* " ;
}
# Sub function of Logger
function _Logger {
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-03-14 22:31:15 +01:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2017-01-04 09:00:47 +01:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-07-30 15:36:53 +02:00
# Build current log file for alerts if we have a sufficient environment
2019-05-21 11:46:07 +02:00
if [ " $RUN_DIR / $PROGRAM " != "/" ] ; then
2020-03-15 22:58:12 +01:00
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP "
2018-07-30 15:36:53 +02:00
fi
2017-01-04 09:00:47 +01:00
fi
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-03-14 22:31:15 +01:00
if [ $toStdErr = = true ] ; then
2017-01-04 09:00:47 +01:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
else
echo -e " $stdValue "
fi
fi
}
# Remote logger similar to below Logger, without log to file and alert flags
function RemoteLogger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2018-11-06 15:33:16 +01:00
local prefix
2017-01-04 09:00:47 +01:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2020-03-15 22:58:12 +01:00
prefix = " RTIME: $SECONDS - "
2017-01-04 09:00:47 +01:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
prefix = " R $( date) - "
else
prefix = ""
fi
if [ " $level " = = "CRITICAL" ] ; then
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "WARN" ] ; then
_Logger "" " $prefix \e[33m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
return
elif [ " $level " = = "NOTICE" ] ; then
if [ $_LOGGER_ERR_ONLY != true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "ALWAYS" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix $value "
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix $value "
return
fi
else
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
fi
}
if [ ! -d " $dirToCreate " ] ; then
# No sudo, you should have all necessary rights
mkdir -p " $dirToCreate "
retval = $?
if [ $retval -ne 0 ] ; then
RemoteLogger " Cannot create directory [ $dirToCreate ] " "CRITICAL"
exit $retval
fi
fi
exit 0
ENDSSH
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 720 1800 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -ne 0 ] ; then
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
return $retval
fi
}
function CreateStorageDirectories {
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "pull" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryLocal " $SQL_STORAGE "
if [ $? -ne 0 ] ; then
CAN_BACKUP_SQL = false
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryLocal " $FILE_STORAGE "
if [ $? -ne 0 ] ; then
CAN_BACKUP_FILES = false
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryLocal " $CRYPT_STORAGE "
if [ $? -ne 0 ] ; then
CAN_BACKUP_FILES = false
fi
fi
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryRemote " $SQL_STORAGE "
if [ $? -ne 0 ] ; then
CAN_BACKUP_SQL = false
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryRemote " $FILE_STORAGE "
if [ $? -ne 0 ] ; then
CAN_BACKUP_FILES = false
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryLocal " $CRYPT_STORAGE "
if [ $? -ne 0 ] ; then
CAN_BACKUP_FILES = false
fi
fi
fi
}
function GetDiskSpaceLocal {
# GLOBAL VARIABLE DISK_SPACE to pass variable to parent function
# GLOBAL VARIABLE DRIVE to pass variable to parent function
local pathToCheck = " ${ 1 } "
local retval
if [ -d " $pathToCheck " ] ; then
# Not elegant solution to make df silent on errors
# No sudo on local commands, assuming you should have all the necesarry rights to check backup directories sizes
2018-01-03 22:32:19 +01:00
$DF_CMD " $pathToCheck " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " 2>& 1 &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -ne 0 ] ; then
DISK_SPACE = 0
Logger " Cannot get disk space in [ $pathToCheck ] on local system. " "ERROR"
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
else
DISK_SPACE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " | awk '{print $4}' )
DRIVE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " | awk '{print $1}' )
2020-05-03 10:08:02 +02:00
if [ $( IsInteger " $DISK_SPACE " ) -eq 0 ] ; then
DISK_SPACE = " $( HumanToNumeric " $DISK_SPACE " ) "
2017-01-04 09:00:47 +01:00
fi
fi
else
Logger " Storage path [ $pathToCheck ] does not exist. " "CRITICAL"
2015-11-12 01:26:38 +01:00
return 1
fi
}
2017-01-04 09:00:47 +01:00
function GetDiskSpaceRemote {
# USE GLOBAL VARIABLE DISK_SPACE to pass variable to parent function
local pathToCheck = " ${ 1 } "
local cmd
local retval
2017-03-14 22:31:15 +01:00
$SSH_CMD env _REMOTE_TOKEN = $_REMOTE_TOKEN \
env _DEBUG = " ' $_DEBUG ' " env _PARANOIA_DEBUG = " ' $_PARANOIA_DEBUG ' " env _LOGGER_SILENT = " ' $_LOGGER_SILENT ' " env _LOGGER_VERBOSE = " ' $_LOGGER_VERBOSE ' " env _LOGGER_PREFIX = " ' $_LOGGER_PREFIX ' " env _LOGGER_ERR_ONLY = " ' $_LOGGER_ERR_ONLY ' " \
2018-11-06 19:17:07 +01:00
env _REMOTE_EXECUTION = "true" env PROGRAM = " ' $PROGRAM ' " env SCRIPT_PID = " ' $SCRIPT_PID ' " env TSTAMP = " ' $TSTAMP ' " \
2017-01-04 09:00:47 +01:00
env DF_CMD = " ' $DF_CMD ' " \
env pathToCheck = " ' $pathToCheck ' " $COMMAND_SUDO ' bash -s' << 'ENDSSH' > "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID .$TSTAMP " 2> " $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID .$TSTAMP " &
2020-03-15 22:58:12 +01:00
_REMOTE_TOKEN = "(o_0)"
2017-01-04 09:00:47 +01:00
2019-02-26 12:09:50 +01:00
## allow debugging from command line with _DEBUG=true
if [ ! " $_DEBUG " = = true ] ; then
_DEBUG = false
2017-01-04 09:00:47 +01:00
_LOGGER_VERBOSE = false
else
trap 'TrapError ${LINENO} $?' ERR
_LOGGER_VERBOSE = true
fi
if [ " $SLEEP_TIME " = = "" ] ; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
SLEEP_TIME = .05
fi
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
if [ $_LOGGER_SILENT = = false ] ; then
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
fi
}
# Array to string converter, see http://stackoverflow.com/questions/1527049/bash-join-elements-of-an-array
# usage: joinString separaratorChar Array
function joinString {
local IFS = " $1 " ; shift; echo " $* " ;
}
# Sub function of Logger
function _Logger {
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-03-14 22:31:15 +01:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2017-01-04 09:00:47 +01:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-07-30 15:36:53 +02:00
# Build current log file for alerts if we have a sufficient environment
2019-05-21 11:46:07 +02:00
if [ " $RUN_DIR / $PROGRAM " != "/" ] ; then
2020-03-15 22:58:12 +01:00
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP "
2018-07-30 15:36:53 +02:00
fi
2017-01-04 09:00:47 +01:00
fi
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-03-14 22:31:15 +01:00
if [ $toStdErr = = true ] ; then
2017-01-04 09:00:47 +01:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
else
echo -e " $stdValue "
fi
fi
}
# Remote logger similar to below Logger, without log to file and alert flags
function RemoteLogger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2015-11-12 01:26:38 +01:00
2018-11-06 15:33:16 +01:00
local prefix
2017-01-04 09:00:47 +01:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2020-03-15 22:58:12 +01:00
prefix = " RTIME: $SECONDS - "
2017-01-04 09:00:47 +01:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
prefix = " R $( date) - "
else
prefix = ""
fi
if [ " $level " = = "CRITICAL" ] ; then
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "WARN" ] ; then
_Logger "" " $prefix \e[33m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
2016-09-08 22:51:24 +02:00
fi
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "NOTICE" ] ; then
if [ $_LOGGER_ERR_ONLY != true ] ; then
_Logger "" " $prefix $value "
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
_Logger "" " $prefix $value "
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "ALWAYS" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix $value "
2017-01-04 09:00:47 +01:00
return
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix $value "
return
2016-09-08 22:51:24 +02:00
fi
2017-01-04 09:00:47 +01:00
else
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
2015-11-12 01:26:38 +01:00
fi
}
2017-01-04 09:00:47 +01:00
function _GetDiskSpaceRemoteSub {
if [ -d " $pathToCheck " ] ; then
2015-11-12 01:26:38 +01:00
# Not elegant solution to make df silent on errors
2015-11-18 10:52:43 +01:00
# No sudo on local commands, assuming you should have all the necesarry rights to check backup directories sizes
2017-01-04 09:00:47 +01:00
cmd = " $DF_CMD \" $pathToCheck \" "
eval $cmd
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2017-01-04 09:00:47 +01:00
RemoteLogger " Error getting [ $pathToCheck ] size. " "CRITICAL"
RemoteLogger " Command was [ $cmd ]. " "WARN"
return 1
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
return 0
2015-11-12 01:26:38 +01:00
fi
else
2017-01-04 09:00:47 +01:00
RemoteLogger " Storage path [ $pathToCheck ] does not exist. " "CRITICAL"
2015-11-12 01:26:38 +01:00
return 1
fi
}
2017-01-04 09:00:47 +01:00
_GetDiskSpaceRemoteSub
exit $?
ENDSSH
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -ne 0 ] ; then
2015-11-12 01:26:38 +01:00
DISK_SPACE = 0
2017-01-04 09:00:47 +01:00
Logger " Cannot get disk space in [ $pathToCheck ] on remote system. " "ERROR"
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2017-01-04 09:00:47 +01:00
return $retval
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
DISK_SPACE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " | awk '{print $4}' )
DRIVE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " | awk '{print $1}' )
2020-05-03 10:08:02 +02:00
if [ $( IsInteger " $DISK_SPACE " ) -eq 0 ] ; then
DISK_SPACE = " $( HumanToNumeric " $DISK_SPACE " ) "
2016-11-10 16:25:37 +01:00
fi
2015-11-12 01:26:38 +01:00
fi
}
function CheckDiskSpace {
# USE OF GLOBAL VARIABLES TOTAL_DATABASES_SIZE, TOTAL_FILES_SIZE, BACKUP_SIZE_MINIMUM, STORAGE_WARN_SIZE, STORAGE_SPACE
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "pull" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] ; then
2015-11-12 01:26:38 +01:00
GetDiskSpaceLocal " $SQL_STORAGE "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2015-11-12 01:26:38 +01:00
SQL_DISK_SPACE = 0
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
else
SQL_DISK_SPACE = $DISK_SPACE
SQL_DRIVE = $DRIVE
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2015-11-12 01:26:38 +01:00
GetDiskSpaceLocal " $FILE_STORAGE "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2015-11-12 01:26:38 +01:00
FILE_DISK_SPACE = 0
2016-08-31 11:26:21 +02:00
CAN_BACKUP_FILES = false
2015-11-12 01:26:38 +01:00
else
FILE_DISK_SPACE = $DISK_SPACE
FILE_DRIVE = $DRIVE
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " != false ] ; then
2016-09-08 22:51:24 +02:00
GetDiskSpaceLocal " $CRYPT_STORAGE "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-09-08 22:51:24 +02:00
CRYPT_DISK_SPACE = 0
CAN_BACKUP_FILES = false
CAN_BACKUP_SQL = false
else
CRYPT_DISK_SPACE = $DISK_SPACE
CRYPT_DRIVE = $DRIVE
fi
fi
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] ; then
2015-11-12 01:26:38 +01:00
GetDiskSpaceRemote " $SQL_STORAGE "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2015-11-12 01:26:38 +01:00
SQL_DISK_SPACE = 0
else
SQL_DISK_SPACE = $DISK_SPACE
SQL_DRIVE = $DRIVE
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2015-11-12 01:26:38 +01:00
GetDiskSpaceRemote " $FILE_STORAGE "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2015-11-12 01:26:38 +01:00
FILE_DISK_SPACE = 0
else
FILE_DISK_SPACE = $DISK_SPACE
FILE_DRIVE = $DRIVE
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " != false ] ; then
2016-09-08 22:51:24 +02:00
GetDiskSpaceLocal " $CRYPT_STORAGE "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-09-08 22:51:24 +02:00
CRYPT_DISK_SPACE = 0
CAN_BACKUP_FILES = false
CAN_BACKUP_SQL = false
else
CRYPT_DISK_SPACE = $DISK_SPACE
CRYPT_DRIVE = $DRIVE
fi
fi
2015-11-12 01:26:38 +01:00
fi
if [ " $TOTAL_DATABASES_SIZE " = = "" ] ; then
TOTAL_DATABASES_SIZE = -1
fi
if [ " $TOTAL_FILES_SIZE " = = "" ] ; then
TOTAL_FILES_SIZE = -1
fi
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] && [ $CAN_BACKUP_SQL = = true ] ; then
2015-11-12 01:26:38 +01:00
if [ $SQL_DISK_SPACE -eq 0 ] ; then
Logger " Storage space in [ $SQL_STORAGE ] reported to be 0Ko. " "WARN"
fi
if [ $SQL_DISK_SPACE -lt $TOTAL_DATABASES_SIZE ] ; then
Logger " Disk space in [ $SQL_STORAGE ] may be insufficient to backup SQL ( $SQL_DISK_SPACE Ko available in $SQL_DRIVE ) (non compressed databases calculation). " "WARN"
fi
if [ $SQL_DISK_SPACE -lt $SQL_WARN_MIN_SPACE ] ; then
Logger " Disk space in [ $SQL_STORAGE ] is lower than warning value [ $SQL_WARN_MIN_SPACE Ko]. " "WARN"
fi
Logger " SQL storage Space: $SQL_DISK_SPACE Ko - Databases size: $TOTAL_DATABASES_SIZE Ko " "NOTICE"
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] && [ $CAN_BACKUP_FILES = = true ] ; then
2015-11-12 01:26:38 +01:00
if [ $FILE_DISK_SPACE -eq 0 ] ; then
Logger " Storage space in [ $FILE_STORAGE ] reported to be 0 Ko. " "WARN"
fi
if [ $FILE_DISK_SPACE -lt $TOTAL_FILES_SIZE ] ; then
Logger " Disk space in [ $FILE_STORAGE ] may be insufficient to backup files ( $FILE_DISK_SPACE Ko available in $FILE_DRIVE ). " "WARN"
fi
if [ $FILE_DISK_SPACE -lt $FILE_WARN_MIN_SPACE ] ; then
Logger " Disk space in [ $FILE_STORAGE ] is lower than warning value [ $FILE_WARN_MIN_SPACE Ko]. " "WARN"
fi
Logger " File storage space: $FILE_DISK_SPACE Ko - Files size: $TOTAL_FILES_SIZE Ko " "NOTICE"
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] ; then
if [ " $SQL_BACKUP " != false ] ; then
2016-09-08 22:51:24 +02:00
if [ " $SQL_DRIVE " = = " $CRYPT_DRIVE " ] ; then
if [ $(( SQL_DISK_SPACE/2)) -lt $(( TOTAL_DATABASES_SIZE)) ] ; then
Logger " Disk space in [ $SQL_STORAGE ] and [ $CRYPT_STORAGE ] may be insufficient to backup SQL ( $SQL_DISK_SPACE Ko available in $SQL_DRIVE ) (non compressed databases calculation + crypt storage space). " "WARN"
fi
else
if [ $(( CRYPT_DISK_SPACE)) -lt $(( TOTAL_DATABASES_SIZE)) ] ; then
Logger " Disk space in [ $CRYPT_STORAGE ] may be insufficient to encrypt SQL ( $CRYPT_DISK_SPACE Ko available in $CRYPT_DRIVE ) (non compressed databases calculation). " "WARN"
fi
fi
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] ; then
2016-09-08 22:51:24 +02:00
if [ " $FILE_DRIVE " = = " $CRYPT_DRIVE " ] ; then
if [ $(( FILE_DISK_SPACE/2)) -lt $(( TOTAL_FILES_SIZE)) ] ; then
Logger " Disk space in [ $FILE_STORAGE ] and [ $CRYPT_STORAGE ] may be insufficient to encrypt Sfiles ( $FILE_DISK_SPACE Ko available in $FILE_DRIVE ). " "WARN"
fi
else
if [ $(( CRYPT_DISK_SPACE)) -lt $(( TOTAL_FILES_SIZE)) ] ; then
Logger " Disk space in [ $CRYPT_STORAGE ] may be insufficient to encrypt files ( $CRYPT_DISK_SPACE Ko available in $CRYPT_DRIVE ). " "WARN"
fi
fi
fi
Logger " Crypt storage space: $CRYPT_DISK_SPACE Ko " "NOTICE"
fi
2019-02-26 12:09:50 +01:00
if [ $BACKUP_SIZE_MINIMUM -gt $(( TOTAL_DATABASES_SIZE+TOTAL_FILES_SIZE)) ] && [ " $GET_BACKUP_SIZE " != false ] ; then
2015-11-12 01:26:38 +01:00
Logger "Backup size is smaller than expected." "WARN"
fi
}
function _BackupDatabaseLocalToLocal {
local database = " ${ 1 } " # Database to backup
2016-09-08 22:51:24 +02:00
local exportOptions = " ${ 2 } " # export options
local encrypt = " ${ 3 :- false } " # Does the file need to be encrypted ?
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local encryptOptions
local drySqlCmd
local sqlCmd
2016-07-19 12:58:05 +02:00
local retval
2015-11-12 01:26:38 +01:00
2016-02-19 22:14:13 +01:00
2016-09-08 22:51:24 +02:00
if [ $encrypt = = true ] ; then
encryptOptions = " | $CRYPT_TOOL --encrypt --recipient=\" $GPG_RECIPIENT \" "
encryptExtension = " $CRYPT_FILE_EXTENSION "
fi
2017-01-04 09:00:47 +01:00
local drySqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions > /dev/null 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
local sqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions > $SQL_STORAGE / $database .sql $COMPRESSION_EXTENSION $encryptExtension 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = false ] ; then
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $sqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $sqlCmd " &
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $drySqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $drySqlCmd " &
2015-11-12 01:26:38 +01:00
fi
2018-07-30 15:36:53 +02:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK true $SLEEP_TIME $KEEP_LOGGING
2016-07-19 12:58:05 +02:00
retval = $?
2017-01-04 09:00:47 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
if [ $_DRYRUN = = false ] ; then
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $sqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
else
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $drySqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
fi
2020-05-03 10:08:02 +02:00
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2016-07-19 13:28:16 +02:00
# Dirty fix for mysqldump return code not honored
retval = 1
2015-11-12 01:26:38 +01:00
fi
return $retval
}
function _BackupDatabaseLocalToRemote {
local database = " ${ 1 } " # Database to backup
2016-09-08 22:51:24 +02:00
local exportOptions = " ${ 2 } " # export options
local encrypt = " ${ 3 :- false } " # Does the file need to be encrypted
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local encryptOptions
local encryptExtension
local drySqlCmd
local sqlCmd
2016-07-19 12:58:05 +02:00
local retval
2016-02-19 22:14:13 +01:00
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
if [ $encrypt = = true ] ; then
encryptOptions = " | $CRYPT_TOOL --encrypt --recipient=\" $GPG_RECIPIENT \" "
encryptExtension = " $CRYPT_FILE_EXTENSION "
fi
2017-01-04 09:00:47 +01:00
local drySqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions > /dev/null 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2017-03-14 22:31:15 +01:00
local sqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions | $SSH_CMD 'env _REMOTE_TOKEN= $_REMOTE_TOKEN $COMMAND_SUDO tee \" $SQL_STORAGE / $database .sql $COMPRESSION_EXTENSION $encryptExtension \" > /dev/null' 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = false ] ; then
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $sqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $sqlCmd " &
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $drySqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $drySqlCmd " &
2015-11-12 01:26:38 +01:00
fi
2018-07-30 15:36:53 +02:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK true $SLEEP_TIME $KEEP_LOGGING
2016-07-19 12:58:05 +02:00
retval = $?
2017-01-04 09:00:47 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
if [ $_DRYRUN = = false ] ; then
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $sqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
else
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $drySqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
fi
2020-05-03 10:08:02 +02:00
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2016-07-19 13:28:16 +02:00
# Dirty fix for mysqldump return code not honored
retval = 1
2015-11-12 01:26:38 +01:00
fi
return $retval
}
function _BackupDatabaseRemoteToLocal {
local database = " ${ 1 } " # Database to backup
2016-09-08 22:51:24 +02:00
local exportOptions = " ${ 2 } " # export options
local encrypt = " ${ 3 :- false } " # Does the file need to be encrypted ?
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local encryptOptions
local encryptExtension
local drySqlCmd
local sqlCmd
2016-02-19 22:14:13 +01:00
local retval
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
if [ $encrypt = = true ] ; then
encryptOptions = " | $CRYPT_TOOL --encrypt --recipient=\\\" $GPG_RECIPIENT \\\" "
encryptExtension = " $CRYPT_FILE_EXTENSION "
fi
2017-03-14 22:31:15 +01:00
local drySqlCmd = $SSH_CMD ' "env _REMOTE_TOKEN=$_REMOTE_TOKEN mysqldump -u ' $SQL_USER ' ' $exportOptions ' --databases ' $database ' ' $COMPRESSION_PROGRAM ' ' $COMPRESSION_OPTIONS ' ' $encryptOptions '" > /dev/null 2> "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID .$TSTAMP '"'
local sqlCmd = $SSH_CMD ' "env _REMOTE_TOKEN=$_REMOTE_TOKEN mysqldump -u ' $SQL_USER ' ' $exportOptions ' --databases ' $database ' ' $COMPRESSION_PROGRAM ' ' $COMPRESSION_OPTIONS ' ' $encryptOptions '" > "' $SQL_STORAGE /$database .sql$COMPRESSION_EXTENSION $encryptExtension '" 2> "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID .$TSTAMP '"'
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = false ] ; then
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $sqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $sqlCmd " &
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $drySqlCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $drySqlCmd " &
2015-11-12 01:26:38 +01:00
fi
2018-07-30 15:36:53 +02:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK true $SLEEP_TIME $KEEP_LOGGING
2016-02-19 22:14:13 +01:00
retval = $?
2017-01-04 09:00:47 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ] ; then
if [ $_DRYRUN = = false ] ; then
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $sqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
else
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $drySqlCmd ]. " "WARN"
2017-01-04 09:00:47 +01:00
fi
2020-05-03 10:08:02 +02:00
Logger " Truncated error output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2016-07-19 13:28:16 +02:00
# Dirty fix for mysqldump return code not honored
retval = 1
2015-11-12 01:26:38 +01:00
fi
return $retval
}
function BackupDatabase {
local database = " ${ 1 } "
2016-09-08 22:51:24 +02:00
local mysqlOptions
local encrypt = false
2016-02-19 22:14:13 +01:00
2015-11-12 01:26:38 +01:00
# Hack to prevent warning on table mysql.events, some mysql versions don't support --skip-events, prefer using --ignore-table
if [ " $database " = = "mysql" ] ; then
2016-09-08 22:51:24 +02:00
mysqlOptions = " $MYSQLDUMP_OPTIONS --ignore-table=mysql.event "
else
mysqlOptions = " $MYSQLDUMP_OPTIONS "
fi
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] ; then
2016-09-08 22:51:24 +02:00
encrypt = true
Logger " Backing up encrypted database [ $database ]. " "NOTICE"
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Logger " Backing up database [ $database ]. " "NOTICE"
2015-11-12 01:26:38 +01:00
fi
if [ " $BACKUP_TYPE " = = "local" ] ; then
2016-09-08 22:51:24 +02:00
_BackupDatabaseLocalToLocal " $database " " $mysqlOptions " $encrypt
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
2016-09-08 22:51:24 +02:00
_BackupDatabaseRemoteToLocal " $database " " $mysqlOptions " $encrypt
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2016-09-08 22:51:24 +02:00
_BackupDatabaseLocalToRemote " $database " " $mysqlOptions " $encrypt
2015-11-12 01:26:38 +01:00
fi
if [ $? -ne 0 ] ; then
Logger "Backup failed." "ERROR"
else
Logger "Backup succeeded." "NOTICE"
fi
}
function BackupDatabases {
local database
for database in $SQL_BACKUP_TASKS
do
2016-08-26 15:10:30 +02:00
BackupDatabase $database
2015-11-12 01:26:38 +01:00
CheckTotalExecutionTime
done
}
2016-09-08 22:51:24 +02:00
function EncryptFiles {
local filePath = " ${ 1 } " # Path of files to encrypt
local destPath = " ${ 2 } " # Path to store encrypted files
local recipient = " ${ 3 } " # GPG recipient
local recursive = " ${ 4 :- true } " # Is recursive ?
local keepFullPath = " ${ 5 :- false } " # Should destpath become destpath + sourcepath ?
2016-08-26 15:10:30 +02:00
2016-09-08 22:51:24 +02:00
local successCounter = 0
local errorCounter = 0
local cryptFileExtension = " $CRYPT_FILE_EXTENSION "
local recursiveArgs = ""
2017-01-04 09:00:47 +01:00
if [ ! -d " $destPath " ] ; then
mkdir -p " $destPath "
if [ $? -ne 0 ] ; then
Logger " Cannot create crypt storage path [ $destPath ]. " "ERROR"
return 1
fi
fi
2016-09-08 22:51:24 +02:00
if [ ! -w " $destPath " ] ; then
Logger " Cannot write to crypt storage path [ $destPath ]. " "ERROR"
return 1
2016-08-26 15:10:30 +02:00
fi
2016-09-08 22:51:24 +02:00
if [ $recursive = = false ] ; then
recursiveArgs = "-mindepth 1 -maxdepth 1"
fi
2017-01-04 09:00:47 +01:00
Logger " Encrypting files in [ $filePath ]. " "NOTICE"
2016-09-08 22:51:24 +02:00
while IFS = read -r -d $'\0' sourceFile; do
# Get path of sourcefile
path = " $( dirname " $sourceFile " ) "
if [ $keepFullPath = = false ] ; then
# Remove source path part
path = " ${ path # $filePath } "
fi
# Remove ending slash if there is one
path = " ${ path %/ } "
# Add new path
path = " $destPath / $path "
# Get filename
file = " $( basename " $sourceFile " ) "
if [ ! -d " $path " ] ; then
mkdir -p " $path "
fi
Logger " Encrypting file [ $sourceFile ] to [ $path / $file $cryptFileExtension ]. " "VERBOSE"
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $PARALLEL_ENCRYPTION_PROCESSES " ) -eq 1 ] && [ " $PARALLEL_ENCRYPTION_PROCESSES " != "1" ] ; then
2017-01-04 09:00:47 +01:00
echo " $CRYPT_TOOL --batch --yes --out \" $path / $file $cryptFileExtension \" --recipient=\" $recipient \" --encrypt \" $sourceFile \" >> \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP \" 2>&1 " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .parallel. $SCRIPT_PID . $TSTAMP "
2016-09-08 22:51:24 +02:00
else
2017-01-04 09:00:47 +01:00
$CRYPT_TOOL --batch --yes --out " $path / $file $cryptFileExtension " --recipient= " $recipient " --encrypt " $sourceFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " 2>& 1
if [ $? -ne 0 ] ; then
Logger " Cannot encrypt [ $sourceFile ]. " "ERROR"
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "DEBUG"
2017-01-04 09:00:47 +01:00
errorCounter = $(( errorCounter+1))
else
successCounter = $(( successCounter+1))
fi
2016-09-08 22:51:24 +02:00
fi
2018-07-30 15:36:53 +02:00
#TODO: This redirection does not work with busybox since there is no subshell support
2017-01-04 09:00:47 +01:00
done < <( $FIND_CMD " $filePath " $recursiveArgs -type f ! -name " * $cryptFileExtension " -print0)
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $PARALLEL_ENCRYPTION_PROCESSES " ) -eq 1 ] && [ " $PARALLEL_ENCRYPTION_PROCESSES " != "1" ] ; then
2017-01-04 09:00:47 +01:00
# Handle batch mode where SOFT /HARD MAX EXEC TIME TOTAL is not defined
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $SOFT_MAX_EXEC_TIME_TOTAL " ) -eq 1 ] ; then
softMaxExecTime = " $SOFT_MAX_EXEC_TIME_TOTAL "
2017-01-04 09:00:47 +01:00
else
softMaxExecTime = 0
fi
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $HARD_MAX_EXEC_TIME_TOTAL " ) -eq 1 ] ; then
hardMaxExecTime = " $HARD_MAX_EXEC_TIME_TOTAL "
2017-01-04 09:00:47 +01:00
else
hardMaxExecTime = 0
fi
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_TOTAL $HARD_MAX_EXEC_TIME_TOTAL true $SLEEP_TIME $KEEP_LOGGING true false false $PARALLEL_ENCRYPTION_PROCESSES " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .parallel. $SCRIPT_PID . $TSTAMP "
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -ne 0 ] ; then
2017-03-14 22:31:15 +01:00
Logger "Encryption error." "ERROR"
2017-01-04 09:00:47 +01:00
# Output file is defined in ParallelExec
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM .ExecTasks. ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "DEBUG"
2017-01-04 09:00:47 +01:00
fi
successCounter = $(( $( wc -l < " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .parallel. $SCRIPT_PID . $TSTAMP " ) - retval))
errorCounter = $retval
fi
if [ $successCounter -gt 0 ] ; then
Logger " Encrypted [ $successCounter ] files successfully. " "NOTICE"
elif [ $successCounter -eq 0 ] && [ $errorCounter -eq 0 ] ; then
Logger "There were no files to encrypt." "WARN"
fi
if [ $errorCounter -gt 0 ] ; then
2016-09-08 22:51:24 +02:00
Logger " Failed to encrypt [ $errorCounter ] files. " "CRITICAL"
fi
return $errorCounter
2016-08-26 15:10:30 +02:00
}
2016-09-08 22:51:24 +02:00
function DecryptFiles {
local filePath = " ${ 1 } " # Path to files to decrypt
local passphraseFile = " ${ 2 } " # Passphrase file to decrypt files
local passphrase = " ${ 3 } " # Passphrase to decrypt files
local options
local secret
local successCounter = 0
local errorCounter = 0
2017-01-04 09:00:47 +01:00
local cryptToolVersion
local cryptToolMajorVersion
local cryptToolSubVersion
2016-09-08 22:51:24 +02:00
local cryptFileExtension = " $CRYPT_FILE_EXTENSION "
2017-01-04 09:00:47 +01:00
local retval
2016-09-08 22:51:24 +02:00
if [ ! -w " $filePath " ] ; then
2017-01-04 09:00:47 +01:00
Logger " Path [ $filePath ] is not writable or does not exist. Cannot decrypt files. " "CRITICAL"
2016-09-08 22:51:24 +02:00
exit 1
fi
2017-01-04 09:00:47 +01:00
# Detect if GnuPG >= 2.1 that does not allow automatic pin entry anymore
2020-05-03 10:08:02 +02:00
cryptToolVersion = $( " $CRYPT_TOOL " --version | head -1 | awk '{print $3}' )
2017-01-04 09:00:47 +01:00
cryptToolMajorVersion = ${ cryptToolVersion %%.* }
cryptToolSubVersion = ${ cryptToolVersion #*. }
cryptToolSubVersion = ${ cryptToolSubVersion %.* }
if [ $cryptToolMajorVersion -eq 2 ] && [ $cryptToolSubVersion -ge 1 ] ; then
additionalParameters = "--pinentry-mode loopback"
fi
2016-09-08 22:51:24 +02:00
if [ -f " $passphraseFile " ] ; then
secret = " --passphrase-file $passphraseFile "
elif [ " $passphrase " != "" ] ; then
secret = " --passphrase $passphrase "
else
Logger "The given passphrase file or passphrase are inexistent." "CRITICAL"
exit 1
fi
2016-08-18 22:16:15 +02:00
2016-09-08 22:51:24 +02:00
if [ " $CRYPT_TOOL " = = "gpg2" ] ; then
options = "--batch --yes"
elif [ " $CRYPT_TOOL " = = "gpg" ] ; then
options = "--no-use-agent --batch"
fi
2016-08-18 22:16:15 +02:00
2016-09-08 22:51:24 +02:00
while IFS = read -r -d $'\0' encryptedFile; do
Logger " Decrypting [ $encryptedFile ]. " "VERBOSE"
2017-01-04 09:00:47 +01:00
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $PARALLEL_ENCRYPTION_PROCESSES " ) -eq 1 ] && [ " $PARALLEL_ENCRYPTION_PROCESSES " != "1" ] ; then
2017-01-04 09:00:47 +01:00
echo " $CRYPT_TOOL $options --out \" ${ encryptedFile %% $cryptFileExtension } \" $additionalParameters $secret --decrypt \" $encryptedFile \" >> \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP \" 2>&1 " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .parallel. $SCRIPT_PID . $TSTAMP "
2016-09-08 22:51:24 +02:00
else
2017-01-04 09:00:47 +01:00
$CRYPT_TOOL $options --out " ${ encryptedFile %% $cryptFileExtension } " $additionalParameters $secret --decrypt " $encryptedFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " 2>& 1
retval = $?
if [ $retval -ne 0 ] ; then
Logger " Cannot decrypt [ $encryptedFile ]. " "ERROR"
2020-05-03 10:08:02 +02:00
Logger " Truncated output\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "NOTICE"
2017-01-04 09:00:47 +01:00
errorCounter = $(( errorCounter+1))
else
successCounter = $(( successCounter+1))
rm -f " $encryptedFile "
if [ $? -ne 0 ] ; then
Logger " Cannot delete original file [ $encryptedFile ] after decryption. " "ERROR"
fi
2016-09-08 22:51:24 +02:00
fi
fi
2017-01-04 09:00:47 +01:00
done < <( $FIND_CMD " $filePath " -type f -name " * $cryptFileExtension " -print0)
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $PARALLEL_ENCRYPTION_PROCESSES " ) -eq 1 ] && [ " $PARALLEL_ENCRYPTION_PROCESSES " != "1" ] ; then
2017-01-04 09:00:47 +01:00
# Handle batch mode where SOFT /HARD MAX EXEC TIME TOTAL is not defined
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $SOFT_MAX_EXEC_TIME_TOTAL " ) -eq 1 ] ; then
2017-01-04 09:00:47 +01:00
softMaxExecTime = $SOFT_MAX_EXEC_TIME_TOTAL
else
softMaxExecTime = 0
fi
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $HARD_MAX_EXEC_TIME_TOTAL " ) -eq 1 ] ; then
2017-01-04 09:00:47 +01:00
hardMaxExecTime = $HARD_MAX_EXEC_TIME_TOTAL
else
hardMaxExecTime = 0
fi
2018-02-24 17:41:57 +01:00
ExecTasks " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .parallel. $SCRIPT_PID . $TSTAMP " " ${ FUNCNAME [0] } " true 0 0 $softMaxExecTime $hardMaxExecTime true $SLEEP_TIME $KEEP_LOGGING true false $PARALLEL_ENCRYPTION_PROCESSES
2017-01-04 09:00:47 +01:00
retval = $?
if [ $retval -ne 0 ] ; then
Logger "Decrypting error.." "ERROR"
# Output file is defined in ParallelExec
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM .ParallelExec.EncryptFiles. $SCRIPT_PID . $TSTAMP " ) " "DEBUG"
2017-01-04 09:00:47 +01:00
fi
successCounter = $(( $( wc -l < " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .parallel. $SCRIPT_PID . $TSTAMP " ) - retval))
errorCounter = $retval
fi
if [ $successCounter -gt 0 ] ; then
Logger " Decrypted [ $successCounter ] files successfully. " "NOTICE"
elif [ $successCounter -eq 0 ] && [ $errorCounter -eq 0 ] ; then
Logger "There were no files to decrypt." "WARN"
fi
2016-09-08 22:51:24 +02:00
if [ $errorCounter -gt 0 ] ; then
Logger " Failed to decrypt [ $errorCounter ] files. " "CRITICAL"
fi
return $errorCounter
2016-08-18 22:16:15 +02:00
}
2015-11-12 01:26:38 +01:00
function Rsync {
2017-01-04 09:00:47 +01:00
local sourceDir = " ${ 1 } " # Source directory
local destinationDir = " ${ 2 } " # Destination directory
2018-07-30 17:35:26 +02:00
local recursive = " ${ 3 :- true } " # Backup only files at toplevel of directory
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local rsyncCmd
local retval
2016-02-19 22:14:13 +01:00
2018-09-30 13:56:00 +02:00
local rsyncArgs
2015-11-12 01:26:38 +01:00
## Manage to backup recursive directories lists files only (not recursing into subdirectories)
2016-09-08 22:51:24 +02:00
if [ $recursive = = false ] ; then
2018-09-30 13:56:00 +02:00
# Fixes symlinks to directories in target cannot be deleted when backing up root directory without recursion
2018-11-06 15:33:16 +01:00
rsyncArgs = " $RSYNC_DEFAULT_ARGS -f '- /*/*/' "
2015-11-12 01:26:38 +01:00
else
2018-09-30 13:56:00 +02:00
rsyncArgs = " $RSYNC_DEFAULT_ARGS "
2015-11-12 01:26:38 +01:00
fi
2015-11-19 22:14:15 +01:00
# Creating subdirectories because rsync cannot handle multiple subdirectory creation
2015-11-12 01:26:38 +01:00
if [ " $BACKUP_TYPE " = = "local" ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryLocal " $destinationDir "
2019-05-21 12:16:08 +02:00
rsyncCmd = " $( type -p $RSYNC_EXECUTABLE ) $rsyncArgs $RSYNC_DRY_ARG $RSYNC_ATTR_ARGS $RSYNC_TYPE_ARGS $RSYNC_NO_RECURSE_ARGS $RSYNC_DELETE $RSYNC_PATTERNS $RSYNC_PARTIAL_EXCLUDE --rsync-path=\" $RSYNC_PATH \" \" $sourceDir \" \" $destinationDir \" > \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP \" 2>&1 "
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryLocal " $destinationDir "
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2020-05-03 10:08:02 +02:00
rsyncCmd = " $( type -p $RSYNC_EXECUTABLE ) $rsyncArgs $RSYNC_DRY_ARG $RSYNC_ATTR_ARGS $RSYNC_TYPE_ARGS $RSYNC_NO_RECURSE_ARGS $RSYNC_DELETE $RSYNC_PATTERNS $RSYNC_PARTIAL_EXCLUDE --rsync-path=\"env _REMOTE_TOKEN= $_REMOTE_TOKEN $RSYNC_PATH \" -e \" $RSYNC_SSH_CMD \" \" $REMOTE_USER @ $REMOTE_HOST :' $sourceDir '\" \" $destinationDir \" > \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP \" 2>&1 "
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2017-01-04 09:00:47 +01:00
_CreateDirectoryRemote " $destinationDir "
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2020-05-03 10:08:02 +02:00
rsyncCmd = " $( type -p $RSYNC_EXECUTABLE ) $rsyncArgs $RSYNC_DRY_ARG $RSYNC_ATTR_ARGS $RSYNC_TYPE_ARGS $RSYNC_NO_RECURSE_ARGS $RSYNC_DELETE $RSYNC_PATTERNS $RSYNC_PARTIAL_EXCLUDE --rsync-path=\"env _REMOTE_TOKEN= $_REMOTE_TOKEN $RSYNC_PATH \" -e \" $RSYNC_SSH_CMD \" \" $sourceDir \" \" $REMOTE_USER @ $REMOTE_HOST :' $destinationDir '\" > \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP \" 2>&1 "
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $rsyncCmd ]. " "DEBUG"
2016-09-08 22:51:24 +02:00
eval " $rsyncCmd " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK true $SLEEP_TIME $KEEP_LOGGING
2016-09-08 22:51:24 +02:00
retval = $?
2017-01-04 09:00:47 +01:00
if [ $retval -ne 0 ] ; then
Logger " Failed to backup [ $sourceDir ] to [ $destinationDir ]. " "ERROR"
2017-03-14 22:31:15 +01:00
_LOGGER_SILENT = true Logger " Command was [ $rsyncCmd ]. " "WARN"
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
else
2020-03-15 22:58:12 +01:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "VERBOSE"
2015-11-12 01:26:38 +01:00
Logger "File backup succeed." "NOTICE"
fi
2016-09-08 22:51:24 +02:00
return $retval
2015-11-12 01:26:38 +01:00
}
function FilesBackup {
2016-08-06 14:04:35 +02:00
local backupTask
local backupTasks
2017-01-04 09:00:47 +01:00
local destinationDir
2018-11-06 15:33:16 +01:00
local encryptDir
2017-01-04 09:00:47 +01:00
2016-08-06 14:04:35 +02:00
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a backupTasks <<< " $FILE_BACKUP_TASKS "
2016-08-06 14:04:35 +02:00
for backupTask in " ${ backupTasks [@] } " ; do
2017-01-04 09:00:47 +01:00
# Backup directories from simple list
2019-02-26 12:09:50 +01:00
if [ " $KEEP_ABSOLUTE_PATHS " != false ] ; then
2018-07-30 16:22:20 +02:00
# Fix for backup of '/'
2018-07-30 16:39:23 +02:00
if [ " ${ backupTask #/ } / " = = "/" ] ; then
destinationDir = " $FILE_STORAGE / "
2018-07-30 16:22:20 +02:00
else
2018-07-30 16:39:23 +02:00
destinationDir = $( dirname " $FILE_STORAGE / ${ backupTask #/ } / " )
2018-07-30 16:22:20 +02:00
fi
2018-11-06 15:33:16 +01:00
encryptDir = " $FILE_STORAGE / ${ backupTask #/ } "
2017-01-04 09:00:47 +01:00
else
destinationDir = " $FILE_STORAGE "
encryptDir = " $FILE_STORAGE "
fi
2018-09-17 11:00:30 +02:00
Logger " Beginning file backup of [ $backupTask ] to [ $destinationDir ] as $BACKUP_TYPE backup. " "NOTICE"
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] && ( [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ) ; then
2016-09-08 22:51:24 +02:00
EncryptFiles " $backupTask " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true true
2017-01-04 09:00:47 +01:00
if [ $? -eq 0 ] ; then
Rsync " $CRYPT_STORAGE / $backupTask " " $destinationDir " true
2016-09-08 22:51:24 +02:00
else
Logger "backup failed." "ERROR"
fi
2019-02-26 12:09:50 +01:00
elif [ " $ENCRYPTION " = = true ] && [ " $BACKUP_TYPE " = = "pull" ] ; then
2017-01-04 09:00:47 +01:00
Rsync " $backupTask " " $destinationDir " true
if [ $? -eq 0 ] ; then
EncryptFiles " $encryptDir " " $CRYPT_STORAGE / $backupTask " " $GPG_RECIPIENT " true false
2016-09-08 22:51:24 +02:00
fi
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
Rsync " $backupTask " " $destinationDir " true
2013-11-02 18:55:17 +01:00
fi
2015-11-12 01:26:38 +01:00
CheckTotalExecutionTime
2013-07-16 23:10:27 +02:00
done
2014-09-22 22:45:18 +02:00
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a backupTasks <<< " $RECURSIVE_DIRECTORY_LIST "
2016-08-06 14:04:35 +02:00
for backupTask in " ${ backupTasks [@] } " ; do
2018-11-06 15:33:16 +01:00
# Backup recursive directories without recursion
2017-01-04 09:00:47 +01:00
2019-02-26 12:09:50 +01:00
if [ " $KEEP_ABSOLUTE_PATHS " != false ] ; then
2018-07-30 16:22:20 +02:00
# Fix for backup of '/'
2018-07-30 16:39:23 +02:00
if [ " ${ backupTask #/ } / " = = "/" ] ; then
destinationDir = " $FILE_STORAGE / "
2018-07-30 16:22:20 +02:00
else
2018-07-30 16:39:23 +02:00
destinationDir = $( dirname " $FILE_STORAGE / ${ backupTask #/ } / " )
2018-07-30 16:22:20 +02:00
fi
2017-01-04 09:00:47 +01:00
encryptDir = " $FILE_STORAGE / ${ backupTask #/ } "
else
destinationDir = " $FILE_STORAGE "
encryptDir = " $FILE_STORAGE "
fi
2018-09-30 16:27:18 +02:00
Logger " Beginning non recursive file backup of [ $backupTask ] to [ $destinationDir ] as $BACKUP_TYPE backup. " "NOTICE"
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] && ( [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ) ; then
2016-09-08 22:51:24 +02:00
EncryptFiles " $backupTask " " $CRYPT_STORAGE " " $GPG_RECIPIENT " false true
2017-01-04 09:00:47 +01:00
if [ $? -eq 0 ] ; then
Rsync " $CRYPT_STORAGE / $backupTask " " $destinationDir " false
2016-09-08 22:51:24 +02:00
else
Logger "backup failed." "ERROR"
fi
2019-02-26 12:09:50 +01:00
elif [ " $ENCRYPTION " = = true ] && [ " $BACKUP_TYPE " = = "pull" ] ; then
2017-01-04 09:00:47 +01:00
Rsync " $backupTask " " $destinationDir " false
if [ $? -eq 0 ] ; then
EncryptFiles " $encryptDir " " $CRYPT_STORAGE / $backupTask " " $GPG_RECIPIENT " false false
2016-09-08 22:51:24 +02:00
fi
2013-07-16 23:10:27 +02:00
else
2017-01-04 09:00:47 +01:00
Rsync " $backupTask " " $destinationDir " false
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
CheckTotalExecutionTime
2013-07-16 23:10:27 +02:00
done
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a backupTasks <<< " $FILE_RECURSIVE_BACKUP_TASKS "
2016-08-06 14:04:35 +02:00
for backupTask in " ${ backupTasks [@] } " ; do
2015-11-12 01:26:38 +01:00
# Backup sub directories of recursive directories
2017-01-04 09:00:47 +01:00
2019-02-26 12:09:50 +01:00
if [ " $KEEP_ABSOLUTE_PATHS " != false ] ; then
2018-07-30 16:22:20 +02:00
# Fix for backup of '/'
2018-07-30 16:39:23 +02:00
if [ " ${ backupTask #/ } / " = = "/" ] ; then
destinationDir = " $FILE_STORAGE / "
2018-07-30 16:22:20 +02:00
else
2018-07-30 16:39:23 +02:00
destinationDir = $( dirname " $FILE_STORAGE / ${ backupTask #/ } / " )
2018-07-30 16:22:20 +02:00
fi
2018-11-06 15:33:16 +01:00
encryptDir = " $FILE_STORAGE / ${ backupTask #/ } "
2017-01-04 09:00:47 +01:00
else
destinationDir = " $FILE_STORAGE "
encryptDir = " $FILE_STORAGE "
fi
2018-09-30 16:27:18 +02:00
Logger " Beginning recursive child file backup of [ $backupTask ] to [ $destinationDir ] as $BACKUP_TYPE backup. " "NOTICE"
2019-02-26 12:09:50 +01:00
if [ " $ENCRYPTION " = = true ] && ( [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ) ; then
2016-09-08 22:51:24 +02:00
EncryptFiles " $backupTask " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true true
2017-01-04 09:00:47 +01:00
if [ $? -eq 0 ] ; then
Rsync " $CRYPT_STORAGE / $backupTask " " $destinationDir " true
2016-09-08 22:51:24 +02:00
else
Logger "backup failed." "ERROR"
fi
2019-02-26 12:09:50 +01:00
elif [ " $ENCRYPTION " = = true ] && [ " $BACKUP_TYPE " = = "pull" ] ; then
2017-01-04 09:00:47 +01:00
Rsync " $backupTask " " $destinationDir " true
if [ $? -eq 0 ] ; then
EncryptFiles " $encryptDir " " $CRYPT_STORAGE / $backupTask " " $GPG_RECIPIENT " true false
2016-09-08 22:51:24 +02:00
fi
2015-11-12 01:26:38 +01:00
else
2017-01-04 09:00:47 +01:00
Rsync " $backupTask " " $destinationDir " true
2015-11-12 01:26:38 +01:00
fi
CheckTotalExecutionTime
done
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function CheckTotalExecutionTime {
#### Check if max execution time of whole script as been reached
if [ $SECONDS -gt $SOFT_MAX_EXEC_TIME_TOTAL ] ; then
2017-01-04 09:00:47 +01:00
Logger "Max soft execution time of the whole backup exceeded." "WARN"
2016-08-26 15:10:30 +02:00
SendAlert true
2017-01-04 09:00:47 +01:00
fi
if [ $SECONDS -gt $HARD_MAX_EXEC_TIME_TOTAL ] && [ $HARD_MAX_EXEC_TIME_TOTAL -ne 0 ] ; then
Logger "Max hard execution time of the whole backup exceeded, stopping backup process." "CRITICAL"
exit 1
2013-07-16 23:10:27 +02:00
fi
}
2015-11-12 01:26:38 +01:00
function _RotateBackupsLocal {
2017-01-04 09:00:47 +01:00
local backupPath = " ${ 1 } "
local rotateCopies = " ${ 2 } "
2015-11-12 01:26:38 +01:00
2016-02-19 22:14:13 +01:00
local backup
local copy
local cmd
local path
2017-01-04 09:00:47 +01:00
$FIND_CMD " $backupPath " -mindepth 1 -maxdepth 1 ! -regex " .*\. $PROGRAM \.[0-9]+ " -print0 | while IFS = read -r -d $'\0' backup; do
copy = $rotateCopies
2016-08-08 19:00:52 +02:00
while [ $copy -gt 1 ] ; do
2017-01-04 09:00:47 +01:00
if [ $copy -eq $rotateCopies ] ; then
2016-08-18 11:53:18 +02:00
path = " $backup . $PROGRAM . $copy "
if [ -f " $path " ] || [ -d " $path " ] ; then
cmd = " rm -rf \" $path \" "
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $cmd ]. " "DEBUG"
2016-08-18 11:53:18 +02:00
eval " $cmd " &
2020-03-15 22:58:12 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 3600 0 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-18 11:53:18 +02:00
Logger " Cannot delete oldest copy [ $path ]. " "ERROR"
2020-03-15 22:58:12 +01:00
_LOGGER_SILENT = true Logger " Command was [ $cmd ]. " "WARN"
2016-08-18 11:53:18 +02:00
fi
2015-11-12 01:26:38 +01:00
fi
fi
2016-08-18 11:53:18 +02:00
2017-01-04 09:00:47 +01:00
path = " $backup . $PROGRAM . $(( copy-1)) "
2016-08-18 11:53:18 +02:00
if [ -f " $path " ] || [ -d " $path " ] ; then
2016-08-17 10:01:55 +02:00
cmd = " mv \" $path \" \" $backup . $PROGRAM . $copy \" "
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $cmd ]. " "DEBUG"
2015-11-12 01:26:38 +01:00
eval " $cmd " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 3600 0 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot move [ $path ] to [ $backup . $PROGRAM . $copy ]. " "ERROR"
2020-03-15 22:58:12 +01:00
_LOGGER_SILENT = true Logger " Command was [ $cmd ]. " "WARN"
2015-11-12 01:26:38 +01:00
fi
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
fi
2017-01-04 09:00:47 +01:00
copy = $(( copy-1))
2015-11-12 01:26:38 +01:00
done
2013-11-02 18:55:17 +01:00
2018-09-30 16:27:18 +02:00
# TODO: Describe new behavior: Always copy instead of move in order to make delta copies
2015-11-12 01:26:38 +01:00
# Latest file backup will not be moved if script configured for remote backup so next rsync execution will only do delta copy instead of full one
2018-09-30 16:27:18 +02:00
# Whereas sql files will always be moved because we don't do deltas on sql files
2015-11-12 01:26:38 +01:00
if [ [ $backup = = *.sql.* ] ] ; then
2016-08-17 10:01:55 +02:00
cmd = " mv \" $backup \" \" $backup . $PROGRAM .1\" "
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $cmd ]. " "DEBUG"
2015-11-12 01:26:38 +01:00
eval " $cmd " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 3600 0 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot move [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2018-09-30 16:27:18 +02:00
_LOGGER_SILENT = true Logger " Command was [ $cmd ]. " "WARN"
2015-11-12 01:26:38 +01:00
fi
2013-08-25 12:39:13 +02:00
2018-09-30 16:27:18 +02:00
else
2019-02-26 12:09:50 +01:00
#elif [ "$REMOTE_OPERATION" == true ]; then
2016-08-17 10:01:55 +02:00
cmd = " cp -R \" $backup \" \" $backup . $PROGRAM .1\" "
2017-01-04 09:00:47 +01:00
Logger " Launching command [ $cmd ]. " "DEBUG"
2015-11-12 01:26:38 +01:00
eval " $cmd " &
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 3600 0 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot copy [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2018-09-30 16:27:18 +02:00
_LOGGER_SILENT = true Logger " Command was [ $cmd ]. " "WARN"
2013-07-16 23:10:27 +02:00
fi
2014-09-22 22:45:18 +02:00
2018-09-30 16:27:18 +02:00
#else
# cmd="mv \"$backup\" \"$backup.$PROGRAM.1\""
# Logger "Launching command [$cmd]." "DEBUG"
# eval "$cmd" &
# ExecTasks $! "${FUNCNAME[0]}" false 0 0 3600 0 true $SLEEP_TIME $KEEP_LOGGING
# if [ $? -ne 0 ]; then
# Logger "Cannot move [$backup] to [$backup.$PROGRAM.1]." "ERROR"
# _LOGGER_SILENT=true Logger "Command was [$cmd]." "WARN"
# fi
2015-11-12 01:26:38 +01:00
fi
done
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _RotateBackupsRemote {
2017-01-04 09:00:47 +01:00
local backupPath = " ${ 1 } "
local rotateCopies = " ${ 2 } "
2017-03-14 22:31:15 +01:00
$SSH_CMD env _REMOTE_TOKEN = $_REMOTE_TOKEN \
env _DEBUG = " ' $_DEBUG ' " env _PARANOIA_DEBUG = " ' $_PARANOIA_DEBUG ' " env _LOGGER_SILENT = " ' $_LOGGER_SILENT ' " env _LOGGER_VERBOSE = " ' $_LOGGER_VERBOSE ' " env _LOGGER_PREFIX = " ' $_LOGGER_PREFIX ' " env _LOGGER_ERR_ONLY = " ' $_LOGGER_ERR_ONLY ' " \
2018-11-06 19:17:07 +01:00
env _REMOTE_EXECUTION = "true" env PROGRAM = " ' $PROGRAM ' " env SCRIPT_PID = " ' $SCRIPT_PID ' " env TSTAMP = " ' $TSTAMP ' " \
2017-01-04 09:00:47 +01:00
env REMOTE_FIND_CMD = " ' $REMOTE_FIND_CMD ' " env rotateCopies = " ' $rotateCopies ' " env backupPath = " ' $backupPath ' " \
$COMMAND_SUDO ' bash -s' << 'ENDSSH' > "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID .$TSTAMP " 2> " $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID .$TSTAMP "
2020-03-15 22:58:12 +01:00
_REMOTE_TOKEN = "(o_0)"
2017-01-04 09:00:47 +01:00
2019-02-26 12:09:50 +01:00
## allow debugging from command line with _DEBUG=true
if [ ! " $_DEBUG " = = true ] ; then
_DEBUG = false
2017-01-04 09:00:47 +01:00
_LOGGER_VERBOSE = false
else
trap 'TrapError ${LINENO} $?' ERR
_LOGGER_VERBOSE = true
fi
if [ " $SLEEP_TIME " = = "" ] ; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
SLEEP_TIME = .05
fi
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
if [ $_LOGGER_SILENT = = false ] ; then
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
fi
}
# Array to string converter, see http://stackoverflow.com/questions/1527049/bash-join-elements-of-an-array
# usage: joinString separaratorChar Array
function joinString {
local IFS = " $1 " ; shift; echo " $* " ;
}
# Sub function of Logger
function _Logger {
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-03-14 22:31:15 +01:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2017-01-04 09:00:47 +01:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-07-30 15:36:53 +02:00
# Build current log file for alerts if we have a sufficient environment
2019-05-21 11:46:07 +02:00
if [ " $RUN_DIR / $PROGRAM " != "/" ] ; then
2020-03-15 22:58:12 +01:00
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM ._Logger. $SCRIPT_PID . $TSTAMP "
2018-07-30 15:36:53 +02:00
fi
2017-01-04 09:00:47 +01:00
fi
2016-02-19 22:14:13 +01:00
2017-01-04 09:00:47 +01:00
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-03-14 22:31:15 +01:00
if [ $toStdErr = = true ] ; then
2017-01-04 09:00:47 +01:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
2015-11-12 01:26:38 +01:00
2017-01-04 09:00:47 +01:00
else
echo -e " $stdValue "
fi
fi
2015-11-12 01:26:38 +01:00
}
2017-01-04 09:00:47 +01:00
# Remote logger similar to below Logger, without log to file and alert flags
2015-11-12 01:26:38 +01:00
function RemoteLogger {
2017-01-04 09:00:47 +01:00
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2015-11-12 01:26:38 +01:00
2018-11-06 15:33:16 +01:00
local prefix
2017-01-04 09:00:47 +01:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2020-03-15 22:58:12 +01:00
prefix = " RTIME: $SECONDS - "
2017-01-04 09:00:47 +01:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
prefix = " R $( date) - "
else
prefix = ""
fi
2015-11-12 01:26:38 +01:00
if [ " $level " = = "CRITICAL" ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
2015-11-12 01:26:38 +01:00
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
2015-11-12 01:26:38 +01:00
return
elif [ " $level " = = "WARN" ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix \e[33m $value \e[0m " true
2019-02-26 12:09:50 +01:00
if [ $_DEBUG = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
2015-11-12 01:26:38 +01:00
return
elif [ " $level " = = "NOTICE" ] ; then
2017-01-04 09:00:47 +01:00
if [ $_LOGGER_ERR_ONLY != true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
_Logger "" " $prefix $value "
fi
return
elif [ " $level " = = "ALWAYS" ] ; then
2018-07-30 15:36:53 +02:00
_Logger "" " $prefix $value "
2015-11-12 01:26:38 +01:00
return
elif [ " $level " = = "DEBUG" ] ; then
2019-02-26 12:09:50 +01:00
if [ " $_DEBUG " = = true ] ; then
2017-01-04 09:00:47 +01:00
_Logger "" " $prefix $value "
2015-11-12 01:26:38 +01:00
return
fi
else
2017-01-04 09:00:47 +01:00
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
2015-11-12 01:26:38 +01:00
fi
}
function _RotateBackupsRemoteSSH {
2018-09-30 17:18:09 +02:00
local backup
local copy
local cmd
local path
2017-01-04 09:00:47 +01:00
$REMOTE_FIND_CMD " $backupPath " -mindepth 1 -maxdepth 1 ! -regex " .*\. $PROGRAM \.[0-9]+ " -print0 | while IFS = read -r -d $'\0' backup; do
copy = $rotateCopies
2016-08-08 19:00:52 +02:00
while [ $copy -gt 1 ] ; do
2017-01-04 09:00:47 +01:00
if [ $copy -eq $rotateCopies ] ; then
2016-08-18 11:53:18 +02:00
path = " $backup . $PROGRAM . $copy "
if [ -f " $path " ] || [ -d " $path " ] ; then
2017-01-04 09:00:47 +01:00
cmd = " rm -rf \" $path \" "
RemoteLogger " Launching command [ $cmd ]. " "DEBUG"
2016-08-18 11:53:18 +02:00
eval " $cmd "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-18 11:53:18 +02:00
RemoteLogger " Cannot delete oldest copy [ $path ]. " "ERROR"
2017-01-04 09:00:47 +01:00
RemoteLogger " Command was [ $cmd ]. " "WARN"
2016-08-18 11:53:18 +02:00
fi
2015-11-12 01:26:38 +01:00
fi
2013-07-16 23:10:27 +02:00
fi
2017-01-04 09:00:47 +01:00
path = " $backup . $PROGRAM . $(( copy-1)) "
2016-08-18 11:53:18 +02:00
if [ -f " $path " ] || [ -d " $path " ] ; then
2017-01-04 09:00:47 +01:00
cmd = " mv \" $path \" \" $backup . $PROGRAM . $copy \" "
RemoteLogger " Launching command [ $cmd ]. " "DEBUG"
2015-11-12 01:26:38 +01:00
eval " $cmd "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot move [ $path ] to [ $backup . $PROGRAM . $copy ]. " "ERROR"
2017-01-04 09:00:47 +01:00
RemoteLogger " Command was [ $cmd ]. " "WARN"
2015-11-12 01:26:38 +01:00
fi
2014-09-22 22:45:18 +02:00
2013-07-16 23:10:27 +02:00
fi
2018-09-30 17:18:09 +02:00
copy = $(( copy-1))
2013-07-16 23:10:27 +02:00
done
# Latest file backup will not be moved if script configured for remote backup so next rsync execution will only do delta copy instead of full one
2015-11-12 01:26:38 +01:00
if [ [ $backup = = *.sql.* ] ] ; then
2017-01-04 09:00:47 +01:00
cmd = " mv \" $backup \" \" $backup . $PROGRAM .1\" "
RemoteLogger " Launching command [ $cmd ]. " "DEBUG"
2015-11-12 01:26:38 +01:00
eval " $cmd "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot move [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2017-01-04 09:00:47 +01:00
RemoteLogger " Command was [ $cmd ]. " "WARN"
2015-11-12 01:26:38 +01:00
fi
2014-09-22 22:45:18 +02:00
2018-09-30 17:06:13 +02:00
else
2019-02-26 12:09:50 +01:00
#elif [ "$REMOTE_OPERATION" == true ]; then
2017-01-04 09:00:47 +01:00
cmd = " cp -R \" $backup \" \" $backup . $PROGRAM .1\" "
RemoteLogger " Launching command [ $cmd ]. " "DEBUG"
2015-11-12 01:26:38 +01:00
eval " $cmd "
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot copy [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2017-01-04 09:00:47 +01:00
RemoteLogger " Command was [ $cmd ]. " "WARN"
2015-11-12 01:26:38 +01:00
fi
2014-09-22 22:45:18 +02:00
2018-09-30 17:06:13 +02:00
#else
# cmd="mv \"$backup\" \"$backup.$PROGRAM.1\""
# RemoteLogger "Launching command [$cmd]." "DEBUG"
# eval "$cmd"
# if [ $? -ne 0 ]; then
# RemoteLogger "Cannot move [$backup] to [$backup.$PROGRAM.1]." "ERROR"
# RemoteLogger "Command was [$cmd]." "WARN"
# fi
2013-07-16 23:10:27 +02:00
fi
done
}
2015-11-12 01:26:38 +01:00
_RotateBackupsRemoteSSH
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
ENDSSH
2018-02-24 17:41:57 +01:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 1800 0 true $SLEEP_TIME $KEEP_LOGGING
2017-01-04 09:00:47 +01:00
if [ $? -ne 0 ] ; then
Logger " Could not rotate backups in [ $backupPath ]. " "ERROR"
2020-05-03 10:08:02 +02:00
Logger " Truncated output:\n $( head -c16384 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
2015-11-12 01:26:38 +01:00
else
Logger "Remote rotation succeed." "NOTICE"
fi ## Need to add a trivial sleep time to give ssh time to log to local file
#sleep 5
}
2017-01-04 09:00:47 +01:00
#TODO: test find cmd for backup rotation with regex on busybox / mac
2015-11-12 01:26:38 +01:00
function RotateBackups {
2017-01-04 09:00:47 +01:00
local backupPath = " ${ 1 } "
local rotateCopies = " ${ 2 } "
2015-11-12 01:26:38 +01:00
2017-01-04 09:00:47 +01:00
2015-11-12 01:26:38 +01:00
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "pull" ] ; then
2018-09-30 17:18:09 +02:00
Logger " Rotating local backups in [ $backupPath ] for [ $rotateCopies ] copies. " "NOTICE"
2017-01-04 09:00:47 +01:00
_RotateBackupsLocal " $backupPath " " $rotateCopies "
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2018-09-30 17:18:09 +02:00
Logger " Rotating remote backups in [ $backupPath ] for [ $rotateCopies ] copies. " "NOTICE"
2017-01-04 09:00:47 +01:00
_RotateBackupsRemote " $backupPath " " $rotateCopies "
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
}
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
function Init {
2013-09-22 12:04:09 +02:00
2016-02-19 22:14:13 +01:00
local uri
local hosturiandpath
local hosturi
2015-11-12 01:26:38 +01:00
## Test if target dir is a ssh uri, and if yes, break it down it its values
if [ " ${ REMOTE_SYSTEM_URI : 0 : 6 } " = = "ssh://" ] && [ " $BACKUP_TYPE " != "local" ] ; then
2019-02-26 12:09:50 +01:00
REMOTE_OPERATION = true
2013-07-20 14:48:06 +02:00
2015-11-12 01:26:38 +01:00
# remove leadng 'ssh://'
uri = ${ REMOTE_SYSTEM_URI #ssh : //* }
if [ [ " $uri " = = *"@" * ] ] ; then
# remove everything after '@'
REMOTE_USER = ${ uri %@* }
2013-09-22 12:04:09 +02:00
else
2015-11-12 01:26:38 +01:00
REMOTE_USER = $LOCAL_USER
fi
2013-07-20 14:48:06 +02:00
2015-11-12 01:26:38 +01:00
if [ " $SSH_RSA_PRIVATE_KEY " = = "" ] ; then
2016-11-10 16:25:37 +01:00
if [ ! -f " $SSH_PASSWORD_FILE " ] ; then
# Assume that there might exist a standard rsa key
SSH_RSA_PRIVATE_KEY = ~/.ssh/id_rsa
fi
2015-11-12 01:26:38 +01:00
fi
# remove everything before '@'
2016-02-19 22:14:13 +01:00
hosturiandpath = ${ uri #*@ }
2015-11-12 01:26:38 +01:00
# remove everything after first '/'
2016-02-19 22:14:13 +01:00
hosturi = ${ hosturiandpath %%/* }
if [ [ " $hosturi " = = *":" * ] ] ; then
REMOTE_PORT = ${ hosturi ##* : }
2015-11-12 01:26:38 +01:00
else
REMOTE_PORT = 22
fi
2016-02-19 22:14:13 +01:00
REMOTE_HOST = ${ hosturi %% : * }
2015-11-12 01:26:38 +01:00
fi
2017-06-20 19:02:22 +02:00
## Add update to default RSYNC_TYPE_ARGS
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " -u"
2015-11-12 01:26:38 +01:00
2016-11-17 21:02:15 +01:00
if [ $_LOGGER_VERBOSE = = true ] ; then
2017-06-20 19:02:22 +02:00
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " -i"
2013-08-18 11:58:55 +02:00
fi
2019-02-26 12:09:50 +01:00
if [ " $DELETE_VANISHED_FILES " = = true ] ; then
2017-06-20 19:02:22 +02:00
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " --delete"
2015-01-08 17:16:57 +01:00
fi
2016-08-31 11:26:21 +02:00
if [ $stats = = true ] ; then
2017-06-20 19:02:22 +02:00
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " --stats"
2014-12-21 22:28:05 +01:00
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
## Fix for symlink to directories on target cannot get updated
2017-06-20 19:02:22 +02:00
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " --force"
2014-09-22 22:45:18 +02:00
}
2015-11-12 01:26:38 +01:00
function Main {
2013-07-16 23:10:27 +02:00
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] && [ $CAN_BACKUP_SQL = = true ] ; then
2013-07-16 23:10:27 +02:00
ListDatabases
fi
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] && [ $CAN_BACKUP_FILES = = true ] ; then
2015-11-12 01:26:38 +01:00
ListRecursiveBackupDirectories
2019-02-26 12:09:50 +01:00
if [ " $GET_BACKUP_SIZE " != false ] ; then
2015-04-20 14:07:45 +02:00
GetDirectoriesSize
2015-11-12 01:26:38 +01:00
else
2016-08-16 20:39:49 +02:00
TOTAL_FILES_SIZE = -1
2015-04-20 14:07:45 +02:00
fi
2013-07-16 23:10:27 +02:00
fi
2013-08-24 19:41:18 +02:00
2016-08-31 11:26:21 +02:00
# Expand ~ if exists
FILE_STORAGE = " ${ FILE_STORAGE /# \~ / $HOME } "
SQL_STORAGE = " ${ SQL_STORAGE /# \~ / $HOME } "
SSH_RSA_PRIVATE_KEY = " ${ SSH_RSA_PRIVATE_KEY /# \~ / $HOME } "
2016-11-10 16:25:37 +01:00
SSH_PASSWORD_FILE = " ${ SSH_PASSWORD_FILE /# \~ / $HOME } "
2016-09-08 22:51:24 +02:00
ENCRYPT_PUBKEY = " ${ ENCRYPT_PUBKEY /# \~ / $HOME } "
2016-08-31 11:26:21 +02:00
2019-02-26 12:09:50 +01:00
if [ " $CREATE_DIRS " != false ] ; then
2015-11-12 01:26:38 +01:00
CreateStorageDirectories
fi
CheckDiskSpace
2013-07-16 23:10:27 +02:00
2013-08-18 11:58:55 +02:00
# Actual backup process
2019-02-26 12:09:50 +01:00
if [ " $SQL_BACKUP " != false ] && [ $CAN_BACKUP_SQL = = true ] ; then
if [ $_DRYRUN = = false ] && [ " $ROTATE_SQL_BACKUPS " = = true ] ; then
2015-11-16 12:52:15 +01:00
RotateBackups " $SQL_STORAGE " " $ROTATE_SQL_COPIES "
2013-07-16 23:10:27 +02:00
fi
2014-11-27 14:40:30 +01:00
BackupDatabases
2013-07-16 23:10:27 +02:00
fi
2013-08-18 11:58:55 +02:00
2019-02-26 12:09:50 +01:00
if [ " $FILE_BACKUP " != false ] && [ $CAN_BACKUP_FILES = = true ] ; then
if [ $_DRYRUN = = false ] && [ " $ROTATE_FILE_BACKUPS " = = true ] ; then
2015-11-16 12:52:15 +01:00
RotateBackups " $FILE_STORAGE " " $ROTATE_FILE_COPIES "
2013-07-16 23:10:27 +02:00
fi
2015-11-28 12:48:19 +01:00
## Add Rsync include / exclude patterns
RsyncPatterns
2013-07-16 23:10:27 +02:00
FilesBackup
fi
}
2015-11-12 01:26:38 +01:00
function Usage {
2019-02-26 12:09:50 +01:00
if [ " $IS_STABLE " != true ] ; then
2015-11-12 01:26:38 +01:00
echo -e "\e[93mThis is an unstable dev build. Please use with caution.\e[0m"
fi
echo " $PROGRAM $PROGRAM_VERSION $PROGRAM_BUILD "
2014-09-22 22:45:18 +02:00
echo " $AUTHOR "
echo " $CONTACT "
2013-07-16 23:10:27 +02:00
echo ""
2016-09-08 22:51:24 +02:00
echo " General usage: $0 /path/to/backup.conf [OPTIONS] "
2013-07-16 23:10:27 +02:00
echo ""
2015-11-12 01:26:38 +01:00
echo "OPTIONS:"
2017-01-04 09:00:47 +01:00
echo " --dry will run $PROGRAM without actually doing anything, just testing "
echo "--no-prefix Will suppress time / date suffix from output"
echo " --silent will run $PROGRAM without any output to stdout, usefull for cron backups "
2016-11-17 21:02:15 +01:00
echo "--errors-only Output only errors (can be combined with silent or verbose)"
2016-02-16 21:09:57 +01:00
echo "--verbose adds command outputs"
2015-11-12 01:26:38 +01:00
echo "--stats Adds rsync transfer statistics to verbose output"
echo "--partial Allows rsync to keep partial downloads that can be resumed later (experimental)"
2015-01-08 17:16:57 +01:00
echo "--no-maxtime disables any soft and hard execution time checks"
echo "--delete Deletes files on destination that vanished on source"
2015-11-12 01:26:38 +01:00
echo "--dontgetsize Does not try to evaluate backup size"
2017-01-04 09:00:47 +01:00
echo "--parallel=ncpu Use n cpus to encrypt / decrypt files. Works in normal and batch processing mode."
2016-09-08 22:51:24 +02:00
echo ""
echo "Batch processing usage:"
echo -e " \e[93mDecrypt\e[0m a backup encrypted with $PROGRAM "
echo " $0 --decrypt=/path/to/encrypted_backup --passphrase-file=/path/to/passphrase "
echo " $0 --decrypt=/path/to/encrypted_backup --passphrase=MySecretPassPhrase (security risk) "
echo ""
2017-01-04 09:00:47 +01:00
echo "Batch encrypt directories in separate gpg files"
2016-09-08 22:51:24 +02:00
echo " $0 --encrypt=/path/to/files --destination=/path/to/encrypted/files --recipient=\"Your Name\" "
2013-07-16 23:10:27 +02:00
exit 128
}
2018-11-06 15:33:16 +01:00
#### SCRIPT ENTRY POINT ####
trap TrapQuit EXIT
2015-04-24 23:41:01 +02:00
# Command line argument flags
2016-08-31 11:26:21 +02:00
_DRYRUN = false
no_maxtime = false
stats = false
2017-06-20 15:23:29 +02:00
partial_transfers = false
delete_vanished = false
dont_get_backup_size = false
2016-09-08 22:51:24 +02:00
_DECRYPT_MODE = false
DECRYPT_PATH = ""
_ENCRYPT_MODE = false
2015-04-24 22:31:39 +02:00
2015-11-12 01:26:38 +01:00
function GetCommandlineArguments {
2017-06-20 19:02:22 +02:00
local isFirstArgument = true
2015-11-12 01:26:38 +01:00
if [ $# -eq 0 ] ; then
2013-07-16 23:10:27 +02:00
Usage
2015-04-24 22:31:39 +02:00
fi
2016-08-08 19:00:52 +02:00
for i in " $@ " ; do
2019-05-21 11:46:07 +02:00
case " $i " in
2015-04-24 22:31:39 +02:00
--dry)
2016-08-31 11:26:21 +02:00
_DRYRUN = true
2015-04-24 22:31:39 +02:00
; ;
--silent)
2016-11-17 21:02:15 +01:00
_LOGGER_SILENT = true
2015-04-24 22:31:39 +02:00
; ;
--verbose)
2016-11-17 21:02:15 +01:00
_LOGGER_VERBOSE = true
2015-04-24 22:31:39 +02:00
; ;
--stats)
2019-05-21 12:16:08 +02:00
stats = true
2015-04-24 22:31:39 +02:00
; ;
--partial)
2017-06-20 15:23:29 +02:00
partial_transfers = true
2015-04-24 22:31:39 +02:00
; ;
--no-maxtime)
2016-08-31 11:26:21 +02:00
no_maxtime = true
2015-04-24 22:31:39 +02:00
; ;
--delete)
2017-06-20 15:23:29 +02:00
delete_vanished = true
2015-04-24 22:31:39 +02:00
; ;
--dontgetsize)
2017-06-20 15:23:29 +02:00
dont_get_backup_size = true
2015-04-24 22:31:39 +02:00
; ;
--help| -h| --version| -v)
Usage
; ;
2016-09-08 22:51:24 +02:00
--decrypt= *)
_DECRYPT_MODE = true
DECRYPT_PATH = " ${ i ##*= } "
; ;
--passphrase= *)
PASSPHRASE = " ${ i ##*= } "
; ;
--passphrase-file= *)
PASSPHRASE_FILE = " ${ i ##*= } "
; ;
--encrypt= *)
_ENCRYPT_MODE = true
CRYPT_SOURCE = " ${ i ##*= } "
; ;
--destination= *)
CRYPT_STORAGE = " ${ i ##*= } "
; ;
--recipient= *)
GPG_RECIPIENT = " ${ i ##*= } "
; ;
2016-11-17 21:02:15 +01:00
--errors-only)
_LOGGER_ERR_ONLY = true
; ;
2017-01-04 09:00:47 +01:00
--no-prefix)
_LOGGER_PREFIX = ""
; ;
--parallel= *)
PARALLEL_ENCRYPTION_PROCESSES = " ${ i ##*= } "
2020-05-03 10:08:02 +02:00
if [ $( IsNumeric " $PARALLEL_ENCRYPTION_PROCESSES " ) -ne 1 ] ; then
2017-01-04 09:00:47 +01:00
Logger "Bogus --parallel value. Using only one CPU." "WARN"
fi
2017-06-20 19:02:22 +02:00
; ;
*)
if [ $isFirstArgument = = false ] ; then
Logger " Unknown option ' $i ' " "CRITICAL"
Usage
fi
; ;
2015-04-24 22:31:39 +02:00
esac
2017-06-20 19:02:22 +02:00
isFirstArgument = false
2015-04-24 22:31:39 +02:00
done
}
2013-07-16 23:10:27 +02:00
2015-04-24 23:41:01 +02:00
GetCommandlineArguments " $@ "
2019-05-21 11:46:07 +02:00
2016-09-08 22:51:24 +02:00
if [ " $_DECRYPT_MODE " = = true ] ; then
CheckCryptEnvironnment
2017-01-04 09:00:47 +01:00
GetLocalOS
InitLocalOSDependingSettings
Logger " $DRY_WARNING $PROGRAM v $PROGRAM_VERSION decrypt mode begin. " "ALWAYS"
2016-09-08 22:51:24 +02:00
DecryptFiles " $DECRYPT_PATH " " $PASSPHRASE_FILE " " $PASSPHRASE "
exit $?
fi
if [ " $_ENCRYPT_MODE " = = true ] ; then
CheckCryptEnvironnment
2017-01-04 09:00:47 +01:00
GetLocalOS
InitLocalOSDependingSettings
Logger " $DRY_WARNING $PROGRAM v $PROGRAM_VERSION encrypt mode begin. " "ALWAYS"
2016-09-08 22:51:24 +02:00
EncryptFiles " $CRYPT_SOURCE " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true false
exit $?
fi
2015-11-12 01:26:38 +01:00
LoadConfigFile " $1 "
2019-05-21 11:46:07 +02:00
# Reload GetCommandlineArguments to override config file with runtime arguments
GetCommandlineArguments " $@ "
2015-11-12 01:26:38 +01:00
if [ " $LOGFILE " = = "" ] ; then
if [ -w /var/log ] ; then
2016-04-06 20:40:20 +02:00
LOG_FILE = " /var/log/ $PROGRAM . $INSTANCE_ID .log "
2020-03-15 22:58:12 +01:00
elif ( [ " ${ HOME } " != "" ] && [ -w " ${ HOME } " ] ) ; then
2016-08-31 11:26:21 +02:00
LOG_FILE = " ${ HOME } / $PROGRAM . $INSTANCE_ID .log "
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
LOG_FILE = ./$PROGRAM .$INSTANCE_ID .log
2013-07-16 23:10:27 +02:00
fi
else
2015-11-12 01:26:38 +01:00
LOG_FILE = " $LOGFILE "
fi
2019-02-26 12:09:50 +01:00
# v2.3 config syntax compatibility
UpdateBooleans
2020-05-03 10:08:02 +02:00
if [ ! -w " $( dirname " $LOG_FILE " ) " ] ; then
echo " Cannot write to log [ $( dirname " $LOG_FILE " ) ]. "
2016-11-10 16:25:37 +01:00
else
Logger " Script begin, logging to [ $LOG_FILE ]. " "DEBUG"
fi
2016-04-06 20:41:58 +02:00
2016-08-31 11:26:21 +02:00
if [ $no_maxtime = = true ] ; then
2015-11-12 01:26:38 +01:00
SOFT_MAX_EXEC_TIME_DB_TASK = 0
SOFT_MAX_EXEC_TIME_FILE_TASK = 0
HARD_MAX_EXEC_TIME_DB_TASK = 0
HARD_MAX_EXEC_TIME_FILE_TASK = 0
HARD_MAX_EXEC_TIME_TOTAL = 0
fi
2017-06-20 15:23:29 +02:00
if [ $partial_transfers = = true ] ; then
2019-02-26 12:09:50 +01:00
PARTIAL = true
2017-06-20 15:23:29 +02:00
fi
if [ $delete_vanished = = true ] ; then
2019-02-26 12:09:50 +01:00
DELETE_VANISHED_FILES = true
2017-06-20 15:23:29 +02:00
fi
if [ $dont_get_backup_size = = true ] ; then
2019-02-26 12:09:50 +01:00
GET_BACKUP_SIZE = false
2017-06-20 15:23:29 +02:00
fi
2019-02-26 12:09:50 +01:00
if [ " $IS_STABLE " != true ] ; then
2017-06-20 19:02:22 +02:00
Logger " This is an unstable dev build [ $PROGRAM_BUILD ]. Please use with caution. " "WARN"
fi
DATE = $( date)
Logger "--------------------------------------------------------------------" "NOTICE"
Logger " $DRY_WARNING $DATE - $PROGRAM v $PROGRAM_VERSION $BACKUP_TYPE script begin. " "ALWAYS"
Logger "--------------------------------------------------------------------" "NOTICE"
Logger " Backup instance [ $INSTANCE_ID ] launched as $LOCAL_USER @ $LOCAL_HOST (PID $SCRIPT_PID ) " "NOTICE"
GetLocalOS
InitLocalOSDependingSettings
CheckRunningInstances
PreInit
Init
CheckEnvironment
PostInit
CheckCurrentConfig
GetRemoteOS
InitRemoteOSDependingSettings
2015-11-12 01:26:38 +01:00
RunBeforeHook
Main