[pve-storage.git] / PVE / API2 / Storage / Content.pm

package PVE::API2::Storage::Content;

use strict;
use warnings;

use PVE::SafeSyslog;
use PVE::Cluster qw(cfs_read_file);
use PVE::Storage;
use PVE::INotify;
use PVE::Exception qw(raise_param_exc);
use PVE::RPCEnvironment;
use PVE::RESTHandler;
use PVE::JSONSchema qw(get_standard_option);

use base qw(PVE::RESTHandler);

my @ctypes = qw(images vztmpl iso backup);

__PACKAGE__->register_method ({
    name => 'index', 
    path => '',
    method => 'GET',
    description => "List storage content.",
    permissions => { 
	check => ['perm', '/storage/{storage}', ['Datastore.Audit', 'Datastore.AllocateSpace'], any => 1],
    },
    protected => 1,
    proxyto => 'node',
    parameters => {
    	additionalProperties => 0,
	properties => { 
	    node => get_standard_option('pve-node'),
	    storage => get_standard_option('pve-storage-id'),
	    content => { 
		description => "Only list content of this type.",
		type => 'string', format => 'pve-storage-content',
		optional => 1,
	    },
	    vmid => get_standard_option
		('pve-vmid', { 
		    description => "Only list images for this VM",
		    optional => 1,		
		 }),
	},
    },
    returns => {
	type => 'array',
	items => {
	    type => "object",
	    properties => { 
		volid => { 
		    type => 'string' 
		} 
	    },
	},
	links => [ { rel => 'child', href => "{volid}" } ],
    },
    code => sub {
	my ($param) = @_;

	my $cts = $param->{content} ? [ $param->{content} ] : [ @ctypes ];

	my $storeid = $param->{storage};

	my $cfg = cfs_read_file("storage.cfg");

	my $scfg = PVE::Storage::storage_config ($cfg, $storeid);

	my $res = [];
	foreach my $ct (@$cts) {
	    my $data;
	    if ($ct eq 'images' || defined($param->{vmid})) {
		$data = PVE::Storage::vdisk_list ($cfg, $storeid, $param->{vmid});
	    } elsif ($ct eq 'iso') {
		$data = PVE::Storage::template_list ($cfg, $storeid, 'iso');
	    } elsif ($ct eq 'vztmpl') {
		$data = PVE::Storage::template_list ($cfg, $storeid, 'vztmpl');
	    } elsif ($ct eq 'backup') {
		$data = PVE::Storage::template_list ($cfg, $storeid, 'backup');
	    }

	    next if !$data || !$data->{$storeid};

	    foreach my $item (@{$data->{$storeid}}) {
		$item->{content} = $ct;
		push @$res, $item;
	    }
	}

	return $res;    
    }});

__PACKAGE__->register_method ({
    name => 'create', 
    path => '',
    method => 'POST',
    description => "Allocate disk images.",
    permissions => { 
	check => ['perm', '/storage/{storage}', ['Datastore.AllocateSpace']],
    },
    protected => 1,
    proxyto => 'node',
    parameters => {
    	additionalProperties => 0,
	properties => { 
	    node => get_standard_option('pve-node'),
	    storage => get_standard_option('pve-storage-id'),
	    filename => { 
		description => "The name of the file to create.",
		type => 'string',
	    },
	    vmid => get_standard_option('pve-vmid', { description => "Specify owner VM" } ),
	    size => {
		description => "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)",
		type => 'string',
		pattern => '\d+[MG]?',
	    },
	    'format' => {
		type => 'string',
		enum => ['raw', 'qcow2'],
		requires => 'size',
		optional => 1,
	    },
	},
    },
    returns => {
	description => "Volume identifier",
	type => 'string',
    },
    code => sub {
	my ($param) = @_;

	my $storeid = $param->{storage};
	my $name = $param->{filename};
	my $sizestr = $param->{size};

	my $size;
	if ($sizestr =~ m/^\d+$/) {
	    $size = $sizestr;
	} elsif ($sizestr =~ m/^(\d+)M$/) {
	    $size = $1 * 1024;
	} elsif ($sizestr =~ m/^(\d+)G$/) {
	    $size = $1 * 1024 * 1024;
	} else {
	    raise_param_exc({ size => "unable to parse size '$sizestr'" });
	}

	# extract FORMAT from name
	if ($name =~ m/\.(raw|qcow2)$/) {
	    my $fmt = $1;

	    raise_param_exc({ format => "different storage formats ($param->{format} != $fmt)" }) 
		if $param->{format} && $param->{format} ne $fmt;

	    $param->{format} = $fmt;
	}

	my $cfg = cfs_read_file('storage.cfg');
    
	my $volid = PVE::Storage::vdisk_alloc ($cfg, $storeid, $param->{vmid}, 
					       $param->{format}, 
					       $name, $size);

	return $volid;
    }});

