aboutsummaryrefslogtreecommitdiff
path: root/src/backupninja.in
blob: f43eaabd2eb1f2767764025bb6b6053785f24335 (plain)
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
#!@BASH@
#                          |\_
# B A C K U P N I N J A   /()/
#                         `\|
#
# Copyright (C) 2004-05 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

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"
}

colorize () {
	if [ "$usecolors" == "yes" ]; then
		local typestr=`echo "$@" | sed 's/\(^[^:]*\).*$/\1/'`
		[ "$typestr" == "Debug" ] && COLOR=$BLUE
		[ "$typestr" == "Info" ] && COLOR=$GREEN
		[ "$typestr" == "Warning" ] && COLOR=$YELLOW
		[ "$typestr" == "Error" ] && COLOR=$RED
		[ "$typestr" == "Fatal" ] && COLOR=$PURPLE
		endcolor=$OFF
		echo -e "$COLOR$@$endcolor"
	else
		echo -e "$@"
	fi
}

# We have the following message levels:
# 0 - debug - blue
# 1 - normal messages - green
# 2 - warnings - yellow
# 3 - errors - red
# 4 - fatal - purple
# 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

usecolors=yes

function printmsg() {
	[ ${#@} -gt 1 ] || return

	type=$1
	shift
	if [ $type == 100 ]; then
		typestr=`echo "$@" | sed 's/\(^[^:]*\).*$/\1/'`
		[ "$typestr" == "Debug" ] && type=0
		[ "$typestr" == "Info" ] && type=1
		[ "$typestr" == "Warning" ] && type=2
		[ "$typestr" == "Error" ] && type=3
		[ "$typestr" == "Fatal" ] && type=4
		typestr=""
	else
		types=(Debug Info Warning Error Fatal)
		typestr="${types[$type]}: "
	fi
	
	print=$[4-type]
	
	if [ $echo_debug_msg == 1 ]; then
		echo -e "$typestr$@" >&2
	elif [ $debug ]; then
		colorize "$typestr$@" >&2
	fi
	
	if [ $print -lt $loglevel ]; then
		logmsg "$typestr$@"
	fi
}

function logmsg() {
	if [ -w "$logfile" ]; then
		echo -e `date "+%h %d %H:%M:%S"` "$@" >> $logfile
	fi
}

function passthru() {
	printmsg 100 "$@"
}
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"
}

#
# 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
		echo "Configuration files must not be group or world writable/readable! Dying on file $file"
		fatal "Configuration files must not be group or world writable/readable! Dying on file $file"
	fi
	if [ `ls -ld $file | awk '{print $3}'` != "root" ]; then
		echo "Configuration files must be owned by root! Dying on file $file"
		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]$//' | sed -r 's/^([0-9])$/0\1/'`

	if [ "$whendayofweek" == "everyday" -o "$whendayofweek" == "daily" ]; 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 @CFGDIR@/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 @CFGDIR@/backupninja.conf
-t, --test           Test run mode. This will test if the backup
                     could run, without actually preforming any
                     backups. For example, it will attempt to authenticate
                     or test that ssh keys are set correctly.
-n, --now            Perform actions now, instead of when they might
                     be scheduled. No output will be created unless also
                     run with -d.
    --run FILE       Execute the specified action file and then exit.    
                     Also puts backupninja in debug mode.
                     
When in debug mode, output to the console will be colored:
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)"
}

##
## this function handles the running of a backup action
##
## these globals are modified:
## fatals, errors, warnings, actions_run, errormsg
##

function process_action() {
	local file="$1"
	local suffix="$2"
	local run="no"
	setfile $file

	# skip over this config if "when" option
	# is not set to the current time.
	getconf when "$defaultwhen"
	if [ "$processnow" == 1 ]; then
		info ">>>> starting action $file (because of --now)"
		run="yes"
	elif [ "$when" == "hourly" ]; then
		info ">>>> starting action $file (because 'when = hourly')"
		run="yes"
	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"
			else
				info ">>>> starting action $file (because it is $w)"
				run="yes"
			fi
		done
		IFS=$' \t\n'
	fi
	debug $run
	[ "$run" == "no" ] && return
	
	let "actions_run += 1"

	# call the handler:
	local bufferfile=`maketemp backupninja.buffer`
	echo "" > $bufferfile
	echo_debug_msg=1
	(
		. $scriptdirectory/$suffix $file
	) 2>&1 | (
		while read a; do
			echo $a >> $bufferfile
			[ $debug ] && colorize "$a"
		done
	)
	retcode=$?
	# ^^^^^^^^ we have a problem! we can't grab the return code "$?". grrr.
	echo_debug_msg=0

	_warnings=`cat $bufferfile | grep "^Warning: " | wc -l`
	_errors=`cat $bufferfile | grep "^Error: " | wc -l`
	_fatals=`cat $bufferfile | grep "^Fatal: " | wc -l`
	
	ret=`grep "\(^Warning: \|^Error: \|^Fatal: \)" $bufferfile`
	rm $bufferfile
	if [ $_fatals != 0 ]; then
		msg "*failed* -- $file"
		errormsg="$errormsg\n== fatal errors from $file ==\n\n$ret\n"
		passthru "Fatal: <<<< finished action $file: FAILED"
	elif [ $_errors != 0 ]; then
		msg "*error* -- $file"
		errormsg="$errormsg\n== errors from $file ==\n\n$ret\n"
		error "<<<< finished action $file: ERROR"
	elif [ $_warnings != 0 ]; then
		msg "*warning* -- $file"
		errormsg="$errormsg\n== warnings from $file ==\n\n$ret\n"
		warning "<<<< finished action $file: WARNING"
	else
		msg "success -- $file"
		info "<<<< finished action $file: SUCCESS"
	fi

	let "fatals += _fatals"
	let "errors += _errors"
	let "warnings += _warnings"	
}

