forked from tachtler/dovecot-backup
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dovecot_backup.sh
498 lines (433 loc) · 17.5 KB
/
dovecot_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
#!/bin/bash
##############################################################################
# Script-Name : dovecot_backup.sh #
# Description : Script to backup the mailboxes from dovecot. #
# On successful execution only a LOG file will be written. #
# On error while execution, a LOG file and a error message #
# will be send by e-mail. #
# #
# Last update : 31.01.2019 #
# Version : 1.10 #
# #
# Author : Klaus Tachtler, <[email protected]> #
# DokuWiki : http://www.dokuwiki.tachtler.net #
# Homepage : http://www.tachtler.net #
# #
# +----------------------------------------------------------------------+ #
# | 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 2 of the License, or | #
# | (at your option) any later version. | #
# +----------------------------------------------------------------------+ #
# #
# Copyright (c) 2019 by Klaus Tachtler. #
# #
##############################################################################
##############################################################################
# H I S T O R Y #
##############################################################################
# Version : 1.01 #
# Description : Bugfix: Delete all temporary domain directories not only the #
# last one. Thanks to Guenther J. Niederwimmer. #
# -------------------------------------------------------------------------- #
# Version : 1.02 #
# Description : GitHub: Issue #1 #
# The name of the variable to delete the number of old backup #
# files $DAYS_DELETE was renamed to $BACKUPFILES_DELETE. This #
# was done for better understanding, because if the script was #
# running more than once a day, this could be misunderstood. #
# Thanks to Diane Trout. #
# -------------------------------------------------------------------------- #
# Version : 1.03 #
# Description : Quota calculation double the calculated size of a mailbox, #
# when dict was used. See also following mailing-list entry: #
# #
# https://www.dovecot.org/list/dovecot/2012-February/ #
# 063585.html #
# #
# Thanks to André Peters. #
# -------------------------------------------------------------------------- #
# Version : 1.04 #
# Description : Typo: Correction of the return code query of #
# "# Delete LOCK file." in a pure string comparison. #
# Thanks to Oli Sennhauser. #
# -------------------------------------------------------------------------- #
# Version : 1.05 #
# Description : GitHub: Issue #4 #
# Add error handling for dsync command. #
# Add runtime statistics. #
# Thanks to HenrikWMG. #
# -------------------------------------------------------------------------- #
# Version : 1.06 #
# Description : Avoid an error when trying to delete backup files, if the #
# $BACKUPFILES_DELETE count is NOT reached. #
# Change file owner, after backup was created. #
# Change file permissions to 600, after backup was created. #
# Thanks to Seep1959. #
# -------------------------------------------------------------------------- #
# Version : 1.07 #
# Description : Compatibility: Change the parameter order for the step #
# "Delete archive files for user" for better compatibility #
# with FreeBSD. #
# Thanks to Alexander Preyer. #
# -------------------------------------------------------------------------- #
# Version : 1.08 #
# Description : GitHub Issue #9 #
# Add ability to only backup specific mailboxes, by using the #
# variable FILE_USERLIST with the file path and file name as #
# content. The file must contain one e-mail address per line. #
# Add the calculation of the script runtime. #
# Thanks to graue Ritter. #
# -------------------------------------------------------------------------- #
# Version : 1.09 #
# Description : Add a switch to enable or disable e-mail address check, when #
# FILE_USERLIST was set and used. #
# Thanks to kbridger. #
# -------------------------------------------------------------------------- #
# Version : 1.10 #
# Description : Code redesign. #
# -------------------------------------------------------------------------- #
# Version : x.xx #
# Description : <Description> #
# -------------------------------------------------------------------------- #
##############################################################################
##############################################################################
# >>> Please edit following lines for personal settings and custom usages. ! #
##############################################################################
# CUSTOM - Script-Name.
SCRIPT_NAME='dovecot_backup'
# CUSTOM - Backup-Files.
DIR_BACKUP='/srv/backup'
FILE_BACKUP=dovecot_backup_`date '+%Y%m%d_%H%M%S'`.tar.gz
FILE_DELETE='*.tar.gz'
BACKUPFILES_DELETE=14
# CUSTOM - dovecot Folders.
MAILDIR_TYPE='maildir'
MAILDIR_NAME='Maildir'
MAILDIR_USER='vmail'
MAILDIR_GROUP='vmail'
# CUSTOM - Path and file name of a file with e-mail addresses to backup, if
# SET. If NOT, the script will determine all mailboxes by default.
# FILE_USERLIST='/path/and/file/name/of/user/list/with/one/user/per/line'
# - OR -
# FILE_USERLIST=''
FILE_USERLIST=''
# CUSTOM - Check when FILE_USERLIST was used, if the user per line was a
# valid e-mail address [Y|N].
FILE_USERLIST_VALIDATE_EMAIL='N'
# CUSTOM - Mail-Recipient.
MAIL_RECIPIENT='[email protected]'
# CUSTOM - Status-Mail [Y|N].
MAIL_STATUS='N'
##############################################################################
# >>> Normaly there is no need to change anything below this comment line. ! #
##############################################################################
# Variables.
DSYNC_COMMAND=`command -v dsync`
TAR_COMMAND=`command -v tar`
TOUCH_COMMAND=`command -v touch`
RM_COMMAND=`command -v rm`
PROG_SENDMAIL=`command -v sendmail`
CAT_COMMAND=`command -v cat`
DATE_COMMAND=`command -v date`
MKDIR_COMMAND=`command -v mkdir`
CHOWN_COMMAND=`command -v chown`
CHMOD_COMMAND=`command -v chmod`
GREP_COMMAND=`command -v grep`
FILE_LOCK='/tmp/'$SCRIPT_NAME'.lock'
FILE_LOG='/var/log/'$SCRIPT_NAME'.log'
FILE_LAST_LOG='/tmp/'$SCRIPT_NAME'.log'
FILE_MAIL='/tmp/'$SCRIPT_NAME'.mail'
FILE_MBOXLIST='/tmp/'$SCRIPT_NAME'.mboxlist'
VAR_HOSTNAME=`uname -n`
VAR_SENDER='root@'$VAR_HOSTNAME
VAR_EMAILDATE=`$DATE_COMMAND '+%a, %d %b %Y %H:%M:%S (%Z)'`
declare -a VAR_LISTED_USER=()
declare -a VAR_FAILED_USER=()
VAR_COUNT_USER=0
VAR_COUNT_FAIL=0
# Functions.
function log() {
echo $1
echo `$DATE_COMMAND '+%Y/%m/%d %H:%M:%S'` " INFO:" $1 >>${FILE_LAST_LOG}
}
function retval() {
if [ "$?" != "0" ]; then
case "$?" in
*)
log "ERROR: Unknown error $?"
;;
esac
fi
}
function movelog() {
$CAT_COMMAND $FILE_LAST_LOG >> $FILE_LOG
$RM_COMMAND -f $FILE_LAST_LOG
$RM_COMMAND -f $FILE_LOCK
}
function sendmail() {
case "$1" in
'STATUS')
MAIL_SUBJECT='Status execution '$SCRIPT_NAME' script.'
;;
*)
MAIL_SUBJECT='ERROR while execution '$SCRIPT_NAME' script !!!'
;;
esac
$CAT_COMMAND <<MAIL >$FILE_MAIL
Subject: $MAIL_SUBJECT
Date: $VAR_EMAILDATE
From: $VAR_SENDER
To: $MAIL_RECIPIENT
MAIL
$CAT_COMMAND $FILE_LAST_LOG >> $FILE_MAIL
$PROG_SENDMAIL -f $VAR_SENDER -t $MAIL_RECIPIENT < $FILE_MAIL
$RM_COMMAND -f $FILE_MAIL
}
function error () {
# Parameters.
CODE_ERROR="$1"
sendmail ERROR
movelog
exit $CODE_ERROR
}
function headerblock () {
# Parameters.
TEXT_INPUT="$1"
LINE_COUNT=68
# Help variables.
WORD_COUNT=`echo $TEXT_INPUT | wc -c`
CHAR_AFTER=`expr $LINE_COUNT - $WORD_COUNT - 5`
LINE_SPACE=`expr $LINE_COUNT - 3`
# Format placeholder.
if [ "$CHAR_AFTER" -lt "0" ]; then
CHAR_AFTER="0"
fi
printf -v char '%*s' $CHAR_AFTER ''
printf -v line '%*s' $LINE_SPACE ''
log "+${line// /-}+"
log "| $TEXT_INPUT${char// /.} |"
log "+${line// /-}+"
}
function logline () {
# Parameters.
TEXT_INPUT="$1"
TRUE_FALSE="$2"
LINE_COUNT=68
# Help variables.
WORD_COUNT=`echo $TEXT_INPUT | wc -c`
CHAR_AFTER=`expr $LINE_COUNT - $WORD_COUNT - 9`
# Format placeholder.
if [ "$CHAR_AFTER" -lt "0" ]; then
CHAR_AFTER="0"
fi
printf -v char '%*s' $CHAR_AFTER ''
if [ "$TRUE_FALSE" == "true" ]; then
log "$TEXT_INPUT${char// /.}[ OK ]"
else
log "$TEXT_INPUT${char// /.}[FAILED]"
fi
}
function checkcommand () {
# Parameters.
CHECK_COMMAND="$1"
if [ ! -s "$1" ]; then
logline "Check if command '$CHECK_COMMAND' was found " false
error 10
else
logline "Check if command '$CHECK_COMMAND' was found " true
fi
}
# Main.
log ""
RUN_TIMESTAMP=`$DATE_COMMAND '+%s'`
headerblock "Start backup of the mailboxes [`$DATE_COMMAND '+%a, %d %b %Y %H:%M:%S (%Z)'`]"
log ""
log "SCRIPT_NAME.................: $SCRIPT_NAME"
log ""
log "DIR_BACKUP..................: $DIR_BACKUP"
log ""
log "MAIL_RECIPIENT..............: $MAIL_RECIPIENT"
log "MAIL_STATUS.................: $MAIL_STATUS"
log ""
log "FILE_USERLIST...............: $FILE_USERLIST"
log "FILE_USERLIST_VALIDATE_EMAIL: $FILE_USERLIST_VALIDATE_EMAIL"
log ""
# Check if command (file) NOT exist OR IS empty.
checkcommand $DSYNC_COMMAND
checkcommand $TAR_COMMAND
checkcommand $TOUCH_COMMAND
checkcommand $RM_COMMAND
checkcommand $CAT_COMMAND
checkcommand $DATE_COMMAND
checkcommand $MKDIR_COMMAND
checkcommand $CHOWN_COMMAND
checkcommand $CHMOD_COMMAND
checkcommand $GREP_COMMAND
checkcommand $PROG_SENDMAIL
# Check if LOCK file NOT exist.
if [ ! -e "$FILE_LOCK" ]; then
logline "Check if the script is NOT already runnig " true
$TOUCH_COMMAND $FILE_LOCK
else
logline "Check if the script is NOT already runnig " false
log ""
log "ERROR: The script was already running, or LOCK file already exists!"
log ""
error 20
fi
# Check if DIR_BACKUP Directory NOT exists.
if [ ! -d "$DIR_BACKUP" ]; then
logline "Check if DIR_BACKUP exists " false
$MKDIR_COMMAND -p $DIR_BACKUP
logline "DIR_BACKUP was now created " true
else
logline "Check if DIR_BACKUP exists " true
fi
# Check if FILE_USERLIST NOT set OR IS empty.
log ""
if [ ! -n "$FILE_USERLIST" ]; then
log "Check if the variable FILE_USERLIST is set ................[ NO ]"
log "Mailboxes to backup will be determined by doveadm user \"*\"."
for users in `doveadm user "*"`; do
VAR_LISTED_USER+=($users);
done
else
logline "Check if the variable FILE_USERLIST is set " true
log "Mailboxes to backup will be read from file."
log ""
log "- File: [$FILE_USERLIST]"
# Check if file exists.
if [ -f "$FILE_USERLIST" ]; then
logline "- Check if FILE_USERLIST exists " true
else
logline "- Check if FILE_USERLIST exists " false
log ""
error 30
fi
# Check if file is readable.
if [ -r "$FILE_USERLIST" ]; then
logline "- Check if FILE_USERLIST is readable " true
else
logline "- Check if FILE_USERLIST is readable " false
log ""
error 31
fi
# Read file into variable.
while IFS= read -r line
do
# Check for valid e-mail address.
if [ $FILE_USERLIST_VALIDATE_EMAIL = 'Y' ]; then
# Check if basic email address syntax is valid.
if echo "${line}" | $GREP_COMMAND '^[a-zA-Z0-9]*@[a-zA-Z0-9]*\.[a-zA-Z0-9]*$' >/dev/null; then
VAR_LISTED_USER+=($line);
else
log ""
log "ERROR: The user: $line is NOT valid e-mail address!"
((VAR_COUNT_FAIL++))
VAR_FAILED_USER+=($line);
fi
else
VAR_LISTED_USER+=($line);
fi
done <"$FILE_USERLIST"
# Check if VAR_COUNT_FAIL is greater than zero. If YES, set VAR_COUNT_USER to VAR_COUNT_FAIL.
if [ "$VAR_COUNT_FAIL" -ne "0" ]; then
VAR_COUNT_USER=$VAR_COUNT_FAIL
fi
fi
# Start backup.
log ""
headerblock "Run backup $SCRIPT_NAME "
log ""
# Start real backup process for all users.
for users in "${VAR_LISTED_USER[@]}"; do
log "Start backup process for user: $users ..."
((VAR_COUNT_USER++))
DOMAINPART=${users#*@}
LOCALPART=${users%%@*}
LOCATION="$DIR_BACKUP/$DOMAINPART/$LOCALPART/$MAILDIR_NAME"
USERPART="$DOMAINPART/$LOCALPART"
log "Extract mailbox data for user: $users ..."
$DSYNC_COMMAND -o plugin/quota= -f -u $users backup $MAILDIR_TYPE:$LOCATION
# Check the status of dsync and continue the script depending on the result.
if [ "$?" != "0" ]; then
case "$?" in
1) log "Synchronization failed > user: $users !!!"
;;
2) log "Synchronization was done without errors, but some changes couldn't be done, so the mailboxes aren't perfectly synchronized for user: $users !!!"
;;
esac
if [ "$?" -gt "3" ]; then
log "Synchronization failed > user: $users !!!"
fi
((VAR_COUNT_FAIL++))
VAR_FAILED_USER+=($users);
else
log "Synchronization done for user: $users ..."
cd $DIR_BACKUP
log "Packaging to archive for user: $users ..."
$TAR_COMMAND -cvzf $users-$FILE_BACKUP $USERPART --atime-preserve --preserve-permissions
log "Delete archive files for user: $users ..."
(ls -t $users-$FILE_DELETE|head -n $BACKUPFILES_DELETE;ls $users-$FILE_DELETE)|sort|uniq -u|xargs -r rm
if [ "$?" != "0" ]; then
logline "Delete old archive files $DIR_BACKUP " false
else
logline "Delete old archive files $DIR_BACKUP " true
fi
log "Delete mailbox files for user: $users ..."
$RM_COMMAND "$DIR_BACKUP/$DOMAINPART" -rf
if [ "$?" != "0" ]; then
logline "Delete mailbox files at: $DIR_BACKUP " false
else
logline "Delete mailbox files at: $DIR_BACKUP " true
fi
fi
log "Ended backup process for user: $users ..."
log ""
done
# Set owner and rights permissions to backup directory and backup files.
$CHOWN_COMMAND -R $MAILDIR_USER:$MAILDIR_GROUP $DIR_BACKUP
$CHMOD_COMMAND 700 $DIR_BACKUP
$CHMOD_COMMAND -R 600 $DIR_BACKUP/*
# Delete LOCK file.
if [ "$?" != "0" ]; then
retval $?
log ""
$RM_COMMAND -f $FILE_LOCK
error 99
else
headerblock "End backup $SCRIPT_NAME "
log ""
fi
# Finish syncing with runntime statistics.
headerblock "Runtime statistics "
log ""
log "- Number of determined users: $VAR_COUNT_USER"
log "- ...Summary of failed users: $VAR_COUNT_FAIL"
if [ "$VAR_COUNT_FAIL" -gt "0" ]; then
log "- ...Mailbox of failed users: "
for i in "${VAR_FAILED_USER[@]}"
do
log "- ... $i"
done
fi
log ""
END_TIMESTAMP=`$DATE_COMMAND '+%s'`
log "Runtime: `$DATE_COMMAND -u -d "0 $END_TIMESTAMP seconds - $RUN_TIMESTAMP seconds" +'%H:%M:%S'` time elapsed."
log ""
headerblock "Finished creating the backups [`$DATE_COMMAND '+%a, %d %b %Y %H:%M:%S (%Z)'`]"
log ""
# If errors occurred on user backups, exit with return code 1 instead of 0.
if [ "$VAR_COUNT_FAIL" -gt "0" ]; then
sendmail ERROR
movelog
exit 1
else
# Status e-mail.
if [ $MAIL_STATUS = 'Y' ]; then
sendmail STATUS
fi
movelog
exit 0
fi