[pve-manager.git] / PVE / API2 / Backup.pm

package PVE::API2::Backup;

use strict;
use warnings;

use PVE::SafeSyslog;
use PVE::Tools qw(extract_param);
use PVE::Cluster qw(cfs_register_file cfs_lock_file cfs_read_file cfs_write_file);
use PVE::RESTHandler;
use PVE::RPCEnvironment;
use PVE::JSONSchema;
use PVE::Storage;
use PVE::Exception qw(raise_param_exc);
use PVE::VZDump;

use base qw(PVE::RESTHandler);

cfs_register_file ('vzdump', 
		   \&parse_vzdump_cron_config, 
		   \&write_vzdump_cron_config); 

PVE::JSONSchema::register_format('pve-day-of-week', \&verify_day_of_week);
sub verify_day_of_week {
    my ($value, $noerr) = @_;

    return $value if $value =~ m/^(mon|tue|wed|thu|fri|sat|sun)$/;

    return undef if $noerr;

    die "invalid day '$value'\n";
}


my $dowhash_to_dow = sub {
    my ($d, $num) = @_;

    my @da = ();
    push @da, $num ? 1 : 'mon' if $d->{mon};
    push @da, $num ? 2 : 'tue' if $d->{tue};
    push @da, $num ? 3 : 'wed' if $d->{wed};
    push @da, $num ? 4 : 'thu' if $d->{thu};
    push @da, $num ? 5 : 'fri' if $d->{fri};
    push @da, $num ? 6 : 'sat' if $d->{sat};
    push @da, $num ? 7 : 'sun' if $d->{sun};

    return join ',', @da;
};

# parse crontab style day of week
sub parse_dow {
    my ($dowstr, $noerr) = @_;

    my $dowmap = {mon => 1, tue => 2, wed => 3, thu => 4,
		  fri => 5, sat => 6, sun => 7};
    my $rdowmap = { '1' => 'mon', '2' => 'tue', '3' => 'wed', '4' => 'thu',
		    '5' => 'fri', '6' => 'sat', '7' => 'sun', '0' => 'sun'};

    my $res = {};

    $dowstr = '1,2,3,4,5,6,7' if $dowstr eq '*';

    foreach my $day (PVE::Tools::split_list($dowstr)) {
	if ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun)-(mon|tue|wed|thu|fri|sat|sun)$/i) {
	    for (my $i = $dowmap->{lc($1)}; $i <= $dowmap->{lc($2)}; $i++) {
		my $r = $rdowmap->{$i};
		$res->{$r} = 1;	
	    }
	} elsif ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun|[0-7])$/i) {
	    $day = $rdowmap->{$day} if $day =~ m/\d/;
	    $res->{lc($day)} = 1;
	} else {
	    return undef if $noerr;
	    die "unable to parse day of week '$dowstr'\n";
	}
    }

    return $res;
};

my $vzdump_propetries = {
    additionalProperties => 0,
    properties => PVE::VZDump::json_config_properties({}),
};

sub parse_vzdump_cron_config {
    my ($filename, $raw) = @_;

    my $jobs = []; # correct jobs

    my $ejobs = []; # mailfomerd lines

    my $jid = 1; # we start at 1
    
    my $digest = Digest::SHA1::sha1_hex(defined($raw) ? $raw : '');

    while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
	my $line = $1;

	next if $line =~ m/^\#/;
	next if $line =~ m/^\s*$/;
	next if $line =~ m/^PATH\s*=/; # we always overwrite path

	if ($line =~ m|^(\d+)\s+(\d+)\s+\*\s+\*\s+(\S+)\s+root\s+(/\S+/)?vzdump(\s+(.*))?$|) {
	    eval {
		my $minute = int($1);
		my $hour = int($2);
		my $dow = $3;
		my $param = $6;

		my $dowhash = parse_dow($dow, 1);
		die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;

		my $args = PVE::Tools::split_args($param);
		my $opts = PVE::JSONSchema::get_options($vzdump_propetries, $args, undef, undef, 'vmid');

		$opts->{id} = "$digest:$jid";
		$jid++;
		$opts->{starttime} = sprintf "%02d:%02d", $hour, $minute;
		$opts->{dow} = &$dowhash_to_dow($dowhash);

		push @$jobs, $opts;
	    };
	    my $err = $@;
	    if ($err) {
		syslog ('err', "parse error in '$filename': $err");
		push @$ejobs, { line => $line };
	    }
	} elsif ($line =~ m|^\S+\s+(\S+)\s+\S+\s+\S+\s+\S+\s+\S+\s+(\S.*)$|) {
	    syslog ('err', "warning: malformed line in '$filename'");
	    push @$ejobs, { line => $line };
	} else {
	    syslog ('err', "ignoring malformed line in '$filename'");
	}
    }

    my $res = {};
    $res->{digest} = $digest;
    $res->{jobs} = $jobs;
    $res->{ejobs} = $ejobs;

    return $res;
}