# we allow to pass volume names (without storage prefix) if the storage
# is specified as separate parameter.
my $real_volume_id = sub {
    my ($storeid, $volume) = @_;

    my $volid;

    if ($volume =~ m/:/) {
	eval {
	    my ($sid, $volname) = PVE::Storage::parse_volume_id ($volume);
	    raise_param_exc({ storage => "storage ID missmatch" }) 
		if $storeid && $sid ne $storeid;
	    $volid = $volume;
	};
	raise_param_exc({ volume => $@}) if $@; 
	   
    } else {
	raise_param_exc({ volume => "no storage speficied - incomplete volume ID" }) 
	    if !$storeid;
	
	$volid = "$storeid:$volume";
    }

    return $volid;
};

__PACKAGE__->register_method ({
    name => 'info',
    path => '{volume}',
    method => 'GET',
    description => "Get volume attributes",
    permissions => { 
	check => ['perm', '/storage/{storage}', ['Datastore.Audit', 'Datastore.AllocateSpace'], any => 1],
    },
    protected => 1,
    proxyto => 'node',
    parameters => {
    	additionalProperties => 0,
	properties => { 
	    node => get_standard_option('pve-node'),
	    storage => get_standard_option('pve-storage-id', { optional => 1 }),
	    volume => {
		description => "Volume identifier",
		type => 'string', 
	    },
	},
    },
    returns => { type => 'object' },
    code => sub {
	my ($param) = @_;

	my $volid = &$real_volume_id($param->{storage}, $param->{volume});

	my $cfg = cfs_read_file('storage.cfg');

	my $path = PVE::Storage::path($cfg, $volid);
	my ($size, $format, $used) = PVE::Storage::file_size_info ($path);

	# fixme: return more attributes?
	return {
	    path => $path,
	    size => $size,
            used => $used,
	};
    }});

__PACKAGE__->register_method ({
    name => 'delete',
    path => '{volume}',
    method => 'DELETE',
    description => "Delete volume",
    permissions => { 
	check => ['perm', '/storage/{storage}', ['Datastore.AllocateSpace']],
    },
    protected => 1,
    proxyto => 'node',
    parameters => {
    	additionalProperties => 0,
	properties => { 
	    node => get_standard_option('pve-node'),
	    storage => get_standard_option('pve-storage-id', { optional => 1}),
	    volume => {
		description => "Volume identifier",
		type => 'string', 
	    },
	},
    },
    returns => { type => 'null' },
    code => sub {
	my ($param) = @_;

	my $volid = &$real_volume_id($param->{storage}, $param->{volume});
	
	my $cfg = cfs_read_file('storage.cfg');

	PVE::Storage::vdisk_free ($cfg, $volid);

	return undef;
    }});

