[pmg-api.git] / bin / pmgsh

#!/usr/bin/perl

use strict;
use warnings;
use Term::ReadLine;
use File::Basename;
use Getopt::Long;
use HTTP::Status qw(:constants :is status_message);
use Text::ParseWords;

use PVE::JSONSchema;
use PVE::SafeSyslog;
use PVE::INotify;
use PVE::CLIHandler;

use PMG::RESTEnvironment;

use PMG::Ticket;
use PMG::Cluster;
use PMG::API2;

use JSON;

PMG::RESTEnvironment->setup_default_cli_env();

my $rpcenv = PMG::RESTEnvironment->get();

my $ticket = PMG::Ticket::assemble_ticket('root@pam');

my $logid = $ENV{PVE_LOG_ID} || 'pmgsh';
initlog($logid);

my $basedir = '/api2/json';

my $cdir = '';

sub print_usage {
    my $msg = shift;

    print STDERR "ERROR: $msg\n" if $msg;
    print STDERR "USAGE: pmgsh [verifyapi]\n";
    print STDERR "       pmgsh CMD [OPTIONS]\n";

}

my $disable_proxy = 0;
my $opt_nooutput = 0;

my $cmd = shift;

my $optmatch;
do {
    $optmatch = 0;
    if ($cmd) {
	if ($cmd eq '--noproxy') {
	    $cmd = shift;
	    $disable_proxy = 1;
	    $optmatch = 1;
	} elsif ($cmd eq '--nooutput') {
	    # we use this when starting task in CLI (suppress printing upid)
	    $cmd = shift;
	    $opt_nooutput = 1;
	    $optmatch = 1;
	}
    }
} while ($optmatch);

if ($cmd) {
    if ($cmd eq 'verifyapi') {
	PVE::RESTHandler::validate_method_schemas();
	exit 0;
    } elsif ($cmd eq 'ls' || $cmd eq 'get' || $cmd eq 'create' || 
	     $cmd eq 'set' || $cmd eq 'delete' ||$cmd eq 'help' ) {
	pmg_command([ $cmd, @ARGV],  $opt_nooutput);
	exit(0);
    } else {
	print_usage ("unknown command '$cmd'");
	exit (-1);
    }
}

if (scalar (@ARGV) != 0) {
    print_usage();
    exit(-1);
}

print "entering PMG shell - type 'help' for help\n";

my $term = new Term::ReadLine('pmgsh');
my $attribs = $term->Attribs;

sub complete_path {
    my($text) = @_;

    my ($dir, undef, $rest) = $text =~ m|^(.*/)?(([^/]*))?$|;
    my $path = abs_path($cdir, $dir);

    my @res = ();

    my $di = dir_info($path);
    if (my $children = $di->{children}) {
	foreach my $c (@$children) {
	    if ($c =~ /^\Q$rest/) {
		my $new =  $dir ? "$dir$c" : $c;
		push @res, $new; 
	    }
	}
    }

    if (scalar(@res) == 0) {
	return undef;
    } elsif (scalar(@res) == 1) {
	return ($res[0], $res[0], "$res[0]/");
    } 

    # lcd : lowest common denominator
    my $lcd = '';
    my $tmp = $res[0];
    for (my $i = 1; $i <= length($tmp); $i++) {
	my $found = 1;
	foreach my $p (@res) {
	    if (substr($tmp, 0, $i) ne substr($p, 0, $i)) {
		$found = 0;
		last;
	    }
	}
	if ($found) {
	    $lcd = substr($tmp, 0, $i);
	} else {
	    last;
	}
    }

    return ($lcd, @res);
};

# just to avoid an endless loop (called by attempted_completion_function)
$attribs->{completion_entry_function} = sub {
    my($text, $state) = @_;
    return undef;
};

$attribs->{attempted_completion_function} = sub {
    my ($text, $line, $start) = @_;

    my $prefix = substr($line, 0, $start);
    if ($prefix =~ /^\s*$/) { # first word (command completeion)
	$attribs->{completion_word} = [qw(help ls cd get set create delete quit)];
	return $term->completion_matches($text, $attribs->{list_completion_function});
    }

    if ($prefix =~ /^\s*\S+\s+$/) { # second word (path completion)
	return complete_path($text);
    }

    return ();   
};

