dbackup 43.3 KB
Newer Older
Nigel Kukard's avatar
Nigel Kukard committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/usr/bin/perl -w
# Copyright (c) 2010-2012, AllWorldIT
# 
# 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.
# 
# 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.
# 
# 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.19b";
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
98
# Main config
my %config = (
		'log-level' => LOG_NOTICE,
99
		'tar' => 'tar',
100
		'exclude-system' => 0,
Nigel Kukard's avatar
Nigel Kukard committed
101
		'backup-upgrade' => 0,
102
103
104
105
106
107
108
109
110
111
112
113
);
# 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
114
115
116
117
118
119
120
121
122

print(STDERR "DBackup v$VERSION, Copyright (c) 2010-2012, AllWorldIT\n\n");


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

123
	"config=s",
Nigel Kukard's avatar
Nigel Kukard committed
124
	"log-level=i",
125
	"tar=s",
Nigel Kukard's avatar
Nigel Kukard committed
126
	"manifest-format=s",
127

Nigel Kukard's avatar
Nigel Kukard committed
128
	"backup",
Nigel Kukard's avatar
Nigel Kukard committed
129
	"backup-upgrade",
Nigel Kukard's avatar
Nigel Kukard committed
130
131
	"compress:s",
	"exclude-system",
132
133
	"system-base=s@",
	"system-dir=s@",
Nigel Kukard's avatar
Nigel Kukard committed
134

135
136
	"tar-ignore-failed-read=s@",

Nigel Kukard's avatar
Nigel Kukard committed
137
	"exclude-data",
138
	"data-dir=s@",
139
	
140
141
	"exclude-file=s@",
	"exclude-path=s@",
Nigel Kukard's avatar
Nigel Kukard committed
142

143
144
	"exclude-fs-type=s@",

Nigel Kukard's avatar
Nigel Kukard committed
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
	"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;
}

# 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;
}

180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# Check config file exists
if (defined($optctl{'config'})) {
	if (! -f $optctl{'config'}) {
		print(STDERR "ERROR: Configuration file '".$optctl{'config'}."' NOT found!\n");
		exit 1;
	}

	# 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};
		}
	}
}


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

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

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

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

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

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

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


#
# Check commandline options
#
257

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

Nigel Kukard's avatar
Nigel Kukard committed
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
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"
	) {	
		print(STDERR "ERROR: Compression is invalid, valid values are: xz bzip2 gzip none\n\n");
		displayHelp();
		exit 1;
	}
279
	$config{'compress'} = $optctl{'compress'};
Nigel Kukard's avatar
Nigel Kukard committed
280
281
}

282
283
284
285
286
287
288
289
290
291
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'});

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

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

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

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

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

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

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

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

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

336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
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
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
# 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
390
			printLog(LOG_INFO,"S: Path '[$source]/($path)' EXCLUDED from backup with .nodbackup\n");