__PACKAGE__->register_method ({
    name => 'copy',
    path => '{volume}',
    method => 'POST',
    description => "Copy a volume. This is experimental code - do not use.",
    protected => 1,
    proxyto => 'node',
    parameters => {
    	additionalProperties => 0,
	properties => { 
	    node => get_standard_option('pve-node'),
	    storage => get_standard_option('pve-storage-id', { optional => 1}),
	    volume => {
		description => "Source volume identifier",
		type => 'string', 
	    },
	    target => {
		description => "Target volume identifier",
		type => 'string', 
	    },
	    target_node => get_standard_option('pve-node',  { 
		description => "Target node. Default is local node.",
		optional => 1,
	    }),
	},
    },
    returns => { 
	type => 'string',
    },
    code => sub {
	my ($param) = @_;

	my $rpcenv = PVE::RPCEnvironment::get();

	my $user = $rpcenv->get_user();

	my $target_node = $param->{target_node} || PVE::INotify::nodename();
	# pvesh examples
	# cd /nodes/localhost/storage/local/content
	# pve:/> create local:103/vm-103-disk-1.raw -target local:103/vm-103-disk-2.raw
	# pve:/> create 103/vm-103-disk-1.raw -target 103/vm-103-disk-3.raw

	my $src_volid = &$real_volume_id($param->{storage}, $param->{volume});
	my $dst_volid = &$real_volume_id($param->{storage}, $param->{target});

	print "DEBUG: COPY $src_volid TO $dst_volid\n";

	my $cfg = cfs_read_file('storage.cfg');

	# do all parameter checks first

	# then do all short running task (to raise errors befor we go to background)

	# then start the worker task
	my $worker = sub  {
	    my $upid = shift;

	    print "DEBUG: starting worker $upid\n";

	    my ($target_sid, $target_volname) = PVE::Storage::parse_volume_id($dst_volid);
	    #my $target_ip = PVE::Cluster::remote_node_ip($target_node);

	    # you need to get this working (fails currently, because storage_migrate() uses
	    # ssh to connect to local host (which is not needed
	    PVE::Storage::storage_migrate($cfg, $src_volid, $target_node, $target_sid, $target_volname);

	    print "DEBUG: end worker $upid\n";

	};

	return $rpcenv->fork_worker('imgcopy', undef, $user, $worker);
    }});