sub abs_path {
    my ($current, $path) = @_;

    my $ret = $current;

    return $current if !defined($path);

    $ret = '' if $path =~ m|^\/|;

    foreach my $d (split (/\/+/ , $path)) {
	if ($d eq '.') {
	    next;
	} elsif ($d eq '..') {
	    $ret = dirname($ret);
	    $ret = '' if $ret eq '.';
	} else {
	    $ret = "$ret/$d";
	}
    }

    $ret =~ s|\/+|\/|g;
    $ret =~ s|^\/||;
    $ret =~ s|\/$||;

    return $ret;
}

my $param_mapping = sub {
    my ($name) = @_;

    return [ PVE::CLIHandler::get_standard_mapping('pve-password') ];
};

sub reverse_map_cmd {
    my $method = shift;

    my $mmap = {
	GET => 'get',
	PUT => 'set',
	POST => 'create',
	DELETE => 'delete',
    };

    my $cmd = $mmap->{$method};

    die "got strange value for method ('$method') - internal error" if !$cmd;

    return $cmd;
}

sub map_cmd {
    my $cmd = shift;

    my $mmap = {
	create => 'POST',
	set => 'PUT',
	get => 'GET',
	ls => 'GET',
	delete => 'DELETE',
    };

    my $method = $mmap->{$cmd};

    die "unable to map method" if !$method;

    return $method;
}

sub check_proxyto {
    my ($info, $uri_param) = @_;

    if ($info->{proxyto}) {
	my $pn = $info->{proxyto};
	my $node;
	if ($pn eq 'master') {
	    $node = PMG::Cluster::get_master_node();
	} else {
	    $node = $uri_param->{$pn};
	    die "proxy parameter '$pn' does not exists" if !$node;
	}

	if ($node ne 'localhost' && ($node ne PVE::INotify::nodename())) {
	    die "proxy loop detected - aborting\n" if $disable_proxy;
	    my $remip = PMG::Cluster::remote_node_ip($node);
	    return ($node, $remip);
	}
    }

    return undef;
}

sub proxy_handler {
    my ($node, $remip, $dir, $cmd, $args) = @_;

    my $remcmd = ['ssh', '-o', 'BatchMode=yes', "root\@$remip", 
	       'pmgsh', '--noproxy', $cmd, $dir, @$args];

    system(@$remcmd) == 0 || die "proxy handler failed\n";
}

sub call_method {
    my ($dir, $cmd, $args, $nooutput) = @_;

    my $method = map_cmd($cmd);

    my $uri_param = {};
    my ($handler, $info) = PMG::API2->find_handler($method, $dir, $uri_param);
    if (!$handler || !$info) {
	die "no '$cmd' handler for '$dir'\n";
    }

    my ($node, $remip) = check_proxyto($info, $uri_param);
    return proxy_handler($node, $remip, $dir, $cmd, $args) if $node;

    my $data = $handler->cli_handler("$cmd $dir", $info->{name}, $args, [], $uri_param, $param_mapping);

    return if $nooutput;

    warn "200 OK\n"; # always print OK status if successful

    if ($info && $info->{returns} && $info->{returns}->{type}) {
	my $rtype = $info->{returns}->{type};

	return if $rtype eq 'null';

	if ($rtype eq 'string') {
	    print $data if $data;
	    return;
	}
    }

    print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });

    return;
}

sub find_resource_methods {
    my ($path, $ihash) = @_;

    for my $method (qw(GET POST PUT DELETE)) {
	my $uri_param = {};
	my $path_match;
	my ($handler, $info) = PMG::API2->find_handler($method, $path, $uri_param, \$path_match);
	if ($handler && $info && !$ihash->{$info}) {
	    $ihash->{$info} = {
		path => $path_match,
		handler => $handler, 
		info => $info, 
		uri_param => $uri_param,
	    };
	}
    }
}