#####################################################
## MAIN

setupcolors
conffile="@CFGDIR@/backupninja.conf"
loglevel=3

## 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
				echo "-f|--conffile option must be followed by an existing filename"
				fatal "-f|--conffile option must be followed by an existing filename"
				usage
			fi
			# we shift here to avoid processing the file path 
			shift
			;;
		--run)
			debug=1
			if [ -f $2 ]; then
				singlerun=$2
				processnow=1
			else
				echo "--run option must be fallowed by a backupninja action file"
				fatal "--run option must be fallowed by a backupninja action file"
				usage
			fi
			shift
			;;
		*)
			debug=1
			echo "Unknown option $1"
			fatal "Unknown option $1"
			usage
			exit
			;;
	esac
	shift
done																										

#if [ $debug ]; then
#	usercolors=yes
#fi

## Load and confirm basic configuration values

# bootstrap
if [ ! -r "$conffile" ]; then
	echo "Configuration file $conffile not found." 
	fatal "Configuration file $conffile not found."
fi

# find $libdirectory
libdirectory=`grep '^libdirectory' $conffile | awk '{print $3}'`
if [ -z "$libdirectory" ]; then
        if [ -d "@libdir@" ]; then
	   libdirectory="@libdir@"
	else
	   echo "Could not find entry 'libdirectory' in $conffile." 
	   fatal "Could not find entry 'libdirectory' in $conffile." 
	fi
else
        if [ ! -d "$libdirectory" ]; then
	   echo "Lib directory $libdirectory not found." 
	   fatal "Lib directory $libdirectory not found." 
	fi
fi

# include shared functions
. $libdirectory/tools

setfile $conffile

# get global config options (second param is the default)
getconf configdirectory @CFGDIR@/backup.d
getconf scriptdirectory @datadir@
getconf reportemail
getconf reportsuccess yes
getconf reportwarning yes
getconf loglevel 3
getconf when "Everyday at 01:00"
defaultwhen=$when
getconf logfile @localstatedir@/log/backupninja.log
getconf usecolors "yes"
getconf SLAPCAT /usr/sbin/slapcat
getconf LDAPSEARCH /usr/bin/ldapsearch
getconf RDIFFBACKUP /usr/bin/rdiff-backup
getconf MYSQL /usr/bin/mysql
getconf MYSQLHOTCOPY /usr/bin/mysqlhotcopy
getconf MYSQLDUMP /usr/bin/mysqldump
getconf PGSQLDUMP /usr/bin/pg_dump
getconf PGSQLDUMPALL /usr/bin/pg_dumpall
getconf GZIP /bin/gzip
getconf RSYNC /usr/bin/rsync
getconf vservers no
getconf VSERVERINFO /usr/sbin/vserver-info
getconf VSERVER /usr/sbin/vserver
getconf VROOTDIR `if [ -f "$VSERVERINFO" ]; then $VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'; fi`

if [ ! -d "$configdirectory" ]; then
	echo "Configuration directory '$configdirectory' not found."
	fatal "Configuration directory '$configdirectory' not found."
fi

[ -f "$logfile" ] || touch $logfile

if [ "$UID" != "0" ]; then
	echo "$0 can only be run as root"
	exit 1
fi

if [ "$vservers" == "yes" -a ! -d "$VROOTDIR" ]; then
	echo "vservers option set in config, but $VROOTDIR is not a directory!"
	fatal "vservers option set in config, but $VROOTDIR is not a directory!"
fi

## Process each configuration file

# by default, don't make files which are world or group readable.
umask 077

# these globals are set by process_action()
fatals=0
errors=0
warnings=0
actions_run=0
errormsg=""

if [ "$singlerun" ]; then
	files=$singlerun
else
	files=`find $configdirectory -mindepth 1 ! -name '.*.swp' | sort -n`
fi

for file in $files; do
	[ -f "$file" ] || continue

	check_perms $file
	suffix="${file##*.}"
	base=`basename $file`
	if [ "${base:0:1}" == "0" -o "$suffix" == "disabled" ]; then
		info "Skipping $file"
		continue
	fi

	if [ -e "$scriptdirectory/$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 [ $actions_run == 0 ]; then doit=0
elif [ "$reportemail" == "" ]; then doit=0
elif [ $fatals != 0 ]; then doit=1
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
	debug "send report to $reportemail"
	hostname=`hostname`
	[ $warnings == 0 ] || subject="WARNING"
	[ $errors == 0 ] || subject="ERROR"
	[ $fatals == 0 ] || subject="FAILED"
	
	{
		for ((i=0; i < ${#messages[@]} ; i++)); do
	 		echo ${messages[$i]}
		done
		echo -e "$errormsg"
	} | mail $reportemail -s "backupninja: $hostname $subject"
fi

if [ $actions_run != 0 ]; then
	info "FINISHED: $actions_run actions run. $fatals fatal. $errors error. $warnings warning."
fi