1;
Commit	Line	Data
b6cf0a66 DM	1	package PVE::API2::Storage::Content;
	2
	3	use strict;
	4	use warnings;
	5
	6	use PVE::SafeSyslog;
	7	use PVE::Cluster qw(cfs_read_file);
	8	use PVE::Storage;
	9	use PVE::INotify;
	10	use PVE::Exception qw(raise_param_exc);
	11	use PVE::RPCEnvironment;
	12	use PVE::RESTHandler;
	13	use PVE::JSONSchema qw(get_standard_option);
	14
	15	use base qw(PVE::RESTHandler);
	16
	17	my @ctypes = qw(images vztmpl iso backup);
	18
	19	__PACKAGE__->register_method ({
	20	name => 'index',
	21	path => '',
	22	method => 'GET',
	23	description => "List storage content.",
5f642f73 DM	24	permissions => {
	25	check => ['perm', '/storage/{storage}', ['Datastore.Audit', 'Datastore.AllocateSpace'], any => 1],
	26	},
b6cf0a66 DM	27	protected => 1,
	28	proxyto => 'node',
	29	parameters => {
	30	additionalProperties => 0,
	31	properties => {
	32	node => get_standard_option('pve-node'),
	33	storage => get_standard_option('pve-storage-id'),
	34	content => {
	35	description => "Only list content of this type.",
	36	type => 'string', format => 'pve-storage-content',
	37	optional => 1,
	38	},
	39	vmid => get_standard_option
	40	('pve-vmid', {
	41	description => "Only list images for this VM",
	42	optional => 1,
	43	}),
	44	},
	45	},
	46	returns => {
	47	type => 'array',
	48	items => {
	49	type => "object",
	50	properties => {
	51	volid => {
	52	type => 'string'
	53	}
	54	},
	55	},
	56	links => [ { rel => 'child', href => "{volid}" } ],
	57	},
	58	code => sub {
	59	my ($param) = @_;
	60
	61	my $cts = $param->{content} ? [ $param->{content} ] : [ @ctypes ];
	62
	63	my $storeid = $param->{storage};
	64
	65	my $cfg = cfs_read_file("storage.cfg");
	66
	67	my $scfg = PVE::Storage::storage_config ($cfg, $storeid);
	68
	69	my $res = [];
	70	foreach my $ct (@$cts) {
	71	my $data;
568de3d1	72	if ($ct eq 'images' \|\| defined($param->{vmid})) {
b6cf0a66 DM	73	$data = PVE::Storage::vdisk_list ($cfg, $storeid, $param->{vmid});
b6cf0a66 DM	74	} elsif ($ct eq 'iso') {
568de3d1	75	$data = PVE::Storage::template_list ($cfg, $storeid, 'iso');
b6cf0a66	76	} elsif ($ct eq 'vztmpl') {
568de3d1	77	$data = PVE::Storage::template_list ($cfg, $storeid, 'vztmpl');
b6cf0a66	78	} elsif ($ct eq 'backup') {
568de3d1	79	$data = PVE::Storage::template_list ($cfg, $storeid, 'backup');
b6cf0a66 DM	80	}
	81
	82	next if !$data \|\| !$data->{$storeid};
	83
	84	foreach my $item (@{$data->{$storeid}}) {
87191fbe	85	$item->{content} = $ct;
b6cf0a66 DM	86	push @$res, $item;
	87	}
	88	}
	89
	90	return $res;
	91	}});
	92
	93	__PACKAGE__->register_method ({
	94	name => 'create',
	95	path => '',
	96	method => 'POST',
	97	description => "Allocate disk images.",
5f642f73 DM	98	permissions => {
	99	check => ['perm', '/storage/{storage}', ['Datastore.AllocateSpace']],
	100	},
b6cf0a66 DM	101	protected => 1,
	102	proxyto => 'node',
	103	parameters => {
	104	additionalProperties => 0,
	105	properties => {
	106	node => get_standard_option('pve-node'),
	107	storage => get_standard_option('pve-storage-id'),
	108	filename => {
03f03009	109	description => "The name of the file to create.",
b6cf0a66 DM	110	type => 'string',
	111	},
	112	vmid => get_standard_option('pve-vmid', { description => "Specify owner VM" } ),
	113	size => {
	114	description => "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)",
	115	type => 'string',
	116	pattern => '\d+[MG]?',
	117	},
	118	'format' => {
	119	type => 'string',
	120	enum => ['raw', 'qcow2'],
	121	requires => 'size',
	122	optional => 1,
	123	},
	124	},
	125	},
	126	returns => {
	127	description => "Volume identifier",
	128	type => 'string',
	129	},
	130	code => sub {
	131	my ($param) = @_;
	132
	133	my $storeid = $param->{storage};
	134	my $name = $param->{filename};
	135	my $sizestr = $param->{size};
	136
	137	my $size;
	138	if ($sizestr =~ m/^\d+$/) {
	139	$size = $sizestr;
	140	} elsif ($sizestr =~ m/^(\d+)M$/) {
	141	$size = $1 * 1024;
	142	} elsif ($sizestr =~ m/^(\d+)G$/) {
	143	$size = $1 * 1024 * 1024;
	144	} else {
	145	raise_param_exc({ size => "unable to parse size '$sizestr'" });
	146	}
	147
	148	# extract FORMAT from name
	149	if ($name =~ m/\.(raw\|qcow2)$/) {
	150	my $fmt = $1;
	151
	152	raise_param_exc({ format => "different storage formats ($param->{format} != $fmt)" })
	153	if $param->{format} && $param->{format} ne $fmt;
	154
	155	$param->{format} = $fmt;
	156	}
	157
	158	my $cfg = cfs_read_file('storage.cfg');
	159
	160	my $volid = PVE::Storage::vdisk_alloc ($cfg, $storeid, $param->{vmid},
	161	$param->{format},
	162	$name, $size);
	163
	164	return $volid;
	165	}});
	166
	167	# we allow to pass volume names (without storage prefix) if the storage
	168	# is specified as separate parameter.
	169	my $real_volume_id = sub {
	170	my ($storeid, $volume) = @_;
	171
	172	my $volid;
	173
174	if ($volume =~ m/:/) {
175	eval {
176	my ($sid, $volname) = PVE::Storage::parse_volume_id ($volume);
177	raise_param_exc({ storage => "storage ID missmatch" })
178	if $storeid && $sid ne $storeid;
179	$volid = $volume;
180	};
181	raise_param_exc({ volume => $@}) if $@;
182
183	} else {
184	raise_param_exc({ volume => "no storage speficied - incomplete volume ID" })
185	if !$storeid;
186
187	$volid = "$storeid:$volume";
188	}
189
190	return $volid;
191	};
192
193	__PACKAGE__->register_method ({
194	name => 'info',
195	path => '{volume}',
196	method => 'GET',
197	description => "Get volume attributes",
5f642f73 DM	198	permissions => {
	199	check => ['perm', '/storage/{storage}', ['Datastore.Audit', 'Datastore.AllocateSpace'], any => 1],
	200	},
b6cf0a66 DM	201	protected => 1,
	202	proxyto => 'node',
	203	parameters => {
	204	additionalProperties => 0,
	205	properties => {
	206	node => get_standard_option('pve-node'),
	207	storage => get_standard_option('pve-storage-id', { optional => 1 }),
	208	volume => {
	209	description => "Volume identifier",
	210	type => 'string',
	211	},
	212	},
	213	},
	214	returns => { type => 'object' },
	215	code => sub {
	216	my ($param) = @_;
	217
	218	my $volid = &$real_volume_id($param->{storage}, $param->{volume});
	219
	220	my $cfg = cfs_read_file('storage.cfg');
	221
	222	my $path = PVE::Storage::path($cfg, $volid);
	223	my ($size, $format, $used) = PVE::Storage::file_size_info ($path);
	224
	225	# fixme: return more attributes?
	226	return {
	227	path => $path,
	228	size => $size,
	229	used => $used,
	230	};
	231	}});
	232
	233	__PACKAGE__->register_method ({
	234	name => 'delete',
	235	path => '{volume}',
	236	method => 'DELETE',
	237	description => "Delete volume",
5f642f73 DM	238	permissions => {
	239	check => ['perm', '/storage/{storage}', ['Datastore.AllocateSpace']],
	240	},
b6cf0a66 DM	241	protected => 1,
	242	proxyto => 'node',
	243	parameters => {
	244	additionalProperties => 0,
	245	properties => {
	246	node => get_standard_option('pve-node'),
	247	storage => get_standard_option('pve-storage-id', { optional => 1}),
	248	volume => {
	249	description => "Volume identifier",
	250	type => 'string',
	251	},
	252	},
	253	},
	254	returns => { type => 'null' },
	255	code => sub {
	256	my ($param) = @_;
	257
	258	my $volid = &$real_volume_id($param->{storage}, $param->{volume});
	259
	260	my $cfg = cfs_read_file('storage.cfg');
	261
	262	PVE::Storage::vdisk_free ($cfg, $volid);
	263
	264	return undef;
	265	}});
	266
