dbackup 43.4 KB
Newer Older
Nigel Kukard's avatar
Nigel Kukard committed
1
#!/usr/bin/perl -w
Nigel Kukard's avatar
Nigel Kukard committed
2
# Copyright (c) 2010-2014, AllWorldIT
Nigel Kukard's avatar
Nigel Kukard committed
3
#
Nigel Kukard's avatar
Nigel Kukard committed
4
5
6
7
# 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 3 of the License, or
# (at your option) any later version.
Nigel Kukard's avatar
Nigel Kukard committed
8
#
Nigel Kukard's avatar
Nigel Kukard committed
9
10
11
12
# 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.
Nigel Kukard's avatar
Nigel Kukard committed
13
#
Nigel Kukard's avatar
Nigel Kukard committed
14
15
16
17
18
19
20
21
22
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
#
# Author: Nigel Kukard <nkukard@lbsd.net>


# TODO:
# - USE incremental backups!!!! fucking awesome
23
24
25
26
#
# - Read in defaultSystemExcl extras from /proc/mounts
# - proc, nfs, nfs4, fusectl fuse.glusterfs, sysfs, tmpfs, devtmpfs, devpts
#
Nigel Kukard's avatar
Nigel Kukard committed
27
28
29
30


use strict;
use Compress::Zlib;
31
use Config::IniFiles;
Nigel Kukard's avatar
Nigel Kukard committed
32
33
34
35
36
37
use Cwd;
use Fcntl qw (:mode);
use File::Find;
use File::Path qw( rmtree mkpath );
use File::Spec;
use Getopt::Long;
38
use POSIX qw (strftime lchown);
Nigel Kukard's avatar
Nigel Kukard committed
39
40
41
42
43
use Data::Dumper;
use MIME::Base64;



Nigel Kukard's avatar
Nigel Kukard committed
44
my $VERSION = "0.0.x";
Nigel Kukard's avatar
Nigel Kukard committed
45
# System dirs we don't care about
46
my @defaultSystemExcl = ("/dev","/run","/proc","/sys","/tmp","/var/tmp","/misc","/media","/mnt");
Nigel Kukard's avatar
Nigel Kukard committed
47
# These should be backed up separately
48
my @defaultDataExcl = (
49
		# We cannot backup the DB reliably by just copying files
50
		"/var/lib/mysql","/var/lib/pgsql",
51
52

		# Exclude amavis working files
53
		"/var/amavis/tmp/",
54
55
56
		"/var/lib/amavis/tmp/",
		"/var/spool/amavis/virusmails/",

57
		"/var/spool/mailman/retry",
58
59
60
61
		# Exclude postfix queues
		"/var/spool/postfix/active",
		"/var/spool/postfix/defer",
		"/var/spool/postfix/deferred",
62
		"/var/spool/postfix/public",
63
		"/var/spool/postfix/private",
64
		# Exclude squid cache
65
		"/var/spool/squid",
66
67
68
69
70
71
72
73

		# Yum cache
		"/var/cache/yum",
		# Apt cache
		"/var/cache/apt/archives",

		# cPanel
		"/home/virtfs"
74
);
Nigel Kukard's avatar
Nigel Kukard committed
75

76

Nigel Kukard's avatar
Nigel Kukard committed
77
# Backup constants
Nigel Kukard's avatar
Nigel Kukard committed
78
use constant {
Nigel Kukard's avatar
Nigel Kukard committed
79
80
	LOG_DEBUG => 5,
	LOG_INFO => 4,
Nigel Kukard's avatar
Nigel Kukard committed
81
	LOG_NOTICE => 3,
Nigel Kukard's avatar
Nigel Kukard committed
82
83
	LOG_WARNING => 2,
	LOG_ERROR => 1
Nigel Kukard's avatar
Nigel Kukard committed
84
85
};

Nigel Kukard's avatar
Nigel Kukard committed
86
87
88
89
90
91
92
93
94
95
use constant {
	ST_FILE_CHANGED 	=> 1,
	ST_DIR_NEW	=> 2,
	ST_DIR_SYS	=> 4,
	ST_DIR_CHANGED	=> 8,
	ST_FILE_ATTR_CHANGED	=> 16,
	ST_FILE_NEW	=> 32,
};


96
97
# Main config
my %config = (
98
99
100
101
	'log-level' => LOG_NOTICE,
	'tar' => 'tar',
	'exclude-system' => 0,
	'backup-upgrade' => 0
102
103
104
105
106
107
108
109
110
111
);
# Choose default compression method
if (-x "/bin/xz" || -x "/usr/bin/xz") {
	$config{'compress'} = "xz";
} else {
	$config{'compress'} = "bzip2";
}



Nigel Kukard's avatar
Nigel Kukard committed
112
print(STDERR "DBackup v$VERSION, Copyright (c) 2010-2014, AllWorldIT\n\n");
Nigel Kukard's avatar
Nigel Kukard committed
113
114
115
116
117
118
119


# Grab options
my %optctl = ();
GetOptions(\%optctl,
	"help",

120
	"config=s",
Nigel Kukard's avatar
Nigel Kukard committed
121
	"log-level=i",
122
	"tar=s",
Nigel Kukard's avatar
Nigel Kukard committed
123
	"manifest-format=s",
124

Nigel Kukard's avatar
Nigel Kukard committed
125
	"backup",
Nigel Kukard's avatar
Nigel Kukard committed
126
	"backup-upgrade",
Nigel Kukard's avatar
Nigel Kukard committed
127
128
	"compress:s",
	"exclude-system",
129
130
	"system-base=s@",
	"system-dir=s@",
Nigel Kukard's avatar
Nigel Kukard committed
131

132
133
	"tar-ignore-failed-read=s@",

Nigel Kukard's avatar
Nigel Kukard committed
134
	"exclude-data",
135
	"data-dir=s@",
Nigel Kukard's avatar
Nigel Kukard committed
136

137
138
	"exclude-file=s@",
	"exclude-path=s@",
Nigel Kukard's avatar
Nigel Kukard committed
139

140
141
	"exclude-fs-type=s@",

Nigel Kukard's avatar
Nigel Kukard committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
	"restore",
	"tar-keep-newer",
	"tar-keep-old-files",
);

# Check for help
if (defined($optctl{'help'})) {
	displayHelp();
	exit 0;
}

# Check for invalid combination
if (defined($optctl{'backup'}) && defined($optctl{'restore'})) {
	print(STDERR "ERROR: Cannot backup AND restore at the same time\n\n");
	displayHelp();
	exit 1;
}

160
161
162
163
164
165
166
167
168
169
# Check config file exists
if (!defined($optctl{'config'})) {
	$optctl{'config'} = "/etc/dbackupc.conf";
}

if (! -f $optctl{'config'}) {
	print(STDERR "ERROR: Configuration file '".$optctl{'config'}."' NOT found!\n");
	exit 1;
}

Nigel Kukard's avatar
Nigel Kukard committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# Make sure we only have 2 additional args
if (@ARGV > 2 || @ARGV < 2) {
		print(STDERR "ERROR: Invalid number of arguments\n\n");
		displayHelp();
		exit 1;
}

# Check both dirs exist...
if (! -d $ARGV[0]) {
	print(STDERR "ERROR: Source directory '".$ARGV[0]."' does not exist!\n\n");
	exit 1;
}
if (! -d $ARGV[1]) {
	print(STDERR "ERROR: Destination directory '".$ARGV[1]."' does not exist!\n\n");
	exit 1;
}

187
188
189
190
191
192
193
194
195
196
197
# Use config file, ignore case
tie my %inifile, 'Config::IniFiles', (
		-file => $optctl{'config'},
		-nocase => 1
) or die "Failed to open config file '".$optctl{'config'}."': ".join("\n",@Config::IniFiles::errors);

# Check if we actually have something...
if (defined($inifile{'backup'})) {
	# Loop with config items
	foreach my $item (keys %{$inifile{'backup'}}) {
		$config{$item} = $inifile{'backup'}{$item};
198
199
200
201
	}
}


202
203
204
#
# Process config
#
205
if (!defined($config{'system-base'})) {
206
	# Quick hack to see if we have a cmdline option
207
208
	if (!defined($optctl{'system-base'})) {
		$config{'system-base'} = ["/"];
209
	} else {
210
		$config{'system-base'} = [];
211
212
	}
} else {
213
214
215
216
217
218
219
	$config{'system-base'} = toArray($config{'system-base'});
}

if (!defined($config{'system-dir'})) {
	$config{'system-dir'} = [];
} else {
	$config{'system-dir'} = toArray($config{'system-dir'});
220
221
}