sub write_vzdump_cron_config {
    my ($filename, $cfg) = @_;

    my $out = "# cluster wide vzdump cron schedule\n";
    $out .= "# Atomatically generated file - do not edit\n\n";
    $out .= "PATH=\"/usr/sbin:/usr/bin:/sbin:/bin\"\n\n";

    my $jobs = $cfg->{jobs} || [];
    foreach my $job (@$jobs) {
	my $dh = parse_dow($job->{dow});
	my $dow;
	if ($dh->{mon} && $dh->{tue} && $dh->{wed} && $dh->{thu} &&
	    $dh->{fri} && $dh->{sat} && $dh->{sun}) {
	    $dow = '*';
	} else {
	    $dow = &$dowhash_to_dow($dh, 1);
	    $dow = '*' if !$dow;
	}

	my ($hour, $minute);

	die "no job start time specified\n" if !$job->{starttime};
	if ($job->{starttime} =~ m/^(\d{1,2}):(\d{1,2})$/) {
	    ($hour, $minute) = (int($1), int($2));
	    die "hour '$hour' out of range\n" if $hour < 0 || $hour > 23;
	    die "minute '$minute' out of range\n" if $minute < 0 || $minute > 59;
	} else {
	    die "unable to parse job start time\n";
	}

	my $param = "";
	foreach my $p (keys %$job) {
	    next if $p eq 'id' || $p eq 'vmid' || $p eq 'starttime' || $p eq 'dow';
	    my $v = $job->{$p};
	    $param .= " --$p " . PVE::Tools::shellquote($v) if defined($v) && $v ne '';
	}

	if ($job->{vmid}) {
	    $param .= " " . join(' ', PVE::Tools::split_list($job->{vmid}));
	}

	$out .= sprintf "$minute $hour * * %-11s root vzdump$param\n", $dow;
    }

    my $ejobs = $cfg->{ejobs} || [];
    foreach my $job (@$ejobs) {
	$out .= "$job->{line}\n" if $job->{line};
    }

    return $out;
}

__PACKAGE__->register_method({
    name => 'index', 
    path => '', 
    method => 'GET',
    description => "List vzdump backup schedule.",
    parameters => {
    	additionalProperties => 0,
	properties => {},
    },
    returns => {
	type => 'array',
	items => {
	    type => "object",
	    properties => {
		id => { type => 'string' },
	    },
	},
	links => [ { rel => 'child', href => "{id}" } ],
    },
    code => sub {
	my ($param) = @_;

	my $rpcenv = PVE::RPCEnvironment::get();
	my $user = $rpcenv->get_user();

	my $data = cfs_read_file('vzdump');

	my $res = $data->{jobs} || [];

	return $res;
    }});

