/usr/bin/s3cl is in libnet-amazon-s3-perl 0.80-1.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 | #!/usr/bin/env perl
use strict;
use warnings;
use Getopt::Long;
use Pod::Usage;
use Path::Class;
use File::Find::Rule;
use Digest::MD5 qw(md5_hex);
use Net::Amazon::S3;
use MIME::Types qw(by_suffix);
use Term::ProgressBar::Simple;
# PODNAME: s3cl
# ABSTRACT: Command line for Amazon s3 cloud storage
my $s3;
my %args;
my %commands = (
mkbucket => \&mk_bucket,
buckets => \&buckets,
ls => \&ls,
rm => \&rm,
cp => \&cp,
sync => \&sync,
sync_up => \&sync_up,
help => \&helper,
);
main();
sub main {
terminal();
get_options();
init_s3();
my $command = shift @ARGV || "help";
$commands{$command}
or helper("Unknown command: $command");
$commands{$command}->();
}
sub init_s3 {
# TODO: read key_id and secret from config file?
# use AppConfig;
# TODO: probably nicer to put all of this in Net::Amazon::S3::CommandLine
# and have simple call to that from here.
my $aws_access_key_id = $ENV{'AWS_ACCESS_KEY_ID'};
my $aws_secret_access_key = $ENV{'AWS_ACCESS_KEY_SECRET'};
$s3 = Net::Amazon::S3->new(
{ aws_access_key_id => $aws_access_key_id,
aws_secret_access_key => $aws_secret_access_key,
retry => 1,
}
);
}
sub sync {
my $dest = $args{dest_or_source} || '';
helper("No destination supplied") if $dest eq '';
helper("Can not write to: $args{dest_or_source}") unless -w $dest;
my $bucket = _get_bucket();
my $list = ls('data');
foreach my $key ( @{ $list->{keys} } ) {
my $source = file( $key->{key} );
my $destination = file( $dest, $source );
$destination->dir->mkpath();
warn "$source -> $destination";
my $response
= $bucket->get_key_filename( $source->stringify, 'GET',
$destination->stringify )
or die $s3->err . ": " . $s3->errstr;
}
}
sub sync_up {
my $source = $args{dest_or_source} || '';
my $prefix = $args{prefix_or_key} || '';
my $acl_short = $args{acl_short};
helper("No source supplied") if $source eq '';
helper("Can not read directory: $args{dest_or_source}") unless -d $source;
# Work out our local files
my @files = File::Find::Rule->file()->in( ($source) );
my $progress = Term::ProgressBar::Simple->new( scalar(@files) );
my $bucket = _get_bucket();
# Get a list of all the remote files
my $remote_file_list = $bucket->list_all( { prefix => $prefix } )
or die $s3->err . ": " . $s3->errstr;
# Now hash, so we can look up a specific key to find the etag
my %remote_files;
foreach my $key_meta ( @{ $remote_file_list->{keys} } ) {
my $key = $key_meta->{key};
$remote_files{$key} = $key_meta;
}
my $dir = dir($source);
my $dir_string = $dir->stringify;
my $mimetypes = MIME::Types->new;
foreach my $f (@files) {
my $file = file($f);
my ( $mediatype, $encoding ) = by_suffix $file->basename();
# Assume plain text unless we can work i
unless ($mediatype) {
if ( -T $file ) {
$mediatype = 'text/plain';
} else {
$progress++;
$progress->message("$f - NOT uploading");
warn "Not uploading: $file";
warn "Unknown mime type, submit patch to MIME::Types";
next;
}
}
my $content = $file->slurp();
my $md5 = md5_hex($content);
my $key = $file->stringify;
$key =~ s/$dir_string//; # remove our local path for the dir
$key =~ s{^/}{}; # remove the trailing slash
$key = "$prefix$key"; # Add the prefix if there is one
if ( my $remote = $remote_files{$key} ) {
if ( $remote->{etag} eq $md5 ) {
$progress->message("$key - $mediatype - not changed");
next;
}
}
$bucket->add_key_filename( $key, $f, { content_type => $mediatype, },
) or die $s3->err . ": " . $s3->errstr;
if ($acl_short) {
$bucket->set_acl(
{ key => $key,
acl_short => $acl_short,
}
) || die $s3->err . ": " . $s3->errstr;
}
$progress->message("$key - $mediatype - uploaded");
$progress++;
}
}
sub cp {
my $dest = $args{dest_or_source} || '';
helper("No destination supplied") if $dest eq '';
my $key = $args{prefix_or_key} || helper("No key supplied");
if ( -d $dest ) {
# If we have a directory we need to add the file name
$dest = file( $dest, file($key)->basename );
}
my $bucket = _get_bucket();
unless ( $bucket->get_key_filename( "$key", 'GET', "$dest" ) ) {
die $s3->err . ": " . $s3->errstr if $s3->err;
die "Could not copy $key from bucket $args{bucket}";
}
}
sub ls {
my $mode = shift || 'print';
my $bucket = _get_bucket();
my $ls_conf;
$ls_conf->{prefix} = $args{prefix_or_key} if $args{prefix_or_key};
# list files in the bucket
my $response = $bucket->list_all($ls_conf)
or die $s3->err . ": " . $s3->errstr;
return $response if $mode eq 'data';
foreach my $key ( @{ $response->{keys} } ) {
my $key_last_modified
= $key->{last_modified}; # 2008-07-14T22:31:10.000Z
$key_last_modified =~ s/:\d{2}\.\d{3}Z$//;
my $key_name = $key->{key};
my $key_size = $key->{size};
print "$key_size $key_last_modified $key_name\n";
}
}
sub rm {
my $bucket = _get_bucket();
helper("Must have a <bucket>:<key>") unless $args{prefix_or_key};
my $res = "NO";
if ( $args{force} ) {
$res = 'y';
} else {
print "\nOnce deleted there is no way to retrieve this key again."
. "\nAre you sure you want to delete $args{bucket}:$args{prefix_or_key}? y/N\n";
( $res = <STDIN> ) =~ s/\n//;
}
if ( $res eq 'y' ) {
# delete key in this bucket
my $response = $bucket->delete_key( $args{prefix_or_key} )
or die $s3->err . ": " . $s3->errstr;
}
}
sub mk_bucket {
my $bucketname = $args{bucket};
my $bucket
= $s3->add_bucket(
{ bucket => $bucketname, location_constraint => 'EU' } )
or die $s3->err . ": " . $s3->errstr;
}
sub buckets {
my $response = $s3->buckets;
my $num = scalar @{ $response->{buckets} || [] };
print "You have $num bucket";
print "s" if $num != 1;
print ":\n";
foreach my $bucket ( @{ $response->{buckets} } ) {
print '- ' . $bucket->bucket . "\n";
}
}
sub terminal {
my $encoding = eval {
require Term::Encoding;
Term::Encoding::get_encoding();
} || "utf-8";
binmode STDOUT, ":encoding($encoding)";
}
# TODO: Replace with AppConfig this is ick!
sub get_options {
my $help = 0;
my $man = 0;
my $force = 0;
my $loc = "US";
my $bucket = "";
GetOptions(
\%args, "bucket=s", "jurisdiction=s",
"acl_short=s",
"f|force" => \$force,
"h|help|?" => \$help,
"man" => \$man,
) or pod2usage(2);
$args{force} = $force;
foreach my $arg (@ARGV) {
if ( $arg =~ /:/ ) {
my ( $b, $rest ) = split( ":", $arg );
$args{bucket} = $b;
$args{prefix_or_key} = $rest;
}
}
# For cp / sync etc
$args{dest_or_source} = $ARGV[2] if $ARGV[2];
pod2usage(1) if $help || @ARGV == 0;
pod2usage( -verbose => 2 ) if $man;
}
sub _get_bucket {
helper("No bucket supplied") unless $args{bucket};
my $bucket = $s3->bucket( $args{bucket} );
die $s3->err . ": " . $s3->errstr if $s3->err;
helper("Could not get bucket $args{bucket}") unless $bucket;
return $bucket;
}
sub helper {
my $msg = shift;
if ($msg) {
pod2usage( -message => $msg, -exitval => 2 );
}
exit;
}
=pod
=encoding UTF-8
=head1 NAME
s3cl - Command line for Amazon s3 cloud storage
=head1 VERSION
version 0.80
=head1 SYNOPSIS
s3cl command [options]
s3cl buckets
s3cl mkbucket --bucket some_bucket_name --jurisdiction [EU|US]
s3cl ls <bucket>:[prefix]
s3cl cp <bucket>:<key> /path/[filename]
s3cl sync <bucket>:[prefix] /path/
s3cl sync_up [--acl_short=public-read] <bucket>:[prefix] /path/
s3cl rm <bucket>:<key>
Options:
-help brief help message
-man full documentation
We take NO responsibility for the costs incured through using
this script.
To run this script, you need to set a pair of environment variables:
AWS_ACCESS_KEY_ID
AWS_ACCESS_KEY_SECRET
=head1 DESCRIPTION
This program gives a command line interface to Amazons s3 storage
service. It does not limit the number of requests (which may cost
you more money than if you did it a different way!) and each
request costs Money (although some costs from EC2 may be $0.0,
check latest from Amazon costs page) - we take NO reponsibility
for your bill.
=head1 AUTHOR
Rusty Conover <rusty@luckydinosaur.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Amazon Digital Services, Leon Brocard, Brad Fitzpatrick, Pedro Figueiredo, Rusty Conover.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__DATA__
=head1 COMMANDS
=over 4
=item B<buckets>
s3cl buckets
List all buckets for this account.
=item B<mkbucket>
s3cl mkbucket --bucket sombucketname [--jurisdiction [EU|US]]
Create a new bucket, optionally specifying what jurisdiction
it should be created in.
=item B<ls>
s3cl ls <bucket>:[prefix]
List contents of a bucket, the optional B<prefix> can be partial, in which
case all keys matching this as the start of the key name will be returned.
If no B<prefix> is supplied all keys of the bucket will be returned.
=item B<cp>
s3cl cp <bucket>:<key> target_file
s3cl cp <bucket>:<key> target_directory
Copy a single key from the bucket to the target file, or into
the target_directory.
=item B<sync>
s3cl sync <bucket>:[prefix] target_dir
Downloads all files matching the prefix into a directory structure
replicating that of the prefix and all 'sub-directories'. It will
download ALL files - even if already on your local disk:
http://www.amazon.com/gp/browse.html?node=16427261
# Data transfer "in" and "out" refers to transfer into and out
# of Amazon S3. Data transferred between Amazon EC2 and
# Amazon S3, is free of charge (i.e., $0.00 per GB), except
# data transferred between Amazon EC2 and Amazon S3-Europe,
# which will be charged at regular rates.
=item B<sync_up>
s3cl sync_up [--acl_short=public-read] <bucket>:[prefix] /path/
Upload all the files below /path/ to S3, with an optional
prefix at the start of the key name. The existing S3 files and
meta data are fetched from S3 and the md5 (etag) is compaired to
what is on the local disk, files are not upload if the content has
not changed.
Use --acl_short to set access control, options from
L<Net::Amazon::S3::Bucket#set_acl> this is only applied when the
file is uploaded.
Each files content-type is worked out using L<MIME::Types>,
if this does not match 'text/plain' is used for ASCII text files,
otherwise a warning is issued and the file is NOT uploaded.
Currently this does NOT remove old files from S3, and if there is
any change to a file then the entire file will be reuploaded.
=item B<rm>
s3cl rm <bucket>:<key>
Remove a key(file) from the bucket, removing a non-existent file
is not classed as an error. Once removed the key (file) can not
be restored - so use with care!
=back
=head1 ABOUT
This module contains code modified from Amazon that contains the
following notice (which is also applicicable to this code):
# This software code is made available "AS IS" without
# warranties of any kind. You may copy, display, modify and
# redistribute the software code either by itself or as incorporated
# into your code; provided that you do not remove any proprietary
# notices. Your use of this software code is at your own risk and
# you waive any claim against Amazon Digital Services, Inc. or its
# affiliates with respect to your use of this software code.
# (c) 2006 Amazon Digital Services, Inc. or its affiliates.
=head1 AUTHOR
Leo Lapworth <LLAP@cuckoo.org> - Part of the HinuHinu project
=cut
|