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
|
package Net::Amazon::S3::Client::Bucket;
use Moose;
use MooseX::StrictConstructor;
use Data::Stream::Bulk::Callback;
use MooseX::Types::DateTimeX qw( DateTime );
has 'client' =>
( is => 'ro', isa => 'Net::Amazon::S3::Client', required => 1 );
has 'name' => ( is => 'ro', isa => 'Str', required => 1 );
has 'creation_date' =>
( is => 'ro', isa => DateTime, coerce => 1, required => 0 );
has 'owner_id' => ( is => 'ro', isa => 'OwnerId', required => 0 );
has 'owner_display_name' => ( is => 'ro', isa => 'Str', required => 0 );
__PACKAGE__->meta->make_immutable;
sub _create {
my ( $self, %conf ) = @_;
my $http_request = Net::Amazon::S3::Request::CreateBucket->new(
s3 => $self->client->s3,
bucket => $self->name,
acl_short => $conf{acl_short},
location_constraint => $conf{location_constraint},
)->http_request;
$self->client->_send_request($http_request);
}
sub delete {
my $self = shift;
my $http_request = Net::Amazon::S3::Request::DeleteBucket->new(
s3 => $self->client->s3,
bucket => $self->name,
)->http_request;
$self->client->_send_request($http_request);
}
sub acl {
my $self = shift;
my $http_request = Net::Amazon::S3::Request::GetBucketAccessControl->new(
s3 => $self->client->s3,
bucket => $self->name,
)->http_request;
return $self->client->_send_request_content($http_request);
}
sub location_constraint {
my $self = shift;
my $http_request
= Net::Amazon::S3::Request::GetBucketLocationConstraint->new(
s3 => $self->client->s3,
bucket => $self->name,
)->http_request;
my $xpc = $self->client->_send_request_xpc($http_request);
my $lc = $xpc->findvalue('/s3:LocationConstraint');
if ( defined $lc && $lc eq '' ) {
$lc = 'US';
}
return $lc;
}
sub list {
my ( $self, $conf ) = @_;
$conf ||= {};
my $prefix = $conf->{prefix};
my $marker = undef;
my $end = 0;
return Data::Stream::Bulk::Callback->new(
callback => sub {
return undef if $end;
my $http_request = Net::Amazon::S3::Request::ListBucket->new(
s3 => $self->client->s3,
bucket => $self->name,
marker => $marker,
prefix => $prefix,
)->http_request;
my $xpc = $self->client->_send_request_xpc($http_request);
my @objects;
foreach my $node (
$xpc->findnodes('/s3:ListBucketResult/s3:Contents') )
{
my $etag = $xpc->findvalue( "./s3:ETag", $node );
$etag =~ s/^"//;
$etag =~ s/"$//;
# storage_class => $xpc->findvalue( ".//s3:StorageClass", $node ),
# owner_id => $xpc->findvalue( ".//s3:ID", $node ),
# owner_displayname =>
# $xpc->findvalue( ".//s3:DisplayName", $node ),
push @objects,
Net::Amazon::S3::Client::Object->new(
client => $self->client,
bucket => $self,
key => $xpc->findvalue( './s3:Key', $node ),
last_modified =>
$xpc->findvalue( './s3:LastModified', $node ),
etag => $etag,
size => $xpc->findvalue( './s3:Size', $node ),
);
}
return undef unless @objects;
my $is_truncated
= scalar $xpc->findvalue(
'/s3:ListBucketResult/s3:IsTruncated') eq 'true'
? 1
: 0;
$end = 1 unless $is_truncated;
$marker = $xpc->findvalue('/s3:ListBucketResult/s3:NextMarker')
|| $objects[-1]->key;
return \@objects;
}
);
}
sub object {
my ( $self, %conf ) = @_;
return Net::Amazon::S3::Client::Object->new(
client => $self->client,
bucket => $self,
%conf,
);
}
1;
__END__
=head1 NAME
Net::Amazon::S3::Client::Bucket - An easy-to-use Amazon S3 client bucket
=head1 SYNOPSIS
# return the bucket name
print $bucket->name . "\n";
# return the bucket location constraint
print "Bucket is in the " . $bucket->location_constraint . "\n";
# return the ACL XML
my $acl = $bucket->acl;
# list objects in the bucket
# this returns a L<Data::Stream::Bulk> object which returns a
# stream of L<Net::Amazon::S3::Client::Object> objects, as it may
# have to issue multiple API requests
my $stream = $bucket->list;
until ( $stream->is_done ) {
foreach my $object ( $stream->items ) {
...
}
}
# or list by a prefix
my $prefix_stream = $bucket->list( { prefix => 'logs/' } );
# returns a L<Net::Amazon::S3::Client::Object>, which can then
# be used to get or put
my $object = $bucket->object( key => 'this is the key' );
# delete the bucket (it must be empty)
$bucket->delete;
=head1 DESCRIPTION
This module represents buckets.
=head1 METHODS
=head2 acl
# return the ACL XML
my $acl = $bucket->acl;
=head2 delete
# delete the bucket (it must be empty)
$bucket->delete;
=head2 list
# list objects in the bucket
# this returns a L<Data::Stream::Bulk> object which returns a
# stream of L<Net::Amazon::S3::Client::Object> objects, as it may
# have to issue multiple API requests
my $stream = $bucket->list;
until ( $stream->is_done ) {
foreach my $object ( $stream->items ) {
...
}
}
# or list by a prefix
my $prefix_stream = $bucket->list( { prefix => 'logs/' } );
=head2 location_constraint
# return the bucket location constraint
print "Bucket is in the " . $bucket->location_constraint . "\n";
=head2 name
# return the bucket name
print $bucket->name . "\n";
=head2 object
# returns a L<Net::Amazon::S3::Client::Object>, which can then
# be used to get or put
my $object = $bucket->object( key => 'this is the key' );
|