sub print_help {
    my ($path, $opts) = @_;

    my $ihash = {};

    find_resource_methods($path, $ihash);

    if (!scalar(keys(%$ihash))) {
	die "no such resource\n";
    }

    my $di = dir_info($path);
    if (my $children = $di->{children}) {
	foreach my $c (@$children) {
	    my $cp = abs_path($path, $c);
	    find_resource_methods($cp, $ihash);
	}
    }

    foreach my $mi (sort { $a->{path} cmp $b->{path} } values %$ihash) {
	my $method = $mi->{info}->{method};

	# we skip index methods for now.
	next if ($method eq 'GET') && PVE::JSONSchema::method_get_child_link($mi->{info});

	my $path = $mi->{path};
	$path =~ s|/+$||; # remove trailing slash

	my $cmd = reverse_map_cmd($method);

	print $mi->{handler}->usage_str($mi->{info}->{name}, "$cmd $path", [], $mi->{uri_param}, 
					$opts->{verbose} ? 'full' : 'short', 1);
	print "\n\n" if $opts->{verbose};
    }
 
};

sub resource_cap {
    my ($path) = @_;

    my $res = '';

    my ($handler, $info) = PMG::API2->find_handler('GET', $path);
    if (!($handler && $info)) {
	$res .= '--';
    } else {
	if (PVE::JSONSchema::method_get_child_link($info)) {
	    $res .= 'Dr';
	} else {
	    $res .= '-r';
	}
    }

    ($handler, $info) = PMG::API2->find_handler('PUT', $path);
    if (!($handler && $info)) {
	$res .= '-';
    } else {
	$res .= 'w';
    }

    ($handler, $info) = PMG::API2->find_handler('POST', $path);
    if (!($handler && $info)) {
	$res .= '-';
    } else {
	$res .= 'c';
    }

    ($handler, $info) = PMG::API2->find_handler('DELETE', $path);
    if (!($handler && $info)) {
	$res .= '-';
    } else {
	$res .= 'd';
    }

    return $res;
}

sub extract_children {
    my ($lnk, $data) = @_;

    my $res = [];

    return $res if !($lnk && $data);

    my $href = $lnk->{href};
    if ($href =~ m/^\{(\S+)\}$/) {
	my $prop = $1;

	foreach my $elem (sort {$a->{$prop} cmp $b->{$prop}} @$data) {
	    next if !ref($elem);
	    my $value = $elem->{$prop};
	    push @$res, $value;
	}
    }

    return $res;
}

sub dir_info {
    my ($path) = @_;

    my $res = { path => $path };
    my $uri_param = {};
    my ($handler, $info, $pm) = PMG::API2->find_handler('GET', $path, $uri_param);
    if ($handler && $info) {
	eval {
	    my $data = $handler->handle($info, $uri_param);
	    my $lnk = PVE::JSONSchema::method_get_child_link($info);
	    $res->{children} = extract_children($lnk, $data);
	}; # ignore errors ?
    }
    return $res;
}

sub list_dir {
    my ($dir, $args) = @_;

    my $uri_param = {};
    my ($handler, $info) = PMG::API2->find_handler('GET', $dir, $uri_param);
    if (!$handler || !$info) {
	die "no such resource\n";
    }

    if (!PVE::JSONSchema::method_get_child_link($info)) {
	die "resource does not define child links\n";
    }

    my ($node, $remip) = check_proxyto($info, $uri_param);
    return proxy_handler($node, $remip, $dir, 'ls', $args) if $node;


    my $data = $handler->cli_handler("ls $dir", $info->{name}, $args, [], $uri_param, $param_mapping);
    my $lnk = PVE::JSONSchema::method_get_child_link($info);
    my $children = extract_children($lnk, $data);

    foreach my $c (@$children) {
	my $cap = resource_cap(abs_path($dir, $c));
	print "$cap $c\n";
    }
}

