#!/bin/bash
PROGRAM = "Osync" # Rsync based two way sync engine with fault tolerance
AUTHOR = "(L) 2013-2014 by Orsiris \"Ozy\" de Jong"
CONTACT = "http://www.netpower.fr/osync - ozy@netpower.fr"
PROGRAM_VERSION = 0.99preRC3
PROGRAM_BUILD = 2303201403
DEBUG = no
SCRIPT_PID = $$
LOCAL_USER = $( whoami)
LOCAL_HOST = $( hostname)
## Default log file until config file is loaded
if [ -w /var/log ]
then
LOG_FILE = /var/log/osync.log
else
LOG_FILE = ./osync.log
fi
## Default directory where to store temporary run files
if [ -w /dev/shm ]
then
RUN_DIR = /dev/shm
elif [ -w /tmp ]
then
RUN_DIR = /tmp
elif [ -w /var/tmp ]
then
RUN_DIR = /var/tmp
else
RUN_DIR = .
fi
## Working directory. Will keep current file states, backups and soft deleted files.
OSYNC_DIR = ".osync_workdir"
## Log a state message every $KEEP_LOGGING seconds. Should not be equal to soft or hard execution time so your log won't be unnecessary big.
KEEP_LOGGING = 1801
## Correct output of sort command (language agnostic sorting)
export LC_ALL = C
function Log
{
if [ $sync_on_changes -eq 1 ]
then
prefix = " $( date) - "
else
prefix = " TIME: $SECONDS - "
fi
echo -e " $prefix $1 " >> " $LOG_FILE "
if [ $silent -eq 0 ]
then
echo -e " $prefix $1 "
fi
}
function LogError
{
Log " $1 "
error_alert = 1
}
function LogDebug
{
if [ " $DEBUG " = = "yes" ]
then
Log " $1 "
fi
}
function TrapError
{
local JOB = " $0 "
local LINE = " $1 "
local CODE = " ${ 2 :- 1 } "
if [ $silent -eq 0 ]
then
echo -e " /!\ ERROR in ${ JOB } : Near line ${ LINE } , exit code ${ CODE } "
fi
}
function TrapUsr1
{
echo "Still doing stuff"
}
function TrapStop
{
if [ $soft_stop -eq 0 ]
then
LogError " /!\ WARNING: Manual exit of osync is really not recommended. Sync will be in inconsistent state."
LogError " /!\ WARNING: If you are sure, please hit CTRL+C another time to quit."
soft_stop = 1
return 1
fi
if [ $soft_stop -eq 1 ]
then
LogError " /!\ WARNING: CTRL+C hit twice. Quitting osync. Please wait..."
soft_stop = 2
exit 1
fi
}
function TrapQuit
{
if [ $error_alert -ne 0 ]
then
SendAlert
UnlockDirectories
CleanUp
LogError "Osync finished with errros."
exitcode = 1
else
UnlockDirectories
CleanUp
Log "Osync finished."
exitcode = 0
fi
if ps -p $child_pid > /dev/null 2>& 1
then
kill -9 $child_pid
fi
if ps -p $sub_pid > /dev/null 2>& 1
then
kill -9 $sub_pid
fi
exit $exitcode
}
function Spinner
{
if [ $silent -eq 1 ]
then
return 1
fi
case $toggle
in
1)
echo -n $1 " \ "
echo -ne "\r"
toggle = "2"
; ;
2)
echo -n $1 " | "
echo -ne "\r"
toggle = "3"
; ;
3)
echo -n $1 " / "
echo -ne "\r"
toggle = "4"
; ;
*)
echo -n $1 " - "
echo -ne "\r"
toggle = "1"
; ;
esac
}
function EscapeSpaces
{
echo $( echo " $1 " | sed 's/ /\\ /g' )
}
function CleanUp
{
if [ " $DEBUG " != "yes" ]
then
rm -f $RUN_DIR /osync_*_$SCRIPT_PID
fi
}
function SendAlert
{
if [ " $quick_sync " = = "2" ]
then
Log "Current task is a quicksync task. Will not send any alert."
return 0
fi
cat " $LOG_FILE " | gzip -9 > $RUN_DIR /osync_lastlog.gz
if type -p mutt > /dev/null 2>& 1
then
echo $MAIL_ALERT_MSG | $( type -p mutt) -x -s " Sync alert for $SYNC_ID " $DESTINATION_MAILS -a $RUN_DIR /osync_lastlog.gz
if [ $? != 0 ]
then
Log " WARNING: Cannot send alert email via $( type -p mutt) !!! "
else
Log "Sent alert mail using mutt."
fi
elif type -p mail > /dev/null 2>& 1
then
echo $MAIL_ALERT_MSG | $( type -p mail) -a $RUN_DIR /osync_lastlog.gz -s " Sync alert for $SYNC_ID " $DESTINATION_MAILS
if [ $? != 0 ]
then
Log " WARNING: Cannot send alert email via $( type -p mail) with attachments !!! "
echo $MAIL_ALERT_MSG | $( type -p mail) -s " Sync alert for $SYNC_ID " $DESTINATION_MAILS
if [ $? != 0 ]
then
Log " WARNING: Cannot send alert email via $( type -p mail) without attachments !!! "
else
Log "Sent alert mail using mail command without attachment."
fi
else
Log "Sent alert mail using mail command."
fi
elif type -p sendemail > /dev/null 2>& 1
then
$( type -p sendemail) -f $SENDER_MAIL -t $DESTINATION_MAILS -u " Backup alert for $BACKUP_ID " -m " $MAIL_ALERT_MSG " -s $SMTP_SERVER -o username $SMTP_USER -p password $SMTP_PASSWORD > /dev/null 2>& 1
if [ $? != 0 ]
then
Log " WARNING: Cannot send alert email via $( type -p sendemail) !!! "
else
Log "Sent alert mail using sendemail command without attachment."
fi
else
Log "WARNING: Cannot send alert email (no mutt / mail present) !!!"
return 1
fi
if [ -f $RUN_DIR /osync_lastlog.gz ]
then
rm $RUN_DIR /osync_lastlog.gz
fi
}
function LoadConfigFile
{
if [ ! -f " $1 " ]
then
LogError " Cannot load configuration file [ $1 ]. Sync cannot start. "
exit 1
elif [ [ " $1 " != *".conf" ] ]
then
LogError " Wrong configuration file supplied [ $1 ]. Sync cannot start. "
exit 1
else
egrep '^#|^[^ ]*=[^;&]*' " $1 " > " $RUN_DIR /osync_config_ $SCRIPT_PID "
source " $RUN_DIR /osync_config_ $SCRIPT_PID "
fi
}
function CheckEnvironment
{
if [ " $REMOTE_SYNC " = = "yes" ]
then
if ! type -p ssh > /dev/null 2>& 1
then
LogError "ssh not present. Cannot start sync."
return 1
fi
fi
if ! type -p rsync > /dev/null 2>& 1
then
LogError "rsync not present. Sync cannot start."
return 1
fi
}
function GetOperatingSystem
{
LOCAL_OS_VAR = $( uname -spio 2>& 1)
if [ $? != 0 ]
then
LOCAL_OS_VAR = $( uname -v 2>& 1)
if [ $? != 0 ]
then
LOCAL_OS_VAR = ( $uname )
fi
fi
case $LOCAL_OS_VAR in
*"Linux" *)
LOCAL_OS = "Linux"
; ;
*"FreeBSD" *)
LOCAL_OS = "FreeBSD"
; ;
*"MINGW32" *)
LOCAL_OS = "msys"
; ;
*"Darwin" *)
LOCAL_OS = "MacOSX"
; ;
*)
LogError " Running on >> $LOCAL_OS_VAR << not supported. Please report to the author. "
exit 1
; ;
esac
LogDebug " Local OS: [ $LOCAL_OS_VAR ]. "
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
eval " $SSH_CMD \"uname -spio\" > $RUN_DIR /osync_remote_os_ $SCRIPT_PID 2>&1 "
child_pid = $!
WaitForTaskCompletion $child_pid 120 240
retval = $?
if [ $retval != 0 ]
then
eval " $SSH_CMD \"uname -v\" > $RUN_DIR /osync_remote_os_ $SCRIPT_PID 2>&1 "
child_pid = $!
WaitForTaskCompletion $child_pid 120 240
retval = $?
if [ $retval != 0 ]
then
eval " $SSH_CMD \"uname\" > $RUN_DIR /osync_remote_os_ $SCRIPT_PID 2>&1 "
child_pid = $!
WaitForTaskCompletion $child_pid 120 240
retval = $?
if [ $retval != 0 ]
then
LogError "Cannot Get remote OS type."
fi
fi
fi
REMOTE_OS_VAR = $( cat $RUN_DIR /osync_remote_os_$SCRIPT_PID )
case $REMOTE_OS_VAR in
*"Linux" *)
REMOTE_OS = "Linux"
; ;
*"FreeBSD" *)
REMOTE_OS = "FreeBSD"
; ;
*"MINGW32" *)
REMOTE_OS = "msys"
; ;
*"Darwin" *)
REMOTE_OS = "MacOSX"
; ;
"ssh" *)
LogError "Cannot connect to remote system."
exit 1
; ;
*)
LogError " Running on remote >> $REMOTE_OS_VAR << not supported. Please report to the author. "
exit 1
esac
LogDebug " Remote OS: [ $REMOTE_OS_VAR ]. "
fi
}
# Waits for pid $1 to complete. Will log an alert if $2 seconds passed since current task execution unless $2 equals 0.
# Will stop task and log alert if $3 seconds passed since current task execution unless $3 equals 0.
function WaitForTaskCompletion
{
soft_alert = 0
SECONDS_BEGIN = $SECONDS
if [ " $LOCAL_OS " = = "msys" ]
then
PROCESS_TEST = " ps -a | awk '{\$1=\$1}\$1' | awk '{print \$1}' | grep $1 "
else
PROCESS_TEST = " ps -p $1 "
fi
while eval $PROCESS_TEST > /dev/null
do
Spinner
sleep 1
EXEC_TIME = $(( $SECONDS - $SECONDS_BEGIN ))
if [ $(( $EXEC_TIME % $KEEP_LOGGING )) -eq 0 ]
then
Log "Current task still running."
fi
if [ $EXEC_TIME -gt $2 ]
then
if [ $soft_alert -eq 0 ] && [ $2 != 0 ]
then
LogError "Max soft execution time exceeded for task."
soft_alert = 1
fi
if [ $EXEC_TIME -gt $3 ] && [ $3 != 0 ]
then
LogError "Max hard execution time exceeded for task. Stopping task execution."
kill -s SIGTERM $1
if [ $? = = 0 ]
then
LogError "Task stopped succesfully"
else
LogError "Sending SIGTERM to proces failed. Trying the hard way."
kill -9 $1
if [ $? != 0 ]
then
LogError "Could not stop task."
fi
fi
return 1
fi
fi
done
wait $child_pid
return $?
}
# Waits for pid $1 to complete. Will log an alert if $2 seconds passed since script start unless $2 equals 0.
# Will stop task and log alert if $3 seconds passed since script start unless $3 equals 0.
function WaitForCompletion
{
soft_alert = 0
if [ " $LOCAL_OS " = = "msys" ]
then
PROCESS_TEST = " ps -a | awk '{\$1=\$1}\$1' | awk '{print \$1}' | grep $1 "
else
PROCESS_TEST = " ps -p $1 "
fi
while eval $PROCESS_TEST > /dev/null
do
Spinner
sleep 1
if [ $(( $SECONDS % $KEEP_LOGGING )) -eq 0 ]
then
Log "Current task still running."
fi
if [ $SECONDS -gt $2 ]
then
if [ $soft_alert -eq 0 ] && [ $2 != 0 ]
then
LogError "Max soft execution time exceeded for script."
soft_alert = 1
fi
if [ $SECONDS -gt $3 ] && [ $3 != 0 ]
then
LogError "Max hard execution time exceeded for script. Stopping current task execution."
kill -s SIGTERM $1
if [ $? = = 0 ]
then
LogError "Task stopped succesfully"
else
LogError "Sending SIGTERM to proces failed. Trying the hard way."
kill -9 $1
if [ $? != 0 ]
then
LogError "Could not stop task."
fi
fi
return 1
fi
fi
done
wait $child_pid
return $?
}
## Runs local command $1 and waits for completition in $2 seconds
function RunLocalCommand
{
if [ $dryrun -ne 0 ]
then
Log " Dryrun: Local command [ $1 ] not run. "
return 1
fi
Log " Running command [ $1 ] on local host. "
eval " $1 " > $RUN_DIR /osync_run_local_$SCRIPT_PID 2>& 1 &
child_pid = $!
WaitForTaskCompletion $child_pid 0 $2
retval = $?
if [ $retval -eq 0 ]
then
Log "Command succeded."
else
LogError "Command failed."
fi
if [ $verbose -eq 1 ] || [ $retval -ne 0 ]
then
Log " Command output:\n $( cat $RUN_DIR /osync_run_local_$SCRIPT_PID ) "
fi
if [ " $STOP_ON_CMD_ERROR " = = "yes" ] && [ $retval -ne 0 ]
then
exit 1
fi
}
## Runs remote command $1 and waits for completition in $2 seconds
function RunRemoteCommand
{
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
if [ $dryrun -ne 0 ]
then
Log " Dryrun: Local command [ $1 ] not run. "
return 1
fi
Log " Running command [ $1 ] on remote host. "
eval " $SSH_CMD \" $1 \" > $RUN_DIR /osync_run_remote_ $SCRIPT_PID 2>&1 & "
child_pid = $!
WaitForTaskCompletion $child_pid 0 $2
retval = $?
if [ $retval -eq 0 ]
then
Log "Command succeded."
else
LogError "Command failed."
fi
if [ -f $RUN_DIR /osync_run_remote_$SCRIPT_PID ] && ( [ $verbose -eq 1 ] || [ $retval -ne 0 ] )
then
Log " Command output:\n $( cat $RUN_DIR /osync_run_remote_$SCRIPT_PID ) "
fi
if [ " $STOP_ON_CMD_ERROR " = = "yes" ] && [ $retval -ne 0 ]
then
exit 1
fi
}
function RunBeforeHook
{
if [ " $LOCAL_RUN_BEFORE_CMD " != "" ]
then
RunLocalCommand " $LOCAL_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE
fi
if [ " $REMOTE_RUN_BEFORE_CMD " != "" ]
then
RunRemoteCommand " $REMOTE_RUN_BEFORE_CMD " $MAX_EXEC_TIME_PER_CMD_BEFORE
fi
}
function RunAfterHook
{
if [ " $LOCAL_RUN_AFTER_CMD " != "" ]
then
RunLocalCommand " $LOCAL_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER
fi
if [ " $REMOTE_RUN_AFTER_CMD " != "" ]
then
RunRemoteCommand " $REMOTE_RUN_AFTER_CMD " $MAX_EXEC_TIME_PER_CMD_AFTER
fi
}
function CheckConnectivityRemoteHost
{
if [ " $REMOTE_HOST_PING " != "no" ] && [ " $REMOTE_SYNC " != "no" ]
then
if [ " $LOCAL_OS " = = "msys" ]
then
ping -n 2 $REMOTE_HOST > /dev/null 2>& 1
else
ping -c 2 $REMOTE_HOST > /dev/null 2>& 1
fi
if [ $? != 0 ]
then
LogError " Cannot ping $REMOTE_HOST "
exit 1
fi
fi
}
function CheckConnectivity3rdPartyHosts
{
if [ " $REMOTE_3RD_PARTY_HOSTS " != "" ]
then
remote_3rd_party_success = 0
OLD_IFS = $IFS
IFS = $' \t\n'
for i in $REMOTE_3RD_PARTY_HOSTS
do
if [ " $LOCAL_OS " = = "msys" ]
then
ping -n 2 $i > /dev/null 2>& 1
else
ping -c 2 $i > /dev/null 2>& 1
fi
if [ $? != 0 ]
then
Log " Cannot ping 3rd party host $i "
else
remote_3rd_party_success = 1
fi
done
IFS = $OLD_IFS
if [ $remote_3rd_party_success -ne 1 ]
then
LogError "No remote 3rd party host responded to ping. No internet ?"
exit 1
fi
fi
}
function CreateOsyncDirs
{
if ! [ -d " $MASTER_STATE_DIR " ]
then
mkdir -p " $MASTER_STATE_DIR "
if [ $? != 0 ]
then
LogError " Cannot create master replica state dir [ $MASTER_STATE_DIR ]. "
exit 1
fi
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
eval " $SSH_CMD \"if ! [ -d \\\" $SLAVE_STATE_DIR \\\" ]; then $COMMAND_SUDO mkdir -p \\\" $SLAVE_STATE_DIR \\\"; fi\" " &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
else
if ! [ -d " $SLAVE_STATE_DIR " ] ; then mkdir -p " $SLAVE_STATE_DIR " ; fi
fi
if [ $? != 0 ]
then
LogError " Cannot create slave replica state dir [ $SLAVE_STATE_DIR ]. "
exit 1
fi
}
function CheckMasterSlaveDirs
{
if ! [ -d " $MASTER_SYNC_DIR " ]
then
if [ " $CREATE_DIRS " = = "yes" ]
then
mkdir -p " $MASTER_SYNC_DIR "
if [ $? != 0 ]
then
LogError " Cannot create master directory [ $MASTER_SYNC_DIR ]. "
exit 1
fi
else
LogError " Master directory [ $MASTER_SYNC_DIR ] does not exist. "
exit 1
fi
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
if [ " $CREATE_DIRS " = = "yes" ]
then
eval " $SSH_CMD \"if ! [ -d \\\" $SLAVE_SYNC_DIR \\\" ]; then $COMMAND_SUDO mkdir -p \\\" $SLAVE_SYNC_DIR \\\"; fi " \" &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
if [ $? != 0 ]
then
LogError " Cannot create slave directory [ $SLAVE_SYNC_DIR ]. "
exit 1
fi
else
eval " $SSH_CMD \"if ! [ -d \\\" $SLAVE_SYNC_DIR \\\" ]; then exit 1; fi " \" &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
res = $?
if [ $res != 0 ]
then
LogError " Slave directory [ $SLAVE_SYNC_DIR ] does not exist. "
exit 1
fi
fi
else
if [ ! -d " $SLAVE_SYNC_DIR " ]
then
if [ " $CREATE_DIRS " = = "yes" ]
then
mkdir -p " $SLAVE_SYNC_DIR "
if [ $? != 0 ]
then
LogError " Cannot create slave directory [ $SLAVE_SYNC_DIR ]. "
exit 1
else
Log " Created slave directory [ $SLAVE_SYNC_DIR ]. "
fi
else
LogError " Slave directory [ $SLAVE_SYNC_DIR ] does not exist. "
exit 1
fi
fi
fi
}
function CheckMinimumSpace
{
Log "Checking minimum disk space on master and slave."
MASTER_SPACE = $( df -P " $MASTER_SYNC_DIR " | tail -1 | awk '{print $4}' )
if [ $MASTER_SPACE -lt $MINIMUM_SPACE ]
then
LogError " There is not enough free space on master [ $MASTER_SPACE KB]. "
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
eval " $SSH_CMD \" $COMMAND_SUDO df -P \\\" $SLAVE_SYNC_DIR \\\"\" " > $RUN_DIR /osync_slave_space_$SCRIPT_PID &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
SLAVE_SPACE = $( cat $RUN_DIR /osync_slave_space_$SCRIPT_PID | tail -1 | awk '{print $4}' )
else
SLAVE_SPACE = $( df -P " $SLAVE_SYNC_DIR " | tail -1 | awk '{print $4}' )
fi
if [ $SLAVE_SPACE -lt $MINIMUM_SPACE ]
then
LogError " There is not enough free space on slave [ $SLAVE_SPACE KB]. "
fi
}
function RsyncExcludePattern
{
OLD_IFS = $IFS
IFS = $PATH_SEPARATOR_CHAR
for excludedir in $RSYNC_EXCLUDE_PATTERN
do
if [ " $RSYNC_EXCLUDE " = = "" ]
then
RSYNC_EXCLUDE = " --exclude=\" $excludedir \" "
else
RSYNC_EXCLUDE = " $RSYNC_EXCLUDE --exclude=\" $excludedir \" "
fi
done
IFS = $OLD_IFS
}
function WriteLockFiles
{
echo $SCRIPT_PID > " $MASTER_LOCK "
if [ $? != 0 ]
then
LogError "Could not set lock on master replica."
exit 1
else
Log "Locked master replica."
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
eval " $SSH_CMD \"echo $SCRIPT_PID @ $SYNC_ID | $COMMAND_SUDO tee \\\" $SLAVE_LOCK \\\" > /dev/null \" " &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
if [ $? != 0 ]
then
LogError "Could not set lock on remote slave replica."
exit 1
else
Log "Locked remote slave replica."
fi
else
echo " $SCRIPT_PID @ $SYNC_ID " > " $SLAVE_LOCK "
if [ $? != 0 ]
then
LogError "Couuld not set lock on local slave replica."
exit 1
else
Log "Locked local slave replica."
fi
fi
}
function LockDirectories
{
if [ $nolocks -eq 1 ]
then
return 0
fi
if [ $force_unlock -eq 1 ]
then
WriteLockFiles
if [ $? != 0 ]
then
exit 1
fi
fi
Log "Checking for replica locks."
if [ -f " $MASTER_LOCK " ]
then
master_lock_pid = $( cat $MASTER_LOCK )
LogDebug " Master lock pid present: $master_lock_pid "
ps -p$master_lock_pid > /dev/null 2>& 1
if [ $? != 0 ]
then
Log " There is a dead osync lock on master. Instance $master_lock_pid no longer running. Resuming. "
else
LogError " There is already a local instance of osync that locks master replica. Cannot start. If your are sure this is an error, plaese kill instance $master_lock_pid of osync. "
exit 1
fi
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
eval " $SSH_CMD \"if [ -f \\\" $SLAVE_LOCK \\\" ]; then cat \\\" $SLAVE_LOCK \\\"; fi\" > $RUN_DIR /osync_remote_slave_lock_ $SCRIPT_PID " &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
if [ -f $RUN_DIR /osync_remote_slave_lock_$SCRIPT_PID ]
then
slave_lock_pid = $( cat $RUN_DIR /osync_remote_slave_lock_$SCRIPT_PID | cut -d'@' -f1)
slave_lock_id = $( cat $RUN_DIR /osync_remote_slave_lock_$SCRIPT_PID | cut -d'@' -f2)
fi
else
if [ -f " $SLAVE_LOCK " ]
then
slave_lock_pid = $( cat " $SLAVE_LOCK " | cut -d'@' -f1)
slave_lock_id = $( cat " $SLAVE_LOCK " | cut -d'@' -f2)
fi
fi
if [ " $slave_lock_pid " != "" ] && [ " $slave_lock_id " != "" ]
then
LogDebug " Slave lock pid: $slave_lock_pid "
LogDebug " Slave lock id: $slave_lock_pid "
ps -p$slave_lock_pid > /dev/null
if [ $? != 0 ]
then
if [ " $slave_lock_id " = = " $SYNC_ID " ]
then
Log " There is a dead osync lock on slave replica that corresponds to this master sync-id. Instance $slave_lock_pid no longer running. Resuming. "
else
if [ " $FORCE_STRANGER_LOCK_RESUME " = = "yes" ]
then
LogError "WARNING: There is a dead osync lock on slave replica that does not correspond to this master sync-id. Forcing resume."
else
LogError "There is a dead osync lock on slave replica that does not correspond to this master sync-id. Will not resume."
exit 1
fi
fi
else
LogError " There is already a local instance of osync that locks slave replica. Cannot start. If you are sure this is an error, please kill instance $slave_lock_pid of osync. "
exit 1
fi
fi
WriteLockFiles
}
function UnlockDirectories
{
if [ $nolocks -eq 1 ]
then
return 0
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
eval " $SSH_CMD \"if [ -f \\\" $SLAVE_LOCK \\\" ]; then $COMMAND_SUDO rm \\\" $SLAVE_LOCK \\\"; fi\" " &
child_pid = $!
WaitForTaskCompletion $child_pid 0 1800
else
if [ -f " $SLAVE_LOCK " ] ; then rm " $SLAVE_LOCK " ; fi
fi
if [ $? != 0 ]
then
LogError "Could not unlock slave replica."
else
Log "Removed slave replica lock."
fi
if [ -f " $MASTER_LOCK " ]
then
rm " $MASTER_LOCK "
if [ $? != 0 ]
then
LogError "Could not unlock master replica."
else
Log "Removed master replica lock."
fi
fi
}
###### Sync core functions
## Rsync does not like spaces in directory names, considering it as two different directories. Handling this schema by escaping space.
## It seems this only happens when trying to execute an rsync command through eval $rsync_cmd on a remote host.
## So i'm using unescaped $MASTER_SYNC_DIR for local rsync calls and escaped $ESC_MASTER_SYNC_DIR for remote rsync calls like user@host:$ESC_MASTER_SYNC_DIR
## The same applies for slave sync dir..............................................T.H.I.S..I.S..A..P.R.O.G.R.A.M.M.I.N.G..N.I.G.H.T.M.A.R.E
## tree_list(replica_path, tree_file, current_action) Creates a list of files in replica_path and stores it's action in $STATE_DIR/last-action
function tree_list
{
Log " Creating replica file list [ $1 ]. "
if [ " $REMOTE_SYNC " = = "yes" ] && [ [ " $2 " = = "slave" * ] ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
ESC = $( EscapeSpaces " $1 " )
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" -rlptgoDE8 $RSYNC_ARGS --exclude \" $OSYNC_DIR \" $RSYNC_EXCLUDE -e \" $RSYNC_SSH_CMD \" --list-only $REMOTE_USER @ $REMOTE_HOST :\" $ESC /\" | grep \"^-\|^d\" | awk '{\$1=\$2=\$3=\$4=\"\" ;print}' | awk '{\$1=\$1 ;print}' | (grep -v \"^\. $\" || :) | sort > \" $RUN_DIR /osync_ $2 _ $SCRIPT_PID \" & "
else
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" -rlptgoDE8 $RSYNC_ARGS --exclude \" $OSYNC_DIR \" $RSNYC_EXCLUDE --list-only \" $1 /\" | grep \"^-\|^d\" | awk '{\$1=\$2=\$3=\$4=\"\" ;print}' | awk '{\$1=\$1 ;print}' | (grep -v \"^\. $\" || :) | sort > \" $RUN_DIR /osync_ $2 _ $SCRIPT_PID \" & "
fi
LogDebug " RSYNC_CMD: $rsync_cmd "
## Redirect commands stderr here to get rsync stderr output in logfile
eval $rsync_cmd 2>> " $LOG_FILE "
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME $HARD_MAX_EXEC_TIME
retval = $?
## Retval 24 = some files vanished while creating list
if ( [ $retval = = 0 ] || [ $retval = = 24 ] ) && [ -f $RUN_DIR /osync_$2 _$SCRIPT_PID ]
then
if [ $dryrun -eq 1 ]
then
mv $RUN_DIR /osync_$2 _$SCRIPT_PID " $MASTER_STATE_DIR /dry- $2 "
else
mv $RUN_DIR /osync_$2 _$SCRIPT_PID " $MASTER_STATE_DIR / $2 "
fi
echo " $3 .success " > " $MASTER_LAST_ACTION "
else
LogError "Cannot create replica file list."
echo " $3 .fail " > " $MASTER_LAST_ACTION "
exit 1
fi
}
# delete_list(replica): Creates a list of files vanished from last run on replica $1
function delete_list
{
Log " Creating $1 replica deleted file list. "
if [ -f " $MASTER_STATE_DIR / $1 -tree-after " ]
then
if [ $dryrun -eq 1 ]
then
## Same functionnality, comm is much faster than grep but is not available on every platform
if type -p comm > /dev/null 2>& 1
then
cmd = " comm -23 \" $MASTER_STATE_DIR / $1 -tree-after\" \" $MASTER_STATE_DIR /dry- $1 -tree-current\" > \" $MASTER_STATE_DIR /dry- $1 -deleted-list\" "
else
## The || : forces the command to have a good result
cmd = " grep -F -x -v -f \" $MASTER_STATE_DIR /dry- $1 -tree-current\" \" $MASTER_STATE_DIR / $1 -tree-after\" || : > \" $MASTER_STATE_DIR /dry- $1 -deleted-list\" "
fi
else
if type -p comm > /dev/null 2>& 1
then
cmd = " comm -23 \" $MASTER_STATE_DIR / $1 -tree-after\" \" $MASTER_STATE_DIR / $1 -tree-current\" > \" $MASTER_STATE_DIR / $1 -deleted-list\" "
else
cmd = " grep -F -x -v -f \" $MASTER_STATE_DIR / $1 -tree-current\" \" $MASTER_STATE_DIR / $1 -tree-after\" || : > \" $MASTER_STATE_DIR / $1 -deleted-list\" "
fi
fi
LogDebug " CMD: $cmd "
eval $cmd
echo " $1 -replica-deleted-list.success " > " $MASTER_LAST_ACTION "
else
touch " $MASTER_STATE_DIR / $1 -deleted-list "
echo " $1 -replica-deleted-list.empty " > " $MASTER_LAST_ACTION "
fi
}
# sync_update(source replica, destination replica)
function sync_update
{
Log " Updating $2 replica. "
if [ " $1 " = = "master" ]
then
SOURCE_DIR = " $MASTER_SYNC_DIR "
ESC_SOURCE_DIR = $( EscapeSpaces " $MASTER_SYNC_DIR " )
DEST_DIR = " $SLAVE_SYNC_DIR "
ESC_DEST_DIR = $( EscapeSpaces " $SLAVE_SYNC_DIR " )
BACKUP_DIR = " $SLAVE_BACKUP "
else
SOURCE_DIR = " $SLAVE_SYNC_DIR "
ESC_SOURCE_DIR = $( EscapeSpaces " $SLAVE_SYNC_DIR " )
DEST_DIR = " $MASTER_SYNC_DIR "
ESC_DEST_DIR = $( EscapeSpaces " $MASTER_SYNC_DIR " )
BACKUP_DIR = " $MASTER_BACKUP "
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
if [ " $1 " = = "master" ]
then
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" $RSYNC_ARGS -rlptgoDEui --stats -e \" $RSYNC_SSH_CMD \" $BACKUP_DIR --exclude \" $OSYNC_DIR \" $RSYNC_EXCLUDE --exclude-from=\" $MASTER_STATE_DIR / $1 -deleted-list\" --exclude-from=\" $MASTER_STATE_DIR / $2 -deleted-list\" \" $SOURCE_DIR /\" $REMOTE_USER @ $REMOTE_HOST :\" $ESC_DEST_DIR /\" > $RUN_DIR /osync_update_ $2 _replica_ $SCRIPT_PID 2>&1 & "
else
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" $RSYNC_ARGS -rlptgoDEui --stats -e \" $RSYNC_SSH_CMD \" $BACKUP_DIR --exclude \" $OSYNC_DIR \" $RSYNC_EXCLUDE --exclude-from=\" $MASTER_STATE_DIR / $1 -deleted-list\" --exclude-from=\" $MASTER_STATE_DIR / $2 -deleted-list\" $REMOTE_USER @ $REMOTE_HOST :\" $ESC_SOURCE_DIR /\" \" $DEST_DIR /\" > $RUN_DIR /osync_update_ $2 _replica_ $SCRIPT_PID 2>&1 & "
fi
else
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" $RSYNC_ARGS -rlptgoDEui --stats $BACKUP_DIR --exclude \" $OSYNC_DIR \" $RSYNC_EXCLUDE --exclude-from=\" $MASTER_STATE_DIR / $1 -deleted-list\" --exclude-from=\" $MASTER_STATE_DIR / $2 -deleted-list\" \" $SOURCE_DIR /\" \" $DEST_DIR /\" > $RUN_DIR /osync_update_ $2 _replica_ $SCRIPT_PID 2>&1 & "
fi
LogDebug " RSYNC_CMD: $rsync_cmd "
eval " $rsync_cmd "
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME $HARD_MAX_EXEC_TIME
retval = $?
if [ $verbose -eq 1 ] && [ -f $RUN_DIR /osync_update_$2 _replica_$SCRIPT_PID ]
then
Log " List:\n $( cat $RUN_DIR /osync_update_$2 _replica_$SCRIPT_PID ) "
fi
if [ $retval != 0 ] && [ $retval != 24 ]
then
LogError " Updating $2 replica failed. Stopping execution. "
if [ $verbose -eq 0 ] && [ -f $RUN_DIR /osync_update_$2 _replica_$SCRIPT_PID ]
then
LogError " Rsync output:\n $( cat $RUN_DIR /osync_update_$2 _replica_$SCRIPT_PID ) "
fi
echo " update- $2 -replica.fail " > " $MASTER_LAST_ACTION "
exit 1
else
Log " Updating $2 replica succeded. "
echo " update- $2 -replica.success " > " $MASTER_LAST_ACTION "
fi
}
# delete_propagation(source replica, destination replica)
function deletion_propagation
{
Log " Propagating deletions to $2 replica. "
if [ " $1 " = = "master" ]
then
SOURCE_DIR = " $MASTER_SYNC_DIR "
ESC_SOURCE_DIR = $( EscapeSpaces " $MASTER_SYNC_DIR " )
DEST_DIR = " $SLAVE_SYNC_DIR "
ESC_DEST_DIR = $( EscapeSpaces " $SLAVE_SYNC_DIR " )
DELETE_DIR = " $SLAVE_DELETE "
else
SOURCE_DIR = " $SLAVE_SYNC_DIR "
ESC_SOURCE_DIR = $( EscapeSpaces " $SLAVE_SYNC_DIR " )
DEST_DIR = " $MASTER_SYNC_DIR "
ESC_DEST_DIR = $( EscapeSpaces " $MASTER_SYNC_DIR " )
DELETE_DIR = " $MASTER_DELETE "
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
if [ " $1 " = = "master" ]
then
#rsync_cmd="$(type -p $RSYNC_EXECUTABLE) --rsync-path=\"$RSYNC_PATH\" $RSYNC_ARGS -rlptgoDEui --stats -e \"$RSYNC_SSH_CMD\" $DELETE_DIR --delete --exclude \"$OSYNC_DIR\" --include-from=\"$MASTER_STATE_DIR/$1-deleted-list\" --filter=\"-! */\" \"$SOURCE_DIR/\" $REMOTE_USER@$REMOTE_HOST:\"$ESC_DEST_DIR/\" > $RUN_DIR/osync_deletion_on_$2_$SCRIPT_PID 2>&1 &"
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" $RSYNC_ARGS -rlptgoDEui --stats -e \" $RSYNC_SSH_CMD \" $DELETE_DIR --delete --exclude \" $OSYNC_DIR \" --include-from=\" $MASTER_STATE_DIR / $1 -deleted-list\" --filter=\"- *\" \" $SOURCE_DIR /\" $REMOTE_USER @ $REMOTE_HOST :\" $ESC_DEST_DIR /\" > $RUN_DIR /osync_deletion_on_ $2 _ $SCRIPT_PID 2>&1 & "
else
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" $RSYNC_ARGS -rlptgoDEui --stats -e \" $RSYNC_SSH_CMD \" $DELETE_DIR --delete --exclude \" $OSYNC_DIR \" --include-from=\" $MASTER_STATE_DIR / $1 -deleted-list\" --filter=\"- *\" $REMOTE_USER @ $REMOTE_HOST :\" $ESC_SOURCE_DIR /\" \" $DEST_DIR /\"> $RUN_DIR /osync_deletion_on_ $2 _ $SCRIPT_PID 2>&1 & "
fi
else
rsync_cmd = " $( type -p $RSYNC_EXECUTABLE ) --rsync-path=\" $RSYNC_PATH \" $RSYNC_ARGS -rlptgoDEui --stats $DELETE_DIR --delete --exclude \" $OSYNC_DIR \" --include-from=\" $MASTER_STATE_DIR / $1 -deleted-list\" --filter=\"- *\" \" $SOURCE_DIR /\" \" $DEST_DIR /\" > $RUN_DIR /osync_deletion_on_ $2 _ $SCRIPT_PID 2>&1 & "
fi
LogDebug " RSYNC_CMD: $rsync_cmd "
eval " $rsync_cmd "
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $verbose -eq 1 ] && [ -f $RUN_DIR /osync_deletion_on_$2 _$SCRIPT_PID ]
then
Log " List:\n $( cat $RUN_DIR /osync_deletion_on_$2 _$SCRIPT_PID ) "
fi
if [ $retval != 0 ] && [ $retval != 24 ]
then
if [ $verbose -eq 0 ] && [ -f $RUN_DIR /osync_deletion_on_$2 _$SCRIPT_PID ]
then
LogError " Rsync output:\n $( cat $RUN_DIR /osync_deletion_on_$2 _$SCRIPT_PID ) "
fi
LogError " Deletion on $2 failed. "
echo " delete-propagation- $2 .fail " > " $MASTER_LAST_ACTION "
exit 1
else
echo " delete-propagation- $2 .success " > " $MASTER_LAST_ACTION "
fi
}
###### Sync function in 10 steps (functions above)
function Sync
{
Log "Starting synchronization task."
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
if [ -f " $MASTER_STATE_DIR /last-action " ] && [ " $RESUME_SYNC " = = "yes" ]
then
resume_sync = $( cat " $MASTER_STATE_DIR /last-action " )
if [ -f " $MASTER_STATE_DIR /resume-count " ]
then
resume_count = $( cat " $MASTER_STATE_DIR /resume-count " )
else
resume_count = 0
fi
if [ $resume_count -lt $RESUME_TRY ]
then
if [ " $resume_sync " != "sync.success" ]
then
Log " WARNING: Trying to resume aborted osync execution on $( stat --format %y " $MASTER_STATE_DIR /last-action " ) at task [ $resume_sync ]. [ $resume_count ] previous tries. "
if [ $dryrun -ne 1 ]
then
echo $(( $resume_count + 1 )) > " $MASTER_STATE_DIR /resume-count "
fi
else
resume_sync = none
fi
else
Log " Will not resume aborted osync execution. Too much resume tries [ $resume_count ]. "
if [ $dryrun -ne 1 ]
then
echo "noresume" > " $MASTER_LAST_ACTION "
echo "0" > " $MASTER_STATE_DIR /resume-count "
fi
resume_sync = none
fi
else
resume_sync = none
fi
################################################################################################################################################# Actual sync begins here
## This replaces the case statement below because ;& operator is not supported in bash 3.2... Code is more messy than case :(
if [ " $resume_sync " = = "none" ] || [ " $resume_sync " = = "noresume" ] || [ " $resume_sync " = = "master-replica-tree.fail" ]
then
#master_tree_current
tree_list " $MASTER_SYNC_DIR " master-tree-current master-replica-tree
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "master-replica-tree.success" ] || [ " $resume_sync " = = "slave-replica-tree.fail" ]
then
#slave_tree_current
tree_list " $SLAVE_SYNC_DIR " slave-tree-current slave-replica-tree
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "slave-replica-tree.success" ] || [ " $resume_sync " = = "master-replica-deleted-list.fail" ]
then
delete_list master
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "master-replica-deleted-list.success" ] || [ " $resume_sync " = = "slave-replica-deleted-list.fail" ]
then
delete_list slave
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "slave-replica-deleted-list.success" ] || [ " $resume_sync " = = "update-master-replica.fail" ] || [ " $resume_sync " = = "update-slave-replica.fail" ]
then
if [ " $CONFLICT_PREVALANCE " != "master" ]
then
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "slave-replica-deleted-list.success" ] || [ " $resume_sync " = = "update-master-replica.fail" ]
then
sync_update slave master
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "update-master-replica.success" ] || [ " $resume_sync " = = "update-slave-replica.fail" ]
then
sync_update master slave
resume_sync = "resumed"
fi
else
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "slave-replica-deleted-list.success" ] || [ " $resume_sync " = = "update-slave-replica.fail" ]
then
sync_update master slave
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "update-slave-replica.success" ] || [ " $resume_sync " = = "update-master-replica.fail" ]
then
sync_update slave master
resume_sync = "resumed"
fi
fi
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "update-slave-replica.success" ] || [ " $resume_sync " = = "update-master-replica.success" ] || [ " $resume_sync " = = "delete-propagation-slave.fail" ]
then
deletion_propagation master slave
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "delete-propagation-slave.success" ] || [ " $resume_sync " = = "delete-propagation-master.fail" ]
then
deletion_propagation slave master
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "delete-propagation-master.success" ] || [ " $resume_sync " = = "master-replica-tree-after.fail" ]
then
#master_tree_after
tree_list " $MASTER_SYNC_DIR " master-tree-after master-replica-tree-after
resume_sync = "resumed"
fi
if [ " $resume_sync " = = "resumed" ] || [ " $resume_sync " = = "master-replica-tree-after.success" ] || [ " $resume_sync " = = "slave-replica-tree-after.fail" ]
then
#slave_tree_after
tree_list " $SLAVE_SYNC_DIR " slave-tree-after slave-replica-tree-after
resume_sync = "resumed"
fi
Log "Finished synchronization task."
echo "sync.success" > " $MASTER_LAST_ACTION "
if [ $dryrun -ne 1 ]
then
echo "0" > " $MASTER_STATE_DIR /resume-count "
fi
}
function SoftDelete
{
if [ " $CONFLICT_BACKUP " != "no" ] && [ $CONFLICT_BACKUP_DAYS -ne 0 ]
then
if [ -d " $MASTER_SYNC_DIR $MASTER_BACKUP_DIR " ]
then
Log " Removing backups older than $CONFLICT_BACKUP_DAYS days on master replica. "
if [ $dryrun -eq 1 ]
then
$FIND_CMD " $MASTER_SYNC_DIR $MASTER_BACKUP_DIR / " -ctime +$CONFLICT_BACKUP_DAYS &
else
$FIND_CMD " $MASTER_SYNC_DIR $MASTER_BACKUP_DIR / " -ctime +$CONFLICT_BACKUP_DAYS -exec rm -rf '{}' \; &
fi
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $retval -ne 0 ]
then
LogError "Error while executing conflict backup cleanup on master replica."
else
Log "Conflict backup cleanup complete on master replica."
fi
elif [ -d " $MASTER_SYNC_DIR $MASTER_BACKUP_DIR " ] && ! [ -w " $MASTER_SYNC_DIR $MASTER_BACKUP_DIR " ]
then
LogError " Warning: Master replica conflict backup dir [ $MASTER_SYNC_DIR $MASTER_BACKUP_DIR ] isn't writable. Cannot clean old files. "
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
Log " Removing backups older than $CONFLICT_BACKUP_DAYS days on remote slave replica. "
if [ $dryrun -eq 1 ]
then
eval " $SSH_CMD \"if [ -w \\\" $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR \\\" ]; then $COMMAND_SUDO $REMOTE_FIND_CMD \\\" $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR /\\\" -ctime + $CONFLICT_BACKUP_DAYS ; fi\" "
else
eval " $SSH_CMD \"if [ -w \\\" $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR \\\" ]; then $COMMAND_SUDO $REMOTE_FIND_CMD \\\" $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR /\\\" -ctime + $CONFLICT_BACKUP_DAYS -exec rm -rf '{}' \;; fi\" "
fi
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $retval -ne 0 ]
then
LogError "Error while executing conflict backup cleanup on slave replica."
else
Log "Conflict backup cleanup complete on slave replica."
fi
else
if [ -w " $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR " ]
then
Log " Removing backups older than $CONFLICT_BACKUP_DAYS days on slave replica. "
if [ $dryrun -eq 1 ]
then
$FIND_CMD " $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR / " -ctime +$CONFLICT_BACKUP_DAYS
else
$FIND_CMD " $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR / " -ctime +$CONFLICT_BACKUP_DAYS -exec rm -rf '{}' \;
fi
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $retval -ne 0 ]
then
LogError "Error while executing conflict backup cleanup on slave replica."
else
Log "Conflict backup cleanup complete on slave replica."
fi
elif [ -d " $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR " ] && ! [ -w " $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR " ]
then
LogError " Warning: Slave replica conflict backup dir [ $SLAVE_SYNC_DIR $SLAVE_BACKUP_DIR ] isn't writable. Cannot clean old files. "
fi
fi
fi
if [ " $SOFT_DELETE " != "no" ] && [ $SOFT_DELETE_DAYS -ne 0 ]
then
if [ -w " $MASTER_SYNC_DIR $MASTER_DELETE_DIR " ]
then
Log " Removing soft deleted items older than $SOFT_DELETE_DAYS days on master replica. "
if [ $dryrun -eq 1 ]
then
$FIND_CMD " $MASTER_SYNC_DIR $MASTER_DELETE_DIR / " -ctime +$SOFT_DELETE_DAYS
else
$FIND_CMD " $MASTER_SYNC_DIR $MASTER_DELETE_DIR / " -ctime +$SOFT_DELETE_DAYS -exec rm -rf '{}' \;
fi
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $retval -ne 0 ]
then
LogError "Error while executing soft delete cleanup on master replica."
else
Log "Soft delete cleanup complete on master replica."
fi
elif [ -d " $MASTER_SYNC_DIR $MASTER_DELETE_DIR " ] && ! [ -w " $MASTER_SYNC_DIR $MASTER_DELETE_DIR " ]
then
LogError " Warning: Master replica deletion backup dir [ $MASTER_SYNC_DIR $MASTER_DELETE_DIR ] isn't writable. Cannot clean old files. "
fi
if [ " $REMOTE_SYNC " = = "yes" ]
then
CheckConnectivity3rdPartyHosts
CheckConnectivityRemoteHost
Log " Removing soft deleted items older than $SOFT_DELETE_DAYS days on remote slave replica. "
if [ $dryrun -eq 1 ]
then
eval " $SSH_CMD \"if [ -w \\\" $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR \\\" ]; then $COMMAND_SUDO $REMOTE_FIND_CMD \\\" $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR /\\\" -ctime + $SOFT_DELETE_DAYS ; fi\" "
else
eval " $SSH_CMD \"if [ -w \\\" $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR \\\" ]; then $COMMAND_SUDO $REMOTE_FIND_CMD \\\" $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR /\\\" -ctime + $SOFT_DELETE_DAYS -exec rm -rf '{}' \;; fi\" "
fi
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $retval -ne 0 ]
then
LogError "Error while executing soft delete cleanup on slave replica."
else
Log "Soft delete cleanup complete on slave replica."
fi
else
if [ -w " $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR " ]
then
Log " Removing soft deleted items older than $SOFT_DELETE_DAYS days on slave replica. "
if [ $dryrun -eq 1 ]
then
$FIND_CMD " $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR / " -ctime +$SOFT_DELETE_DAYS
else
$FIND_CMD " $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR / " -ctime +$SOFT_DELETE_DAYS -exec rm -rf '{}' \;
fi
child_pid = $!
WaitForCompletion $child_pid $SOFT_MAX_EXEC_TIME 0
retval = $?
if [ $retval -ne 0 ]
then
LogError "Error while executing soft delete cleanup on slave replica."
else
Log "Soft delete cleanup complete on slave replica."
fi
elif [ -d " $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR " ] && ! [ -w " $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR " ]
then
LogError " Warning: Slave replica deletion backup dir [ $SLAVE_SYNC_DIR $SLAVE_DELETE_DIR ] isn't writable. Cannot clean old files. "
fi
fi
fi
}
function Init
{
# Set error exit code if a piped command fails
set -o pipefail
set -o errtrace
# Do not use exit and quit traps if osync runs in monitor mode
if [ $sync_on_changes -eq 0 ]
then
trap TrapStop SIGINT SIGKILL SIGHUP SIGTERM SIGQUIT
trap TrapQuit SIGKILL EXIT
else
trap TrapQuit SIGTERM EXIT SIGKILL SIGHUP SIGQUIT
fi
if [ " $DEBUG " = = "yes" ]
then
trap 'TrapError ${LINENO} $?' ERR
fi
if [ " $LOGFILE " = = "" ]
then
if [ -w /var/log ]
then
LOG_FILE = /var/log/osync_$OSYNC_VERSION -$SYNC_ID .log
else
LOG_FILE = ./osync_$OSYNC_VERSION -$SYNC_ID .log
fi
else
LOG_FILE = " $LOGFILE "
fi
MAIL_ALERT_MSG = " Warning: Execution of osync instance $OSYNC_ID (pid $SCRIPT_PID ) as $LOCAL_USER @ $LOCAL_HOST produced errors on $( date) . "
## If running Msys, find command of windows is used instead of msys one
if [ " $LOCAL_OS " = = "msys" ]
then
FIND_CMD = $( dirname $BASH ) /find
else
FIND_CMD = find
fi
if [ " $REMOTE_OS " = = "msys" ]
then
REMOTE_FIND_CMD = $( dirname $BASH ) /find
else
REMOTE_FIND_CMD = find
fi
## Test if slave dir is a ssh uri, and if yes, break it down it its values
if [ " ${ SLAVE_SYNC_DIR : 0 : 6 } " = = "ssh://" ]
then
REMOTE_SYNC = "yes"
# remove leadng 'ssh://'
uri = ${ SLAVE_SYNC_DIR #ssh : //* }
# remove everything after '@'
_first_part = ${ uri %@* }
REMOTE_USER = ${ _first_part %;* }
#fingerprint=${_first_part#*fingerprint=}
if [ " $SSH_RSA_PRIVATE_KEY " = = "" ]
then
SSH_RSA_PRIVATE_KEY = ~/.ssh/id_rsa
fi
# remove everything before '@'
_last_part = ${ uri #*@ }
_last_part2 = ${ _last_part %%/* }
# remove last part if no port defined
REMOTE_HOST = ${ _last_part2 %% : * }
if [ [ " $_last_part2 " = = *":" * ] ]
then
REMOTE_PORT = ${ _last_part2 ##* : }
else
REMOTE_PORT = 22
fi
SLAVE_SYNC_DIR = ${ _last_part #*/ }
fi
## Make sure there is only one trailing slash on path
MASTER_SYNC_DIR = " ${ MASTER_SYNC_DIR %/ } / "
SLAVE_SYNC_DIR = " ${ SLAVE_SYNC_DIR %/ } / "
MASTER_STATE_DIR = " $MASTER_SYNC_DIR $OSYNC_DIR /state "
SLAVE_STATE_DIR = " $SLAVE_SYNC_DIR $OSYNC_DIR /state "
STATE_DIR = " $OSYNC_DIR /state "
MASTER_LOCK = " $MASTER_STATE_DIR /lock "
SLAVE_LOCK = " $SLAVE_STATE_DIR /lock "
if [ $dryrun -eq 1 ]
then
MASTER_LAST_ACTION = " $MASTER_STATE_DIR /dry-last-action "
else
MASTER_LAST_ACTION = " $MASTER_STATE_DIR /last-action "
fi
## Working directories to keep backups of updated / deleted files
MASTER_BACKUP_DIR = " $OSYNC_DIR /backups "
MASTER_DELETE_DIR = " $OSYNC_DIR /deleted "
SLAVE_BACKUP_DIR = " $OSYNC_DIR /backups "
SLAVE_DELETE_DIR = " $OSYNC_DIR /deleted "
## SSH compression
if [ " $SSH_COMPRESSION " != "no" ]
then
SSH_COMP = -C
else
SSH_COMP =
fi
## Define which runner (local bash or distant ssh) to use for standard commands and rsync commands
if [ " $REMOTE_SYNC " = = "yes" ]
then
SSH_CMD = " $( type -p ssh) $SSH_COMP -i $SSH_RSA_PRIVATE_KEY $REMOTE_USER @ $REMOTE_HOST -p $REMOTE_PORT "
RSYNC_SSH_CMD = " $( type -p ssh) $SSH_COMP -i $SSH_RSA_PRIVATE_KEY -p $REMOTE_PORT "
fi
## 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
## Set rsync options
RSYNC_ARGS = "-"
if [ " $PRESERVE_ACL " = = "yes" ]
then
RSYNC_ARGS = $RSYNC_ARGS "A"
fi
if [ " $PRESERVE_XATTR " = = "yes" ]
then
RSYNC_ARGS = $RSYNC_ARGS "X"
fi
if [ " $RSYNC_COMPRESS " = = "yes" ]
then
RSYNC_ARGS = $RSYNC_ARGS "z"
fi
if [ $dryrun -eq 1 ]
then
RSYNC_ARGS = $RSYNC_ARGS "n"
DRY_WARNING = "/!\ DRY RUN"
fi
if [ " $RSYNC_ARGS " = = "-" ]
then
RSYNC_ARGS = ""
fi
if [ " $BANDWIDTH " != "" ] && [ " $BANDWIDTH " != "0" ]
then
RSYNC_ARGS = $RSYNC_ARGS " --bwlimit= $BANDWIDTH "
fi
## Conflict options
if [ " $CONFLICT_BACKUP " != "no" ]
then
MASTER_BACKUP = " --backup --backup-dir=\" $MASTER_BACKUP_DIR \" "
SLAVE_BACKUP = " --backup --backup-dir=\" $SLAVE_BACKUP_DIR \" "
if [ " $CONFLICT_BACKUP_MULTIPLE " = = "yes" ]
then
MASTER_BACKUP = " $MASTER_BACKUP --suffix . $( date +%Y.%m.%d-%H.%M.%S) "
SLAVE_BACKUP = " $SLAVE_BACKUP --suffix . $( date +%Y.%m.%d-%H.%M.%S) "
fi
else
MASTER_BACKUP =
SLAVE_BACKUP =
fi
## Soft delete options
if [ " $SOFT_DELETE " != "no" ]
then
MASTER_DELETE = " --backup --backup-dir=\" $MASTER_DELETE_DIR \" "
SLAVE_DELETE = " --backup --backup-dir=\" $SLAVE_DELETE_DIR \" "
else
MASTER_DELETE =
SLAVE_DELETE =
fi
## Add Rsync exclude patterns
RsyncExcludePattern
}
function Main
{
CreateOsyncDirs
LockDirectories
Sync
}
function Usage
{
echo " $PROGRAM $PROGRAM_VERSION $PROGRAM_BUILD "
echo $AUTHOR
echo $CONTACT
echo ""
echo "You may use Osync with a full blown configuration file, or use its default options for quick command line sync."
echo "Usage: osync /path/to/config/file [OPTIONS]"
echo "or osync --master=/path/to/master/replica --slave=/path/to/slave/replica [OPTIONS] [QUICKSYNC OPTIONS]"
echo "or osync --master=/path/to/master/replica --slave=ssh://backupuser@remotehost.com[:portnumber]//path/to/slave/replica [OPTIONS] [QUICKSYNC OPTIONS]"
echo ""
echo "[OPTIONS]"
echo "--dry Will run osync without actually doing anything; just testing"
echo "--silent Will run osync without any output to stdout, used for cron jobs"
echo "--verbose Increases output"
echo "--no-maxtime Disables any soft and hard execution time checks"
echo "--force-unlock Will override any existing active or dead locks on master and slave replica"
echo "--on-changes Will launch a sync as soon as there is some file activity on master replica"
echo "--daemon When used with --on-changes, will launch osync as daemon."
echo ""
echo "[QUICKSYNC OPTIONS]"
echo "--master=\"\" Master replica path. Will contain state and backup directory (is mandatory)."
echo "--slave=\"\" Local or remote slave replica path. Can be a ssh uri like ssh://user@host.com:22//path/to/slave/replica (is mandatory)."
echo "--rsakey=\"\" Alternative path to rsa private key for ssh connection to slave replica"
exit 128
}
function SyncOnChanges
{
if ! type -p inotifywait > /dev/null 2>& 1
then
LogError "No inotifywait command found. Cannot monitor changes."
exit 1
fi
Log "#### Running Osync in file monitor mode."
while true
do
if [ " $ConfigFile " != "" ]
then
cmd = " bash $osync_cmd \" $ConfigFile \" $opts --no-locks "
else
cmd = " bash $osync_cmd $opts --no-locks "
fi
eval $cmd
if [ $? != 0 ]
then
LogError "osync child exited with error."
exit 1
fi
Log "#### Monitoring now."
inotifywait --exclude $OSYNC_DIR $RSYNC_EXCLUDE -qq -r -e create -e modify -e delete -e move -e attrib " $MASTER_SYNC_DIR " &
sub_pid = $!
wait $sub_pid
Log " #### Changes detected, waiting $MIN_WAIT seconds before running next sync. "
sleep $MIN_WAIT
done
}
# Comand line argument flags
dryrun = 0
silent = 0
verbose = 0
force_unlock = 0
no_maxtime = 0
# Alert flags
opts = ""
soft_alert_total = 0
error_alert = 0
soft_stop = 0
quick_sync = 0
sync_on_changes = 0
nolocks = 0
osync_cmd = $0
if [ $# -eq 0 ]
then
Usage
fi
for i in " $@ "
do
case $i in
--dry)
dryrun = 1
opts = $opts " --dry"
; ;
--silent)
silent = 1
opts = $opts " --silent"
; ;
--verbose)
verbose = 1
opts = $opts " --verbose"
; ;
--force-unlock)
force_unlock = 1
opts = $opts " --force-unlock"
; ;
--no-maxtime)
no_maxtime = 1
opts = $opts " --no-maxtime"
; ;
--help| -h| --version| -v)
Usage
; ;
--master= *)
quick_sync = $(( $quick_sync + 1 ))
no_maxtime = 1
MASTER_SYNC_DIR = ${ i ##*= }
opts = $opts " --master=\" $MASTER_SYNC_DIR \" "
; ;
--slave= *)
quick_sync = $(( $quick_sync + 1 ))
SLAVE_SYNC_DIR = ${ i ##*= }
opts = $opts " --slave=\" $SLAVE_SYNC_DIR \" "
no_maxtime = 1
; ;
--rsakey= *)
SSH_RSA_PRIVATE_KEY = ${ i ##*= }
opts = $opts " --rsakey=\" $SSH_RSA_PRIVATE_KEY \" "
; ;
--on-changes)
sync_on_changes = 1
; ;
--no-locks)
nolocks = 1
; ;
esac
done
# Remove leading space if there is one
opts = " ${ opts # * } "
CheckEnvironment
if [ $? = = 0 ]
then
if [ $quick_sync -eq 2 ]
then
SYNC_ID = "quicksync task"
MINIMUM_SPACE = 1024
REMOTE_SYNC = no
CONFLICT_BACKUP_DAYS = 30
SOFT_DELETE_DAYS = 30
RESUME_TRY = 1
MIN_WAIT = 30
else
ConfigFile = " $1 "
LoadConfigFile " $ConfigFile "
fi
Init
if [ $sync_on_changes -eq 1 ]
then
SyncOnChanges
else
DATE = $( date)
Log "-------------------------------------------------------------"
Log " $DRY_WARNING $DATE - $PROGRAM $PROGRAM_VERSION script begin. "
Log "-------------------------------------------------------------"
Log " Sync task [ $SYNC_ID ] launched as $LOCAL_USER @ $LOCAL_HOST (PID $SCRIPT_PID ) "
GetOperatingSystem
if [ $no_maxtime -eq 1 ]
then
SOFT_MAX_EXEC_TIME = 0
HARD_MAX_EXEC_TIME = 0
fi
CheckMasterSlaveDirs
CheckMinimumSpace
if [ $? = = 0 ]
then
RunBeforeHook
Main
if [ $? = = 0 ]
then
SoftDelete
fi
RunAfterHook
fi
fi
else
LogError "Environment not suitable to run osync."
exit 1
fi