]>
git.proxmox.com Git - pve-manager.git/blob - PVE/API2/Backup.pm
c26c8d37951902090c6fba91591143b93705b0db
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);
111 my $dowhash = parse_dow
($dow, 1);
112 die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;
114 my $args = PVE
::Tools
::split_args
($param);
115 my $opts = PVE
::JSONSchema
::get_options
($vzdump_properties, $args, 'vmid');
117 $opts->{id
} = "$digest:$jid";
119 $opts->{starttime
} = sprintf "%02d:%02d", $hour, $minute;
120 $opts->{dow
} = &$dowhash_to_dow($dowhash);
126 syslog
('err', "parse error in '$filename': $err");
127 push @$ejobs, { line
=> $line };
129 } elsif ($line =~ m
|^\S
+\s
+(\S
+)\s
+\S
+\s
+\S
+\s
+\S
+\s
+\S
+\s
+(\S
.*)$|) {
130 syslog
('err', "warning: malformed line in '$filename'");
131 push @$ejobs, { line
=> $line };
133 syslog
('err', "ignoring malformed line in '$filename'");
138 $res->{digest
} = $digest;
139 $res->{jobs
} = $jobs;
140 $res->{ejobs
} = $ejobs;
145 sub write_vzdump_cron_config
{
146 my ($filename, $cfg) = @_;
148 my $out = "# cluster wide vzdump cron schedule\n";
149 $out .= "# Atomatically generated file - do not edit\n\n";
150 $out .= "PATH=\"/usr/sbin:/usr/bin:/sbin:/bin\"\n\n";
152 my $jobs = $cfg->{jobs
} || [];
153 foreach my $job (@$jobs) {
154 my $dh = parse_dow
($job->{dow
});
156 if ($dh->{mon
} && $dh->{tue
} && $dh->{wed
} && $dh->{thu
} &&
157 $dh->{fri
} && $dh->{sat
} && $dh->{sun
}) {
160 $dow = &$dowhash_to_dow($dh, 1);
166 die "no job start time specified\n" if !$job->{starttime
};
167 if ($job->{starttime
} =~ m/^(\d{1,2}):(\d{1,2})$/) {
168 ($hour, $minute) = (int($1), int($2));
169 die "hour '$hour' out of range\n" if $hour < 0 || $hour > 23;
170 die "minute '$minute' out of range\n" if $minute < 0 || $minute > 59;
172 die "unable to parse job start time\n";
175 $job->{quiet
} = 1; # we do not want messages from cron
177 my $cmd = PVE
::VZDump
::command_line
($job);
179 $out .= sprintf "$minute $hour * * %-11s root $cmd\n", $dow;
182 my $ejobs = $cfg->{ejobs
} || [];
183 foreach my $job (@$ejobs) {
184 $out .= "$job->{line}\n" if $job->{line
};
190 __PACKAGE__-
>register_method({
194 description
=> "List vzdump backup schedule.",
196 check
=> ['perm', '/', ['Sys.Audit']],
199 additionalProperties
=> 0,
207 id
=> { type
=> 'string' },
210 links
=> [ { rel
=> 'child', href
=> "{id}" } ],
215 my $rpcenv = PVE
::RPCEnvironment
::get
();
216 my $user = $rpcenv->get_user();
218 my $data = cfs_read_file
('vzdump.cron');
220 my $res = $data->{jobs
} || [];
225 __PACKAGE__-
>register_method({
226 name
=> 'create_job',
230 description
=> "Create new vzdump backup job.",
232 check
=> ['perm', '/', ['Sys.Modify']],
235 additionalProperties
=> 0,
236 properties
=> PVE
::VZDump
::json_config_properties
({
239 description
=> "Job Start time.",
240 pattern
=> '\d{1,2}:\d{1,2}',
244 type
=> 'string', format
=> 'pve-day-of-week-list',
246 description
=> "Day of week selection.",
247 default => 'mon,tue,wed,thu,fri,sat,sun',
251 returns
=> { type
=> 'null' },
255 my $rpcenv = PVE
::RPCEnvironment
::get
();
256 my $user = $rpcenv->get_user();
258 my $data = cfs_read_file
('vzdump.cron');
260 $param->{dow
} = 'mon,tue,wed,thu,fri,sat,sun' if !defined($param->{dow
});
262 PVE
::VZDump
::verify_vzdump_parameters
($param, 1);
264 push @{$data->{jobs
}}, $param;
266 cfs_write_file
('vzdump.cron', $data);
271 __PACKAGE__-
>register_method({
275 description
=> "Read vzdump backup job definition.",
277 check
=> ['perm', '/', ['Sys.Audit']],
280 additionalProperties
=> 0,
284 description
=> "The job ID.",
295 my $rpcenv = PVE
::RPCEnvironment
::get
();
296 my $user = $rpcenv->get_user();
298 my $data = cfs_read_file
('vzdump.cron');
300 my $jobs = $data->{jobs
} || [];
302 foreach my $job (@$jobs) {
303 return $job if $job->{id
} eq $param->{id
};
306 raise_param_exc
({ id
=> "No such job '$param->{id}'" });
310 __PACKAGE__-
>register_method({
311 name
=> 'delete_job',
314 description
=> "Delete vzdump backup job definition.",
316 check
=> ['perm', '/', ['Sys.Modify']],
320 additionalProperties
=> 0,
324 description
=> "The job ID.",
329 returns
=> { type
=> 'null' },
333 my $rpcenv = PVE
::RPCEnvironment
::get
();
334 my $user = $rpcenv->get_user();
336 my $data = cfs_read_file
('vzdump.cron');
338 my $jobs = $data->{jobs
} || [];
342 foreach my $job (@$jobs) {
343 if ($job->{id
} eq $param->{id
}) {
346 push @$newjobs, $job;
350 raise_param_exc
({ id
=> "No such job '$param->{id}'" }) if !$found;
352 $data->{jobs
} = $newjobs;
354 cfs_write_file
('vzdump.cron', $data);
359 __PACKAGE__-
>register_method({
360 name
=> 'update_job',
364 description
=> "Update vzdump backup job definition.",
366 check
=> ['perm', '/', ['Sys.Modify']],
369 additionalProperties
=> 0,
370 properties
=> PVE
::VZDump
::json_config_properties
({
373 description
=> "The job ID.",
378 description
=> "Job Start time.",
379 pattern
=> '\d{1,2}:\d{1,2}',
383 type
=> 'string', format
=> 'pve-day-of-week-list',
385 description
=> "Day of week selection.",
388 type
=> 'string', format
=> 'pve-configid-list',
389 description
=> "A list of settings you want to delete.",
394 returns
=> { type
=> 'null' },
398 my $rpcenv = PVE
::RPCEnvironment
::get
();
399 my $user = $rpcenv->get_user();
401 my $data = cfs_read_file
('vzdump.cron');
403 my $jobs = $data->{jobs
} || [];
405 die "no options specified\n" if !scalar(keys %$param);
407 PVE
::VZDump
::verify_vzdump_parameters
($param);
409 my @delete = PVE
::Tools
::split_list
(extract_param
($param, 'delete'));
411 foreach my $job (@$jobs) {
412 if ($job->{id
} eq $param->{id
}) {
414 foreach my $k (@delete) {
415 if (!PVE
::VZDump
::option_exists
($k)) {
416 raise_param_exc
({ delete => "unknown option '$k'" });
422 foreach my $k (keys %$param) {
423 $job->{$k} = $param->{$k};
426 $job->{all
} = 1 if defined($job->{exclude
});
428 if (defined($param->{vmid
})) {
430 delete $job->{exclude
};
431 } elsif ($param->{all
}) {
435 PVE
::VZDump
::verify_vzdump_parameters
($job, 1);
437 cfs_write_file
('vzdump.cron', $data);
443 raise_param_exc
({ id
=> "No such job '$param->{id}'" });