sub pmg_command {
    my ($args, $nooutput) = @_;

    $rpcenv->init_request();

    $rpcenv->set_ticket($ticket);
    $rpcenv->set_user('root@pam');
    $rpcenv->set_role('root');

    my $cmd = shift @$args;

    if ($cmd eq 'cd') {

	my $path =  shift @$args;

	die "usage: cd [dir]\n" if scalar(@$args);

	if (!defined($path)) {
	    $cdir = '';
	    return;
	} else {
	    my $new_dir = abs_path($cdir, $path);
	    my ($handler, $info) = PMG::API2->find_handler('GET', $new_dir);
	    die "no such resource\n" if !$handler;
	    $cdir = $new_dir;
	}

    } elsif ($cmd eq 'help') {

	my $help_usage_error = sub {
	    die "usage: help [path] [--verbose]\n";
	};

	my $opts = {};

	&$help_usage_error() if !Getopt::Long::GetOptionsFromArray($args, $opts, 'verbose');

	my $path;
	if (scalar(@$args) && $args->[0] !~ m/^\-/)  {
	    $path = shift @$args;
	}

	&$help_usage_error() if scalar(@$args);

	print "help [path] [--verbose]\n";
	print "cd [path]\n";
	print "ls [path]\n\n";

	print_help(abs_path($cdir, $path), $opts);

    } elsif ($cmd eq 'ls') {
	my $path;
	if (scalar(@$args) && $args->[0] !~ m/^\-/)  {
	    $path = shift @$args;
	}

	list_dir(abs_path($cdir, $path), $args);

    } elsif ($cmd =~ m/^get|delete|set$/) {

	my $path;
	if (scalar(@$args) && $args->[0] !~ m/^\-/)  {
	    $path = shift @$args;
	}

	call_method(abs_path($cdir, $path), $cmd, $args);

    } elsif ($cmd eq 'create') {

	my $path;
	if (scalar(@$args) && $args->[0] !~ m/^\-/)  {
	    $path = shift @$args;
	}

	call_method(abs_path($cdir, $path), $cmd, $args, $nooutput);

    } else {
	die "unknown command '$cmd'\n";
    }

}

my $input;
while (defined ($input = $term->readline("pmg:/$cdir> "))) {
    chomp $input;

    next if $input =~ m/^\s*$/;

    if ($input =~ m/^\s*q(uit)?\s*$/) {
	exit (0);
    }

    # add input to history if it gets not
    # automatically added
    if (!$term->Features->{autohistory}) {
	$term->addhistory($input);
    }

    eval {
	my $args = [ shellwords($input) ];
	pmg_command($args);
    };
    warn $@ if $@;
}

__END__

=head1 NAME

pmgsh - shell interface to the Promox Mail Gateway API

=head1 SYNOPSIS

pmgsh [get|set|create|delete|help] [REST API path] [--verbose]

=head1 DESCRIPTION

pmgsh provides a shell-like interface to the Proxmox Mail Gateway API, in 
two different modes:

=over

=item interactive

when called without parameters, pmgsh starts an interactive client,
where you can navigate in the different parts of the API

=item command line

when started with parameters pmgsh will send a command to the
corresponding REST url, and will return the JSON formatted output

=back

=head1 EXAMPLES

get the list of nodes in my cluster

pmgsh get /nodes
Commit	Line	Data
1d18e90b DM	1	#!/usr/bin/perl
	2
	3	use strict;
	4	use warnings;
	5	use Term::ReadLine;
	6	use File::Basename;
	7	use Getopt::Long;
	8	use HTTP::Status qw(:constants :is status_message);
	9	use Text::ParseWords;
	10
	11	use PVE::JSONSchema;
	12	use PVE::SafeSyslog;
	13	use PVE::INotify;