__PACKAGE__->register_method({
    name => 'create_job', 
    path => '', 
    method => 'POST',
    protected => 1,
    description => "Create new vzdump backup job.",
    parameters => {
    	additionalProperties => 0,
	properties => PVE::VZDump::json_config_properties({
	    starttime => {
		type => 'string',
		description => "Job Start time.",
		pattern => '\d{1,2}:\d{1,2}',
		typetext => 'HH:MM',
	    },
	    dow => {
		type => 'string', format => 'pve-day-of-week-list',
		optional => 1,
		description => "Day of week selection.",
		default => 'mon,tue,wed,thu,fri,sat,sun',
	    },
       }),
    },
    returns => { type => 'null' },
    code => sub {
	my ($param) = @_;

	my $rpcenv = PVE::RPCEnvironment::get();
	my $user = $rpcenv->get_user();

	my $data = cfs_read_file('vzdump');

	$param->{dow} = 'mon,tue,wed,thu,fri,sat,sun' if !defined($param->{dow});

	$param->{all} = 1 if defined($param->{exclude});
	raise_param_exc({ all => "option conflicts with option 'vmid'"})
	    if $param->{all} && $param->{vmid};

	raise_param_exc({ vmid => "property is missing"})
	    if !$param->{all} && !$param->{vmid};

	push @{$data->{jobs}}, $param;

	cfs_write_file('vzdump', $data);

	return undef;
    }});

__PACKAGE__->register_method({
    name => 'read_job', 
    path => '{id}', 
    method => 'GET',
    description => "Read vzdump backup job definition.",
    parameters => {
    	additionalProperties => 0,
	properties => {
	    id => {
		type => 'string',
		description => "The job ID.",
		maxLength => 50,
	    }
	},
    },
    returns => {
	type => 'object',
    },
    code => sub {
	my ($param) = @_;

	my $rpcenv = PVE::RPCEnvironment::get();
	my $user = $rpcenv->get_user();

	my $data = cfs_read_file('vzdump');

	my $jobs = $data->{jobs} || [];

	foreach my $job (@$jobs) {
	    return $job if $job->{id} eq $param->{id};
	}

	raise_param_exc({ id => "No such job '$param->{id}'" });

    }});

__PACKAGE__->register_method({
    name => 'delete_job', 
    path => '{id}', 
    method => 'DELETE',
    description => "Delete vzdump backup job definition.",
    protected => 1,
    parameters => {
    	additionalProperties => 0,
	properties => {
	    id => {
		type => 'string',
		description => "The job ID.",
		maxLength => 50,
	    }
	},
    },
    returns => { type => 'null' },
    code => sub {
	my ($param) = @_;

	my $rpcenv = PVE::RPCEnvironment::get();
	my $user = $rpcenv->get_user();

	my $data = cfs_read_file('vzdump');

	my $jobs = $data->{jobs} || [];
	my $newjobs = [];

	my $found;
	foreach my $job (@$jobs) {
	    if ($job->{id} eq $param->{id}) {
		$found = 1;
	    } else {
		push @$newjobs, $job;
	    }
	}

	raise_param_exc({ id => "No such job '$param->{id}'" }) if !$found;

	$data->{jobs} = $newjobs;

	cfs_write_file('vzdump', $data);

	return undef;
    }});

