2015-11-12 01:26:38 +01:00
#!/usr/bin/env bash
2013-07-16 23:10:27 +02:00
2016-09-08 22:51:24 +02:00
#TODO: missing files says Backup succeed
#TODO: ListingDatabases fail succeed
#TODO: Add .gpg extesion to RotateFiles ?
2015-11-12 01:26:38 +01:00
###### Remote push/pull (or local) backup script for files & databases
PROGRAM = "obackup"
2016-03-31 10:02:42 +02:00
AUTHOR = "(C) 2013-2016 by Orsiris de Jong"
2015-01-08 20:05:58 +01:00
CONTACT = "http://www.netpower.fr/obackup - ozy@netpower.fr"
2016-08-06 14:04:35 +02:00
PROGRAM_VERSION = 2.1-dev
2016-11-12 00:39:19 +01:00
PROGRAM_BUILD = 2016111201
2016-08-31 12:28:19 +02:00
IS_STABLE = no
2015-11-12 01:26:38 +01:00
2016-08-06 16:16:19 +02:00
#### MINIMAL-FUNCTION-SET BEGIN ####
2016-11-10 16:25:37 +01:00
## FUNC_BUILD=2016111002
2016-08-31 11:26:21 +02:00
## BEGIN Generic bash functions written in 2013-2016 by Orsiris de Jong - http://www.netpower.fr - ozy@netpower.fr
## To use in a program, define the following variables:
## PROGRAM=program-name
## INSTANCE_ID=program-instance-name
## _DEBUG=yes/no
2015-11-19 23:04:02 +01:00
2016-11-10 16:25:37 +01:00
#TODO(high): Refactor GetRemoteOs into big oneliner for faster execution (if busybox else uname else uname -spio in one statement)
#TODO(high): Implement busybox support in SendEmail function
2016-09-08 22:51:24 +02:00
#TODO: Windows checks, check sendmail & mailsend
2015-11-19 23:04:02 +01:00
if ! type " $BASH " > /dev/null; then
echo "Please run this script only with bash shell. Tested on bash >= 3.2"
exit 127
fi
2016-03-18 19:20:28 +01:00
## Correct output of sort command (language agnostic sorting)
export LC_ALL = C
# Standard alert mail body
MAIL_ALERT_MSG = " Execution of $PROGRAM instance $INSTANCE_ID on $( date) has warnings/errors. "
2016-08-06 16:16:19 +02:00
# Environment variables that can be overriden by programs
2016-08-31 11:26:21 +02:00
_DRYRUN = false
_SILENT = false
_VERBOSE = false
2016-08-06 16:16:19 +02:00
_LOGGER_PREFIX = "date"
2016-08-31 11:26:21 +02:00
_LOGGER_STDERR = false
2016-08-16 22:54:52 +02:00
if [ " $KEEP_LOGGING " = = "" ] ; then
2016-08-16 22:40:02 +02:00
KEEP_LOGGING = 1801
fi
2015-11-19 23:04:02 +01:00
# Initial error status, logging 'WARN', 'ERROR' or 'CRITICAL' will enable alerts flags
2016-08-31 11:26:21 +02:00
ERROR_ALERT = false
WARN_ALERT = false
2015-11-19 23:04:02 +01:00
2016-08-31 11:26:21 +02:00
# Log from current run
CURRENT_LOG = ""
2016-08-26 15:10:30 +02:00
2015-11-19 23:04:02 +01:00
## allow debugging from command line with _DEBUG=yes
if [ ! " $_DEBUG " = = "yes" ] ; then
_DEBUG = no
2016-08-06 16:16:19 +02:00
SLEEP_TIME = .05 # Tested under linux and FreeBSD bash, #TODO tests on cygwin / msys
2016-08-31 11:26:21 +02:00
_VERBOSE = false
2015-11-19 23:04:02 +01:00
else
SLEEP_TIME = 1
trap 'TrapError ${LINENO} $?' ERR
2016-08-31 11:26:21 +02:00
_VERBOSE = true
2015-11-19 23:04:02 +01:00
fi
SCRIPT_PID = $$
LOCAL_USER = $( whoami)
LOCAL_HOST = $( hostname)
2016-08-31 11:26:21 +02:00
if [ " $PROGRAM " = = "" ] ; then
PROGRAM = "ofunctions"
fi
2015-11-19 23:04:02 +01:00
## Default log file until config file is loaded
if [ -w /var/log ] ; then
LOG_FILE = " /var/log/ $PROGRAM .log "
2016-04-06 20:40:20 +02:00
elif ( [ " $HOME " != "" ] && [ -w " $HOME " ] ) ; then
LOG_FILE = " $HOME / $PROGRAM .log "
2015-11-19 23:04:02 +01:00
else
LOG_FILE = " ./ $PROGRAM .log "
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
# Default alert attachment filename
2016-11-10 16:25:37 +01:00
ALERT_LOG_FILE = " $RUN_DIR / $PROGRAM . $SCRIPT_PID .last.log "
2015-11-19 23:04:02 +01:00
# Set error exit code if a piped command fails
set -o pipefail
set -o errtrace
function Dummy {
2016-08-06 16:16:19 +02:00
sleep $SLEEP_TIME
2015-11-19 23:04:02 +01:00
}
2016-05-26 11:11:43 +02:00
# Sub function of Logger
2015-11-19 23:04:02 +01:00
function _Logger {
2016-03-31 10:02:42 +02:00
local svalue = " ${ 1 } " # What to log to stdout
2015-11-19 23:04:02 +01:00
local lvalue = " ${ 2 :- $svalue } " # What to log to logfile, defaults to screen value
2016-03-31 10:02:42 +02:00
local evalue = " ${ 3 } " # What to log to stderr
2016-08-06 16:16:19 +02:00
2015-11-19 23:04:02 +01:00
echo -e " $lvalue " >> " $LOG_FILE "
2016-08-26 15:10:30 +02:00
CURRENT_LOG = " $CURRENT_LOG " $'\n' " $lvalue "
2015-11-19 23:04:02 +01:00
2016-11-10 16:25:37 +01:00
if [ $_LOGGER_STDERR = = true ] && [ " $evalue " != "" ] ; then
2016-08-06 16:16:19 +02:00
cat <<< " $evalue " 1>& 2
2016-08-31 11:26:21 +02:00
elif [ " $_SILENT " = = false ] ; then
2015-11-19 23:04:02 +01:00
echo -e " $svalue "
fi
}
2016-08-31 11:26:21 +02:00
# General log function with log levels:
# CRITICAL, ERROR, WARN are colored in stdout, prefixed in stderr
# NOTICE is standard level
# VERBOSE is only sent to stdout / stderr if _VERBOSE=true
# DEBUG & PARANOIA_DEBUG are only sent if _DEBUG=yes
2015-11-19 23:04:02 +01:00
function Logger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
2016-08-31 11:26:21 +02:00
local level = " ${ 2 } " # Log level: PARANOIA_DEBUG, DEBUG, VERBOSE, NOTICE, WARN, ERROR, CRITIAL
2015-11-19 23:04:02 +01:00
2016-08-06 16:16:19 +02:00
if [ " $_LOGGER_PREFIX " = = "time" ] ; then
prefix = " TIME: $SECONDS - "
elif [ " $_LOGGER_PREFIX " = = "date" ] ; then
2015-11-19 23:04:02 +01:00
prefix = " $( date) - "
else
2016-08-06 16:16:19 +02:00
prefix = ""
2015-11-19 23:04:02 +01:00
fi
if [ " $level " = = "CRITICAL" ] ; then
2016-03-31 10:02:42 +02:00
_Logger " $prefix \e[41m $value \e[0m " " $prefix $level : $value " " $level : $value "
2016-08-31 11:26:21 +02:00
ERROR_ALERT = true
2015-11-19 23:04:02 +01:00
return
elif [ " $level " = = "ERROR" ] ; then
2016-03-31 10:02:42 +02:00
_Logger " $prefix \e[91m $value \e[0m " " $prefix $level : $value " " $level : $value "
2016-08-31 11:26:21 +02:00
ERROR_ALERT = true
2015-11-19 23:04:02 +01:00
return
elif [ " $level " = = "WARN" ] ; then
2016-03-31 10:02:42 +02:00
_Logger " $prefix \e[93m $value \e[0m " " $prefix $level : $value " " $level : $value "
2016-08-31 11:26:21 +02:00
WARN_ALERT = true
2015-11-19 23:04:02 +01:00
return
elif [ " $level " = = "NOTICE" ] ; then
_Logger " $prefix $value "
return
2016-08-31 11:26:21 +02:00
elif [ " $level " = = "VERBOSE" ] ; then
if [ $_VERBOSE = = true ] ; then
_Logger " $prefix $value "
fi
return
2015-11-19 23:04:02 +01:00
elif [ " $level " = = "DEBUG" ] ; then
if [ " $_DEBUG " = = "yes" ] ; then
_Logger " $prefix $value "
return
fi
else
2016-08-31 11:26:21 +02:00
_Logger " \e[41mLogger function called without proper loglevel [ $level ].\e[0m "
2016-09-08 22:51:24 +02:00
_Logger " Value was: $prefix $value "
2015-11-19 23:04:02 +01:00
fi
}
2016-05-26 11:11:43 +02:00
# QuickLogger subfunction, can be called directly
function _QuickLogger {
local value = " ${ 1 } "
local destination = " ${ 2 } " # Destination: stdout, log, both
2016-08-06 16:16:19 +02:00
2016-05-26 11:11:43 +02:00
if ( [ " $destination " = = "log" ] || [ " $destination " = = "both" ] ) ; then
echo -e " $( date) - $value " >> " $LOG_FILE "
elif ( [ " $destination " = = "stdout" ] || [ " $destination " = = "both" ] ) ; then
echo -e " $value "
fi
}
# Generic quick logging function
function QuickLogger {
local value = " ${ 1 } "
2016-08-06 16:16:19 +02:00
2016-08-31 11:26:21 +02:00
if [ $_SILENT = = true ] ; then
2016-05-26 11:11:43 +02:00
_QuickLogger " $value " "log"
else
_QuickLogger " $value " "stdout"
fi
}
2015-11-19 23:04:02 +01:00
# Portable child (and grandchild) kill function tester under Linux, BSD and MacOS X
function KillChilds {
2016-08-16 22:40:02 +02:00
local pid = " ${ 1 } " # Parent pid to kill childs
local self = " ${ 2 :- false } " # Should parent be killed too ?
2015-11-19 23:04:02 +01:00
2016-08-06 16:16:19 +02:00
2015-11-19 23:04:02 +01:00
if children = " $( pgrep -P " $pid " ) " ; then
for child in $children ; do
KillChilds " $child " true
done
fi
2016-08-06 16:16:19 +02:00
# Try to kill nicely, if not, wait 15 seconds to let Trap actions happen before killing
if ( [ " $self " = = true ] && kill -0 $pid > /dev/null 2>& 1) ; then
2016-04-12 09:14:44 +02:00
Logger " Sending SIGTERM to process [ $pid ]. " "DEBUG"
2016-08-22 09:11:32 +02:00
kill -s TERM " $pid "
2016-04-10 21:11:59 +02:00
if [ $? != 0 ] ; then
2016-04-12 09:14:44 +02: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
2016-08-06 16:16:19 +02:00
else
return 0
2016-03-31 14:28:18 +02:00
fi
2016-04-12 09:41:16 +02:00
else
return 0
2015-11-19 23:04:02 +01:00
fi
}
2016-08-06 16:16:19 +02:00
function KillAllChilds {
local pids = " ${ 1 } " # List of parent pids to kill separated by semi-colon
2016-08-16 22:54:52 +02:00
local self = " ${ 2 :- false } " # Should parent be killed too ?
2016-08-06 16:16:19 +02:00
local errorcount = 0
IFS = ';' read -a pidsArray <<< " $pids "
for pid in " ${ pidsArray [@] } " ; do
2016-08-16 22:54:52 +02:00
KillChilds $pid $self
2016-08-06 16:16:19 +02:00
if [ $? != 0 ] ; then
errorcount = $(( errorcount+1))
fi
done
return $errorcount
}
2016-05-25 19:55:54 +02:00
# osync/obackup/pmocr script specific mail alert function, use SendEmail function for generic mail sending
2015-11-19 23:04:02 +01:00
function SendAlert {
2016-08-26 15:10:30 +02:00
local runAlert = " ${ 1 :- false } " # Specifies if current message is sent while running or at the end of a run
2015-11-19 23:04:02 +01:00
2016-02-19 22:14:13 +01:00
local mail_no_attachment =
local attachment_command =
2016-03-22 12:38:09 +01:00
local subject =
2016-08-26 15:10:30 +02:00
local body =
2016-02-19 22:14:13 +01:00
2016-05-25 19:55:54 +02:00
# Windows specific settings
local encryption_string =
local auth_string =
2016-03-10 10:26:26 +01:00
if [ " $DESTINATION_MAILS " = = "" ] ; then
return 0
fi
2015-11-19 23:04:02 +01:00
if [ " $_DEBUG " = = "yes" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Debug mode, no warning mail will be sent." "NOTICE"
2015-11-19 23:04:02 +01:00
return 0
fi
# <OSYNC SPECIFIC>
if [ " $_QUICK_SYNC " = = "2" ] ; then
Logger "Current task is a quicksync task. Will not send any alert." "NOTICE"
return 0
fi
# </OSYNC SPECIFIC>
eval " cat \" $LOG_FILE \" $COMPRESSION_PROGRAM > $ALERT_LOG_FILE "
2016-02-16 21:09:57 +01:00
if [ $? != 0 ] ; then
Logger " Cannot create [ $ALERT_LOG_FILE ] " "WARN"
mail_no_attachment = 1
else
mail_no_attachment = 0
fi
2016-08-26 15:10:30 +02:00
body = " $MAIL_ALERT_MSG " $'\n\n' " $CURRENT_LOG "
2016-08-31 11:26:21 +02:00
if [ $ERROR_ALERT = = true ] ; then
2015-11-19 23:04:02 +01:00
subject = " Error alert for $INSTANCE_ID "
2016-08-31 11:26:21 +02:00
elif [ $WARN_ALERT = = true ] ; then
2015-11-19 23:04:02 +01:00
subject = " Warning alert for $INSTANCE_ID "
else
subject = " Alert for $INSTANCE_ID "
fi
2016-08-26 15:10:30 +02:00
if [ $runAlert = = true ] ; then
subject = " Currently runing - $subject "
else
subject = " Fnished run - $subject "
fi
2016-02-19 22:14:13 +01:00
if [ " $mail_no_attachment " -eq 0 ] ; then
2016-02-16 21:09:57 +01:00
attachment_command = " -a $ALERT_LOG_FILE "
fi
2016-11-10 16:25:37 +01:00
if [ " $LOCAL_OS " = = "BUSYBOX" ] ; then
if type sendmail > /dev/null 2>& 1; then
if [ " $ENCRYPTION " = = "tls" ] ; then
echo -e " Subject: $subject \r\n $body " | $( type -p sendmail) -f " $SENDER_MAIL " -H " exec openssl s_client -quiet -tls1_2 -starttls smtp -connect $SMTP_SERVER : $SMTP_PORT " -au" $SMTP_USER " -ap" $SMTP_PASSWORD " $DESTINATION_MAILS
elif [ " $ENCRYPTION " = = "ssl" ] ; then
echo -e " Subject: $subject \r\n $body " | $( type -p sendmail) -f " $SENDER_MAIL " -H " exec openssl s_client -quiet -connect $SMTP_SERVER : $SMTP_PORT " -au" $SMTP_USER " -ap" $SMTP_PASSWORD " $DESTINATION_MAILS
else
echo -e " Subject: $subject \r\n $body " | $( type -p sendmail) -f " $SENDER_MAIL " -S " $SMTP_SERVER : $SMTP_PORT " -au" $SMTP_USER " -ap" $SMTP_PASSWORD " $DESTINATION_MAILS
fi
if [ $? != 0 ] ; then
Logger " Cannot send alert mail via $( type -p sendmail) !!! " "WARN"
# Don't bother try other mail systems with busybox
return 1
else
return 0
fi
else
Logger "Sendmail not present. Won't send any mail" "WARN"
return 1
fi
fi
2015-11-19 23:04:02 +01:00
if type mutt > /dev/null 2>& 1 ; then
2016-08-26 15:10:30 +02:00
echo " $body " | $( type -p mutt) -x -s " $subject " $DESTINATION_MAILS $attachment_command
2015-11-19 23:04:02 +01:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send alert mail via $( type -p mutt) !!! " "WARN"
2015-11-19 23:04:02 +01:00
else
Logger "Sent alert mail using mutt." "NOTICE"
return 0
fi
fi
if type mail > /dev/null 2>& 1 ; then
2016-02-19 22:14:13 +01:00
if [ " $mail_no_attachment " -eq 0 ] && $( type -p mail) -V | grep "GNU" > /dev/null; then
2016-02-16 21:09:57 +01:00
attachment_command = " -A $ALERT_LOG_FILE "
2016-02-19 22:14:13 +01:00
elif [ " $mail_no_attachment " -eq 0 ] && $( type -p mail) -V > /dev/null; then
2016-03-31 11:59:53 +02:00
attachment_command = " -a $ALERT_LOG_FILE "
2016-02-16 21:09:57 +01:00
else
attachment_command = ""
fi
2016-08-26 15:10:30 +02:00
echo " $body " | $( type -p mail) $attachment_command -s " $subject " $DESTINATION_MAILS
2015-11-19 23:04:02 +01:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send alert mail via $( type -p mail) with attachments !!! " "WARN"
2016-08-26 15:10:30 +02:00
echo " $body " | $( type -p mail) -s " $subject " $DESTINATION_MAILS
2015-11-19 23:04:02 +01:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send alert mail via $( type -p mail) without attachments !!! " "WARN"
2015-11-19 23:04:02 +01:00
else
Logger "Sent alert mail using mail command without attachment." "NOTICE"
return 0
fi
else
Logger "Sent alert mail using mail command." "NOTICE"
return 0
fi
fi
if type sendmail > /dev/null 2>& 1 ; then
2016-08-26 15:10:30 +02:00
echo -e " Subject: $subject \r\n $body " | $( type -p sendmail) $DESTINATION_MAILS
2015-11-19 23:04:02 +01:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send alert mail via $( type -p sendmail) !!! " "WARN"
2015-11-19 23:04:02 +01:00
else
Logger "Sent alert mail using sendmail command without attachment." "NOTICE"
return 0
fi
fi
2016-05-25 19:55:54 +02:00
# Windows specific
2016-08-08 15:49:48 +02:00
if type "mailsend.exe" > /dev/null 2>& 1 ; then
2016-05-25 19:55:54 +02:00
if [ " $SMTP_ENCRYPTION " != "tls" ] && [ " $SMTP_ENCRYPTION " != "ssl" ] && [ " $SMTP_ENCRYPTION " != "none" ] ; then
Logger "Bogus smtp encryption, assuming none." "WARN"
encryption_string =
elif [ " $SMTP_ENCRYPTION " = = "tls" ] ; then
encryption_string = -starttls
elif [ " $SMTP_ENCRYPTION " = = "ssl" ] :; then
encryption_string = -ssl
fi
if [ " $SMTP_USER " != "" ] && [ " $SMTP_USER " != "" ] ; then
auth_string = " -auth -user \" $SMTP_USER \" -pass \" $SMTP_PASSWORD \" "
fi
2016-08-26 15:10:30 +02:00
$( type mailsend.exe) -f $SENDER_MAIL -t " $DESTINATION_MAILS " -sub " $subject " -M " $body " -attach " $attachment " -smtp " $SMTP_SERVER " -port " $SMTP_PORT " $encryption_string $auth_string
2016-08-08 15:49:48 +02: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 19:55:54 +02:00
# Windows specific, kept for compatibility (sendemail from http://caspian.dotconf.net/menu/Software/SendEmail/)
2015-11-19 23:04:02 +01:00
if type sendemail > /dev/null 2>& 1 ; then
if [ " $SMTP_USER " != "" ] && [ " $SMTP_PASSWORD " != "" ] ; then
SMTP_OPTIONS = " -xu $SMTP_USER -xp $SMTP_PASSWORD "
else
SMTP_OPTIONS = ""
fi
2016-08-26 15:10:30 +02:00
$( type -p sendemail) -f $SENDER_MAIL -t " $DESTINATION_MAILS " -u " $subject " -m " $body " -s $SMTP_SERVER $SMTP_OPTIONS > /dev/null 2>& 1
2015-11-19 23:04:02 +01:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send alert mail via $( type -p sendemail) !!! " "WARN"
2015-11-19 23:04:02 +01:00
else
Logger "Sent alert mail using sendemail command without attachment." "NOTICE"
return 0
fi
fi
2016-03-22 12:38:09 +01:00
# pfSense specific
if [ -f /usr/local/bin/mail.php ] ; then
2016-08-26 15:10:30 +02:00
echo " $body " | /usr/local/bin/mail.php -s= " $subject "
2016-03-22 12:38:09 +01:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger "Cannot send alert mail via /usr/local/bin/mail.php (pfsense) !!!" "WARN"
2016-03-22 12:38:09 +01:00
else
Logger "Sent alert mail using pfSense mail.php." "NOTICE"
return 0
fi
fi
2016-08-06 16:16:19 +02:00
# If function has not returned 0 yet, assume it is critical that no alert can be sent
2016-05-25 19:55:54 +02:00
Logger "Cannot send alert (neither mutt, mail, sendmail, mailsend, sendemail or pfSense mail.php could be used)." "ERROR" # Is not marked critical because execution must continue
2015-11-19 23:04:02 +01:00
# Delete tmp log file
if [ -f " $ALERT_LOG_FILE " ] ; then
2016-11-10 16:25:37 +01:00
rm -f " $ALERT_LOG_FILE "
2015-11-19 23:04:02 +01:00
fi
}
2016-05-25 19:55:54 +02:00
# Generic email sending function.
# Usage (linux / BSD), attachment is optional, can be "/path/to/my.file" or ""
# SendEmail "subject" "Body text" "receiver@example.com receiver2@otherdomain.com" "/path/to/attachment.file"
# Usage (Windows, make sure you have mailsend.exe in executable path, see http://github.com/muquit/mailsend)
# attachment is optional but must be in windows format like "c:\\some\path\\my.file", or ""
2016-11-10 16:25:37 +01:00
# smtp_server.domain.tld is mandatory, as is smtpPort (should be 25, 465 or 587)
2016-05-25 19:55:54 +02:00
# encryption can be set to tls, ssl or none
2016-11-10 16:25:37 +01:00
# smtpUser and smtpPassword are optional
# SendEmail "subject" "Body text" "receiver@example.com receiver2@otherdomain.com" "/path/to/attachment.file" "senderMail@example.com" "smtpServer.domain.tld" "smtpPort" "encryption" "smtpUser" "smtpPassword"
2016-04-14 18:01:18 +02:00
function SendEmail {
local subject = " ${ 1 } "
local message = " ${ 2 } "
2016-11-10 16:25:37 +01:00
local destinationMails = " ${ 3 } "
2016-05-25 19:55:54 +02:00
local attachment = " ${ 4 } "
2016-11-10 16:25:37 +01:00
local senderMail = " ${ 5 } "
local smtpServer = " ${ 6 } "
local smtpPort = " ${ 7 } "
2016-07-19 10:53:55 +02:00
local encryption = " ${ 8 } "
2016-11-10 16:25:37 +01:00
local smtpUser = " ${ 9 } "
local smtpPassword = " ${ 10 } "
2016-04-14 18:01:18 +02:00
2016-05-25 19:55:54 +02:00
# CheckArguments will report a warning that can be ignored if used in Windows with paranoia debug enabled
2016-04-14 18:01:18 +02:00
local mail_no_attachment =
local attachment_command =
2016-05-25 19:55:54 +02:00
local encryption_string =
local auth_string =
2016-04-14 18:01:18 +02:00
if [ ! -f " $attachment " ] ; then
2016-11-10 16:25:37 +01:00
attachment_command = " -a $attachment "
2016-04-14 18:01:18 +02:00
mail_no_attachment = 1
else
mail_no_attachment = 0
fi
2016-11-10 16:25:37 +01:00
if [ " $LOCAL_OS " = = "BUSYBOX" ] ; then
if type sendmail > /dev/null 2>& 1; then
if [ " $ENCRYPTION " = = "tls" ] ; then
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $SenderMail " -H " exec openssl s_client -quiet -tls1_2 -starttls smtp -connect $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
elif [ " $ENCRYPTION " = = "ssl" ] ; then
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $SenderMail " -H " exec openssl s_client -quiet -connect $smtpServer : $smtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
else
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) -f " $SenderMail " -S " $smtpServer : $SmtpPort " -au" $smtpUser " -ap" $smtpPassword " " $destinationMails "
fi
if [ $? != 0 ] ; then
Logger " Cannot send alert mail via $( type -p sendmail) !!! " "WARN"
# Don't bother try other mail systems with busybox
return 1
else
return 0
fi
else
Logger "Sendmail not present. Won't send any mail" "WARN"
return 1
fi
fi
2016-04-14 18:01:18 +02:00
if type mutt > /dev/null 2>& 1 ; then
2016-11-10 16:25:37 +01:00
echo " $message " | $( type -p mutt) -x -s " $subject " " $destinationMails " $attachment_command
2016-04-14 18:01:18 +02:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p mutt) !!! " "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using mutt." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
if type mail > /dev/null 2>& 1 ; then
if [ " $mail_no_attachment " -eq 0 ] && $( type -p mail) -V | grep "GNU" > /dev/null; then
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-10 16:25:37 +01:00
echo " $message " | $( type -p mail) $attachment_command -s " $subject " " $destinationMails "
2016-04-14 18:01:18 +02:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p mail) with attachments !!! " "WARN"
2016-11-10 16:25:37 +01:00
echo " $message " | $( type -p mail) -s " $subject " " $destinationMails "
2016-04-14 18:01:18 +02:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p mail) without attachments !!! " "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using mail command without attachment." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using mail command." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
if type sendmail > /dev/null 2>& 1 ; then
2016-11-10 16:25:37 +01:00
echo -e " Subject: $subject \r\n $message " | $( type -p sendmail) " $destinationMails "
2016-04-14 18:01:18 +02:00
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger " Cannot send mail via $( type -p sendmail) !!! " "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using sendmail command without attachment." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
2016-05-25 19:55:54 +02:00
# Windows specific
2016-08-08 15:49:48 +02:00
if type "mailsend.exe" > /dev/null 2>& 1 ; then
2016-11-10 16:25:37 +01:00
if [ " $senderMail " = = "" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Missing sender email." "ERROR"
return 1
fi
2016-11-10 16:25:37 +01:00
if [ " $smtpServer " = = "" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Missing smtp port." "ERROR"
return 1
fi
2016-11-10 16:25:37 +01:00
if [ " $smtpPort " = = "" ] ; then
2016-05-25 19:55:54 +02:00
Logger "Missing smtp port, assuming 25." "WARN"
2016-11-10 16:25:37 +01:00
smtpPort = 25
2016-05-25 19:55:54 +02:00
fi
if [ " $encryption " != "tls" ] && [ " $encryption " != "ssl" ] && [ " $encryption " != "none" ] ; then
Logger "Bogus smtp encryption, assuming none." "WARN"
encryption_string =
elif [ " $encryption " = = "tls" ] ; then
encryption_string = -starttls
elif [ " $encryption " = = "ssl" ] :; then
encryption_string = -ssl
fi
2016-11-10 16:25:37 +01:00
if [ " $smtpUser " != "" ] && [ " $smtpPassword " != "" ] ; then
auth_string = " -auth -user \" $smtpUser \" -pass \" $smtpPassword \" "
2016-05-25 19:55:54 +02:00
fi
2016-11-10 16:25:37 +01:00
$( type mailsend.exe) -f " $senderMail " -t " $destinationMails " -sub " $subject " -M " $message " -attach " $attachment " -smtp " $smtpServer " -port " $smtpPort " $encryption_string $auth_string
2016-08-08 15:49:48 +02: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 19:55:54 +02:00
2016-04-14 18:01:18 +02:00
# pfSense specific
if [ -f /usr/local/bin/mail.php ] ; then
echo " $message " | /usr/local/bin/mail.php -s= " $subject "
if [ $? != 0 ] ; then
2016-05-25 19:55:54 +02:00
Logger "Cannot send mail via /usr/local/bin/mail.php (pfsense) !!!" "WARN"
2016-04-14 18:01:18 +02:00
else
2016-05-25 19:55:54 +02:00
Logger "Sent mail using pfSense mail.php." "NOTICE"
2016-04-14 18:01:18 +02:00
return 0
fi
fi
2016-08-06 16:16:19 +02:00
# If function has not returned 0 yet, assume it is critical that no alert can be sent
2016-05-25 19:55:54 +02:00
Logger "Cannot send mail (neither mutt, mail, sendmail, sendemail, mailsend (windows) or pfSense mail.php could be used)." "ERROR" # Is not marked critical because execution must continue
2016-04-14 18:01:18 +02:00
}
2016-03-04 09:34:02 +01:00
function TrapError {
local job = " $0 "
local line = " $1 "
local code = " ${ 2 :- 1 } "
2016-11-10 16:25:37 +01:00
2016-08-31 11:26:21 +02:00
if [ $_SILENT = = false ] ; then
2016-03-04 09:34:02 +01:00
echo -e " /!\ ERROR in ${ job } : Near line ${ line } , exit code ${ code } "
fi
}
2016-03-18 19:20:28 +01:00
function LoadConfigFile {
2016-09-08 22:51:24 +02:00
local configFile = " ${ 1 } "
2016-03-18 19:20:28 +01:00
2016-11-10 16:25:37 +01:00
2016-09-08 22:51:24 +02:00
if [ ! -f " $configFile " ] ; then
Logger " Cannot load configuration file [ $configFile ]. Cannot start. " "CRITICAL"
2016-03-18 19:20:28 +01:00
exit 1
2016-09-08 22:51:24 +02:00
elif [ [ " $configFile " != *".conf" ] ] ; then
Logger " Wrong configuration file supplied [ $configFile ]. Cannot start. " "CRITICAL"
2016-03-18 19:20:28 +01:00
exit 1
else
2016-09-08 22:51:24 +02:00
# Remove everything that is not a variable assignation
grep '^[^ ]*=[^;&]*' " $configFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID "
2016-03-18 19:20:28 +01:00
source " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID "
fi
2016-09-08 22:51:24 +02:00
CONFIG_FILE = " $configFile "
2016-03-18 19:20:28 +01:00
}
2016-03-04 09:34:02 +01:00
function Spinner {
2016-08-31 11:26:21 +02:00
if [ $_SILENT = = true ] ; then
2016-03-04 09:34:02 +01:00
return 0
fi
case $toggle
in
1)
echo -n " \ "
echo -ne "\r"
toggle = "2"
; ;
2)
echo -n " | "
echo -ne "\r"
toggle = "3"
; ;
3)
echo -n " / "
echo -ne "\r"
toggle = "4"
; ;
*)
echo -n " - "
echo -ne "\r"
toggle = "1"
; ;
esac
}
2016-08-08 15:49:48 +02: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-08-15 10:29:13 +02:00
# Time control function for background processes, suitable for multiple synchronous processes
# Fills a global variable called WAIT_FOR_TASK_COMPLETION that contains list of failed pids in format pid1:result1;pid2:result2
# Warning: Don't imbricate this function into another run if you plan to use the global variable output
2016-08-31 11:26:21 +02:00
2016-08-06 16:16:19 +02:00
function WaitForTaskCompletion {
local pids = " ${ 1 } " # pids to wait for, separated by semi-colon
2016-11-10 16:25:37 +01:00
local softMaxTime = " ${ 2 } " # If program with pid $pid takes longer than $softMaxTime seconds, will log a warning, unless $softMaxTime equals 0.
local hardMaxTime = " ${ 3 } " # If program with pid $pid takes longer than $hardMaxTime seconds, will stop execution, unless $hardMaxTime equals 0.
local callerName = " ${ 4 } " # Who called this function
2016-08-18 22:16:15 +02:00
local counting = " ${ 5 :- true } " # Count time since function has been launched if true, since script has been launched if false
2016-11-10 16:25:37 +01:00
local keepLogging = " ${ 6 :- 0 } " # Log a standby message every X seconds. Set to zero to disable logging
2016-08-06 16:16:19 +02:00
2016-08-31 11:26:21 +02:00
local soft_alert = false # Does a soft alert need to be triggered, if yes, send an alert once
2016-08-06 16:16:19 +02:00
local log_ttime = 0 # local time instance for comparaison
local seconds_begin = $SECONDS # Seconds since the beginning of the script
local exec_time = 0 # Seconds since the beginning of this function
local retval = 0 # return value of monitored pid process
local errorcount = 0 # Number of pids that finished with errors
2016-08-31 11:26:21 +02:00
local pid # Current pid working on
2016-08-06 16:16:19 +02:00
local pidCount # number of given pids
2016-08-15 10:29:13 +02:00
local pidState # State of the process
2016-08-06 16:16:19 +02:00
2016-08-31 11:26:21 +02:00
local pidsArray # Array of currently running pids
local newPidsArray # New array of currently running pids
2016-08-06 16:16:19 +02:00
IFS = ';' read -a pidsArray <<< " $pids "
pidCount = ${# pidsArray [@] }
2016-08-15 10:29:13 +02:00
WAIT_FOR_TASK_COMPLETION = ""
2016-08-06 16:16:19 +02:00
while [ ${# pidsArray [@] } -gt 0 ] ; do
newPidsArray = ( )
Spinner
2016-08-07 23:47:21 +02:00
if [ $counting = = true ] ; then
exec_time = $(( $SECONDS - $seconds_begin ))
else
exec_time = $SECONDS
fi
2016-11-10 16:25:37 +01:00
if [ $keepLogging -ne 0 ] ; then
if [ $(( ( $exec_time + 1 ) % $keepLogging )) -eq 0 ] ; then
2016-08-16 20:39:49 +02:00
if [ $log_ttime -ne $exec_time ] ; then # Fix when sleep time lower than 1s
log_ttime = $exec_time
Logger " Current tasks still running with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "NOTICE"
fi
2016-08-06 16:16:19 +02:00
fi
fi
2016-11-10 16:25:37 +01:00
if [ $exec_time -gt $softMaxTime ] ; then
if [ $soft_alert = = true ] && [ $softMaxTime -ne 0 ] ; then
Logger " Max soft execution time exceeded for task [ $callerName ] with pids [ $( joinString , ${ pidsArray [@] } ) ]. " "WARN"
2016-08-31 11:26:21 +02:00
soft_alert = true
2016-08-26 15:10:30 +02:00
SendAlert true
2016-08-06 16:16:19 +02:00
fi
2016-11-10 16:25:37 +01:00
if [ $exec_time -gt $hardMaxTime ] && [ $hardMaxTime -ne 0 ] ; then
Logger " Max hard execution time exceeded for task [ $callerName ] with pids [ $( joinString , ${ pidsArray [@] } ) ]. Stopping task execution. " "ERROR"
2016-08-16 20:39:49 +02:00
for pid in " ${ pidsArray [@] } " ; do
2016-08-16 22:40:02 +02:00
KillChilds $pid true
2016-08-16 20:39:49 +02:00
if [ $? = = 0 ] ; then
Logger " Task with pid [ $pid ] stopped successfully. " "NOTICE"
else
Logger " Could not stop task with pid [ $pid ]. " "ERROR"
fi
done
2016-08-26 15:10:30 +02:00
SendAlert true
2016-08-06 16:16:19 +02:00
fi
fi
2016-08-22 09:11:32 +02:00
for pid in " ${ pidsArray [@] } " ; do
2016-09-08 22:51:24 +02:00
if [ $( IsInteger $pid ) -eq 1 ] ; then
2016-08-31 11:26:21 +02:00
if kill -0 $pid > /dev/null 2>& 1; then
# Handle uninterruptible sleep state or zombies by ommiting them from running process array (How to kill that is already dead ? :)
2016-11-10 16:25:37 +01:00
#TODO(high): have this tested on *BSD, Mac, Win & busybox.
#TODO(high): propagate changes to ParallelExec
#pidState=$(ps -p$pid -o state= 2 > /dev/null)
pidState = " $( eval $PROCESS_STATE_CMD ) "
2016-08-31 11:26:21 +02:00
if [ " $pidState " != "D" ] && [ " $pidState " != "Z" ] ; then
newPidsArray += ( $pid )
fi
else
# pid is dead, get it's exit code from wait command
wait $pid
retval = $?
if [ $retval -ne 0 ] ; then
errorcount = $(( errorcount+1))
2016-11-10 16:25:37 +01:00
Logger " ${ FUNCNAME [0] } called by [ $callerName ] finished monitoring [ $pid ] with exitcode [ $retval ]. " "DEBUG"
2016-08-31 11:26:21 +02:00
if [ " $WAIT_FOR_TASK_COMPLETION " = = "" ] ; then
WAIT_FOR_TASK_COMPLETION = " $pid : $retval "
else
WAIT_FOR_TASK_COMPLETION = " ; $pid : $retval "
fi
2016-08-22 09:11:32 +02:00
fi
fi
fi
done
2016-08-31 11:26:21 +02:00
2016-08-06 16:16:19 +02:00
pidsArray = ( " ${ newPidsArray [@] } " )
2016-08-31 11:26:21 +02:00
# Trivial wait time for bash to not eat up all CPU
2016-08-06 16:16:19 +02:00
sleep $SLEEP_TIME
done
2016-08-22 09:11:32 +02:00
# Return exit code if only one process was monitored, else return number of errors
if [ $pidCount -eq 1 ] && [ $errorcount -eq 0 ] ; then
return $errorcount
else
return $errorcount
fi
2016-08-06 16:16:19 +02:00
}
2016-08-31 11:26:21 +02:00
# Take a list of commands to run, runs them sequentially with numberOfProcesses commands simultaneously runs
# Returns the number of non zero exit codes from commands
2016-09-08 22:51:24 +02:00
# Use cmd1;cmd2;cmd3 syntax for small sets, use file for large command sets
2016-08-31 11:26:21 +02:00
function ParallelExec {
local numberOfProcesses = " ${ 1 } " # Number of simultaneous commands to run
2016-09-08 22:51:24 +02:00
local commandsArg = " ${ 2 } " # Semi-colon separated list of commands, or file containing one command per line
local readFromFile = " ${ 3 :- false } " # Is commandsArg a file or a string ?
2016-11-10 16:25:37 +01:00
local softMaxTime = " ${ 4 :- 0 } "
local hardMaxTime = " ${ 5 :- 0 } "
local callerName = " ${ 6 } " # Who called this function
local counting = " ${ 7 :- true } " # Count time since function has been launched if true, since script has been launched if false
local keepLogging = " ${ 8 :- 0 } " # Log a standby message every X seconds. Set to zero to disable logging
2016-08-31 11:26:21 +02:00
2016-09-08 22:51:24 +02:00
local commandCount
local command
2016-08-31 11:26:21 +02:00
local pid
local counter = 0
local commandsArray
local pidsArray
local newPidsArray
local retval
2016-09-08 22:51:24 +02:00
local errorCount = 0
2016-08-31 11:26:21 +02:00
local pidState
local commandsArrayPid
2016-09-08 22:51:24 +02:00
if [ $readFromFile = = true ] ; then
if [ -f " $commandsArg " ] ; then
commandCount = $( wc -l < " $commandsArg " )
else
commandCount = 0
fi
else
IFS = ';' read -r -a commandsArray <<< " $commandsArg "
commandCount = ${# commandsArray [@] }
fi
2016-08-31 11:26:21 +02:00
2016-09-08 22:51:24 +02:00
Logger " Runnning $commandCount commands in $numberOfProcesses simultaneous processes. " "DEBUG"
2016-08-31 11:26:21 +02:00
2016-09-08 22:51:24 +02:00
while [ $counter -lt " $commandCount " ] || [ ${# pidsArray [@] } -gt 0 ] ; do
2016-08-31 11:26:21 +02:00
2016-09-08 22:51:24 +02:00
while [ $counter -lt " $commandCount " ] && [ ${# pidsArray [@] } -lt $numberOfProcesses ] ; do
if [ $readFromFile = = true ] ; then
#TODO: Checked on FreeBSD 10, also check on Win
command = $( awk 'NR == num_line {print; exit}' num_line = $(( counter+1)) " $commandsArg " )
else
command = " ${ commandsArray [ $counter ] } "
fi
Logger " Running command [ $command ]. " "DEBUG"
2016-11-10 16:25:37 +01:00
eval " $command " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " 2>& 1 &
2016-08-31 11:26:21 +02:00
pid = $!
pidsArray += ( $pid )
2016-09-08 22:51:24 +02:00
commandsArrayPid[ $pid ] = " $command "
2016-08-31 11:26:21 +02:00
counter = $(( counter+1))
done
newPidsArray = ( )
for pid in " ${ pidsArray [@] } " ; do
2016-09-08 22:51:24 +02:00
if [ $( IsInteger $pid ) -eq 1 ] ; then
2016-08-31 11:26:21 +02:00
# Handle uninterruptible sleep state or zombies by ommiting them from running process array (How to kill that is already dead ? :)
if kill -0 $pid > /dev/null 2>& 1; then
2016-11-10 16:25:37 +01:00
#pidState=$(ps -p$pid -o state= 2 > /dev/null)
pidState = " $( eval $PROCESS_STATE_CMD ) "
2016-08-31 11:26:21 +02:00
if [ " $pidState " != "D" ] && [ " $pidState " != "Z" ] ; then
newPidsArray += ( $pid )
fi
else
# pid is dead, get it's exit code from wait command
wait $pid
retval = $?
if [ $retval -ne 0 ] ; then
Logger " Command [ ${ commandsArrayPid [ $pid ] } ] failed with exit code [ $retval ]. " "ERROR"
2016-09-08 22:51:24 +02:00
errorCount = $(( errorCount+1))
2016-08-31 11:26:21 +02:00
fi
fi
fi
done
pidsArray = ( " ${ newPidsArray [@] } " )
# Trivial wait time for bash to not eat up all CPU
sleep $SLEEP_TIME
done
2016-09-08 22:51:24 +02:00
return $errorCount
2016-08-31 11:26:21 +02:00
}
2016-08-07 23:47:21 +02:00
function CleanUp {
2016-08-06 16:16:19 +02:00
2016-08-07 23:47:21 +02:00
if [ " $_DEBUG " != "yes" ] ; then
rm -f " $RUN_DIR / $PROGRAM . " *" . $SCRIPT_PID "
# Fix for sed -i requiring backup extension for BSD & Mac (see all sed -i statements)
rm -f " $RUN_DIR / $PROGRAM . " *" . $SCRIPT_PID .tmp "
fi
2016-08-06 16:16:19 +02:00
}
2016-04-14 18:01:18 +02:00
# obsolete, use StripQuotes
2016-03-04 09:34:02 +01:00
function SedStripQuotes {
2016-08-08 15:49:48 +02:00
echo $( echo $1 | sed "s/^\([\"']\)\(.*\)\1\$/\2/g" )
2016-03-04 09:34:02 +01:00
}
2016-04-14 18:01:18 +02:00
# Usage: var=$(StripSingleQuotes "$var")
2016-03-04 09:34:02 +01:00
function StripSingleQuotes {
local string = " ${ 1 } "
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
string = " ${ string /# \' / } " # Remove singlequote if it begins string
string = " ${ string /% \' / } " # Remove singlequote if it ends string
echo " $string "
}
2016-04-14 18:01:18 +02:00
# Usage: var=$(StripDoubleQuotes "$var")
2016-03-04 09:34:02 +01:00
function StripDoubleQuotes {
local string = " ${ 1 } "
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
string = " ${ string /# \" / } "
string = " ${ string /% \" / } "
echo " $string "
}
function StripQuotes {
local string = " ${ 1 } "
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
echo " $( StripSingleQuotes $( StripDoubleQuotes $string ) ) "
}
2016-09-08 22:51:24 +02:00
# Usage var=$(EscapeSpaces "$var") or var="$(EscapeSpaces "$var")"
2016-03-04 09:34:02 +01:00
function EscapeSpaces {
local string = " ${ 1 } " # String on which spaces will be escaped
2016-11-10 16:25:37 +01:00
2016-09-08 22:51:24 +02:00
echo " ${ string // / \\ } "
2016-03-04 09:34:02 +01:00
}
2016-09-08 22:51:24 +02:00
function IsNumericExpand {
2016-08-18 11:53:18 +02:00
eval " local value=\" ${ 1 } \" " # Needed eval so variable variables can be processed
2016-03-04 09:34:02 +01:00
local re = " ^-?[0-9]+([.][0-9]+)? $"
2016-11-10 16:25:37 +01:00
2016-03-04 09:34:02 +01:00
if [ [ $value = ~ $re ] ] ; then
2016-11-10 16:25:37 +01:00
echo 1 && return 1
2016-03-04 09:34:02 +01:00
else
2016-11-10 16:25:37 +01:00
echo 0 && return 0
2016-03-04 09:34:02 +01:00
fi
}
2016-11-10 16:25:37 +01:00
# Usage [ $(IsNumeric $var) -eq 1 ]
2016-09-08 22:51:24 +02:00
function IsNumeric {
local value = " ${ 1 } "
if [ [ $value = ~ ^[ 0-9] +( [ .] [ 0-9] +) ?$ ] ] ; then
2016-11-10 16:25:37 +01:00
echo 1 && return 1
2016-09-08 22:51:24 +02:00
else
2016-11-10 16:25:37 +01:00
echo 0 && return 0
2016-09-08 22:51:24 +02:00
fi
}
function IsInteger {
local value = " ${ 1 } "
if [ [ $value = ~ ^[ 0-9] +$ ] ] ; then
2016-11-10 16:25:37 +01:00
echo 1 && return 1
else
echo 0 && return 0
fi
}
# Converts human readable sizes into integer kilobyte sizes
# Usage numericSize="$(HumanToNumeric $humanSize)"
function HumanToNumeric {
local value = " ${ 1 } "
local notation
local suffix
local suffixPresent
local multiplier
notation = ( K M G T P E)
for suffix in " ${ notation [@] } " ; do
multiplier = $(( multiplier+1))
if [ [ " $value " = = *" $suffix " * ] ] ; then
suffixPresent = $suffix
break;
fi
done
if [ " $suffixPresent " != "" ] ; then
value = ${ value % $suffix * }
value = ${ value %.* }
# /1024 since we convert to kilobytes instead of bytes
value = $(( value*( 1024 * * multiplier/1024)) )
2016-09-08 22:51:24 +02:00
else
2016-11-10 16:25:37 +01:00
value = ${ value %.* }
2016-09-08 22:51:24 +02:00
fi
2016-11-10 16:25:37 +01:00
echo $value
2016-09-08 22:51:24 +02:00
}
2016-05-26 22:34:08 +02:00
## from https://gist.github.com/cdown/1163649
function urlEncode {
local length = " ${# 1 } "
local LANG = C
for ( ( i = 0; i < length; i++ ) ) ; do
local c = " ${ 1 : i : 1 } "
case $c in
[ a-zA-Z0-9.~_-] )
printf " $c "
; ;
*)
printf '%%%02X' " ' $c "
; ;
esac
done
}
function urlDecode {
2016-11-10 16:25:37 +01:00
local urlEncoded = " ${ 1 //+/ } "
printf '%b' " ${ urlEncoded //%/ \\ x } "
}
## Modified version of http://stackoverflow.com/a/8574392
## Usage: arrayContains "needle" "${haystack[@]}"
arrayContains ( ) {
local e
if [ " $2 " = = "" ] ; then
echo 0 && return 0
fi
2016-05-26 22:34:08 +02:00
2016-11-10 16:25:37 +01:00
for e in " ${ @ : 2 } " ; do
[ [ " $e " = = " $1 " ] ] && echo 1 && return 1
done
echo 0 && return 0
2016-05-26 22:34:08 +02:00
}
2015-11-19 23:04:02 +01:00
function GetLocalOS {
2016-11-10 16:25:37 +01:00
local localOsVar
2016-02-19 22:14:13 +01:00
2016-11-10 16:25:37 +01:00
# There's no good way to tell if currently running in BusyBox shell. Using sluggish way.
ls --help 2>& 1 | grep -i BusyBox > /dev/null
if [ $? = = 0 ] ; then
localOsVar = "BusyBox"
else
localOsVar = " $( uname -spio 2>& 1) "
2015-11-19 23:04:02 +01:00
if [ $? != 0 ] ; then
2016-11-10 16:25:37 +01:00
localOsVar = " $( uname -v 2>& 1) "
if [ $? != 0 ] ; then
localOsVar = " $( uname) "
fi
2015-11-19 23:04:02 +01:00
fi
fi
2016-11-10 16:25:37 +01:00
case $localOsVar in
2015-11-19 23:04:02 +01:00
*"Linux" *)
LOCAL_OS = "Linux"
; ;
*"BSD" *)
LOCAL_OS = "BSD"
; ;
2016-03-20 16:49:29 +01:00
*"MINGW32" *| *"CYGWIN" *)
2015-11-19 23:04:02 +01:00
LOCAL_OS = "msys"
; ;
*"Darwin" *)
LOCAL_OS = "MacOSX"
; ;
2016-11-10 16:25:37 +01:00
*"BusyBox" *)
LOCAL_OS = "BUSYBOX"
; ;
2015-11-19 23:04:02 +01:00
*)
2016-11-10 16:25:37 +01:00
if [ " $IGNORE_OS_TYPE " = = "yes" ] ; then #TODO(doc): Undocumented option
Logger " Running on unknown local OS [ $localOsVar ]. " "WARN"
2016-03-20 16:49:29 +01:00
return
fi
2016-11-10 16:25:37 +01:00
Logger " Running on >> $localOsVar << not supported. Please report to the author. " "ERROR"
2015-11-19 23:04:02 +01:00
exit 1
; ;
esac
2016-11-10 16:25:37 +01:00
Logger " Local OS: [ $localOsVar ]. " "DEBUG"
2015-11-19 23:04:02 +01:00
}
2016-11-10 16:25:37 +01:00
#### MINIMAL-FUNCTION-SET END ####
2015-11-19 23:04:02 +01:00
2016-11-10 16:25:37 +01:00
function GetRemoteOS {
2016-02-19 22:14:13 +01:00
2016-11-10 16:25:37 +01:00
local retval
local cmd
local remoteOsVar
2016-02-19 22:14:13 +01:00
2015-11-19 23:04:02 +01:00
if [ " $REMOTE_OPERATION " = = "yes" ] ; then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-11-10 16:25:37 +01:00
cmd = $SSH_CMD ' "ls --help 2>&1 | grep -i BusyBox > /dev/null"'
2015-11-19 23:04:02 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-11-10 16:25:37 +01:00
WaitForTaskCompletion $! 120 240 ${ FUNCNAME [0] } "-0" true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
2016-11-10 16:25:37 +01:00
if [ $retval = = 0 ] ; then
remoteOsVar = "BusyBox"
else
cmd = $SSH_CMD ' "uname -spio" > "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID '" 2>&1'
2015-11-19 23:04:02 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-11-10 16:25:37 +01:00
WaitForTaskCompletion $! 120 240 ${ FUNCNAME [0] } "-1" true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
if [ $retval != 0 ] ; then
2016-11-10 16:25:37 +01:00
cmd = $SSH_CMD ' "uname -v" > "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID '" 2>&1'
2015-11-19 23:04:02 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-11-10 16:25:37 +01:00
WaitForTaskCompletion $! 120 240 ${ FUNCNAME [0] } "-2" true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
if [ $retval != 0 ] ; then
2016-11-10 16:25:37 +01:00
cmd = $SSH_CMD ' "uname" > "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID '" 2>&1'
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
WaitForTaskCompletion $! 120 240 ${ FUNCNAME [0] } "-3" true $KEEP_LOGGING
retval = $?
if [ $retval != 0 ] ; then
Logger "Cannot Get remote OS type." "ERROR"
fi
2015-11-19 23:04:02 +01:00
fi
fi
2016-11-10 16:25:37 +01:00
remoteOsVar = $( cat " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " )
2015-11-19 23:04:02 +01:00
fi
2016-11-10 16:25:37 +01:00
case $remoteOsVar in
2015-11-19 23:04:02 +01:00
*"Linux" *)
REMOTE_OS = "Linux"
; ;
*"BSD" *)
REMOTE_OS = "BSD"
; ;
2016-03-20 16:49:29 +01:00
*"MINGW32" *| *"CYGWIN" *)
2015-11-19 23:04:02 +01:00
REMOTE_OS = "msys"
; ;
*"Darwin" *)
REMOTE_OS = "MacOSX"
; ;
2016-11-10 16:25:37 +01:00
*"BusyBox" *)
REMOTE_OS = "BUSYBOX"
; ;
2015-11-19 23:04:02 +01:00
*"ssh" *| *"SSH" *)
Logger "Cannot connect to remote system." "CRITICAL"
exit 1
; ;
*)
2016-03-31 10:02:42 +02:00
if [ " $IGNORE_OS_TYPE " = = "yes" ] ; then #DOC: Undocumented option
2016-11-10 16:25:37 +01:00
Logger " Running on unknown remote OS [ $remoteOsVar ]. " "WARN"
2016-03-20 16:49:29 +01:00
return
fi
2015-11-19 23:04:02 +01:00
Logger "Running on remote OS failed. Please report to the author if the OS is not supported." "CRITICAL"
2016-11-10 16:25:37 +01:00
Logger " Remote OS said:\n $remoteOsVar " "CRITICAL"
2015-11-19 23:04:02 +01:00
exit 1
esac
2016-11-10 16:25:37 +01:00
Logger " Remote OS: [ $remoteOsVar ]. " "DEBUG"
2015-11-19 23:04:02 +01:00
fi
}
function RunLocalCommand {
local command = " ${ 1 } " # Command to run
2016-11-10 16:25:37 +01:00
local hardMaxTime = " ${ 2 } " # Max time to wait for command to compleet
2015-11-19 23:04:02 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = true ] ; then
2015-11-19 23:04:02 +01:00
Logger " Dryrun: Local command [ $command ] not run. " "NOTICE"
return 0
fi
Logger " Running command [ $command ] on local host. " "NOTICE"
2016-02-19 22:14:13 +01:00
eval " $command " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " 2>& 1 &
2016-11-10 16:25:37 +01:00
WaitForTaskCompletion $! 0 $hardMaxTime ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
if [ $retval -eq 0 ] ; then
Logger "Command succeded." "NOTICE"
else
Logger "Command failed." "ERROR"
fi
2016-08-31 11:26:21 +02:00
if [ $_VERBOSE = = true ] || [ $retval -ne 0 ] ; then
2016-02-19 22:14:13 +01:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "NOTICE"
2015-11-19 23:04:02 +01: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-11-10 16:25:37 +01:00
local hardMaxTime = " ${ 2 } " # Max time to wait for command to compleet
2015-11-19 23:04:02 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = true ] ; then
2015-11-19 23:04:02 +01:00
Logger " Dryrun: Local command [ $command ] not run. " "NOTICE"
return 0
fi
Logger " Running command [ $command ] on remote host. " "NOTICE"
2016-02-19 22:14:13 +01:00
cmd = $SSH_CMD ' "$command" > "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID '" 2>&1'
2015-11-19 23:04:02 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-11-10 16:25:37 +01:00
WaitForTaskCompletion $! 0 $hardMaxTime ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
retval = $?
if [ $retval -eq 0 ] ; then
Logger "Command succeded." "NOTICE"
else
Logger "Command failed." "ERROR"
fi
2016-08-31 11:26:21 +02:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] && ( [ $_VERBOSE = = true ] || [ $retval -ne 0 ] )
2015-11-19 23:04:02 +01:00
then
2016-02-19 22:14:13 +01:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "NOTICE"
2015-11-19 23:04:02 +01: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-11-10 16:25:37 +01:00
local pids
2016-08-06 16:16:19 +02:00
2015-11-19 23:04:02 +01:00
if [ " $LOCAL_RUN_BEFORE_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunLocalCommand " $LOCAL_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE &
pids = " $! "
2015-11-19 23:04:02 +01:00
fi
if [ " $REMOTE_RUN_BEFORE_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunRemoteCommand " $REMOTE_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE &
pids = " $pids ; $! "
fi
if [ " $pids " != "" ] ; then
2016-08-22 09:11:32 +02:00
WaitForTaskCompletion $pids 0 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
fi
}
function RunAfterHook {
2016-08-06 16:16:19 +02:00
local pids
2015-11-19 23:04:02 +01:00
if [ " $LOCAL_RUN_AFTER_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunLocalCommand " $LOCAL_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER &
pids = " $! "
2015-11-19 23:04:02 +01:00
fi
if [ " $REMOTE_RUN_AFTER_CMD " != "" ] ; then
2016-08-06 16:16:19 +02:00
RunRemoteCommand " $REMOTE_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER &
pids = " $pids ; $! "
fi
if [ " $pids " != "" ] ; then
2016-08-22 09:11:32 +02:00
WaitForTaskCompletion $pids 0 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-19 23:04:02 +01:00
fi
}
function CheckConnectivityRemoteHost {
2016-09-08 22:51:24 +02:00
local retval
2015-11-19 23:04:02 +01:00
if [ " $_PARANOIA_DEBUG " != "yes" ] ; then # Do not loose time in paranoia debug
if [ " $REMOTE_HOST_PING " != "no" ] && [ " $REMOTE_OPERATION " != "no" ] ; then
eval " $PING_CMD $REMOTE_HOST > /dev/null 2>&1 " &
2016-08-26 15:10:30 +02:00
WaitForTaskCompletion $! 60 180 ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-09-08 22:51:24 +02:00
retval = $?
if [ $retval != 0 ] ; then
2016-11-10 16:25:37 +01:00
Logger " Cannot ping [ $REMOTE_HOST ]. Return code [ $retval ]. " "WARN"
2016-09-08 22:51:24 +02:00
return $retval
2015-11-19 23:04:02 +01:00
fi
fi
fi
}
function CheckConnectivity3rdPartyHosts {
2016-11-10 16:25:37 +01:00
local remote3rdPartySuccess
2016-09-08 22:51:24 +02:00
local retval
2016-08-08 15:49:48 +02:00
2015-11-19 23:04:02 +01:00
if [ " $_PARANOIA_DEBUG " != "yes" ] ; then # Do not loose time in paranoia debug
if [ " $REMOTE_3RD_PARTY_HOSTS " != "" ] ; then
2016-11-10 16:25:37 +01:00
remote3rdPartySuccess = false
2015-11-19 23:04:02 +01:00
for i in $REMOTE_3RD_PARTY_HOSTS
do
eval " $PING_CMD $i > /dev/null 2>&1 " &
2016-08-22 09:11:32 +02:00
WaitForTaskCompletion $! 180 360 ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-09-08 22:51:24 +02:00
retval = $?
if [ $retval != 0 ] ; then
Logger " Cannot ping 3rd party host [ $i ]. Return code [ $retval ]. " "NOTICE"
2015-11-19 23:04:02 +01:00
else
2016-11-10 16:25:37 +01:00
remote3rdPartySuccess = true
2015-11-19 23:04:02 +01:00
fi
done
2016-08-08 15:49:48 +02:00
2016-11-10 16:25:37 +01:00
if [ $remote3rdPartySuccess = = false ] ; then
Logger "No remote 3rd party host responded to ping. No internet ?" "WARN"
2015-11-19 23:04:02 +01:00
return 1
2016-08-08 15:49:48 +02:00
else
return 0
2015-11-19 23:04:02 +01:00
fi
fi
fi
}
#__BEGIN_WITH_PARANOIA_DEBUG
#__END_WITH_PARANOIA_DEBUG
2016-03-01 19:35:40 +01:00
function RsyncPatternsAdd {
2016-11-10 16:25:37 +01:00
local patternType = " ${ 1 } " # exclude or include
2016-04-01 21:22:18 +02:00
local pattern = " ${ 2 } "
2016-03-01 19:35:40 +01:00
2016-08-08 15:49:48 +02:00
local rest
2016-03-01 19:35:40 +01:00
# Disable globbing so wildcards from exclusions do not get expanded
set -f
rest = " $pattern "
while [ -n " $rest " ]
do
# Take the string until first occurence until $PATH_SEPARATOR_CHAR
2016-11-10 16:25:37 +01:00
str = ${ rest %%;* } #TODO: replace ; with $PATH_SEPARATOR_CHAR
2016-03-01 19:35:40 +01:00
# Handle the last case
if [ " $rest " = " ${ rest / $PATH_SEPARATOR_CHAR / } " ] ; then
rest =
else
# Cut everything before the first occurence of $PATH_SEPARATOR_CHAR
rest = ${ rest #* $PATH_SEPARATOR_CHAR }
fi
if [ " $RSYNC_PATTERNS " = = "" ] ; then
2016-11-10 16:25:37 +01:00
RSYNC_PATTERNS = "--" $patternType " =\" $str \" "
2016-03-01 19:35:40 +01:00
else
2016-11-10 16:25:37 +01:00
RSYNC_PATTERNS = " $RSYNC_PATTERNS -- " $patternType " =\" $str \" "
2016-03-01 19:35:40 +01:00
fi
done
set +f
}
function RsyncPatternsFromAdd {
2016-11-10 16:25:37 +01:00
local patternType = " ${ 1 } "
local patternFrom = " ${ 2 } "
2016-03-01 19:35:40 +01:00
2016-08-08 15:49:48 +02:00
## Check if the exclude list has a full path, and if not, add the config file path if there is one
2016-11-10 16:25:37 +01:00
if [ " $( basename $patternFrom ) " = = " $patternFrom " ] ; then
patternFrom = " $( dirname $CONFIG_FILE ) / $patternFrom "
2016-08-08 15:49:48 +02:00
fi
2016-03-01 19:35:40 +01:00
2016-11-10 16:25:37 +01:00
if [ -e " $patternFrom " ] ; then
RSYNC_PATTERNS = " $RSYNC_PATTERNS -- " $patternType " -from=\" $patternFrom \" "
2016-08-08 15:49:48 +02:00
fi
2016-03-01 19:35:40 +01:00
}
function RsyncPatterns {
2016-08-08 15:49:48 +02:00
if [ " $RSYNC_PATTERN_FIRST " = = "exclude" ] ; then
if [ " $RSYNC_EXCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd "exclude" " $RSYNC_EXCLUDE_PATTERN "
fi
if [ " $RSYNC_EXCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "exclude" " $RSYNC_EXCLUDE_FROM "
fi
if [ " $RSYNC_INCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd " $RSYNC_INCLUDE_PATTERN " "include"
fi
if [ " $RSYNC_INCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "include" " $RSYNC_INCLUDE_FROM "
fi
2016-11-10 16:25:37 +01:00
# Use default include first for quicksync runs
elif [ " $RSYNC_PATTERN_FIRST " = = "include" ] || [ " $_QUICK_SYNC " = = "2" ] ; then
2016-08-08 15:49:48 +02:00
if [ " $RSYNC_INCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd "include" " $RSYNC_INCLUDE_PATTERN "
fi
if [ " $RSYNC_INCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "include" " $RSYNC_INCLUDE_FROM "
fi
if [ " $RSYNC_EXCLUDE_PATTERN " != "" ] ; then
RsyncPatternsAdd "exclude" " $RSYNC_EXCLUDE_PATTERN "
fi
if [ " $RSYNC_EXCLUDE_FROM " != "" ] ; then
RsyncPatternsFromAdd "exclude" " $RSYNC_EXCLUDE_FROM "
fi
else
Logger "Bogus RSYNC_PATTERN_FIRST value in config file. Will not use rsync patterns." "WARN"
fi
2016-03-01 19:35:40 +01:00
}
2015-11-19 23:04:02 +01:00
function PreInit {
2016-11-10 16:25:37 +01:00
local compressionString
2015-11-19 23:04:02 +01:00
## SSH compression
2016-08-08 15:49:48 +02:00
if [ " $SSH_COMPRESSION " != "no" ] ; then
SSH_COMP = -C
else
SSH_COMP =
fi
2015-11-19 23:04:02 +01:00
2016-03-25 20:07:27 +01:00
## Ignore SSH known host verification
if [ " $SSH_IGNORE_KNOWN_HOSTS " = = "yes" ] ; then
SSH_OPTS = "-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
fi
2016-08-08 15:49:48 +02:00
## Support for older config files without RSYNC_EXECUTABLE option
if [ " $RSYNC_EXECUTABLE " = = "" ] ; then
RSYNC_EXECUTABLE = rsync
fi
## Sudo execution option
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
COMMAND_SUDO = "sudo"
else
if [ " $RSYNC_REMOTE_PATH " != "" ] ; then
RSYNC_PATH = " $RSYNC_REMOTE_PATH / $RSYNC_EXECUTABLE "
else
RSYNC_PATH = " $RSYNC_EXECUTABLE "
fi
COMMAND_SUDO = ""
fi
2015-11-19 23:04:02 +01:00
## Set rsync default arguments
2016-08-08 15:49:48 +02:00
RSYNC_ARGS = "-rltD"
2016-08-31 11:26:21 +02:00
if [ " $_DRYRUN " = = true ] ; then
2016-02-19 22:14:13 +01:00
RSYNC_DRY_ARG = "-n"
2016-08-08 15:49:48 +02:00
DRY_WARNING = "/!\ DRY RUN"
2016-02-19 22:14:13 +01:00
else
RSYNC_DRY_ARG = ""
fi
2015-11-19 23:04:02 +01:00
2016-08-15 10:29:13 +02:00
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
2016-08-08 15:49:48 +02:00
if [ " $PRESERVE_ACL " = = "yes" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -A"
fi
if [ " $PRESERVE_XATTR " = = "yes" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -X"
fi
if [ " $RSYNC_COMPRESS " = = "yes" ] ; then
RSYNC_ARGS = $RSYNC_ARGS " -z"
fi
if [ " $COPY_SYMLINKS " = = "yes" ] ; then
RSYNC_ARGS = $RSYNC_ARGS " -L"
fi
if [ " $KEEP_DIRLINKS " = = "yes" ] ; then
RSYNC_ARGS = $RSYNC_ARGS " -K"
fi
if [ " $PRESERVE_HARDLINKS " = = "yes" ] ; then
RSYNC_ARGS = $RSYNC_ARGS " -H"
fi
if [ " $CHECKSUM " = = "yes" ] ; then
RSYNC_TYPE_ARGS = $RSYNC_TYPE_ARGS " --checksum"
fi
if [ " $BANDWIDTH " != "" ] && [ " $BANDWIDTH " != "0" ] ; then
RSYNC_ARGS = $RSYNC_ARGS " --bwlimit= $BANDWIDTH "
fi
if [ " $PARTIAL " = = "yes" ] ; then
RSYNC_ARGS = $RSYNC_ARGS " --partial --partial-dir=\" $PARTIAL_DIR \" "
RSYNC_PARTIAL_EXCLUDE = " --exclude=\" $PARTIAL_DIR \" "
fi
2016-02-16 21:09:57 +01:00
if [ " $DELTA_COPIES " != "no" ] ; then
2016-08-08 15:49:48 +02:00
RSYNC_ARGS = $RSYNC_ARGS " --no-whole-file"
else
RSYNC_ARGS = $RSYNC_ARGS " --whole-file"
fi
2016-02-16 21:09:57 +01:00
2015-11-19 23:04:02 +01:00
## Set compression executable and extension
2016-11-10 16:25:37 +01:00
if [ " $( IsInteger $COMPRESSION_LEVEL ) " -eq 0 ] ; then
COMPRESSION_LEVEL = 3
fi
## Busybox fix (Termux xz command doesn't support compression at all)
if [ " $LOCAL_OS " = = "BUSYBOX" ] || [ " $REMOTE_OS " = = "BUSYBOX" ] ; 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
2016-08-08 15:49:48 +02:00
else
2016-11-10 16:25:37 +01:00
compressionString = " - $COMPRESSION_LEVEL "
if type xz > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | xz -c $compressionString "
COMPRESSION_EXTENSION = .xz
elif type lzma > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | lzma -c $compressionString "
COMPRESSION_EXTENSION = .lzma
elif type pigz > /dev/null 2>& 1
then
COMPRESSION_PROGRAM = " | pigz -c $compressionString "
COMPRESSION_EXTENSION = .gz
# obackup specific
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
2016-08-08 15:49:48 +02:00
fi
ALERT_LOG_FILE = " $ALERT_LOG_FILE $COMPRESSION_EXTENSION "
2015-11-19 23:04:02 +01:00
}
function PostInit {
# Define remote commands
2016-11-10 16:25:37 +01:00
if [ -f " $SSH_RSA_PRIVATE_KEY " ] ; then
SSH_CMD = " $( type -p ssh) $SSH_COMP -i $SSH_RSA_PRIVATE_KEY $SSH_OPTS $REMOTE_USER @ $REMOTE_HOST -p $REMOTE_PORT "
SCP_CMD = " $( type -p scp) $SSH_COMP -i $SSH_RSA_PRIVATE_KEY -P $REMOTE_PORT "
RSYNC_SSH_CMD = " $( type -p ssh) $SSH_COMP -i $SSH_RSA_PRIVATE_KEY $SSH_OPTS -p $REMOTE_PORT "
elif [ -f " $SSH_PASSWORD_FILE " ] ; then
SSH_CMD = " $( type -p sshpass) -f $SSH_PASSWORD_FILE $( type -p ssh) $SSH_COMP $SSH_OPTS $REMOTE_USER @ $REMOTE_HOST -p $REMOTE_PORT "
SCP_CMD = " $( type -p sshpass) -f $SSH_PASSWORD_FILE $( type -p scp) $SSH_COMP -P $REMOTE_PORT "
RSYNC_SSH_CMD = " $( type -p sshpass) -f $SSH_PASSWORD_FILE $( type -p ssh) $SSH_COMP $SSH_OPTS -p $REMOTE_PORT "
else
SSH_PASSWORD = ""
SSH_CMD = ""
SCP_CMD = ""
RSYNC_SSH_CMD = ""
fi
2015-11-19 23:04:02 +01:00
}
function InitLocalOSSettings {
2016-08-08 15:49:48 +02:00
## If running under Msys, some commands do not run the same way
## Using mingw version of find instead of windows one
## Getting running processes is quite different
## Ping command is not the same
if [ " $LOCAL_OS " = = "msys" ] ; then
FIND_CMD = $( dirname $BASH ) /find
PING_CMD = '$SYSTEMROOT\system32\ping -n 2'
else
FIND_CMD = find
PING_CMD = "ping -c 2 -i .2"
fi
2016-11-10 16:25:37 +01:00
if [ " $LOCAL_OS " = = "BUSYBOX" ] ; then
PROCESS_STATE_CMD = "echo none"
else
PROCESS_STATE_CMD = 'ps -p$pid -o state= 2 > /dev/null'
fi
2016-08-08 15:49:48 +02:00
## Stat command has different syntax on Linux and FreeBSD/MacOSX
if [ " $LOCAL_OS " = = "MacOSX" ] || [ " $LOCAL_OS " = = "BSD" ] ; then
2016-11-10 16:25:37 +01:00
# Tested on BSD and Mac
2016-08-08 15:49:48 +02:00
STAT_CMD = "stat -f \"%Sm\""
2016-04-06 20:40:20 +02:00
STAT_CTIME_MTIME_CMD = "stat -f %N;%c;%m"
2016-08-08 15:49:48 +02:00
else
2016-11-10 16:25:37 +01:00
# Tested on GNU stat and busybox
STAT_CMD = "stat -c %y"
2016-04-06 20:40:20 +02:00
STAT_CTIME_MTIME_CMD = "stat -c %n;%Z;%Y"
2016-08-08 15:49:48 +02:00
fi
2015-11-19 23:04:02 +01:00
}
function InitRemoteOSSettings {
2016-08-08 15:49:48 +02:00
## MacOSX does not use the -E parameter like Linux or BSD does (-E is mapped to extended attrs instead of preserve executability)
2016-08-15 10:29:13 +02:00
if [ " $PRESERVE_EXECUTABILITY " != "no" ] ; then
if [ " $LOCAL_OS " != "MacOSX" ] && [ " $REMOTE_OS " != "MacOSX" ] ; then
RSYNC_ATTR_ARGS = $RSYNC_ATTR_ARGS " -E"
fi
2016-08-08 15:49:48 +02:00
fi
2015-11-19 23:04:02 +01:00
2016-08-08 15:49:48 +02:00
if [ " $REMOTE_OS " = = "msys" ] ; then
REMOTE_FIND_CMD = $( dirname $BASH ) /find
else
REMOTE_FIND_CMD = find
fi
2016-04-06 20:40:20 +02:00
2016-08-08 15:49:48 +02:00
## Stat command has different syntax on Linux and FreeBSD/MacOSX
if [ " $LOCAL_OS " = = "MacOSX" ] || [ " $LOCAL_OS " = = "BSD" ] ; then
REMOTE_STAT_CMD = "stat -f \"%Sm\""
2016-04-06 20:40:20 +02:00
REMOTE_STAT_CTIME_MTIME_CMD = "stat -f \\\"%N;%c;%m\\\""
2016-08-08 15:49:48 +02:00
else
REMOTE_STAT_CMD = "stat --format %y"
2016-04-06 20:40:20 +02:00
REMOTE_STAT_CTIME_MTIME_CMD = "stat -c \\\"%n;%Z;%Y\\\""
2016-08-08 15:49:48 +02:00
fi
2016-04-06 20:40:20 +02:00
2015-11-19 23:04:02 +01:00
}
2016-08-18 14:23:57 +02:00
## IFS debug function
function PrintIFS {
printf "IFS is: %q" " $IFS "
}
2016-11-10 16:25:37 +01:00
# Process debugging
# Recursive function to get all parents from a pid
function ParentPid {
local pid = " ${ 1 } " # Pid to analyse
local parent
parent = $( ps -p $pid -o ppid = )
echo " $pid is a child of $parent "
if [ $parent -gt 0 ] ; then
ParentPid $parent
fi
}
2015-11-19 23:04:02 +01:00
## END Generic functions
2015-11-12 01:26:38 +01:00
2016-08-06 14:04:35 +02:00
_LOGGER_PREFIX = "time"
2015-11-12 01:26:38 +01:00
## Working directory for partial downloads
PARTIAL_DIR = ".obackup_workdir_partial"
2016-09-08 22:51:24 +02:00
## File extension for encrypted files
CRYPT_FILE_EXTENSION = ".obackup.gpg"
2015-11-12 01:26:38 +01:00
# List of runtime created global variables
# $SQL_DISK_SPACE, disk space available on target for sql backups
# $FILE_DISK_SPACE, disk space available on target for file backups
# $SQL_BACKUP_TASKS, list of all databases to backup, space separated
# $SQL_EXCLUDED_TASKS, list of all database to exclude from backup, space separated
# $FILE_BACKUP_TASKS list of directories to backup, found in config file
# $FILE_RECURSIVE_BACKUP_TASKS, list of directories to backup, computed from config file recursive list
# $FILE_RECURSIVE_EXCLUDED_TASKS, list of all directories excluded from recursive list
2016-08-18 11:53:18 +02:00
# $FILE_SIZE_LIST_LOCAL, list of all directories to include in GetDirectoriesSize, enclosed by escaped doublequotes for local command
2016-08-18 14:23:57 +02:00
# $FILE_SIZE_LIST_REMOTE, list of all directories to include in GetDirectoriesSize, enclosed by escaped singlequotes for remote command
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = true
CAN_BACKUP_FILES = true
2015-11-12 01:26:38 +01:00
function TrapStop {
2016-03-03 16:33:59 +01:00
Logger "/!\ Manual exit of backup script. Backups may be in inconsistent state." "WARN"
2016-08-17 10:01:55 +02:00
exit 2
2015-11-12 01:26:38 +01:00
}
function TrapQuit {
2016-02-19 22:14:13 +01:00
local exitcode
2016-08-31 11:26:21 +02:00
if [ $ERROR_ALERT = = true ] ; then
2016-04-06 20:47:04 +02:00
if [ " $RUN_AFTER_CMD_ON_ERROR " = = "yes" ] ; then
RunAfterHook
fi
2015-11-12 01:26:38 +01:00
CleanUp
2016-09-08 22:51:24 +02:00
Logger " $PROGRAM finished with errors. " "ERROR"
2016-08-26 15:10:30 +02:00
SendAlert
2016-02-19 22:14:13 +01:00
exitcode = 1
2016-08-31 11:26:21 +02:00
elif [ $WARN_ALERT = = true ] ; then
2016-04-06 20:47:04 +02:00
if [ " $RUN_AFTER_CMD_ON_ERROR " = = "yes" ] ; then
RunAfterHook
fi
2015-11-12 01:26:38 +01:00
CleanUp
2016-09-08 22:51:24 +02:00
Logger " $PROGRAM finished with warnings. " "WARN"
2016-08-26 15:10:30 +02:00
SendAlert
2016-02-19 22:14:13 +01:00
exitcode = 2
2013-07-16 23:10:27 +02:00
else
2016-08-22 09:11:32 +02:00
RunAfterHook
2015-11-12 01:26:38 +01:00
CleanUp
2016-09-08 22:51:24 +02:00
Logger " $PROGRAM finshed without errors. " "NOTICE"
2016-02-19 22:14:13 +01:00
exitcode = 0
2013-07-16 23:10:27 +02:00
fi
2013-09-22 12:04:09 +02:00
2016-03-03 16:06:27 +01:00
if [ -f " $RUN_DIR / $PROGRAM . $INSTANCE_ID " ] ; then
rm -f " $RUN_DIR / $PROGRAM . $INSTANCE_ID "
fi
2015-11-12 01:26:38 +01:00
KillChilds $$ > /dev/null 2>& 1
2016-02-19 22:14:13 +01:00
exit $exitcode
2015-11-12 01:26:38 +01:00
}
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
function CheckEnvironment {
if [ " $REMOTE_OPERATION " = = "yes" ] ; then
if ! type ssh > /dev/null 2>& 1 ; then
Logger "ssh not present. Cannot start backup." "CRITICAL"
exit 1
fi
if [ " $SQL_BACKUP " != "no" ] ; then
if ! type mysqldump > /dev/null 2>& 1 ; then
Logger "mysqldump not present. Cannot backup SQL." "CRITICAL"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
fi
if ! type mysql > /dev/null 2>& 1 ; then
Logger "mysql not present. Cannot backup SQL." "CRITICAL"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
fi
fi
2016-11-10 16:25:37 +01:00
if [ " $SSH_PASSWORD_FILE " != "" ] && ! type sshpass > /dev/null 2>& 1 ; then
Logger "sshpass not present. Cannot use password authentication." "CRITICAL"
exit 1
fi
2015-11-12 01:26:38 +01:00
fi
if [ " $FILE_BACKUP " != "no" ] ; then
2016-09-08 22:51:24 +02:00
if ! type rsync > /dev/null 2>& 1 ; then
Logger "rsync not present. Cannot backup files." "CRITICAL"
CAN_BACKUP_FILES = false
fi
fi
if [ " $ENCRYPTION " = = "yes" ] ; then
CheckCryptEnvironnment
fi
}
function CheckCryptEnvironnment {
if ! type gpg2 > /dev/null 2>& 1 ; then
if ! type gpg > /dev/null 2>& 1; then
2016-09-09 08:31:29 +02:00
Logger "Programs gpg2 nor gpg not present. Cannot encrypt backup files." "CRITICAL"
2016-09-08 22:51:24 +02:00
CAN_BACKUP_FILES = false
2013-07-16 23:10:27 +02:00
else
2016-09-09 08:31:29 +02:00
Logger "Program gpg2 not present, falling back to gpg." "NOTICE"
2016-09-08 22:51:24 +02:00
CRYPT_TOOL = gpg
2013-07-16 23:10:27 +02:00
fi
2016-09-08 22:51:24 +02:00
else
CRYPT_TOOL = gpg2
2015-11-12 01:26:38 +01:00
fi
}
function CheckCurrentConfig {
if [ " $INSTANCE_ID " = = "" ] ; then
Logger "No INSTANCE_ID defined in config file." "CRITICAL"
exit 1
fi
# Check all variables that should contain "yes" or "no"
2016-08-18 22:16:15 +02:00
declare -a yes_no_vars = ( SQL_BACKUP FILE_BACKUP ENCRYPTION CREATE_DIRS KEEP_ABSOLUTE_PATHS GET_BACKUP_SIZE SSH_COMPRESSION SSH_IGNORE_KNOWN_HOSTS REMOTE_HOST_PING SUDO_EXEC DATABASES_ALL PRESERVE_PERMISSIONS PRESERVE_OWNER PRESERVE_GROUP PRESERVE_EXECUTABILITY PRESERVE_ACL PRESERVE_XATTR COPY_SYMLINKS KEEP_DIRLINKS PRESERVE_HARDLINKS RSYNC_COMPRESS PARTIAL DELETE_VANISHED_FILES DELTA_COPIES ROTATE_SQL_BACKUPS ROTATE_FILE_BACKUPS STOP_ON_CMD_ERROR RUN_AFTER_CMD_ON_ERROR)
2016-02-19 22:14:13 +01:00
for i in " ${ yes_no_vars [@] } " ; do
2016-11-10 16:25:37 +01:00
test = " if [ \"\$ $i \" != \"yes\" ] && [ \"\$ $i \" != \"no\" ]; then Logger \"Bogus $i value [ $$ i] defined in config file. Correct your config file or update it with the update script if using and old version.\" \"CRITICAL\"; exit 1; fi "
2015-11-12 01:26:38 +01:00
eval " $test "
2013-09-22 12:04:09 +02:00
done
2013-11-02 18:55:17 +01:00
2015-11-12 01:26:38 +01:00
if [ " $BACKUP_TYPE " != "local" ] && [ " $BACKUP_TYPE " != "pull" ] && [ " $BACKUP_TYPE " != "push" ] ; then
Logger "Bogus BACKUP_TYPE value in config file." "CRITICAL"
exit 1
2013-11-02 18:55:17 +01:00
fi
2015-11-12 01:26:38 +01:00
# Check all variables that should contain a numerical value >= 0
2016-08-17 10:01:55 +02:00
declare -a num_vars = ( BACKUP_SIZE_MINIMUM SQL_WARN_MIN_SPACE FILE_WARN_MIN_SPACE SOFT_MAX_EXEC_TIME_DB_TASK HARD_MAX_EXEC_TIME_DB_TASK COMPRESSION_LEVEL SOFT_MAX_EXEC_TIME_FILE_TASK HARD_MAX_EXEC_TIME_FILE_TASK BANDWIDTH SOFT_MAX_EXEC_TIME_TOTAL HARD_MAX_EXEC_TIME_TOTAL ROTATE_SQL_COPIES ROTATE_FILE_COPIES KEEP_LOGGING MAX_EXEC_TIME_PER_CMD_BEFORE MAX_EXEC_TIME_PER_CMD_AFTER)
2016-02-19 22:14:13 +01:00
for i in " ${ num_vars [@] } " ; do
2016-11-10 16:25:37 +01:00
test = " if [ $( IsNumericExpand \" \$ $i \" ) -eq 0 ]; then Logger \"Bogus $i value [ $$ i] defined in config file. Correct your config file or update it with the update script if using and old version.\" \"CRITICAL\"; exit 1; fi "
2015-11-12 01:26:38 +01:00
eval " $test "
done
2015-11-21 13:22:14 +01:00
if [ " $FILE_BACKUP " = = "yes" ] ; then
if [ " $DIRECTORY_LIST " = = "" ] && [ " $RECURSIVE_DIRECTORY_LIST " = = "" ] ; then
Logger "No directories specified in config file, no files to backup." "ERROR"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_FILES = false
2015-11-21 13:22:14 +01:00
fi
fi
2016-08-31 11:26:21 +02:00
#TODO-v2.1(ongoing WIP): Add runtime variable tests (RSYNC_ARGS etc)
2016-08-26 15:10:30 +02:00
if [ " $REMOTE_OPERATION " = = "yes" ] && [ ! -f " $SSH_RSA_PRIVATE_KEY " ] ; then
Logger " Cannot find rsa private key [ $SSH_RSA_PRIVATE_KEY ]. Cannot connect to remote system. " "CRITICAL"
exit 1
fi
2016-09-08 22:51:24 +02:00
#WIP: Encryption use key file instead of recipient ?
#if [ ! -f "$ENCRYPT_GPG_PYUBKEY" ]; then
# Logger "Cannot find gpg pubkey [$ENCRYPT_GPG_PUBKEY]. Cannot encrypt backup files." "CRITICAL"
# exit 1
#fi
if [ " $SQL_BACKUP " = = "yes" ] && [ " $SQL_STORAGE " = = "" ] ; then
Logger "SQL_STORAGE not defined." "CRITICAL"
exit 1
fi
if [ " $FILE_BACKUP " = = "yes" ] && [ " $FILE_STORAGE " = = "" ] ; then
Logger "FILE_STORAGE not defined." "CRITICAL"
exit 1
fi
2016-09-09 08:31:29 +02:00
if [ " $ENCRYPTION " = = "yes" ] ; then
if [ " $CRYPT_STORAGE " = = "" ] ; then
Logger "CRYPT_STORAGE not defined." "CRITICAL"
exit 1
fi
if [ " $GPG_RECIPIENT " = = "" ] ; then
Logger "No GPG recipient defined." "CRITICAL"
exit 1
fi
2016-08-26 15:10:30 +02:00
fi
2016-09-08 22:51:24 +02:00
2016-11-10 16:25:37 +01:00
if [ " $REMOTE_OPERATION " = = "yes" ] && ( [ ! -f " $SSH_RSA_PRIVATE_KEY " ] && [ ! -f " $SSH_PASSWORD_FILE " ] ) ; then
Logger " Cannot find rsa private key [ $SSH_RSA_PRIVATE_KEY ] nor password file [ $SSH_PASSWORD_FILE ]. No authentication method provided. " "CRITICAL"
exit 1
fi
2013-07-16 23:10:27 +02:00
}
2016-03-03 16:06:27 +01:00
function CheckRunningInstances {
if [ -f " $RUN_DIR / $PROGRAM . $INSTANCE_ID " ] ; then
pid = $( cat " $RUN_DIR / $PROGRAM . $INSTANCE_ID " )
if ps aux | awk '{print $2}' | grep $pid > /dev/null; then
Logger " Another instance [ $INSTANCE_ID ] of obackup is already running. " "CRITICAL"
exit 1
fi
fi
echo $SCRIPT_PID > " $RUN_DIR / $PROGRAM . $INSTANCE_ID "
}
2015-11-12 01:26:38 +01:00
function _ListDatabasesLocal {
2016-09-08 22:51:24 +02:00
local sqlCmd =
2016-02-19 22:14:13 +01:00
2016-09-08 22:51:24 +02:00
sqlCmd = " mysql -u $SQL_USER -Bse 'SELECT table_schema, round(sum( data_length + index_length ) / 1024) FROM information_schema.TABLES GROUP by table_schema;' > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID 2>&1 "
Logger " cmd: $sqlCmd " "DEBUG"
eval " $sqlCmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? -eq 0 ] ; then
Logger "Listing databases succeeded." "NOTICE"
else
Logger "Listing databases failed." "ERROR"
2016-02-19 22:14:13 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] ; then
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
return 1
fi
}
function _ListDatabasesRemote {
2016-09-08 22:51:24 +02:00
local sqlCmd =
2016-02-19 22:14:13 +01:00
2013-07-16 23:10:27 +02:00
CheckConnectivity3rdPartyHosts
2015-11-12 01:26:38 +01:00
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
sqlCmd = " $SSH_CMD \"mysql -u $SQL_USER -Bse 'SELECT table_schema, round(sum( data_length + index_length ) / 1024) FROM information_schema.TABLES GROUP by table_schema;'\" > \" $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID \" 2>&1 "
Logger " cmd: $sqlCmd " "DEBUG"
eval " $sqlCmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? -eq 0 ] ; then
Logger "Listing databases succeeded." "NOTICE"
else
Logger "Listing databases failed." "ERROR"
2016-02-19 22:14:13 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] ; then
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
return 1
fi
}
function ListDatabases {
2016-08-08 19:00:52 +02:00
local outputFile # Return of subfunction
local dbName
local dbSize
local dbBackup
local dbArray
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $CAN_BACKUP_SQL = = false ] ; then
2015-11-12 01:26:38 +01:00
Logger "Cannot list databases." "ERROR"
return 1
fi
Logger "Listing databases." "NOTICE"
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ; then
_ListDatabasesLocal
if [ $? != 0 ] ; then
2016-08-08 19:00:52 +02:00
outputFile = ""
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
outputFile = " $RUN_DIR / $PROGRAM ._ListDatabasesLocal. $SCRIPT_PID "
2015-11-12 01:26:38 +01:00
fi
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
_ListDatabasesRemote
if [ $? != 0 ] ; then
2016-08-08 19:00:52 +02:00
outputFile = ""
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
outputFile = " $RUN_DIR / $PROGRAM ._ListDatabasesRemote. $SCRIPT_PID "
2013-07-16 23:10:27 +02:00
fi
fi
2013-11-02 18:55:17 +01:00
2016-08-31 11:26:21 +02:00
if [ -f " $outputFile " ] && [ $CAN_BACKUP_SQL = = true ] ; then
2016-08-08 19:00:52 +02:00
while read -r line; do
while read -r name size; do dbName = $name ; dbSize = $size ; done <<< " $line "
2015-11-12 01:26:38 +01:00
if [ " $DATABASES_ALL " = = "yes" ] ; then
2016-08-08 19:00:52 +02:00
dbBackup = 1
2016-08-18 11:53:18 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a dbArray <<< " $DATABASES_ALL_EXCLUDE_LIST "
2016-08-08 19:00:52 +02:00
for j in " ${ dbArray [@] } " ; do
if [ " $dbName " = = " $j " ] ; then
dbBackup = 0
2015-11-12 01:26:38 +01:00
fi
done
else
2016-08-08 19:00:52 +02:00
dbBackup = 0
2016-08-18 11:53:18 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a dbArray <<< " $DATABASES_LIST "
2016-08-08 19:00:52 +02:00
for j in " ${ dbArray [@] } " ; do
if [ " $dbName " = = " $j " ] ; then
dbBackup = 1
2015-11-12 01:26:38 +01:00
fi
done
fi
2016-08-08 19:00:52 +02:00
if [ $dbBackup -eq 1 ] ; then
2015-11-12 01:26:38 +01:00
if [ " $SQL_BACKUP_TASKS " != "" ] ; then
2016-08-08 19:00:52 +02:00
SQL_BACKUP_TASKS = " $SQL_BACKUP_TASKS $dbName "
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
SQL_BACKUP_TASKS = " $dbName "
2015-11-12 01:26:38 +01:00
fi
2016-08-08 19:00:52 +02:00
TOTAL_DATABASES_SIZE = $(( TOTAL_DATABASES_SIZE+$dbSize ))
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
SQL_EXCLUDED_TASKS = " $SQL_EXCLUDED_TASKS $dbName "
2015-11-12 01:26:38 +01:00
fi
2016-08-08 19:00:52 +02:00
done < " $outputFile "
2015-11-12 01:26:38 +01:00
Logger " Database backup list: $SQL_BACKUP_TASKS " "DEBUG"
Logger " Database exclude list: $SQL_EXCLUDED_TASKS " "DEBUG"
2014-11-27 14:40:30 +01:00
else
2015-11-12 01:26:38 +01:00
Logger "Will not execute database backup." "ERROR"
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2014-11-27 14:40:30 +01:00
fi
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _ListRecursiveBackupDirectoriesLocal {
2016-02-19 22:14:13 +01:00
local cmd
2016-08-06 14:04:35 +02:00
local directories
local directory
local retval
2016-02-19 22:14:13 +01:00
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a directories <<< " $RECURSIVE_DIRECTORY_LIST "
2016-08-06 14:04:35 +02:00
for directory in " ${ directories [@] } " ; do
2015-11-18 10:52:43 +01:00
# No sudo here, assuming you should have all necessary rights for local checks
2016-02-19 22:14:13 +01:00
cmd = " $FIND_CMD -L $directory / -mindepth 1 -maxdepth 1 -type d >> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID "
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
Logger " Could not enumerate directories in [ $directory ]. " "ERROR"
2016-02-19 22:14:13 +01:00
if [ -f $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ] ; then
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2016-02-19 22:14:13 +01:00
if [ -f $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
retval = 1
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
retval = 0
2013-07-16 23:10:27 +02:00
fi
done
2015-11-12 01:26:38 +01:00
return $retval
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _ListRecursiveBackupDirectoriesRemote {
2016-02-19 22:14:13 +01:00
local cmd
2016-08-06 14:04:35 +02:00
local directories
local directory
local retval
2016-02-19 22:14:13 +01:00
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a directories <<< " $RECURSIVE_DIRECTORY_LIST "
2016-08-06 14:04:35 +02:00
for directory in " ${ directories [@] } " ; do
2016-08-31 11:26:21 +02:00
#TODO(med): Uses local home directory for remote lookup...
2016-03-18 19:20:28 +01:00
cmd = $SSH_CMD ' "' $COMMAND_SUDO ' ' $REMOTE_FIND_CMD ' -L ' $directory '/ -mindepth 1 -maxdepth 1 -type d" >> ' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ' 2> ' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
Logger " Could not enumerate directories in [ $directory ]. " "ERROR"
2016-02-19 22:14:13 +01:00
if [ -f $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ] ; then
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2016-02-19 22:14:13 +01:00
if [ -f $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
retval = 1
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
retval = 0
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
done
return $retval
}
function ListRecursiveBackupDirectories {
2016-02-19 22:14:13 +01:00
local output_file
local file_exclude
2016-08-31 11:26:21 +02:00
local excluded
2016-08-08 19:00:52 +02:00
local fileArray
2015-11-12 01:26:38 +01:00
Logger "Listing directories to backup." "NOTICE"
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ; then
_ListRecursiveBackupDirectoriesLocal
if [ $? != 0 ] ; then
output_file = ""
else
output_file = " $RUN_DIR / $PROGRAM ._ListRecursiveBackupDirectoriesLocal. $SCRIPT_PID "
fi
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
_ListRecursiveBackupDirectoriesRemote
if [ $? != 0 ] ; then
output_file = ""
else
output_file = " $RUN_DIR / $PROGRAM ._ListRecursiveBackupDirectoriesRemote. $SCRIPT_PID "
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
fi
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
if [ -f " $output_file " ] ; then
2016-08-08 19:00:52 +02:00
while read -r line; do
2013-07-16 23:10:27 +02:00
file_exclude = 0
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a fileArray <<< " $RECURSIVE_EXCLUDE_LIST "
2016-08-31 11:26:21 +02:00
for excluded in " ${ fileArray [@] } " ; do
if [ " $excluded " = = " $line " ] ; then
2013-07-16 23:10:27 +02:00
file_exclude = 1
fi
done
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
if [ $file_exclude -eq 0 ] ; then
if [ " $FILE_RECURSIVE_BACKUP_TASKS " = = "" ] ; then
2016-08-18 11:53:18 +02:00
FILE_SIZE_LIST_LOCAL = " \" $line \" "
FILE_SIZE_LIST_REMOTE = " \' $line \' "
2015-11-12 01:26:38 +01:00
FILE_RECURSIVE_BACKUP_TASKS = " $line "
2013-07-16 23:10:27 +02:00
else
2016-08-18 11:53:18 +02:00
FILE_SIZE_LIST_LOCAL = " $FILE_SIZE_LIST_LOCAL \" $line \" "
FILE_SIZE_LIST_REMOTE = " $FILE_SIZE_LIST_REMOTE \' $line \' "
2015-11-12 01:26:38 +01:00
FILE_RECURSIVE_BACKUP_TASKS = " $FILE_RECURSIVE_BACKUP_TASKS $PATH_SEPARATOR_CHAR $line "
2013-07-16 23:10:27 +02:00
fi
else
2015-11-12 01:26:38 +01:00
FILE_RECURSIVE_EXCLUDED_TASKS = " $FILE_RECURSIVE_EXCLUDED_TASKS $PATH_SEPARATOR_CHAR $line "
2013-07-16 23:10:27 +02:00
fi
2016-08-08 19:00:52 +02:00
done < " $output_file "
2015-11-12 01:26:38 +01:00
fi
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a fileArray <<< " $DIRECTORY_LIST "
for directory in " ${ fileArray [@] } " ; do
2016-08-18 11:53:18 +02:00
if [ " $FILE_SIZE_LIST_LOCAL " = = "" ] ; then
FILE_SIZE_LIST_LOCAL = " \" $directory \" "
FILE_SIZE_LIST_REMOTE = " \' $directory \' "
else
FILE_SIZE_LIST_LOCAL = " $FILE_SIZE_LIST_LOCAL \" $directory \" "
FILE_SIZE_LIST_REMOTE = " $FILE_SIZE_LIST_REMOTE \' $directory \' "
fi
2015-11-12 01:26:38 +01:00
if [ " $FILE_BACKUP_TASKS " = = "" ] ; then
FILE_BACKUP_TASKS = " $directory "
else
FILE_BACKUP_TASKS = " $FILE_BACKUP_TASKS $PATH_SEPARATOR_CHAR $directory "
fi
done
}
function _GetDirectoriesSizeLocal {
local dir_list = " ${ 1 } "
2016-02-19 22:14:13 +01:00
local cmd
2015-11-18 10:52:43 +01:00
# No sudo here, assuming you should have all the necessary rights
2016-08-18 11:53:18 +02:00
# This is not pretty, but works with all supported systems
cmd = " du -cs $dir_list | tail -n1 | cut -f1 > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID "
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
# $cmd will return 0 even if some errors found, so we need to check if there is an error output
2016-02-19 22:14:13 +01:00
if [ $? != 0 ] || [ -s $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ] ; then
2015-11-12 01:26:38 +01:00
Logger "Could not get files size for some or all directories." "ERROR"
2016-02-19 22:14:13 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] ; then
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2016-02-19 22:14:13 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID " ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
else
Logger "File size fetched successfully." "NOTICE"
fi
2016-02-19 22:14:13 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] ; then
TOTAL_FILES_SIZE = " $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) "
2016-11-10 16:25:37 +01:00
if [ $( IsInteger $TOTAL_FILES_SIZE ) -eq 0 ] ; then
TOTAL_FILES_SIZE = " $( HumanToNumeric $TOTAL_FILES_SIZE ) "
fi
2015-11-12 01:26:38 +01:00
else
TOTAL_FILES_SIZE = -1
fi
}
function _GetDirectoriesSizeRemote {
local dir_list = " ${ 1 } "
2016-02-19 22:14:13 +01:00
local cmd
2015-11-12 01:26:38 +01:00
# Error output is different from stdout because not all files in list may fail at once
2016-08-18 11:53:18 +02:00
cmd = $SSH_CMD ' ' $COMMAND_SUDO ' du -cs ' $dir_list ' | tail -n1 | cut -f1 > ' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ' 2> ' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
# $cmd will return 0 even if some errors found, so we need to check if there is an error output
2016-02-19 22:14:13 +01:00
if [ $? != 0 ] || [ -s $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ] ; then
2015-11-12 01:26:38 +01:00
Logger "Could not get files size for some or all directories." "ERROR"
2016-02-19 22:14:13 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] ; then
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2016-02-19 22:14:13 +01:00
if [ -f " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID " ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
else
Logger "File size fetched successfully." "NOTICE"
fi
2016-02-19 22:14:13 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " ] ; then
TOTAL_FILES_SIZE = " $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) "
2016-11-10 16:25:37 +01:00
if [ $( IsInteger $TOTAL_FILES_SIZE ) -eq 0 ] ; then
TOTAL_FILES_SIZE = " $( HumanToNumeric $TOTAL_FILES_SIZE ) "
fi
2015-11-12 01:26:38 +01:00
else
TOTAL_FILES_SIZE = -1
fi
}
function GetDirectoriesSize {
Logger "Getting files size" "NOTICE"
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ; then
if [ " $FILE_BACKUP " != "no" ] ; then
2016-08-18 11:53:18 +02:00
_GetDirectoriesSizeLocal " $FILE_SIZE_LIST_LOCAL "
2015-11-12 01:26:38 +01:00
fi
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
if [ " $FILE_BACKUP " != "no" ] ; then
2016-08-18 11:53:18 +02:00
_GetDirectoriesSizeRemote " $FILE_SIZE_LIST_REMOTE "
2015-11-12 01:26:38 +01:00
fi
fi
}
2015-11-19 22:14:15 +01:00
function _CreateDirectoryLocal {
2015-11-12 01:26:38 +01:00
local dir_to_create = " ${ 1 } "
if [ ! -d " $dir_to_create " ] ; then
2015-11-18 10:52:43 +01:00
# No sudo, you should have all necessary rights
2016-05-26 11:11:43 +02:00
mkdir -p " $dir_to_create " > $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID 2>& 1
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
Logger " Cannot create directory [ $dir_to_create ] " "CRITICAL"
2016-02-19 22:14:13 +01:00
if [ -f $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ] ; then
Logger " Command output: $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
fi
return 1
fi
fi
}
2015-11-19 22:14:15 +01:00
function _CreateDirectoryRemote {
2015-11-12 01:26:38 +01:00
local dir_to_create = " ${ 1 } "
2016-02-19 22:14:13 +01:00
local cmd
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-05-26 11:11:43 +02:00
cmd = $SSH_CMD ' "if ! [ -d \"' $dir_to_create '\" ]; then ' $COMMAND_SUDO ' mkdir -p \"' $dir_to_create '\"; fi" > ' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ' 2>&1'
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 720 1800 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
Logger " Cannot create remote directory [ $dir_to_create ]. " "CRITICAL"
2016-02-19 22:14:13 +01:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
return 1
fi
}
function CreateStorageDirectories {
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "pull" ] ; then
2015-11-16 12:52:15 +01:00
if [ " $SQL_BACKUP " != "no" ] ; then
2015-11-19 22:14:15 +01:00
_CreateDirectoryLocal " $SQL_STORAGE "
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
fi
fi
2015-11-16 12:52:15 +01:00
if [ " $FILE_BACKUP " != "no" ] ; then
2015-11-19 22:14:15 +01:00
_CreateDirectoryLocal " $FILE_STORAGE "
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-31 11:26:21 +02:00
CAN_BACKUP_FILES = false
2015-11-12 01:26:38 +01:00
fi
fi
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " = = "yes" ] ; then
_CreateDirectoryLocal " $CRYPT_STORAGE "
if [ $? != 0 ] ; then
CAN_BACKUP_FILES = false
fi
fi
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2015-11-16 12:52:15 +01:00
if [ " $SQL_BACKUP " != "no" ] ; then
2015-11-19 22:14:15 +01:00
_CreateDirectoryRemote " $SQL_STORAGE "
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
fi
fi
if [ " $FILE_BACKUP " != "no" ] ; then
2015-11-19 22:14:15 +01:00
_CreateDirectoryRemote " $FILE_STORAGE "
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-31 11:26:21 +02:00
CAN_BACKUP_FILES = false
2015-11-12 01:26:38 +01:00
fi
fi
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " = = "yes" ] ; then
_CreateDirectoryLocal " $CRYPT_STORAGE "
if [ $? != 0 ] ; then
CAN_BACKUP_FILES = false
fi
fi
2015-11-12 01:26:38 +01:00
fi
}
function GetDiskSpaceLocal {
# GLOBAL VARIABLE DISK_SPACE to pass variable to parent function
# GLOBAL VARIABLE DRIVE to pass variable to parent function
local path_to_check = " ${ 1 } "
2015-11-21 13:22:14 +01:00
if [ -d " $path_to_check " ] ; then
2015-11-12 01:26:38 +01:00
# Not elegant solution to make df silent on errors
2015-11-18 10:52:43 +01:00
# No sudo on local commands, assuming you should have all the necesarry rights to check backup directories sizes
2016-11-10 16:25:37 +01:00
df " $path_to_check " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " 2>& 1
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
DISK_SPACE = 0
Logger " Cannot get disk space in [ $path_to_check ] on local system. " "ERROR"
2016-02-19 22:14:13 +01:00
Logger " Command Output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
else
2016-08-08 19:00:52 +02:00
DISK_SPACE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " | awk '{print $4}' )
DRIVE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " | awk '{print $1}' )
2016-11-10 16:25:37 +01:00
if [ $( IsInteger $DISK_SPACE ) -eq 0 ] ; then
DISK_SPACE = " $( HumanToNumeric $DISK_SPACE ) "
fi
2015-11-12 01:26:38 +01:00
fi
else
2015-11-21 13:22:14 +01:00
Logger " Storage path [ $path_to_check ] does not exist. " "CRITICAL"
2015-11-12 01:26:38 +01:00
return 1
fi
}
function GetDiskSpaceRemote {
# USE GLOBAL VARIABLE DISK_SPACE to pass variable to parent function
local path_to_check = " ${ 1 } "
2016-02-19 22:14:13 +01:00
local cmd
2016-11-10 16:25:37 +01:00
cmd = $SSH_CMD ' "if [ -d \"' $path_to_check '\" ]; then ' $COMMAND_SUDO ' df \"' $path_to_check '\"; else exit 1; fi" > "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID '" 2>&1'
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
DISK_SPACE = 0
Logger " Cannot get disk space in [ $path_to_check ] on remote system. " "ERROR"
2016-02-19 22:14:13 +01:00
Logger " Command Output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
return 1
else
2016-08-08 19:00:52 +02:00
DISK_SPACE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " | awk '{print $4}' )
DRIVE = $( tail -1 " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " | awk '{print $1}' )
2016-11-10 16:25:37 +01:00
if [ $( IsInteger $DISK_SPACE ) -eq 0 ] ; then
DISK_SPACE = " $( HumanToNumeric $DISK_SPACE ) "
fi
2015-11-12 01:26:38 +01:00
fi
}
function CheckDiskSpace {
# USE OF GLOBAL VARIABLES TOTAL_DATABASES_SIZE, TOTAL_FILES_SIZE, BACKUP_SIZE_MINIMUM, STORAGE_WARN_SIZE, STORAGE_SPACE
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "pull" ] ; then
if [ " $SQL_BACKUP " != "no" ] ; then
GetDiskSpaceLocal " $SQL_STORAGE "
if [ $? != 0 ] ; then
SQL_DISK_SPACE = 0
2016-08-31 11:26:21 +02:00
CAN_BACKUP_SQL = false
2015-11-12 01:26:38 +01:00
else
SQL_DISK_SPACE = $DISK_SPACE
SQL_DRIVE = $DRIVE
fi
fi
if [ " $FILE_BACKUP " != "no" ] ; then
GetDiskSpaceLocal " $FILE_STORAGE "
if [ $? != 0 ] ; then
FILE_DISK_SPACE = 0
2016-08-31 11:26:21 +02:00
CAN_BACKUP_FILES = false
2015-11-12 01:26:38 +01:00
else
FILE_DISK_SPACE = $DISK_SPACE
FILE_DRIVE = $DRIVE
fi
fi
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " != "no" ] ; then
GetDiskSpaceLocal " $CRYPT_STORAGE "
if [ $? != 0 ] ; then
CRYPT_DISK_SPACE = 0
CAN_BACKUP_FILES = false
CAN_BACKUP_SQL = false
else
CRYPT_DISK_SPACE = $DISK_SPACE
CRYPT_DRIVE = $DRIVE
fi
fi
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
if [ " $SQL_BACKUP " != "no" ] ; then
GetDiskSpaceRemote " $SQL_STORAGE "
if [ $? != 0 ] ; then
SQL_DISK_SPACE = 0
else
SQL_DISK_SPACE = $DISK_SPACE
SQL_DRIVE = $DRIVE
fi
fi
if [ " $FILE_BACKUP " != "no" ] ; then
GetDiskSpaceRemote " $FILE_STORAGE "
if [ $? != 0 ] ; then
FILE_DISK_SPACE = 0
else
FILE_DISK_SPACE = $DISK_SPACE
FILE_DRIVE = $DRIVE
fi
fi
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " != "no" ] ; then
GetDiskSpaceLocal " $CRYPT_STORAGE "
if [ $? != 0 ] ; then
CRYPT_DISK_SPACE = 0
CAN_BACKUP_FILES = false
CAN_BACKUP_SQL = false
else
CRYPT_DISK_SPACE = $DISK_SPACE
CRYPT_DRIVE = $DRIVE
fi
fi
2015-11-12 01:26:38 +01:00
fi
if [ " $TOTAL_DATABASES_SIZE " = = "" ] ; then
TOTAL_DATABASES_SIZE = -1
fi
if [ " $TOTAL_FILES_SIZE " = = "" ] ; then
TOTAL_FILES_SIZE = -1
fi
2016-08-31 11:26:21 +02:00
if [ " $SQL_BACKUP " != "no" ] && [ $CAN_BACKUP_SQL = = true ] ; then
2015-11-12 01:26:38 +01:00
if [ $SQL_DISK_SPACE -eq 0 ] ; then
Logger " Storage space in [ $SQL_STORAGE ] reported to be 0Ko. " "WARN"
fi
if [ $SQL_DISK_SPACE -lt $TOTAL_DATABASES_SIZE ] ; then
Logger " Disk space in [ $SQL_STORAGE ] may be insufficient to backup SQL ( $SQL_DISK_SPACE Ko available in $SQL_DRIVE ) (non compressed databases calculation). " "WARN"
fi
if [ $SQL_DISK_SPACE -lt $SQL_WARN_MIN_SPACE ] ; then
Logger " Disk space in [ $SQL_STORAGE ] is lower than warning value [ $SQL_WARN_MIN_SPACE Ko]. " "WARN"
fi
Logger " SQL storage Space: $SQL_DISK_SPACE Ko - Databases size: $TOTAL_DATABASES_SIZE Ko " "NOTICE"
fi
2016-08-31 11:26:21 +02:00
if [ " $FILE_BACKUP " != "no" ] && [ $CAN_BACKUP_FILES = = true ] ; then
2015-11-12 01:26:38 +01:00
if [ $FILE_DISK_SPACE -eq 0 ] ; then
Logger " Storage space in [ $FILE_STORAGE ] reported to be 0 Ko. " "WARN"
fi
if [ $FILE_DISK_SPACE -lt $TOTAL_FILES_SIZE ] ; then
Logger " Disk space in [ $FILE_STORAGE ] may be insufficient to backup files ( $FILE_DISK_SPACE Ko available in $FILE_DRIVE ). " "WARN"
fi
if [ $FILE_DISK_SPACE -lt $FILE_WARN_MIN_SPACE ] ; then
Logger " Disk space in [ $FILE_STORAGE ] is lower than warning value [ $FILE_WARN_MIN_SPACE Ko]. " "WARN"
fi
Logger " File storage space: $FILE_DISK_SPACE Ko - Files size: $TOTAL_FILES_SIZE Ko " "NOTICE"
fi
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " = = "yes" ] ; then
if [ " $SQL_BACKUP " != "no" ] ; then
if [ " $SQL_DRIVE " = = " $CRYPT_DRIVE " ] ; then
if [ $(( SQL_DISK_SPACE/2)) -lt $(( TOTAL_DATABASES_SIZE)) ] ; then
Logger " Disk space in [ $SQL_STORAGE ] and [ $CRYPT_STORAGE ] may be insufficient to backup SQL ( $SQL_DISK_SPACE Ko available in $SQL_DRIVE ) (non compressed databases calculation + crypt storage space). " "WARN"
fi
else
if [ $(( CRYPT_DISK_SPACE)) -lt $(( TOTAL_DATABASES_SIZE)) ] ; then
Logger " Disk space in [ $CRYPT_STORAGE ] may be insufficient to encrypt SQL ( $CRYPT_DISK_SPACE Ko available in $CRYPT_DRIVE ) (non compressed databases calculation). " "WARN"
fi
fi
fi
if [ " $FILE_BACKUP " != "no" ] ; then
if [ " $FILE_DRIVE " = = " $CRYPT_DRIVE " ] ; then
if [ $(( FILE_DISK_SPACE/2)) -lt $(( TOTAL_FILES_SIZE)) ] ; then
Logger " Disk space in [ $FILE_STORAGE ] and [ $CRYPT_STORAGE ] may be insufficient to encrypt Sfiles ( $FILE_DISK_SPACE Ko available in $FILE_DRIVE ). " "WARN"
fi
else
if [ $(( CRYPT_DISK_SPACE)) -lt $(( TOTAL_FILES_SIZE)) ] ; then
Logger " Disk space in [ $CRYPT_STORAGE ] may be insufficient to encrypt files ( $CRYPT_DISK_SPACE Ko available in $CRYPT_DRIVE ). " "WARN"
fi
fi
fi
Logger " Crypt storage space: $CRYPT_DISK_SPACE Ko " "NOTICE"
fi
2015-11-12 01:26:38 +01:00
if [ $BACKUP_SIZE_MINIMUM -gt $(( $TOTAL_DATABASES_SIZE + $TOTAL_FILES_SIZE )) ] && [ " $GET_BACKUP_SIZE " != "no" ] ; then
Logger "Backup size is smaller than expected." "WARN"
fi
}
function _BackupDatabaseLocalToLocal {
local database = " ${ 1 } " # Database to backup
2016-09-08 22:51:24 +02:00
local exportOptions = " ${ 2 } " # export options
local encrypt = " ${ 3 :- false } " # Does the file need to be encrypted ?
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local encryptOptions
local drySqlCmd
local sqlCmd
2016-07-19 12:58:05 +02:00
local retval
2015-11-12 01:26:38 +01:00
2016-02-19 22:14:13 +01:00
2016-09-08 22:51:24 +02:00
if [ $encrypt = = true ] ; then
encryptOptions = " | $CRYPT_TOOL --encrypt --recipient=\" $GPG_RECIPIENT \" "
encryptExtension = " $CRYPT_FILE_EXTENSION "
fi
local drySqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions > /dev/null 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID "
local sqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions > $SQL_STORAGE / $database .sql $COMPRESSION_EXTENSION $encryptExtension 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID "
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = false ] ; then
2016-09-08 22:51:24 +02:00
Logger " cmd: $sqlCmd " "DEBUG"
eval " $sqlCmd " &
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Logger " cmd: $drySqlCmd " "DEBUG"
eval " $drySqlCmd " &
2015-11-12 01:26:38 +01:00
fi
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-07-19 12:58:05 +02:00
retval = $?
2016-02-19 22:14:13 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID " ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2016-07-19 13:28:16 +02:00
# Dirty fix for mysqldump return code not honored
retval = 1
2015-11-12 01:26:38 +01:00
fi
return $retval
}
function _BackupDatabaseLocalToRemote {
local database = " ${ 1 } " # Database to backup
2016-09-08 22:51:24 +02:00
local exportOptions = " ${ 2 } " # export options
local encrypt = " ${ 3 :- false } " # Does the file need to be encrypted
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local encryptOptions
local encryptExtension
local drySqlCmd
local sqlCmd
2016-07-19 12:58:05 +02:00
local retval
2016-02-19 22:14:13 +01:00
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
if [ $encrypt = = true ] ; then
encryptOptions = " | $CRYPT_TOOL --encrypt --recipient=\" $GPG_RECIPIENT \" "
encryptExtension = " $CRYPT_FILE_EXTENSION "
fi
local drySqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions > /dev/null 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID "
local sqlCmd = " mysqldump -u $SQL_USER $exportOptions --databases $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS $encryptOptions | $SSH_CMD ' $COMMAND_SUDO tee \" $SQL_STORAGE / $database .sql $COMPRESSION_EXTENSION $encryptExtension \" > /dev/null' 2> $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID "
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = false ] ; then
2016-09-08 22:51:24 +02:00
Logger " cmd: $sqlCmd " "DEBUG"
eval " $sqlCmd " &
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Logger " cmd: $drySqlCmd " "DEBUG"
eval " $drySqlCmd " &
2015-11-12 01:26:38 +01:00
fi
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-07-19 12:58:05 +02:00
retval = $?
2016-02-19 22:14:13 +01:00
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID " ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2016-07-19 13:28:16 +02:00
# Dirty fix for mysqldump return code not honored
retval = 1
2015-11-12 01:26:38 +01:00
fi
return $retval
}
function _BackupDatabaseRemoteToLocal {
local database = " ${ 1 } " # Database to backup
2016-09-08 22:51:24 +02:00
local exportOptions = " ${ 2 } " # export options
local encrypt = " ${ 3 :- false } " # Does the file need to be encrypted ?
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local encryptOptions
local encryptExtension
local drySqlCmd
local sqlCmd
2016-02-19 22:14:13 +01:00
local retval
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
if [ $encrypt = = true ] ; then
encryptOptions = " | $CRYPT_TOOL --encrypt --recipient=\\\" $GPG_RECIPIENT \\\" "
encryptExtension = " $CRYPT_FILE_EXTENSION "
fi
local drySqlCmd = $SSH_CMD ' "mysqldump -u ' $SQL_USER ' ' $exportOptions ' --databases ' $database ' ' $COMPRESSION_PROGRAM ' ' $COMPRESSION_OPTIONS ' ' $encryptOptions '" > /dev/null 2> "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID '"'
local sqlCmd = $SSH_CMD ' "mysqldump -u ' $SQL_USER ' ' $exportOptions ' --databases ' $database ' ' $COMPRESSION_PROGRAM ' ' $COMPRESSION_OPTIONS ' ' $encryptOptions '" > "' $SQL_STORAGE /$database .sql$COMPRESSION_EXTENSION $encryptExtension '" 2> "' $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID '"'
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_DRYRUN = = false ] ; then
2016-09-08 22:51:24 +02:00
Logger " cmd: $sqlCmd " "DEBUG"
eval " $sqlCmd " &
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Logger " cmd: $drySqlCmd " "DEBUG"
eval " $drySqlCmd " &
2015-11-12 01:26:38 +01:00
fi
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-02-19 22:14:13 +01:00
retval = $?
if [ -s " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } .error. $SCRIPT_PID " ] ; then
Logger " Error output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .error.$SCRIPT_PID ) " "ERROR"
2016-07-19 13:28:16 +02:00
# Dirty fix for mysqldump return code not honored
retval = 1
2015-11-12 01:26:38 +01:00
fi
return $retval
}
function BackupDatabase {
local database = " ${ 1 } "
2016-09-08 22:51:24 +02:00
local mysqlOptions
local encrypt = false
2016-02-19 22:14:13 +01:00
2015-11-12 01:26:38 +01:00
# Hack to prevent warning on table mysql.events, some mysql versions don't support --skip-events, prefer using --ignore-table
if [ " $database " = = "mysql" ] ; then
2016-09-08 22:51:24 +02:00
mysqlOptions = " $MYSQLDUMP_OPTIONS --ignore-table=mysql.event "
else
mysqlOptions = " $MYSQLDUMP_OPTIONS "
fi
if [ " $ENCRYPTION " = = "yes" ] ; then
encrypt = true
Logger " Backing up encrypted database [ $database ]. " "NOTICE"
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Logger " Backing up database [ $database ]. " "NOTICE"
2015-11-12 01:26:38 +01:00
fi
if [ " $BACKUP_TYPE " = = "local" ] ; then
2016-09-08 22:51:24 +02:00
_BackupDatabaseLocalToLocal " $database " " $mysqlOptions " $encrypt
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
2016-09-08 22:51:24 +02:00
_BackupDatabaseRemoteToLocal " $database " " $mysqlOptions " $encrypt
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2016-09-08 22:51:24 +02:00
_BackupDatabaseLocalToRemote " $database " " $mysqlOptions " $encrypt
2015-11-12 01:26:38 +01:00
fi
if [ $? -ne 0 ] ; then
Logger "Backup failed." "ERROR"
else
Logger "Backup succeeded." "NOTICE"
fi
}
function BackupDatabases {
local database
for database in $SQL_BACKUP_TASKS
do
2016-08-26 15:10:30 +02:00
BackupDatabase $database
2015-11-12 01:26:38 +01:00
CheckTotalExecutionTime
done
}
2016-09-08 22:51:24 +02:00
#TODO: exclusions don't work for encrypted files
2016-09-09 08:31:29 +02:00
#TODO: add ParallelExec here ?
2016-09-08 22:51:24 +02:00
function EncryptFiles {
local filePath = " ${ 1 } " # Path of files to encrypt
local destPath = " ${ 2 } " # Path to store encrypted files
local recipient = " ${ 3 } " # GPG recipient
local recursive = " ${ 4 :- true } " # Is recursive ?
local keepFullPath = " ${ 5 :- false } " # Should destpath become destpath + sourcepath ?
2016-08-26 15:10:30 +02:00
2016-09-08 22:51:24 +02:00
local successCounter = 0
local errorCounter = 0
local cryptFileExtension = " $CRYPT_FILE_EXTENSION "
local recursiveArgs = ""
if [ ! -w " $destPath " ] ; then
Logger " Cannot write to crypt storage path [ $destPath ]. " "ERROR"
return 1
2016-08-26 15:10:30 +02:00
fi
2016-09-08 22:51:24 +02:00
if [ $recursive = = false ] ; then
recursiveArgs = "-mindepth 1 -maxdepth 1"
fi
while IFS = read -r -d $'\0' sourceFile; do
# Get path of sourcefile
path = " $( dirname " $sourceFile " ) "
if [ $keepFullPath = = false ] ; then
# Remove source path part
path = " ${ path # $filePath } "
fi
# Remove ending slash if there is one
path = " ${ path %/ } "
# Add new path
path = " $destPath / $path "
# Get filename
file = " $( basename " $sourceFile " ) "
if [ ! -d " $path " ] ; then
mkdir -p " $path "
fi
Logger " Encrypting file [ $sourceFile ] to [ $path / $file $cryptFileExtension ]. " "VERBOSE"
$CRYPT_TOOL --batch --yes --out " $path / $file $cryptFileExtension " --recipient= " $recipient " --encrypt " $sourceFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " 2>& 1
if [ $? != 0 ] ; then
Logger " Cannot encrypt [ $sourceFile ]. " "ERROR"
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "DEBUG"
errorCounter = $(( errorCounter+1))
else
successCounter = $(( successCounter+1))
fi
done < <( find " $filePath " $recursiveArgs -type f ! -name " * $cryptFileExtension " -print0)
Logger " Encrypted [ $successCounter ] files successfully. " "NOTICE"
if [ $errorCounter -gt 0 ] ; then
Logger " Failed to encrypt [ $errorCounter ] files. " "CRITICAL"
fi
return $errorCounter
2016-08-26 15:10:30 +02:00
}
2016-09-08 22:51:24 +02:00
function DecryptFiles {
local filePath = " ${ 1 } " # Path to files to decrypt
local passphraseFile = " ${ 2 } " # Passphrase file to decrypt files
local passphrase = " ${ 3 } " # Passphrase to decrypt files
local options
local secret
local successCounter = 0
local errorCounter = 0
local cryptFileExtension = " $CRYPT_FILE_EXTENSION "
if [ ! -w " $filePath " ] ; then
Logger " Directory [ $filePath ] is not writable. Cannot decrypt files. " "CRITICAL"
exit 1
fi
if [ -f " $passphraseFile " ] ; then
secret = " --passphrase-file $passphraseFile "
elif [ " $passphrase " != "" ] ; then
secret = " --passphrase $passphrase "
else
Logger "The given passphrase file or passphrase are inexistent." "CRITICAL"
exit 1
fi
2016-08-18 22:16:15 +02:00
2016-09-08 22:51:24 +02:00
if [ " $CRYPT_TOOL " = = "gpg2" ] ; then
options = "--batch --yes"
elif [ " $CRYPT_TOOL " = = "gpg" ] ; then
options = "--no-use-agent --batch"
fi
2016-08-18 22:16:15 +02:00
2016-09-08 22:51:24 +02:00
while IFS = read -r -d $'\0' encryptedFile; do
Logger " Decrypting [ $encryptedFile ]. " "VERBOSE"
$CRYPT_TOOL $options --out " ${ encryptedFile %% $cryptFileExtension } " $secret --decrypt " $encryptedFile " > " $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID " 2>& 1
if [ $? != 0 ] ; then
Logger " Cannot decrypt [ $encryptedFile ]. " "ERROR"
Logger " Command output\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "DEBUG"
errorCounter = $(( errorCounter+1))
else
successCounter = $(( successCounter+1))
rm -f " $encryptedFile "
if [ $? != 0 ] ; then
Logger " Cannot delete original file [ $encryptedFile ] after decryption. " "ERROR"
fi
fi
done < <( find " $filePath " -type f -name " * $cryptFileExtension " -print0)
Logger " Decrypted [ $successCounter ] files successfully. " "NOTICE"
if [ $errorCounter -gt 0 ] ; then
Logger " Failed to decrypt [ $errorCounter ] files. " "CRITICAL"
fi
return $errorCounter
2016-08-18 22:16:15 +02:00
}
2015-11-12 01:26:38 +01:00
function Rsync {
2016-09-08 22:51:24 +02:00
local backupDirectory = " ${ 1 } " # Which directory to backup
local recursive = " ${ 2 :- true } " # Backup only files at toplevel of directory
2015-11-12 01:26:38 +01:00
2016-09-08 22:51:24 +02:00
local fileStoragePath
local withoutCryptPath
local rsyncCmd
local retval
2016-02-19 22:14:13 +01:00
2016-09-08 22:51:24 +02:00
if [ " $KEEP_ABSOLUTE_PATHS " != "no" ] ; then
if [ " $ENCRYPTION " = = "yes" ] ; then
withoutCryptPath = " ${ backupDirectory # $CRYPT_STORAGE } "
fileStoragePath = $( dirname " $FILE_STORAGE / ${ withoutCryptPath #/ } " )
else
fileStoragePath = $( dirname " $FILE_STORAGE / ${ backupDirectory #/ } " )
fi
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
fileStoragePath = " $FILE_STORAGE "
2015-11-12 01:26:38 +01:00
fi
## Manage to backup recursive directories lists files only (not recursing into subdirectories)
2016-09-08 22:51:24 +02:00
if [ $recursive = = false ] ; then
2015-11-12 01:26:38 +01:00
# Fixes symlinks to directories in target cannot be deleted when backing up root directory without recursion, and excludes subdirectories
RSYNC_NO_RECURSE_ARGS = " -k --exclude=*/*/"
else
RSYNC_NO_RECURSE_ARGS = ""
fi
2015-11-19 22:14:15 +01:00
# Creating subdirectories because rsync cannot handle multiple subdirectory creation
2015-11-12 01:26:38 +01:00
if [ " $BACKUP_TYPE " = = "local" ] ; then
2016-09-08 22:51:24 +02:00
_CreateDirectoryLocal " $fileStoragePath "
rsyncCmd = " $( type -p $RSYNC_EXECUTABLE ) $RSYNC_ARGS $RSYNC_DRY_ARG $RSYNC_ATTR_ARGS $RSYNC_TYPE_ARGS $RSYNC_NO_RECURSE_ARGS $RSYNC_DELETE $RSYNC_PATTERNS $RSYNC_PARTIAL_EXCLUDE --rsync-path=\" $RSYNC_PATH \" \" $backupDirectory \" \" $fileStoragePath \" > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID 2>&1 "
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "pull" ] ; then
2016-09-08 22:51:24 +02:00
_CreateDirectoryLocal " $fileStoragePath "
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
backupDirectory = $( EscapeSpaces " $backupDirectory " )
rsyncCmd = " $( type -p $RSYNC_EXECUTABLE ) $RSYNC_ARGS $RSYNC_DRY_ARG $RSYNC_ATTR_ARGS $RSYNC_TYPE_ARGS $RSYNC_NO_RECURSE_ARGS $RSYNC_DELETE $RSYNC_PATTERNS $RSYNC_PARTIAL_EXCLUDE --rsync-path=\" $RSYNC_PATH \" -e \" $RSYNC_SSH_CMD \" \" $REMOTE_USER @ $REMOTE_HOST : $backupDirectory \" \" $fileStoragePath \" > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID 2>&1 "
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2016-09-08 22:51:24 +02:00
fileStoragePath = $( EscapeSpaces " $fileStoragePath " )
_CreateDirectoryRemote " $fileStoragePath "
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
2016-09-08 22:51:24 +02:00
rsyncCmd = " $( type -p $RSYNC_EXECUTABLE ) $RSYNC_ARGS $RSYNC_DRY_ARG $RSYNC_ATTR_ARGS $RSYNC_TYPE_ARGS $RSYNC_NO_RECURSE_ARGS $RSYNC_DELETE $RSYNC_PATTERNS $RSYNC_PARTIAL_EXCLUDE --rsync-path=\" $RSYNC_PATH \" -e \" $RSYNC_SSH_CMD \" \" $backupDirectory \" \" $REMOTE_USER @ $REMOTE_HOST : $fileStoragePath \" > $RUN_DIR / $PROGRAM . ${ FUNCNAME [0] } . $SCRIPT_PID 2>&1 "
2015-11-12 01:26:38 +01:00
fi
2016-09-08 22:51:24 +02:00
Logger " cmd: $rsyncCmd " "DEBUG"
eval " $rsyncCmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-09-08 22:51:24 +02:00
retval = $?
if [ $retval != 0 ] ; then
Logger " Failed to backup [ $backupDirectory ] to [ $fileStoragePath ]. " "ERROR"
2016-02-19 22:14:13 +01:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
else
Logger "File backup succeed." "NOTICE"
fi
2016-09-08 22:51:24 +02:00
return $retval
2015-11-12 01:26:38 +01:00
}
function FilesBackup {
2016-08-06 14:04:35 +02:00
local backupTask
local backupTasks
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a backupTasks <<< " $FILE_BACKUP_TASKS "
2016-08-06 14:04:35 +02:00
for backupTask in " ${ backupTasks [@] } " ; do
2016-08-08 00:23:48 +02:00
Logger " Beginning file backup of [ $backupTask ]. " "NOTICE"
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " = = "yes" ] && ( [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ) ; then
EncryptFiles " $backupTask " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true true
if [ $? = = 0 ] ; then
Rsync " $CRYPT_STORAGE / $backupTask " true
else
Logger "backup failed." "ERROR"
fi
elif [ " $ENCRYPTION " = = "yes" ] && [ " $BACKUP_TYPE " = = "pull" ] ; then
Rsync " $backupTask " true
if [ $? = = 0 ] ; then
EncryptFiles " $FILE_STORAGE " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true false
fi
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Rsync " $backupTask " true
2013-11-02 18:55:17 +01:00
fi
2015-11-12 01:26:38 +01:00
CheckTotalExecutionTime
2013-07-16 23:10:27 +02:00
done
2014-09-22 22:45:18 +02:00
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a backupTasks <<< " $RECURSIVE_DIRECTORY_LIST "
2016-08-06 14:04:35 +02:00
for backupTask in " ${ backupTasks [@] } " ; do
2016-08-08 00:23:48 +02:00
Logger " Beginning non recursive file backup of [ $backupTask ]. " "NOTICE"
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " = = "yes" ] && ( [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ) ; then
EncryptFiles " $backupTask " " $CRYPT_STORAGE " " $GPG_RECIPIENT " false true
if [ $? = = 0 ] ; then
Rsync " $CRYPT_STORAGE / $backupTask " false true
else
Logger "backup failed." "ERROR"
fi
elif [ " $ENCRYPTION " = = "yes" ] && [ " $BACKUP_TYPE " = = "pull" ] ; then
Rsync " $backupTask " false
if [ $? = = 0 ] ; then
EncryptFiles " $FILE_STORAGE " " $CRYPT_STORAGE " " $GPG_RECIPIENT " false false
fi
2013-07-16 23:10:27 +02:00
else
2016-09-08 22:51:24 +02:00
Rsync " $backupTask " false
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
CheckTotalExecutionTime
2013-07-16 23:10:27 +02:00
done
2016-08-08 19:00:52 +02:00
IFS = $PATH_SEPARATOR_CHAR read -r -a backupTasks <<< " $FILE_RECURSIVE_BACKUP_TASKS "
2016-08-06 14:04:35 +02:00
for backupTask in " ${ backupTasks [@] } " ; do
2015-11-12 01:26:38 +01:00
# Backup sub directories of recursive directories
2016-08-08 00:23:48 +02:00
Logger " Beginning recursive file backup of [ $backupTask ]. " "NOTICE"
2016-09-08 22:51:24 +02:00
if [ " $ENCRYPTION " = = "yes" ] && ( [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "push" ] ) ; then
EncryptFiles " $backupTask " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true true
if [ $? = = 0 ] ; then
Rsync " $CRYPT_STORAGE / $backupTask " true true
else
Logger "backup failed." "ERROR"
fi
elif [ " $ENCRYPTION " = = "yes" ] && [ " $BACKUP_TYPE " = = "pull" ] ; then
Rsync " $backupTask " true
if [ $? = = 0 ] ; then
EncryptFiles " $FILE_STORAGE " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true false
fi
2015-11-12 01:26:38 +01:00
else
2016-09-08 22:51:24 +02:00
Rsync " $backupTask " true
2015-11-12 01:26:38 +01:00
fi
CheckTotalExecutionTime
done
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function CheckTotalExecutionTime {
#### Check if max execution time of whole script as been reached
if [ $SECONDS -gt $SOFT_MAX_EXEC_TIME_TOTAL ] ; then
2016-08-08 00:23:48 +02:00
Logger "Max soft execution time of the whole backup exceeded." "ERROR"
2015-11-12 01:26:38 +01:00
WARN_ALERT = 1
2016-08-26 15:10:30 +02:00
SendAlert true
2015-11-12 01:26:38 +01:00
if [ $SECONDS -gt $HARD_MAX_EXEC_TIME_TOTAL ] && [ $HARD_MAX_EXEC_TIME_TOTAL -ne 0 ] ; then
2016-08-08 00:23:48 +02:00
Logger "Max hard execution time of the whole backup exceeded, stopping backup process." "CRITICAL"
2015-11-12 01:26:38 +01:00
exit 1
2013-07-16 23:10:27 +02:00
fi
fi
}
2015-11-12 01:26:38 +01:00
function _RotateBackupsLocal {
local backup_path = " ${ 1 } "
2015-11-16 12:52:15 +01:00
local rotate_copies = " ${ 2 } "
2015-11-12 01:26:38 +01:00
2016-02-19 22:14:13 +01:00
local backup
local copy
local cmd
local path
2016-09-09 08:31:29 +02:00
#TODO: Replace this -name with regex .*$PROGRAM\.[1-9][0-9]+
find " $backup_path " -mindepth 1 -maxdepth 1 ! -name " *. $PROGRAM .[0-9]* " -print0 | while IFS = read -r -d $'\0' backup; do
2015-11-16 12:52:15 +01:00
copy = $rotate_copies
2016-08-08 19:00:52 +02:00
while [ $copy -gt 1 ] ; do
2015-11-16 12:52:15 +01:00
if [ $copy -eq $rotate_copies ] ; then
2016-08-18 11:53:18 +02:00
path = " $backup . $PROGRAM . $copy "
if [ -f " $path " ] || [ -d " $path " ] ; then
cmd = " rm -rf \" $path \" "
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 3600 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2016-08-18 11:53:18 +02:00
if [ $? != 0 ] ; then
Logger " Cannot delete oldest copy [ $path ]. " "ERROR"
fi
2015-11-12 01:26:38 +01:00
fi
fi
2016-08-18 11:53:18 +02:00
2016-08-17 10:01:55 +02:00
path = " $backup . $PROGRAM . $(( $copy - 1 )) "
2016-08-18 11:53:18 +02:00
if [ -f " $path " ] || [ -d " $path " ] ; then
2016-08-17 10:01:55 +02:00
cmd = " mv \" $path \" \" $backup . $PROGRAM . $copy \" "
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 3600 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot move [ $path ] to [ $backup . $PROGRAM . $copy ]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
fi
copy = $(( $copy - 1 ))
done
2013-11-02 18:55:17 +01:00
2015-11-12 01:26:38 +01:00
# Latest file backup will not be moved if script configured for remote backup so next rsync execution will only do delta copy instead of full one
if [ [ $backup = = *.sql.* ] ] ; then
2016-08-17 10:01:55 +02:00
cmd = " mv \" $backup \" \" $backup . $PROGRAM .1\" "
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 3600 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot move [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2013-08-25 12:39:13 +02:00
2015-11-12 01:26:38 +01:00
elif [ " $REMOTE_OPERATION " = = "yes" ] ; then
2016-08-17 10:01:55 +02:00
cmd = " cp -R \" $backup \" \" $backup . $PROGRAM .1\" "
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 3600 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot copy [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2013-07-16 23:10:27 +02:00
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
else
2016-08-17 10:01:55 +02:00
cmd = " mv \" $backup \" \" $backup . $PROGRAM .1\" "
2015-11-12 01:26:38 +01:00
Logger " cmd: $cmd " "DEBUG"
eval " $cmd " &
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 3600 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
Logger " Cannot move [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
fi
done
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _RotateBackupsRemote {
local backup_path = " ${ 1 } "
2015-11-16 12:52:15 +01:00
local rotate_copies = " ${ 2 } "
2016-02-19 22:14:13 +01:00
$SSH_CMD PROGRAM = $PROGRAM REMOTE_OPERATION = $REMOTE_OPERATION _DEBUG = $_DEBUG COMMAND_SUDO = $COMMAND_SUDO rotate_copies = $rotate_copies backup_path = " $backup_path " 'bash -s' << 'ENDSSH' > "$RUN_DIR/$PROGRAM.${FUNCNAME [ 0] } .$SCRIPT_PID " 2>&1 &
2015-11-12 01:26:38 +01:00
function _RemoteLogger {
local value = " ${ 1 } " # What to log
echo -e " $value "
}
function RemoteLogger {
local value = " ${ 1 } " # Sentence to log (in double quotes)
local level = " ${ 2 } " # Log level: PARANOIA_DEBUG, DEBUG, NOTICE, WARN, ERROR, CRITIAL
prefix = " REMOTE TIME: $SECONDS - "
if [ " $level " = = "CRITICAL" ] ; then
_RemoteLogger " $prefix \e[41m $value \e[0m "
return
elif [ " $level " = = "ERROR" ] ; then
_RemoteLogger " $prefix \e[91m $value \e[0m "
return
elif [ " $level " = = "WARN" ] ; then
_RemoteLogger " $prefix \e[93m $value \e[0m "
return
elif [ " $level " = = "NOTICE" ] ; then
_RemoteLogger " $prefix $value "
return
elif [ " $level " = = "DEBUG" ] ; then
if [ " $_DEBUG " = = "yes" ] ; then
_RemoteLogger " $prefix $value "
return
fi
else
_RemoteLogger "\e[41mLogger function called without proper loglevel.\e[0m"
_RemoteLogger " $prefix $value "
fi
}
function _RotateBackupsRemoteSSH {
2016-09-08 22:51:24 +02:00
find " $backup_path " -mindepth 1 -maxdepth 1 ! -name " *. $PROGRAM .[0-9]* " -print0 | while IFS = read -r -d $'\0' backup; do
2015-11-16 12:52:15 +01:00
copy = $rotate_copies
2016-08-08 19:00:52 +02:00
while [ $copy -gt 1 ] ; do
2015-11-16 12:52:15 +01:00
if [ $copy -eq $rotate_copies ] ; then
2016-08-18 11:53:18 +02:00
path = " $backup . $PROGRAM . $copy "
if [ -f " $path " ] || [ -d " $path " ] ; then
cmd = " $COMMAND_SUDO rm -rf \" $path \" "
RemoteLogger " cmd: $cmd " "DEBUG"
eval " $cmd "
if [ $? != 0 ] ; then
RemoteLogger " Cannot delete oldest copy [ $path ]. " "ERROR"
fi
2015-11-12 01:26:38 +01:00
fi
2013-07-16 23:10:27 +02:00
fi
2016-08-17 10:01:55 +02:00
path = " $backup . $PROGRAM . $(( $copy - 1 )) "
2016-08-18 11:53:18 +02:00
if [ -f " $path " ] || [ -d " $path " ] ; then
2016-08-17 10:01:55 +02:00
cmd = " $COMMAND_SUDO mv \" $path \" \" $backup . $PROGRAM . $copy \" "
2015-11-12 01:26:38 +01:00
RemoteLogger " cmd: $cmd " "DEBUG"
eval " $cmd "
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot move [ $path ] to [ $backup . $PROGRAM . $copy ]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2014-09-22 22:45:18 +02:00
2013-07-16 23:10:27 +02:00
fi
copy = $(( $copy - 1 ))
done
# Latest file backup will not be moved if script configured for remote backup so next rsync execution will only do delta copy instead of full one
2015-11-12 01:26:38 +01:00
if [ [ $backup = = *.sql.* ] ] ; then
2016-08-17 10:01:55 +02:00
cmd = " $COMMAND_SUDO mv \" $backup \" \" $backup . $PROGRAM .1\" "
2015-11-12 01:26:38 +01:00
RemoteLogger " cmd: $cmd " "DEBUG"
eval " $cmd "
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot move [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
elif [ " $REMOTE_OPERATION " = = "yes" ] ; then
2016-08-17 10:01:55 +02:00
cmd = " $COMMAND_SUDO cp -R \" $backup \" \" $backup . $PROGRAM .1\" "
2015-11-12 01:26:38 +01:00
RemoteLogger " cmd: $cmd " "DEBUG"
eval " $cmd "
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot copy [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
else
2016-08-17 10:01:55 +02:00
cmd = " $COMMAND_SUDO mv \" $backup \" \" $backup . $PROGRAM .1\" "
2015-11-12 01:26:38 +01:00
RemoteLogger " cmd: $cmd " "DEBUG"
eval " $cmd "
if [ $? != 0 ] ; then
2016-08-17 10:01:55 +02:00
RemoteLogger " Cannot move [ $backup ] to [ $backup . $PROGRAM .1]. " "ERROR"
2015-11-12 01:26:38 +01:00
fi
2013-07-16 23:10:27 +02:00
fi
done
}
2015-11-12 01:26:38 +01:00
_RotateBackupsRemoteSSH
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
ENDSSH
2016-08-18 22:16:15 +02:00
WaitForTaskCompletion $! 1800 0 ${ FUNCNAME [0] } true $KEEP_LOGGING
2015-11-12 01:26:38 +01:00
if [ $? != 0 ] ; then
Logger " Could not rotate backups in [ $backup_path ]. " "ERROR"
2016-02-19 22:14:13 +01:00
Logger " Command output:\n $( cat $RUN_DIR /$PROGRAM .${ FUNCNAME [0] } .$SCRIPT_PID ) " "ERROR"
2015-11-12 01:26:38 +01:00
else
Logger "Remote rotation succeed." "NOTICE"
fi ## Need to add a trivial sleep time to give ssh time to log to local file
#sleep 5
}
function RotateBackups {
local backup_path = " ${ 1 } "
2015-11-16 12:52:15 +01:00
local rotate_copies = " ${ 2 } "
2015-11-12 01:26:38 +01:00
2016-08-18 11:53:18 +02:00
Logger " Rotating backups in [ $backup_path ] for [ $rotate_copies ] copies. " "NOTICE"
2015-11-12 01:26:38 +01:00
if [ " $BACKUP_TYPE " = = "local" ] || [ " $BACKUP_TYPE " = = "pull" ] ; then
2015-11-16 12:52:15 +01:00
_RotateBackupsLocal " $backup_path " " $rotate_copies "
2015-11-12 01:26:38 +01:00
elif [ " $BACKUP_TYPE " = = "push" ] ; then
2015-11-16 12:52:15 +01:00
_RotateBackupsRemote " $backup_path " " $rotate_copies "
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
}
2013-07-16 23:10:27 +02:00
2016-09-08 22:51:24 +02:00
function SetTraps {
trap TrapStop INT QUIT TERM HUP
trap TrapQuit EXIT
}
2015-11-12 01:26:38 +01:00
function Init {
2013-09-22 12:04:09 +02:00
2016-02-19 22:14:13 +01:00
local uri
local hosturiandpath
local hosturi
2015-11-12 01:26:38 +01:00
## Test if target dir is a ssh uri, and if yes, break it down it its values
if [ " ${ REMOTE_SYSTEM_URI : 0 : 6 } " = = "ssh://" ] && [ " $BACKUP_TYPE " != "local" ] ; then
REMOTE_OPERATION = "yes"
2013-07-20 14:48:06 +02:00
2015-11-12 01:26:38 +01:00
# remove leadng 'ssh://'
uri = ${ REMOTE_SYSTEM_URI #ssh : //* }
if [ [ " $uri " = = *"@" * ] ] ; then
# remove everything after '@'
REMOTE_USER = ${ uri %@* }
2013-09-22 12:04:09 +02:00
else
2015-11-12 01:26:38 +01:00
REMOTE_USER = $LOCAL_USER
fi
2013-07-20 14:48:06 +02:00
2015-11-12 01:26:38 +01:00
if [ " $SSH_RSA_PRIVATE_KEY " = = "" ] ; then
2016-11-10 16:25:37 +01:00
if [ ! -f " $SSH_PASSWORD_FILE " ] ; then
# Assume that there might exist a standard rsa key
SSH_RSA_PRIVATE_KEY = ~/.ssh/id_rsa
fi
2015-11-12 01:26:38 +01:00
fi
# remove everything before '@'
2016-02-19 22:14:13 +01:00
hosturiandpath = ${ uri #*@ }
2015-11-12 01:26:38 +01:00
# remove everything after first '/'
2016-02-19 22:14:13 +01:00
hosturi = ${ hosturiandpath %%/* }
if [ [ " $hosturi " = = *":" * ] ] ; then
REMOTE_PORT = ${ hosturi ##* : }
2015-11-12 01:26:38 +01:00
else
REMOTE_PORT = 22
fi
2016-02-19 22:14:13 +01:00
REMOTE_HOST = ${ hosturi %% : * }
2015-11-12 01:26:38 +01:00
fi
## Add update to default RSYNC_ARGS
2016-03-01 20:11:38 +01:00
RSYNC_ARGS = $RSYNC_ARGS " -u"
2015-11-12 01:26:38 +01:00
2016-08-31 11:26:21 +02:00
if [ $_VERBOSE = = true ] ; then
2016-03-01 20:11:38 +01:00
RSYNC_ARGS = $RSYNC_ARGS " -i"
2013-08-18 11:58:55 +02:00
fi
2015-11-12 01:26:38 +01:00
if [ " $DELETE_VANISHED_FILES " = = "yes" ] ; then
2015-01-08 20:05:58 +01:00
RSYNC_ARGS = $RSYNC_ARGS " --delete"
2015-01-08 17:16:57 +01:00
fi
2016-08-31 11:26:21 +02:00
if [ $stats = = true ] ; then
2015-11-12 01:26:38 +01:00
RSYNC_ARGS = $RSYNC_ARGS " --stats"
2014-12-21 22:28:05 +01:00
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
## Fix for symlink to directories on target cannot get updated
RSYNC_ARGS = $RSYNC_ARGS " --force"
2014-09-22 22:45:18 +02:00
}
2015-11-12 01:26:38 +01:00
function Main {
2013-07-16 23:10:27 +02:00
2016-08-31 11:26:21 +02:00
if [ " $SQL_BACKUP " != "no" ] && [ $CAN_BACKUP_SQL = = true ] ; then
2013-07-16 23:10:27 +02:00
ListDatabases
fi
2016-08-31 11:26:21 +02:00
if [ " $FILE_BACKUP " != "no" ] && [ $CAN_BACKUP_FILES = = true ] ; then
2015-11-12 01:26:38 +01:00
ListRecursiveBackupDirectories
if [ " $GET_BACKUP_SIZE " != "no" ] ; then
2015-04-20 14:07:45 +02:00
GetDirectoriesSize
2015-11-12 01:26:38 +01:00
else
2016-08-16 20:39:49 +02:00
TOTAL_FILES_SIZE = -1
2015-04-20 14:07:45 +02:00
fi
2013-07-16 23:10:27 +02:00
fi
2013-08-24 19:41:18 +02:00
2016-08-31 11:26:21 +02:00
# Expand ~ if exists
FILE_STORAGE = " ${ FILE_STORAGE /# \~ / $HOME } "
SQL_STORAGE = " ${ SQL_STORAGE /# \~ / $HOME } "
SSH_RSA_PRIVATE_KEY = " ${ SSH_RSA_PRIVATE_KEY /# \~ / $HOME } "
2016-11-10 16:25:37 +01:00
SSH_PASSWORD_FILE = " ${ SSH_PASSWORD_FILE /# \~ / $HOME } "
2016-09-08 22:51:24 +02:00
ENCRYPT_PUBKEY = " ${ ENCRYPT_PUBKEY /# \~ / $HOME } "
2016-08-31 11:26:21 +02:00
2015-11-12 01:26:38 +01:00
if [ " $CREATE_DIRS " != "no" ] ; then
CreateStorageDirectories
fi
CheckDiskSpace
2013-07-16 23:10:27 +02:00
2013-08-18 11:58:55 +02:00
# Actual backup process
2016-08-31 11:26:21 +02:00
if [ " $SQL_BACKUP " != "no" ] && [ $CAN_BACKUP_SQL = = true ] ; then
if [ $_DRYRUN = = false ] && [ " $ROTATE_SQL_BACKUPS " = = "yes" ] ; then
2015-11-16 12:52:15 +01:00
RotateBackups " $SQL_STORAGE " " $ROTATE_SQL_COPIES "
2013-07-16 23:10:27 +02:00
fi
2014-11-27 14:40:30 +01:00
BackupDatabases
2013-07-16 23:10:27 +02:00
fi
2013-08-18 11:58:55 +02:00
2016-08-31 11:26:21 +02:00
if [ " $FILE_BACKUP " != "no" ] && [ $CAN_BACKUP_FILES = = true ] ; then
if [ $_DRYRUN = = false ] && [ " $ROTATE_FILE_BACKUPS " = = "yes" ] ; then
2015-11-16 12:52:15 +01:00
RotateBackups " $FILE_STORAGE " " $ROTATE_FILE_COPIES "
2013-07-16 23:10:27 +02:00
fi
2015-11-28 12:48:19 +01:00
## Add Rsync include / exclude patterns
RsyncPatterns
2013-07-16 23:10:27 +02:00
FilesBackup
fi
}
2015-11-12 01:26:38 +01:00
function Usage {
if [ " $IS_STABLE " != "yes" ] ; then
echo -e "\e[93mThis is an unstable dev build. Please use with caution.\e[0m"
fi
echo " $PROGRAM $PROGRAM_VERSION $PROGRAM_BUILD "
2014-09-22 22:45:18 +02:00
echo " $AUTHOR "
echo " $CONTACT "
2013-07-16 23:10:27 +02:00
echo ""
2016-09-08 22:51:24 +02:00
echo " General usage: $0 /path/to/backup.conf [OPTIONS] "
2013-07-16 23:10:27 +02:00
echo ""
2015-11-12 01:26:38 +01:00
echo "OPTIONS:"
2016-02-16 21:09:57 +01:00
echo "--dry will run obackup without actually doing anything, just testing"
echo "--silent will run obackup without any output to stdout, usefull for cron backups"
echo "--verbose adds command outputs"
2015-11-12 01:26:38 +01:00
echo "--stats Adds rsync transfer statistics to verbose output"
echo "--partial Allows rsync to keep partial downloads that can be resumed later (experimental)"
2015-01-08 17:16:57 +01:00
echo "--no-maxtime disables any soft and hard execution time checks"
echo "--delete Deletes files on destination that vanished on source"
2015-11-12 01:26:38 +01:00
echo "--dontgetsize Does not try to evaluate backup size"
2016-09-08 22:51:24 +02:00
echo ""
echo "Batch processing usage:"
echo -e " \e[93mDecrypt\e[0m a backup encrypted with $PROGRAM "
echo " $0 --decrypt=/path/to/encrypted_backup --passphrase-file=/path/to/passphrase "
echo " $0 --decrypt=/path/to/encrypted_backup --passphrase=MySecretPassPhrase (security risk) "
echo ""
echo "Batch encrypt a directory in separate gpg files"
echo " $0 --encrypt=/path/to/files --destination=/path/to/encrypted/files --recipient=\"Your Name\" "
2013-07-16 23:10:27 +02:00
exit 128
}
2015-04-24 23:41:01 +02:00
# Command line argument flags
2016-08-31 11:26:21 +02:00
_DRYRUN = false
_SILENT = false
no_maxtime = false
stats = false
PARTIAL = no
2016-09-08 22:51:24 +02:00
_DECRYPT_MODE = false
DECRYPT_PATH = ""
_ENCRYPT_MODE = false
2015-04-24 22:31:39 +02:00
2015-11-12 01:26:38 +01:00
function GetCommandlineArguments {
if [ $# -eq 0 ] ; then
2013-07-16 23:10:27 +02:00
Usage
2015-04-24 22:31:39 +02:00
fi
2016-08-08 19:00:52 +02:00
for i in " $@ " ; do
2015-04-24 22:31:39 +02:00
case $i in
--dry)
2016-08-31 11:26:21 +02:00
_DRYRUN = true
2015-04-24 22:31:39 +02:00
; ;
--silent)
2016-08-31 11:26:21 +02:00
_SILENT = true
2015-04-24 22:31:39 +02:00
; ;
--verbose)
2016-08-31 11:26:21 +02:00
_VERBOSE = true
2015-04-24 22:31:39 +02:00
; ;
--stats)
2016-08-31 11:26:21 +02:00
stats = false
2015-04-24 22:31:39 +02:00
; ;
--partial)
PARTIAL = "yes"
; ;
--no-maxtime)
2016-08-31 11:26:21 +02:00
no_maxtime = true
2015-04-24 22:31:39 +02:00
; ;
--delete)
DELETE_VANISHED_FILES = "yes"
; ;
--dontgetsize)
2015-11-12 01:26:38 +01:00
GET_BACKUP_SIZE = "no"
2015-04-24 22:31:39 +02:00
; ;
--help| -h| --version| -v)
Usage
; ;
2016-09-08 22:51:24 +02:00
--decrypt= *)
_DECRYPT_MODE = true
DECRYPT_PATH = " ${ i ##*= } "
; ;
--passphrase= *)
PASSPHRASE = " ${ i ##*= } "
; ;
--passphrase-file= *)
PASSPHRASE_FILE = " ${ i ##*= } "
; ;
--encrypt= *)
_ENCRYPT_MODE = true
CRYPT_SOURCE = " ${ i ##*= } "
; ;
--destination= *)
CRYPT_STORAGE = " ${ i ##*= } "
; ;
--recipient= *)
GPG_RECIPIENT = " ${ i ##*= } "
; ;
2015-04-24 22:31:39 +02:00
esac
done
}
2013-07-16 23:10:27 +02:00
2016-09-08 22:51:24 +02:00
SetTraps
2015-04-24 23:41:01 +02:00
GetCommandlineArguments " $@ "
2016-09-08 22:51:24 +02:00
if [ " $_DECRYPT_MODE " = = true ] ; then
CheckCryptEnvironnment
DecryptFiles " $DECRYPT_PATH " " $PASSPHRASE_FILE " " $PASSPHRASE "
exit $?
fi
if [ " $_ENCRYPT_MODE " = = true ] ; then
CheckCryptEnvironnment
EncryptFiles " $CRYPT_SOURCE " " $CRYPT_STORAGE " " $GPG_RECIPIENT " true false
exit $?
fi
2015-11-12 01:26:38 +01:00
LoadConfigFile " $1 "
if [ " $LOGFILE " = = "" ] ; then
if [ -w /var/log ] ; then
2016-04-06 20:40:20 +02:00
LOG_FILE = " /var/log/ $PROGRAM . $INSTANCE_ID .log "
2016-08-31 11:26:21 +02:00
elif ( [ " ${ HOME } " != "" ] && [ -w " { $HOME } " ] ) ; then
LOG_FILE = " ${ HOME } / $PROGRAM . $INSTANCE_ID .log "
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
LOG_FILE = ./$PROGRAM .$INSTANCE_ID .log
2013-07-16 23:10:27 +02:00
fi
else
2015-11-12 01:26:38 +01:00
LOG_FILE = " $LOGFILE "
fi
2016-11-10 16:25:37 +01:00
if [ ! -w " $( dirname $LOG_FILE ) " ] ; then
echo " Cannot write to log [ $( dirname $LOG_FILE ) ]. "
else
Logger " Script begin, logging to [ $LOG_FILE ]. " "DEBUG"
fi
2015-11-12 01:26:38 +01:00
if [ " $IS_STABLE " != "yes" ] ; then
2016-11-10 16:25:37 +01:00
Logger " This is an unstable dev build [ $PROGRAM_BUILD ]. Please use with caution. " "WARN"
2015-11-12 01:26:38 +01:00
fi
2016-04-12 09:41:16 +02:00
DATE = $( date)
Logger "--------------------------------------------------------------------" "NOTICE"
Logger " $DRY_WARNING $DATE - $PROGRAM v $PROGRAM_VERSION $BACKUP_TYPE script begin. " "NOTICE"
Logger "--------------------------------------------------------------------" "NOTICE"
Logger " Backup instance [ $INSTANCE_ID ] launched as $LOCAL_USER @ $LOCAL_HOST (PID $SCRIPT_PID ) " "NOTICE"
2015-11-12 01:26:38 +01:00
GetLocalOS
InitLocalOSSettings
2016-03-03 16:06:27 +01:00
CheckRunningInstances
2015-11-12 01:26:38 +01:00
PreInit
Init
2016-11-10 16:25:37 +01:00
CheckEnvironment
2015-11-12 01:26:38 +01:00
PostInit
CheckCurrentConfig
2016-04-06 20:41:58 +02:00
if [ " $REMOTE_OPERATION " = = "yes" ] ; then
GetRemoteOS
InitRemoteOSSettings
fi
2016-08-31 11:26:21 +02:00
if [ $no_maxtime = = true ] ; then
2015-11-12 01:26:38 +01:00
SOFT_MAX_EXEC_TIME_DB_TASK = 0
SOFT_MAX_EXEC_TIME_FILE_TASK = 0
HARD_MAX_EXEC_TIME_DB_TASK = 0
HARD_MAX_EXEC_TIME_FILE_TASK = 0
HARD_MAX_EXEC_TIME_TOTAL = 0
fi
RunBeforeHook
Main