]>
git.proxmox.com Git - pve-manager.git/blob - PVE/API2/Backup.pm
8e1f34e615762cc86569e3c8e97eb5af37f6b0a6
1 package PVE
::API2
::Backup
;
7 use PVE
::Tools
qw(extract_param);
8 use PVE
::Cluster
qw(cfs_register_file cfs_lock_file cfs_read_file cfs_write_file);
10 use PVE
::RPCEnvironment
;
13 use PVE
::Exception
qw(raise_param_exc);
16 use base
qw(PVE::RESTHandler);
18 cfs_register_file
('vzdump.cron',
19 \
&parse_vzdump_cron_config
,
20 \
&write_vzdump_cron_config
);
22 PVE
::JSONSchema
::register_format
('pve-day-of-week', \
&verify_day_of_week
);
23 sub verify_day_of_week
{
24 my ($value, $noerr) = @_;
26 return $value if $value =~ m/^(mon|tue|wed|thu|fri|sat|sun)$/;
28 return undef if $noerr;
30 die "invalid day '$value'\n";
34 my $dowhash_to_dow = sub {
38 push @da, $num ?
1 : 'mon' if $d->{mon
};
39 push @da, $num ?
2 : 'tue' if $d->{tue
};
40 push @da, $num ?
3 : 'wed' if $d->{wed
};
41 push @da, $num ?
4 : 'thu' if $d->{thu
};
42 push @da, $num ?
5 : 'fri' if $d->{fri
};
43 push @da, $num ?
6 : 'sat' if $d->{sat
};
44 push @da, $num ?
7 : 'sun' if $d->{sun
};
49 # parse crontab style day of week
51 my ($dowstr, $noerr) = @_;
53 my $dowmap = {mon
=> 1, tue
=> 2, wed
=> 3, thu
=> 4,
54 fri
=> 5, sat
=> 6, sun
=> 7};
55 my $rdowmap = { '1' => 'mon', '2' => 'tue', '3' => 'wed', '4' => 'thu',
56 '5' => 'fri', '6' => 'sat', '7' => 'sun', '0' => 'sun'};
60 $dowstr = '1,2,3,4,5,6,7' if $dowstr eq '*';
62 foreach my $day (PVE
::Tools
::split_list
($dowstr)) {
63 if ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun)-(mon|tue|wed|thu|fri|sat|sun)$/i) {
64 for (my $i = $dowmap->{lc($1)}; $i <= $dowmap->{lc($2)}; $i++) {
65 my $r = $rdowmap->{$i};
68 } elsif ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun|[0-7])$/i) {
69 $day = $rdowmap->{$day} if $day =~ m/\d/;
72 return undef if $noerr;
73 die "unable to parse day of week '$dowstr'\n";
80 my $vzdump_propetries = {
81 additionalProperties
=> 0,
82 properties
=> PVE
::VZDump
::json_config_properties
({}),
85 sub parse_vzdump_cron_config
{
86 my ($filename, $raw) = @_;
88 my $jobs = []; # correct jobs
90 my $ejobs = []; # mailfomerd lines
92 my $jid = 1; # we start at 1
94 my $digest = Digest
::SHA1
::sha1_hex
(defined($raw) ?
$raw : '');
96 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
99 next if $line =~ m/^\#/;
100 next if $line =~ m/^\s*$/;
101 next if $line =~ m/^PATH\s*=/; # we always overwrite path
103 if ($line =~ m
|^(\d
+)\s
+(\d
+)\s
+\
*\s
+\
*\s
+(\S
+)\s
+root\s
+(/\S+/)?vzdump
(\s
+(.*))?
$|) {
105 my $minute = int($1);
110 my $dowhash = parse_dow
($dow, 1);
111 die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;
113 my $args = PVE
::Tools
::split_args
($param);
114 my $opts = PVE
::JSONSchema
::get_options
($vzdump_propetries, $args, 'vmid');
116 $opts->{id
} = "$digest:$jid";
118 $opts->{starttime
} = sprintf "%02d:%02d", $hour, $minute;
119 $opts->{dow
} = &$dowhash_to_dow($dowhash);
125 syslog
('err', "parse error in '$filename': $err");
126 push @$ejobs, { line
=> $line };
128 } elsif ($line =~ m
|^\S
+\s
+(\S
+)\s
+\S
+\s
+\S
+\s
+\S
+\s
+\S
+\s
+(\S
.*)$|) {
129 syslog
('err', "warning: malformed line in '$filename'");
130 push @$ejobs, { line
=> $line };
132 syslog
('err', "ignoring malformed line in '$filename'");
137 $res->{digest
} = $digest;
138 $res->{jobs
} = $jobs;
139 $res->{ejobs
} = $ejobs;
144 sub write_vzdump_cron_config
{
145 my ($filename, $cfg) = @_;
147 my $out = "# cluster wide vzdump cron schedule\n";
148 $out .= "# Atomatically generated file - do not edit\n\n";
149 $out .= "PATH=\"/usr/sbin:/usr/bin:/sbin:/bin\"\n\n";
151 my $jobs = $cfg->{jobs
} || [];
152 foreach my $job (@$jobs) {
153 my $dh = parse_dow
($job->{dow
});
155 if ($dh->{mon
} && $dh->{tue
} && $dh->{wed
} && $dh->{thu
} &&
156 $dh->{fri
} && $dh->{sat
} && $dh->{sun
}) {
159 $dow = &$dowhash_to_dow($dh, 1);
165 die "no job start time specified\n" if !$job->{starttime
};
166 if ($job->{starttime
} =~ m/^(\d{1,2}):(\d{1,2})$/) {
167 ($hour, $minute) = (int($1), int($2));
168 die "hour '$hour' out of range\n" if $hour < 0 || $hour > 23;
169 die "minute '$minute' out of range\n" if $minute < 0 || $minute > 59;
171 die "unable to parse job start time\n";
174 $job->{quiet
} = 1; # we do not want messages from cron
176 my $cmd = PVE
::VZDump
::command_line
($job);
178 $out .= sprintf "$minute $hour * * %-11s root $cmd\n", $dow;
181 my $ejobs = $cfg->{ejobs
} || [];
182 foreach my $job (@$ejobs) {
183 $out .= "$job->{line}\n" if $job->{line
};
189 __PACKAGE__-
>register_method({
193 description
=> "List vzdump backup schedule.",
195 check
=> ['perm', '/', ['Sys.Audit']],
198 additionalProperties
=> 0,
206 id
=> { type
=> 'string' },
209 links
=> [ { rel
=> 'child', href
=> "{id}" } ],
214 my $rpcenv = PVE
::RPCEnvironment
::get
();
215 my $user = $rpcenv->get_user();
217 my $data = cfs_read_file
('vzdump.cron');
219 my $res = $data->{jobs
} || [];
224 __PACKAGE__-
>register_method({
225 name
=> 'create_job',
229 description
=> "Create new vzdump backup job.",
231 check
=> ['perm', '/', ['Sys.Modify']],
234 additionalProperties
=> 0,
235 properties
=> PVE
::VZDump
::json_config_properties
({
238 description
=> "Job Start time.",
239 pattern
=> '\d{1,2}:\d{1,2}',
243 type
=> 'string', format
=> 'pve-day-of-week-list',
245 description
=> "Day of week selection.",
246 default => 'mon,tue,wed,thu,fri,sat,sun',
250 returns
=> { type
=> 'null' },
254 my $rpcenv = PVE
::RPCEnvironment
::get
();
255 my $user = $rpcenv->get_user();
257 my $data = cfs_read_file
('vzdump.cron');
259 $param->{dow
} = 'mon,tue,wed,thu,fri,sat,sun' if !defined($param->{dow
});
261 PVE
::VZDump
::verify_vzdump_parameters
($param, 1);
263 push @{$data->{jobs
}}, $param;
265 cfs_write_file
('vzdump.cron', $data);
270 __PACKAGE__-
>register_method({
274 description
=> "Read vzdump backup job definition.",
276 check
=> ['perm', '/', ['Sys.Audit']],
279 additionalProperties
=> 0,
283 description
=> "The job ID.",
294 my $rpcenv = PVE
::RPCEnvironment
::get
();
295 my $user = $rpcenv->get_user();
297 my $data = cfs_read_file
('vzdump.cron');
299 my $jobs = $data->{jobs
} || [];
301 foreach my $job (@$jobs) {
302 return $job if $job->{id
} eq $param->{id
};
305 raise_param_exc
({ id
=> "No such job '$param->{id}'" });
309 __PACKAGE__-
>register_method({
310 name
=> 'delete_job',
313 description
=> "Delete vzdump backup job definition.",
315 check
=> ['perm', '/', ['Sys.Modify']],
319 additionalProperties
=> 0,
323 description
=> "The job ID.",
328 returns
=> { type
=> 'null' },
332 my $rpcenv = PVE
::RPCEnvironment
::get
();
333 my $user = $rpcenv->get_user();
335 my $data = cfs_read_file
('vzdump.cron');
337 my $jobs = $data->{jobs
} || [];
341 foreach my $job (@$jobs) {
342 if ($job->{id
} eq $param->{id
}) {
345 push @$newjobs, $job;
349 raise_param_exc
({ id
=> "No such job '$param->{id}'" }) if !$found;
351 $data->{jobs
} = $newjobs;
353 cfs_write_file
('vzdump.cron', $data);
358 __PACKAGE__-
>register_method({
359 name
=> 'update_job',
363 description
=> "Update vzdump backup job definition.",
365 check
=> ['perm', '/', ['Sys.Modify']],
368 additionalProperties
=> 0,
369 properties
=> PVE
::VZDump
::json_config_properties
({
372 description
=> "The job ID.",
377 description
=> "Job Start time.",
378 pattern
=> '\d{1,2}:\d{1,2}',
382 type
=> 'string', format
=> 'pve-day-of-week-list',
384 description
=> "Day of week selection.",
387 type
=> 'string', format
=> 'pve-configid-list',
388 description
=> "A list of settings you want to delete.",
393 returns
=> { type
=> 'null' },
397 my $rpcenv = PVE
::RPCEnvironment
::get
();
398 my $user = $rpcenv->get_user();
400 my $data = cfs_read_file
('vzdump.cron');
402 my $jobs = $data->{jobs
} || [];
404 die "no options specified\n" if !scalar(keys %$param);
406 PVE
::VZDump
::verify_vzdump_parameters
($param);
408 my @delete = PVE
::Tools
::split_list
(extract_param
($param, 'delete'));
410 foreach my $job (@$jobs) {
411 if ($job->{id
} eq $param->{id
}) {
413 foreach my $k (@delete) {
414 if (!PVE
::VZDump
::option_exists
($k)) {
415 raise_param_exc
({ delete => "unknown option '$k'" });
421 foreach my $k (keys %$param) {
422 $job->{$k} = $param->{$k};
425 $job->{all
} = 1 if defined($job->{exclude
});
427 if (defined($param->{vmid
})) {
429 delete $job->{exclude
};
430 } elsif ($param->{all
}) {
434 PVE
::VZDump
::verify_vzdump_parameters
($job, 1);
436 cfs_write_file
('vzdump.cron', $data);
442 raise_param_exc
({ id
=> "No such job '$param->{id}'" });