obackup/obackup.sh

1317 lines
40 KiB
Bash
Raw Normal View History

2015-11-12 01:26:38 +01:00
#!/usr/bin/env bash
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
###### Remote push/pull (or local) backup script for files & databases
2015-01-08 18:52:19 +01:00
###### (L) 2013-2015 by Orsiris "Ozy" de Jong (www.netpower.fr)
2015-11-12 01:26:38 +01:00
PROGRAM="obackup"
AUTHOR="(L) 2013-2015 by Orsiris de Jong"
CONTACT="http://www.netpower.fr/obackup - ozy@netpower.fr"
2015-11-12 01:26:38 +01:00
PROGRAM_VERSION=2.0-pre
PROGRAM_BUILD=2015111901
2015-11-12 01:26:38 +01:00
IS_STABLE=no
2015-11-19 23:03:18 +01:00
source "./ofunctions.sh"
2015-11-12 01:26:38 +01:00
## Working directory for partial downloads
PARTIAL_DIR=".obackup_workdir_partial"
# 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
# $FILE_SIZE_LIST, list of all directories to include in GetDirectoriesSize
CAN_BACKUP_SQL=1
CAN_BACKUP_FILES=1
function TrapStop {
Logger " /!\ WARNING: Manual exit of backup script. Backups may be in inconsistent state." "WARN"
exit 1
}
function TrapQuit {
if [ $ERROR_ALERT -ne 0 ]; then
SendAlert
CleanUp
Logger "Backup script finished with errors." "ERROR"
elif [ $WARN_ALERT -ne 0 ]; then
SendAlert
CleanUp
Logger "Backup script finished with warnings." "WARN"
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
CleanUp
Logger "Backup script finshed." "NOTICE"
2013-07-16 23:10:27 +02:00
fi
2013-09-22 12:04:09 +02:00
2015-11-12 01:26:38 +01:00
KillChilds $$ > /dev/null 2>&1
}
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"
CAN_BACKUP_SQL=0
fi
if ! type mysql > /dev/null 2>&1 ; then
Logger "mysql not present. Cannot backup SQL." "CRITICAL"
CAN_BACKUP_SQL=0
fi
fi
fi
if [ "$FILE_BACKUP" != "no" ]; then
if [ "$ENCRYPTION" == "yes" ]; then
if ! type duplicity > /dev/null 2>&1 ; then
Logger "duplicity not present. Cannot backup encrypted files." "CRITICAL"
CAN_BACKUP_FILES=0
2013-07-16 23:10:27 +02:00
fi
else
2015-11-12 01:26:38 +01:00
if ! type rsync > /dev/null 2>&1 ; then
Logger "rsync not present. Cannot backup files." "CRITICAL"
CAN_BACKUP_FILES=0
fi
2013-07-16 23:10:27 +02:00
fi
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"
declare -a yes_no_vars=(SQL_BACKUP FILE_BACKUP ENCRYPTION CREATE_DIRS KEEP_ABSOLUTE_PATHS GET_BACKUP_SIZE SUDO_EXEC SSH_COMPRESSION REMOTE_HOST_PING DATABASES_ALL 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)
for i in ${yes_no_vars[@]}; do
test="if [ \"\$$i\" != \"yes\" ] && [ \"\$$i\" != \"no\" ]; then Logger \"Bogus $i value defined in config file.\" \"CRITICAL\"; exit 1; fi"
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
declare -a num_vars=(BACKUP_SIZE_MINIMUM BANDWIDTH 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 SOFT_MAX_EXEC_TIME_TOTAL HARD_MAX_EXEC_TIME_TOTAL ROTATE_SQL_COPIES ROTATE_FILE_COPIES MAX_EXEC_TIME_PER_CMD_BEFORE MAX_EXEC_TIME_PER_CMD_AFTER)
2015-11-12 01:26:38 +01:00
for i in ${num_vars[@]}; do
test="if [ $(IsNumeric \"\$$i\") -eq 0 ]; then Logger \"Bogus $i value defined in config file.\" \"CRITICAL\"; exit 1; fi"
eval "$test"
done
#TODO-v2.1: Add runtime variable tests (RSYNC_ARGS etc)
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function _ListDatabasesLocal {
sql_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.$SCRIPT_PID 2>&1"
Logger "cmd: $sql_cmd" "DEBUG"
eval "$sql_cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
if [ $? -eq 0 ]; then
Logger "Listing databases succeeded." "NOTICE"
else
Logger "Listing databases failed." "ERROR"
if [ -f "$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID" ]; then
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
fi
return 1
fi
}
function _ListDatabasesRemote {
2013-07-16 23:10:27 +02:00
CheckConnectivity3rdPartyHosts
2015-11-12 01:26:38 +01:00
CheckConnectivityRemoteHost
sql_cmd="$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.$SCRIPT_PID\" 2>&1"
Logger "cmd: $sql_cmd" "DEBUG"
eval "$sql_cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
if [ $? -eq 0 ]; then
Logger "Listing databases succeeded." "NOTICE"
else
Logger "Listing databases failed." "ERROR"
if [ -f "$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID" ]; then
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$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 {
local output_file # Return of subfunction
if [ $CAN_BACKUP_SQL -ne 1 ]; then
Logger "Cannot list databases." "ERROR"
return 1
fi
Logger "Listing databases." "NOTICE"
if [ "$BACKUP_TYPE" == "local" ] || [ "$BACKUP_TYPE" == "push" ]; then
_ListDatabasesLocal
if [ $? != 0 ]; then
output_file=""
else
output_file="$RUN_DIR/$PROGRAM._ListDatabasesLocal.$SCRIPT_PID"
fi
elif [ "$BACKUP_TYPE" == "pull" ]; then
_ListDatabasesRemote
if [ $? != 0 ]; then
output_file=""
else
output_file="$RUN_DIR/$PROGRAM._ListDatabasesRemote.$SCRIPT_PID"
2013-07-16 23:10:27 +02:00
fi
fi
2013-11-02 18:55:17 +01:00
2015-11-12 01:26:38 +01:00
if [ -f "$output_file" ] && [ $CAN_BACKUP_SQL -eq 1 ]; then
OLD_IFS=$IFS
IFS=$' \n'
for line in $(cat "$output_file")
do
db_name=$(echo $line | cut -f1)
db_size=$(echo $line | cut -f2)
if [ "$DATABASES_ALL" == "yes" ]; then
db_backup=1
IFS=$PATH_SEPARATOR_CHAR
for j in $DATABASES_ALL_EXCLUDE_LIST
do
if [ "$db_name" == "$j" ]; then
db_backup=0
fi
done
IFS=$' \n'
else
db_backup=0
IFS=$PATH_SEPARATOR_CHAR
for j in $DATABASES_LIST
do
if [ "$db_name" == "$j" ]; then
db_backup=1
fi
done
IFS=$' \n'
fi
if [ $db_backup -eq 1 ]; then
if [ "$SQL_BACKUP_TASKS" != "" ]; then
SQL_BACKUP_TASKS="$SQL_BACKUP_TASKS $db_name"
else
SQL_BACKUP_TASKS="$db_name"
fi
TOTAL_DATABASES_SIZE=$((TOTAL_DATABASES_SIZE+$db_size))
else
SQL_EXCLUDED_TASKS="$SQL_EXCLUDED_TASKS $db_name"
fi
done
IFS=$OLD_IFS
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"
CAN_BACKUP_SQL=0
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 {
OLD_IFS=$IFS
2015-11-12 01:26:38 +01:00
IFS=$PATH_SEPARATOR_CHAR
for directory in $RECURSIVE_DIRECTORY_LIST
2013-07-16 23:10:27 +02:00
do
# No sudo here, assuming you should have all necessary rights for local checks
cmd="$FIND_CMD -L $directory/ -mindepth 1 -maxdepth 1 -type d >> $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID 2> $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID"
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK $FUNCNAME
if [ $? != 0 ]; then
Logger "Could not enumerate directories in [$directory]." "ERROR"
if [ -f $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID ]; then
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
fi
if [ -f $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID)" "ERROR"
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
IFS=$OLD_IFS
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 {
2013-07-16 23:10:27 +02:00
OLD_IFS=$IFS
IFS=$PATH_SEPARATOR_CHAR
2015-11-12 01:26:38 +01:00
for directory in $RECURSIVE_DIRECTORY_LIST
2013-07-16 23:10:27 +02:00
do
2015-11-12 01:26:38 +01:00
cmd=$SSH_CMD' "'$COMMAND_SUDO' '$FIND_CMD' -L '$directory'/ -mindepth 1 -maxdepth 1 -type d" >> '$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID' 2> '$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK $FUNCNAME
if [ $? != 0 ]; then
Logger "Could not enumerate directories in [$directory]." "ERROR"
if [ -f $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID ]; then
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
fi
if [ -f $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.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
IFS=$OLD_IFS
return $retval
}
function ListRecursiveBackupDirectories {
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
2013-09-22 12:04:09 +02:00
OLD_IFS=$IFS
IFS=$' \n'
2015-11-12 01:26:38 +01:00
for line in $(cat "$output_file")
2013-07-16 23:10:27 +02:00
do
file_exclude=0
IFS=$PATH_SEPARATOR_CHAR
2015-11-12 01:26:38 +01:00
for k in $RECURSIVE_EXCLUDE_LIST
2013-07-16 23:10:27 +02:00
do
2015-11-12 01:26:38 +01:00
if [ "$k" == "$line" ]; then
2013-07-16 23:10:27 +02:00
file_exclude=1
fi
done
IFS=$' \n'
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
FILE_RECURSIVE_BACKUP_TASKS="$line"
FILE_SIZE_LIST="$(EscapeSpaces $line)"
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
FILE_RECURSIVE_BACKUP_TASKS="$FILE_RECURSIVE_BACKUP_TASKS$PATH_SEPARATOR_CHAR$line"
FILE_SIZE_LIST="$FILE_SIZE_LIST $(EscapeSpaces $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
2013-09-22 12:04:09 +02:00
done
2015-11-12 01:26:38 +01:00
IFS=$OLD_IFS
fi
OLD_IFS=$IFS
IFS=$PATH_SEPARATOR_CHAR
for directory in $DIRECTORY_LIST
do
2015-11-15 14:47:20 +01:00
FILE_SIZE_LIST="$FILE_SIZE_LIST $(EscapeSpaces $directory)"
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
IFS=$OLD_IFS
}
function _GetDirectoriesSizeLocal {
local dir_list="${1}"
# No sudo here, assuming you should have all the necessary rights
cmd='echo "'$dir_list'" | xargs du -cs | tail -n1 | cut -f1 > '$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID 2> $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK $FUNCNAME
# $cmd will return 0 even if some errors found, so we need to check if there is an error output
if [ $? != 0 ] || [ -s $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID ]; then
Logger "Could not get files size for some or all directories." "ERROR"
if [ -f "$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID" ]; then
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
fi
if [ -f "$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID" ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID)" "ERROR"
fi
else
Logger "File size fetched successfully." "NOTICE"
fi
if [ -s "$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID" ]; then
TOTAL_FILES_SIZE="$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)"
else
TOTAL_FILES_SIZE=-1
fi
}
function _GetDirectoriesSizeRemote {
local dir_list="${1}"
# Error output is different from stdout because not all files in list may fail at once
cmd=$SSH_CMD' "echo '$dir_list' | xargs '$COMMAND_SUDO' du -cs | tail -n1 | cut -f1" > '$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID' 2> '$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK $FUNCNAME
# $cmd will return 0 even if some errors found, so we need to check if there is an error output
if [ $? != 0 ] || [ -s $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID ]; then
Logger "Could not get files size for some or all directories." "ERROR"
if [ -f "$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID" ]; then
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
fi
if [ -f "$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID" ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID)" "ERROR"
fi
else
Logger "File size fetched successfully." "NOTICE"
fi
if [ -s "$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID" ]; then
TOTAL_FILES_SIZE="$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)"
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
_GetDirectoriesSizeLocal "$FILE_SIZE_LIST"
fi
elif [ "$BACKUP_TYPE" == "pull" ]; then
if [ "$FILE_BACKUP" != "no" ]; then
_GetDirectoriesSizeRemote "$FILE_SIZE_LIST"
fi
fi
}
function _CreateDirectoryLocal {
2015-11-12 01:26:38 +01:00
local dir_to_create="${1}"
if [ ! -d "$dir_to_create" ]; then
# No sudo, you should have all necessary rights
mkdir -p "$dir_to_create" > $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID 2>&1
2015-11-12 01:26:38 +01:00
if [ $? != 0 ]; then
Logger "Cannot create directory [$dir_to_create]" "CRITICAL"
if [ -f $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID ]; then
Logger "Command output: $(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
fi
return 1
fi
fi
}
function _CreateDirectoryRemote {
2015-11-12 01:26:38 +01:00
local dir_to_create="${1}"
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
cmd=$SSH_CMD' "if ! [ -d \"'$dir_to_create'\" ]; then '$COMMAND_SUDO' mkdir -p \"'$dir_to_create'\"; fi" > '$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID' 2>&1'
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! 720 1800 $FUNCNAME
if [ $? != 0 ]; then
Logger "Cannot create remote directory [$dir_to_create]." "CRITICAL"
Logger "Command output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
return 1
fi
}
function CreateStorageDirectories {
if [ "$BACKUP_TYPE" == "local" ] || [ "$BACKUP_TYPE" == "pull" ]; then
if [ "$SQL_BACKUP" != "no" ]; then
_CreateDirectoryLocal "$SQL_STORAGE"
2015-11-12 01:26:38 +01:00
if [ $? != 0 ]; then
CAN_BACKUP_SQL=0
fi
fi
if [ "$FILE_BACKUP" != "no" ]; then
_CreateDirectoryLocal "$FILE_STORAGE"
2015-11-12 01:26:38 +01:00
if [ $? != 0 ]; then
CAN_BACKUP_FILES=0
fi
fi
elif [ "$BACKUP_TYPE" == "push" ]; then
if [ "$SQL_BACKUP" != "no" ]; then
_CreateDirectoryRemote "$SQL_STORAGE"
2015-11-12 01:26:38 +01:00
if [ $? != 0 ]; then
CAN_BACKUP_SQL=0
fi
fi
if [ "$FILE_BACKUP" != "no" ]; then
_CreateDirectoryRemote "$FILE_STORAGE"
2015-11-12 01:26:38 +01:00
if [ $? != 0 ]; then
CAN_BACKUP_FILES=0
fi
fi
fi
}
function GetDiskSpaceLocal {
# GLOBAL VARIABLE DISK_SPACE to pass variable to parent function
# GLOBAL VARIABLE DRIVE to pass variable to parent function
local path_to_check="${1}"
if [ -w "$path_to_check" ]; then
# Not elegant solution to make df silent on errors
# No sudo on local commands, assuming you should have all the necesarry rights to check backup directories sizes
df -P "$path_to_check" > "$RUN_DIR/$PROGRAM.$FUNCNAME.$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"
Logger "Command Output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
else
DISK_SPACE=$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID | tail -1 | awk '{print $4}')
DRIVE=$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID | tail -1 | awk '{print $1}')
fi
else
Logger "Storage path [$path_to_check] does not exist or cannot write to it." "CRITICAL"
return 1
fi
}
function GetDiskSpaceRemote {
# USE GLOBAL VARIABLE DISK_SPACE to pass variable to parent function
local path_to_check="${1}"
cmd=$SSH_CMD' "if [ -w \"'$path_to_check'\" ]; then '$COMMAND_SUDO' df -P \"'$path_to_check'\"; else exit 1; fi" > "'$RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID'" 2>&1'
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
if [ $? != 0 ]; then
DISK_SPACE=0
Logger "Cannot get disk space in [$path_to_check] on remote system." "ERROR"
Logger "Command Output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
return 1
else
DISK_SPACE=$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID | tail -1 | awk '{print $4}')
DRIVE=$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID | tail -1 | awk '{print $1}')
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
CAN_BACKUP_SQL=0
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
CAN_BACKUP_FILES=0
else
FILE_DISK_SPACE=$DISK_SPACE
FILE_DRIVE=$DRIVE
fi
fi
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
fi
if [ "$TOTAL_DATABASES_SIZE" == "" ]; then
TOTAL_DATABASES_SIZE=-1
fi
if [ "$TOTAL_FILES_SIZE" == "" ]; then
TOTAL_FILES_SIZE=-1
fi
if [ "$SQL_BACKUP" != "no" ] && [ $CAN_BACKUP_SQL -eq 1 ]; then
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
if [ "$FILE_BACKUP" != "no" ] && [ $CAN_BACKUP_FILES -eq 1 ]; then
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
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
local export_options="${2}" # export options
local dry_sql_cmd="mysqldump -u $SQL_USER $export_options --database $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS > /dev/null 2> $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID"
local sql_cmd="mysqldump -u $SQL_USER $export_options --database $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS > $SQL_STORAGE/$database.sql$COMPRESSION_EXTENSION 2> $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID"
if [ $_DRYRUN -ne 1 ]; then
Logger "cmd: $sql_cmd" "DEBUG"
eval "$sql_cmd" &
else
Logger "cmd: $dry_sql_cmd" "DEBUG"
eval "$dry_sql_cmd" &
fi
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
local retval=$?
if [ -s "$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID" ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID)" "ERROR"
fi
return $retval
}
function _BackupDatabaseLocalToRemote {
local database="${1}" # Database to backup
local export_options="${2}" # export options
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
#TODO-v2.0: cannot catch mysqldump warnings
local dry_sql_cmd="mysqldump -u $SQL_USER $export_options --database $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS > /dev/null 2> $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID"
local sql_cmd="mysqldump -u $SQL_USER $export_options --database $database $COMPRESSION_PROGRAM $COMPRESSION_OPTIONS | $SSH_CMD '$COMMAND_SUDO tee \"$SQL_STORAGE/$database.sql$COMPRESSION_EXTENSION\" > /dev/null' 2> $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID"
if [ $_DRYRUN -ne 1 ]; then
Logger "cmd: $sql_cmd" "DEBUG"
eval "$sql_cmd" &
else
Logger "cmd: $dry_sql_cmd" "DEBUG"
eval "$dry_sql_cmd" &
fi
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
local retval=$?
if [ -s "$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID" ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID)" "ERROR"
fi
return $retval
}
function _BackupDatabaseRemoteToLocal {
local database="${1}" # Database to backup
local export_options="${2}" # export options
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
local dry_sql_cmd=$SSH_CMD' "mysqldump -u '$SQL_USER' '$export_options' --database '$database' '$COMPRESSION_PROGRAM' '$COMPRESSION_OPTIONS'" > /dev/null 2> "'$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID'"'
local sql_cmd=$SSH_CMD' "mysqldump -u '$SQL_USER' '$export_options' --database '$database' '$COMPRESSION_PROGRAM' '$COMPRESSION_OPTIONS'" > "'$SQL_STORAGE/$database.sql$COMPRESSION_EXTENSION'" 2> "'$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID'"'
if [ $_DRYRUN -ne 1 ]; then
Logger "cmd: $sql_cmd" "DEBUG"
eval "$sql_cmd" &
else
Logger "cmd: $dry_sql_cmd" "DEBUG"
eval "$dry_sql_cmd" &
fi
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
local retval=$?
if [ -s "$RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID" ]; then
Logger "Error output:\n$(cat $RUN_DIR/$PROGRAM.$FUNCNAME.error.$SCRIPT_PID)" "ERROR"
fi
return $retval
}
function BackupDatabase {
local database="${1}"
# Hack to prevent warning on table mysql.events, some mysql versions don't support --skip-events, prefer using --ignore-table
if [ "$database" == "mysql" ]; then
local mysql_options='--skip-lock-tables --single-transaction --ignore-table=mysql.event'
else
local mysql_options='--skip-lock-tables --single-transaction'
fi
if [ "$BACKUP_TYPE" == "local" ]; then
_BackupDatabaseLocalToLocal "$database" "$mysql_options"
elif [ "$BACKUP_TYPE" == "pull" ]; then
_BackupDatabaseRemoteToLocal "$database" "$mysql_options"
elif [ "$BACKUP_TYPE" == "push" ]; then
_BackupDatabaseLocalToRemote "$database" "$mysql_options"
fi
if [ $? -ne 0 ]; then
Logger "Backup failed." "ERROR"
else
Logger "Backup succeeded." "NOTICE"
fi
}
function BackupDatabases {
local database
OLD_IFS=$IFS
IFS=$' \t\n'
for database in $SQL_BACKUP_TASKS
do
Logger "Backing up database [$database]." "NOTICE"
BackupDatabase $database &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_DB_TASK $HARD_MAX_EXEC_TIME_DB_TASK $FUNCNAME
CheckTotalExecutionTime
done
IFS=$OLD_IFS
}
function Rsync {
local backup_directory="${1}" # Which directory to backup
local is_recursive="${2}" # Backup only files at toplevel of directory
if [ "$KEEP_ABSOLUTE_PATHS" == "yes" ]; then
local file_storage_path="$(dirname $FILE_STORAGE$backup_directory)"
else
local file_storage_path="$FILE_STORAGE"
fi
## Manage to backup recursive directories lists files only (not recursing into subdirectories)
if [ "$is_recursive" == "no-recurse" ]; then
# 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
# Creating subdirectories because rsync cannot handle multiple subdirectory creation
2015-11-12 01:26:38 +01:00
if [ "$BACKUP_TYPE" == "local" ]; then
_CreateDirectoryLocal "$file_storage_path/$backup_directory"
2015-11-12 01:26:38 +01:00
rsync_cmd="$(type -p $RSYNC_EXECUTABLE) $RSYNC_ARGS $RSYNC_NO_RECURSE_ARGS --stats $RSYNC_DELETE $RSYNC_EXCLUDE --rsync-path=\"$RSYNC_PATH\" \"$backup_directory\" \"$file_storage_path\" > $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID 2>&1"
elif [ "$BACKUP_TYPE" == "pull" ]; then
_CreateDirectoryLocal "$file_storage_path/$backup_directory"
2015-11-12 01:26:38 +01:00
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
rsync_cmd="$(type -p $RSYNC_EXECUTABLE) $RSYNC_ARGS $RSYNC_NO_RECURSE_ARGS --stats $RSYNC_DELETE $RSYNC_EXCLUDE --rsync-path=\"$RSYNC_PATH\" -e \"$RSYNC_SSH_CMD\" \"$REMOTE_USER@$REMOTE_HOST:$backup_directory\" \"$file_storage_path\" > $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID 2>&1"
elif [ "$BACKUP_TYPE" == "push" ]; then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
_CreateDirectoryRemote "$file_storage_path/$backup_directory"
2015-11-12 01:26:38 +01:00
rsync_cmd="$(type -p $RSYNC_EXECUTABLE) $RSYNC_ARGS $RSYNC_NO_RECURSE_ARGS --stats $RSYNC_DELETE $RSYNC_EXCLUDE --rsync-path=\"$RSYNC_PATH\" -e \"$RSYNC_SSH_CMD\" \"$backup_directory\" \"$REMOTE_USER@$REMOTE_HOST:$file_storage_path\" > $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID 2>&1"
fi
Logger "cmd: $rsync_cmd" "DEBUG"
eval "$rsync_cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK $FUNCNAME
if [ $? != 0 ]; then
Logger "Failed to backup [$backup_directory] to [$file_storage_path]." "ERROR"
Logger "Command output:\n $(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
else
Logger "File backup succeed." "NOTICE"
fi
}
function Duplicity {
local backup_directory="${1}" # Which directory to backup
local is_recursive="${2}" # Backup only files at toplevel of directory
Logger "Encrpytion not supported yet ! No backup done." "CRITICAL"
return 1
if [ "$KEEP_ABSOLUTE_PATHS" == "yes" ]; then
local file_storage_path="$(dirname $FILE_STORAGE$backup_directory)"
else
local file_storage_path="$FILE_STORAGE"
fi
if [ "$BACKUP_TYPE" == "local" ]; then
duplicity_cmd=""
elif [ "$BACKUP_TYPE" == "pull" ]; then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
duplicity_cmd=""
elif [ "$BACKUP_TYPE" == "push" ]; then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
duplicity_cmd=""
fi
Logger "cmd: $duplicity_cmd" "DEBUG"
eval "$duplicity_cmd" &
WaitForTaskCompletion $! $SOFT_MAX_EXEC_TIME_FILE_TASK $HARD_MAX_EXEC_TIME_FILE_TASK $FUNCNAME
if [ $? != 0 ]; then
Logger "Failed to backup [$backup_directory] to [$file_storage_path]." "ERROR"
Logger "Command output:\n $(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
else
Logger "File backup succeed." "NOTICE"
fi
}
function FilesBackup {
OLD_IFS=$IFS
IFS=$PATH_SEPARATOR_CHAR
# Backup non recursive directories
for BACKUP_TASK in $FILE_BACKUP_TASKS
do
Logger "Beginning file backup of [$BACKUP_TASK]." "NOTICE"
if [ "$ENCRYPTION" == "yes" ]; then
Duplicity "$BACKUP_TASK" "recurse"
else
Rsync "$BACKUP_TASK" "recurse"
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
2015-11-12 01:26:38 +01:00
## Backup files at root of DIRECTORIES_RECURSE_LIST directories
for BACKUP_TASK in $RECURSIVE_DIRECTORY_LIST
2013-07-16 23:10:27 +02:00
do
2015-11-12 01:26:38 +01:00
Logger "Beginning non recursive file backup of [$BACKUP_TASK]." "NOTICE"
if [ "$ENCRYPTION" == "yes" ]; then
Duplicity "$BACKUP_TASK" "no-recurse"
2013-07-16 23:10:27 +02:00
else
2015-11-12 01:26:38 +01:00
Rsync "$BACKUP_TASK" "no-recurse"
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
2015-11-12 01:26:38 +01:00
# Backup sub directories of recursive directories
for BACKUP_TASK in $FILE_RECURSIVE_BACKUP_TASKS
do
Logger "Beginning recursive file backup of [$BACKUP_TASK]." "NOTICE"
if [ "$ENCRYPTION" == "yes" ]; then
Duplicity "$BACKUP_TASK" "recurse"
else
Rsync "$BACKUP_TASK" "recurse"
fi
CheckTotalExecutionTime
done
2013-07-16 23:10:27 +02:00
IFS=$OLD_IFS
}
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
Logger "Max soft execution time of the whole backup exceeded while backing up [$BACKUP_TASK]." "ERROR"
WARN_ALERT=1
SendAlert
if [ $SECONDS -gt $HARD_MAX_EXEC_TIME_TOTAL ] && [ $HARD_MAX_EXEC_TIME_TOTAL -ne 0 ]; then
Logger "Max hard execution time of the whole backup exceeded while backing up [$BACKUP_TASK], stopping backup process." "CRITICAL"
exit 1
2013-07-16 23:10:27 +02:00
fi
fi
}
2015-11-12 01:26:38 +01:00
function RsyncExcludePattern {
# Disable globbing so wildcards from exclusions do not get expanded
set -f
2015-11-12 01:26:38 +01:00
rest="$RSYNC_EXCLUDE_PATTERN"
while [ -n "$rest" ]
do
# Take the string until first occurence until $PATH_SEPARATOR_CHAR
str=${rest%%;*}
# 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
2015-04-03 12:21:33 +02:00
2015-11-12 01:26:38 +01:00
if [ "$RSYNC_EXCLUDE" == "" ]; then
RSYNC_EXCLUDE="--exclude=\"$str\""
else
RSYNC_EXCLUDE="$RSYNC_EXCLUDE --exclude=\"$str\""
fi
done
set +f
2013-07-16 23:10:27 +02:00
}
2015-11-12 01:26:38 +01:00
function RsyncExcludeFrom {
2013-11-02 18:55:17 +01:00
2015-11-12 01:26:38 +01:00
if [ ! $RSYNC_EXCLUDE_FROM == "" ]; then
## Check if the exclude list has a full path, and if not, add the config file path if there is one
if [ "$(basename $RSYNC_EXCLUDE_FROM)" == "$RSYNC_EXCLUDE_FROM" ]; then
RSYNC_EXCLUDE_FROM=$(dirname $ConfigFile)/$RSYNC_EXCLUDE_FROM
fi
2013-07-16 23:10:27 +02:00
2015-11-12 01:26:38 +01:00
if [ -e $RSYNC_EXCLUDE_FROM ]; then
RSYNC_EXCLUDE="$RSYNC_EXCLUDE --exclude-from=\"$RSYNC_EXCLUDE_FROM\""
2013-07-16 23:10:27 +02:00
fi
fi
}
2015-11-12 01:26:38 +01:00
function _RotateBackupsLocal {
local backup_path="${1}"
local rotate_copies="${2}"
2015-11-12 01:26:38 +01:00
2013-07-16 23:10:27 +02:00
OLD_IFS=$IFS
2015-11-12 01:26:38 +01:00
IFS=$'\t\n'
for backup in $(ls -I "*.$PROGRAM.*" "$backup_path")
2013-07-16 23:10:27 +02:00
do
copy=$rotate_copies
2015-11-12 01:26:38 +01:00
while [ $copy -gt 1 ]
do
if [ $copy -eq $rotate_copies ]; then
cmd="rm -rf \"$backup_path/$backup.$PROGRAM.$copy\""
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! 720 0 $FUNCNAME
if [ $? != 0 ]; then
Logger "Cannot delete oldest copy [$backup_path/$backup.$PROGRAM.$copy]." "ERROR"
fi
fi
path="$backup_path/$backup.$PROGRAM.$(($copy-1))"
if [[ -f $path || -d $path ]]; then
cmd="mv \"$path\" \"$backup_path/$backup.$PROGRAM.$copy\""
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! 720 0 $FUNCNAME
if [ $? != 0 ]; then
Logger "Cannot move [$path] to [$backup_path/$backup.$PROGRAM.$copy]." "ERROR"
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
cmd="mv \"$backup_path/$backup\" \"$backup_path/$backup.$PROGRAM.1\""
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! 720 0 $FUNCNAME
if [ $? != 0 ]; then
Logger "Cannot move [$backup_path/$backup] to [$backup_path/$backup.$PROGRAM.1]." "ERROR"
fi
2013-08-25 12:39:13 +02:00
2015-11-12 01:26:38 +01:00
elif [ "$REMOTE_OPERATION" == "yes" ]; then
cmd="cp -R \"$backup_path/$backup\" \"$backup_path/$backup.$PROGRAM.1\""
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! 720 0 $FUNCNAME
if [ $? != 0 ]; then
Logger "Cannot copy [$backup_path/$backup] to [$backup_path/$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
cmd="mv \"$backup_path/$backup\" \"$backup_path/$backup.$PROGRAM.1\""
2015-11-12 01:26:38 +01:00
Logger "cmd: $cmd" "DEBUG"
eval "$cmd" &
WaitForTaskCompletion $! 720 0 $FUNCNAME
if [ $? != 0 ]; then
Logger "Cannot move [$backup_path/$backup] to [$backup_path/$backup.$PROGRAM.1]." "ERROR"
fi
fi
done
2013-07-16 23:10:27 +02:00
IFS=$OLD_IFS
}
2015-11-12 01:26:38 +01:00
function _RotateBackupsRemote {
local backup_path="${1}"
local rotate_copies="${2}"
$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.$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 {
OLD_IFS=$IFS
IFS=$'\t\n'
2015-11-12 01:26:38 +01:00
for backup in $(ls -I "*.$PROGRAM.*" "$backup_path")
2013-07-16 23:10:27 +02:00
do
copy=$rotate_copies
2013-07-16 23:10:27 +02:00
while [ $copy -gt 1 ]
do
if [ $copy -eq $rotate_copies ]; then
2015-11-12 01:26:38 +01:00
cmd="$COMMAND_SUDO rm -rf \"$backup_path/$backup.$PROGRAM.$copy\""
RemoteLogger "cmd: $cmd" "DEBUG"
eval "$cmd"
if [ $? != 0 ]; then
RemoteLogger "Cannot delete oldest copy [$backup_path/$backup.$PROGRAM.$copy]." "ERROR"
fi
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01:00
path="$backup_path/$backup.$PROGRAM.$(($copy-1))"
if [[ -f $path || -d $path ]]; then
cmd="$COMMAND_SUDO mv \"$path\" \"$backup_path/$backup.$PROGRAM.$copy\""
RemoteLogger "cmd: $cmd" "DEBUG"
eval "$cmd"
if [ $? != 0 ]; then
RemoteLogger "Cannot move [$path] to [$backup_path/$backup.$PROGRAM.$copy]." "ERROR"
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
cmd="$COMMAND_SUDO mv \"$backup_path/$backup\" \"$backup_path/$backup.$PROGRAM.1\""
RemoteLogger "cmd: $cmd" "DEBUG"
eval "$cmd"
if [ $? != 0 ]; then
RemoteLogger "Cannot move [$backup_path/$backup] to [$backup_path/$backup.$PROGRAM.1]." "ERROR"
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
elif [ "$REMOTE_OPERATION" == "yes" ]; then
cmd="$COMMAND_SUDO cp -R \"$backup_path/$backup\" \"$backup_path/$backup.$PROGRAM.1\""
RemoteLogger "cmd: $cmd" "DEBUG"
eval "$cmd"
if [ $? != 0 ]; then
RemoteLogger "Cannot copy [$backup_path/$backup] to [$backup_path/$backup.$PROGRAM.1]." "ERROR"
fi
2014-09-22 22:45:18 +02:00
2015-11-12 01:26:38 +01:00
else
cmd="$COMMAND_SUDO mv \"$backup_path/$backup\" \"$backup_path/$backup.$PROGRAM.1\""
RemoteLogger "cmd: $cmd" "DEBUG"
eval "$cmd"
if [ $? != 0 ]; then
RemoteLogger "Cannot move [$backup_path/$backup] to [$backup_path/$backup.$PROGRAM.1]." "ERROR"
fi
2013-07-16 23:10:27 +02:00
fi
done
IFS=$OLD_IFS
2013-07-16 23:10:27 +02:00
}
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
WaitForTaskCompletion $! 1800 0 $FUNCNAME
if [ $? != 0 ]; then
Logger "Could not rotate backups in [$backup_path]." "ERROR"
Logger "Command output:\n $(cat $RUN_DIR/$PROGRAM.$FUNCNAME.$SCRIPT_PID)" "ERROR"
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}"
local rotate_copies="${2}"
2015-11-12 01:26:38 +01:00
Logger "Rotating backups." "NOTICE"
if [ "$BACKUP_TYPE" == "local" ] || [ "$BACKUP_TYPE" == "pull" ]; then
_RotateBackupsLocal "$backup_path" "$rotate_copies"
2015-11-12 01:26:38 +01:00
elif [ "$BACKUP_TYPE" == "push" ]; then
_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
2015-11-12 01:26:38 +01:00
function Init {
2013-09-22 12:04:09 +02:00
2015-11-12 01:26:38 +01:00
trap TrapStop SIGINT SIGQUIT SIGKILL SIGTERM SIGHUP
trap TrapQuit EXIT
2013-07-20 14:48:06 +02:00
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
SSH_RSA_PRIVATE_KEY=~/.ssh/id_rsa
fi
# remove everything before '@'
_hosturiandpath=${uri#*@}
# remove everything after first '/'
_hosturi=${_hosturiandpath%%/*}
if [[ "$_hosturi" == *":"* ]]; then
REMOTE_PORT=${_hosturi##*:}
else
REMOTE_PORT=22
fi
REMOTE_HOST=${_hosturi%%:*}
fi
## Add update to default RSYNC_ARGS
RSYNC_ARGS=$RSYNC_ARGS"u"
if [ $_VERBOSE -eq 1 ]; then
2013-08-18 11:58:55 +02:00
RSYNC_ARGS=$RSYNC_ARGS"i"
fi
2015-11-12 01:26:38 +01:00
if [ "$PARTIAL" == "yes" ]; then
RSYNC_ARGS=$RSYNC_ARGS" --partial --partial-dir=\"$PARTIAL_DIR\""
RSYNC_EXCLUDE="$RSYNC_EXCLUDE --exclude=\"$PARTIAL_DIR\""
fi
2014-11-27 14:40:30 +01:00
2015-11-12 01:26:38 +01:00
if [ "$DELETE_VANISHED_FILES" == "yes" ]; then
RSYNC_ARGS=$RSYNC_ARGS" --delete"
2015-01-08 17:16:57 +01:00
fi
2015-11-12 01:26:38 +01:00
if [ "$DELTA_COPIES" != "no" ]; then
RSYNC_ARGS=$RSYNC_ARGS" --no-whole-file"
else
RSYNC_ARGS=$RSYNC_ARGS" --whole-file"
fi
2015-11-12 01:26:38 +01:00
if [ $stats -eq 1 ]; then
RSYNC_ARGS=$RSYNC_ARGS" --stats"
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
2015-11-12 01:26:38 +01:00
if [ "$SQL_BACKUP" != "no" ] && [ $CAN_BACKUP_SQL -eq 1 ]; then
2013-07-16 23:10:27 +02:00
ListDatabases
fi
2015-11-12 01:26:38 +01:00
if [ "$FILE_BACKUP" != "no" ] && [ $CAN_BACKUP_FILES -eq 1 ]; then
ListRecursiveBackupDirectories
if [ "$GET_BACKUP_SIZE" != "no" ]; then
GetDirectoriesSize
2015-11-12 01:26:38 +01:00
else
TOTAL_FILE_SIZE=0
fi
2013-07-16 23:10:27 +02:00
fi
2013-08-24 19:41:18 +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
2015-11-12 01:26:38 +01:00
if [ "$SQL_BACKUP" != "no" ] && [ $CAN_BACKUP_SQL -eq 1 ]; then
if [ $_DRYRUN -ne 1 ] && [ "$ROTATE_SQL_BACKUPS" == "yes" ]; then
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
2015-11-12 01:26:38 +01:00
if [ "$FILE_BACKUP" != "no" ] && [ $CAN_BACKUP_FILES -eq 1 ]; then
if [ $_DRYRUN -ne 1 ] && [ "$ROTATE_FILE_BACKUPS" == "yes" ]; then
RotateBackups "$FILE_STORAGE" "$ROTATE_FILE_COPIES"
2013-07-16 23:10:27 +02:00
fi
## Add Rsync exclude patterns
2015-11-12 01:26:38 +01:00
RsyncExcludePattern
## Add Rsync exclude from file
RsyncExcludeFrom
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 ""
2015-11-12 01:26:38 +01:00
echo "usage: obackup.sh /path/to/backup.conf [OPTIONS]"
2013-07-16 23:10:27 +02:00
echo ""
2015-11-12 01:26:38 +01:00
echo "OPTIONS:"
2013-07-16 23:10:27 +02: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"
2013-07-21 21:42:00 +02:00
echo "--verbose: adds command outputs"
2015-11-12 01:26:38 +01:00
echo "--stats Adds rsync transfer statistics to verbose output"
echo "--partial Allows rsync to keep partial downloads that can be resumed later (experimental)"
2015-01-08 17:16:57 +01:00
echo "--no-maxtime disables any soft and hard execution time checks"
echo "--delete Deletes files on destination that vanished on source"
2015-11-12 01:26:38 +01:00
echo "--dontgetsize Does not try to evaluate backup size"
2013-07-16 23:10:27 +02:00
exit 128
}
# Command line argument flags
2015-11-12 01:26:38 +01:00
_DRYRUN=0
_SILENT=0
no_maxtime=0
2015-11-12 01:26:38 +01:00
dontgetsize=0
stats=0
PARTIAL=0
2015-11-12 01:26:38 +01:00
function GetCommandlineArguments {
if [ $# -eq 0 ]; then
2013-07-16 23:10:27 +02:00
Usage
fi
for i in "$@"
do
case $i in
--dry)
2015-11-12 01:26:38 +01:00
_DRYRUN=1
;;
--silent)
2015-11-12 01:26:38 +01:00
_SILENT=1
;;
--verbose)
2015-11-12 01:26:38 +01:00
_VERBOSE=1
;;
--stats)
stats=1
;;
--partial)
PARTIAL="yes"
;;
--no-maxtime)
no_maxtime=1
;;
--delete)
DELETE_VANISHED_FILES="yes"
;;
--dontgetsize)
2015-11-12 01:26:38 +01:00
GET_BACKUP_SIZE="no"
;;
--help|-h|--version|-v)
Usage
;;
esac
done
}
2013-07-16 23:10:27 +02:00
GetCommandlineArguments "$@"
2013-07-16 23:10:27 +02:00
CheckEnvironment
2015-11-12 01:26:38 +01:00
LoadConfigFile "$1"
if [ "$LOGFILE" == "" ]; then
if [ -w /var/log ]; then
LOG_FILE=/var/log/$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
if [ "$IS_STABLE" != "yes" ]; then
Logger "This is an unstable dev build. Please use with caution." "WARN"
fi
GetLocalOS
InitLocalOSSettings
PreInit
Init
PostInit
CheckCurrentConfig
if [ "$REMOTE_OPERATION" == "yes" ]; then
GetRemoteOS
InitRemoteOSSettings
2013-07-16 23:10:27 +02:00
fi
2015-11-12 01:26:38 +01: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"
if [ $no_maxtime -eq 1 ]; then
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
RunAfterHook