2018-06-29 20:11:33 +00:00
#!/usr/bin/env bash
2018-07-02 13:32:48 +00:00
## Generic and highly portable bash functions written in 2013-2018 by Orsiris de Jong - http://www.netpower.fr - ozy@netpower.fr
2016-08-06 11:17:56 +00:00
2018-10-02 09:37:46 +00:00
#TODO: ExecTasks postponed arrays / files grow a lot. Consider having them "rolling" (cleaned at numberOfEvents)
2018-07-02 13:32:48 +00:00
#TODO: command line arguments don't take -AaqV for example
2017-01-04 08:17:49 +00:00
2018-10-02 08:07:01 +00:00
####################################################################################################################################################################
2016-08-28 09:32:25 +00:00
## To use in a program, define the following variables:
2018-10-02 08:07:01 +00:00
2016-08-28 09:32:25 +00:00
## PROGRAM=program-name
## INSTANCE_ID=program-instance-name
## _DEBUG=yes/no
2016-12-03 08:47:51 +00:00
## _LOGGER_SILENT=true/false
## _LOGGER_VERBOSE=true/false
2016-11-14 18:17:30 +00:00
## _LOGGER_ERR_ONLY=true/false
2016-11-14 18:05:29 +00:00
## _LOGGER_PREFIX="date"/"time"/""
2015-11-12 00:37:43 +00:00
2018-10-02 08:07:01 +00:00
## Also, set the following trap in order to clean temporary files
## trap GenericTrapQuit TERM EXIT HUP QUIT
2018-10-02 08:49:16 +00:00
## Then simply source ofunctions with
## source "./ofunctions.sh"
2018-10-02 08:07:01 +00:00
## Why use GenericTrapQuit in order to catch exitcode ?
2016-11-15 20:26:52 +00:00
## Logger sets {ERROR|WARN}_ALERT variable when called with critical / error / warn loglevel
2018-01-02 19:02:57 +00:00
## When called from subprocesses, variable of main process cannot be set. Status needs to be get via $RUN_DIR/$PROGRAM.Logger.{error|warn}.$SCRIPT_PID.$TSTAMP
2016-11-15 20:26:52 +00:00
2018-10-02 08:07:01 +00:00
####################################################################################################################################################################
2018-10-02 08:49:16 +00:00
#### OFUNCTIONS FULL SUBSET ####
#### OFUNCTIONS MINI SUBSET ####
#### OFUNCTIONS MICRO SUBSET ####
_OFUNCTIONS_VERSION = 2.3.0-RC2
_OFUNCTIONS_BUILD = 2018100204
#### _OFUNCTIONS_BOOTSTRAP SUBSET ####
_OFUNCTIONS_BOOTSTRAP = true
#### _OFUNCTIONS_BOOTSTRAP SUBSET END ####
2015-11-12 00:37:43 +00: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-19 09:48:46 +00:00
## Correct output of sort command (language agnostic sorting)
export LC_ALL = C
2017-04-08 19:07:21 +00:00
## Default umask for file creation
umask 0077
2016-03-19 09:48:46 +00:00
# Standard alert mail body
MAIL_ALERT_MSG = " Execution of $PROGRAM instance $INSTANCE_ID on $( date) has warnings/errors. "
2016-08-06 11:17:56 +00:00
# Environment variables that can be overriden by programs
2016-08-29 11:48:03 +00:00
_DRYRUN = false
2016-11-17 19:00:23 +00:00
_LOGGER_SILENT = false
_LOGGER_VERBOSE = false
_LOGGER_ERR_ONLY = false
2016-08-06 11:17:56 +00:00
_LOGGER_PREFIX = "date"
2016-08-18 21:28:41 +00:00
if [ " $KEEP_LOGGING " = = "" ] ; then
2016-12-11 19:54:40 +00:00
KEEP_LOGGING = 1801
2016-08-18 21:28:41 +00:00
fi
2015-11-12 00:37:43 +00:00
# Initial error status, logging 'WARN', 'ERROR' or 'CRITICAL' will enable alerts flags
2016-08-29 11:48:03 +00:00
ERROR_ALERT = false
WARN_ALERT = false
2015-11-12 00:37:43 +00:00
2016-12-07 20:30:10 +00:00
#### DEBUG SUBSET ####
2015-11-12 00:37:43 +00:00
## allow function call checks #__WITH_PARANOIA_DEBUG
if [ " $_PARANOIA_DEBUG " = = "yes" ] ; then #__WITH_PARANOIA_DEBUG
_DEBUG = yes #__WITH_PARANOIA_DEBUG
fi #__WITH_PARANOIA_DEBUG
## allow debugging from command line with _DEBUG=yes
if [ ! " $_DEBUG " = = "yes" ] ; then
_DEBUG = no
2016-11-17 19:00:23 +00:00
_LOGGER_VERBOSE = false
2015-11-12 00:37:43 +00:00
else
trap 'TrapError ${LINENO} $?' ERR
2016-11-17 19:00:23 +00:00
_LOGGER_VERBOSE = true
2015-11-12 00:37:43 +00:00
fi
2016-11-25 21:15:27 +00: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
2016-12-07 20:30:10 +00:00
#### DEBUG SUBSET END ####
2016-11-25 21:15:27 +00:00
2015-11-12 00:37:43 +00:00
SCRIPT_PID = $$
2017-05-29 14:53:43 +00:00
2015-11-12 00:37:43 +00:00
LOCAL_USER = $( whoami)
LOCAL_HOST = $( hostname)
2016-08-28 09:32:25 +00:00
if [ " $PROGRAM " = = "" ] ; then
PROGRAM = "ofunctions"
fi
2015-11-12 00:37:43 +00:00
## Default log file until config file is loaded
if [ -w /var/log ] ; then
LOG_FILE = " /var/log/ $PROGRAM .log "
2016-04-06 18:13:19 +00:00
elif ( [ " $HOME " != "" ] && [ -w " $HOME " ] ) ; then
LOG_FILE = " $HOME / $PROGRAM .log "
2016-12-07 10:45:34 +00:00
elif [ -w . ] ; then
2015-11-12 00:37:43 +00:00
LOG_FILE = " ./ $PROGRAM .log "
2016-12-07 10:45:34 +00:00
else
LOG_FILE = " /tmp/ $PROGRAM .log "
2015-11-12 00:37:43 +00:00
fi
## Default directory where to store temporary run files
if [ -w /tmp ] ; then
RUN_DIR = /tmp
elif [ -w /var/tmp ] ; then
RUN_DIR = /var/tmp
else
RUN_DIR = .
fi
2018-06-04 12:13:10 +00:00
#### PoorMansRandomGenerator SUBSET ####
2018-10-02 09:37:46 +00:00
# Get a random number on Windows BusyBox alike, also works on most Unixes that have dd, if dd is not found, then return $RANDOM
function PoorMansRandomGenerator {
2018-10-02 09:41:46 +00:00
local digits = " ${ 1 } " # The number of digits to generate
local number
local isFirst = true
2018-10-02 09:37:46 +00:00
if type dd >/dev/null 2>& 1; then
# 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
if [ $isFirst = = false ] || [ $( printf "%d" " ' $char " ) != "0" ] ; then
number = $number $( printf "%d" " ' $char " )
isFirst = false
fi
if [ ${# number } -ge $digits ] ; then
echo ${ number : 0 : $digits }
break;
fi
done
elif [ " $RANDOM " -ne 0 ] ; then
echo $RANDOM
else
Logger "Cannot generate random number." "ERROR"
fi
}
2018-06-04 12:13:10 +00:00
function PoorMansRandomGenerator {
2018-10-01 09:27:01 +00:00
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
2018-10-01 12:02:44 +00:00
dd if = /dev/urandom bs = $digits count = 2 2> /dev/null | while read -r -n1 char; do
2018-10-01 09:27:01 +00:00
number = $number $( printf "%d" " ' $char " )
if [ ${# number } -ge $digits ] ; then
echo ${ number : 0 : $digits }
break;
fi
done
2018-06-04 12:13:10 +00:00
}
#### PoorMansRandomGenerator SUBSET END ####
# Initial TSTMAP value before function declaration
TSTAMP = $( date '+%Y%m%dT%H%M%S' ) .$( PoorMansRandomGenerator 4)
2015-11-12 00:37:43 +00:00
# Default alert attachment filename
2016-12-12 09:14:59 +00:00
ALERT_LOG_FILE = " $RUN_DIR / $PROGRAM . $SCRIPT_PID . $TSTAMP .last.log "
2015-11-12 00:37:43 +00:00
# Set error exit code if a piped command fails
2018-01-02 19:02:57 +00:00
set -o pipefail
set -o errtrace
2015-11-12 00:37:43 +00:00
2016-12-07 20:30:10 +00:00
#### Logger SUBSET ####
#### RemoteLogger SUBSET ####
2016-12-23 17:25:08 +00: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 20:11:00 +00:00
# Sub function of Logger
2015-11-12 00:37:43 +00:00
function _Logger {
2016-11-17 19:00:23 +00:00
local logValue = " ${ 1 } " # Log to file
local stdValue = " ${ 2 } " # Log to screeen
2017-02-08 07:39:26 +00:00
local toStdErr = " ${ 3 :- false } " # Log to stderr instead of stdout
2016-11-17 19:00:23 +00:00
2016-12-07 10:45:34 +00:00
if [ " $logValue " != "" ] ; then
echo -e " $logValue " >> " $LOG_FILE "
2018-06-25 12:11:29 +00:00
# Build current log file for alerts if we have a sufficient environment
if [ " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " != "" ] ; then
echo -e " $logValue " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP "
fi
2016-12-07 10:45:34 +00:00
fi
2016-11-17 19:00:23 +00:00
if [ " $stdValue " != "" ] && [ " $_LOGGER_SILENT " != true ] ; then
2017-02-08 07:39:26 +00:00
if [ $toStdErr = = true ] ; then
2016-11-17 19:00:23 +00:00
# Force stderr color in subshell
( >& 2 echo -e " $stdValue " )
else
echo -e " $stdValue "
fi
fi
}
2016-12-07 20:30:10 +00:00
# Remote logger similar to below Logger, without log to file and alert flags
function RemoteLogger {
2016-12-11 13:29:17 +00:00
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2016-12-07 20:30:10 +00:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
2016-12-28 22:37:07 +00:00
prefix = " TIME: $SECONDS - "
2016-12-07 20:30:10 +00:00
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
2016-12-13 11:29:33 +00:00
prefix = " R $( date) - "
2016-12-07 20:30:10 +00:00
else
2016-12-13 17:31:06 +00:00
prefix = ""
2016-12-07 20:30:10 +00:00
fi
if [ " $level " = = "CRITICAL" ] ; then
2016-12-15 10:53:22 +00:00
_Logger "" " $prefix \e[1;33;41m $value \e[0m " true
2016-12-11 16:07:34 +00:00
if [ $_DEBUG = = "yes" ] ; then
2016-12-11 13:29:17 +00:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
2016-12-07 20:30:10 +00:00
return
elif [ " $level " = = "ERROR" ] ; then
2018-07-09 13:00:38 +00:00
_Logger "" " $prefix \e[31m $value \e[0m " true
2016-12-11 16:07:34 +00:00
if [ $_DEBUG = = "yes" ] ; then
2016-12-11 13:29:17 +00:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
2016-12-07 20:30:10 +00:00
return
elif [ " $level " = = "WARN" ] ; then
_Logger "" " $prefix \e[33m $value \e[0m " true
2016-12-11 16:07:34 +00:00
if [ $_DEBUG = = "yes" ] ; then
2016-12-11 13:29:17 +00:00
_Logger -e "" " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ " true
fi
2016-12-07 20:30:10 +00:00
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-02 08:40:10 +00:00
_Logger "" " $prefix $value "
2016-12-07 20:30:10 +00:00
return
elif [ " $level " = = "DEBUG" ] ; then
if [ " $_DEBUG " = = "yes" ] ; then
_Logger "" " $prefix $value "
return
fi
elif [ " $level " = = "PARANOIA_DEBUG" ] ; then #__WITH_PARANOIA_DEBUG
if [ " $_PARANOIA_DEBUG " = = "yes" ] ; then #__WITH_PARANOIA_DEBUG
_Logger "" " $prefix \e[35m $value \e[0m " #__WITH_PARANOIA_DEBUG
return #__WITH_PARANOIA_DEBUG
fi #__WITH_PARANOIA_DEBUG
else
2016-12-23 17:25:08 +00:00
_Logger "" " \e[41mLogger function called without proper loglevel [ $level ].\e[0m " true
_Logger "" " Value was: $prefix $value " true
2016-12-07 20:30:10 +00:00
fi
}
#### RemoteLogger SUBSET END ####
2016-11-17 19:00:23 +00:00
# General log function with log levels:
# Environment variables
# _LOGGER_SILENT: Disables any output to stdout & stderr
2016-12-19 21:39:03 +00:00
# _LOGGER_ERR_ONLY: Disables any output to stdout except for ALWAYS loglevel
2016-11-17 19:00:23 +00: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
# 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=yes
2018-06-25 12:11:29 +00:00
# SIMPLE is a wrapper for QuickLogger that does not use advanced functionality
2016-11-17 19:00:23 +00:00
function Logger {
2016-12-10 17:07:00 +00:00
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level
local retval = " ${ 3 :- undef } " # optional return value of command
2016-11-17 19:00:23 +00:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
prefix = " TIME: $SECONDS - "
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
2018-07-14 13:37:14 +00:00
prefix = " $( date '+%Y-%m-%d %H:%M:%S' ) - "
2016-11-17 19:00:23 +00:00
else
prefix = ""
fi
2017-02-10 10:14:11 +00:00
## Obfuscate _REMOTE_TOKEN in logs (for ssh_filter usage only in osync and obackup)
value = " ${ value /env _REMOTE_TOKEN= $_REMOTE_TOKEN /__(o_O)__ } "
value = " ${ value /env _REMOTE_TOKEN= \$ _REMOTE_TOKEN /__(o_O)__ } "
2016-11-17 19:00:23 +00:00
if [ " $level " = = "CRITICAL" ] ; then
2016-12-15 10:53:22 +00:00
_Logger " $prefix ( $level ): $value " " $prefix \e[1;33;41m $value \e[0m " true
2016-11-17 19:00:23 +00:00
ERROR_ALERT = true
2018-01-02 19:02:57 +00:00
# ERROR_ALERT / WARN_ALERT is not set in main when Logger is called from a subprocess. Need to keep this flag.
2016-12-12 10:38:27 +00:00
echo -e " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ \n $prefix ( $level ): $value " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2016-11-17 19:00:23 +00:00
return
elif [ " $level " = = "ERROR" ] ; then
_Logger " $prefix ( $level ): $value " " $prefix \e[91m $value \e[0m " true
ERROR_ALERT = true
2016-12-12 10:38:27 +00:00
echo -e " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ \n $prefix ( $level ): $value " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID . $TSTAMP "
2016-11-17 19:00:23 +00:00
return
elif [ " $level " = = "WARN" ] ; then
_Logger " $prefix ( $level ): $value " " $prefix \e[33m $value \e[0m " true
WARN_ALERT = true
2016-12-12 10:38:27 +00:00
echo -e " [ $retval ] in [ $( joinString , ${ FUNCNAME [@] } ) ] SP= $SCRIPT_PID P= $$ \n $prefix ( $level ): $value " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .warn. $SCRIPT_PID . $TSTAMP "
2016-11-17 19:00:23 +00:00
return
elif [ " $level " = = "NOTICE" ] ; then
if [ " $_LOGGER_ERR_ONLY " != true ] ; then
_Logger " $prefix $value " " $prefix $value "
fi
return
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_LOGGER_VERBOSE = = true ] ; then
2017-04-11 11:25:03 +00:00
_Logger " $prefix ( $level ): $value " " $prefix $value "
2016-11-17 19:00:23 +00:00
fi
return
elif [ " $level " = = "ALWAYS" ] ; then
2016-12-23 17:25:08 +00:00
_Logger " $prefix $value " " $prefix $value "
2016-11-17 19:00:23 +00:00
return
elif [ " $level " = = "DEBUG" ] ; then
if [ " $_DEBUG " = = "yes" ] ; then
_Logger " $prefix $value " " $prefix $value "
return
fi
2016-12-03 09:40:30 +00:00
elif [ " $level " = = "PARANOIA_DEBUG" ] ; then #__WITH_PARANOIA_DEBUG
if [ " $_PARANOIA_DEBUG " = = "yes" ] ; then #__WITH_PARANOIA_DEBUG
_Logger " $prefix $value " " $prefix \e[35m $value \e[0m " #__WITH_PARANOIA_DEBUG
return #__WITH_PARANOIA_DEBUG
fi #__WITH_PARANOIA_DEBUG
2018-06-25 12:11:29 +00:00
elif [ " $level " = = "SIMPLE" ] ; then
if [ " $_LOGGER_SILENT " = = true ] ; then
_Logger " $preix $value "
else
_Logger " $preix $value " " $prefix $value "
fi
return
2016-11-17 19:00:23 +00:00
else
2016-12-23 17:25:08 +00: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
2016-11-17 19:00:23 +00:00
fi
}
2016-12-07 20:30:10 +00:00
#### Logger SUBSET END ####
2016-11-17 19:00:23 +00:00
2015-11-12 00:37:43 +00:00
# Portable child (and grandchild) kill function tester under Linux, BSD and MacOS X
function KillChilds {
2016-08-18 21:28:41 +00:00
local pid = " ${ 1 } " # Parent pid to kill childs
local self = " ${ 2 :- false } " # Should parent be killed too ?
2015-11-12 00:37:43 +00:00
2018-01-02 19:02:57 +00:00
# Paranoid checks, we can safely assume that $pid should not be 0 nor 1
2017-11-22 23:30:47 +00:00
if [ $( IsInteger " $pid " ) -eq 0 ] || [ " $pid " = = "" ] || [ " $pid " = = "0" ] || [ " $pid " = = "1" ] ; then
2017-05-28 18:17:38 +00:00
Logger " Bogus pid given [ $pid ]. " "CRITICAL"
return 1
fi
2017-05-28 19:25:03 +00:00
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
Logger " Launching KillChilds \" $child \" true " "DEBUG" #__WITH_PARANOIA_DEBUG
KillChilds " $child " true
done
2017-05-28 11:37:12 +00:00
fi
2017-05-28 20:20:41 +00:00
fi
2017-05-28 11:37:12 +00:00
2017-05-28 20:20:41 +00:00
# Try to kill nicely, if not, wait 15 seconds to let Trap actions happen before killing
if [ " $self " = = true ] ; then
# We need to check for pid again because it may have disappeared after recursive function call
if kill -0 " $pid " > /dev/null 2>& 1; then
2016-11-29 19:28:00 +00:00
kill -s TERM " $pid "
Logger " Sent SIGTERM to process [ $pid ]. " "DEBUG"
2016-04-12 08:16:21 +00:00
if [ $? != 0 ] ; then
2016-11-29 19:28:00 +00:00
sleep 15
Logger " Sending SIGTERM to process [ $pid ] failed. " "DEBUG"
kill -9 " $pid "
if [ $? != 0 ] ; then
Logger " Sending SIGKILL to process [ $pid ] failed. " "DEBUG"
return 1
fi # Simplify the return 0 logic here
else
return 0
2016-04-12 08:16:21 +00:00
fi
2016-08-03 08:02:07 +00:00
else
2016-08-03 21:58:24 +00:00
return 0
2016-03-31 20:32:03 +00:00
fi
2016-08-03 21:58:24 +00:00
else
return 0
fi
}
function KillAllChilds {
local pids = " ${ 1 } " # List of parent pids to kill separated by semi-colon
2016-08-18 21:28:41 +00:00
local self = " ${ 2 :- false } " # Should parent be killed too ?
2016-08-03 21:58:24 +00:00
2016-12-07 20:30:10 +00:00
__CheckArguments 1 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-08-06 11:17:56 +00:00
2016-08-03 21:58:24 +00:00
local errorcount = 0
IFS = ';' read -a pidsArray <<< " $pids "
for pid in " ${ pidsArray [@] } " ; do
2016-08-18 21:28:41 +00:00
KillChilds $pid $self
2016-08-03 21:58:24 +00:00
if [ $? != 0 ] ; then
errorcount = $(( errorcount+1))
fi
2016-08-03 08:02:07 +00:00
done
return $errorcount
2015-11-12 00:37:43 +00:00
}
2018-10-02 08:07:01 +00:00
#### CleanUp SUBSET ####
function CleanUp {
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
if [ " $_DEBUG " != "yes" ] ; then
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
}
#### CleanUp SUBSET END ####
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
}
#### OFUNCTIONS MICRO SUBSET END ####
2016-05-25 17:57:04 +00:00
# osync/obackup/pmocr script specific mail alert function, use SendEmail function for generic mail sending
2015-11-12 00:37:43 +00:00
function SendAlert {
2016-08-28 09:32:25 +00:00
local runAlert = " ${ 1 :- false } " # Specifies if current message is sent while running or at the end of a run
2016-12-07 20:30:10 +00:00
__CheckArguments 0-1 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-02-18 19:54:07 +00:00
2016-11-17 20:02:45 +00:00
local attachment
local attachmentFile
local subject
local body
2015-11-12 00:37:43 +00:00
2016-03-08 22:54:25 +00:00
if [ " $DESTINATION_MAILS " = = "" ] ; then
return 0
fi
2015-11-12 00:37:43 +00:00
if [ " $_DEBUG " = = "yes" ] ; then
2016-05-25 17:57:04 +00:00
Logger "Debug mode, no warning mail will be sent." "NOTICE"
2015-11-12 00:37:43 +00:00
return 0
fi
eval " cat \" $LOG_FILE \" $COMPRESSION_PROGRAM > $ALERT_LOG_FILE "
2016-02-16 21:15:44 +00:00
if [ $? != 0 ] ; then
2016-11-14 18:17:30 +00:00
attachment = false
2016-02-16 21:15:44 +00:00
else
2016-11-14 18:05:29 +00:00
attachment = true
2016-02-16 21:15:44 +00:00
fi
2018-02-20 21:14:41 +00:00
body = " $MAIL_ALERT_MSG " $'\n\n' "Last 1000 lines of log" $'\n\n' " $( tail -n 1000 $RUN_DIR /$PROGRAM ._Logger.$SCRIPT_PID .$TSTAMP ) "
2016-08-28 09:32:25 +00:00
2016-08-29 11:48:03 +00:00
if [ $ERROR_ALERT = = true ] ; then
2015-11-12 00:37:43 +00:00
subject = " Error alert for $INSTANCE_ID "
2016-08-29 11:48:03 +00:00
elif [ $WARN_ALERT = = true ] ; then
2015-11-12 00:37:43 +00:00
subject = " Warning alert for $INSTANCE_ID "
else
subject = " Alert for $INSTANCE_ID "
fi
2016-08-28 09:32:25 +00:00
if [ $runAlert = = true ] ; then
subject = " Currently runing - $subject "
else
2016-12-12 10:16:53 +00:00
subject = " Finished run - $subject "
2016-08-28 09:32:25 +00:00
fi
2016-11-14 18:05:29 +00:00
if [ " $attachment " = = true ] ; then
2016-11-11 23:30:25 +00:00
attachmentFile = " $ALERT_LOG_FILE "
2015-11-12 00:37:43 +00:00
fi
2016-12-10 17:27:56 +00:00
SendEmail " $subject " " $body " " $DESTINATION_MAILS " " $attachmentFile " " $SENDER_MAIL " " $SMTP_SERVER " " $SMTP_PORT " " $SMTP_ENCRYPTION " " $SMTP_USER " " $SMTP_PASSWORD "
2015-11-12 00:37:43 +00:00
# Delete tmp log file
2016-11-14 18:05:29 +00:00
if [ " $attachment " = = true ] ; then
2016-11-11 23:30:25 +00:00
if [ -f " $ALERT_LOG_FILE " ] ; then
rm -f " $ALERT_LOG_FILE "
fi
2015-11-12 00:37:43 +00:00
fi
}
2016-05-25 17:57:04 +00: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-10-23 16:23:44 +00:00
# smtp_server.domain.tld is mandatory, as is smtpPort (should be 25, 465 or 587)
2016-05-25 17:57:04 +00:00
# encryption can be set to tls, ssl or none
2016-10-23 16:23:44 +00:00
# smtpUser and smtpPassword are optional
2016-10-23 18:25:46 +00:00
# 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-02 08:42:32 +00: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 16:01:56 +00:00
function SendEmail {
local subject = " ${ 1 } "
local message = " ${ 2 } "
2016-10-23 16:23:44 +00:00
local destinationMails = " ${ 3 } "
2016-05-25 17:57:04 +00:00
local attachment = " ${ 4 } "
2016-10-23 18:25:46 +00:00
local senderMail = " ${ 5 } "
2016-10-23 16:23:44 +00:00
local smtpServer = " ${ 6 } "
local smtpPort = " ${ 7 } "
2016-07-19 08:52:43 +00:00
local encryption = " ${ 8 } "
2016-10-23 16:23:44 +00:00
local smtpUser = " ${ 9 } "
local smtpPassword = " ${ 10 } "
2016-05-25 17:57:04 +00:00
2016-12-07 20:30:10 +00:00
__CheckArguments 3-10 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-04-14 16:01:56 +00:00
local mail_no_attachment =
local attachment_command =
2016-05-25 17:57:04 +00:00
local encryption_string =
local auth_string =
2018-02-20 21:14:41 +00:00
local i
2018-07-02 20:09:28 +00:00
if [ " ${ destinationMails [@] } " != "" ] ; then
for i in " ${ destinationMails [@] } " ; do
if [ $( CheckRFC822 " $i " ) -ne 1 ] ; then
Logger " Given email [ $i ] does not seem to be valid. " "WARN"
fi
done
else
Logger "No valid email adresses given." "WARN"
return 1
fi
2018-02-20 21:14:41 +00: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 "
message = " $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .iconv.$SCRIPT_PID .$TSTAMP ) "
else
Logger "iconv utility not installed. Will not convert email charset." "NOTICE"
fi
fi
2016-04-14 16:01:56 +00:00
if [ ! -f " $attachment " ] ; then
2016-11-09 16:36:18 +00:00
attachment_command = " -a $attachment "
2016-04-14 16:01:56 +00:00
mail_no_attachment = 1
else
mail_no_attachment = 0
fi
2016-11-19 11:37:33 +00:00
if [ " $LOCAL_OS " = = "Busybox" ] || [ " $LOCAL_OS " = = "Android" ] ; then
2016-12-10 17:07:00 +00:00
if [ " $smtpPort " = = "" ] ; then
Logger "Missing smtp port, assuming 25." "WARN"
smtpPort = 25
fi
2016-10-23 16:23:44 +00:00
if type sendmail > /dev/null 2>& 1; then
2016-12-10 17:27:56 +00:00
if [ " $encryption " = = "tls" ] ; then
2016-12-10 17:40:36 +00:00
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 "
2016-12-10 17:27:56 +00:00
elif [ " $encryption " = = "ssl" ] ; then
2016-12-10 17:40:36 +00:00
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 "
2016-10-23 18:25:46 +00:00
else
2016-12-10 17:27:56 +00:00
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $senderMail " -S " $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
2016-10-23 18:25:46 +00:00
fi
2016-10-23 16:23:44 +00:00
if [ $? != 0 ] ; then
Logger " Cannot send alert mail via $( type -p sendmail) !!! " "WARN"
2018-01-02 19:02:57 +00:00
# Do not bother try other mail systems with busybox
2016-10-23 16:23:44 +00:00
return 1
else
return 0
fi
else
2018-01-02 19:02:57 +00:00
Logger "Sendmail not present. Will not send any mail" "WARN"
2016-10-23 16:23:44 +00:00
return 1
fi
fi
2016-04-14 16:01:56 +00:00
if type mutt > /dev/null 2>& 1 ; then
2016-12-01 20:27:28 +00: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
2016-04-14 16:01:56 +00:00
if [ $? != 0 ] ; then
2016-05-25 17:57:04 +00:00
Logger " Cannot send mail via $( type -p mutt) !!! " "WARN"
2016-04-14 16:01:56 +00:00
else
2016-05-25 17:57:04 +00:00
Logger "Sent mail using mutt." "NOTICE"
2016-04-14 16:01:56 +00:00
return 0
fi
fi
if type mail > /dev/null 2>& 1 ; then
2016-11-21 13:04:05 +00: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 16:01:56 +00: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-21 13:04:05 +00:00
2016-10-23 16:23:44 +00:00
echo " $message " | $( type -p mail) $attachment_command -s " $subject " " $destinationMails "
2016-04-14 16:01:56 +00:00
if [ $? != 0 ] ; then
2016-05-25 17:57:04 +00:00
Logger " Cannot send mail via $( type -p mail) with attachments !!! " "WARN"
2016-10-23 16:23:44 +00:00
echo " $message " | $( type -p mail) -s " $subject " " $destinationMails "
2016-04-14 16:01:56 +00:00
if [ $? != 0 ] ; then
2016-05-25 17:57:04 +00:00
Logger " Cannot send mail via $( type -p mail) without attachments !!! " "WARN"
2016-04-14 16:01:56 +00:00
else
2016-05-25 17:57:04 +00:00
Logger "Sent mail using mail command without attachment." "NOTICE"
2016-04-14 16:01:56 +00:00
return 0
fi
else
2016-05-25 17:57:04 +00:00
Logger "Sent mail using mail command." "NOTICE"
2016-04-14 16:01:56 +00:00
return 0
fi
fi
if type sendmail > /dev/null 2>& 1 ; then
2016-10-23 16:23:44 +00:00
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) " $destinationMails "
2016-04-14 16:01:56 +00:00
if [ $? != 0 ] ; then
2016-05-25 17:57:04 +00:00
Logger " Cannot send mail via $( type -p sendmail) !!! " "WARN"
2016-04-14 16:01:56 +00:00
else
2016-05-25 17:57:04 +00:00
Logger "Sent mail using sendmail command without attachment." "NOTICE"
2016-04-14 16:01:56 +00:00
return 0
fi
fi
2016-05-25 17:57:04 +00:00
# Windows specific
2016-08-08 16:06:31 +00:00
if type "mailsend.exe" > /dev/null 2>& 1 ; then
2016-10-23 18:25:46 +00:00
if [ " $senderMail " = = "" ] ; then
2016-05-25 17:57:04 +00:00
Logger "Missing sender email." "ERROR"
return 1
fi
2016-10-23 16:23:44 +00:00
if [ " $smtpServer " = = "" ] ; then
2016-05-25 17:57:04 +00:00
Logger "Missing smtp port." "ERROR"
return 1
fi
2016-10-23 16:23:44 +00:00
if [ " $smtpPort " = = "" ] ; then
2016-05-25 17:57:04 +00:00
Logger "Missing smtp port, assuming 25." "WARN"
2016-10-23 16:23:44 +00:00
smtpPort = 25
2016-05-25 17:57:04 +00: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-10-23 16:23:44 +00:00
if [ " $smtpUser " != "" ] && [ " $smtpPassword " != "" ] ; then
auth_string = " -auth -user \" $smtpUser \" -pass \" $smtpPassword \" "
2016-05-25 17:57:04 +00:00
fi
2016-10-23 18:25:46 +00:00
$( type mailsend.exe) -f " $senderMail " -t " $destinationMails " -sub " $subject " -M " $message " -attach " $attachment " -smtp " $smtpServer " -port " $smtpPort " $encryption_string $auth_string
2016-08-08 16:06:31 +00:00
if [ $? != 0 ] ; then
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 17:57:04 +00:00
2016-04-14 16:01:56 +00:00
# pfSense specific
if [ -f /usr/local/bin/mail.php ] ; then
echo " $message " | /usr/local/bin/mail.php -s= " $subject "
if [ $? != 0 ] ; then
2016-05-25 17:57:04 +00:00
Logger "Cannot send mail via /usr/local/bin/mail.php (pfsense) !!!" "WARN"
2016-04-14 16:01:56 +00:00
else
2016-05-25 17:57:04 +00:00
Logger "Sent mail using pfSense mail.php." "NOTICE"
2016-04-14 16:01:56 +00:00
return 0
fi
fi
2016-08-02 12:26:04 +00:00
# If function has not returned 0 yet, assume it is critical that no alert can be sent
2016-05-25 17:57:04 +00: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 16:01:56 +00:00
}
2016-12-07 20:30:10 +00:00
#### TrapError SUBSET ####
2016-03-08 22:54:25 +00:00
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
2016-10-19 10:28:30 +00:00
2016-11-17 19:00:23 +00:00
if [ $_LOGGER_SILENT = = false ] ; then
2017-01-04 08:17:49 +00:00
( >& 2 echo -e " \e[45m/!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } \e[0m " )
2016-03-08 22:54:25 +00:00
fi
}
2016-12-07 20:30:10 +00:00
#### TrapError SUBSET END ####
2016-03-08 22:54:25 +00:00
2016-03-19 09:48:46 +00:00
function LoadConfigFile {
2016-09-06 17:08:53 +00:00
local configFile = " ${ 1 } "
2016-10-19 10:28:30 +00:00
2016-12-07 20:30:10 +00:00
__CheckArguments 1 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-03-19 09:48:46 +00:00
2016-09-06 17:08:53 +00:00
if [ ! -f " $configFile " ] ; then
Logger " Cannot load configuration file [ $configFile ]. Cannot start. " "CRITICAL"
2016-03-19 09:48:46 +00:00
exit 1
2016-09-06 17:08:53 +00:00
elif [ [ " $configFile " != *".conf" ] ] ; then
Logger " Wrong configuration file supplied [ $configFile ]. Cannot start. " "CRITICAL"
2016-03-19 09:48:46 +00:00
exit 1
else
2016-09-06 17:08:53 +00:00
# Remove everything that is not a variable assignation
2016-12-12 10:38:27 +00:00
grep '^[^ ]*=[^;&]*' " $configFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP "
source " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP "
2016-03-19 09:48:46 +00:00
fi
2016-09-06 17:08:53 +00:00
CONFIG_FILE = " $configFile "
2016-03-19 09:48:46 +00:00
}
2018-01-02 19:02:57 +00:00
# Quick and dirty performance logger only used for debugging
2017-04-26 11:51:15 +00:00
function _PerfProfiler { #__WITH_PARANOIA_DEBUG
local perfString #__WITH_PARANOIA_DEBUG
2018-01-02 19:02:57 +00:00
local i #__WITH_PARANOIA_DEBUG
2017-04-26 11:51:15 +00:00
#__WITH_PARANOIA_DEBUG
2017-04-26 11:55:52 +00:00
perfString = $( ps -p $$ -o args,pid,ppid,%cpu,%mem,time,etime,state,wchan) #__WITH_PARANOIA_DEBUG
2017-04-26 11:51:15 +00:00
#__WITH_PARANOIA_DEBUG
for i in $( pgrep -P $$ ) ; do #__WITH_PARANOIA_DEBUG
2017-04-26 11:55:52 +00:00
perfString = " $perfString \n " $( ps -p $i -o args,pid,ppid,%cpu,%mem,time,etime,state,wchan | tail -1) #__WITH_PARANOIA_DEBUG
2017-04-26 11:51:15 +00:00
done #__WITH_PARANOIA_DEBUG
#__WITH_PARANOIA_DEBUG
if type iostat > /dev/null 2>& 1; then #__WITH_PARANOIA_DEBUG
perfString = " $perfString \n " $( iostat) #__WITH_PARANOIA_DEBUG
fi #__WITH_PARANOIA_DEBUG
#__WITH_PARANOIA_DEBUG
2017-05-22 07:32:12 +00:00
Logger " PerfProfiler:\n $perfString " "PARANOIA_DEBUG" #__WITH_PARANOIA_DEBUG
2017-04-26 11:51:15 +00:00
} #__WITH_PARANOIA_DEBUG
2017-04-26 10:04:00 +00:00
2018-01-02 19:02:57 +00:00
_OFUNCTIONS_SPINNER = "|/-\\"
function Spinner {
if [ $_LOGGER_SILENT = = true ] || [ " $_LOGGER_ERR_ONLY " = = true ] ; then
return 0
else
printf " [%c] \b\b\b\b\b\b" " $_OFUNCTIONS_SPINNER "
_OFUNCTIONS_SPINNER = ${ _OFUNCTIONS_SPINNER #? } ${ _OFUNCTIONS_SPINNER %%??? }
return 0
fi
}
2016-08-08 16:06:31 +00:00
2018-01-02 19:02:57 +00:00
# WaitForTaskCompletion function emulation, now uses ExecTasks
function WaitForTaskCompletion {
2018-02-20 21:14:41 +00: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-02 19:02:57 +00:00
}
2016-08-28 09:32:25 +00:00
2018-01-02 19:02:57 +00:00
# ParallelExec function emulation, now uses ExecTasks
function ParallelExec {
2018-02-20 21:14:41 +00: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-02 19:02:57 +00:00
2018-01-03 14:11:16 +00:00
if [ $readFromFile = = true ] ; then
2018-02-20 21:14:41 +00:00
ExecTasks " $commandsArg " "base" $readFromFile 0 0 " $softMaxTime " " $hardMaxTime " " $counting " " $sleepTime " " $keepLogging " " $spinner " " $noErrorLog " false " $numberOfProcesses "
2018-01-03 14:11:16 +00:00
else
2018-02-20 21:14:41 +00:00
ExecTasks " $commandsArg " "base" $readFromFile 0 0 " $softMaxTime " " $hardMaxTime " " $counting " " $sleepTime " " $keepLogging " " $spinner " " $noErrorLog " false " $numberOfProcesses "
2018-01-03 14:11:16 +00:00
fi
2018-01-02 19:02:57 +00:00
}
2016-11-22 16:19:30 +00:00
2018-01-02 19:02:57 +00:00
## Main asynchronous execution function
2018-02-20 21:14:41 +00: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-02 19:02:57 +00:00
## Spinner
## Logger
## JoinString
## KillChilds
2018-02-20 21:14:41 +00:00
## Full call
##ExecTasks "$mainInput" "$id" $readFromFile $softPerProcessTime $hardPerProcessTime $softMaxTime $hardMaxTime $counting $sleepTime $keepLogging $spinner $noTimeErrorLog $noErrorLogsAtAll $numberOfProcesses $auxInput $maxPostponeRetries $minTimeBetweenRetries $validExitCodes
2018-01-02 19:02:57 +00:00
function ExecTasks {
2018-02-20 21:14:41 +00:00
# Mandatory arguments
2018-07-02 08:40:10 +00:00
local mainInput = " ${ 1 } " # Contains list of pids / commands separated by semicolons or filepath to list of pids / commands
2018-02-20 21:14:41 +00:00
# Optional arguments
2018-07-02 08:40:10 +00: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-20 21:14:41 +00:00
# Parallelism specific arguments
2018-07-02 08:40:10 +00: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
2018-01-02 19:02:57 +00:00
local i
2016-08-06 11:17:56 +00:00
2018-07-02 08:40:10 +00:00
Logger " ${ FUNCNAME [0] } called by [ ${ FUNCNAME [0] } < ${ FUNCNAME [1] } < ${ FUNCNAME [2] } < ${ FUNCNAME [3] } < ${ FUNCNAME [4] } ...]. " "PARANOIA_DEBUG" #__WITH_PARANOIA_DEBUG
__CheckArguments 1-18 $# " $@ " #__WITH_PARANOIA_DEBUG
2018-01-02 19:02:57 +00:00
2018-02-20 21:14:41 +00:00
# Since ExecTasks takes up to 17 arguments, do a quick preflight check in DEBUG mode
2018-01-02 19:02:57 +00:00
if [ " $_DEBUG " = = "yes" ] ; then
2018-02-20 21:14:41 +00: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-02 19:02:57 +00: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
2018-02-20 21:14:41 +00:00
# Change '-' to '_' in task id
id = " ${ id /-/_ } "
2016-08-06 11:17:56 +00:00
2018-02-20 21:14:41 +00:00
# Expand validExitCodes into array
IFS = ';' read -r -a validExitCodes <<< " $validExitCodes "
2016-08-06 11:17:56 +00:00
2018-02-20 21:14:41 +00:00
# ParallelExec specific variables
2018-07-02 08:40:10 +00:00
local auxItemCount = 0 # Number of conditional commands
local commandsArray = ( ) # Array containing commands
2018-02-20 21:14:41 +00:00
local commandsConditionArray = ( ) # Array containing conditional commands
2018-07-02 08:40:10 +00:00
local currentCommand # Variable containing currently processed command
local currentCommandCondition # Variable containing currently processed conditional command
local commandsArrayPid = ( ) # Array containing pids of commands currently run
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-20 21:14:41 +00:00
local postponedCounter = 0
2018-07-02 08:40:10 +00: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-20 21:14:41 +00:00
local temp
2016-08-06 11:17:56 +00:00
2018-02-20 21:14:41 +00:00
# Common variables
2018-07-02 08:40:10 +00: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-20 21:14:41 +00:00
local counter = 0
2018-07-02 08:40:10 +00:00
local log_ttime = 0 # local time instance for comparaison
2018-02-20 21:14:41 +00:00
2018-07-02 08:40:10 +00:00
local seconds_begin = $SECONDS # Seconds since the beginning of the script
local exec_time = 0 # Seconds since the beginning of this function
2018-02-20 21:14:41 +00:00
2018-07-02 08:40:10 +00: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-02-20 21:14:41 +00:00
2018-07-02 08:40:10 +00:00
local hasPids = false # Are any valable pids given to function ? #__WITH_PARANOIA_DEBUG
2016-08-28 15:54:20 +00:00
2018-01-02 19:02:57 +00:00
local functionMode
2016-08-30 09:49:21 +00:00
2018-01-02 19:02:57 +00:00
if [ $counting = = true ] ; then
local softAlert = false # Does a soft alert need to be triggered, if yes, send an alert once
else
local softAlert = false
2016-11-29 21:43:28 +00:00
fi
2018-01-02 19:02:57 +00:00
# Initialise global variable
2017-11-23 15:58:29 +00:00
eval " WAIT_FOR_TASK_COMPLETION_ $id =\"\" "
eval " HARD_MAX_EXEC_TIME_REACHED_ $id =false "
2016-08-09 20:14:17 +00:00
2018-02-20 21:14:41 +00:00
# Init function variables depending on mode
if [ $numberOfProcesses -gt 0 ] ; then
2018-01-02 19:02:57 +00:00
functionMode = ParallelExec
2018-02-20 21:14:41 +00: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-02 19:02:57 +00:00
if [ -f " $mainInput " ] ; then
2018-02-20 21:14:41 +00:00
mainItemCount = $( wc -l < " $mainInput " )
2018-01-02 19:02:57 +00:00
readFromFile = true
2018-02-20 21:14:41 +00:00
else
2018-02-24 15:34:53 +00:00
Logger " Cannot read main file [ $mainInput ]. " "WARN"
2018-02-20 21:14:41 +00:00
fi
2018-02-24 15:34:53 +00:00
if [ " $auxInput " != "" ] ; then
if [ -f " $auxInput " ] ; then
auxItemCount = $( wc -l < " $auxInput " )
else
Logger " Cannot read aux file [ $auxInput ]. " "WARN"
fi
2018-02-20 21:14:41 +00:00
fi
fi
2018-01-02 19:02:57 +00:00
2018-02-20 21:14:41 +00: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-02 19:02:57 +00:00
2018-07-02 08:40:10 +00:00
Logger " Running ${ FUNCNAME [0] } as [ $functionMode ] for [ $mainItemCount ] mainItems and [ $auxItemCount ] auxItems. " "PARANOIA_DEBUG" #__WITH_PARANOIA_DEBUG
2016-08-06 11:17:56 +00:00
2018-02-20 21:14:41 +00: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-22 16:19:30 +00:00
if [ $spinner = = true ] ; then
Spinner
fi
2016-08-07 21:54:46 +00:00
if [ $counting = = true ] ; then
2017-01-04 08:17:49 +00:00
exec_time = $(( SECONDS - seconds_begin))
2016-08-07 21:54:46 +00:00
else
exec_time = $SECONDS
fi
2016-10-19 10:28:30 +00:00
if [ $keepLogging -ne 0 ] ; then
2018-02-20 21:14:41 +00:00
if [ $(( ( exec_time + 1 ) % keepLogging)) -eq 0 ] ; then
2018-01-02 19:02:57 +00:00
if [ $log_ttime -ne $exec_time ] ; then # Fix when sleep time lower than 1 second
2016-08-18 21:28:41 +00:00
log_ttime = $exec_time
2018-01-02 19:02:57 +00:00
if [ $functionMode = = "Wait" ] ; then
Logger " Current tasks still running with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "NOTICE"
elif [ $functionMode = = "ParallelExec" ] ; then
2018-02-20 21:14:41 +00:00
Logger " There are $(( mainItemCount-counter+postponedItemCount)) / $mainItemCount tasks in the queue. Currently, ${# pidsArray [@] } tasks running with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "NOTICE"
2018-01-02 19:02:57 +00:00
fi
2016-08-18 21:28:41 +00:00
fi
2016-08-06 11:17:56 +00:00
fi
fi
2016-10-19 10:28:30 +00:00
if [ $exec_time -gt $softMaxTime ] ; then
2018-01-02 19:02:57 +00:00
if [ " $softAlert " != true ] && [ $softMaxTime -ne 0 ] && [ $noTimeErrorLog != true ] ; then
2018-02-20 21:14:41 +00:00
Logger " Max soft execution time [ $softMaxTime ] exceeded for task [ $id ] with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "WARN"
2018-01-02 19:02:57 +00:00
softAlert = true
2016-08-28 09:32:25 +00:00
SendAlert true
2016-11-29 21:43:28 +00:00
fi
fi
2016-08-06 11:17:56 +00:00
2016-11-29 21:43:28 +00:00
if [ $exec_time -gt $hardMaxTime ] && [ $hardMaxTime -ne 0 ] ; then
2018-01-02 19:02:57 +00:00
if [ $noTimeErrorLog != true ] ; then
2018-02-20 21:14:41 +00:00
Logger " Max hard execution time [ $hardMaxTime ] exceeded for task [ $id ] with pids [ $( joinString , ${ pidsArray [@] } ) ]. Stopping task execution. " "ERROR"
2016-08-06 11:17:56 +00:00
fi
2016-11-29 21:43:28 +00:00
for pid in " ${ pidsArray [@] } " ; do
KillChilds $pid true
if [ $? = = 0 ] ; then
Logger " Task with pid [ $pid ] stopped successfully. " "NOTICE"
else
2018-02-20 21:14:41 +00:00
if [ $noErrorLogsAtAll != true ] ; then
Logger " Could not stop task with pid [ $pid ]. " "ERROR"
fi
2016-11-21 18:18:22 +00:00
fi
2016-11-29 21:43:28 +00:00
errorcount = $(( errorcount+1))
done
2018-01-02 19:02:57 +00:00
if [ $noTimeErrorLog != true ] ; then
2016-11-29 21:43:28 +00:00
SendAlert true
2016-08-06 11:17:56 +00:00
fi
2017-11-23 15:58:29 +00:00
eval " HARD_MAX_EXEC_TIME_REACHED_ $id =true "
2018-01-02 19:02:57 +00:00
if [ $functionMode = = "WaitForTaskCompletion" ] ; then
return $errorcount
2018-02-20 21:14:41 +00:00
else
return 129
2018-01-02 19:02:57 +00:00
fi
fi
2018-02-20 21:14:41 +00:00
}
2018-01-02 19:02:57 +00:00
2018-02-20 21:14:41 +00:00
function _ExecTasksPidsCheck {
newPidsArray = ( )
2016-08-06 11:17:56 +00:00
2016-08-22 06:09:48 +00:00
for pid in " ${ pidsArray [@] } " ; do
2016-09-05 20:06:57 +00:00
if [ $( IsInteger $pid ) -eq 1 ] ; then
2016-08-30 09:37:25 +00: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-10-22 12:14:52 +00:00
pidState = " $( eval $PROCESS_STATE_CMD ) "
2016-08-30 09:37:25 +00:00
if [ " $pidState " != "D" ] && [ " $pidState " != "Z" ] ; then
2018-02-20 21:14:41 +00: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
2018-02-24 15:34:53 +00:00
Logger " Max soft execution time [ $softPerProcessTime ] exceeded for pid [ $pid ]. " "WARN"
2018-02-20 21:14:41 +00:00
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
if [ $? = = 0 ] ; then
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-30 09:37:25 +00:00
newPidsArray += ( $pid )
fi
else
2018-01-02 19:02:57 +00:00
# pid is dead, get its exit code from wait command
2016-08-30 09:37:25 +00:00
wait $pid
2018-07-02 08:40:10 +00:00
retval = $?
2018-02-20 21:14:41 +00:00
# Check for valid exit codes
if [ $( ArrayContains $retval " ${ validExitCodes [@] } " ) -eq 0 ] ; then
if [ $noErrorLogsAtAll != true ] ; then
2018-07-02 08:40:10 +00:00
Logger " ${ FUNCNAME [0] } called by [ $id ] finished monitoring pid [ $pid ] with exitcode [ $retval ]. " "DEBUG"
2018-02-20 21:14:41 +00:00
if [ " $functionMode " = = "ParallelExec" ] ; then
Logger " Command was [ ${ commandsArrayPid [ $pid ] } ]. " "ERROR"
fi
fi
2016-12-13 11:29:33 +00:00
errorcount = $(( errorcount+1))
2016-12-03 09:40:30 +00:00
# Welcome to variable variable bash hell
2017-11-23 15:58:29 +00:00
if [ " $( eval echo \" \$ WAIT_FOR_TASK_COMPLETION_$id \" ) " = = "" ] ; then
eval " WAIT_FOR_TASK_COMPLETION_ $id =\" $pid : $retval \" "
2016-08-30 09:37:25 +00:00
else
2017-11-23 15:58:29 +00:00
eval " WAIT_FOR_TASK_COMPLETION_ $id =\"; $pid : $retval \" "
2016-08-30 09:37:25 +00:00
fi
2018-01-02 19:02:57 +00:00
else
2018-02-20 21:14:41 +00:00
Logger " ${ FUNCNAME [0] } called by [ $id ] finished monitoring pid [ $pid ] with exitcode [ $retval ]. " "DEBUG"
2016-08-22 06:09:48 +00:00
fi
fi
2018-07-02 08:40:10 +00:00
hasPids = true ##__WITH_PARANOIA_DEBUG
2016-08-22 06:09:48 +00:00
fi
done
2018-02-20 21:14:41 +00:00
# hasPids can be false on last iteration in ParallelExec mode
2018-07-02 08:40:10 +00:00
if [ $hasPids = = false ] && [ " $functionMode " = "WaitForTaskCompletion" ] ; then ##__WITH_PARANOIA_DEBUG
Logger "No valable pids given." "ERROR" ##__WITH_PARANOIA_DEBUG
fi ##__WITH_PARANOIA_DEBUG
2016-08-06 11:17:56 +00:00
pidsArray = ( " ${ newPidsArray [@] } " )
2018-01-02 19:02:57 +00:00
2016-08-28 09:32:25 +00:00
# Trivial wait time for bash to not eat up all CPU
2016-11-22 16:19:30 +00:00
sleep $sleepTime
2017-04-26 10:04:00 +00:00
2018-07-02 08:40:10 +00:00
if [ " $_PERF_PROFILER " = = "yes" ] ; then ##__WITH_PARANOIA_DEBUG
_PerfProfiler ##__WITH_PARANOIA_DEBUG
fi ##__WITH_PARANOIA_DEBUG
2018-02-20 21:14:41 +00: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
if ( [ $postponedRetryCount -lt $maxPostponeRetries ] && [ $postponedExecTime -ge $(( minTimeBetweenRetries)) ] ) || [ $isPostponedCommand = = false ] ; then
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"
eval " $currentCommand " >> " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $id . $SCRIPT_PID . $TSTAMP " 2>& 1 &
pid = $!
pidsArray += ( $pid )
commandsArrayPid[ $pid ] = " $currentCommand "
# 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 11:17:56 +00:00
done
2018-02-20 21:14:41 +00:00
Logger " ${ FUNCNAME [0] } ended for [ $id ] using [ $mainItemCount ] subprocesses with [ $errorcount ] errors. " "PARANOIA_DEBUG" #__WITH_PARANOIA_DEBUG
2016-08-18 21:28:41 +00:00
# Return exit code if only one process was monitored, else return number of errors
2016-11-29 19:28:00 +00:00
# As we cannot return multiple values, a global variable WAIT_FOR_TASK_COMPLETION contains all pids with their return value
2016-11-29 21:43:28 +00:00
2018-01-02 19:02:57 +00:00
if [ $mainItemCount -eq 1 ] ; then
return $retval
2016-09-06 17:08:53 +00:00
else
2018-01-02 19:02:57 +00:00
return $errorcount
2016-09-06 17:08:53 +00:00
fi
2016-08-28 09:32:25 +00:00
}
2016-04-14 16:01:56 +00:00
# Usage: var=$(StripSingleQuotes "$var")
2016-03-08 22:54:25 +00:00
function StripSingleQuotes {
local string = " ${ 1 } "
2016-10-19 10:28:30 +00:00
2016-03-08 22:54:25 +00:00
string = " ${ string /# \' / } " # Remove singlequote if it begins string
string = " ${ string /% \' / } " # Remove singlequote if it ends string
echo " $string "
}
2016-04-14 16:01:56 +00:00
# Usage: var=$(StripDoubleQuotes "$var")
2016-03-08 22:54:25 +00:00
function StripDoubleQuotes {
local string = " ${ 1 } "
2016-10-19 10:28:30 +00:00
2016-03-08 22:54:25 +00:00
string = " ${ string /# \" / } "
string = " ${ string /% \" / } "
echo " $string "
}
function StripQuotes {
local string = " ${ 1 } "
2016-10-19 10:28:30 +00:00
2016-03-08 22:54:25 +00:00
echo " $( StripSingleQuotes $( StripDoubleQuotes $string ) ) "
}
2016-09-05 20:06:57 +00:00
# Usage var=$(EscapeSpaces "$var") or var="$(EscapeSpaces "$var")"
2016-03-08 22:54:25 +00:00
function EscapeSpaces {
local string = " ${ 1 } " # String on which spaces will be escaped
2016-10-19 10:28:30 +00:00
2016-09-05 20:06:57 +00:00
echo " ${ string // / \\ } "
2016-03-08 22:54:25 +00:00
}
2018-07-03 15:29:51 +00:00
# Usage var=$(EscapeDoubleQuotes "$var") or var="$(EscapeDoubleQuotes "$var")"
function EscapeDoubleQuotes {
local value = " ${ 1 } "
echo " ${ value // \" / \\ \" } "
}
2016-10-21 13:29:49 +00:00
# Usage [ $(IsNumeric $var) -eq 1 ]
2016-09-05 20:06:57 +00:00
function IsNumeric {
local value = " ${ 1 } "
2018-10-02 08:49:16 +00:00
if type expr > /dev/null 2>& 1; then
2018-10-02 08:51:45 +00:00
expr " $value " : " ^[-+]\?[0-9]*\.\?[0-9]\+ $" > /dev/null 2>& 1
2018-10-02 08:49:16 +00:00
if [ $? -eq 0 ] ; then
echo 1
else
echo 0
fi
2016-09-05 20:06:57 +00:00
else
2018-10-02 08:49:16 +00:00
if [ [ $value = ~ ^[ -+] ?[ 0-9] +( [ .] [ 0-9] +) ?$ ] ] ; then
echo 1
else
echo 0
fi
2016-09-05 20:06:57 +00:00
fi
}
2018-10-02 08:49:16 +00:00
function IsNumericExpand {
eval " local value=\" ${ 1 } \" " # Needed eval so variable variables can be processed
echo $( IsNumeric " $value " )
# if [[ $value =~ ^-?[0-9]+([.][0-9]+)?$ ]]; then
# echo 1
#else
# echo 0
#fi
}
2016-12-07 20:30:10 +00:00
#### IsInteger SUBSET ####
2018-06-25 12:11:29 +00:00
# Function is busybox compatible since busybox ash does not understand direct regex, we use expr
2016-09-05 20:06:57 +00:00
function IsInteger {
local value = " ${ 1 } "
2018-06-25 12:11:29 +00:00
if type expr > /dev/null 2>& 1; then
expr " $value " : " ^[0-9]\+ $" > /dev/null 2>& 1
if [ $? -eq 0 ] ; then
echo 1
else
echo 0
fi
2016-09-05 20:06:57 +00:00
else
2018-06-25 12:11:29 +00:00
if [ [ $value = ~ ^[ 0-9] +$ ] ] ; then
echo 1
else
echo 0
fi
2016-09-05 20:06:57 +00:00
fi
}
2016-12-07 20:30:10 +00:00
#### IsInteger SUBSET END ####
2016-09-05 20:06:57 +00:00
2016-12-07 20:30:10 +00:00
#### HumanToNumeric SUBSET ####
2016-10-23 08:35:38 +00:00
# Converts human readable sizes into integer kilobyte sizes
2016-10-23 11:27:35 +00:00
# Usage numericSize="$(HumanToNumeric $humanSize)"
2016-10-23 08:35:38 +00:00
function HumanToNumeric {
2016-10-23 11:27:35 +00:00
local value = " ${ 1 } "
2016-10-23 08:35:38 +00:00
local notation
local suffix
local suffixPresent
local multiplier
notation = ( K M G T P E)
for suffix in " ${ notation [@] } " ; do
multiplier = $(( multiplier+1))
2016-10-23 11:27:35 +00:00
if [ [ " $value " = = *" $suffix " * ] ] ; then
2016-10-23 08:35:38 +00:00
suffixPresent = $suffix
break;
fi
done
if [ " $suffixPresent " != "" ] ; then
2016-10-23 11:27:35 +00:00
value = ${ value % $suffix * }
value = ${ value %.* }
2016-10-23 08:35:38 +00:00
# /1024 since we convert to kilobytes instead of bytes
2016-10-23 11:27:35 +00:00
value = $(( value*( 1024 * * multiplier/1024)) )
2016-10-23 08:35:38 +00:00
else
2016-10-23 11:27:35 +00:00
value = ${ value %.* }
2016-10-23 08:35:38 +00:00
fi
2016-10-23 11:27:35 +00:00
echo $value
2016-10-23 08:35:38 +00:00
}
2016-12-07 20:30:10 +00:00
#### HumanToNumeric SUBSET END ####
2016-10-23 08:35:38 +00:00
2018-06-25 12:11:29 +00:00
#### CheckRFC822 SUBSET ####
# 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
}
#### CheckRFC822 SUBSET END ####
2016-12-11 21:40:27 +00:00
#### UrlEncode SUBSET ####
2018-06-05 09:51:49 +00:00
## Modified version of https://gist.github.com/cdown/1163649
2016-12-08 07:58:56 +00:00
function UrlEncode {
2016-05-26 20:11:00 +00:00
local length = " ${# 1 } "
2018-07-09 13:01:45 +00:00
local i
2016-05-26 20:11:00 +00:00
local LANG = C
2018-06-05 09:51:49 +00:00
for i in $( seq 0 $(( length-1)) ) ; do
2016-05-26 20:11:00 +00:00
local c = " ${ 1 : i : 1 } "
case $c in
[ a-zA-Z0-9.~_-] )
printf " $c "
; ;
*)
printf '%%%02X' " ' $c "
; ;
esac
done
}
2016-12-11 21:40:27 +00:00
#### UrlEncode SUBSET END ####
2016-05-26 20:11:00 +00:00
2016-12-08 07:58:56 +00:00
function UrlDecode {
2016-10-19 10:28:30 +00:00
local urlEncoded = " ${ 1 //+/ } "
2016-05-26 20:11:00 +00:00
2016-10-19 10:28:30 +00:00
printf '%b' " ${ urlEncoded //%/ \\ x } "
2016-05-26 20:11:00 +00:00
}
2016-12-07 20:30:10 +00:00
#### ArrayContains SUBSET ####
2016-10-21 10:37:38 +00:00
## Modified version of http://stackoverflow.com/a/8574392
2016-12-08 07:58:56 +00:00
## Usage: [ $(ArrayContains "needle" "${haystack[@]}") -eq 1 ]
2016-12-06 22:24:02 +00:00
function ArrayContains ( ) {
local needle = " ${ 1 } "
local haystack = " ${ 2 } "
2016-10-21 10:37:38 +00:00
local e
2016-12-06 22:24:02 +00:00
if [ " $needle " != "" ] && [ " $haystack " != "" ] ; then
for e in " ${ @ : 2 } " ; do
if [ " $e " = = " $needle " ] ; then
echo 1
return
fi
done
2016-10-21 10:37:38 +00:00
fi
2016-12-06 22:24:02 +00:00
echo 0
return
2016-10-21 10:37:38 +00:00
}
2016-12-07 20:30:10 +00:00
#### ArrayContains SUBSET END ####
2016-10-21 10:37:38 +00:00
2016-12-11 21:40:27 +00:00
#### GetLocalOS SUBSET ####
2015-11-12 00:37:43 +00:00
function GetLocalOS {
2016-10-19 10:28:30 +00:00
local localOsVar
2017-02-07 21:04:36 +00:00
local localOsName
local localOsVer
2016-02-18 19:54:07 +00:00
2018-01-02 19:02:57 +00:00
# There is no good way to tell if currently running in BusyBox shell. Using sluggish way.
2016-11-14 22:10:37 +00:00
if ls --help 2>& 1 | grep -i "BusyBox" > /dev/null; then
2016-10-22 12:27:08 +00:00
localOsVar = "BusyBox"
else
2016-11-22 17:50:09 +00:00
# Detecting the special ubuntu userland in Windows 10 bash
2016-11-22 18:02:13 +00:00
if grep -i Microsoft /proc/sys/kernel/osrelease > /dev/null 2>& 1; then
localOsVar = "Microsoft"
else
2016-12-28 22:37:07 +00:00
localOsVar = " $( uname -spior 2>& 1) "
2016-11-22 18:02:13 +00:00
if [ $? != 0 ] ; then
localOsVar = " $( uname -v 2>& 1) "
2016-11-22 17:50:09 +00:00
if [ $? != 0 ] ; then
2016-11-22 18:02:13 +00:00
localOsVar = " $( uname) "
2016-11-22 17:50:09 +00:00
fi
2016-10-22 12:27:08 +00:00
fi
2015-11-12 00:37:43 +00:00
fi
fi
2016-10-19 10:28:30 +00:00
case $localOsVar in
2016-11-19 11:37:33 +00:00
# Android uname contains both linux and android, keep it before linux entry
*"Android" *)
LOCAL_OS = "Android"
; ;
2015-11-12 00:37:43 +00:00
*"Linux" *)
LOCAL_OS = "Linux"
; ;
*"BSD" *)
LOCAL_OS = "BSD"
; ;
2017-03-23 20:05:38 +00:00
*"MINGW32" *| *"MINGW64" *| *"MSYS" *)
2015-11-12 00:37:43 +00:00
LOCAL_OS = "msys"
; ;
2016-12-09 18:19:52 +00:00
*"CYGWIN" *)
LOCAL_OS = "Cygwin"
; ;
2016-11-22 16:41:06 +00:00
*"Microsoft" *)
2016-11-22 16:43:43 +00:00
LOCAL_OS = "WinNT10"
2016-11-22 16:41:06 +00:00
; ;
2015-11-12 00:37:43 +00:00
*"Darwin" *)
LOCAL_OS = "MacOSX"
; ;
2016-10-22 12:27:08 +00:00
*"BusyBox" *)
2016-11-19 11:37:33 +00:00
LOCAL_OS = "BusyBox"
2016-10-22 12:27:08 +00:00
; ;
2015-11-12 00:37:43 +00:00
*)
2016-12-03 08:47:51 +00:00
if [ " $IGNORE_OS_TYPE " = = "yes" ] ; then
2016-10-19 10:28:30 +00:00
Logger " Running on unknown local OS [ $localOsVar ]. " "WARN"
2016-03-19 09:48:46 +00:00
return
fi
2016-12-11 21:40:27 +00:00
if [ " $_OFUNCTIONS_VERSION " != "" ] ; then
Logger " Running on >> $localOsVar << not supported. Please report to the author. " "ERROR"
fi
2015-11-12 00:37:43 +00:00
exit 1
; ;
esac
2016-12-28 22:37:07 +00:00
2017-02-07 21:04:36 +00:00
# Get linux versions
if [ -f "/etc/os-release" ] ; then
2017-12-30 16:55:27 +00:00
localOsName = $( GetConfFileValue "/etc/os-release" "NAME" true )
localOsVer = $( GetConfFileValue "/etc/os-release" "VERSION" true )
2018-06-25 13:10:11 +00:00
elif [ " $LOCAL_OS " = = "BusyBox" ] ; then
localOsVer = ` ls --help 2>& 1 | head -1 | cut -f2 -d' ' `
localOsName = "BusyBox"
2017-02-07 21:04:36 +00:00
fi
2018-06-25 13:10:11 +00:00
# Get Host info for Windows
if [ " $LOCAL_OS " = = "msys" ] || [ " $LOCAL_OS " = = "BusyBox" ] || [ " $LOCAL_OS " = = "Cygwin" ] || [ " $LOCAL_OS " = = "WinNT10" ] ; then localOsVar = " $( uname -a) "
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"
if uname -m | grep '64' > /dev/null 2>& 1; then
LOCAL_OS_BITNESS = 64
else
LOCAL_OS_BITNESS = 32
fi
fi
LOCAL_OS_FULL = " $localOsVar ( $localOsName $localOsVer ) $LOCAL_OS_BITNESS -bit $LOCAL_OS_FAMILY "
2017-04-26 19:03:04 +00:00
if [ " $_OFUNCTIONS_VERSION " != "" ] ; then
Logger " Local OS: [ $LOCAL_OS_FULL ]. " "DEBUG"
fi
2015-11-12 00:37:43 +00:00
}
2016-12-11 21:40:27 +00:00
#### GetLocalOS SUBSET END ####
2015-11-12 00:37:43 +00:00
2017-04-11 11:25:03 +00:00
#__BEGIN_WITH_PARANOIA_DEBUG
function __CheckArguments {
# Checks the number of arguments of a function and raises an error if some are missing
if [ " $_DEBUG " = = "yes" ] ; then
local numberOfArguments = " ${ 1 } " # Number of arguments the tested function should have, can be a number of a range, eg 0-2 for zero to two arguments
local numberOfGivenArguments = " ${ 2 } " # Number of arguments that have been passed
local minArgs
local maxArgs
# All arguments of the function to check are passed as array in ${3} (the function call waits for $@)
# If any of the arguments contains spaces, bash things there are two aguments
# In order to avoid this, we need to iterate over ${3} and count
callerName = " ${ FUNCNAME [1] } "
local iterate = 3
local fetchArguments = true
local argList = ""
local countedArguments
while [ $fetchArguments = = true ] ; do
cmd = 'argument=${' $iterate '}'
eval $cmd
if [ " $argument " = = "" ] ; then
fetchArguments = false
else
argList = " $argList [Argument $(( iterate-2)) : $argument ] "
iterate = $(( iterate+1))
fi
done
countedArguments = $(( iterate-3))
if [ $( IsInteger " $numberOfArguments " ) -eq 1 ] ; then
minArgs = $numberOfArguments
maxArgs = $numberOfArguments
else
IFS = '-' read minArgs maxArgs <<< " $numberOfArguments "
fi
Logger " Entering function [ $callerName ]. " "PARANOIA_DEBUG"
if ! ( [ $countedArguments -ge $minArgs ] && [ $countedArguments -le $maxArgs ] ) ; then
Logger " Function $callerName may have inconsistent number of arguments. Expected min: $minArgs , max: $maxArgs , count: $countedArguments , bash seen: $numberOfGivenArguments . " "ERROR"
Logger " $callerName arguments: $argList " "ERROR"
else
if [ ! -z " $argList " ] ; then
Logger " $callerName arguments: $argList " "PARANOIA_DEBUG"
fi
fi
fi
}
#__END_WITH_PARANOIA_DEBUG
2016-12-07 20:30:10 +00:00
#### OFUNCTIONS MINI SUBSET END ####
2016-09-16 08:11:59 +00:00
2015-11-12 00:37:43 +00:00
function GetRemoteOS {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-02-18 19:54:07 +00:00
2016-11-19 12:13:08 +00:00
if [ " $REMOTE_OPERATION " != "yes" ] ; then
return 0
fi
2016-11-14 22:10:37 +00:00
local remoteOsVar
2017-06-07 10:43:45 +00: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
2016-11-14 22:10:37 +00:00
2017-04-26 19:03:04 +00:00
2016-11-14 22:10:37 +00:00
function GetOs {
local localOsVar
2017-02-07 21:04:36 +00:00
local localOsName
local localOsVer
2018-06-25 13:10:11 +00:00
local localOsBitness
local localOsFamily
2016-11-14 22:10:37 +00:00
2017-04-26 19:03:04 +00:00
local osInfo = "/etc/os-release"
2018-01-02 19:02:57 +00:00
# There is no good way to tell if currently running in BusyBox shell. Using sluggish way.
2016-11-14 22:10:37 +00:00
if ls --help 2>& 1 | grep -i "BusyBox" > /dev/null; then
localOsVar = "BusyBox"
else
2016-11-22 17:50:09 +00:00
# Detecting the special ubuntu userland in Windows 10 bash
2016-11-22 18:02:13 +00:00
if grep -i Microsoft /proc/sys/kernel/osrelease > /dev/null 2>& 1; then
localOsVar = "Microsoft"
else
2016-12-28 22:37:07 +00:00
localOsVar = " $( uname -spior 2>& 1) "
2016-11-22 18:02:13 +00:00
if [ $? != 0 ] ; then
localOsVar = " $( uname -v 2>& 1) "
2016-11-22 17:50:09 +00:00
if [ $? != 0 ] ; then
2016-11-22 18:02:13 +00:00
localOsVar = " $( uname) "
2016-11-22 17:50:09 +00:00
fi
2016-11-14 22:10:37 +00:00
fi
fi
fi
2017-02-07 21:04:36 +00:00
# Get linux versions
2017-04-26 19:03:04 +00:00
if [ -f " $osInfo " ] ; then
localOsName = $( grep "^NAME=" " $osInfo " )
2018-02-20 21:14:41 +00:00
localOsName = " ${ localOsName ##*= } "
2017-04-26 19:03:04 +00:00
localOsVer = $( grep "^VERSION=" " $osInfo " )
localOsVer = " ${ localOsVer ##*= } "
2018-06-25 13:10:11 +00:00
elif [ " $localOsVar " = = "BusyBox" ] ; then
localOsVer = ` ls --help 2>& 1 | head -1 | cut -f2 -d' ' `
localOsName = "BusyBox"
2017-02-07 21:04:36 +00:00
fi
2018-06-25 13:10:11 +00: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-14 22:10:37 +00:00
}
GetOs
ENDSSH
2018-01-31 20:04:48 +00:00
if [ $? != 0 ] ; then
Logger " Cannot connect to remote system [ $REMOTE_HOST ] port [ $REMOTE_PORT ]. " "CRITICAL"
2018-07-02 13:32:48 +00:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
Logger " $( cat " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ) " "ERROR"
fi
2018-01-31 20:04:48 +00:00
exit 1
fi
2016-11-14 22:10:37 +00:00
2016-12-12 10:38:27 +00:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] ; then
remoteOsVar = $( cat " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " )
2016-11-14 22:10:37 +00:00
case $remoteOsVar in
2016-11-19 11:37:33 +00:00
*"Android" *)
REMOTE_OS = "Android"
; ;
2016-11-14 22:10:37 +00:00
*"Linux" *)
REMOTE_OS = "Linux"
; ;
*"BSD" *)
REMOTE_OS = "BSD"
; ;
2017-03-23 20:05:38 +00:00
*"MINGW32" *| *"MINGW64" *| *"MSYS" *)
2016-11-14 22:10:37 +00:00
REMOTE_OS = "msys"
; ;
2016-12-09 18:19:52 +00:00
*"CYGWIN" *)
REMOTE_OS = "Cygwin"
; ;
2016-11-22 16:41:06 +00:00
*"Microsoft" *)
REMOTE_OS = "WinNT10"
; ;
2016-11-14 22:10:37 +00:00
*"Darwin" *)
REMOTE_OS = "MacOSX"
; ;
*"BusyBox" *)
2016-11-19 11:37:33 +00:00
REMOTE_OS = "BusyBox"
2016-11-14 22:10:37 +00:00
; ;
*"ssh" *| *"SSH" *)
Logger "Cannot connect to remote system." "CRITICAL"
exit 1
; ;
*)
if [ " $IGNORE_OS_TYPE " = = "yes" ] ; then #DOC: Undocumented debug only setting
Logger " Running on unknown remote OS [ $remoteOsVar ]. " "WARN"
return
fi
Logger "Running on remote OS failed. Please report to the author if the OS is not supported." "CRITICAL"
Logger " Remote OS said:\n $remoteOsVar " "CRITICAL"
exit 1
esac
Logger " Remote OS: [ $remoteOsVar ]. " "DEBUG"
else
2016-11-15 12:14:41 +00:00
Logger "Cannot get Remote OS" "CRITICAL"
2015-11-12 00:37:43 +00:00
fi
}
function RunLocalCommand {
local command = " ${ 1 } " # Command to run
2016-10-19 10:28:30 +00:00
local hardMaxTime = " ${ 2 } " # Max time to wait for command to compleet
2016-12-07 20:30:10 +00:00
__CheckArguments 2 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-08-29 11:48:03 +00:00
if [ $_DRYRUN = = true ] ; then
2015-11-12 00:37:43 +00:00
Logger " Dryrun: Local command [ $command ] not run. " "NOTICE"
2015-11-19 21:39:31 +00:00
return 0
2015-11-12 00:37:43 +00:00
fi
2015-11-19 21:39:31 +00:00
2015-11-12 00:37:43 +00:00
Logger " Running command [ $command ] on local host. " "NOTICE"
2016-12-12 10:38:27 +00:00
eval " $command " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " 2>& 1 &
2016-11-24 08:40:33 +00:00
2018-03-15 08:53:35 +00:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 0 $hardMaxTime true $SLEEP_TIME $KEEP_LOGGING
2018-02-20 21:14:41 +00:00
#ExecTasks "${FUNCNAME[0]}" 0 0 $SOFT_MAX_EXEC_TIME $HARD_MAX_EXEC_TIME $SLEEP_TIME $KEEP_LOGGING true true false false 1 $!
2015-11-12 00:37:43 +00:00
retval = $?
if [ $retval -eq 0 ] ; then
Logger "Command succeded." "NOTICE"
else
Logger "Command failed." "ERROR"
fi
2016-11-17 19:00:23 +00:00
if [ $_LOGGER_VERBOSE = = true ] || [ $retval -ne 0 ] ; then
2016-12-12 10:38:27 +00:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID .$TSTAMP ) " "NOTICE"
2015-11-12 00:37:43 +00:00
fi
if [ " $STOP_ON_CMD_ERROR " = = "yes" ] && [ $retval -ne 0 ] ; then
Logger "Stopping on command execution error." "CRITICAL"
exit 1
fi
}
## Runs remote command $1 and waits for completition in $2 seconds
function RunRemoteCommand {
local command = " ${ 1 } " # Command to run
2016-10-19 10:28:30 +00:00
local hardMaxTime = " ${ 2 } " # Max time to wait for command to compleet
2016-12-07 20:30:10 +00:00
__CheckArguments 2 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2017-02-13 11:47:46 +00:00
if [ " $REMOTE_OPERATION " != "yes" ] ; then
Logger " Ignoring remote command [ $command ] because remote host is not configured. " "WARN"
return 0
fi
2015-11-12 00:37:43 +00:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-08-29 11:48:03 +00:00
if [ $_DRYRUN = = true ] ; then
2015-11-12 00:37:43 +00:00
Logger " Dryrun: Local command [ $command ] not run. " "NOTICE"
2015-11-19 21:39:31 +00:00
return 0
2015-11-12 00:37:43 +00:00
fi
2015-11-19 21:39:31 +00:00
2015-11-12 00:37:43 +00:00
Logger " Running command [ $command ] on remote host. " "NOTICE"
2017-06-07 10:43:45 +00: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-12 00:37:43 +00:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2018-03-15 08:53:35 +00:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 0 $hardMaxTime true $SLEEP_TIME $KEEP_LOGGING
2018-02-20 21:14:41 +00:00
#ExecTasks "${FUNCNAME[0]}" 0 0 $SOFT_MAX_EXEC_TIME $HARD_MAX_EXEC_TIME $SLEEP_TIME $KEEP_LOGGING true true false false 1 $!
2015-11-12 00:37:43 +00:00
retval = $?
if [ $retval -eq 0 ] ; then
Logger "Command succeded." "NOTICE"
else
Logger "Command failed." "ERROR"
fi
2016-12-12 10:38:27 +00:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID . $TSTAMP " ] && ( [ $_LOGGER_VERBOSE = = true ] || [ $retval -ne 0 ] )
2015-11-12 00:37:43 +00:00
then
2016-12-12 10:38:27 +00:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID .$TSTAMP ) " "NOTICE"
2015-11-12 00:37:43 +00:00
fi
if [ " $STOP_ON_CMD_ERROR " = = "yes" ] && [ $retval -ne 0 ] ; then
Logger "Stopping on command execution error." "CRITICAL"
exit 1
fi
}
function RunBeforeHook {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-10-19 10:28:30 +00:00
local pids
2016-08-03 22:52:05 +00:00
2015-11-12 00:37:43 +00:00
if [ " $LOCAL_RUN_BEFORE_CMD " != "" ] ; then
2016-08-03 22:28:09 +00:00
RunLocalCommand " $LOCAL_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE &
pids = " $! "
2015-11-12 00:37:43 +00:00
fi
if [ " $REMOTE_RUN_BEFORE_CMD " != "" ] ; then
2016-08-03 22:28:09 +00:00
RunRemoteCommand " $REMOTE_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE &
pids = " $pids ; $! "
2015-11-12 00:37:43 +00:00
fi
2016-08-03 22:52:05 +00:00
if [ " $pids " != "" ] ; then
2018-03-15 08:53:35 +00:00
ExecTasks $pids " ${ FUNCNAME [0] } " false 0 0 0 0 true $SLEEP_TIME $KEEP_LOGGING
2018-02-20 21:14:41 +00:00
#ExecTasks "${FUNCNAME[0]}" 0 0 0 0 true true false false 1 $pids
2016-08-03 22:52:05 +00:00
fi
2015-11-12 00:37:43 +00:00
}
function RunAfterHook {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-08-03 22:52:05 +00:00
local pids
2015-11-12 00:37:43 +00:00
if [ " $LOCAL_RUN_AFTER_CMD " != "" ] ; then
2016-08-03 22:28:09 +00:00
RunLocalCommand " $LOCAL_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER &
pids = " $! "
2015-11-12 00:37:43 +00:00
fi
if [ " $REMOTE_RUN_AFTER_CMD " != "" ] ; then
2016-08-03 22:28:09 +00:00
RunRemoteCommand " $REMOTE_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER &
pids = " $pids ; $! "
2015-11-12 00:37:43 +00:00
fi
2016-08-03 22:52:05 +00:00
if [ " $pids " != "" ] ; then
2018-03-15 08:53:35 +00:00
ExecTasks $pids " ${ FUNCNAME [0] } " false 0 0 0 0 true $SLEEP_TIME $KEEP_LOGGING
2018-02-20 21:14:41 +00:00
#ExecTasks "${FUNCNAME[0]}" 0 0 0 0 true true false false 1 $pids
2016-08-03 22:52:05 +00:00
fi
2015-11-12 00:37:43 +00:00
}
function CheckConnectivityRemoteHost {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-09-05 20:06:57 +00:00
local retval
2016-11-20 16:43:13 +00:00
if [ " $_PARANOIA_DEBUG " != "yes" ] ; then # Do not loose time in paranoia debug #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
if [ " $REMOTE_HOST_PING " != "no" ] && [ " $REMOTE_OPERATION " != "no" ] ; then
eval " $PING_CMD $REMOTE_HOST > /dev/null 2>&1 " &
2018-02-20 21:14:41 +00:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 60 180 true $SLEEP_TIME $KEEP_LOGGING
#ExecTasks "${FUNCNAME[0]}" 0 0 60 180 $SLEEP_TIME $KEEP_LOGGING true true false false 1 $!
2016-09-05 20:06:57 +00:00
retval = $?
if [ $retval != 0 ] ; then
2016-09-16 08:11:59 +00:00
Logger " Cannot ping [ $REMOTE_HOST ]. Return code [ $retval ]. " "WARN"
2016-09-05 20:06:57 +00:00
return $retval
2015-11-12 00:37:43 +00:00
fi
fi
2016-11-20 16:43:13 +00:00
fi #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
}
function CheckConnectivity3rdPartyHosts {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-10-19 10:28:30 +00:00
local remote3rdPartySuccess
2016-09-05 20:06:57 +00:00
local retval
2018-01-02 19:02:57 +00:00
local i
2016-08-08 16:06:31 +00:00
2016-11-20 16:43:13 +00:00
if [ " $_PARANOIA_DEBUG " != "yes" ] ; then # Do not loose time in paranoia debug #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
if [ " $REMOTE_3RD_PARTY_HOSTS " != "" ] ; then
2016-10-19 10:28:30 +00:00
remote3rdPartySuccess = false
2015-11-12 00:37:43 +00:00
for i in $REMOTE_3RD_PARTY_HOSTS
do
eval " $PING_CMD $i > /dev/null 2>&1 " &
2018-02-20 21:14:41 +00:00
ExecTasks $! " ${ FUNCNAME [0] } " false 0 0 60 180 true $SLEEP_TIME $KEEP_LOGGING
#ExecTasks "${FUNCNAME[0]}" 0 0 180 360 $SLEEP_TIME $KEEP_LOGGING true true false false 1 $!
2016-09-05 20:06:57 +00:00
retval = $?
if [ $retval != 0 ] ; then
Logger " Cannot ping 3rd party host [ $i ]. Return code [ $retval ]. " "NOTICE"
2015-11-12 00:37:43 +00:00
else
2016-10-19 10:28:30 +00:00
remote3rdPartySuccess = true
2015-11-12 00:37:43 +00:00
fi
done
2016-08-08 16:06:31 +00:00
2016-10-19 10:28:30 +00:00
if [ $remote3rdPartySuccess = = false ] ; then
2016-09-16 08:11:59 +00:00
Logger "No remote 3rd party host responded to ping. No internet ?" "WARN"
2015-11-12 00:37:43 +00:00
return 1
2016-08-08 16:06:31 +00:00
else
return 0
2015-11-12 00:37:43 +00:00
fi
fi
2016-11-20 16:43:13 +00:00
fi #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
}
2016-02-21 10:12:41 +00:00
function RsyncPatternsAdd {
2016-10-19 10:28:30 +00:00
local patternType = " ${ 1 } " # exclude or include
2016-04-01 19:29:33 +00:00
local pattern = " ${ 2 } "
2016-12-07 20:30:10 +00:00
__CheckArguments 2 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-08-08 16:06:31 +00:00
local rest
2015-11-12 00:37:43 +00:00
2016-02-21 10:12:41 +00: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
2016-12-03 08:39:09 +00:00
str = " ${ rest %% $PATH_SEPARATOR_CHAR * } "
2016-02-21 10:12:41 +00:00
# Handle the last case
2016-12-11 20:56:47 +00:00
if [ " $rest " = = " ${ rest / $PATH_SEPARATOR_CHAR / } " ] ; then
2016-02-21 10:12:41 +00:00
rest =
else
# Cut everything before the first occurence of $PATH_SEPARATOR_CHAR
2016-12-03 08:39:09 +00:00
rest = " ${ rest #* $PATH_SEPARATOR_CHAR } "
2015-11-12 00:37:43 +00:00
fi
2016-02-21 10:12:41 +00:00
if [ " $RSYNC_PATTERNS " = = "" ] ; then
2018-10-01 12:13:05 +00:00
RSYNC_PATTERNS = " -- $patternType =\" $str \" "
2016-02-21 10:12:41 +00:00
else
2018-10-01 12:13:05 +00:00
RSYNC_PATTERNS = " $RSYNC_PATTERNS -- $patternType =\" $str \" "
2015-11-12 00:37:43 +00:00
fi
2016-02-21 10:12:41 +00:00
done
set +f
}
2015-11-12 00:37:43 +00:00
2016-02-21 10:12:41 +00:00
function RsyncPatternsFromAdd {
2016-10-19 10:28:30 +00:00
local patternType = " ${ 1 } "
local patternFrom = " ${ 2 } "
2016-12-07 20:30:10 +00:00
__CheckArguments 2 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-02-21 10:12:41 +00:00
2016-08-08 16:06:31 +00:00
## Check if the exclude list has a full path, and if not, add the config file path if there is one
2016-10-19 10:28:30 +00:00
if [ " $( basename $patternFrom ) " = = " $patternFrom " ] ; then
patternFrom = " $( dirname $CONFIG_FILE ) / $patternFrom "
2016-08-08 16:06:31 +00:00
fi
2016-02-21 10:12:41 +00:00
2016-10-19 10:28:30 +00:00
if [ -e " $patternFrom " ] ; then
2018-10-01 12:13:05 +00:00
RSYNC_PATTERNS = " $RSYNC_PATTERNS -- $patternType -from=\" $patternFrom \" "
2016-08-08 16:06:31 +00:00
fi
2016-02-21 10:12:41 +00:00
}
function RsyncPatterns {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-08-08 16:06:31 +00: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
2017-12-30 16:59:12 +00:00
RsyncPatternsAdd "include" " $RSYNC_INCLUDE_PATTERN "
2016-08-08 16:06:31 +00:00
fi
if [ " $RSYNC_INCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "include" " $RSYNC_INCLUDE_FROM "
fi
2016-09-16 08:11:59 +00:00
# Use default include first for quicksync runs
2016-10-23 16:23:44 +00:00
elif [ " $RSYNC_PATTERN_FIRST " = = "include" ] || [ " $_QUICK_SYNC " = = "2" ] ; then
2016-08-08 16:06:31 +00: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
Logger "Bogus RSYNC_PATTERN_FIRST value in config file. Will not use rsync patterns." "WARN"
fi
2015-11-12 00:37:43 +00:00
}
function PreInit {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
2016-10-23 16:23:44 +00:00
local compressionString
2015-11-12 00:37:43 +00:00
## SSH compression
2016-08-08 16:06:31 +00:00
if [ " $SSH_COMPRESSION " != "no" ] ; then
SSH_COMP = -C
else
SSH_COMP =
fi
2015-11-12 00:37:43 +00:00
2016-03-29 20:55:57 +00:00
## Ignore SSH known host verification
if [ " $SSH_IGNORE_KNOWN_HOSTS " = = "yes" ] ; then
SSH_OPTS = "-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
fi
2016-08-08 16:06:31 +00:00
## Support for older config files without RSYNC_EXECUTABLE option
if [ " $RSYNC_EXECUTABLE " = = "" ] ; then
RSYNC_EXECUTABLE = rsync
fi
## Sudo execution option
if [ " $SUDO_EXEC " = = "yes" ] ; then
if [ " $RSYNC_REMOTE_PATH " != "" ] ; then
RSYNC_PATH = " sudo $RSYNC_REMOTE_PATH / $RSYNC_EXECUTABLE "
else
RSYNC_PATH = " sudo $RSYNC_EXECUTABLE "
fi
2016-12-19 12:19:21 +00:00
COMMAND_SUDO = "sudo -E"
2016-08-08 16:06:31 +00: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-12 00:37:43 +00:00
2016-11-21 14:13:15 +00:00
## Set compression executable and extension
2016-10-23 16:23:44 +00:00
if [ " $( IsInteger $COMPRESSION_LEVEL ) " -eq 0 ] ; then
COMPRESSION_LEVEL = 3
fi
2015-11-12 00:37:43 +00:00
}
function PostInit {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2015-11-12 00:37:43 +00:00
# Define remote commands
2016-10-19 10:28:30 +00:00
if [ -f " $SSH_RSA_PRIVATE_KEY " ] ; then
2017-05-22 07:32:12 +00: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 "
2016-10-19 10:28:30 +00:00
elif [ -f " $SSH_PASSWORD_FILE " ] ; then
2017-05-22 07:32:12 +00: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 "
2016-10-19 10:28:30 +00:00
else
SSH_PASSWORD = ""
SSH_CMD = ""
SCP_CMD = ""
RSYNC_SSH_CMD = ""
fi
2015-11-12 00:37:43 +00:00
}
2016-12-23 19:41:52 +00:00
function SetCompression {
2018-01-02 19:02:57 +00:00
## Busybox fix (Termux xz command does not support compression at all)
2016-12-23 19:41:52 +00:00
if [ " $LOCAL_OS " = = "BusyBox" ] || [ " $REMOTE_OS " = = "Busybox" ] || [ " $LOCAL_OS " = = "Android" ] || [ " $REMOTE_OS " = = "Android" ] ; then
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
else
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
COMPRESSION_OPTIONS = --rsyncable
elif type gzip > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | gzip -c $compressionString "
COMPRESSION_EXTENSION = .gz
# obackup specific
COMPRESSION_OPTIONS = --rsyncable
else
COMPRESSION_PROGRAM =
COMPRESSION_EXTENSION =
fi
fi
2017-06-09 09:49:13 +00:00
if [ " . ${ ALERT_LOG_FILE ##*. } " != " $COMPRESSION_EXTENSION " ] ; then
ALERT_LOG_FILE = " $ALERT_LOG_FILE $COMPRESSION_EXTENSION "
fi
2016-12-23 19:41:52 +00:00
}
2016-12-04 10:10:02 +00:00
function InitLocalOSDependingSettings {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-08-08 16:06:31 +00: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-06-26 07:56:54 +00:00
if [ " $LOCAL_OS " = = "msys" ] || [ " $LOCAL_OS " = = "Cygwin" ] || [ " $LOCAL_OS " = = "Microsoft" ] || [ " $LOCAL_OS " = = "WinNT10" ] ; then
2016-08-08 16:06:31 +00:00
FIND_CMD = $( dirname $BASH ) /find
PING_CMD = '$SYSTEMROOT\system32\ping -n 2'
2017-02-07 21:24:54 +00:00
# On BSD, when not root, min ping interval is 1s
2017-02-07 21:28:54 +00:00
elif [ " $LOCAL_OS " = = "BSD" ] && [ " $LOCAL_USER " != "root" ] ; then
2017-02-07 21:24:54 +00:00
FIND_CMD = find
PING_CMD = "ping -c 2 -i 1"
2016-08-08 16:06:31 +00:00
else
FIND_CMD = find
PING_CMD = "ping -c 2 -i .2"
fi
2016-12-09 18:19:52 +00:00
if [ " $LOCAL_OS " = = "BusyBox" ] || [ " $LOCAL_OS " = = "Android" ] || [ " $LOCAL_OS " = = "msys" ] || [ " $LOCAL_OS " = = "Cygwin" ] ; then
2016-10-22 12:14:52 +00:00
PROCESS_STATE_CMD = "echo none"
2016-11-19 11:37:33 +00:00
DF_CMD = "df"
2016-10-22 12:14:52 +00:00
else
PROCESS_STATE_CMD = 'ps -p$pid -o state= 2 > /dev/null'
2016-11-19 11:37:33 +00:00
# CentOS 5 needs -P for one line output
DF_CMD = "df -P"
2016-10-22 12:14:52 +00:00
fi
2016-08-08 16:06:31 +00:00
## Stat command has different syntax on Linux and FreeBSD/MacOSX
if [ " $LOCAL_OS " = = "MacOSX" ] || [ " $LOCAL_OS " = = "BSD" ] ; then
2016-10-22 12:27:08 +00:00
# Tested on BSD and Mac
2016-08-08 16:06:31 +00:00
STAT_CMD = "stat -f \"%Sm\""
2016-04-03 14:06:45 +00:00
STAT_CTIME_MTIME_CMD = "stat -f %N;%c;%m"
2018-02-20 21:37:46 +00:00
SED_REGEX_ARG = "-E"
2016-08-08 16:06:31 +00:00
else
2016-11-22 17:18:35 +00:00
# Tested on GNU stat, busybox and Cygwin
2016-10-22 12:27:08 +00:00
STAT_CMD = "stat -c %y"
2016-04-03 14:06:45 +00:00
STAT_CTIME_MTIME_CMD = "stat -c %n;%Z;%Y"
2018-02-20 21:37:46 +00:00
SED_REGEX_ARG = "-r"
2016-08-08 16:06:31 +00:00
fi
2016-12-23 19:41:52 +00:00
# Set compression first time when we know what local os we have
SetCompression
2015-11-12 00:37:43 +00:00
}
2018-01-02 19:02:57 +00: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
2016-12-04 10:10:02 +00:00
function InitRemoteOSDependingSettings {
2016-12-07 20:30:10 +00:00
__CheckArguments 0 $# " $@ " #__WITH_PARANOIA_DEBUG
2016-08-08 16:06:31 +00:00
2016-12-09 18:19:52 +00:00
if [ " $REMOTE_OS " = = "msys" ] || [ " $LOCAL_OS " = = "Cygwin" ] ; then
2016-08-08 16:06:31 +00:00
REMOTE_FIND_CMD = $( dirname $BASH ) /find
else
REMOTE_FIND_CMD = find
fi
## Stat command has different syntax on Linux and FreeBSD/MacOSX
if [ " $LOCAL_OS " = = "MacOSX" ] || [ " $LOCAL_OS " = = "BSD" ] ; then
REMOTE_STAT_CMD = "stat -f \"%Sm\""
2016-12-12 07:57:31 +00:00
REMOTE_STAT_CTIME_MTIME_CMD = "stat -f \\\"%N;%c;%m\\\""
2016-08-08 16:06:31 +00:00
else
REMOTE_STAT_CMD = "stat --format %y"
2016-12-12 07:57:31 +00:00
REMOTE_STAT_CTIME_MTIME_CMD = "stat -c \\\"%n;%Z;%Y\\\""
2016-08-08 16:06:31 +00:00
fi
2016-04-03 14:06:45 +00:00
2018-09-30 11:57:57 +00:00
## Set rsync default arguments (complete with -r or -d depending on recursivity later)
2018-09-30 12:06:24 +00:00
RSYNC_DEFAULT_ARGS = "-ltD -8"
2016-11-21 14:13:15 +00:00
if [ " $_DRYRUN " = = true ] ; then
RSYNC_DRY_ARG = "-n"
DRY_WARNING = "/!\ DRY RUN "
else
RSYNC_DRY_ARG = ""
fi
RSYNC_ATTR_ARGS = ""
if [ " $PRESERVE_PERMISSIONS " != "no" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -p"
fi
if [ " $PRESERVE_OWNER " != "no" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -o"
fi
if [ " $PRESERVE_GROUP " != "no" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -g"
fi
if [ " $PRESERVE_EXECUTABILITY " != "no" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " --executability"
fi
2016-12-11 10:33:42 +00:00
if [ " $PRESERVE_ACL " = = "yes" ] ; then
2016-12-11 10:48:41 +00: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-21 14:13:15 +00:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -A"
2016-12-11 10:33:42 +00:00
else
2016-12-12 08:36:10 +00:00
Logger " Disabling ACL synchronization on [ $LOCAL_OS ] due to lack of support. " "NOTICE"
2016-12-11 10:33:42 +00:00
2016-11-21 14:13:15 +00:00
fi
2016-12-11 10:33:42 +00:00
fi
if [ " $PRESERVE_XATTR " = = "yes" ] ; then
2016-12-11 10:38:36 +00: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-21 14:13:15 +00:00
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -X"
2016-12-11 10:33:42 +00:00
else
2016-12-12 08:36:10 +00:00
Logger " Disabling extended attributes synchronization on [ $LOCAL_OS ] due to lack of support. " "NOTICE"
2016-11-21 14:13:15 +00:00
fi
fi
if [ " $RSYNC_COMPRESS " = = "yes" ] ; then
2016-12-12 08:36:10 +00:00
if [ " $LOCAL_OS " != "MacOSX" ] && [ " $REMOTE_OS " != "MacOSX" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -zz --skip-compress=gz/xz/lz/lzma/lzo/rz/jpg/mp3/mp4/7z/bz2/rar/zip/sfark/s7z/ace/apk/arc/cab/dmg/jar/kgb/lzh/lha/lzx/pak/sfx"
2016-12-12 08:36:10 +00:00
else
Logger " Disabling compression skips on synchronization on [ $LOCAL_OS ] due to lack of support. " "NOTICE"
2016-12-12 08:37:17 +00:00
fi
2016-11-21 14:13:15 +00:00
fi
if [ " $COPY_SYMLINKS " = = "yes" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -L"
2016-11-21 14:13:15 +00:00
fi
if [ " $KEEP_DIRLINKS " = = "yes" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -K"
2016-11-21 14:13:15 +00:00
fi
2016-12-13 08:18:47 +00:00
if [ " $RSYNC_OPTIONAL_ARGS " != "" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " " $RSYNC_OPTIONAL_ARGS
2016-12-13 08:18:47 +00:00
fi
2016-11-21 14:13:15 +00:00
if [ " $PRESERVE_HARDLINKS " = = "yes" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " -H"
2016-11-21 14:13:15 +00:00
fi
if [ " $CHECKSUM " = = "yes" ] ; then
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " --checksum"
fi
if [ " $BANDWIDTH " != "" ] && [ " $BANDWIDTH " != "0" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --bwlimit= $BANDWIDTH "
2016-11-21 14:13:15 +00:00
fi
if [ " $PARTIAL " = = "yes" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --partial --partial-dir=\" $PARTIAL_DIR \" "
2016-11-21 14:13:15 +00:00
RSYNC_PARTIAL_EXCLUDE = " --exclude=\" $PARTIAL_DIR \" "
fi
if [ " $DELTA_COPIES " != "no" ] ; then
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --no-whole-file"
2016-11-21 14:13:15 +00:00
else
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_ARGS = $RSYNC_DEFAULT_ARGS " --whole-file"
2016-11-21 14:13:15 +00:00
fi
2016-12-04 10:10:02 +00:00
2018-01-02 19:02:57 +00:00
# Set compression options again after we know what remote OS we are dealing with
2016-12-23 19:41:52 +00:00
SetCompression
2018-09-30 11:57:57 +00:00
2018-09-30 12:50:00 +00:00
# Set recursive options
2018-09-30 11:57:57 +00:00
RSYNC_DEFAULT_NONRECURSIVE_ARGS = " -d $RSYNC_DEFAULT_ARGS "
2018-09-30 12:50:00 +00:00
RSYNC_DEFAULT_ARGS = " -r $RSYNC_DEFAULT_ARGS "
2016-11-21 14:13:15 +00:00
}
2016-08-18 21:28:41 +00:00
## IFS debug function
function PrintIFS {
printf "IFS is: %q" " $IFS "
}
2016-09-16 08:11:59 +00: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-04-11 11:25:03 +00:00
#### VerComp SUBSET ####
2017-02-03 11:00:03 +00: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-04-11 11:25:03 +00:00
function VerComp ( ) {
2017-04-20 19:30:04 +00:00
if [ " $1 " = = "" ] || [ " $2 " = = "" ] ; then
Logger " Bogus Vercomp values [ $1 ] and [ $2 ]. " "WARN"
return 1
fi
2017-04-11 11:25:03 +00:00
2018-10-01 12:10:16 +00:00
if [ [ " $1 " = = " $2 " ] ]
2017-04-20 19:30:04 +00:00
then
echo 0
2017-04-11 11:25:03 +00:00
return
2017-04-20 19:30:04 +00:00
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-20 21:14:41 +00:00
ver1[ i] = 0
2017-04-20 19:30:04 +00: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-20 21:14:41 +00:00
fi
if ( ( 10#${ ver1 [i] } < 10#${ ver2 [i] } ) )
then
2017-04-20 19:30:04 +00:00
echo 2
2018-02-20 21:14:41 +00:00
return
fi
done
2017-04-11 11:25:03 +00:00
2018-02-20 21:14:41 +00:00
echo 0
2017-04-11 11:25:03 +00:00
return
2017-02-03 11:00:03 +00:00
}
2017-04-11 11:25:03 +00:00
#### VerComp SUBSET END ####
2017-02-03 11:00:03 +00:00
2017-02-07 21:04:36 +00:00
#### GetConfFileValue SUBSET ####
function GetConfFileValue ( ) {
2018-02-20 21:14:41 +00:00
local file = " ${ 1 } "
local name = " ${ 2 } "
2017-12-30 16:55:27 +00:00
local noError = " ${ 3 :- false } "
2018-02-20 21:14:41 +00:00
local value
2017-02-07 21:04:36 +00:00
2018-02-20 21:14:41 +00:00
value = $( grep " ^ $name = " " $file " )
if [ $? = = 0 ] ; then
value = " ${ value ##*= } "
echo " $value "
else
2017-12-30 16:55:27 +00:00
if [ $noError = = true ] ; then
2018-02-20 21:14:41 +00:00
Logger " Cannot get value for [ $name ] in config file [ $file ]. " "NOTICE"
2017-12-30 16:55:27 +00:00
else
Logger " Cannot get value for [ $name ] in config file [ $file ]. " "ERROR"
fi
2018-02-20 21:14:41 +00:00
fi
2017-02-07 21:04:36 +00:00
}
2017-12-30 16:55:27 +00:00
2017-02-07 21:04:36 +00:00
#### GetConfFileValue SUBSET END ####
#### SetConfFileValue SUBSET ####
function SetConfFileValue ( ) {
2018-02-20 21:14:41 +00:00
local file = " ${ 1 } "
local name = " ${ 2 } "
local value = " ${ 3 } "
2017-02-09 12:02:44 +00:00
local separator = " ${ 4 :- # } "
2017-02-07 21:04:36 +00:00
2018-02-20 21:14:41 +00:00
if grep " ^ $name = " " $file " > /dev/null; then
# Using -i.tmp for BSD compat
sed -i.tmp " s $separator ^ $name =.* $separator $name = $value $separator " " $file "
rm -f " $file .tmp "
2017-02-07 21:04:36 +00:00
Logger " Set [ $name ] to [ $value ] in config file [ $file ]. " "DEBUG"
2018-02-20 21:14:41 +00:00
else
2017-02-07 21:04:36 +00:00
Logger " Cannot set value [ $name ] to [ $value ] in config file [ $file ]. " "ERROR"
2018-02-20 21:14:41 +00:00
fi
2017-02-07 21:04:36 +00:00
}
#### SetConfFileValue SUBSET END ####
2017-04-11 11:25:03 +00:00
# Function can replace [ -f /some/file* ] tests
# Modified version of http://stackoverflow.com/a/6364244/2635443
function WildcardFileExists ( ) {
2018-02-20 21:14:41 +00: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-04-11 11:25:03 +00:00
}
2016-12-07 20:30:10 +00:00
#### OFUNCTIONS FULL SUBSET END ####