-
Notifications
You must be signed in to change notification settings - Fork 52
/
rclone_jobber.sh
executable file
·137 lines (118 loc) · 5.99 KB
/
rclone_jobber.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
#!/usr/bin/env sh
# rclone_jobber.sh version 1.5.6
# Tutorial, backup-job examples, and source code at https://github.com/wolfv6/rclone_jobber
# Logging options are headed by "# set log". Details are in the tutorial's "Logging options" section.
################################### license ##################################
# rclone_jobber.sh is a script that calls rclone sync to perform a backup.
# Written in 2018 by Wolfram Volpi, contact at https://github.com/wolfv6/rclone_jobber/issues
# To the extent possible under law, the author(s) have dedicated all copyright and related and
# neighboring rights to this software to the public domain worldwide.
# This software is distributed without any warranty.
# You should have received a copy of the CC0 Public Domain Dedication along with this software.
# If not, see http://creativecommons.org/publicdomain/zero/1.0/.
# rclone_jobber is not affiliated with rclone.
################################# parameters #################################
source="$1" #the directory to back up (without a trailing slash)
dest="$2" #the directory to back up to (without a trailing slash or "last_snapshot") destination=$dest/last_snapshot
move_old_files_to="$3" #move_old_files_to is one of:
# "dated_directory" - move old files to a dated directory (an incremental backup)
# "dated_files" - move old files to old_files directory, and append move date to file names (an incremental backup)
# "" - old files are overwritten or deleted (a plain one-way sync backup)
options="$4" #rclone options like "--filter-from=filter_patterns --checksum --log-level="INFO" --dry-run"
#do not put these in options: --backup-dir, --suffix, --log-file
job_name="$5" #job_name="$(basename $0)"
monitoring_URL="$6" #cron monitoring service URL to send email if cron failure or other error prevented back up
################################ set variables ###############################
# $new is the directory name of the current snapshot
# $timestamp is time that old file was moved out of new (not time that file was copied from source)
new="last_snapshot"
timestamp="$(date +%F_%T)"
#timestamp="$(date +%F_%H%M%S)" #time w/o colons if thumb drive is FAT format, which does not allow colons in file name
# set log_file path
path="$(realpath "$0")" #this will place log in the same directory as this script
log_file="${path%.*}.log" #replace path extension with "log"
#log_file="/var/log/rclone_jobber.log" #for Logrotate
# set log_option for rclone
log_option="--log-file=$log_file" #log to log_file
#log_option="--syslog" #log to systemd journal
################################## functions #################################
send_to_log()
{
msg="$1"
# set log - send msg to log
echo "$msg" >> "$log_file" #log msg to log_file
#printf "$msg" | systemd-cat -t RCLONE_JOBBER -p info #log msg to systemd journal
}
# print message to echo, log, and popup
print_message()
{
urgency="$1"
msg="$2"
message="${urgency}: $job_name $msg"
echo "$message"
send_to_log "$(date +%F_%T) $message"
warning_icon="/usr/share/icons/Adwaita/32x32/emblems/emblem-synchronizing.png" #path in Fedora 28
# notify-send is a popup notification on most Linux desktops, install libnotify-bin
command -v notify-send && notify-send --urgency critical --icon "$warning_icon" "$message"
}
################################# range checks ################################
# if source is empty string
if [ -z "$source" ]; then
print_message "ERROR" "aborted because source is empty string."
exit 1
fi
# if dest is empty string
if [ -z "$dest" ]; then
print_message "ERROR" "aborted because dest is empty string."
exit 1
fi
# if source is empty
if ! test "rclone lsf --max-depth 1 $source"; then # rclone lsf requires rclone 1.40 or later
print_message "ERROR" "aborted because source is empty."
exit 1
fi
# if job is already running (maybe previous run didn't finish)
# https://github.com/wolfv6/rclone_jobber/pull/9 said this is not working in macOS
if pidof -o $PPID -x "$job_name"; then
print_message "WARNING" "aborted because it is already running."
exit 1
fi
############################### move_old_files_to #############################
# deleted or changed files are removed or moved, depending on value of move_old_files_to variable
# default move_old_files_to="" will remove deleted or changed files from backup
if [ "$move_old_files_to" = "dated_directory" ]; then
# move deleted or changed files to archive/$(date +%Y)/$timestamp directory
backup_dir="--backup-dir=$dest/archive/$(date +%Y)/$timestamp"
elif [ "$move_old_files_to" = "dated_files" ]; then
# move deleted or changed files to old directory, and append _$timestamp to file name
backup_dir="--backup-dir=$dest/old_files --suffix=_$timestamp"
elif [ "$move_old_files_to" != "" ]; then
print_message "WARNING" "Parameter move_old_files_to=$move_old_files_to, but should be dated_directory or dated_files.\
Moving old data to dated_directory."
backup_dir="--backup-dir=$dest/$timestamp"
fi
################################### back up ##################################
cmd="rclone sync $source $dest/$new $backup_dir $log_option $options"
# progress message
echo "Back up in progress $timestamp $job_name"
echo "$cmd"
# set logging to verbose
#send_to_log "$timestamp $job_name"
#send_to_log "$cmd"
eval $cmd
exit_code=$?
############################ confirmation and logging ########################
if [ "$exit_code" -eq 0 ]; then #if no errors
confirmation="$(date +%F_%T) completed $job_name"
echo "$confirmation"
send_to_log "$confirmation"
send_to_log ""
if [ ! -z "$monitoring_URL" ]; then
wget --quiet $monitoring_URL -O /dev/null
fi
exit 0
else
print_message "ERROR" "failed. rclone exit_code=$exit_code"
send_to_log ""
exit 1
fi