Nigel Kukard's avatar
Nigel Kukard committed
391
392
393
394
			return ();
		}
		# Exclude trash folders
		if ( "$source/$path" =~ /(\.Trash-[0-9]{4})$/) {
Nigel Kukard's avatar
Nigel Kukard committed
395
			printLog(LOG_INFO,"S: Path '[$source]/($path)' EXCLUDED from backup, Linux trash folder\n");
Nigel Kukard's avatar
Nigel Kukard committed
396
397
398
399
400
401
402
403
404
405
			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
406
		if ($config{'exclude-system'}) {
Nigel Kukard's avatar
Nigel Kukard committed
407
			# Loop through system dirs
408
			foreach my $sysdir (@{$config{'system-base'}}) {
Nigel Kukard's avatar
Nigel Kukard committed
409
				# Loop with system paths
410
				foreach my $excl (@defaultSystemExcl,@{$config{'system-dir'}}) {
Nigel Kukard's avatar
Nigel Kukard committed
411
					# Sanitize path
412
					my $testPath = File::Spec->rel2abs("$sysdir/$excl");
Nigel Kukard's avatar
Nigel Kukard committed
413
					# Check...
414
					if ("/$path" eq $testPath) {
Nigel Kukard's avatar
Nigel Kukard committed
415
						printLog(LOG_INFO,"S: Path '[$source]/($path)' is a system directory, ignoring files\n");
Nigel Kukard's avatar
Nigel Kukard committed
416
417
418
419
420
						$doBackup{$path} |= ST_DIR_SYS;
						return ();
					}
				}
				# Check if we excluding data dirs
421
				if (defined($config{'exclude-data'})) {
Nigel Kukard's avatar
Nigel Kukard committed
422
					# Loop with data dirs
423
					foreach my $excl (@defaultDataExcl,@{$config{'data-dir'}}) {
Nigel Kukard's avatar
Nigel Kukard committed
424
						# Sanitize path
425
						my $testPath = File::Spec->rel2abs("$sysdir/$excl");
Nigel Kukard's avatar
Nigel Kukard committed
426
						# Check...
427
						if ("/$path" eq $testPath) {
Nigel Kukard's avatar
Nigel Kukard committed
428
							printLog(LOG_INFO,"S: Path '[$source]/($path)' is a data directory, ignoring files\n");
Nigel Kukard's avatar
Nigel Kukard committed
429
430
431
432
433
434
435
							$doBackup{$path} |= ST_DIR_SYS;
							return ();
						}
					}
				}
			}
		}
436
437
438
439
		# Exclude paths
		foreach my $item (@{$config{'exclude-path'}}) {
			# Check...
			if ("/$path" =~ $item) {
Nigel Kukard's avatar
Nigel Kukard committed
440
				printLog(LOG_INFO,"S: Path '[$source]/($path)' is an excluded path, ignoring files\n");
441
442
443
444
				$doBackup{$path} |= ST_DIR_SYS;
				return ();
			}
		}
Nigel Kukard's avatar
Nigel Kukard committed
445
446
447
448
449
450
451
452

		# 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
453
				printLog(LOG_WARNING,"State file '[$dest]/($path)/.dbackup-state' does not exist\n");
Nigel Kukard's avatar
Nigel Kukard committed
454
455
456
457
458
459
460
461
462
463
464
			}
			$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
465
				printLog(LOG_ERROR,"No dbackup version information found in '[$dest]/($path)/.dbackup-state', IGNORING\n");
Nigel Kukard's avatar
Nigel Kukard committed
466
467
				delete($origDirList{$path});
				delete($origFileList{$path});
Nigel Kukard's avatar
Nigel Kukard committed
468
469
470
471
472
473
474
475
476
477
478
479

			# 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" && (
						!defined($origPathAttribs{$path}->{'format'}) || 
						!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
480
481
				delete($origDirList{$path});
				delete($origFileList{$path});
Nigel Kukard's avatar
Nigel Kukard committed
482
483
484
485
486
487
488
489
490

			# 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
491
492
493
494
					if (
							$a < 16		# Things before 0.0.16 may have .dbackup-state issues and missing
										# required info.
					) {
Nigel Kukard's avatar
Nigel Kukard committed
495
496
497
498
499
500
501
502
						# 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});
503
504
							# Force state file update if dir is empty
							$doBackup{$path} |= ST_DIR_CHANGED;
Nigel Kukard's avatar
Nigel Kukard committed
505
506
507
						}
					}
				}
508
509
510
511
			}
		}

		# Apply filter...
