3 # B A C K U P N I N J A /()/
6 # Copyright (C) 2004 riseup.net -- property is theft.
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.
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.
19 #####################################################
22 function setupcolors() {
30 COLORS=($BLUE $GREEN $YELLOW $RED $PURPLE)
34 if [ "$usecolors" == "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]}
43 echo -e "$color$@$endcolor"
49 # We have the following message levels:
51 # 1 - normal messages - green
52 # 2 - warnings - yellow
55 # First variable passed is the error level, all others are printed
57 # if 1, echo out all warnings, errors, or fatal
58 # used to capture output from handlers
64 [ ${#@} -gt 1 ] || return
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
77 types=(Debug Info Warning Error Fatal)
78 typestr="${types[$type]}: "
83 if [ $echo_debug_msg == 1 ]; then
84 echo -e "$typestr$@" >&2
86 colorize "$typestr$@" >&2
89 if [ $print -lt $loglevel ]; then
90 if [ -w "$logfile" ]; then
91 colorize "$typestr$@" >> $logfile
118 messages[$msgcount]=$1
126 function setsection() {
131 # sets a global var with name equal to $1
132 # to the value of the configuration parameter $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
144 # replace * with %, so that it is not globbed.
145 ret="${ret//\\*/__star__}"
146 ret="${ret//\*/__star__}"
148 # this is weird, but single quotes are needed to
149 # allow for returned values with spaces. $ret is still expanded
150 # because it is in an 'eval' statement.
155 # enforces very strict permissions on configuration file $file.
158 function check_perms() {
160 local perms=`ls -ld $file`
162 if [ "$perms" != "------" ]; then
163 fatal "Configuration files must not be group or world readable! Dying on file $file"
165 if [ `ls -ld $file | awk '{print $3}'` != "root" ]; then
166 fatal "Configuration files must be owned by root! Dying on file $file"
170 # simple lowercase function
172 echo "$1" | tr [:upper:] [:lower:]
175 # simple to integer function
177 echo "$1" | tr [:alpha:] -d
181 # function isnow(): returns 1 if the time/day passed as $1 matches
182 # the current time/day.
184 # format is <day> at <time>:
190 # we grab the current time once, since processing
191 # all the configs might take more than an hour.
194 nowdayofweek=`date +%A`
195 nowdayofweek=`tolower "$nowdayofweek"`
200 whendayofweek=$1; at=$2; whentime=$3;
201 whenday=`toint "$whendayofweek"`
202 whendayofweek=`tolower "$whendayofweek"`
203 whentime=`echo "$whentime" | sed 's/:[0-9][0-9]$//'`
205 if [ "$whendayofweek" == "everyday" ]; then
206 whendayofweek=$nowdayofweek
209 if [ "$whenday" == "" ]; then
210 if [ "$whendayofweek" != "$nowdayofweek" ]; then
211 whendayofweek=${whendayofweek%s}
212 if [ "$whendayofweek" != "$nowdayofweek" ]; then
216 elif [ "$whenday" != "$nowday" ]; then
220 [ "$at" == "at" ] || return 0
221 [ "$whentime" == "$nowtime" ] || return 0
229 This script allows you to coordinate system backup by dropping a few
230 simple configuration files into /etc/backup.d/. Typically, this
231 script is run hourly from cron.
233 The following options are available:
234 -h, --help This usage message
235 -d, --debug Run in debug mode, where all log messages are
236 output to the current shell.
237 -f, --conffile FILE Use FILE for the main configuration instead
238 of /etc/backupninja.conf
239 -t, --test Run in test mode, no actions are actually taken.
240 -n, --now Perform actions now, instead of when they
242 --run FILE Execute the specified action file and then exit.
243 When using colored output, there are:
246 debug "Debugging info (when run with -d)"
247 info "Informational messages (verbosity level 4)"
248 warning "Warnings (verbosity level 3 and up)"
249 error "Errors (verbosity level 2 and up)"
250 fatal "Fatal, halting errors (always shown)"
254 ## this function handles the running of a backup action
256 ## these globals are modified:
257 ## fatals, errors, warnings, actions_run, errormsg
260 function process_action() {
266 # skip over this config if "when" option
267 # is not set to the current time.
268 getconf when "$defaultwhen"
269 if [ "$processnow" == 1 ]; then
270 info "running $file because of --now"
278 if [ $ret == 0 ]; then
279 debug "skipping $file because it is not $w"
282 info "running $file because it is $w"
288 let "actions_run += 1"
291 local bufferfile="/tmp/backupninja.buffer.$$"
292 echo "" > $bufferfile
295 . $scriptdir/$suffix $file
298 echo $a >> $bufferfile
299 [ $debug ] && colorize "$a"
303 # ^^^^^^^^ we have a problem! we can't grab the return code "$?". grrr.
306 _warnings=`cat $bufferfile | grep "^Warning: " | wc -l`
307 _errors=`cat $bufferfile | grep "^Error: " | wc -l`
308 _fatals=`cat $bufferfile | grep "^Fatal: " | wc -l`
310 ret=`grep "\(^Warning: \|^Error: \|^Fatal: \)" $bufferfile`
312 if [ $_fatals != 0 ]; then
313 msg "*failed* -- $file"
314 errormsg="$errormsg\n== failures from $file ==\n\n$ret\n"
315 elif [ $_errors != 0 ]; then
316 msg "*error* -- $file"
317 errormsg="$errormsg\n== errors from $file ==\n\n$ret\n"
318 elif [ $_warnings != 0 ]; then
319 msg "*warning* -- $file"
320 errormsg="$errormsg\n== warnings from $file ==\n\n$ret\n"
321 elif [ $retcode == 0 ]; then
322 msg "success -- $file"
324 msg "unknown -- $file"
327 let "fatals += _fatals"
328 let "errors += _errors"
329 let "warnings += _warnings"
332 #####################################################
336 conffile="/etc/backupninja.conf"
339 ## process command line options
341 while [ $# -ge 1 ]; do
344 -d|--debug) debug=1;;
345 -t|--test) test=1;debug=1;;
346 -n|--now) processnow=1;;
351 fatal "-f|--conffile option must be followed by an existing filename"
354 # we shift here to avoid processing the file path
363 fatal "--run option must be fallowed by a backupninja action file"
370 fatal "Unknown option $1"
382 ## Load and confirm basic configuration values
385 [ -r "$conffile" ] || fatal "Configuration file $conffile not found."
386 scriptdir=`grep scriptdirectory $conffile | awk '{print $3}'`
387 [ -n "$scriptdir" ] || fatal "Cound not find entry 'scriptdirectory' in $conffile"
388 [ -d "$scriptdir" ] || fatal "Script directory $scriptdir not found."
391 # get global config options (second param is the default)
392 getconf configdirectory /etc/backup.d
394 getconf reportsuccess yes
395 getconf reportwarning yes
397 getconf when "Everyday at 01:00"
399 getconf logfile /var/log/backupninja.log
400 getconf usecolors "yes"
401 getconf SLAPCAT /usr/sbin/slapcat
402 getconf RDIFFBACKUP /usr/bin/rdiff-backup
403 getconf MYSQL /usr/bin/mysql
404 getconf MYSQLHOTCOPY /usr/bin/mysqlhotcopy
405 getconf MYSQLDUMP /usr/bin/mysqldump
406 getconf GZIP /bin/gzip
407 getconf RSYNC /usr/bin/rsync
409 [ -d "$configdirectory" ] || fatal "Configuration directory '$configdirectory' not found."
411 if [ "$UID" != "0" ]; then
412 echo "$0 can only be run as root"
416 ## Process each configuration file
418 # by default, don't make files which are world or group readable.
421 # these globals are set by process_action()
428 if [ "$singlerun" ]; then
431 files=`find $configdirectory -mindepth 1 `
434 for file in $files; do
435 [ -f "$file" ] || continue
439 base=`basename $file`
440 if [ "${base:0:1}" == "0" ]; then
441 info "Skipping $file"
445 if [ -e "$scriptdir/$suffix" ]; then
446 process_action $file $suffix
448 error "Can't process file '$file': no handler script for suffix '$suffix'"
449 msg "*missing handler* -- $file"
453 ## mail the messages to the report address
455 if [ $actions_run == 0 ]; then doit=0
456 elif [ "$reportemail" == "" ]; then doit=0
457 elif [ $fatals != 0 ]; then doit=1
458 elif [ $errors != 0 ]; then doit=1
459 elif [ "$reportsuccess" == "yes" ]; then doit=1
460 elif [ "$reportwarning" == "yes" -a $warnings != 0 ]; then doit=1
464 if [ $doit == 1 ]; then
465 debug "send report to $reportemail"
467 [ $warnings == 0 ] || subject="WARNING"
468 [ $errors == 0 ] || subject="ERROR"
469 [ $fatals == 0 ] || subject="FAILED"
472 for ((i=0; i < ${#messages[@]} ; i++)); do
476 } | mail $reportemail -s "backupninja: $hostname $subject"