__PACKAGE__->register_method({
    name => 'update_job', 
    path => '{id}', 
    method => 'PUT',
    protected => 1,
    description => "Update vzdump backup job definition.",
    parameters => {
    	additionalProperties => 0,
	properties => PVE::VZDump::json_config_properties({
	    id => {
		type => 'string',
		description => "The job ID.",
		maxLength => 50,
	    },
	    starttime => {
		type => 'string',
		description => "Job Start time.",
		pattern => '\d{1,2}:\d{1,2}',
		typetext => 'HH:MM',
	    },
	    dow => {
		type => 'string', format => 'pve-day-of-week-list',
		optional => 1,
		description => "Day of week selection.",
	    },
	    delete => {
		type => 'string', format => 'pve-configid-list',
		description => "A list of settings you want to delete.",
		optional => 1,
	    },
       }),
    },
    returns => { type => 'null' },
    code => sub {
	my ($param) = @_;

	my $rpcenv = PVE::RPCEnvironment::get();
	my $user = $rpcenv->get_user();

	my $data = cfs_read_file('vzdump');

	my $jobs = $data->{jobs} || [];

	die "no options specified\n" if !scalar(keys %$param);

	raise_param_exc({ all => "option conflicts with option 'vmid'"})
	    if $param->{all} && $param->{vmid};

	my $delete = extract_param($param, 'delete');

	foreach my $job (@$jobs) {
	    if ($job->{id} eq $param->{id}) {

		foreach my $k (PVE::Tools::split_list($delete)) {
		    if (!PVE::VZDump::option_exists($k)) {
			raise_param_exc({ delete => "unknown option '$k'" });
		    }

		    delete $job->{$k};
		}

		foreach my $k (keys %$param) {
		    $job->{$k} = $param->{$k};
		}

		$job->{all} = 1 if defined($job->{exclude});

		if ($param->{vmid}) {
		    delete $job->{all};
		    delete $job->{exclude};
		} elsif ($param->{all}) {
		    delete $job->{vmid};
		}

		raise_param_exc({ all => "option conflicts with option 'vmid'"})
		    if $job->{all} && $job->{vmid};

		raise_param_exc({ vmid => "property is missing"})
		    if !$job->{all} && !$job->{vmid};

		cfs_write_file('vzdump', $data);

		return undef;
	    }
	}

	raise_param_exc({ id => "No such job '$param->{id}'" });

    }});