512
		if ((@{$config{'exclude-file'}}) > 0) {
513
514
515
516
517
518
			my @newList;
			foreach my $item (@list) {
				my $match = 0;
				# Apply only to files
				if ( -f "$source/$path/$item") {
					# Loop with exclude filters
519
					foreach my $filter (@{$config{'exclude-file'}}) {
520
521
						# Check for match
						if ($item =~ $filter) {
Nigel Kukard's avatar
Nigel Kukard committed
522
							printLog(LOG_INFO,"S: Path '[$source]/($path)/$item' matches file exclude filter, ignoring\n");
523
524
525
526
527
528
529
530
531
532
							# 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
533
			}
534
535
			# Replace the list now
			@list = @newList;
Nigel Kukard's avatar
Nigel Kukard committed
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
570
		}

		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
571
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' is new\n");
Nigel Kukard's avatar
Nigel Kukard committed
572
573
574
575
576
577
578
				$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
579
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' was modified\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
580
581
582
583
584
585
				$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
586
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' UID was changed\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
587
588
589
590
591
592
				$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
593
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' GID was changed\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
594
595
596
597
598
599
				$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
600
				printLog(LOG_DEBUG,"S: Directory '[$source]/($path)/$item' MODE was changed\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
601
602
603
604
605
606
607
608
609
610
611
612
613
				$doBackup{$path} |= ST_DIR_CHANGED;
			}

			# Record details...	
			$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;
614
615
616
617
618

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

		# 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
627
				printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' is new\n");
Nigel Kukard's avatar
Nigel Kukard committed
628
629
630
631
632
633
634
635
			}
			$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
636
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' has different size\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
637
638
639
640
641
642
643
644
645
646
			$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
647
#			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' was recreated\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
648
649
650
651
652
653
654
#			$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
655
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' was modified\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
656
657
658
659
660
661
662
			$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
663
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' UID was changed\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
664
665
666
667
668
669
670
			$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
671
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' GID was changed\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
672
673
674
675
676
677
678
			$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
679
			printLog(LOG_DEBUG,"S: File '[$source]/($path)/$item' MODE was changed\n"); 
Nigel Kukard's avatar
Nigel Kukard committed
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
			$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;
		}

		# Record details...	
		$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
711
				printLog(LOG_DEBUG,"File '[$source]/($path)/$fname' removed\n");
Nigel Kukard's avatar
Nigel Kukard committed
712
713
714
715
716
717
718
719
720
				$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
721
722
723
724
725
726
727
728
		# 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
729
730
		# Check if we need to backup this dir
		if (($doBackup{$path} & ST_FILE_CHANGED) == ST_FILE_CHANGED) {
Nigel Kukard's avatar
Nigel Kukard committed
731
			printLog(LOG_INFO,"B: Path '[$source]/$path' backing up\n");
Nigel Kukard's avatar
Nigel Kukard committed
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
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784

			# 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;
						# Remove old files	
						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;
785
				if ($config{'compress'} eq "xz") {
Nigel Kukard's avatar
Nigel Kukard committed
786
787
					push(@tarArgs,"--xz");
					$tarExt = ".xz";
788
				} elsif ($config{'compress'} eq "bzip2") {
Nigel Kukard's avatar
Nigel Kukard committed
789
790
					push(@tarArgs,"--bzip2");
					$tarExt = ".bz2";
791
				} elsif ($config{'compress'} eq "gzip") {
Nigel Kukard's avatar
Nigel Kukard committed
792
793
					push(@tarArgs,"--gzip");
					$tarExt = ".gz";
794
				} elsif ($config{'compress'} eq "none") {
Nigel Kukard's avatar
Nigel Kukard committed
795
796
797
798
799
					$tarExt = "";
				}

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

802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
				# 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";
						}	
					}
				}

				# 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
837
						or die "Failed to open '[$dest]/($path)/dbackup$seq.manifest': $!";
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
				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);

854
855
856
857
858
859
860
861
862
863
864
865
				# 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
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
				# Change dir and start backup
				system(
					"tar", 
					"--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
885
					printLog(LOG_ERROR,"Failed to execute: $!\n");
Nigel Kukard's avatar
Nigel Kukard committed
886
887
					exit 1;
				} elsif ($? & 127) {
Nigel Kukard's avatar
Nigel Kukard committed
888
					printLog(LOG_ERROR,"Child died with signal ".($? & 127)."\n");
Nigel Kukard's avatar
Nigel Kukard committed
889
890
891
892
					exit 1;
				} else {
					my $retcode = $? >> 8;
					# If tar died, lets die too
893
					if ($retcode >= 2) {
Nigel Kukard's avatar
Nigel Kukard committed
894
						printLog(LOG_ERROR,"tar died with error code $retcode\n");
Nigel Kukard's avatar
Nigel Kukard committed
895
#						exit 1;
Nigel Kukard's avatar
Nigel Kukard committed
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
					}
				}
			# if (($doBackup{$path} & ST_DIR_SYS) != ST_DIR_SYS) {
			} else {
					# Remove old files	
					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
924
925
926
927
			# 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
928
929
930

			# 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
931
					or die "Failed to open '[$dest]/($path)/.dbackup-state': $!";
Nigel Kukard's avatar
Nigel Kukard committed
932
933
934
935
936
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
983
			# Loop with attributes
			foreach my $item (keys %{$newPathAttribs{$path}}) {
				$gz->gzwrite(join("\0",
						"a",
						$item,
						$newPathAttribs{$path}->{$item}	
					)."\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
984
985
	printLog(LOG_NOTICE,"BACKUP START: $source => $dest\n");
	printLog(LOG_INFO,"Compression: ".$config{'compress'}."\n");
986

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

	# We need an entry for our main dir before we start
	$doBackup{""} = 0;
For faster browsing, not all history is shown. View entire blame