-
-
Notifications
You must be signed in to change notification settings - Fork 101
/
backup-domain.pl
executable file
·513 lines (482 loc) · 16.3 KB
/
backup-domain.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
#!/usr/local/bin/perl
=head1 backup-domain.pl
Backup one or more virtual servers
This program is analogous to the Backup Virtual Servers page in the Virtualmin web interface. It will create either a single backup file or multiple separate files containing the domains specified on the command line, either locally or on a remote SCP or FTP server.
The C<--dest> option sets the backup destination, and can be a simple path like
C</backup/virtualmin.tgz> , an FTP URL like
C<ftp://user:pass@server:/backup/virtualmin.tgz> , or an SCP URL like
C<ssh://user:pass@server:/backup/virtualmin.tgz> . When backing up to a single
file, the path specifies a file that will be created. When creating one backup
per domain, it specifies a directory instead.
The C<--domain> and C<--all-domains> options can be used to control which virtual
servers are included in the backup. The C<--domain> parameter followed by a
domain name can be given multiple times, to select more than one server. You can
also add the C<--parent> flag to include all sub-servers and aliases of the
selected domains.
Alternately, virtual servers can be selected with the C<--user> flag followed
by an administrator's username, C<--plan> followed by a plan name, or
C<-reseller> followed by a reseller name. In all cases, all sub-servers will be
included too.
Typically the C<--all-features> option will be used to include all virtual server
features in the backup, but you can instead use the C<--feature> option one or
more times to control exactly what gets included. In this case, it is wise to
use at least C<--feature dir> to include each server's home directory.
The C<--newformat> option tells the backup program to create a separate file for
each virtual server. As long as the entire domain is being backed up, this
format also uses less temporary space as all databases and other additional
files are included in the home directory archive.
Using the C<--ignore-errors> option means than any errors
encountered backing up one feature or server will be reported and ignored,
rather than terminating the whole backup as happens by default.
To include core Virtualmin settings in the backup, the C<--all-virtualmin>
option can be specified as well. Alternately, you can select exactly which
settings to include with the C<--virtualmin> parameter. For example,
C<--virtualmin config> would only backup the module configuration.
By default, backups include all files in each domain's home directory. However,
if you use the C<--differential> parameter, only those changed since the last
non-differential backup will be included. This allows you to reduce the size of
backups for large websites that rarely change, but means that when restoring
both the full and differential backups are needed.
The alternative parameter C<--no-differential> can be used by prevent Virtualmin
from clearing the list of files that were included in the last full backup.
This is used if you have a scheduled differential backup setup, and don't want
to change its behavior by doing an ad-hoc full backup.
To exclude some files from each virtual server's home directory from the
backup, use the C<--exclude> flag followed by a relative filename, like
I<public_html/stats> or I<.bashrc>. Alternately, you can limit the backup to
only specific files and directories with the C<--include> flag.
To have Virtualmin automatically replace strftime-style date formatting
characters in the backup destination, you can use the C<--strftime> flag.
When this is enabled, the C<--purge> flag can also be given, followed by a
number of days. The command will then delete backups in the same desination
directory older than the specified number of days. To see more detail about
which files were consisered for purging, add the C<--purge-debug> flag.
On a Virtualmin Pro system, you can use the C<--key> flag followed by
a backup key ID or description to select the key to encrypt this backup with.
Keys can be found using the C<list-backup-keys> API call.
By default, only one backup to the same destination can be running at the
same time - the second backup will immediately fail. You can invert this
behavior with the C<--kill-running> flag, which terminates the first backup
and allows this one to continue. Or you can use the C<--wait-running> flag
to delay the backup until the first one completes.
To override the default compression format set on the Virtualmin Configuration
page, use the C<--compression> flag followed by one of C<gzip>, C<bzip2>,
C<tar> or C<zip>.
=cut
package virtual_server;
if (!$module_name) {
$main::no_acl_check++;
$ENV{'WEBMIN_CONFIG'} ||= "/etc/webmin";
$ENV{'WEBMIN_VAR'} ||= "/var/webmin";
if ($0 =~ /^(.*)\/[^\/]+$/) {
chdir($pwd = $1);
}
else {
chop($pwd = `pwd`);
}
$0 = "$pwd/backup-domain.pl";
require './virtual-server-lib.pl';
$< == 0 || die "backup-domain.pl must be run as root";
}
$first_print = \&first_text_print;
$second_print = \&second_text_print;
$indent_print = \&indent_text_print;
$outdent_print = \&outdent_text_print;
# Parse command-line args
$asowner = 0;
@allplans = &list_plans();
@OLDARGV = @ARGV;
while(@ARGV > 0) {
local $a = shift(@ARGV);
if ($a eq "--dest") {
push(@dests, shift(@ARGV));
}
elsif ($a eq "--feature") {
local $f = shift(@ARGV);
$f eq "virtualmin" || $config{$f} ||
&indexof($f, &list_backup_plugins()) >= 0 ||
&usage("Feature $f is not enabled on this system");
push(@bfeats, $f);
}
elsif ($a eq "--domain") {
push(@bdoms, shift(@ARGV));
}
elsif ($a eq "--user") {
push(@users, shift(@ARGV));
}
elsif ($a eq "--parent") {
$includesubs = 1;
}
elsif ($a eq "--reseller") {
defined(&list_resellers) ||
&usage("Your system does not support resellers");
push(@resellers, shift(@ARGV));
}
elsif ($a eq "--plan") {
$planname = shift(@ARGV);
($plan) = grep { lc($_->{'name'}) eq lc($planname) ||
$_->{'id'} eq $planname } @allplans;
$plan || &usage("No plan with name or ID $planname found");
push(@plans, $plan);
}
elsif ($a eq "--all-features") {
@bfeats = grep { $config{$_} || $_ eq 'virtualmin' }
@backup_features;
push(@bfeats, &list_backup_plugins());
}
elsif ($a eq "--except-feature") {
local $f = shift(@ARGV);
@bfeats = grep { $_ ne $f } @bfeats;
}
elsif ($a eq "--all-domains") {
$all_doms = 1;
}
elsif ($a eq "--test") {
$test = 1;
}
elsif ($a eq "--ignore-errors") {
$ignore_errors = 1;
}
elsif ($a eq "--separate") {
$separate = 1;
}
elsif ($a eq "--mkdir") {
$mkdir = 1;
}
elsif ($a eq "--onebyone") {
$onebyone = 1;
}
elsif ($a eq "--newformat") {
$separate = 1;
$newformat = 1;
}
elsif ($a eq "--strftime") {
$strftime = 1;
}
elsif ($a eq "--option") {
$optf = shift(@ARGV);
if ($optf =~ /^(\S+)\s+(\S+)\s+(\S+)$/) {
$optf = $1;
$optn = $2;
$optv = $3;
}
else {
$optn = shift(@ARGV);
$optv = shift(@ARGV);
}
$optf && $optn && $optv || &usage("Invalid option specification");
$opts{$optf}->{$optn} = $optv;
}
elsif ($a eq "--mailfiles") {
# Convenience flag for --option mail mailfiles 1
# Deprecated, as this is on by default now
}
elsif ($a eq "--as-owner") {
# Run as domain owner
$asowner = 1;
}
elsif ($a eq "--virtualmin") {
$v = shift(@ARGV);
if (&indexof($v, @virtualmin_backups) < 0) {
print STDERR "Unknown --virtualmin option $v. Available options are : ".join(" ", @virtualmin_backups)."\n";
}
else {
push(@vbs, $v);
}
}
elsif ($a eq "--all-virtualmin") {
@vbs = @virtualmin_backups;
}
elsif ($a eq "--except-virtualmin") {
$v = shift(@ARGV);
@vbs = grep { $_ ne $v } @vbs;
}
elsif ($a eq "--incremental" || $a eq "--differential") {
&has_incremental_tar() || &usage("The tar command on this system does not support differential backups");
$increment = 1;
}
elsif ($a eq "--no-incremental" || $a eq "--no-differential") {
$increment = 2;
}
elsif ($a eq "--purge") {
$purge = shift(@ARGV);
$purge =~ /^[0-9\.]+$/ || &usage("--purge must be followed by a number");
}
elsif ($a eq "--purge-debug") {
$purge_debug = 1;
}
elsif ($a eq "--key") {
$keyid = shift(@ARGV);
}
elsif ($a eq "--exclude") {
$exclude = shift(@ARGV);
push(@exclude, $exclude);
}
elsif ($a eq "--include") {
$include = shift(@ARGV);
push(@include, $include);
}
elsif ($a eq "--multiline") {
$multiline = 1;
}
elsif ($a eq "--kill-running") {
$kill = 1;
}
elsif ($a eq "--wait-running") {
$kill = 2;
}
elsif ($a eq "--compression") {
my $c = shift(@ARGV);
$compression = $c eq "gzip" ? 0 :
$c eq "bzip2" ? 1 :
$c eq "tar" ? 2 :
$c eq "zip" ? 3 : -1;
&usage("Invalid compression format $c") if ($compression < 0);
}
elsif ($a eq "--help") {
&usage();
}
else {
&usage("Unknown parameter $a");
}
}
@dests || usage("No destinations specified");
if (@resellers) {
# Map resellers to domains
foreach $r (@resellers) {
push(@bdoms, map { $_->{'dom'} } &get_reseller_domains($r));
}
}
@bdoms || @users || $all_doms || @plans || @vbs || $purge ||
&usage("No domains specified");
if (@bdoms || @users || $all_doms) {
@bfeats || usage("No features specified");
}
foreach $dest (@dests) {
# Validate destination URL
($bmode, $derr, undef, $host, $path) = &parse_backup_url($dest);
$bmode < 0 && &usage("Destination $dest is invalid : $derr");
if ($bmode && $mkdir) {
&usage("--mkdir option can only be used for local backups");
}
if ($onebyone && !$bmode) {
&usage("--onebyone option can only be used with ".
"remote backups");
}
# Validate purging
if ($purge) {
$strftime || &usage("The --purge flag can only be used in ".
"conjunction with --strftime");
$path =~ /%/ || $host =~ /%/ ||
&usage("The --purge flag can only be used for backup ".
"destinations containing strftime substitutions");
($basepath, $pattern) = &extract_purge_path($dest);
$basepath || $pattern ||
&usage("The --purge flag can only be used when a ".
"base directory can be extracted from the ".
"backup path, like /backup/virtualmin-%d-%m-%Y");
}
}
if ($keyid) {
# Validate encryption key
defined(&list_backup_keys) ||
&usage("Backup encryption is not supported on this system");
($key) = grep { $_->{'id'} eq $keyid ||
$_->{'key'} eq $keyid ||
$_->{'desc'} eq $keyid } &list_backup_keys();
$key || &usage("No backup key with ID or description $keyid exists");
}
if ($onebyone && !$newformat) {
&usage("--onebyone option can only be used in conjunction ".
"with --newformat");
}
if ($increment) {
&has_incremental_format($compression) || &usage("The configured backup format does not support differential backups");
}
# Work out what will be backed up
if ($all_doms) {
# All domains
@doms = &list_domains();
}
else {
# Get domains by name and user
@doms = &get_domains_by_names_users(\@bdoms, \@users, \&usage, \@plans,
$includesubs);
}
if ($test) {
# Just tell the user what will be done
if (@doms) {
print "The following servers will be backed up :\n";
foreach $d (@doms) {
print "\t$d->{'dom'}\n";
}
print "\n";
print "The following features will be backed up :\n";
foreach $f (@bfeats) {
if (&indexof($f, &list_backup_plugins()) >= 0) {
$fn = &plugin_call($f, "feature_backup_name") ||
&plugin_call($f, "feature_name");
}
else {
$fn = $text{"backup_feature_".$f} || $text{"feature_".$f};
}
print "\t",($fn ? $fn." ($f)" : $f),"\n";
}
}
if (@vbs) {
print "The following Virtualmin settings will be backed up :\n";
foreach $v (@vbs) {
print "\t",$text{'backup_v'.$v},"\n";
}
}
exit(0);
}
# Create a fake backup schedule object
my $sched = { 'id' => 'backup.pl.'.time() };
for(my $i=0; $i<@dests; $i++) {
$sched->{'dest'.$i} = $dests[$i];
}
if ($all_doms) {
$sched->{'all'} = 1;
}
elsif (@doms) {
$sched->{'doms'} = join(" ", map { $_->{'id'} } @doms);
}
$sched->{'virtualmin'} = join(" ", @vbs);
&start_running_backup($sched);
&start_print_capture();
$start_time = time();
if ($strftime) {
@strfdests = map { &backup_strftime($_) } @dests;
}
else {
@strfdests = @dests;
}
@exclude && @include &&
&usage("The --exclude and --include flags are mutually exclusive");
if (@exclude) {
$opts{'dir'}->{'exclude'} = join("\t", @exclude);
}
elsif (@include) {
$opts{'dir'}->{'exclude'} = join("\t", @include);
$opts{'dir'}->{'include'} = 1;
}
$opts{'dir'}->{'strftime'} = $strftime;
# Do the backup, printing any output
if ($sched->{'doms'} || $sched->{'all'} || $sched->{'virtualmin'}) {
&$first_print("Starting backup..");
($ok, $size, $errdoms) = &backup_domains(
\@strfdests,
\@doms,
\@bfeats,
$separate,
$ignore_errors,
\%opts,
$newformat,
\@vbs,
$mkdir,
$onebyone,
$asowner,
undef,
$increment,
0,
$key,
$kill,
$compression);
if ($ok && !@$errdoms) {
&$second_print("Backup completed successfully. Final size was ".
&nice_size($size));
$ex = 0;
}
elsif ($ok && @$errdoms) {
&$second_print("Backup partially completed. Final size was ".
&nice_size($size));
$ex = 4;
}
else {
&$second_print("Backup failed!");
$ex = 2;
}
}
else {
# Probably just purging
$ok = 1;
$size = 0;
}
# Purge if requested
$pok = 1;
if ($purge && $ok) {
$asd = $asowner ? &get_backup_as_domain(\@doms) : undef;
foreach $dest (@dests) {
$pok = &purge_domain_backups($dest, $purge, $start_time, $asd,
$purge_debug);
if (!$pok) {
$ex = 3;
}
}
}
$output = &stop_print_capture();
&cleanup_backup_limits(0, 1);
foreach $dest (@strfdests) {
&write_backup_log(\@doms, $dest, $increment, $start_time,
$size, $ok, "api", $output, $errdoms, undef, $key,
undef,
$separate && $newformat ? 2 : $separate ? 1 : 0,
undef, $compression);
}
&stop_running_backup($sched);
&virtualmin_api_log(\@OLDARGV, $doms[0]);
exit($ex);
sub usage
{
if ($_[0]) {
print $_[0],"\n\n";
}
print "Creates a Virtualmin backup, for the domains and features specified\n";
print "on the command line.\n";
print "\n";
print "virtualmin backup-domain [--dest file]+\n";
print " [--test]\n";
print " [--domain name] | [--all-domains]\n";
print " [--parent]\n";
print " [--user name]\n";
print " [--reseller name]\n";
print " [--plan name]\n";
print " [--feature name] | [--all-features]\n";
print " [--except-feature name]\n";
print " [--ignore-errors]\n";
print " [--newformat]\n";
print " [--onebyone]\n";
print " [--strftime] [--purge days]\n";
if (&has_incremental_tar()) {
print " [--differential] | [--no-differential]\n";
}
print " [--all-virtualmin] | [--virtualmin config] |\n";
print " [--except-virtualmin config]\n";
print " [--option \"feature name value\"]\n";
print " [--as-owner]\n";
print " [--exclude file]*\n";
print " [--include file]*\n";
print " [--purge days]\n";
print " [--purge-debug]\n";
if (defined(&list_backup_keys)) {
print " [--key id]\n";
}
print " [--kill-running | --wait-running]\n";
print " [--compression gzip|bzip2|tar|zip]\n";
print "\n";
print "Multiple domains may be specified with multiple --domain parameters.\n";
print "Features must be specified using their short names, like web and dns.\n";
print "\n";
print "The destination can be one of :\n";
print " - A local file, like /backup/yourdomain.com.tgz\n";
print " - A local directory can be given while passing --newformat option, like /backup/\n";
print " - An FTP destination, like ftp://login:pass\@server/backup/yourdomain.com.tgz\n";
print " - An SSH destination, like ssh://login:pass\@server/backup/yourdomain.com.tgz\n";
print " - An S3 bucket, like s3://accesskey:secretkey\@bucket\n";
print " - A Rackspace container, like rs://user:apikey\@container\n";
print " - A Google Cloud Storage bucket, like gcs://bucket\n";
print " - A Dropbox folder, like dropbox://folder\n";
print "Multiple destinations can be given by repeating this flag.\n";
exit(1);
}