1;
Commit	Line	Data
ac27b58d DM	1	package PVE::API2::Backup;
	2
	3	use strict;
	4	use warnings;
	5
	6	use PVE::SafeSyslog;
	7	use PVE::Tools qw(extract_param);
	8	use PVE::Cluster qw(cfs_register_file cfs_lock_file cfs_read_file cfs_write_file);
	9	use PVE::RESTHandler;
	10	use PVE::RPCEnvironment;
	11	use PVE::JSONSchema;
	12	use PVE::Storage;
	13	use PVE::Exception qw(raise_param_exc);
	14	use PVE::VZDump;
	15
	16	use base qw(PVE::RESTHandler);
	17
	18	cfs_register_file ('vzdump',
	19	\&parse_vzdump_cron_config,
	20	\&write_vzdump_cron_config);
	21
	22	PVE::JSONSchema::register_format('pve-day-of-week', \&verify_day_of_week);
	23	sub verify_day_of_week {
	24	my ($value, $noerr) = @_;
	25
	26	return $value if $value =~ m/^(mon\|tue\|wed\|thu\|fri\|sat\|sun)$/;
	27
	28	return undef if $noerr;
	29
	30	die "invalid day '$value'\n";
	31	}
	32
	33
	34	my $dowhash_to_dow = sub {
	35	my ($d, $num) = @_;
	36
	37	my @da = ();
	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};
	45
	46	return join ',', @da;
	47	};
	48
	49	# parse crontab style day of week
	50	sub parse_dow {
	51	my ($dowstr, $noerr) = @_;
	52
	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'};
	57
	58	my $res = {};
	59
	60	$dowstr = '1,2,3,4,5,6,7' if $dowstr eq '*';
	61
7625ea19	62	foreach my $day (PVE::Tools::split_list($dowstr)) {
ac27b58d DM	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};
	66	$res->{$r} = 1;
	67	}
	68	} elsif ($day =~ m/^(mon\|tue\|wed\|thu\|fri\|sat\|sun\|[0-7])$/i) {
	69	$day = $rdowmap->{$day} if $day =~ m/\d/;
	70	$res->{lc($day)} = 1;
	71	} else {
	72	return undef if $noerr;
	73	die "unable to parse day of week '$dowstr'\n";
	74	}
	75	}
	76
	77	return $res;
	78	};
	79
	80	my $vzdump_propetries = {
	81	additionalProperties => 0,
	82	properties => PVE::VZDump::json_config_properties({}),
	83	};
	84
	85	sub parse_vzdump_cron_config {
	86	my ($filename, $raw) = @_;
	87
	88	my $jobs = []; # correct jobs
	89
	90	my $ejobs = []; # mailfomerd lines
	91
	92	my $jid = 1; # we start at 1
	93
	94	my $digest = Digest::SHA1::sha1_hex(defined($raw) ? $raw : '');
	95
	96	while ($raw && $raw =~ s/^(.*?)(\n\|$)//) {
	97	my $line = $1;
	98
	99	next if $line =~ m/^\#/;
	100	next if $line =~ m/^\s*$/;
	101	next if $line =~ m/^PATH\s*=/; # we always overwrite path
	102
	103	if ($line =~ m\|^(\d+)\s+(\d+)\s+\\s+\\s+(\S+)\s+root\s+(/\S+/)?vzdump(\s+(.*))?$\|) {
	104	eval {
	105	my $minute = int($1);
	106	my $hour = int($2);
	107	my $dow = $3;
	108	my $param = $6;
	109
	110	my $dowhash = parse_dow($dow, 1);
	111	die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;
	112
063bb19b	113	my $args = PVE::Tools::split_args($param);
ac27b58d DM	114	my $opts = PVE::JSONSchema::get_options($vzdump_propetries, $args, undef, undef, 'vmid');
	115
	116	$opts->{id} = "$digest:$jid";
	117	$jid++;
7625ea19	118	$opts->{starttime} = sprintf "%02d:%02d", $hour, $minute;
ac27b58d DM	119	$opts->{dow} = &$dowhash_to_dow($dowhash);
	120
	121	push @$jobs, $opts;
	122	};
	123	my $err = $@;
	124	if ($err) {
	125	syslog ('err', "parse error in '$filename': $err");
	126	push @$ejobs, { line => $line };
	127	}
	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 };
	131	} else {
	132	syslog ('err', "ignoring malformed line in '$filename'");
	133	}
	134	}
	135
	136	my $res = {};
	137	$res->{digest} = $digest;
	138	$res->{jobs} = $jobs;
	139	$res->{ejobs} = $ejobs;
	140
	141	return $res;
	142	}
	143
	144	sub write_vzdump_cron_config {
	145	my ($filename, $cfg) = @_;
	146
	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";
	150
	151	my $jobs = $cfg->{jobs} \|\| [];
	152	foreach my $job (@$jobs) {
	153	my $dh = parse_dow($job->{dow});
	154	my $dow;
	155	if ($dh->{mon} && $dh->{tue} && $dh->{wed} && $dh->{thu} &&
	156	$dh->{fri} && $dh->{sat} && $dh->{sun}) {
	157	$dow = '*';
	158	} else {
	159	$dow = &$dowhash_to_dow($dh, 1);
	160	$dow = '*' if !$dow;
	161	}
	162
7625ea19 DM	163	my ($hour, $minute);
	164
	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;
	170	} else {
	171	die "unable to parse job start time\n";
	172	}
	173
ac27b58d DM	174	my $param = "";
ac27b58d DM	175	foreach my $p (keys %$job) {
7625ea19	176	next if $p eq 'id' \|\| $p eq 'vmid' \|\| $p eq 'starttime' \|\| $p eq 'dow';
063bb19b DM	177	my $v = $job->{$p};
063bb19b DM	178	$param .= " --$p " . PVE::Tools::shellquote($v) if defined($v) && $v ne '';
ac27b58d DM	179	}
ac27b58d DM	180
53c6bb6c DM	181	if ($job->{vmid}) {
	182	$param .= " " . join(' ', PVE::Tools::split_list($job->{vmid}));
	183	}
ac27b58d	184
7625ea19	185	$out .= sprintf "$minute $hour * * %-11s root vzdump$param\n", $dow;
ac27b58d DM	186	}
	187
	188	my $ejobs = $cfg->{ejobs} \|\| [];
	189	foreach my $job (@$ejobs) {
	190	$out .= "$job->{line}\n" if $job->{line};
	191	}
	192
	193	return $out;
	194	}
	195
	196	__PACKAGE__->register_method({
	197	name => 'index',
	198	path => '',
	199	method => 'GET',
	200	description => "List vzdump backup schedule.",
	201	parameters => {
	202	additionalProperties => 0,
	203	properties => {},
	204	},
	205	returns => {
	206	type => 'array',
	207	items => {
	208	type => "object",
	209	properties => {
	210	id => { type => 'string' },
	211	},
	212	},
	213	links => [ { rel => 'child', href => "{id}" } ],
	214	},
	215	code => sub {
	216	my ($param) = @_;
	217
	218	my $rpcenv = PVE::RPCEnvironment::get();
	219	my $user = $rpcenv->get_user();
	220
	221	my $data = cfs_read_file('vzdump');
	222
	223	my $res = $data->{jobs} \|\| [];
	224
	225	return $res;
	226	}});
	227
	228	__PACKAGE__->register_method({
	229	name => 'create_job',
	230	path => '',
	231	method => 'POST',
	232	protected => 1,
	233	description => "Create new vzdump backup job.",
	234	parameters => {
	235	additionalProperties => 0,
	236	properties => PVE::VZDump::json_config_properties({
7625ea19 DM	237	starttime => {
	238	type => 'string',
	239	description => "Job Start time.",
	240	pattern => '\d{1,2}:\d{1,2}',
	241	typetext => 'HH:MM',
ac27b58d DM	242	},
	243	dow => {
	244	type => 'string', format => 'pve-day-of-week-list',
	245	optional => 1,
	246	description => "Day of week selection.",
	247	default => 'mon,tue,wed,thu,fri,sat,sun',
	248	},
	249	}),
	250	},
	251	returns => { type => 'null' },
	252	code => sub {
	253	my ($param) = @_;
	254
	255	my $rpcenv = PVE::RPCEnvironment::get();
	256	my $user = $rpcenv->get_user();
	257
	258	my $data = cfs_read_file('vzdump');
	259
ac27b58d DM	260	$param->{dow} = 'mon,tue,wed,thu,fri,sat,sun' if !defined($param->{dow});
	261
	262	$param->{all} = 1 if defined($param->{exclude});
	263	raise_param_exc({ all => "option conflicts with option 'vmid'"})
	264	if $param->{all} && $param->{vmid};
	265
	266	raise_param_exc({ vmid => "property is missing"})
	267	if !$param->{all} && !$param->{vmid};
	268
	269	push @{$data->{jobs}}, $param;
	270
	271	cfs_write_file('vzdump', $data);
	272
	273	return undef;
	274	}});
	275
	276	__PACKAGE__->register_method({
	277	name => 'read_job',
	278	path => '{id}',
	279	method => 'GET',
	280	description => "Read vzdump backup job definition.",
	281	parameters => {
	282	additionalProperties => 0,
	283	properties => {
	284	id => {
	285	type => 'string',
	286	description => "The job ID.",
	287	maxLength => 50,
	288	}
	289	},
	290	},
	291	returns => {
	292	type => 'object',
	293	},
	294	code => sub {
	295	my ($param) = @_;
	296
	297	my $rpcenv = PVE::RPCEnvironment::get();
	298	my $user = $rpcenv->get_user();
	299
	300	my $data = cfs_read_file('vzdump');
	301
	302	my $jobs = $data->{jobs} \|\| [];
	303
	304	foreach my $job (@$jobs) {
	305	return $job if $job->{id} eq $param->{id};
	306	}
	307
	308	raise_param_exc({ id => "No such job '$param->{id}'" });
	309
	310	}});
	311
	312	__PACKAGE__->register_method({
	313	name => 'delete_job',
	314	path => '{id}',
	315	method => 'DELETE',
	316	description => "Delete vzdump backup job definition.",
	317	protected => 1,
	318	parameters => {
	319	additionalProperties => 0,
	320	properties => {
	321	id => {
	322	type => 'string',
	323	description => "The job ID.",
324	maxLength => 50,
325	}
326	},
327	},
328	returns => { type => 'null' },
329	code => sub {
330	my ($param) = @_;
331
332	my $rpcenv = PVE::RPCEnvironment::get();
333	my $user = $rpcenv->get_user();
334
335	my $data = cfs_read_file('vzdump');
336
337	my $jobs = $data->{jobs} \|\| [];
338	my $newjobs = [];
339
340	my $found;
341	foreach my $job (@$jobs) {
342	if ($job->{id} eq $param->{id}) {
343	$found = 1;
344	} else {
345	push @$newjobs, $job;
346	}
347	}
348
349	raise_param_exc({ id => "No such job '$param->{id}'" }) if !$found;
350
351	$data->{jobs} = $newjobs;
352
353	cfs_write_file('vzdump', $data);
354
355	return undef;
356	}});
357
358	__PACKAGE__->register_method({
359	name => 'update_job',
360	path => '{id}',
361	method => 'PUT',
362	protected => 1,
363	description => "Update vzdump backup job definition.",
364	parameters => {
365	additionalProperties => 0,
366	properties => PVE::VZDump::json_config_properties({
367	id => {
368	type => 'string',
369	description => "The job ID.",
370	maxLength => 50,
371	},
7625ea19 DM	372	starttime => {
	373	type => 'string',
	374	description => "Job Start time.",
	375	pattern => '\d{1,2}:\d{1,2}',
	376	typetext => 'HH:MM',
ac27b58d DM	377	},
	378	dow => {
	379	type => 'string', format => 'pve-day-of-week-list',
	380	optional => 1,
	381	description => "Day of week selection.",
	382	},
53c6bb6c DM	383	delete => {
	384	type => 'string', format => 'pve-configid-list',
	385	description => "A list of settings you want to delete.",
	386	optional => 1,
	387	},
ac27b58d DM	388	}),
	389	},
	390	returns => { type => 'null' },
	391	code => sub {
	392	my ($param) = @_;
	393
	394	my $rpcenv = PVE::RPCEnvironment::get();
	395	my $user = $rpcenv->get_user();
	396
	397	my $data = cfs_read_file('vzdump');
	398
	399	my $jobs = $data->{jobs} \|\| [];
	400
53c6bb6c DM	401	die "no options specified\n" if !scalar(keys %$param);
53c6bb6c DM	402
ac27b58d DM	403	raise_param_exc({ all => "option conflicts with option 'vmid'"})
	404	if $param->{all} && $param->{vmid};
	405
53c6bb6c DM	406	my $delete = extract_param($param, 'delete');
53c6bb6c DM	407
ac27b58d DM	408	foreach my $job (@$jobs) {
	409	if ($job->{id} eq $param->{id}) {
	410
53c6bb6c DM	411	foreach my $k (PVE::Tools::split_list($delete)) {
	412	if (!PVE::VZDump::option_exists($k)) {
	413	raise_param_exc({ delete => "unknown option '$k'" });
	414	}
	415
	416	delete $job->{$k};
	417	}
	418
ac27b58d DM	419	foreach my $k (keys %$param) {
	420	$job->{$k} = $param->{$k};
	421	}
	422
	423	$job->{all} = 1 if defined($job->{exclude});
	424
	425	if ($param->{vmid}) {
	426	delete $job->{all};
	427	delete $job->{exclude};
	428	} elsif ($param->{all}) {
	429	delete $job->{vmid};
	430	}
	431
	432	raise_param_exc({ all => "option conflicts with option 'vmid'"})
	433	if $job->{all} && $job->{vmid};
	434
	435	raise_param_exc({ vmid => "property is missing"})
	436	if !$job->{all} && !$job->{vmid};
	437
	438	cfs_write_file('vzdump', $data);
	439
	440	return undef;
	441	}
	442	}
	443
	444	raise_param_exc({ id => "No such job '$param->{id}'" });
	445
	446	}});
	447
	448	1;