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
|
#!/bin/bash
# |\_
# B A C K U P N I N J A /()/
# `\|
#
# Copyright (C) 2004 riseup.net -- property is theft.
#
# 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.
#
# 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.
#
#####################################################
## FUNCTIONS
function setupcolors() {
BLUE="\033[34;01m"
GREEN="\033[32;01m"
YELLOW="\033[33;01m"
PURPLE="\033[35;01m"
RED="\033[31;01m"
OFF="\033[0m"
CYAN="\033[36;01m"
}
#function run() {
# RUNERROR=0
# debug 0 "$@"
# returnstring=`$@ 2>&1`
# RUNERROR=$?
# RUNERRORS=$[RUNERRORS+RUNERROR]
# if [ "$RUNERROR" != 0 ]; then
# debug 3 "Exitcode $RUNERROR returned when running: $@"
# debug 3 "$returnstring"
# else
# debug 0 "$returnstring"
# fi
# return $RUNERROR
#}
# We have the following message levels:
# 0 - debug - blue
# 1 - normal messages - green
# 2 - warnings - yellow
# 3 - errors - orange
# 4 - fatal - red
# First variable passed is the error level, all others are printed
# if 1, echo out all warnings, errors, or fatal
# used to capture output from handlers
echo_debug_msg=0
usecolor=yes
function printmsg() {
[ ${#@} -gt 1 ] || return
types=(Debug Info Warning Error Fatal)
type=$1
print=$[4-type]
typestr=${types[$type]}
if [ "$usecolor" == "yes" ]; then
colors=($BLUE $GREEN $YELLOW $RED $PURPLE)
color=${colors[$type]}
endcolor=$OFF
fi
shift
if [ "$echo_debug_msg" != "0" -a "$type" -gt "1" ]; then
echo -e "$typestr: $@"
fi
if [ "$debug" == 1 ]; then
echo -e "${color}$typestr: $@${endcolor}" >&2
fi
if [ "$print" -lt "$loglevel" ]; then
if [ -w "$logfile" ]; then
echo -e "${color}$typestr: $@${endcolor}" >> $logfile
fi
fi
}
function debug() {
printmsg 0 "$@"
}
function info() {
printmsg 1 "$@"
}
function warning() {
printmsg 2 "$@"
}
function error() {
printmsg 3 "$@"
}
function fatal() {
printmsg 4 "$@"
exit 2
}
msgcount=0
function msg {
messages[$msgcount]=$1
let "msgcount += 1"
}
function setfile() {
CURRENT_CONF_FILE=$1
}
function setsection() {
CURRENT_SECTION=$1
}
#
# sets a global var with name equal to $1
# to the value of the configuration parameter $1
# $2 is the default.
#
function getconf() {
CURRENT_PARAM=$1
ret=`awk -f $scriptdir/parseini S=$CURRENT_SECTION P=$CURRENT_PARAM $CURRENT_CONF_FILE`
# if nothing is returned, set the default
if [ "$ret" == "" -a "$2" != "" ]; then
ret="$2"
fi
# replace * with %, so that it is not globbed.
ret="${ret//\\*/__star__}"
# this is weird, but single quotes are needed to
# allow for returned values with spaces. $ret is still expanded
# because it is in an 'eval' statement.
eval $1='$ret'
}
#
# enforces very strict permissions on configuration file $file.
#
function check_perms() {
local file=$1
local perms=`ls -ld $file`
perms=${perms:4:6}
if [ "$perms" != "------" ]; then
fatal "Configuration files must not be group or world readable! Dying on file $file"
fi
if [ `ls -ld $file | awk '{print $3}'` != "root" ]; then
fatal "Configuration files must be owned by root! Dying on file $file"
fi
}
# simple lowercase function
function tolower() {
echo "$1" | tr [:upper:] [:lower:]
}
# simple to integer function
function toint() {
echo "$1" | tr [:alpha:] -d
}
#
# function isnow(): returns 1 if the time/day passed as $1 matches
# the current time/day.
#
# format is <day> at <time>:
# sunday at 16
# 8th at 01
# everyday at 22
#
# we grab the current time once, since processing
# all the configs might take more than an hour.
nowtime=`date +%H`
nowday=`date +%d`
nowdayofweek=`date +%A`
nowdayofweek=`tolower "$nowdayofweek"`
function isnow() {
local when="$1"
set -- $when
whendayofweek=$1; at=$2; whentime=$3;
whenday=`toint "$whendayofweek"`
whendayofweek=`tolower "$whendayofweek"`
whentime=`echo "$whentime" | sed 's/:[0-9][0-9]$//'`
if [ "$whendayofweek" == "everyday" ]; then
whendayofweek=$nowdayofweek
fi
if [ "$whenday" == "" ]; then
if [ "$whendayofweek" != "$nowdayofweek" ]; then
whendayofweek=${whendayofweek%s}
if [ "$whendayofweek" != "$nowdayofweek" ]; then
return 0
fi
fi
elif [ "$whenday" != "$nowday" ]; then
return 0
fi
[ "$at" == "at" ] || return 0
[ "$whentime" == "$nowtime" ] || return 0
return 1
}
function usage() {
cat << EOF
$0 usage:
This script allows you to coordinate system backup by dropping a few
simple configuration files into /etc/backup.d/. Typically, this
script is run hourly from cron.
The following options are available:
-h, --help This usage message
-d, --debug Run in debug mode, where all log messages are
output to the current shell.
-f, --conffile FILE Use FILE for the main configuration instead
of /etc/backupninja.conf
-t, --test Run in test mode, no actions are actually taken.
-n, --now Perform actions now, instead of when they
might be scheduled.
When using colored output, there are:
EOF
debug=1
debug "Debugging info (when run with -d)"
info "Informational messages (verbosity level 4)"
warning "Warnings (verbosity level 3 and up)"
error "Errors (verbosity level 2 and up)"
fatal "Fatal, halting errors (always shown)"
}
function process_action() {
local file="$1"
local suffix="$2"
setfile $file
# skip over this config if "when" option
# is not set to the current time.
getconf when "$defaultwhen"
if [ "$processnow" == 1 ]; then
info "running $file because of --now"
else
IFS=$'\t\n'
for w in $when; do
IFS=$' \t\n'
isnow "$w"
ret=$?
IFS=$'\t\n'
if [ $ret == 0 ]; then
debug "skipping $file because it is not $w"
return
else
info "running $file because it is $w"
fi
done
IFS=$' \t\n'
fi
echo_debug_msg=1
# call the handler:
ret=`( . $scriptdir/$suffix $file )`
retcode="$?"
warnings=`echo $ret | grep -e "^Warning: " | wc -l`
errors=`echo $ret | grep -e "^Error: \|^Fatal: " | wc -l`
if [ $errors != 0 ]; then
msg "*failed* -- $file"
errormsg="$errormsg\n== errors from $file ==\n\n$ret\n"
elif [ $warnings != 0 ]; then
msg "*warning* -- $file"
errormsg="$errormsg\n== warnings from $file ==\n\n$ret\n"
elif [ $retcode == 0 ]; then
msg "success -- $file"
else
msg "unknown -- $file"
fi
echo_debug_msg=0
}
#####################################################
## MAIN
setupcolors
conffile="/etc/backupninja.conf"
## process command line options
while [ $# -ge 1 ]; do
case $1 in
-h|--help) usage;;
-d|--debug) debug=1;;
-t|--test) test=1;debug=1;;
-n|--now) processnow=1;;
-f|--conffile)
if [ -f $2 ]; then
conffile=$2
else
fatal "-f|--conffile option must be followed by an existing filename"
usage
fi
# we shift here to avoid processing the file path
shift
;;
*)
fatal "Unknown option $1"
usage
;;
esac
shift
done
## Load and confirm basic configuration values
# bootstrap
[ -r "$conffile" ] || fatal "Configuration file $conffile not found."
scriptdir=`grep scriptdirectory $conffile | awk '{print $3}'`
[ -n "$scriptdir" ] || fatal "Cound not find entry 'scriptdirectory' in $conffile"
[ -d "$scriptdir" ] || fatal "Script directory $scriptdir not found."
setfile $conffile
# get global config options (second param is the default)
getconf configdirectory /etc/backup.d
getconf reportemail
getconf reportsuccess yes
getconf reportwarning yes
getconf loglevel 3
getconf when "Everyday at 01:00"
defaultwhen=$when
getconf logfile /var/log/backupninja.log
getconf usecolors "yes"
getconf SLAPCAT /usr/sbin/slapcat
getconf RDIFFBACKUP /usr/bin/rdiff-backup
getconf MYSQL /usr/bin/mysql
getconf MYSQLHOTCOPY /usr/bin/mysqlhotcopy
getconf MYSQLDUMP /usr/bin/mysqldump
getconf GZIP /bin/gzip
[ -d "$configdirectory" ] || fatal "Configuration directory '$configdirectory' not found."
if [ "$UID" != "0" ]; then
echo "$0 can only be run as root"
exit 1
fi
## Process each configuration file
info "====== starting at "`date`" ======"
# by default, don't make files which are world or group readable.
umask 077
errors=0
for file in $configdirectory/*; do
[ -f $file ] || continue;
check_perms $file
suffix="${file##*.}"
base=`basename $file`
if [ "${base:0:1}" == "0" ]; then
info "Skipping $file"
continue
fi
if [ -e "$scriptdir/$suffix" ]; then
process_action $file $suffix
else
error "Can't process file '$file': no handler script for suffix '$suffix'"
msg "*missing handler* -- $file"
fi
done
## mail the messages to the report address
if [ "$reportemail" == "" ]; then doit=0
elif [ $errors != 0 ]; then doit=1
elif [ "$reportsuccess" == "yes" ]; then doit=1
elif [ "$reportwarning" == "yes" -a $warnings != 0 ]; then doit=1
else doit=0
fi
if [ $doit == 1 ]; then
hostname=`hostname`
{
for ((i=0; i < ${#messages[@]} ; i++)); do
echo ${messages[$i]}
done
echo -e "$errormsg"
} | mail $reportemail -s "backupninja: $hostname"
fi
info "====== finished at "`date`" ======"
############################################################
|