222
223
224
225
226
227
if (!defined($config{'tar-ignore-failed-read'})) {
	$config{'tar-ignore-failed-read'} = [];
} else {
	$config{'tar-ignore-failed-read'} = toArray($config{'tar-ignore-failed-read'});
}

228
229
if (!defined($config{'data-dir'})) {
	$config{'data-dir'} = [];
230
} else {
231
	$config{'data-dir'} = toArray($config{'data-dir'});
232
233
}

234
235
if (!defined($config{'exclude-file'})) {
	$config{'exclude-file'} = [];
236
} else {
237
	$config{'exclude-file'} = toArray($config{'exclude-file'});
238
239
}

240
241
if (!defined($config{'exclude-path'})) {
	$config{'exclude-path'} = [];
242
} else {
243
	$config{'exclude-path'} = toArray($config{'exclude-path'});
244
245
}

246
247
248
249
250
251
252
253
254
255
if (!defined($config{'exclude-fs-type'})) {
	$config{'exclude-fs-type'} = [];
} else {
	$config{'exclude-fs-type'} = toArray($config{'exclude-fs-type'});
}


#
# Check commandline options
#
256

Nigel Kukard's avatar
Nigel Kukard committed
257
258
259
260
if (defined($optctl{'backup-upgrade'})) {
	$config{'backup-upgrade'} = 1;
}

Nigel Kukard's avatar
Nigel Kukard committed
261
262
263
264
265
266
267
268
269
270
271
272
if (defined($optctl{'compress'})) {
	# Why use --compress with --restore?
	if (defined($optctl{'restore'})) {
		print(STDERR "WARNING: The use of --compress with --restore does not make sense\n");
	}

	# Make sure its valid
	if (
				$optctl{'compress'} ne "xz" &&
				$optctl{'compress'} ne "bzip2" &&
				$optctl{'compress'} ne "gzip" &&
				$optctl{'compress'} ne "none"
Nigel Kukard's avatar
Nigel Kukard committed
273
	) {
Nigel Kukard's avatar
Nigel Kukard committed
274
275
276
277
		print(STDERR "ERROR: Compression is invalid, valid values are: xz bzip2 gzip none\n\n");
		displayHelp();
		exit 1;
	}
278
	$config{'compress'} = $optctl{'compress'};
Nigel Kukard's avatar
Nigel Kukard committed
279
280
}

281
282
283
284
285
286
287
288
289
290
if (defined($optctl{'tar'})) {
	# Check if tar is executable
	if ( -x $optctl{'tar'}) {
		$config{'tar'} = $optctl{'tar'};
	} else {
		print(STDERR "ERROR: tar '".$optctl{'tar'}."' does not exist or is not executable\n");
	}
}
my $tarVer = getTarVer($config{'tar'});

291
292
293
if (defined($optctl{'log-level'})) {
	$config{'log-level'} = $optctl{'log-level'};
}
294

Nigel Kukard's avatar
Nigel Kukard committed
295
296
297
298
if (defined($optctl{'manifest-format'})) {
	if (
				$optctl{'manifest-format'} ne "null" &&
				$optctl{'manifest-format'} ne "newline"
Nigel Kukard's avatar
Nigel Kukard committed
299
	) {
Nigel Kukard's avatar
Nigel Kukard committed
300
301
302
303
304
305
306
		print(STDERR "ERROR: Manifest format is invalid, valid values are: null newline\n\n");
		displayHelp();
		exit 1;
	}
	$config{'manifest-format'} = $optctl{'manifest-format'};
}

307
308
309
if (defined($optctl{'exclude-system'})) {
	$config{'exclude-system'} = 1;
}
310

311
312
if (defined($optctl{'system-base'})) {
	push(@{$config{'system-base'}},@{$optctl{'system-base'}});
Nigel Kukard's avatar
Nigel Kukard committed
313
}
314

315
316
if (defined($optctl{'system-dir'})) {
	push(@{$config{'system-dir'}},@{$optctl{'system-dir'}});
Nigel Kukard's avatar
Nigel Kukard committed
317
}
318

319
320
321
322
if (defined($optctl{'tar-ignore-failed-read'})) {
	push(@{$config{'tar-ignore-failed-read'}},@{$optctl{'tar-ignore-failed-read'}});
}

323
324
if (defined($optctl{'data-dir'})) {
	push(@{$config{'data-dir'}},@{$optctl{'data-dir'}});
325
}
326

327
328
329
if (defined($optctl{'exclude-file'})) {
	push(@{$config{'exclude-file'}},@{$optctl{'exclude-file'}});
}
330

331
332
if (defined($optctl{'exclude-path'})) {
	push(@{$config{'exclude-path'}},@{$optctl{'exclude-path'}});
Nigel Kukard's avatar
Nigel Kukard committed
333
334
}

335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
if (defined($optctl{'exclude-fs-type'})) {
	push(@{$config{'exclude-fs-type'}},@{$optctl{'exclude-fs-type'}});
}

if (@{$config{'exclude-fs-type'}} > 0) {
	# Pull in mounts
	open(MOUNTS, "< /proc/mounts")
			or die "ERROR: Failed to open '/proc/mounts': $!";
	while (my $line = <MOUNTS>) {
		chomp($line);
		# Split off items we need
		my (undef,$path,$type) = split(/\s+/,$line);
		# Loop with types and check
		foreach my $item (@{$config{'exclude-fs-type'}}) {
			if ($item eq $type) {
				push(@{$config{'exclude-path'}},$path);
			}
		}
	}
	close(MOUNTS);
}

Nigel Kukard's avatar
Nigel Kukard committed
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
# Sanitize the source and dest
my $sourceDir = File::Spec->rel2abs($ARGV[0]);
my $destDir = File::Spec->rel2abs($ARGV[1]);