8319c8d9	14	use PVE::CLIHandler;
807a5c2e DM	15
807a5c2e DM	16	use PMG::RESTEnvironment;
1d18e90b	17
ba11e2d3	18	use PMG::Ticket;
1d18e90b DM	19	use PMG::Cluster;
1d18e90b DM	20	use PMG::API2;
ba11e2d3	21
1d18e90b DM	22	use JSON;
1d18e90b DM	23
2030e673	24	PMG::RESTEnvironment->setup_default_cli_env();
1d18e90b	25
2030e673	26	my $rpcenv = PMG::RESTEnvironment->get();
1d18e90b	27
ba11e2d3	28	my $ticket = PMG::Ticket::assemble_ticket('root@pam');
1d18e90b DM	29
	30	my $logid = $ENV{PVE_LOG_ID} \|\| 'pmgsh';
	31	initlog($logid);
	32
	33	my $basedir = '/api2/json';
	34
	35	my $cdir = '';
	36
	37	sub print_usage {
	38	my $msg = shift;
	39
	40	print STDERR "ERROR: $msg\n" if $msg;
	41	print STDERR "USAGE: pmgsh [verifyapi]\n";
	42	print STDERR " pmgsh CMD [OPTIONS]\n";
	43
	44	}
	45
	46	my $disable_proxy = 0;
	47	my $opt_nooutput = 0;
	48
	49	my $cmd = shift;
	50
	51	my $optmatch;
	52	do {
	53	$optmatch = 0;
	54	if ($cmd) {
	55	if ($cmd eq '--noproxy') {
	56	$cmd = shift;
	57	$disable_proxy = 1;
	58	$optmatch = 1;
	59	} elsif ($cmd eq '--nooutput') {
	60	# we use this when starting task in CLI (suppress printing upid)
	61	$cmd = shift;
	62	$opt_nooutput = 1;
	63	$optmatch = 1;
	64	}
	65	}
	66	} while ($optmatch);
	67
	68	if ($cmd) {
	69	if ($cmd eq 'verifyapi') {
	70	PVE::RESTHandler::validate_method_schemas();
	71	exit 0;
	72	} elsif ($cmd eq 'ls' \|\| $cmd eq 'get' \|\| $cmd eq 'create' \|\|
	73	$cmd eq 'set' \|\| $cmd eq 'delete' \|\|$cmd eq 'help' ) {
	74	pmg_command([ $cmd, @ARGV], $opt_nooutput);
	75	exit(0);
	76	} else {
	77	print_usage ("unknown command '$cmd'");
	78	exit (-1);
	79	}
	80	}
	81
	82	if (scalar (@ARGV) != 0) {
	83	print_usage();
	84	exit(-1);
	85	}
	86
	87	print "entering PMG shell - type 'help' for help\n";
	88
	89	my $term = new Term::ReadLine('pmgsh');
	90	my $attribs = $term->Attribs;
	91
	92	sub complete_path {
93	my($text) = @_;
94
95	my ($dir, undef, $rest) = $text =~ m\|^(./)?(([^/]))?$\|;
96	my $path = abs_path($cdir, $dir);
97
98	my @res = ();
99
100	my $di = dir_info($path);
101	if (my $children = $di->{children}) {
102	foreach my $c (@$children) {
103	if ($c =~ /^\Q$rest/) {
104	my $new = $dir ? "$dir$c" : $c;
105	push @res, $new;
106	}
107	}
108	}
109
110	if (scalar(@res) == 0) {
111	return undef;
112	} elsif (scalar(@res) == 1) {
113	return ($res[0], $res[0], "$res[0]/");
114	}
115
116	# lcd : lowest common denominator
117	my $lcd = '';
118	my $tmp = $res[0];
119	for (my $i = 1; $i <= length($tmp); $i++) {
120	my $found = 1;
121	foreach my $p (@res) {
122	if (substr($tmp, 0, $i) ne substr($p, 0, $i)) {
123	$found = 0;
124	last;
125	}
126	}
127	if ($found) {
128	$lcd = substr($tmp, 0, $i);
129	} else {
130	last;
131	}
132	}
133
134	return ($lcd, @res);
135	};
136
137	# just to avoid an endless loop (called by attempted_completion_function)
138	$attribs->{completion_entry_function} = sub {
139	my($text, $state) = @_;
140	return undef;
141	};
142
143	$attribs->{attempted_completion_function} = sub {
144	my ($text, $line, $start) = @_;
145
146	my $prefix = substr($line, 0, $start);
147	if ($prefix =~ /^\s*$/) { # first word (command completeion)
148	$attribs->{completion_word} = [qw(help ls cd get set create delete quit)];
149	return $term->completion_matches($text, $attribs->{list_completion_function});
150	}
151
152	if ($prefix =~ /^\s*\S+\s+$/) { # second word (path completion)
153	return complete_path($text);
154	}
155
156	return ();
157	};
158
159	sub abs_path {
160	my ($current, $path) = @_;
161
162	my $ret = $current;
163
164	return $current if !defined($path);
165
166	$ret = '' if $path =~ m\|^\/\|;
167
168	foreach my $d (split (/\/+/ , $path)) {
169	if ($d eq '.') {
170	next;
171	} elsif ($d eq '..') {
172	$ret = dirname($ret);
173	$ret = '' if $ret eq '.';
174	} else {
175	$ret = "$ret/$d";
176	}
177	}
178
179	$ret =~ s\|\/+\|\/\|g;
180	$ret =~ s\|^\/\|\|;
181	$ret =~ s\|\/$\|\|;
182
183	return $ret;
184	}
185
8319c8d9 TL	186	my $param_mapping = sub {
8319c8d9 TL	187	my ($name) = @_;
1d18e90b	188
8319c8d9	189	return [ PVE::CLIHandler::get_standard_mapping('pve-password') ];
1d18e90b DM	190	};
	191
	192	sub reverse_map_cmd {
	193	my $method = shift;
	194
	195	my $mmap = {
	196	GET => 'get',
	197	PUT => 'set',
	198	POST => 'create',
	199	DELETE => 'delete',
	200	};
	201
	202	my $cmd = $mmap->{$method};
	203
	204	die "got strange value for method ('$method') - internal error" if !$cmd;
	205
	206	return $cmd;
	207	}
	208
	209	sub map_cmd {
	210	my $cmd = shift;
	211
	212	my $mmap = {
	213	create => 'POST',
	214	set => 'PUT',
	215	get => 'GET',
	216	ls => 'GET',
	217	delete => 'DELETE',
	218	};
	219
	220	my $method = $mmap->{$cmd};
	221
	222	die "unable to map method" if !$method;
	223
	224	return $method;
	225	}
	226
	227	sub check_proxyto {
	228	my ($info, $uri_param) = @_;
	229
	230	if ($info->{proxyto}) {
	231	my $pn = $info->{proxyto};
0fb55414 DM	232	my $node;
	233	if ($pn eq 'master') {
	234	$node = PMG::Cluster::get_master_node();
	235	} else {
	236	$node = $uri_param->{$pn};
	237	die "proxy parameter '$pn' does not exists" if !$node;
	238	}
1d18e90b DM	239
	240	if ($node ne 'localhost' && ($node ne PVE::INotify::nodename())) {
	241	die "proxy loop detected - aborting\n" if $disable_proxy;
	242	my $remip = PMG::Cluster::remote_node_ip($node);
	243	return ($node, $remip);
	244	}
	245	}
	246
	247	return undef;
	248	}
	249
	250	sub proxy_handler {
	251	my ($node, $remip, $dir, $cmd, $args) = @_;
	252
	253	my $remcmd = ['ssh', '-o', 'BatchMode=yes', "root\@$remip",
	254	'pmgsh', '--noproxy', $cmd, $dir, @$args];
	255
	256	system(@$remcmd) == 0 \|\| die "proxy handler failed\n";
	257	}
	258
	259	sub call_method {
	260	my ($dir, $cmd, $args, $nooutput) = @_;
	261
	262	my $method = map_cmd($cmd);
	263
	264	my $uri_param = {};
	265	my ($handler, $info) = PMG::API2->find_handler($method, $dir, $uri_param);
	266	if (!$handler \|\| !$info) {
	267	die "no '$cmd' handler for '$dir'\n";
	268	}
	269
	270	my ($node, $remip) = check_proxyto($info, $uri_param);
	271	return proxy_handler($node, $remip, $dir, $cmd, $args) if $node;
	272
8319c8d9	273	my $data = $handler->cli_handler("$cmd $dir", $info->{name}, $args, [], $uri_param, $param_mapping);
1d18e90b DM	274
	275	return if $nooutput;
	276
	277	warn "200 OK\n"; # always print OK status if successful
	278
	279	if ($info && $info->{returns} && $info->{returns}->{type}) {
	280	my $rtype = $info->{returns}->{type};
	281
	282	return if $rtype eq 'null';
	283
	284	if ($rtype eq 'string') {
	285	print $data if $data;
	286	return;
	287	}
	288	}
	289
	290	print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
	291
	292	return;
	293	}
	294
	295	sub find_resource_methods {
	296	my ($path, $ihash) = @_;
	297
	298	for my $method (qw(GET POST PUT DELETE)) {
	299	my $uri_param = {};
	300	my $path_match;
	301	my ($handler, $info) = PMG::API2->find_handler($method, $path, $uri_param, \$path_match);
	302	if ($handler && $info && !$ihash->{$info}) {
	303	$ihash->{$info} = {
	304	path => $path_match,
	305	handler => $handler,
	306	info => $info,
	307	uri_param => $uri_param,
	308	};
	309	}
	310	}
	311	}
	312
	313	sub print_help {
	314	my ($path, $opts) = @_;
	315
	316	my $ihash = {};
	317
	318	find_resource_methods($path, $ihash);
	319
	320	if (!scalar(keys(%$ihash))) {
	321	die "no such resource\n";
	322	}
	323
	324	my $di = dir_info($path);
	325	if (my $children = $di->{children}) {
	326	foreach my $c (@$children) {
	327	my $cp = abs_path($path, $c);
	328	find_resource_methods($cp, $ihash);
	329	}
	330	}
	331
	332	foreach my $mi (sort { $a->{path} cmp $b->{path} } values %$ihash) {
	333	my $method = $mi->{info}->{method};
	334
	335	# we skip index methods for now.
	336	next if ($method eq 'GET') && PVE::JSONSchema::method_get_child_link($mi->{info});
	337
338	my $path = $mi->{path};
339	$path =~ s\|/+$\|\|; # remove trailing slash
340
341	my $cmd = reverse_map_cmd($method);
342
343	print $mi->{handler}->usage_str($mi->{info}->{name}, "$cmd $path", [], $mi->{uri_param},
344	$opts->{verbose} ? 'full' : 'short', 1);
345	print "\n\n" if $opts->{verbose};
346	}
347
348	};
349
350	sub resource_cap {
351	my ($path) = @_;
352
353	my $res = '';
354
355	my ($handler, $info) = PMG::API2->find_handler('GET', $path);
356	if (!($handler && $info)) {
357	$res .= '--';
358	} else {
359	if (PVE::JSONSchema::method_get_child_link($info)) {
360	$res .= 'Dr';
361	} else {
362	$res .= '-r';
363	}
364	}
365
366	($handler, $info) = PMG::API2->find_handler('PUT', $path);
367	if (!($handler && $info)) {
368	$res .= '-';
369	} else {
370	$res .= 'w';
371	}
372
373	($handler, $info) = PMG::API2->find_handler('POST', $path);
374	if (!($handler && $info)) {
375	$res .= '-';
376	} else {
377	$res .= 'c';
378	}
379
380	($handler, $info) = PMG::API2->find_handler('DELETE', $path);
381	if (!($handler && $info)) {
382	$res .= '-';
383	} else {
384	$res .= 'd';
385	}
386
387	return $res;
388	}
389
390	sub extract_children {
391	my ($lnk, $data) = @_;
392
393	my $res = [];
394
395	return $res if !($lnk && $data);
396
397	my $href = $lnk->{href};
398	if ($href =~ m/^\{(\S+)\}$/) {
399	my $prop = $1;
400
401	foreach my $elem (sort {$a->{$prop} cmp $b->{$prop}} @$data) {
402	next if !ref($elem);
403	my $value = $elem->{$prop};
404	push @$res, $value;
405	}
406	}
407
408	return $res;
409	}
410
411	sub dir_info {
412	my ($path) = @_;
413
414	my $res = { path => $path };
415	my $uri_param = {};
416	my ($handler, $info, $pm) = PMG::API2->find_handler('GET', $path, $uri_param);
417	if ($handler && $info) {
418	eval {
419	my $data = $handler->handle($info, $uri_param);
420	my $lnk = PVE::JSONSchema::method_get_child_link($info);
421	$res->{children} = extract_children($lnk, $data);
422	}; # ignore errors ?
423	}
424	return $res;
425	}
426
427	sub list_dir {
428	my ($dir, $args) = @_;
429
430	my $uri_param = {};
431	my ($handler, $info) = PMG::API2->find_handler('GET', $dir, $uri_param);
432	if (!$handler \|\| !$info) {
433	die "no such resource\n";
434	}
435
436	if (!PVE::JSONSchema::method_get_child_link($info)) {
437	die "resource does not define child links\n";
438	}
439
440	my ($node, $remip) = check_proxyto($info, $uri_param);
441	return proxy_handler($node, $remip, $dir, 'ls', $args) if $node;
442
443
8319c8d9	444	my $data = $handler->cli_handler("ls $dir", $info->{name}, $args, [], $uri_param, $param_mapping);
1d18e90b DM	445	my $lnk = PVE::JSONSchema::method_get_child_link($info);
	446	my $children = extract_children($lnk, $data);
	447
	448	foreach my $c (@$children) {
	449	my $cap = resource_cap(abs_path($dir, $c));
	450	print "$cap $c\n";
	451	}
	452	}
	453
	454	sub pmg_command {
	455	my ($args, $nooutput) = @_;
	456
	457	$rpcenv->init_request();
	458
ba11e2d3	459	$rpcenv->set_ticket($ticket);
2030e673 DM	460	$rpcenv->set_user('root@pam');
2030e673 DM	461	$rpcenv->set_role('root');
ba11e2d3	462
1d18e90b DM	463	my $cmd = shift @$args;
	464
	465	if ($cmd eq 'cd') {
	466
	467	my $path = shift @$args;
	468
	469	die "usage: cd [dir]\n" if scalar(@$args);
	470
	471	if (!defined($path)) {
	472	$cdir = '';
	473	return;
	474	} else {
	475	my $new_dir = abs_path($cdir, $path);
	476	my ($handler, $info) = PMG::API2->find_handler('GET', $new_dir);
	477	die "no such resource\n" if !$handler;
	478	$cdir = $new_dir;
	479	}
	480
	481	} elsif ($cmd eq 'help') {
	482
	483	my $help_usage_error = sub {
	484	die "usage: help [path] [--verbose]\n";
	485	};
	486
	487	my $opts = {};
	488
	489	&$help_usage_error() if !Getopt::Long::GetOptionsFromArray($args, $opts, 'verbose');
	490
	491	my $path;
	492	if (scalar(@$args) && $args->[0] !~ m/^\-/) {
	493	$path = shift @$args;
	494	}
	495
	496	&$help_usage_error() if scalar(@$args);
	497
	498	print "help [path] [--verbose]\n";
	499	print "cd [path]\n";
	500	print "ls [path]\n\n";
	501
	502	print_help(abs_path($cdir, $path), $opts);
	503
	504	} elsif ($cmd eq 'ls') {
	505	my $path;
	506	if (scalar(@$args) && $args->[0] !~ m/^\-/) {
	507	$path = shift @$args;
	508	}
	509
	510	list_dir(abs_path($cdir, $path), $args);
	511
	512	} elsif ($cmd =~ m/^get\|delete\|set$/) {
	513
	514	my $path;
	515	if (scalar(@$args) && $args->[0] !~ m/^\-/) {
	516	$path = shift @$args;
	517	}
	518
	519	call_method(abs_path($cdir, $path), $cmd, $args);
	520
	521	} elsif ($cmd eq 'create') {
	522
	523	my $path;
	524	if (scalar(@$args) && $args->[0] !~ m/^\-/) {
	525	$path = shift @$args;
	526	}
527
528	call_method(abs_path($cdir, $path), $cmd, $args, $nooutput);
529
530	} else {
531	die "unknown command '$cmd'\n";
532	}
533
534	}
535
536	my $input;
537	while (defined ($input = $term->readline("pmg:/$cdir> "))) {
538	chomp $input;
539
540	next if $input =~ m/^\s*$/;
541
542	if ($input =~ m/^\sq(uit)?\s$/) {
543	exit (0);
544	}
545
546	# add input to history if it gets not
547	# automatically added
548	if (!$term->Features->{autohistory}) {
549	$term->addhistory($input);
550	}
551
552	eval {
553	my $args = [ shellwords($input) ];
554	pmg_command($args);
555	};
556	warn $@ if $@;
557	}
558
559	__END__
560
561	=head1 NAME
562
563	pmgsh - shell interface to the Promox Mail Gateway API
564
565	=head1 SYNOPSIS
566
567	pmgsh [get\|set\|create\|delete\|help] [REST API path] [--verbose]
568
569	=head1 DESCRIPTION
570
571	pmgsh provides a shell-like interface to the Proxmox Mail Gateway API, in
572	two different modes:
573
574	=over
575
576	=item interactive
577
578	when called without parameters, pmgsh starts an interactive client,
579	where you can navigate in the different parts of the API
580
581	=item command line
582
583	when started with parameters pmgsh will send a command to the
584	corresponding REST url, and will return the JSON formatted output
585
586	=back
587
588	=head1 EXAMPLES
589
590	get the list of nodes in my cluster
591
592	pmgsh get /nodes
593