changes to support maildir
[matthijs/upstream/backupninja.git] / backupninja
1 #!/bin/bash
2 #                          |\_
3 # B A C K U P N I N J A   /()/
4 #                         `\|
5 #
6 # Copyright (C) 2004 riseup.net -- property is theft.
7 #
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #
18
19 #####################################################
20 ## FUNCTIONS
21
22 function setupcolors() {
23         BLUE="\033[34;01m"
24         GREEN="\033[32;01m"
25         YELLOW="\033[33;01m"
26         PURPLE="\033[35;01m"
27         RED="\033[31;01m"
28         OFF="\033[0m"
29         CYAN="\033[36;01m"
30         COLORS=($BLUE $GREEN $YELLOW $RED $PURPLE)
31 }
32
33 function colorize() {
34         if [ "$usecolor" == "yes" ]; then
35                 local typestr=`echo "$@" | sed 's/\(^[^:]*\).*$/\1/'`
36                 [ "$typestr" == "Debug" ] && type=0
37                 [ "$typestr" == "Info" ] && type=1
38                 [ "$typestr" == "Warning" ] && type=2
39                 [ "$typestr" == "Error" ] && type=3
40                 [ "$typestr" == "Fatal" ] && type=4
41                 color=${COLORS[$type]}
42                 endcolor=$OFF
43                 echo -e "$color$@$endcolor"
44         else
45                 echo -e "$@"
46         fi
47 }
48
49 # We have the following message levels:
50 # 0 - debug - blue
51 # 1 - normal messages - green
52 # 2 - warnings - yellow
53 # 3 - errors - orange
54 # 4 - fatal - red
55 # First variable passed is the error level, all others are printed
56
57 # if 1, echo out all warnings, errors, or fatal
58 # used to capture output from handlers
59 echo_debug_msg=0
60
61 usecolor=yes
62
63 function printmsg() {
64         [ ${#@} -gt 1 ] || return
65
66         type=$1
67         shift
68         if [ $type == 100 ]; then
69                 typestr=`echo "$@" | sed 's/\(^[^:]*\).*$/\1/'`
70                 [ "$typestr" == "Debug" ] && type=0
71                 [ "$typestr" == "Info" ] && type=1
72                 [ "$typestr" == "Warning" ] && type=2
73                 [ "$typestr" == "Error" ] && type=3
74                 [ "$typestr" == "Fatal" ] && type=4
75                 typestr=""
76         else
77                 types=(Debug Info Warning Error Fatal)
78                 typestr="${types[$type]}: "
79         fi
80         
81         print=$[4-type]
82         
83         if [ $echo_debug_msg == 1 ]; then
84                 echo -e "$typestr$@" >&2
85         elif [ $debug ]; then
86                 colorize "$typestr$@" >&2
87         fi
88         
89         if [ $print -lt $loglevel ]; then
90                 if [ -w "$logfile" ]; then
91                         colorize "$typestr$@" >> $logfile
92                 fi
93         fi
94 }
95
96 function passthru() {
97         printmsg 100 "$@"
98 }
99 function debug() {
100         printmsg 0 "$@"
101 }
102 function info() {
103         printmsg 1 "$@"
104 }
105 function warning() {
106         printmsg 2 "$@"
107 }
108 function error() {
109         printmsg 3 "$@" 
110 }
111 function fatal() {
112         printmsg 4 "$@"
113         exit 2
114 }
115
116 msgcount=0
117 function msg {
118         messages[$msgcount]=$1
119         let "msgcount += 1"
120 }
121
122 function setfile() {
123         CURRENT_CONF_FILE=$1
124 }
125
126 function setsection() {
127         CURRENT_SECTION=$1
128 }
129
130 #
131 # sets a global var with name equal to $1
132 # to the value of the configuration parameter $1
133 # $2 is the default.
134
135
136 function getconf() {
137         CURRENT_PARAM=$1
138         ret=`awk -f $scriptdir/parseini S=$CURRENT_SECTION P=$CURRENT_PARAM $CURRENT_CONF_FILE`
139         # if nothing is returned, set the default
140         if [ "$ret" == "" -a "$2" != "" ]; then
141                 ret="$2"
142         fi
143
144         # replace * with %, so that it is not globbed.
145         ret="${ret//\\*/__star__}"
146
147         # this is weird, but single quotes are needed to 
148         # allow for returned values with spaces. $ret is still expanded
149         # because it is in an 'eval' statement.
150         eval $1='$ret'
151 }
152
153 #
154 # enforces very strict permissions on configuration file $file.
155 #
156
157 function check_perms() {
158         local file=$1
159         local perms=`ls -ld $file`
160         perms=${perms:4:6}
161         if [ "$perms" != "------" ]; then
162                 fatal "Configuration files must not be group or world readable! Dying on file $file"
163         fi
164         if [ `ls -ld $file | awk '{print $3}'` != "root" ]; then
165                 fatal "Configuration files must be owned by root! Dying on file $file"
166         fi
167 }
168
169 # simple lowercase function
170 function tolower() {
171         echo "$1" | tr [:upper:] [:lower:]
172 }
173
174 # simple to integer function
175 function toint() {
176         echo "$1" | tr [:alpha:] -d 
177 }
178
179 #
180 # function isnow(): returns 1 if the time/day passed as $1 matches
181 # the current time/day.
182 #
183 # format is <day> at <time>:
184 #   sunday at 16
185 #   8th at 01
186 #   everyday at 22
187 #
188
189 # we grab the current time once, since processing
190 # all the configs might take more than an hour.
191 nowtime=`date +%H`
192 nowday=`date +%d`
193 nowdayofweek=`date +%A`
194 nowdayofweek=`tolower "$nowdayofweek"`
195
196 function isnow() {
197         local when="$1"
198         set -- $when
199         whendayofweek=$1; at=$2; whentime=$3;
200         whenday=`toint "$whendayofweek"`
201         whendayofweek=`tolower "$whendayofweek"`
202         whentime=`echo "$whentime" | sed 's/:[0-9][0-9]$//'`
203
204         if [ "$whendayofweek" == "everyday" ]; then
205                 whendayofweek=$nowdayofweek
206         fi
207
208         if [ "$whenday" == "" ]; then
209                 if [ "$whendayofweek" != "$nowdayofweek" ]; then
210                         whendayofweek=${whendayofweek%s}
211                         if [ "$whendayofweek" != "$nowdayofweek" ]; then
212                                 return 0
213                         fi
214                 fi
215         elif [ "$whenday" != "$nowday" ]; then
216                 return 0
217         fi
218
219         [ "$at" == "at" ] || return 0
220         [ "$whentime" == "$nowtime" ] || return 0
221
222         return 1
223 }
224
225 function usage() {
226         cat << EOF
227 $0 usage:
228 This script allows you to coordinate system backup by dropping a few
229 simple configuration files into /etc/backup.d/. Typically, this
230 script is run hourly from cron.
231
232 The following options are available:
233 -h, --help           This usage message
234 -d, --debug          Run in debug mode, where all log messages are
235                      output to the current shell.
236 -f, --conffile FILE  Use FILE for the main configuration instead
237                      of /etc/backupninja.conf
238 -t, --test           Run in test mode, no actions are actually taken.
239 -n, --now            Perform actions now, instead of when they
240                      might be scheduled.
241 When using colored output, there are:
242 EOF
243         debug=1
244         debug   "Debugging info (when run with -d)"
245         info    "Informational messages (verbosity level 4)"
246         warning "Warnings (verbosity level 3 and up)"
247         error   "Errors (verbosity level 2 and up)"
248         fatal   "Fatal, halting errors (always shown)"
249 }
250
251 ##
252 ## this function handles the running of a backup action
253 ##
254 ## these globals are modified:
255 ## fatals, errors, warnings, actions_run, errormsg
256 ##
257
258 function process_action() {
259         local file="$1"
260         local suffix="$2"
261
262         setfile $file
263
264         # skip over this config if "when" option
265         # is not set to the current time.
266         getconf when "$defaultwhen"
267         if [ "$processnow" == 1 ]; then
268                 info "running $file because of --now"
269         else
270                 IFS=$'\t\n'
271                 for w in $when; do
272                         IFS=$' \t\n'
273                         isnow "$w"
274                         ret=$?
275                         IFS=$'\t\n'
276                         if [ $ret == 0 ]; then
277                                 debug "skipping $file because it is not $w"
278                                 return
279                         else
280                                 info "running $file because it is $w"
281                         fi
282                 done
283                 IFS=$' \t\n'
284         fi
285         
286         let "actions_run += 1"
287
288         # call the handler:
289         local bufferfile="/tmp/backupninja.buffer.$$"
290         echo "" > $bufferfile
291         echo_debug_msg=1
292         (
293                 . $scriptdir/$suffix $file
294         ) 2>&1 | (
295                 while read a; do
296                         echo $a >> $bufferfile
297                         [ $debug ] && colorize "$a"
298                 done
299         )
300         retcode=$?
301         # ^^^^^^^^ we have a problem! we can't grab the return code "$?". grrr.
302         echo_debug_msg=0
303
304         _warnings=`cat $bufferfile | grep "^Warning: " | wc -l`
305         _errors=`cat $bufferfile | grep "^Error: " | wc -l`
306         _fatals=`cat $bufferfile | grep "^Fatal: " | wc -l`
307         
308         ret=`grep "\(^Warning: \|^Error: \|^Fatal: \)" $bufferfile`
309         #rm $bufferfile
310         if [ $_fatals != 0 ]; then
311                 msg "*failed* -- $file"
312                 errormsg="$errormsg\n== failures from $file ==\n\n$ret\n"
313         elif [ $_errors != 0 ]; then
314                 msg "*error* -- $file"
315                 errormsg="$errormsg\n== errors from $file ==\n\n$ret\n"
316         elif [ $_warnings != 0 ]; then
317                 msg "*warning* -- $file"
318                 errormsg="$errormsg\n== warnings from $file ==\n\n$ret\n"
319         elif [ $retcode == 0 ]; then
320                 msg "success -- $file"
321         else
322                 msg "unknown -- $file"
323         fi
324
325         let "fatals += _fatals"
326         let "errors += _errors"
327         let "warnings += _warnings"     
328 }
329
330 #####################################################
331 ## MAIN
332
333 setupcolors
334 conffile="/etc/backupninja.conf"
335 loglevel=3
336
337 ## process command line options
338
339 while [ $# -ge 1 ]; do
340         case $1 in
341                 -h|--help) usage;;
342                 -d|--debug) debug=1;;
343                 -t|--test) test=1;debug=1;;
344                 -n|--now) processnow=1;;
345                 -f|--conffile)
346                         if [ -f $2 ]; then
347                                 conffile=$2
348                         else
349                                 fatal "-f|--conffile option must be followed by an existing filename"
350                                 usage
351                         fi
352                         # we shift here to avoid processing the file path 
353                         shift
354                         ;;
355                 *)
356                         fatal "Unknown option $1"
357                         usage
358                         ;;
359         esac
360         shift
361 done                                                                                                                                                                                                            
362
363 ## Load and confirm basic configuration values
364
365 # bootstrap
366 [ -r "$conffile" ] || fatal "Configuration file $conffile not found."
367 scriptdir=`grep scriptdirectory $conffile | awk '{print $3}'`
368 [ -n "$scriptdir" ] || fatal "Cound not find entry 'scriptdirectory' in $conffile"
369 [ -d "$scriptdir" ] || fatal "Script directory $scriptdir not found."
370 setfile $conffile
371
372 # get global config options (second param is the default)
373 getconf configdirectory /etc/backup.d
374 getconf reportemail
375 getconf reportsuccess yes
376 getconf reportwarning yes
377 getconf loglevel 3
378 getconf when "Everyday at 01:00"
379 defaultwhen=$when
380 getconf logfile /var/log/backupninja.log
381 getconf usecolors "yes"
382 getconf SLAPCAT /usr/sbin/slapcat
383 getconf RDIFFBACKUP /usr/bin/rdiff-backup
384 getconf MYSQL /usr/bin/mysql
385 getconf MYSQLHOTCOPY /usr/bin/mysqlhotcopy
386 getconf MYSQLDUMP /usr/bin/mysqldump
387 getconf GZIP /bin/gzip
388 getconf RSYNC /usr/bin/rsync
389
390 [ -d "$configdirectory" ] || fatal "Configuration directory '$configdirectory' not found."
391
392 if [ "$UID" != "0" ]; then
393         echo "$0 can only be run as root"
394         exit 1
395 fi
396
397 ## Process each configuration file
398
399 # by default, don't make files which are world or group readable.
400 umask 077
401
402 # these globals are set by process_action()
403 fatals=0
404 errors=0
405 warnings=0
406 actions_run=0
407 errormsg=""
408
409 for file in $configdirectory/*; do
410         [ -f $file ] || continue;
411
412         check_perms $file
413         suffix="${file##*.}"
414         base=`basename $file`
415         if [ "${base:0:1}" == "0" ]; then
416                 info "Skipping $file"
417                 continue
418         fi
419
420         if [ -e "$scriptdir/$suffix" ]; then
421                 process_action $file $suffix
422         else
423                 error "Can't process file '$file': no handler script for suffix '$suffix'"
424                 msg "*missing handler* -- $file"
425         fi
426 done
427
428 ## mail the messages to the report address
429
430 if [ $actions_run == 0 ]; then doit=0
431 elif [ "$reportemail" == "" ]; then doit=0
432 elif [ $fatals != 0 ]; then doit=1
433 elif [ $errors != 0 ]; then doit=1
434 elif [ "$reportsuccess" == "yes" ]; then doit=1
435 elif [ "$reportwarning" == "yes" -a $warnings != 0 ]; then doit=1
436 else doit=0
437 fi
438
439 if [ $doit == 1 ]; then
440         debug "send report to $reportemail"
441         hostname=`hostname`
442         [ $warnings == 0 ] || subject="WARNING"
443         [ $errors == 0 ] || subject="ERROR"
444         [ $fatals == 0 ] || subject="FAILED"
445         
446         {
447                 for ((i=0; i < ${#messages[@]} ; i++)); do
448                         echo ${messages[$i]}
449                 done
450                 echo -e "$errormsg"
451         } | mail $reportemail -s "backupninja: $hostname $subject"
452 fi
453