# Backup function
sub backup
{
	our ($source,$dest) = @_;


	# State infor for current dir
	our %doBackup;
	our %srcFileList;
	our %srcDirList;
	# Original .state file read in during backup
	our %origFileList;
	our %origDirList;
	our %origPathAttribs;
	# New attributes
	our %newPathAttribs;


	# Preprocess dir
	sub backup_preprocess {
		my @list = @_;

		# Strip first part of the path
		(my $path = $File::Find::dir) =~ s#^$source/?##;

		# Check if this dir should be backed up or not....
		if ( -f "$source/$path/.nodbackup" ) {
Nigel Kukard's avatar
Nigel Kukard committed
389
			printLog(LOG_INFO,"S: Path '[$source]/($path)' EXCLUDED from backup with .nodbackup\n");
Nigel Kukard's avatar
Nigel Kukard committed
390
391
392
393
			return ();
		}
		# Exclude trash folders
		if ( "$source/$path" =~ /(\.Trash-[0-9]{4})$/) {
Nigel Kukard's avatar
Nigel Kukard committed
394
			printLog(LOG_INFO,"S: Path '[$source]/($path)' EXCLUDED from backup, Linux trash folder\n");
Nigel Kukard's avatar
Nigel Kukard committed
395
396
397
398
399
400
401
402
403
404
			return ();
		}

		# Make sure even if we processing empty dirs that we actually record it
		if (!defined($srcFileList{$path})) {
			# Just set to empty hash ref
			$srcFileList{$path} = {};
		}

		# Exclude system directories
405
		if ($config{'exclude-system'}) {
Nigel Kukard's avatar
Nigel Kukard committed
406
			# Loop through system dirs
407
			foreach my $sysdir (@{$config{'system-base'}}) {
Nigel Kukard's avatar
Nigel Kukard committed
408
				# Loop with system paths
409
				foreach my $excl (@defaultSystemExcl,@{$config{'system-dir'}}) {
Nigel Kukard's avatar
Nigel Kukard committed
410
					# Sanitize path
411
					my $testPath = File::Spec->rel2abs("$sysdir/$excl");
Nigel Kukard's avatar
Nigel Kukard committed
412
					# Check...
413
					if ("/$path" eq $testPath) {
Nigel Kukard's avatar
Nigel Kukard committed
414
						printLog(LOG_INFO,"S: Path '[$source]/($path)' is a system directory, ignoring files\n");
Nigel Kukard's avatar
Nigel Kukard committed
415
416
417
418
419
						$doBackup{$path} |= ST_DIR_SYS;
						return ();
					}
				}
				# Check if we excluding data dirs
420
				if (defined($config{'exclude-data'})) {
Nigel Kukard's avatar
Nigel Kukard committed
421
					# Loop with data dirs
422
					foreach my $excl (@defaultDataExcl,@{$config{'data-dir'}}) {
Nigel Kukard's avatar
Nigel Kukard committed
423
						# Sanitize path
424
						my $testPath = File::Spec->rel2abs("$sysdir/$excl");
Nigel Kukard's avatar
Nigel Kukard committed
425
						# Check...
426
						if ("/$path" eq $testPath) {
Nigel Kukard's avatar
Nigel Kukard committed
427
							printLog(LOG_INFO,"S: Path '[$source]/($path)' is a data directory, ignoring files\n");
Nigel Kukard's avatar
Nigel Kukard committed
428
429
430
431
432
433
434
							$doBackup{$path} |= ST_DIR_SYS;
							return ();
						}
					}
				}
			}
		}
435
436
437
438
		# Exclude paths
		foreach my $item (@{$config{'exclude-path'}}) {
			# Check...
			if ("/$path" =~ $item) {
Nigel Kukard's avatar
Nigel Kukard committed
439
				printLog(LOG_INFO,"S: Path '[$source]/($path)' is an excluded path, ignoring files\n");
440
441
442
443
				$doBackup{$path} |= ST_DIR_SYS;
				return ();
			}
		}
Nigel Kukard's avatar
Nigel Kukard committed
444
445
446
447
448
449
450
451

		# Check if this dir exists on the backup, if not we need to back it up obviously...
		if ( ! -d "$dest/$path") {
			$doBackup{$path} |= ST_DIR_NEW;
		# This can probably only be because a backup was continued
		} elsif ( ! -f "$dest/$path/.dbackup-state" ) {
			# First backup will never have the main dir .dbackup-state file existing
			if ($path ne "") {
Nigel Kukard's avatar
Nigel Kukard committed
452
				printLog(LOG_WARNING,"State file '[$dest]/($path)/.dbackup-state' does not exist\n");
Nigel Kukard's avatar
Nigel Kukard committed
453
454
455
456
457
458
459
460
461
462
463
			}
			$doBackup{$path} |= ST_DIR_NEW;
		}

		# Cannot read in for new dirs can we...
		if (($doBackup{$path} & ST_DIR_NEW) != ST_DIR_NEW) {
			# Load state file
			loadStateFile("$dest/$path/.dbackup-state",$path,\%origFileList,\%origDirList,\%origPathAttribs);

			# Check we have at least the version attribute
			if (!defined($origPathAttribs{$path}) || !defined($origPathAttribs{$path}->{'dbackup.version'})) {
Nigel Kukard's avatar
Nigel Kukard committed
464
				printLog(LOG_ERROR,"No dbackup version information found in '[$dest]/($path)/.dbackup-state', IGNORING\n");
Nigel Kukard's avatar
Nigel Kukard committed
465
466
				delete($origDirList{$path});
				delete($origFileList{$path});
Nigel Kukard's avatar
Nigel Kukard committed
467
468
469
470
471
472

			# NK:
			# Sanity check, some versions created empty'ish .dbackup-state files with no sequence  < 2012-01-21
			# If we have a manifest, we should have a backup, therefore a format and sequence
			} elsif (
					-f "$dest/$path/dbackup0.manifest" && (
Nigel Kukard's avatar
Nigel Kukard committed
473
						!defined($origPathAttribs{$path}->{'format'}) ||
Nigel Kukard's avatar
Nigel Kukard committed
474
475
476
477
478
						!defined($origPathAttribs{$path}->{'sequence'})
					)
			) {
				printLog(LOG_ERROR,"No dbackup format/sequence information found in ".
						"'[$dest]/($path)/.dbackup-state', IGNORING\n");
Nigel Kukard's avatar
Nigel Kukard committed
479
480
				delete($origDirList{$path});
				delete($origFileList{$path});
Nigel Kukard's avatar
Nigel Kukard committed
481
482
483
484
485
486
487
488
489

			# Check if we going to upgrade...
			} else {
				# Are we doing backup upgrades?
				if ($config{'backup-upgrade'}) {
					# Pull in versions
					my $a = getNumericVer($origPathAttribs{$path}->{'dbackup.version'});
					my $b = getNumericVer($VERSION);
					# Compare
Nigel Kukard's avatar
Nigel Kukard committed
490
491
492
493
					if (
							$a < 16		# Things before 0.0.16 may have .dbackup-state issues and missing
										# required info.
					) {
Nigel Kukard's avatar
Nigel Kukard committed
494
495
496
497
498
499
500
501
						# Check if end in .x
						if ($VERSION =~ /\.x$/) {
							printLog(LOG_WARNING,"S: Path '[$source]/($path)' ".
									"cannot be upgraded, dbackup is TRUNK version\n");
						} else {
							printLog(LOG_INFO,"S: Path '[$source]/($path)' will be backed up, upgrading\n");
							delete($origDirList{$path});
							delete($origFileList{$path});
502
503
							# Force state file update if dir is empty
							$doBackup{$path} |= ST_DIR_CHANGED;
Nigel Kukard's avatar
Nigel Kukard committed
504
505
506
						}
					}
				}
507
508
509
510
			}
		}

		# Apply filter...
511
		if ((@{$config{'exclude-file'}}) > 0) {
512
513
514
515
516
517
			my @newList;
			foreach my $item (@list) {
				my $match = 0;
				# Apply only to files
				if ( -f "$source/$path/$item") {
					# Loop with exclude filters
518
					foreach my $filter (@{$config{'exclude-file'}}) {
519
520
						# Check for match
						if ($item =~ $filter) {
Nigel Kukard's avatar
Nigel Kukard committed
521
							printLog(LOG_INFO,"S: Path '[$source]/($path)/$item' matches file exclude filter, ignoring\n");
522
523
524
525
526
527
528
529
530
531
							# XXX: NK - If this ws backed up before and now not, dir has changed?
							$match = 1;
							last;
						}
					}
				}
				# If not matched, add to new list
				if (!$match) {
					push(@newList,$item);
				}
Nigel Kukard's avatar
Nigel Kukard committed
532
			}
533
534
			# Replace the list now
			@list = @newList;
Nigel Kukard's avatar
Nigel Kukard committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
		}

		return @list;
	}

	# Process files
	sub backup_process {
		my $name = $File::Find::name;
		# Strip first part of the path
		(my $path = $File::Find::dir) =~ s#^$source/?##;

		# Store current filename
		my $item = $_;

		# We use lstat so we don't follow symlinks that don't exist
		my @stat = lstat($name);
		# Split it up
		my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,
				$ctime,$blksize,$blocks) = @stat;

		# Process directory
		if (S_ISDIR($mode)) {
			# Skip over main dir
			if ($item eq ".") {
				return;
			}

			# Make sure sub dirs have a santized name
			my $ppath = ($path ne "") ? "$path/$item" : $item;

			# Set default flags to nothing...
			$doBackup{$ppath} = 0;

			# Ok, lets see whats going on with the dir
			if (!defined($origDirList{$path}->{$item})) {
Nigel Kukard's avatar
Nigel Kukard committed
570
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' is new\n");
Nigel Kukard's avatar
Nigel Kukard committed
571
572
573
574
575
576
577
				$doBackup{$path} |= ST_DIR_CHANGED;

			# Check if mtime matches
			} elsif (
					!defined($origDirList{$path}->{$item}->{'mtime'}) ||
					$origDirList{$path}->{$item}->{'mtime'} ne $mtime
			) {
Nigel Kukard's avatar
Nigel Kukard committed
578
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' was modified\n");
Nigel Kukard's avatar
Nigel Kukard committed
579
580
581
582
583
584
				$doBackup{$path} |= ST_DIR_CHANGED;
			# Check if uid matches
			} elsif (
					!defined($origDirList{$path}->{$item}->{'uid'}) ||
					$origDirList{$path}->{$item}->{'uid'} ne $uid
			) {
Nigel Kukard's avatar
Nigel Kukard committed
585
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' UID was changed\n");
Nigel Kukard's avatar
Nigel Kukard committed
586
587
588
589
590
591
				$doBackup{$path} |= ST_DIR_CHANGED;
			# Check if gid matches
			} elsif (
					!defined($origDirList{$path}->{$item}->{'gid'}) ||
					$origDirList{$path}->{$item}->{'gid'} ne $gid
			) {
Nigel Kukard's avatar
Nigel Kukard committed
592
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' GID was changed\n");
Nigel Kukard's avatar
Nigel Kukard committed
593
594
595
596
597
598
				$doBackup{$path} |= ST_DIR_CHANGED;
			# Check if mode matches
			} elsif (
					!defined($origDirList{$path}->{$item}->{'mode'}) ||
					$origDirList{$path}->{$item}->{'mode'} ne $mode
			) {
Nigel Kukard's avatar
Nigel Kukard committed
599
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' MODE was changed\n");
Nigel Kukard's avatar
Nigel Kukard committed
600
601
602
				$doBackup{$path} |= ST_DIR_CHANGED;
			}

Nigel Kukard's avatar
Nigel Kukard committed
603
			# Record details...
Nigel Kukard's avatar
Nigel Kukard committed
604
605
606
607
608
609
610
611
612
			$srcDirList{$path}->{$item}->{'size'} = $size;
			$srcDirList{$path}->{$item}->{'ctime'} = $ctime;
			$srcDirList{$path}->{$item}->{'atime'} = $atime;
			$srcDirList{$path}->{$item}->{'mtime'} = $mtime;
			$srcDirList{$path}->{$item}->{'uid'} = $uid;
			$srcDirList{$path}->{$item}->{'gid'} = $gid;
			$srcDirList{$path}->{$item}->{'mode'} = $mode;

			return;
613
614
615
616
617

		# Check if we're a socket
		} elsif (S_ISSOCK($mode)) {
			# Blatently ignore...
			return;
Nigel Kukard's avatar
Nigel Kukard committed
618
619
620
621
622
623
624
625
		}

		# Initialize file state
		my $state = 0;

		# Check if file does not exists on backup
		if (!defined($origFileList{$path}->{$item})) {
			if (($doBackup{$path} & ST_DIR_NEW) != ST_DIR_NEW) {
Nigel Kukard's avatar
Nigel Kukard committed
626
				printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' is new\n");
Nigel Kukard's avatar
Nigel Kukard committed
627
628
629
630
631
632
633
634
			}
			$state |= ST_FILE_NEW;

		# Check if size matches
		} elsif (
				!defined($origFileList{$path}->{$item}->{'size'}) ||
				$origFileList{$path}->{$item}->{'size'} ne $size
		) {
Nigel Kukard's avatar
Nigel Kukard committed
635
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' has different size\n");
Nigel Kukard's avatar
Nigel Kukard committed
636
637
638
639
640
641
642
643
644
645
			$state |= ST_FILE_CHANGED;

		#
		# NK: Does not like chmod changes to files???
		#
		# Check if ctime matches
#		} elsif (
#				!defined($origFileList{$path}->{$item}->{'ctime'}) ||
#				$origFileList{$path}->{$item}->{'ctime'} ne $ctime
#		) {
Nigel Kukard's avatar
Nigel Kukard committed
646
#			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' was recreated\n");
Nigel Kukard's avatar
Nigel Kukard committed
647
648
649
650
651
652
653
#			$state |= ST_FILE_CHANGED;

		# Check if mtime matches
		} elsif (
				!defined($origFileList{$path}->{$item}->{'mtime'}) ||
				$origFileList{$path}->{$item}->{'mtime'} ne $mtime
		) {
Nigel Kukard's avatar
Nigel Kukard committed
654
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' was modified\n");
Nigel Kukard's avatar
Nigel Kukard committed
655
656
657
658
659
660
661
			$state |= ST_FILE_CHANGED;

		# Check if uid matches
		} elsif (
				!defined($origFileList{$path}->{$item}->{'uid'}) ||
				$origFileList{$path}->{$item}->{'uid'} ne $uid
		) {
Nigel Kukard's avatar
Nigel Kukard committed
662
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' UID was changed\n");
Nigel Kukard's avatar
Nigel Kukard committed
663
664
665
666
667
668
669
			$state |= ST_FILE_ATTR_CHANGED

		# Check if gid matches
		} elsif (
				!defined($origFileList{$path}->{$item}->{'gid'}) ||
				$origFileList{$path}->{$item}->{'gid'} ne $gid
		) {
Nigel Kukard's avatar
Nigel Kukard committed
670
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' GID was changed\n");
Nigel Kukard's avatar
Nigel Kukard committed
671
672
673
674
675
676
677
			$state |= ST_FILE_ATTR_CHANGED;

		# Check if mode matches
		} elsif (
				!defined($origFileList{$path}->{$item}->{'mode'}) ||
				$origFileList{$path}->{$item}->{'mode'} ne $mode
		) {
Nigel Kukard's avatar
Nigel Kukard committed
678
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' MODE was changed\n");
Nigel Kukard's avatar
Nigel Kukard committed
679
680
681
682
683
684
685
686
			$state |= ST_FILE_ATTR_CHANGED;
		}

		# Update state of path, this is used below, the $state is used to track WHAT changed
		if ($state) {
			$doBackup{$path} |= ST_FILE_CHANGED;
		}

Nigel Kukard's avatar
Nigel Kukard committed
687
		# Record details...
Nigel Kukard's avatar
Nigel Kukard committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
		$srcFileList{$path}->{$item}->{'size'} = $size;
		$srcFileList{$path}->{$item}->{'ctime'} = $ctime;
		$srcFileList{$path}->{$item}->{'atime'} = $atime;
		$srcFileList{$path}->{$item}->{'mtime'} = $mtime;
		$srcFileList{$path}->{$item}->{'uid'} = $uid;
		$srcFileList{$path}->{$item}->{'gid'} = $gid;
		$srcFileList{$path}->{$item}->{'mode'} = $mode;
		$srcFileList{$path}->{$item}->{'_state'} = $state;
	}


	# Time to do stuff
	sub backup_postprocess {
		# Strip first part of the path
		(my $path = $File::Find::dir) =~ s#^$source/?##;
		# Get current lists
		my $curDirList = $srcDirList{$path};
		my $curFileList = $srcFileList{$path};

		# Compare the two file lists, we know what was added, lets see if anything was removed
		foreach my $fname (keys %{$origFileList{$path}}) {
			if (!defined($srcFileList{$path}->{$fname})) {
Nigel Kukard's avatar
Nigel Kukard committed
710
				printLog(LOG_DEBUG,"File '[$source]/($path)/$fname' removed\n");
Nigel Kukard's avatar
Nigel Kukard committed
711
712
713
714
715
716
717
718
719
				$doBackup{$path} |= ST_FILE_CHANGED;
			}
		}

		# Create backup dir
		if (($doBackup{$path} & ST_DIR_NEW) == ST_DIR_NEW && ! -d "$dest/$path") {
			mkpath("$dest/$path");
		}

Nigel Kukard's avatar
Nigel Kukard committed
720
721
722
723
724
725
726
727
		# NK:
		# Before we do anything, we copy our previous attributes.
		# If we do not write an archive below, we still have our stuff.
		# If there is something special, we still have it. Best idea? right?
		foreach my $item (keys %{$origPathAttribs{$path}}) {
			$newPathAttribs{$path}->{$item} = $origPathAttribs{$path}->{$item};
		}

Nigel Kukard's avatar
Nigel Kukard committed
728
729
		# Check if we need to backup this dir
		if (($doBackup{$path} & ST_FILE_CHANGED) == ST_FILE_CHANGED) {
Nigel Kukard's avatar
Nigel Kukard committed
730
			printLog(LOG_INFO,"B: Path '[$source]/$path' backing up\n");
Nigel Kukard's avatar
Nigel Kukard committed
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765

			# If we not backing up a system dir, we create a manifest and backup the files
			if (($doBackup{$path} & ST_DIR_SYS) != ST_DIR_SYS) {
				# Did file contents change?
				my $changedFiles = 0;
				my $changedAttrs = 0;
				my @newFiles = ();
				my @manifestList;

				# Take a look quick...
				foreach my $item (sort keys %{$curFileList}) {
					# Lets see whats happened...
					if (($curFileList->{$item}->{'_state'} & ST_FILE_NEW) == ST_FILE_NEW) {
						push(@newFiles,$item);
					}
					if (($curFileList->{$item}->{'_state'} & ST_FILE_CHANGED) == ST_FILE_CHANGED) {
						$changedFiles = 1;
					}
					if (($curFileList->{$item}->{'_state'} & ST_FILE_ATTR_CHANGED) == ST_FILE_ATTR_CHANGED) {
						$changedAttrs = 1;
					}
				}

				# If we don't have a sequence, this is a new backup?
				if (!defined($newPathAttribs{$path}->{'sequence'} = $origPathAttribs{$path}->{'sequence'})) {
					$newPathAttribs{$path}->{'sequence'} = 0;
					@manifestList = keys %{$curFileList};
				} else {
					# If this is new files, then just inc the counter
					if (@newFiles > 0 && !$changedFiles && !$changedAttrs) {
						$newPathAttribs{$path}->{'sequence'}++;
						@manifestList = @newFiles;
					# If files changed we blow everything away
					} else {
						$newPathAttribs{$path}->{'sequence'} = 0;
Nigel Kukard's avatar
Nigel Kukard committed
766
						# Remove old files
Nigel Kukard's avatar
Nigel Kukard committed
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
						removeBackups(
								"$dest/$path",
								$origPathAttribs{$path}->{'format'},
								$origPathAttribs{$path}->{'compression'},
								$origPathAttribs{$path}->{'sequence'}
						);
						@manifestList = keys %{$curFileList};
					}
				}


				# Get current sequence
				my $seq = $newPathAttribs{$path}->{'sequence'};

				# Setup tar args
				my @tarArgs = ();
				my $tarExt;
784
				if ($config{'compress'} eq "xz") {
Nigel Kukard's avatar
Nigel Kukard committed
785
786
					push(@tarArgs,"--xz");
					$tarExt = ".xz";
787
				} elsif ($config{'compress'} eq "bzip2") {
Nigel Kukard's avatar
Nigel Kukard committed
788
789
					push(@tarArgs,"--bzip2");
					$tarExt = ".bz2";
790
				} elsif ($config{'compress'} eq "gzip") {
Nigel Kukard's avatar
Nigel Kukard committed
791
792
					push(@tarArgs,"--gzip");
					$tarExt = ".gz";
793
				} elsif ($config{'compress'} eq "none") {
Nigel Kukard's avatar
Nigel Kukard committed
794
795
796
797
798
					$tarExt = "";
				}

				# Save format and compression
				$newPathAttribs{$path}->{'format'} = "tar";
799
				$newPathAttribs{$path}->{'compression'} = $config{'compress'};
Nigel Kukard's avatar
Nigel Kukard committed
800

801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
				# Sort out manifest format
				my $manifestDelim;
				# Are we overriding the manifest format?
				if (defined($config{'manifest-format'})) {
					$newPathAttribs{$path}->{'manifest.format'} = $config{'manifest-format'};
				} else {
					# If not choose best
					if (defined($origPathAttribs{$path}->{'manifest.format'})) {
						$newPathAttribs{$path}->{'manifest.format'} = $origPathAttribs{$path}->{'manifest.format'};
					} else {
						# Tar pre-1.22 is buggered with \0 manifest files
						if ($tarVer > 122) {
							$newPathAttribs{$path}->{'manifest.format'} = "null";
						} else {
							$newPathAttribs{$path}->{'manifest.format'} = "newline";
Nigel Kukard's avatar
Nigel Kukard committed
816
						}
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
					}
				}

				# Setup manifest delim & tar options
				if ($newPathAttribs{$path}->{'manifest.format'} eq "null") {
					push(@tarArgs,"--null");
					push(@tarArgs,"--files-from", "$dest/$path/dbackup$seq.manifest");
					push(@tarArgs,"--no-unquote");
					$manifestDelim = "\0";
				} elsif ($newPathAttribs{$path}->{'manifest.format'} eq "newline") {
					push(@tarArgs,"--files-from", "$dest/$path/dbackup$seq.manifest");
					$manifestDelim = "\n";
				} else {
					printLog(LOG_ERROR,"Invalid manifest.format '".$newPathAttribs{$path}->{'manifest.format'}."'\n");
					exit 1;
				}

				# File list to backup
				open(MANIFEST,"> $dest/$path/dbackup$seq.manifest")
Nigel Kukard's avatar
Nigel Kukard committed
836
						or die "Failed to open '[$dest]/($path)/dbackup$seq.manifest': $!";
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
				foreach my $item (@manifestList) {
					# Sanity check to see if this filename is going to work
					if ($manifestDelim eq "\n" && $item =~ /[\n"'\\]/) {
						printLog(LOG_ERROR,"ERROR: Your version of tar cannot backup => path:'$path', file '$item'\n");
						next;
					}
					# If this is not the top dir, use /
					if ($path ne "") {
						print(MANIFEST "$path/$item$manifestDelim");
					# If it is, don't use /
					} else {
						print(MANIFEST "$item$manifestDelim");
					}
				}
				close(MANIFEST);

853
854
855
856
857
858
859
860
861
862
863
864
				# tar specifics...
				if ($newPathAttribs{$path}->{'format'} eq "tar") {
					# Exclude paths for tar-ignore-failed-read
					foreach my $item (@{$config{'tar-ignore-failed-read'}}) {
						# Check...
						if ("/$path" eq $item) {
							printLog(LOG_NOTICE,"B: Path '[$source]/$path' ignore-failed-read passed to tar\n");
							push(@tarArgs,"--ignore-failed-read",$path);
						}
					}
				}

Nigel Kukard's avatar
Nigel Kukard committed
865
866
				# Change dir and start backup
				system(
Nigel Kukard's avatar
Nigel Kukard committed
867
					"tar",
Nigel Kukard's avatar
Nigel Kukard committed
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
					"--create",
					"--verbose",
					# Output file
					"--file", "$dest/$path/dbackup$seq.tar$tarExt",
					# cd into here first...
					"--directory", "$source",
					# Do not recurse
					"--no-recursion",
					# Output to this file
					"--index-file", "$dest/$path/dbackup$seq.index",
					# Incremental options
#					"--listed-incremental", "$dest/$path/dbackup.snar",
#					"--no-check-device",
					@tarArgs
				);
				if ($? == -1) {
Nigel Kukard's avatar
Nigel Kukard committed
884
					printLog(LOG_ERROR,"Failed to execute: $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
885
886
					exit 1;
				} elsif ($? & 127) {
Nigel Kukard's avatar
Nigel Kukard committed
887
					printLog(LOG_ERROR,"Child died with signal ".($? & 127)."\n");
Nigel Kukard's avatar
Nigel Kukard committed
888
889
890
891
					exit 1;
				} else {
					my $retcode = $? >> 8;
					# If tar died, lets die too
892
					if ($retcode >= 2) {
Nigel Kukard's avatar
Nigel Kukard committed
893
						printLog(LOG_ERROR,"tar died with error code $retcode\n");
Nigel Kukard's avatar
Nigel Kukard committed
894
#						exit 1;
Nigel Kukard's avatar
Nigel Kukard committed
895
896
897
898
					}
				}
			# if (($doBackup{$path} & ST_DIR_SYS) != ST_DIR_SYS) {
			} else {
Nigel Kukard's avatar
Nigel Kukard committed
899
					# Remove old files
Nigel Kukard's avatar
Nigel Kukard committed
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
					removeBackups(
							"$dest/$path",
							$origPathAttribs{$path}->{'format'},
							$origPathAttribs{$path}->{'compression'},
							$origPathAttribs{$path}->{'sequence'}
					);
			}
		} # if (($doBackup{$path} & ST_FILE_CHANGED) == ST_FILE_CHANGED) {


		# Check if we need to record directory changes...
		if (
					($doBackup{$path} & ST_FILE_CHANGED) == ST_FILE_CHANGED ||
					($doBackup{$path} & ST_DIR_CHANGED) == ST_DIR_CHANGED ||
					($doBackup{$path} & ST_DIR_NEW) == ST_DIR_NEW
		) {
			# If we have a revision, bump it
			if (defined($newPathAttribs{$path}->{'revision'} = $origPathAttribs{$path}->{'revision'})) {
				$newPathAttribs{$path}->{'revision'} = $origPathAttribs{$path}->{'revision'} + 1;
			} else {
				$newPathAttribs{$path}->{'revision'} = 0;
			}

Nigel Kukard's avatar
Nigel Kukard committed
923
924
925
926
			# Set this as the dbackup that created this file
			$newPathAttribs{$path}->{'dbackup.version'} = $VERSION;

			printLog(LOG_DEBUG,"B: Writing state '[$source]/($path)' - revision ".$newPathAttribs{$path}->{'revision'}."\n");
Nigel Kukard's avatar
Nigel Kukard committed
927
928
929

			# Write out state, we do this AFTER we have backed up, so if we stopped, we can just  continue
			my $gz = gzopen("$dest/$path/.dbackup-state","wb")
Nigel Kukard's avatar
Nigel Kukard committed
930
					or die "Failed to open '[$dest]/($path)/.dbackup-state': $!";
Nigel Kukard's avatar
Nigel Kukard committed
931
932
933
934
935
			# Loop with attributes
			foreach my $item (keys %{$newPathAttribs{$path}}) {
				$gz->gzwrite(join("\0",
						"a",
						$item,
Nigel Kukard's avatar
Nigel Kukard committed
936
						$newPathAttribs{$path}->{$item}
Nigel Kukard's avatar
Nigel Kukard committed
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
					)."\n"
				);
			}
			# Loop with directory list
			foreach my $item (sort keys %{$curDirList}) {
				my $ename = encode_base64($item);
				$ename =~ s/\n//g;
				# Save state of source files
				$gz->gzwrite(join("\0",
						"d",
						$ename,
						$curDirList->{$item}->{'ctime'},
						$curDirList->{$item}->{'atime'},
						$curDirList->{$item}->{'mtime'},
						$curDirList->{$item}->{'uid'},
						$curDirList->{$item}->{'gid'},
						$curDirList->{$item}->{'mode'}
					)."\n"
				);
			}
			# Loop with file list
			foreach my $item (sort keys %{$curFileList}) {
				my $ename = encode_base64($item);
				$ename =~ s/\n//g;
				# Save state of source files
				$gz->gzwrite(join("\0",
						"f",
						$ename,
						$curFileList->{$item}->{'size'},
						$curFileList->{$item}->{'ctime'},
						$curFileList->{$item}->{'atime'},
						$curFileList->{$item}->{'mtime'},
						$curFileList->{$item}->{'uid'},
						$curFileList->{$item}->{'gid'},
						$curFileList->{$item}->{'mode'}
					)."\n"
				);
			}
			# Finally close
			$gz->gzclose();
		}

		# State clear
		delete($origFileList{$path});
	}

Nigel Kukard's avatar
Nigel Kukard committed
983
984
	printLog(LOG_NOTICE,"BACKUP START: $source => $dest\n");
	printLog(LOG_INFO,"Compression: ".$config{'compress'}."\n");
985

Nigel Kukard's avatar
Nigel Kukard committed
986
	# Check if we excluding system files
987
	if ($config{'exclude-system'}) {
Nigel Kukard's avatar
Nigel Kukard committed
988
989
		printLog(LOG_NOTICE,"Exclude System Base: ".join(", ",@{$config{'system-base'}})."\n");
		printLog(LOG_NOTICE,"Exclude System Dirs: ".join(", ",@defaultSystemExcl,@{$config{'system-dir'}})."\n");
Nigel Kukard's avatar
Nigel Kukard committed
990
		# If we excluding data too...
991
		if ($config{'exclude-data'}) {
Nigel Kukard's avatar
Nigel Kukard committed
992
			printLog(LOG_NOTICE,"Exclude Data Dirs: ".join(", ",@defaultDataExcl,@{$config{'data-dir'}})."\n");
Nigel Kukard's avatar
Nigel Kukard committed
993
994
		}
	}
995
	printLog(LOG_NOTICE,"Exclude Paths: ".join(", ",@{$config{'exclude-path'}})."\n");
Nigel Kukard's avatar
Nigel Kukard committed
996
	printLog(LOG_NOTICE,"Exclude Files: ".join(", ",@{$config{'exclude-file'}})."\n");
Nigel Kukard's avatar
Nigel Kukard committed
997
998
999
1000
1001
1002

	# We need an entry for our main dir before we start
	$doBackup{""} = 0;

	# This basically does our backup for us...
	find (
Nigel Kukard's avatar
Nigel Kukard committed
1003
		{
Nigel Kukard's avatar
Nigel Kukard committed
1004
1005
1006
1007
1008
1009
1010
1011
			preprocess => \&backup_preprocess,
			wanted => \&backup_process,
			postprocess => \&backup_postprocess
		},
		$source
	);


Nigel Kukard's avatar
Nigel Kukard committed
1012
	printLog(LOG_INFO,"Processing stale directories...\n");
Nigel Kukard's avatar
Nigel Kukard committed
1013
1014
1015
	my @rmlist;
	# Total item by item
	find (
Nigel Kukard's avatar
Nigel Kukard committed
1016
		{
Nigel Kukard's avatar
Nigel Kukard committed
1017
1018
1019
1020
1021
1022
1023
			wanted => sub { },
			# We just need post processing ...
			postprocess => sub {
				# Strip first part of the path
				(my $path = $File::Find::dir) =~ s#^$dest/?##;
				# Does this dir exist on the backup, but not on the fileserver?
				if (!defined($srcFileList{$path})) {
Nigel Kukard's avatar
Nigel Kukard committed
1024
					push(@rmlist,$path);
Nigel Kukard's avatar
Nigel Kukard committed
1025
1026
1027
1028
1029
1030
				}
			},
		},
		$dest
	);
	foreach my $rmitem ( @rmlist ) {
Nigel Kukard's avatar
Nigel Kukard committed
1031
		printLog(LOG_DEBUG,"Remove path '[$dest]/($rmitem)'\n");
Nigel Kukard's avatar
Nigel Kukard committed
1032
   		rmtree("$dest/$rmitem");
Nigel Kukard's avatar
Nigel Kukard committed
1033
1034
	}

Nigel Kukard's avatar
Nigel Kukard committed
1035
	printLog(LOG_NOTICE,"BACKUP END\n");
Nigel Kukard's avatar
Nigel Kukard committed
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
}


# Do backup
if (defined($optctl{'backup'})) {
	backup($sourceDir,$destDir);

} elsif (defined($optctl{'restore'})) {
	restore($sourceDir,$destDir);

} else {
	print(STDERR "ERROR: No command given\n\n");
	displayHelp();
	exit 1;
}


# Restore function
sub restore
{
	our ($source,$dest) = @_;

	# State infor for current dir
	our %origFileList;
	our %origDirList;
	our %origPathAttribs;


	# Preprocess dir
	sub restore_preprocess {
		my @list = @_;

		# Strip first part of the path
		(my $path = $File::Find::dir) =~ s#^$source/?##;

		# Check if we have all our source files
		if ( ! -f "$source/$path/.dbackup-state" ) {
Nigel Kukard's avatar
Nigel Kukard committed
1073
			printLog(LOG_WARNING,"S: Path '[$source]/($path)' is MISSING .dbackup-state\n");
Nigel Kukard's avatar
Nigel Kukard committed
1074
1075
1076
1077
1078
1079
1080
1081
			return @list;
		}

		# Load state file
		loadStateFile("$source/$path/.dbackup-state",$path,\%origFileList,\%origDirList,\%origPathAttribs);

		# Check we have at least the version attribute
		if (!defined($origPathAttribs{$path}) || !defined($origPathAttribs{$path}->{'dbackup.version'})) {
Nigel Kukard's avatar
Nigel Kukard committed
1082
			printLog(LOG_ERROR, "No dbackup version information found in '[$source]/($path)/.dbackup-state', IGNORING\n");
Nigel Kukard's avatar
Nigel Kukard committed
1083
1084
1085
1086
1087
1088
1089
1090
			delete($origDirList{$path});
			delete($origFileList{$path});
			return @list;
		}

		# During our check, we need to create the dir, we may not have a backup file
		# so we do it here.
		if ( ! -d "$dest/$path") {
Nigel Kukard's avatar
Nigel Kukard committed
1091
			printLog(LOG_INFO,"R: Path '[$dest]/($path)' creating directory\n");
Nigel Kukard's avatar
Nigel Kukard committed
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
			mkpath("$dest/$path");
		}

		# The lack of a sequence number probably means we didn't output any tar files during backup
		if (!defined($origPathAttribs{$path}->{'sequence'})) {
			return @list;
		}

		# Loop through backup sequences
		for (my $seq = 0; $seq <= $origPathAttribs{$path}->{'sequence'}; $seq++) {
Nigel Kukard's avatar
Nigel Kukard committed
1102
			printLog(LOG_DEBUG,"R: Path '[$dest]/($path)' restoring data ".($seq+1)." of ".
Nigel Kukard's avatar
Nigel Kukard committed
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
					($origPathAttribs{$path}->{'sequence'}+1)."\n");

			# Args for tar
			my @tarArgs = ();

			my $tarExt;
			if ($origPathAttribs{$path}->{'compression'} eq "xz") {
				push(@tarArgs,"--xz");
				$tarExt = ".xz";
			} elsif ($origPathAttribs{$path}->{'compression'} eq "bzip2") {
				push(@tarArgs,"--bzip2");
				$tarExt = ".bz2";
			} elsif ($origPathAttribs{$path}->{'compression'} eq "gzip") {
				push(@tarArgs,"--gzip");
				$tarExt = ".gz";
			} elsif ($origPathAttribs{$path}->{'compression'} eq "none") {
				$tarExt = "";
			}

			# Check what type of backup we did
			if ( ! -f "$source/$path/dbackup$seq.tar$tarExt" ) {
				# If we have any other part of the backup, show a message
				if (
Nigel Kukard's avatar
Nigel Kukard committed
1126
							( -f "$source/$path/dbackup$seq.index" ||
Nigel Kukard's avatar
Nigel Kukard committed
1127
1128
1129
							-f "$source/$path/dbackup$seq.manifest" ||
							-f "$source/$path/dbackup$seq.snar" ) && $seq > 0
				) {
Nigel Kukard's avatar
Nigel Kukard committed
1130
					printLog(LOG_WARNING,"Backup file '[$source]/($path)/dbackup$seq.tar$tarExt' not found, IGNORING\n");
Nigel Kukard's avatar
Nigel Kukard committed
1131
1132
1133
1134
1135
1136
1137
				}

				return @list;
			}

			# Check we have files we need/created
			if ( ! -f "$source/$path/dbackup$seq.index" ) {
Nigel Kukard's avatar
Nigel Kukard committed
1138
				printLog(LOG_WARNING,"Manifest file '[$source]/($path)/dbackup$seq.index' not found\n");
Nigel Kukard's avatar
Nigel Kukard committed
1139
1140
1141
				return @list;
			}
			if ( ! -f "$source/$path/dbackup$seq.manifest" ) {
Nigel Kukard's avatar
Nigel Kukard committed
1142
				printLog(LOG_WARNING,"Manifest file '[$source]/($path)/dbackup$seq.manifest' not found\n");
Nigel Kukard's avatar
Nigel Kukard committed
1143
1144
1145
				return @list;
			}

Nigel Kukard's avatar
Nigel Kukard committed
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
			# Check if manifest.format is undefined, if it is, use the default
			if (!defined($origPathAttribs{$path}->{'manifest.format'})) {
				# Check if we have a commandline override
				if (defined($optctl{'manifest-format'})) {
					$origPathAttribs{$path}->{'manifest.format'} = $optctl{'manifest-format'};
				} else {
					# NK:
					# Default to null
					# This saves us from having to regenerate manifest.format attrs and backups for older
					# versions of dbackup.
					$origPathAttribs{$path}->{'manifest.format'} = "null";
				}
			}

1160
1161
1162
1163
1164
1165
1166
1167
			# Setup manifest delim & tar options
			if ($origPathAttribs{$path}->{'manifest.format'} eq "null") {
				push(@tarArgs,"--null");
				push(@tarArgs,"--files-from", "$source/$path/dbackup$seq.manifest");
				push(@tarArgs,"--no-unquote");
			} elsif ($origPathAttribs{$path}->{'manifest.format'} eq "newline") {
				push(@tarArgs,"--files-from", "$source/$path/dbackup$seq.manifest");
			} else {
Nigel Kukard's avatar
Nigel Kukard committed
1168
1169
				printLog(LOG_ERROR,"Invalid manifest.format '".$origPathAttribs{$path}->{'manifest.format'}.
						"' for '[$source]/($path)', try setting the default with --manifest-format=\n");
1170
1171
1172
1173
1174
1175
1176
1177
1178
				exit 1;
			}

			# Sanity check
			if ($tarVer < 122 && $origPathAttribs{$path}->{'manifest.format'} eq "null") {
				printLog(LOG_ERROR,"Your version of tar does NOT support manifest.format of 'null'\n");
				exit 1;
			}

Nigel Kukard's avatar
Nigel Kukard committed
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
			# Other tar options
			if (defined($optctl{'tar-keep-newer'})) {
				push(@tarArgs,"--keep-newer-files");
			}
			if (defined($optctl{'tar-keep-old-files'})) {
				push(@tarArgs,"--keep-old-files");
			}

			# Change dir and start backup
			system(
Nigel Kukard's avatar
Nigel Kukard committed
1189
				"tar",
Nigel Kukard's avatar
Nigel Kukard committed
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
				"--extract",
				# Output file
				"--file", "$source/$path/dbackup$seq.tar$tarExt",
				# cd into here first...
				"--directory", "$dest",
				# Do not recurse
				"--no-recursion",
				# Incremental options
#			"--incremental",
				@tarArgs
			);
			if ($? == -1) {
Nigel Kukard's avatar
Nigel Kukard committed
1202
				printLog(LOG_ERROR,"Failed to execute: $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1203
1204
				exit 1;
			} elsif ($? & 127) {
Nigel Kukard's avatar
Nigel Kukard committed
1205
				printLog(LOG_ERROR,"Child died with signal ".($? & 127)."\n");
Nigel Kukard's avatar
Nigel Kukard committed
1206
1207
1208
1209
				exit 1;
			} else {
				my $retcode = $? >> 8;
				# If tar died, lets die too
1210
				if ($retcode >= 2) {
Nigel Kukard's avatar
Nigel Kukard committed
1211
					printLog(LOG_ERROR,"tar died with error code $retcode\n");
Nigel Kukard's avatar
Nigel Kukard committed
1212
#					exit 1;
Nigel Kukard's avatar
Nigel Kukard committed
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
				}
			}
		}

		return @list;
	}

	# Process files
	sub restore_process {
		my $name = $File::Find::name;
		# Strip first part of the path
		(my $path = $File::Find::dir) =~ s#^$source/?##;

		# Store current filename
		my $item = $_;

#		print(STDERR "PROCESS: Path = $path, Name = $name, Item = $item)\n");
	}


	# Time to do stuff
	sub restore_postprocess {
		# Strip first part of the path
		(my $path = $File::Find::dir) =~ s#^$source/?##;

Nigel Kukard's avatar
Nigel Kukard committed
1238
		printLog(LOG_DEBUG,"R: Path '[$dest]/($path)' restoring meta-data\n");
Nigel Kukard's avatar
Nigel Kukard committed
1239
1240
1241
1242
1243
1244
1245
1246
1247

		# Loop with directories in this path
		foreach my $dname (keys %{$origDirList{$path}}) {
			# Set dir
			my $dir = $origDirList{$path}->{$dname};

			# Full dirname
			my $fdirname = "$dest/$path/$dname";

Nigel Kukard's avatar
Nigel Kukard committed
1248
1249
1250
1251
1252
1253
			# Could be a dir with no contents of one which was ignored, in which case we must create it
			if (! -d $fdirname) {
				printLog(LOG_INFO,"R: Path '[$dest]/($path)/$dname' creating missing directory\n");
				mkpath($fdirname);
			}

Nigel Kukard's avatar
Nigel Kukard committed
1254
1255
			# Restore attribs
			if (!chown($dir->{'uid'},$dir->{'gid'},$fdirname)) {
Nigel Kukard's avatar
Nigel Kukard committed
1256
				printLog(LOG_ERROR,"Failed to chown(".$dir->{'uid'}.",".$dir->{'gid'}.") '$fdirname': $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1257
1258
			}
			if (!chmod($dir->{'mode'},$fdirname)) {
Nigel Kukard's avatar
Nigel Kukard committed
1259
				printLog(LOG_ERROR,"Failed to chmod(".$dir->{'mode'}.") '$fdirname': $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1260
1261
			}
			if (!utime($dir->{'atime'},$dir->{'mtime'},$fdirname)) {
Nigel Kukard's avatar
Nigel Kukard committed
1262
				printLog(LOG_ERROR,"Failed to utime(".$dir->{'atime'}.",".$dir->{'mtime'}.") '$fdirname': $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
			}
		}

		# Loop with files in this path
		foreach my $fname (keys %{$origFileList{$path}}) {
			# Set dir
			my $file = $origFileList{$path}->{$fname};

			# Full dirname
			my $ffilename = "$dest/$path/$fname";

1274
1275
1276
			# Restore for links and files
			if (!lchown($file->{'uid'},$file->{'gid'},$ffilename)) {
				printLog(LOG_ERROR,"Failed to lchown(".$file->{'uid'}.",".$file->{'gid'}.") '$ffilename': $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1277
			}
1278
1279
1280
1281
1282

			# Ignore links for the rest...
			next if (S_ISLNK($file->{'mode'}));

			# Restore mode & utime only for files
Nigel Kukard's avatar
Nigel Kukard committed
1283
			if (!chmod($file->{'mode'},$ffilename)) {
Nigel Kukard's avatar
Nigel Kukard committed
1284
				printLog(LOG_ERROR,"Failed to chmod(".$file->{'mode'}.") '$ffilename': $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1285
1286
			}
			if (!utime($file->{'atime'},$file->{'mtime'},$ffilename)) {
Nigel Kukard's avatar
Nigel Kukard committed
1287
				printLog(LOG_ERROR,"Failed to utime(".$file->{'atime'}.",".$file->{'mtime'}.") '$ffilename': $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
1288
1289
1290
1291
			}
		}
	}

Nigel Kukard's avatar
Nigel Kukard committed
1292
	printLog(LOG_NOTICE,"RESTORE START: $source => $dest\n");
Nigel Kukard's avatar
Nigel Kukard committed
1293
1294
1295

	# This basically does our backup for us...
	find (
Nigel Kukard's avatar
Nigel Kukard committed
1296
		{
Nigel Kukard's avatar
Nigel Kukard committed
1297
1298
1299
1300
1301
1302
1303
			preprocess => \&restore_preprocess,
			wanted => \&restore_process,
			postprocess => \&restore_postprocess
		},
		$source
	);

Nigel Kukard's avatar
Nigel Kukard committed
1304
	printLog(LOG_NOTICE,"RESTORE END\n");
Nigel Kukard's avatar
Nigel Kukard committed
1305
1306
1307
1308
1309
}


# Display log line
sub printLog {
Nigel Kukard's avatar
Nigel Kukard committed
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
	my ($level,$msg,@args) = @_;


	# Work out level txt all nicely
	my $levelTxt = "UNKNOWN";
	if ($level == LOG_DEBUG) {
		$levelTxt = "DEBUG";
	} elsif ($level == LOG_INFO) {
		$levelTxt = "INFO";
	} elsif ($level == LOG_NOTICE) {
		$levelTxt = "NOTICE";
	} elsif ($level == LOG_WARNING) {
		$levelTxt = "WARNING";
1323
1324
	} elsif ($level == LOG_ERROR) {
		$levelTxt = "ERROR";
Nigel Kukard's avatar
Nigel Kukard committed
1325
	}
Nigel Kukard's avatar
Nigel Kukard committed
1326

Nigel Kukard's avatar
Nigel Kukard committed
1327
	# Check log level
Nigel Kukard's avatar
Nigel Kukard committed
1328
	if ($level <= $config{'log-level'}) {
Nigel Kukard's avatar
Nigel Kukard committed
1329
1330
		printf(STDERR "%s/$levelTxt: %s", strftime('%F %T',localtime()), $msg, @args);
	}
Nigel Kukard's avatar
Nigel Kukard committed
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
}



# Display usage
sub displayHelp {
	# Build some strings we need
	my $systemDirStr = join (", ",@defaultSystemExcl);
	my $dataDirStr = join (", ",@defaultDataExcl);

	print(STDERR<<EOF);
Usage: $0 [args] <src> <dst>

    General Options:
      --help                             What you seeing now.
Nigel Kukard's avatar
Nigel Kukard committed
1346
      --config=file                      Config file to use.
Nigel Kukard's avatar
Nigel Kukard committed
1347
1348
      --log-level                        5 = debug, 4 = info, 3 = notice
                                         2 = warning, 1 = error
1349
      --tar                              Path to tar binary.
Nigel Kukard's avatar
Nigel Kukard committed
1350
1351

    Backing Options:
Nigel Kukard's avatar
Nigel Kukard committed
1352
      --backup                           Backup src to dst.
Nigel Kukard's avatar
Nigel Kukard committed
1353
      --backup-upgrade                   Upgrade backup to new dbackup ver.
1354
      --compress=<xz|bz2|gzip|none>      Compression method to use defaults
Nigel Kukard's avatar
Nigel Kukard committed
1355
1356
                                         to using xz, or bzip2 if xz unavail.

1357
1358
1359
1360
1361
      --exclude-data                     Exclude all data dirs listed below.
      --exclude-system                   Exclude system dirs listed below.

      --exclude-path=pcre                PCRE to exclude paths from backup.
      --exclude-file=pcre                PCRE to exclude files from backup.
Nigel Kukard's avatar
Nigel Kukard committed
1362

1363
      --exclude-fs-type=fstype           Filesystem type to exclude.
1364
1365

      --data-dir=dir                     Add an additional data directory.
Nigel Kukard's avatar
Nigel Kukard committed
1366
      --system-dir=dir                   Add an additional system directory.
1367
1368
      --system-base=path                 Add a system base. This defaults to /
                                         and this option will override that.
1369

1370
1371
1372
1373
      --tar-ignore-failed-read=path      This is passed to tar only. It will
                                         not cause errors of files that cannot
                                         be read for the path matched.

Nigel Kukard's avatar
Nigel Kukard committed
1374
    Restore Options:
1375
      --restore                          Restore src to dst.
Nigel Kukard's avatar
Nigel Kukard committed
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
      --tar-keep-newer                   Do not overwrite newer files.
      --tar-keep-old-files               Don't replace existing files.


Builtins:
---------
    system-dirs:
      $systemDirStr

    data-dirs:
      $dataDirStr
EOF
Nigel Kukard's avatar
Nigel Kukard committed
1388
}
Nigel Kukard's avatar
Nigel Kukard committed
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400


#
# LIBRARY
#

sub loadStateFile {
		my ($statefile,$key,$fileList,$dirList,$pathAttribs) = @_;


		# Read in backup state file, we do it here because we may not have a backup file
		# to restore
Nigel Kukard's avatar
Nigel Kukard committed
1401
		my $gz = gzopen($statefile,"rb")
Nigel Kukard's avatar
Nigel Kukard committed
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
				or die "FATAL ERROR: Failed to open '$statefile': $!";
		# Read in file list
		my $line;
		while ($gz->gzreadline($line) > 0) {
			chomp($line);
			# Pull out array of items
			my @aline = split(/\0/,$line);
			my $type = shift(@aline);
			# Check if its defined
			if (defined($type)) {
				# If its a file...
				if ($type eq "f") {
					my ($ename,$size,$ctime,$atime,$mtime,$uid,$gid,$mode) = @aline;
					my $name = decode_base64($ename);
					# Setup our hash
					$fileList->{$key}->{$name}->{'size'} = $size;
					$fileList->{$key}->{$name}->{'ctime'} = $ctime;
					$fileList->{$key}->{$name}->{'atime'} = $atime;
					$fileList->{$key}->{$name}->{'mtime'} = $mtime;
					$fileList->{$key}->{$name}->{'uid'} = $uid;
					$fileList->{$key}->{$name}->{'gid'} = $gid;
					$fileList->{$key}->{$name}->{'mode'} = $mode;
				# If its a dir
				} elsif ($type eq "d") {
					my ($ename,$ctime,$atime,$mtime,$uid,$gid,$mode) = @aline;
					my $name = decode_base64($ename);
					# Setup our hash
					$dirList->{$key}->{$name}->{'ctime'} = $ctime;
					$dirList->{$key}->{$name}->{'atime'} = $atime;
					$dirList->{$key}->{$name}->{'mtime'} = $mtime;
					$dirList->{$key}->{$name}->{'uid'} = $uid;
					$dirList->{$key}->{$name}->{'gid'} = $gid;
					$dirList->{$key}->{$name}->{'mode'} = $mode;
				# Attribute
				} elsif ($type eq "a") {
					my ($name,$value) = @aline;
					$pathAttribs->{$key}->{$name} = $value;
				# Unknown
				} else {
					print(STDERR "ERROR: Invalid type '$type' in '$statefile'\n");
					exit 1;
				}
			}
		}
		# Close gzip file
		$gz->gzclose();
}


1451
# Remove backup and its sequences
Nigel Kukard's avatar
Nigel Kukard committed
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
sub removeBackups
{
	my ($path,$format,$compression,$seqs) = @_;


	# Loop through backup sequences
	for (my $i = 0; $i <= $seqs; $i++) {

		my $tarExt;
		if ($compression eq "xz") {
			$tarExt = ".xz";
		} elsif ($compression eq "bzip2") {
			$tarExt = ".bz2";
		} elsif ($compression eq "gzip") {
			$tarExt = ".gz";
		} elsif ($compression eq "none") {
			$tarExt = "";
		}

		# Unlink backup files
		if (-f "$path/dbackup$i.tar$tarExt") {
			unlink("$path/dbackup$i.tar$tarExt")
					or die "ERROR: Failed to remove file '$path/dbackup$i.tar$tarExt': $!";
		}
		# Unlink manifest
		if (-f "$path/dbackup$i.manifest") {
			unlink("$path/dbackup$i.manifest")
					or die "ERROR: Failed to remove file '$path