File: //usr/share/webmin/virtual-server/list-s3-files.pl
#!/usr/bin/perl
=head1 list-s3-files.pl
Lists files in one S3 bucket.
This command queries Amazon's S3 service for the list of files in a bucket,
specified using the C<--bucket> flag. The login and password for S3 must be
set using the C<--access-key> and C<--secret-key> flags, unless defaults have
been set in the Virtualmin configuration.
By default output is in a human-readable table format, but you can switch to
a more parsable output format with the C<--multiline> flag. Or to just get a
list of filenames, use the C<--name-only> flag.
=cut
package virtual_server;
if (!$module_name) {
$main::no_acl_check++;
$ENV{'WEBMIN_CONFIG'} ||= "/etc/webmin";
$ENV{'WEBMIN_VAR'} ||= "/var/webmin";
if ($0 =~ /^(.*)\/[^\/]+$/) {
chdir($pwd = $1);
}
else {
chop($pwd = `pwd`);
}
$0 = "$pwd/list-s3-files.pl";
require './virtual-server-lib.pl';
$< == 0 || die "list-s3-files.pl must be run as root";
}
&require_mail();
# Parse command-line args
$owner = 1;
&parse_common_cli_flags(\@ARGV);
while(@ARGV > 0) {
local $a = shift(@ARGV);
if ($a eq "--bucket") {
$bucket = shift(@ARGV);
}
elsif ($a eq "--access-key") {
$akey = shift(@ARGV);
}
elsif ($a eq "--secret-key") {
$skey = shift(@ARGV);
}
else {
&usage("Unknown parameter $a");
}
}
($akey, $skey, $iam) = &lookup_s3_credentials($akey, $skey);
$iam || $akey || &usage("Missing --access-key parameter");
$iam || $skey || &usage("Missing --secret-key parameter");
$bucket || &usage("Missing --bucket parameter");
# List the directory
$files = &s3_list_files($akey, $skey, $bucket);
if (!ref($files)) {
print "ERROR: $files\n";
exit(1);
}
if ($multiline) {
# Full details
foreach $f (@$files) {
print $f->{'Key'},"\n";
print " Size: $f->{'Size'}\n";
if ($f->{'Owner'}) {
print " Owner: $f->{'Owner'}->{'DisplayName'}\n";
}
local $ctime = &s3_parse_date($f->{'LastModified'});
print " Last modified: ",&make_date($ctime),"\n";
print " Last modified time: ",$ctime,"\n";
print " Storage class: $f->{'StorageClass'}\n";
print " ETag: $f->{'ETag'}\n";
}
}
elsif ($nameonly) {
# Filenames only
foreach $f (@$files) {
print $f->{'Key'},"\n";
}
}
else {
# Summary
$fmt = "%-35.35s %-12.12s %-30.30s\n";
printf $fmt, "Filename", "Size", "Last modified";
printf $fmt, ("-" x 35), ("-" x 12), ("-" x 30);
foreach $f (@$files) {
local $ctime = &s3_parse_date($f->{'LastModified'});
printf $fmt, $f->{'Key'}, &nice_size($f->{'Size'}),
&make_date($ctime);
}
}
sub usage
{
print "$_[0]\n\n" if ($_[0]);
print "Lists files in one S3 bucket.\n";
print "\n";
print "virtualmin list-s3-files [--multiline | --json | --xml | --name-only]\n";
print " [--access-key key]\n";
print " [--secret-key key]\n";
print " --bucket name\n";
exit(1);
}