]>
git.proxmox.com Git - pve-manager.git/blob - PVE/API2/Backup.pm
141402b1155cd300e73797c153426651c266fde2
1 package PVE
::API2
::Backup
;
8 use PVE
::Tools
qw(extract_param);
9 use PVE
::Cluster
qw(cfs_register_file cfs_lock_file cfs_read_file cfs_write_file);
11 use PVE
::RPCEnvironment
;
14 use PVE
::Exception
qw(raise_param_exc);
17 use base
qw(PVE::RESTHandler);
19 cfs_register_file
('vzdump.cron',
20 \
&parse_vzdump_cron_config
,
21 \
&write_vzdump_cron_config
);
23 PVE
::JSONSchema
::register_format
('pve-day-of-week', \
&verify_day_of_week
);
24 sub verify_day_of_week
{
25 my ($value, $noerr) = @_;
27 return $value if $value =~ m/^(mon|tue|wed|thu|fri|sat|sun)$/;
29 return undef if $noerr;
31 die "invalid day '$value'\n";
35 my $dowhash_to_dow = sub {
39 push @da, $num ?
1 : 'mon' if $d->{mon
};
40 push @da, $num ?
2 : 'tue' if $d->{tue
};
41 push @da, $num ?
3 : 'wed' if $d->{wed
};
42 push @da, $num ?
4 : 'thu' if $d->{thu
};
43 push @da, $num ?
5 : 'fri' if $d->{fri
};
44 push @da, $num ?
6 : 'sat' if $d->{sat
};
45 push @da, $num ?
7 : 'sun' if $d->{sun
};
50 # parse crontab style day of week
52 my ($dowstr, $noerr) = @_;
54 my $dowmap = {mon
=> 1, tue
=> 2, wed
=> 3, thu
=> 4,
55 fri
=> 5, sat
=> 6, sun
=> 7};
56 my $rdowmap = { '1' => 'mon', '2' => 'tue', '3' => 'wed', '4' => 'thu',
57 '5' => 'fri', '6' => 'sat', '7' => 'sun', '0' => 'sun'};
61 $dowstr = '1,2,3,4,5,6,7' if $dowstr eq '*';
63 foreach my $day (PVE
::Tools
::split_list
($dowstr)) {
64 if ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun)-(mon|tue|wed|thu|fri|sat|sun)$/i) {
65 for (my $i = $dowmap->{lc($1)}; $i <= $dowmap->{lc($2)}; $i++) {
66 my $r = $rdowmap->{$i};
69 } elsif ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun|[0-7])$/i) {
70 $day = $rdowmap->{$day} if $day =~ m/\d/;
73 return undef if $noerr;
74 die "unable to parse day of week '$dowstr'\n";
81 my $vzdump_properties = {
82 additionalProperties
=> 0,
83 properties
=> PVE
::VZDump
::json_config_properties
({}),
86 sub parse_vzdump_cron_config
{
87 my ($filename, $raw) = @_;
89 my $jobs = []; # correct jobs
91 my $ejobs = []; # mailfomerd lines
93 my $jid = 1; # we start at 1
95 my $digest = Digest
::SHA
::sha1_hex
(defined($raw) ?
$raw : '');
97 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
100 next if $line =~ m/^\#/;
101 next if $line =~ m/^\s*$/;
102 next if $line =~ m/^PATH\s*=/; # we always overwrite path
104 if ($line =~ m
|^(\d
+)\s
+(\d
+)\s
+\
*\s
+\
*\s
+(\S
+)\s
+root\s
+(/\S+/)?
(#)?vzdump(\s+(.*))?$|) {
106 my $minute = int($1);
112 my $dowhash = parse_dow
($dow, 1);
113 die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;
115 my $args = PVE
::Tools
::split_args
($param);
116 my $opts = PVE
::JSONSchema
::get_options
($vzdump_properties, $args, 'vmid');
118 $opts->{enabled
} = !defined($enabled);
119 $opts->{id
} = "$digest:$jid";
121 $opts->{starttime
} = sprintf "%02d:%02d", $hour, $minute;
122 $opts->{dow
} = &$dowhash_to_dow($dowhash);
128 syslog
('err', "parse error in '$filename': $err");
129 push @$ejobs, { line
=> $line };
131 } elsif ($line =~ m
|^\S
+\s
+(\S
+)\s
+\S
+\s
+\S
+\s
+\S
+\s
+\S
+\s
+(\S
.*)$|) {
132 syslog
('err', "warning: malformed line in '$filename'");
133 push @$ejobs, { line
=> $line };
135 syslog
('err', "ignoring malformed line in '$filename'");
140 $res->{digest
} = $digest;
141 $res->{jobs
} = $jobs;
142 $res->{ejobs
} = $ejobs;
147 sub write_vzdump_cron_config
{
148 my ($filename, $cfg) = @_;
150 my $out = "# cluster wide vzdump cron schedule\n";
151 $out .= "# Automatically generated file - do not edit\n\n";
152 $out .= "PATH=\"/usr/sbin:/usr/bin:/sbin:/bin\"\n\n";
154 my $jobs = $cfg->{jobs
} || [];
155 foreach my $job (@$jobs) {
156 my $enabled = ($job->{enabled
}) ?
'' : '#';
157 my $dh = parse_dow
($job->{dow
});
159 if ($dh->{mon
} && $dh->{tue
} && $dh->{wed
} && $dh->{thu
} &&
160 $dh->{fri
} && $dh->{sat
} && $dh->{sun
}) {
163 $dow = &$dowhash_to_dow($dh, 1);
169 die "no job start time specified\n" if !$job->{starttime
};
170 if ($job->{starttime
} =~ m/^(\d{1,2}):(\d{1,2})$/) {
171 ($hour, $minute) = (int($1), int($2));
172 die "hour '$hour' out of range\n" if $hour < 0 || $hour > 23;
173 die "minute '$minute' out of range\n" if $minute < 0 || $minute > 59;
175 die "unable to parse job start time\n";
178 $job->{quiet
} = 1; # we do not want messages from cron
180 my $cmd = PVE
::VZDump
::command_line
($job);
182 $out .= sprintf "$minute $hour * * %-11s root $enabled$cmd\n", $dow;
185 my $ejobs = $cfg->{ejobs
} || [];
186 foreach my $job (@$ejobs) {
187 $out .= "$job->{line}\n" if $job->{line
};
193 __PACKAGE__-
>register_method({
197 description
=> "List vzdump backup schedule.",
199 check
=> ['perm', '/', ['Sys.Audit']],
202 additionalProperties
=> 0,
210 id
=> { type
=> 'string' },
213 links
=> [ { rel
=> 'child', href
=> "{id}" } ],
218 my $rpcenv = PVE
::RPCEnvironment
::get
();
219 my $user = $rpcenv->get_user();
221 my $data = cfs_read_file
('vzdump.cron');
223 my $res = $data->{jobs
} || [];
228 __PACKAGE__-
>register_method({
229 name
=> 'create_job',
233 description
=> "Create new vzdump backup job.",
235 check
=> ['perm', '/', ['Sys.Modify']],
236 description
=> "The 'tmpdir', 'dumpdir' and 'script' parameters are additionally restricted to the 'root\@pam' user.",
239 additionalProperties
=> 0,
240 properties
=> PVE
::VZDump
::json_config_properties
({
243 description
=> "Job Start time.",
244 pattern
=> '\d{1,2}:\d{1,2}',
248 type
=> 'string', format
=> 'pve-day-of-week-list',
250 description
=> "Day of week selection.",
251 default => 'mon,tue,wed,thu,fri,sat,sun',
256 description
=> "Enable or disable the job.",
261 returns
=> { type
=> 'null' },
265 my $rpcenv = PVE
::RPCEnvironment
::get
();
266 my $user = $rpcenv->get_user();
268 foreach my $key (qw(tmpdir dumpdir script)) {
269 raise_param_exc
({ $key => "Only root may set this option."})
270 if defined($param->{$key}) && ($user ne 'root@pam');
273 my $create_job = sub {
274 my $data = cfs_read_file
('vzdump.cron');
276 $param->{dow
} = 'mon,tue,wed,thu,fri,sat,sun' if !defined($param->{dow
});
277 $param->{enabled
} = 1 if !defined($param->{enabled
});
278 PVE
::VZDump
::verify_vzdump_parameters
($param, 1);
280 push @{$data->{jobs
}}, $param;
282 cfs_write_file
('vzdump.cron', $data);
284 cfs_lock_file
('vzdump.cron', undef, $create_job);
290 __PACKAGE__-
>register_method({
294 description
=> "Read vzdump backup job definition.",
296 check
=> ['perm', '/', ['Sys.Audit']],
299 additionalProperties
=> 0,
303 description
=> "The job ID.",
314 my $rpcenv = PVE
::RPCEnvironment
::get
();
315 my $user = $rpcenv->get_user();
317 my $data = cfs_read_file
('vzdump.cron');
319 my $jobs = $data->{jobs
} || [];
321 foreach my $job (@$jobs) {
322 return $job if $job->{id
} eq $param->{id
};
325 raise_param_exc
({ id
=> "No such job '$param->{id}'" });
329 __PACKAGE__-
>register_method({
330 name
=> 'delete_job',
333 description
=> "Delete vzdump backup job definition.",
335 check
=> ['perm', '/', ['Sys.Modify']],
339 additionalProperties
=> 0,
343 description
=> "The job ID.",
348 returns
=> { type
=> 'null' },
352 my $rpcenv = PVE
::RPCEnvironment
::get
();
353 my $user = $rpcenv->get_user();
355 my $delete_job = sub {
356 my $data = cfs_read_file
('vzdump.cron');
358 my $jobs = $data->{jobs
} || [];
362 foreach my $job (@$jobs) {
363 if ($job->{id
} eq $param->{id
}) {
366 push @$newjobs, $job;
370 raise_param_exc
({ id
=> "No such job '$param->{id}'" }) if !$found;
372 $data->{jobs
} = $newjobs;
374 cfs_write_file
('vzdump.cron', $data);
376 cfs_lock_file
('vzdump.cron', undef, $delete_job);
382 __PACKAGE__-
>register_method({
383 name
=> 'update_job',
387 description
=> "Update vzdump backup job definition.",
389 check
=> ['perm', '/', ['Sys.Modify']],
392 additionalProperties
=> 0,
393 properties
=> PVE
::VZDump
::json_config_properties
({
396 description
=> "The job ID.",
401 description
=> "Job Start time.",
402 pattern
=> '\d{1,2}:\d{1,2}',
406 type
=> 'string', format
=> 'pve-day-of-week-list',
408 description
=> "Day of week selection.",
411 type
=> 'string', format
=> 'pve-configid-list',
412 description
=> "A list of settings you want to delete.",
418 description
=> "Enable or disable the job.",
423 returns
=> { type
=> 'null' },
427 my $rpcenv = PVE
::RPCEnvironment
::get
();
428 my $user = $rpcenv->get_user();
430 my $update_job = sub {
431 my $data = cfs_read_file
('vzdump.cron');
433 my $jobs = $data->{jobs
} || [];
435 die "no options specified\n" if !scalar(keys %$param);
437 PVE
::VZDump
::verify_vzdump_parameters
($param);
439 my @delete = PVE
::Tools
::split_list
(extract_param
($param, 'delete'));
441 foreach my $job (@$jobs) {
442 if ($job->{id
} eq $param->{id
}) {
444 foreach my $k (@delete) {
445 if (!PVE
::VZDump
::option_exists
($k)) {
446 raise_param_exc
({ delete => "unknown option '$k'" });
452 foreach my $k (keys %$param) {
453 $job->{$k} = $param->{$k};
456 $job->{all
} = 1 if defined($job->{exclude
});
458 if (defined($param->{vmid
})) {
460 delete $job->{exclude
};
461 } elsif ($param->{all
}) {
465 PVE
::VZDump
::verify_vzdump_parameters
($job, 1);
467 cfs_write_file
('vzdump.cron', $data);
472 raise_param_exc
({ id
=> "No such job '$param->{id}'" });
474 cfs_lock_file
('vzdump.cron', undef, $update_job);