883eeea6 DM	267	__PACKAGE__->register_method ({
	268	name => 'copy',
	269	path => '{volume}',
	270	method => 'POST',
5f642f73	271	description => "Copy a volume. This is experimental code - do not use.",
883eeea6 DM	272	protected => 1,
	273	proxyto => 'node',
	274	parameters => {
	275	additionalProperties => 0,
	276	properties => {
	277	node => get_standard_option('pve-node'),
	278	storage => get_standard_option('pve-storage-id', { optional => 1}),
	279	volume => {
	280	description => "Source volume identifier",
	281	type => 'string',
	282	},
	283	target => {
	284	description => "Target volume identifier",
	285	type => 'string',
	286	},
	287	target_node => get_standard_option('pve-node', {
	288	description => "Target node. Default is local node.",
	289	optional => 1,
	290	}),
	291	},
	292	},
	293	returns => {
	294	type => 'string',
	295	},
	296	code => sub {
	297	my ($param) = @_;
	298
	299	my $rpcenv = PVE::RPCEnvironment::get();
	300
	301	my $user = $rpcenv->get_user();
	302
	303	my $target_node = $param->{target_node} \|\| PVE::INotify::nodename();
	304	# pvesh examples
	305	# cd /nodes/localhost/storage/local/content
	306	# pve:/> create local:103/vm-103-disk-1.raw -target local:103/vm-103-disk-2.raw
	307	# pve:/> create 103/vm-103-disk-1.raw -target 103/vm-103-disk-3.raw
	308
	309	my $src_volid = &$real_volume_id($param->{storage}, $param->{volume});
	310	my $dst_volid = &$real_volume_id($param->{storage}, $param->{target});
	311
	312	print "DEBUG: COPY $src_volid TO $dst_volid\n";
	313
	314	my $cfg = cfs_read_file('storage.cfg');
	315
	316	# do all parameter checks first
	317
	318	# then do all short running task (to raise errors befor we go to background)
	319
	320	# then start the worker task
	321	my $worker = sub {
	322	my $upid = shift;
	323
	324	print "DEBUG: starting worker $upid\n";
	325
	326	my ($target_sid, $target_volname) = PVE::Storage::parse_volume_id($dst_volid);
	327	#my $target_ip = PVE::Cluster::remote_node_ip($target_node);
	328
	329	# you need to get this working (fails currently, because storage_migrate() uses
	330	# ssh to connect to local host (which is not needed
	331	PVE::Storage::storage_migrate($cfg, $src_volid, $target_node, $target_sid, $target_volname);
	332
	333	print "DEBUG: end worker $upid\n";
	334
	335	};
336
337	return $rpcenv->fork_worker('imgcopy', undef, $user, $worker);
338	}});
339
b6cf0a66	340	1;