forked from orkaa/dt-s3-backup
-
Notifications
You must be signed in to change notification settings - Fork 187
/
duplicity-backup.sh
executable file
·1186 lines (1036 loc) · 37.7 KB
/
duplicity-backup.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env bash
#
# Copyright (c) 2008-2010 Damon Timm.
# Copyright (c) 2010 Mario Santagiuliana.
# Copyright (c) 2012-2018 Marc Gallet.
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
#
# MORE ABOUT THIS SCRIPT AVAILABLE IN THE README AND AT:
#
# http://zertrin.org/projects/duplicity-backup/ (for this version)
# http://damontimm.com/code/dt-s3-backup (for the original program by Damon Timm)
#
# Latest code available at:
# http://github.com/zertrin/duplicity-backup.sh
#
# List of contributors:
# https://github.com/zertrin/duplicity-backup.sh/graphs/contributors
#
# ---------------------------------------------------------------------------- #
# Default config file (don't forget to copy duplicity-backup.conf.example to
# match that path)
#
# NOTE: It is RECOMMENDED to use the command line option -c to specify the
# location of the config file. The CONFIG variable here is only used for
# fallback purposes (look for the file named 'duplicity-backup.conf' in
# the same folder as the script, if the option -c is not given).
# It is DEPRECATED to edit this.
CONFIG="duplicity-backup.conf"
##############################################################
# Script Happens Below This Line - Shouldn't Require Editing #
##############################################################
DBSH_VERSION="v1.6.0"
# make a backup of stdout and stderr for later
exec 6>&1
exec 7>&2
# ------------------------------------------------------------
usage(){
echo "USAGE:
$(basename "$0") [options]
Options:
-c, --config CONFIG_FILE specify the config file to use
-b, --backup runs an incremental backup
-f, --full forces a full backup
-v, --verify verifies the backup
-e, --cleanup cleanup the backup (eg. broken sessions), by default using
duplicity --force flag, use --dry-run to actually log what
will be cleaned up without removing (see man duplicity
> ACTIONS > cleanup for details)
-l, --list-current-files lists the files currently backed up in the archive
-s, --collection-status show all the backup sets in the archive
--restore [PATH] restores the entire backup to [path]
--restore-file [FILE_TO_RESTORE] [DESTINATION]
restore a specific file
--restore-dir [DIR_TO_RESTORE] [DESTINATION]
restore a specific directory
-t, --time TIME specify the time from which to restore or list files
(see duplicity man page for the format)
--backup-script automatically backup the script and secret key(s) to
the current working directory
-q, --quiet silence most of output messages, except errors and output
that are intended for interactive usage. Silenced output
is still logged in the logfile.
-n, --dry-run perform a trial run with no changes made
-d, --debug echo duplicity commands to logfile
-V, --version print version information about this script and duplicity
-h, --help print this help and exit
CURRENT SCRIPT VARIABLES:
========================
DEST (backup destination) = ${DEST}
INCLIST (directories included) = ${INCLIST[*]:0}
EXCLIST (directories excluded) = ${EXCLIST[*]:0}
ROOT (root directory of backup) = ${ROOT}
LOGFILE (log file path) = ${LOGFILE}
" >&6
USAGE=1
}
DUPLICITY="$(command -v duplicity)"
if [ ! -x "${DUPLICITY}" ]; then
echo "ERROR: duplicity not installed, that's gotta happen first!" >&2
exit 1
fi
DUPLICITY_VERSION=$(${DUPLICITY} --version)
DUPLICITY_VERSION=${DUPLICITY_VERSION//[^0-9\.]/}
version_compare() {
if [[ $1 =~ ^([0-9]+\.?)+$ && $2 =~ ^([0-9]+\.?)+$ ]]; then
# shellcheck disable=SC2206
local l=(${1//./ }) r=(${2//./ }) s=${#l[@]}; [[ ${#r[@]} -gt ${#l[@]} ]] && s=${#r[@]}
for i in $(seq 0 $((s - 1))); do
[[ ${l[$i]} -gt ${r[$i]} ]] && return 1
[[ ${l[$i]} -lt ${r[$i]} ]] && return 2
done
return 0
else
echo "Invalid version number given"
exit 1
fi
}
# set a flag if duplicity's version is lower than 0.7, for usage later in the script
version_compare "${DUPLICITY_VERSION}" 0.7
case $? in 2) LT07=1;; *) LT07=0;; esac
version(){
echo "duplicity-backup.sh ${DBSH_VERSION}"
echo "duplicity ${DUPLICITY_VERSION}"
exit 0
}
# Some expensive argument parsing that allows the script to
# be insensitive to the order of appearance of the options
# and to handle correctly option parameters that are optional
while getopts ":c:t:bfvelsqndhV-:" opt; do
case $opt in
# parse long options (a bit tricky because builtin getopts does not
# manage long options and I don't want to impose GNU getopt dependancy)
-)
case "${OPTARG}" in
# --restore [restore dest]
restore)
COMMAND=${OPTARG}
# We try to find the optional value [restore dest]
if [ -n "${!OPTIND:0:1}" ] && [ ! "${!OPTIND:0:1}" = "-" ]; then
RESTORE_DEST=${!OPTIND}
OPTIND=$(( OPTIND + 1 )) # we found it, move forward in arg parsing
fi
;;
# --restore-file [file to restore] [restore dest]
# --restore-dir [path to restore] [restore dest]
restore-file|restore-dir)
COMMAND=${OPTARG}
# We try to find the first optional value [file to restore]
if [ -n "${!OPTIND:0:1}" ] && [ ! "${!OPTIND:0:1}" = "-" ]; then
FILE_TO_RESTORE=${!OPTIND}
OPTIND=$(( OPTIND + 1 )) # we found it, move forward in arg parsing
else
continue # no value for the restore-file option, skip the rest
fi
# We try to find the second optional value [restore dest]
if [ -n "${!OPTIND:0:1}" ] && [ ! "${!OPTIND:0:1}" = "-" ]; then
RESTORE_DEST=${!OPTIND}
OPTIND=$(( OPTIND + 1 )) # we found it, move forward in arg parsing
fi
;;
config) # set the config file from the command line
# We try to find the config file
if [ -n "${!OPTIND:0:1}" ] && [ ! "${!OPTIND:0:1}" = "-" ]; then
CONFIG=${!OPTIND}
OPTIND=$(( OPTIND + 1 )) # we found it, move forward in arg parsing
fi
;;
time) # set the restore time from the command line
# We try to find the restore time
if [ -n "${!OPTIND:0:1}" ] && [ ! "${!OPTIND:0:1}" = "-" ]; then
TIME=${!OPTIND}
OPTIND=$(( OPTIND + 1 )) # we found it, move forward in arg parsing
fi
;;
quiet)
QUIET=1
;;
dry-run)
DRY_RUN="--dry-run"
;;
debug)
ECHO=$(command -v echo)
;;
help)
usage
exit 0
;;
version)
version
;;
*)
COMMAND=${OPTARG}
;;
esac
;;
# here are parsed the short options
c) CONFIG=${OPTARG};; # set the config file from the command line
t) TIME=${OPTARG};; # set the restore time from the command line
b) COMMAND="backup";;
f) COMMAND="full";;
v) COMMAND="verify";;
e) COMMAND="cleanup";;
l) COMMAND="list-current-files";;
s) COMMAND="collection-status";;
q) QUIET=1;;
n) DRY_RUN="--dry-run";; # dry run
d) ECHO=$(command -v echo);; # debug
h)
usage
exit 0
;;
V) version;;
:)
echo "Option -${OPTARG} requires an argument." >&2
COMMAND=""
;;
\?)
echo "Invalid option: -${OPTARG}" >&2
COMMAND=""
;;
esac
done
#echo "Options parsed. COMMAND=${COMMAND}" # for debugging
# ---------------- Read config file if specified -----------------
if [ -n "${CONFIG}" ] && [ -f "${CONFIG}" ];
then
# shellcheck source=duplicity-backup.conf.example
. "${CONFIG}"
else
echo "ERROR: can't find config file! (${CONFIG})" >&2
usage
exit 1
fi
# ----------------------- Setup logging ---------------------------
# Setup logging as soon as possible, in order to be able to perform i/o redirection
[[ ${LOGDIR} = "/home/foobar_user_name/logs/test2/" ]] && config_sanity_fail "LOGDIR must be configured"
# Ensure a trailing slash always exists in the log directory name
LOGDIR="${LOGDIR%/}/"
LOGFILE="${LOGDIR}${LOG_FILE}"
if [ ! -d "${LOGDIR}" ]; then
echo "Attempting to create log directory ${LOGDIR} ..."
if ! mkdir -p "${LOGDIR}"; then
echo "Log directory ${LOGDIR} could not be created by this user: ${USER}" >&2
echo "Aborting..." >&2
exit 1
else
echo "Directory ${LOGDIR} successfully created."
fi
echo "Attempting to change owner:group of ${LOGDIR} to ${LOG_FILE_OWNER} ..."
if ! chown "${LOG_FILE_OWNER}" "${LOGDIR}"; then
echo "User ${USER} could not change the owner:group of ${LOGDIR} to ${LOG_FILE_OWNER}" >&2
echo "Aborting..." >&2
exit 1
else
echo "Directory ${LOGDIR} successfully changed to owner:group of ${LOG_FILE_OWNER}"
fi
elif [ ! -w "${LOGDIR}" ]; then
echo "Log directory ${LOGDIR} is not writeable by this user: ${USER}" >&2
echo "Aborting..." >&2
exit 1
fi
# -------------------- Setup I/O redirections --------------------
# Magic from
# http://superuser.com/questions/86915/force-bash-script-to-use-tee-without-piping-from-the-command-line
#
# ##### Redirection matrix in the case when quiet mode is ON #####
#
# QUIET mode ON | shown on screen | not shown on screen
# ---------------+-----------------+----------------------
# logged | fd2, fd3 | fd1, fd5
# not logged | fd4 | -
#
# ##### Redirection matrix in the case when quiet mode is OFF #####
#
# QUIET mode OFF | shown on screen | not shown on screen
# ---------------+-----------------+----------------------
# logged | fd1, fd2, fd3 | fd5
# not logged | fd4 | -
#
# fd1 is stdout and is always logged but only shown if not QUIET
# fd2 is stderr and is always shown on screen and logged
# fd3 is like stdout but always shown on screen (for interactive prompts)
# fd4 is always shown on screen but never logged (for the usage text)
# fd5 is never shown on screen but always logged (for delimiters in the log)
#
# fd2 and fd3 are always logged and shown on screen via tee
# for fd2 (original stderr) the output of tee needs to be redirected to stderr
exec 2> >(tee -ia "${LOGFILE}" >&2)
# create fd3 as a redirection to stdout and the logfile via tee
exec 3> >(tee -ia "${LOGFILE}")
# create fd4 as a copy of stdout, but that won't be redirected to tee
# so that it is always shown and never logged
exec 4>&1
# create fd5 as a direct redirection to the logfile
# so that the content is never shown on screen but always logged
exec 5>> "${LOGFILE}"
# finally we modify stdout (fd1) to always being logged (like fd3 and fd5)
# but only being shown on screen if quiet mode is not active
if [[ ${QUIET} == 1 ]]; then
# Quiet mode: stdout not shown on screen but still logged via fd5
exec 1>&5
else
# Normal mode: stdout shown on screen and logged via fd3
exec 1>&3
fi
# tests for debugging the magic
#echo "redirected to fd1"
#echo "redirected to fd2" >&2
#echo "redirected to fd3" >&3
#echo "redirected to fd4" >&4
#echo "redirected to fd5" >&5
# ------------------------- Setting up variables ------------------------
if [ -n "${DRY_RUN}" ]; then
STATIC_OPTIONS="${DRY_RUN} ${STATIC_OPTIONS}"
fi
if [ -n "${STORAGECLASS}" ]; then
STATIC_OPTIONS="${STATIC_OPTIONS} ${STORAGECLASS}"
fi
SIGN_PASSPHRASE=${PASSPHRASE}
export AWS_ACCESS_KEY_ID
export AWS_SECRET_ACCESS_KEY
export GS_ACCESS_KEY_ID
export GS_SECRET_ACCESS_KEY
export SWIFT_USERNAME
export SWIFT_PASSWORD
export SWIFT_AUTHURL
export SWIFT_AUTHVERSION
export SWIFT_TENANTNAME
export SWIFT_REGIONNAME
export DPBX_ACCESS_TOKEN
export PASSPHRASE
export SIGN_PASSPHRASE
if [[ -n "${FTP_PASSWORD}" ]]; then
export FTP_PASSWORD
fi
if [[ -n "${TMPDIR}" ]]; then
export TMPDIR
fi
# File to use as a lock. The lock is used to insure that only one instance of
# the script is running at a time.
LOCKFILE=${LOGDIR}backup.lock
if [ "${ENCRYPTION}" = "yes" ]; then
ENCRYPT="--gpg-options \"${GPG_OPTIONS}\""
if [ -n "${GPG_ENC_KEY}" ] && [ -n "${GPG_SIGN_KEY}" ]; then
if [ "${HIDE_KEY_ID}" = "yes" ]; then
ENCRYPT="${ENCRYPT} --hidden-encrypt-key=${GPG_ENC_KEY}"
if [ "${COMMAND}" != "restore" ] && [ "${COMMAND}" != "restore-file" ] && [ "${COMMAND}" != "restore-dir" ]; then
ENCRYPT="${ENCRYPT} --sign-key=${GPG_SIGN_KEY}"
fi
else
ENCRYPT="${ENCRYPT} --encrypt-key=${GPG_ENC_KEY} --sign-key=${GPG_SIGN_KEY}"
fi
if [ -n "${SECRET_KEYRING}" ]; then
KEYRING="--secret-keyring ${SECRET_KEYRING}"
ENCRYPT="${ENCRYPT} --encrypt-secret-keyring=${SECRET_KEYRING}"
fi
elif [ -n "${PASSPHRASE}" ]; then
ENCRYPT=""
fi
elif [ "${ENCRYPTION}" = "no" ]; then
ENCRYPT="--no-encryption"
fi
NO_GSCMD="WARNING: gsutil not found in PATH, remote file \
size information unavailable."
NO_GSCMD_CFG="WARNING: gsutil is not configured, run 'gsutil config' \
in order to retrieve remote file size information. Remote file \
size information unavailable."
NO_S3CMD="WARNING: s3cmd not found in PATH, remote file \
size information unavailable."
NO_S3CMD_CFG="WARNING: s3cmd is not configured, run 's3cmd --configure' \
in order to retrieve remote file size information. Remote file \
size information unavailable."
NO_B2CMD="WARNING: b2 not found in PATH, remote file size information \
unavailable. Is the python-b2 package installed?"
README_TXT="In case you've long forgotten, this is a backup script that you used to backup some files (most likely remotely at Amazon S3). In order to restore these files, you first need to import your GPG private(s) key(s) (if you haven't already). The key(s) is/are in this directory and the following command(s) should do the trick:\n\nIf you were using the same key for encryption and signature:\n gpg --allow-secret-key-import --import duplicity-backup-encryption-and-sign-secret.key.txt\nOr if you were using two separate keys for encryption and signature:\n gpg --allow-secret-key-import --import duplicity-backup-encryption-secret.key.txt\n gpg --allow-secret-key-import --import duplicity-backup-sign-secret.key.txt\n\nAfter your key(s) has/have been succesfully imported, you should be able to restore your files.\n\nGood luck!"
if [ "$(echo "${DEST}" | cut -c 1,2)" = "gs" ]; then
DEST_IS_GS=true
GSCMD="$(command -v gsutil)"
if [ ! -x "${GSCMD}" ]; then
echo "${NO_GSCMD}"; GSCMD_AVAIL=false
elif [ ! -f "${HOME}/.boto" ]; then
echo "${NO_GSCMD_CFG}"; GSCMD_AVAIL=false
else
GSCMD_AVAIL=true
GSCMD="${GSCMD}"
fi
else
DEST_IS_GS=false
fi
if [ "$(echo "${DEST}" | cut -c 1,2)" = "s3" ]; then
DEST_IS_S3=true
S3CMD="$(command -v s3cmd)"
if [ ! -x "${S3CMD}" ]; then
echo "${NO_S3CMD}"; S3CMD_AVAIL=false
elif [ -z "${S3CMD_CONF_FILE}" ] && [ ! -f "${HOME}/.s3cfg" ]; then
S3CMD_CONF_FOUND=false
echo "${NO_S3CMD_CFG}"; S3CMD_AVAIL=false
elif [ -n "${S3CMD_CONF_FILE}" ] && [ ! -f "${S3CMD_CONF_FILE}" ]; then
S3CMD_CONF_FOUND=false
echo "${S3CMD_CONF_FILE} not found, check S3CMD_CONF_FILE variable in duplicity-backup's configuration!";
echo "${NO_S3CMD_CFG}";
S3CMD_AVAIL=false
else
S3CMD_AVAIL=true
S3CMD_CONF_FOUND=true
if [ -n "${S3CMD_CONF_FILE}" ] && [ -f "${S3CMD_CONF_FILE}" ]; then
# if conf file specified and it exists then add it to the command line for s3cmd
S3CMD="${S3CMD} -c ${S3CMD_CONF_FILE}"
fi
fi
else
DEST_IS_S3=false
fi
if [ "$(echo "${DEST}" | cut -c 1,4)" = "dpbx" ]; then
DEST_IS_DPBX=true
else
DEST_IS_DPBX=false
fi
if [ "$(echo "${DEST}" | cut -c 1,2)" = "b2" ]; then
DEST_IS_B2=true
B2CMD="$(command -v b2)"
if [ ! -x "${B2CMD}" ]; then
echo "${NO_B2CMD}"; B2CMD_AVAIL=false
fi
else
DEST_IS_B2=false
fi
config_sanity_fail()
{
EXPLANATION=$1
CONFIG_VAR_MSG="Oops!! ${0} was unable to run!\nWe are missing one or more important variables in the configuration file.\nCheck your configuration because it appears that something has not been set yet."
echo -e "${CONFIG_VAR_MSG}\n ${EXPLANATION}." >&2
echo -e "--------------------- END ---------------------\n" >&5
exit 1
}
check_variables ()
{
[[ ${ROOT} = "" ]] && config_sanity_fail "ROOT must be configured"
[[ ${DEST} = "" || ${DEST} = "s3+http://backup-foobar-bucket/backup-folder/" ]] && config_sanity_fail "DEST must be configured"
[[ ${INCLIST[0]} = "/home/foobar_user_name/Documents/" ]] && config_sanity_fail "INCLIST must be configured"
[[ ${EXCLIST[0]} = "/home/foobar_user_name/Documents/foobar-to-exclude" ]] && config_sanity_fail "EXCLIST must be configured"
[[ ( ${ENCRYPTION} = "yes" && (${GPG_ENC_KEY} = "foobar_gpg_key" || \
${GPG_SIGN_KEY} = "foobar_gpg_key" || \
${PASSPHRASE} = "foobar_gpg_passphrase")) ]] && \
config_sanity_fail "ENCRYPTION is set to 'yes', but GPG_ENC_KEY, GPG_SIGN_KEY, or PASSPHRASE have not been configured"
[[ ( ${DEST_IS_S3} = true && (${AWS_ACCESS_KEY_ID} = "foobar_aws_key_id" || ${AWS_SECRET_ACCESS_KEY} = "foobar_aws_access_key" )) ]] && \
config_sanity_fail "An s3 DEST has been specified, but AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY have not been configured"
[[ ( ${DEST_IS_GS} = true && (${GS_ACCESS_KEY_ID} = "foobar_gcs_key_id" || ${GS_SECRET_ACCESS_KEY} = "foobar_gcs_secret_id" )) ]] && \
config_sanity_fail "A Google Cloud Storage DEST has been specified, but GS_ACCESS_KEY_ID or GS_SECRET_ACCESS_KEY have not been configured"
[[ ( ${DEST_IS_DPBX} = true && (${DPBX_ACCESS_TOKEN} = "foobar_dropbox_access_token" )) ]] && \
config_sanity_fail "A Dropbox DEST has been specified, but DPBX_ACCESS_TOKEN has not been configured"
[[ -n "${INCEXCFILE}" && ! -f ${INCEXCFILE} ]] && config_sanity_fail "The specified INCEXCFILE ${INCEXCFILE} does not exists"
}
mailcmd_sendmail() {
# based on http://linux.die.net/man/8/sendmail.sendmail
echo -e "From: ${EMAIL_FROM}\nSubject: ${EMAIL_SUBJECT}\n" | cat - "${LOGFILE}" | ${MAILCMD} "${EMAIL_TO}"
}
mailcmd_ssmtp() {
# based on http://linux.die.net/man/8/ssmtp
echo -e "From: ${EMAIL_FROM}\nSubject: ${EMAIL_SUBJECT}\n" | cat - "${LOGFILE}" | ${MAILCMD} "${EMAIL_TO}"
}
mailcmd_msmtp() {
# based on http://manpages.ubuntu.com/manpages/precise/en/man1/msmtp.1.html
echo -e "Subject: ${EMAIL_SUBJECT}\n" | cat - "${LOGFILE}" | ${MAILCMD} -f "${EMAIL_FROM}" -- "${EMAIL_TO}"
}
mailcmd_bsd_mailx() {
# based on http://man.he.net/man1/bsd-mailx
${MAILCMD} -s "${EMAIL_SUBJECT}" -a "From: ${EMAIL_FROM}" "${EMAIL_TO}" < "${LOGFILE}"
}
mailcmd_heirloom_mailx() {
# based on http://heirloom.sourceforge.net/mailx/mailx.1.html
${MAILCMD} -s "${EMAIL_SUBJECT}" -S from="${EMAIL_FROM}" "${EMAIL_TO}" < "${LOGFILE}"
}
mailcmd_nail() {
# based on http://linux.die.net/man/1/nail
${MAILCMD} -s "${EMAIL_SUBJECT}" -r "${EMAIL_FROM}" "${EMAIL_TO}" < "${LOGFILE}"
}
mailcmd_else() {
${MAILCMD} "${EMAIL_SUBJECT}" "${EMAIL_FROM}" "${EMAIL_TO}" < "${LOGFILE}"
}
email_logfile()
{
if [ -n "${EMAIL_TO}" ]; then
MAILCMD=$(command -v "${MAIL}")
MAILCMD_REALPATH=$(readlink -e "${MAILCMD}")
MAILCMD_BASENAME=${MAILCMD_REALPATH##*/}
if [ ! -x "${MAILCMD}" ]; then
echo -e "Email couldn't be sent. ${MAIL} not available." >&2
else
EMAIL_SUBJECT=${EMAIL_SUBJECT:="duplicity-backup ${BACKUP_STATUS:-"ERROR"} (${HOSTNAME}) ${LOG_FILE}"}
case ${MAIL} in
ssmtp)
mailcmd_ssmtp;;
msmtp)
mailcmd_msmtp;;
mail|mailx)
case ${MAILCMD_BASENAME} in
bsd-mailx|mail.mailutils)
mailcmd_bsd_mailx;;
heirloom-mailx)
mailcmd_heirloom_mailx;;
s-nail)
mailcmd_nail;;
*)
mailcmd_else;;
esac
;;
sendmail)
mailcmd_sendmail;;
nail)
mailcmd_nail;;
*)
mailcmd_else;;
esac
echo -e "Email notification sent to ${EMAIL_TO} using ${MAIL}"
fi
fi
}
send_notification()
{
if [ -n "${NOTIFICATION_SERVICE}" ]; then
echo "-----------[ Notification Request ]-----------"
NOTIFICATION_CONTENT="duplicity-backup ${BACKUP_STATUS:-"ERROR"} [${HOSTNAME}] - \`${LOGFILE}\`"
if [ "${NOTIFICATION_SERVICE}" = "slack" ]; then
curl -X POST -H 'Content-type: application/json' --data "{\"text\": \"${NOTIFICATION_CONTENT}\", \"channel\": \"${SLACK_CHANNEL}\", \"username\": \"${SLACK_USERNAME}\", \"icon_emoji\": \":${SLACK_EMOJI}:\"}" "${SLACK_HOOK_URL}"
elif [ "${NOTIFICATION_SERVICE}" = "ifttt" ]; then
curl -X POST -H 'Content-type: application/json' --data "{\"value1\": \"${NOTIFICATION_CONTENT}\", \"value2\": \"${IFTTT_VALUE2}\"}" "${IFTTT_HOOK_URL}"
elif [ "${NOTIFICATION_SERVICE}" = "pushover" ]; then
curl -s \
-F "token=${PUSHOVER_TOKEN}" \
-F "user=${PUSHOVER_USER}" \
-F "message=${NOTIFICATION_CONTENT}" \
https://api.pushover.net/1/messages
elif [ "${NOTIFICATION_SERVICE}" = "telegram" ]; then
curl -s --max-time 10 -d "chat_id=${TELEGRAM_CHATID}&disable_web_page_preview=1&text=${NOTIFICATION_CONTENT}" "https://api.telegram.org/bot${TELEGRAM_KEY}/sendMessage" >/dev/null
fi
echo -e "\n----------------------------------------------\n"
if [ "${NOTIFICATION_SERVICE}" = "slack" ]; then
echo -e "Slack notification sent to channel ${SLACK_CHANNEL}"
elif [ "${NOTIFICATION_SERVICE}" = "ifttt" ]; then
echo -e "IFTTT notification sent to Maker channel event ${IFTTT_EVENT}"
elif [ "${NOTIFICATION_SERVICE}" = "pushover" ]; then
echo -e "Pushover notification sent"
elif [ "${NOTIFICATION_SERVICE}" = "telegram" ]; then
echo -e "Telegram notification sent"
fi
fi
}
get_lock()
{
echo "Attempting to acquire lock ${LOCKFILE}" >&5
if ( set -o noclobber; echo "$$" > "${LOCKFILE}" ) 2> /dev/null; then
# The lock succeeded. Create a signal handler to remove the lock file when the process terminates.
trap 'EXITCODE=$?; echo "Removing lock. Exit code: ${EXITCODE}" >> ${LOGFILE}; rm -f "${LOCKFILE}"' EXIT
echo "successfully acquired lock." >&5
else
# Write lock acquisition errors to log file and stderr
echo "lock failed, could not acquire ${LOCKFILE}" >&2
echo "lock held by $(cat "${LOCKFILE}")" >&2
email_logfile
send_notification
exit 2
fi
}
get_source_file_size()
{
echo "-----------[ Source Disk Use Information ]-----------"
# FIXME: doesn't work properly with include/exclude-filelists (issue #101)
# Patches to support spaces in paths-
# Remove space as a field separator temporarily
OLDIFS=$IFS
IFS=$(echo -en "\t\n")
case $(uname) in
FreeBSD|Darwin|DragonFly)
DUEXCFLAG="-I -"
;;
OpenBSD)
echo "WARNING: OpenBSD du does not support exclusion, sizes may be off"
DUEXCFLAG=""
;;
*)
DUEXCFLAG="--exclude-from=-"
;;
esac
# always exclude /proc
DUEXCLIST="/proc\n"
for exclude in "${EXCLIST[@]}"; do
DUEXCLIST="${DUEXCLIST}${exclude}\n"
done
# if INCLIST is not set or empty, add ROOT to it to be able to calculate disk usage
if [ ${#INCLIST[@]} -eq 0 ]; then
DUINCLIST=("${ROOT}")
else
DUINCLIST=("${INCLIST[@]}")
fi
for include in "${DUINCLIST[@]}"; do
# shellcheck disable=SC2216
echo -e "${DUEXCLIST}" | \
du -hs ${DUEXCFLAG} "${include}" | \
awk '{ FS="\t"; $0=$0; print $1"\t"$2 }'
done
echo
# Restore IFS
IFS=$OLDIFS
}
get_remote_file_size()
{
echo "---------[ Destination Disk Use Information ]--------"
FRIENDLY_TYPE_NAME=""
dest_type=$(echo "${DEST}" | cut -c 1,2)
case $dest_type in
"ss")
FRIENDLY_TYPE_NAME="SSH"
TMPDEST="${DEST#*://*/}"
TMPDEST="${DEST%/${TMPDEST}}"
ssh_opt=$(echo "${STATIC_OPTIONS}" |awk -vo="--ssh-options=" '{s=index($0,o); if (s) {s=substr($0,s+length(o)); m=substr(s,0,1); for (i=2; i < length(s); i++) { if (substr(s,i,1) == m && substr(s,i-1,1) != "\\\\") break; } print substr(s,2,i-2)}}')
SIZE=$(${TMPDEST%://*} "${ssh_opt}" "${TMPDEST#*//}" du -hs "${DEST#${TMPDEST}/}" | awk '{print $1}')
EMAIL_SUBJECT="${EMAIL_SUBJECT} ${SIZE} $(${TMPDEST%://*} "${ssh_opt}" "${TMPDEST#*//}" df -hP "${DEST#${TMPDEST}/}" | awk '{tmp=$5 " used"}END{print tmp}')"
;;
"fi")
FRIENDLY_TYPE_NAME="File"
TMPDEST="${DEST#file://*}"
SIZE=$(du -hs "${TMPDEST}" | awk '{print $1}')
;;
"gs")
FRIENDLY_TYPE_NAME="Google Cloud Storage"
if ${GSCMD_AVAIL} ; then
#TMPDEST=$(echo "${DEST}" | sed -e "s/\/*$//" )
TMPDEST=${DEST//\/*$/}
SIZE=$(gsutil du -hs "${TMPDEST}" | awk '{print $1$2}')
fi
;;
"s3")
FRIENDLY_TYPE_NAME="Amazon S3"
if ${S3CMD_AVAIL} ; then
TMPDEST=$(echo "${DEST}" | cut -f 3- -d /)
dest_scheme=$(echo "${DEST}" | cut -f -1 -d :)
if [ "$dest_scheme" = "s3" ]; then
# Strip off the host name, too.
TMPDEST=$(echo "${TMPDEST}" | cut -f 2- -d /)
fi
SIZE=$(${S3CMD} du -H s3://"${TMPDEST}" | awk '{print $1}')
else
if ! ${S3CMD_CONF_FOUND} ; then
SIZE="-s3cmd config not found-"
else
SIZE="-s3cmd not found in PATH-"
fi
fi
;;
"b2")
FRIENDLY_TYPE_NAME="Backblaze B2"
if ${B2CMD_AVAIL}; then
if [[ -n ${FTP_PASSWORD} ]]; then
APP_KEY=${FTP_PASSWORD}
else
APP_KEY=$(echo "${DEST}" | cut -d":" -f 3 | cut -d"@" -f 1)
fi
ACC_ID=$(echo "${DEST}" | cut -d"/" -f 3 | cut -d"@" -f 1 | cut -d ":" -f 1)
BUCKET=$(echo "${DEST}" | cut -d"@" -f2 | cut -d"/" -f1)
if [[ -z ${APP_KEY} ]] || [[ -z ${ACC_ID} ]]; then
SIZE="-b2 authentication wrong-"
return
fi
if [[ -z ${BUCKET} ]]; then
SIZE="-b2 bucket wrong-"
return
fi
if [[ $(${B2CMD} authorize-account "${ACC_ID}" "${APP_KEY}" >/dev/null 2>&1) -ne 0 ]]; then
SIZE="-b2 authentication wrong-"
return
fi
SIZE=$(${B2CMD} ls --long "${BUCKET}" | awk '{ print $5 }' | paste -sd+ | bc | numfmt --to=iec)
else
SIZE="-b2 not found in PATH-"
fi
;;
*)
# not yet available for the other backends
FRIENDLY_TYPE_NAME=""
;;
esac
if [[ ${FRIENDLY_TYPE_NAME} ]] ; then
echo -e "${SIZE}\t${FRIENDLY_TYPE_NAME} type backend"
else
echo "Destination disk use information is currently only available for the following storage backends:"
echo "File, SSH, Amazon S3, Google Cloud and Backblaze B2"
fi
echo
}
include_exclude()
{
# Changes to handle spaces in directory names and filenames
# and wrapping the files to include and exclude in quotes.
OLDIFS=$IFS
IFS=$(echo -en "\t\n")
# Exclude device files?
if [ -n "${EXDEVICEFILES}" ] && [ "${EXDEVICEFILES}" -ne 0 ]; then
TMP=" --exclude-device-files"
EXCLUDE=${EXCLUDE}${TMP}
fi
for include in "${INCLIST[@]}"
do
if [[ -n "$include" ]]; then
TMP=" --include='$include'"
INCLUDE=${INCLUDE}${TMP}
fi
done
for exclude in "${EXCLIST[@]}"
do
if [[ -n "$exclude" ]]; then
TMP=" --exclude '$exclude'"
EXCLUDE=${EXCLUDE}${TMP}
fi
done
# Include/Exclude globbing filelist
if [ "${INCEXCFILE}" != '' ]; then
if [ ${LT07} -eq 1 ]; then
TMP=" --include-globbing-filelist '${INCEXCFILE}'"
else
TMP=" --include-filelist '${INCEXCFILE}'"
fi
INCLUDE=${INCLUDE}${TMP}
fi
# INCLIST and globbing filelist is empty so every file needs to be saved
if [ ${#INCLIST[@]} -eq 0 ] && [ "${INCEXCFILE}" == '' ]; then
EXCLUDEROOT=''
else
EXCLUDEROOT="--exclude=**"
fi
# Restore IFS
IFS=$OLDIFS
}
duplicity_cleanup()
{
echo "----------------[ Duplicity Cleanup ]----------------"
if [[ "${CLEAN_UP_TYPE}" != "none" && -n ${CLEAN_UP_TYPE} && -n ${CLEAN_UP_VARIABLE} ]]; then
{
eval "${ECHO}" "${DUPLICITY}" "${CLEAN_UP_TYPE}" "${CLEAN_UP_VARIABLE}" "${STATIC_OPTIONS}" --force \
"${ENCRYPT}" \
"${DEST}"
} || {
BACKUP_ERROR=1
}
echo
fi
if [ -n "${REMOVE_INCREMENTALS_OLDER_THAN}" ] && [[ ${REMOVE_INCREMENTALS_OLDER_THAN} =~ ^[0-9]+$ ]]; then
{
eval "${ECHO}" "${DUPLICITY}" remove-all-inc-of-but-n-full "${REMOVE_INCREMENTALS_OLDER_THAN}" \
"${STATIC_OPTIONS}" --force \
"${ENCRYPT}" \
"${DEST}"
} || {
BACKUP_ERROR=1
}
echo
fi
}
duplicity_backup()
{
{
eval "${ECHO}" "${DUPLICITY}" "${OPTION}" "${VERBOSITY}" "${STATIC_OPTIONS}" \
"${ENCRYPT}" \
"${EXCLUDE}" \
"${INCLUDE}" \
"${EXCLUDEROOT}" \
"${ROOT}" "${DEST}"
} || {
BACKUP_ERROR=1
}
}
duplicity_cleanup_failed()
{
{
eval "${ECHO}" "${DUPLICITY}" "${OPTION}" "${VERBOSITY}" "${STATIC_OPTIONS}" \
"${ENCRYPT}" \
"${DEST}"
} || {
BACKUP_ERROR=1
}
}
setup_passphrase()
{
if [ -n "${GPG_ENC_KEY}" ] && [ -n "${GPG_SIGN_KEY}" ] && [ "${GPG_ENC_KEY}" != "${GPG_SIGN_KEY}" ]; then
echo -n "Please provide the passphrase for decryption (GPG key 0x${GPG_ENC_KEY}): " >&3
builtin read -s -r ENCPASSPHRASE
echo -ne "\n" >&3
PASSPHRASE=${ENCPASSPHRASE}
export PASSPHRASE
fi
}
get_file_sizes()
{
get_source_file_size
get_remote_file_size
}
backup_this_script()
{
if [ "$(echo "${0}" | cut -c 1)" = "." ]; then
SCRIPTFILE=$(echo "${0}" | cut -c 2-)
SCRIPTPATH=$(pwd)${SCRIPTFILE}
else
SCRIPTPATH=$(command -v "${0}")
fi
TMPDIR=duplicity-backup-$(date +%Y-%m-%d)
TMPFILENAME=${TMPDIR}.tar.gpg
README=${TMPDIR}/README
echo "You are backing up: " >&3
echo " 1. ${SCRIPTPATH}" >&3
if [ -n "${GPG_ENC_KEY}" ] && [ -n "${GPG_SIGN_KEY}" ]; then
if [ "${GPG_ENC_KEY}" = "${GPG_SIGN_KEY}" ]; then
echo " 2. GPG Secret encryption and sign key: ${GPG_ENC_KEY}" >&3
else
echo " 2. GPG Secret encryption key: ${GPG_ENC_KEY} and GPG secret sign key: ${GPG_SIGN_KEY}" >&3
fi
else
echo " 2. GPG Secret encryption and sign key: none (symmetric encryption)" >&3
fi
if [ -n "${CONFIG}" ] && [ -f "${CONFIG}" ];
then
echo " 3. Config file: ${CONFIG}" >&3
fi
if [ -n "${INCEXCFILE}" ] && [ -f "${INCEXCFILE}" ];
then
echo " 4. Include/Exclude globbing file: ${INCEXCFILE}" >&3
fi
echo "Backup tarball will be encrypted and saved to: $(pwd)/${TMPFILENAME}" >&3
echo >&3
echo ">> Are you sure you want to do that ('yes' to continue)?" >&3
read -r ANSWER
if [ "${ANSWER}" != "yes" ]; then
echo "You said << ${ANSWER} >> so I am exiting now." >&3
echo -e "--------------------- END ---------------------\n" >&5
exit 1
fi
mkdir -p "${TMPDIR}"
cp "${SCRIPTPATH}" "${TMPDIR}"/
if [ -n "${CONFIG}" ] && [ -f "${CONFIG}" ];
then
cp "${CONFIG}" "${TMPDIR}"/
fi
if [ -n "${INCEXCFILE}" ] && [ -f "${INCEXCFILE}" ];
then
cp "${INCEXCFILE}" "${TMPDIR}"/
fi
if [ -n "${GPG_ENC_KEY}" ] && [ -n "${GPG_SIGN_KEY}" ]; then
GPG_TTY=$(tty)
export GPG_TTY
if [ "${GPG_ENC_KEY}" = "${GPG_SIGN_KEY}" ]; then
# shellcheck disable=SC2086
gpg -a --export-secret-keys ${KEYRING} ${GPG_ENC_KEY} > "${TMPDIR}"/duplicity-backup-encryption-and-sign-secret.key.txt
else
# shellcheck disable=SC2086
gpg -a --export-secret-keys ${KEYRING} ${GPG_ENC_KEY} > "${TMPDIR}"/duplicity-backup-encryption-secret.key.txt
# shellcheck disable=SC2086
gpg -a --export-secret-keys ${KEYRING} ${GPG_SIGN_KEY} > "${TMPDIR}"/duplicity-backup-sign-secret.key.txt
fi
fi
echo -e "${README_TXT}" > "${README}"
echo "Encrypting tarball, choose a password you'll remember..." >&3
tar -cf - "${TMPDIR}" | gpg -aco "${TMPFILENAME}"
rm -Rf "${TMPDIR}"
echo -e "\nIMPORTANT!!" >&3
echo ">> To restore these files, run the following (remember your password):" >&3
echo "gpg -d ${TMPFILENAME} | tar -xf -" >&3
echo -e "\nYou may want to write the above down and save it with the file." >&3
}
# ##################################################
# #### end of functions definition ####
# ##################################################
check_variables
echo -e "-------- START DUPLICITY-BACKUP SCRIPT for ${HOSTNAME} --------\n" >&5
echo -e "-------[ Program versions ]-------"
echo -e "duplicity-backup.sh ${DBSH_VERSION}"
echo -e "duplicity ${DUPLICITY_VERSION}"
echo -e "----------------------------------\n"
get_lock
INCLUDE=
EXCLUDE=
EXCLUDEROOT=
case "${COMMAND}" in
"backup-script")
backup_this_script
exit 0
;;
"full")
OPTION="full"
include_exclude
duplicity_backup
duplicity_cleanup
get_file_sizes
;;
"verify")