This repository has been archived by the owner on May 28, 2020. It is now read-only.
forked from acme/net-amazon-s3
/
Object.pm
executable file
·534 lines (419 loc) · 14.5 KB
/
Object.pm
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
package Net::Amazon::S3::Client::Object;
use Moose 0.85;
use MooseX::StrictConstructor 0.16;
use DateTime::Format::HTTP;
use Digest::MD5 qw(md5 md5_hex);
use Digest::MD5::File qw(file_md5 file_md5_hex);
use File::stat;
use MIME::Base64;
use Moose::Util::TypeConstraints;
use MooseX::Types::DateTime::MoreCoercions 0.07 qw( DateTime );
use IO::File 1.14;
# ABSTRACT: An easy-to-use Amazon S3 client object
enum 'AclShort' =>
qw(private public-read public-read-write authenticated-read);
has 'client' =>
( is => 'ro', isa => 'Net::Amazon::S3::Client', required => 1 );
has 'bucket' =>
( is => 'ro', isa => 'Net::Amazon::S3::Client::Bucket', required => 1 );
has 'key' => ( is => 'ro', isa => 'Str', required => 1 );
has 'etag' => ( is => 'ro', isa => 'Etag', required => 0 );
has 'size' => ( is => 'ro', isa => 'Int', required => 0 );
has 'last_modified' =>
( is => 'ro', isa => DateTime, coerce => 1, required => 0 );
has 'expires' => ( is => 'rw', isa => DateTime, coerce => 1, required => 0 );
has 'acl_short' =>
( is => 'ro', isa => 'AclShort', required => 0, default => 'private' );
has 'content_type' => (
is => 'ro',
isa => 'Str',
required => 0,
default => 'binary/octet-stream'
);
has 'content_disposition' => (
is => 'ro',
isa => 'Str',
required => 0,
);
has 'content_encoding' => (
is => 'ro',
isa => 'Str',
required => 0,
);
__PACKAGE__->meta->make_immutable;
sub exists {
my $self = shift;
my $http_request = Net::Amazon::S3::Request::GetObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
method => 'HEAD',
)->http_request;
my $http_response = $self->client->_send_request_raw($http_request);
return $http_response->code == 200 ? 1 : 0;
}
sub get {
my $self = shift;
my $http_request = Net::Amazon::S3::Request::GetObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
method => 'GET',
)->http_request;
my $http_response = $self->client->_send_request($http_request);
my $content = $http_response->content;
my $md5_hex = md5_hex($content);
my $etag = $self->etag || $self->_etag($http_response);
confess 'Corrupted download' if( !$self->_is_multipart_etag($etag) && $etag ne $md5_hex);
return $content;
}
sub get_filename {
my ( $self, $filename ) = @_;
my $http_request = Net::Amazon::S3::Request::GetObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
method => 'GET',
)->http_request;
my $http_response
= $self->client->_send_request( $http_request, $filename );
my $md5_hex = file_md5_hex($filename);
my $etag = $self->etag || $self->_etag($http_response);
confess 'Corrupted download' if( !$self->_is_multipart_etag($etag) && $etag ne $md5_hex);
}
sub put {
my ( $self, $value ) = @_;
my $md5 = md5($value);
my $md5_hex = unpack( 'H*', $md5 );
my $md5_base64 = encode_base64($md5);
chomp $md5_base64;
my $conf = {
'Content-MD5' => $md5_base64,
'Content-Length' => length $value,
'Content-Type' => $self->content_type,
};
if ( $self->expires ) {
$conf->{Expires}
= DateTime::Format::HTTP->format_datetime( $self->expires );
}
if ( $self->content_encoding ) {
$conf->{'Content-Encoding'} = $self->content_encoding;
}
if ( $self->content_disposition ) {
$conf->{'Content-Disposition'} = $self->content_disposition;
}
my $http_request = Net::Amazon::S3::Request::PutObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
value => $value,
headers => $conf,
acl_short => $self->acl_short,
)->http_request;
my $http_response = $self->client->_send_request($http_request);
confess 'Error uploading' if $http_response->code != 200;
my $etag = $self->_etag($http_response);
confess 'Corrupted upload' if $etag ne $md5_hex;
}
sub put_filename {
my ( $self, $filename ) = @_;
my $md5_hex = $self->etag || file_md5_hex($filename);
my $size = $self->size;
unless ($size) {
my $stat = stat($filename) || confess("No $filename: $!");
$size = $stat->size;
}
my $md5 = pack( 'H*', $md5_hex );
my $md5_base64 = encode_base64($md5);
chomp $md5_base64;
my $conf = {
'Content-MD5' => $md5_base64,
'Content-Length' => $size,
'Content-Type' => $self->content_type,
};
if ( $self->expires ) {
$conf->{Expires}
= DateTime::Format::HTTP->format_datetime( $self->expires );
}
if ( $self->content_encoding ) {
$conf->{'Content-Encoding'} = $self->content_encoding;
}
if ( $self->content_disposition ) {
$conf->{'Content-Disposition'} = $self->content_disposition;
}
my $http_request = Net::Amazon::S3::Request::PutObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
value => $self->_content_sub($filename),
headers => $conf,
acl_short => $self->acl_short,
)->http_request;
my $http_response = $self->client->_send_request($http_request);
confess 'Error uploading' . $http_response->as_string
if $http_response->code != 200;
confess 'Corrupted upload' if $self->_etag($http_response) ne $md5_hex;
}
sub delete {
my $self = shift;
my $http_request = Net::Amazon::S3::Request::DeleteObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
)->http_request;
$self->client->_send_request($http_request);
}
sub initiate_multipart_upload {
my $self = shift;
my $http_request = Net::Amazon::S3::Request::InitiateMultipartUpload->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
)->http_request;
my $res = $self->client->_send_request($http_request);
return unless $res->is_success;
my $doc = $self->client->s3->libxml->parse_string($res->content);
my $xpc = XML::LibXML::XPathContext->new($doc);
$xpc->registerNs( 's3',
'http://s3.amazonaws.com/doc/2006-03-01/' );
my $upload_id = $xpc->findvalue('//s3:UploadId');
return $upload_id;
}
sub complete_multipart_upload {
my $self = shift;
my %args = ref($_[0]) ? {$_[0]} : @_;
#set default args
$args{s3} = $self->client->s3;
$args{key} = $self->key;
$args{bucket} = $self->bucket->name;
my $http_request = Net::Amazon::S3::Request::CompleteMultipartUpload->new(%args)->http_request;
return $self->client->_send_request($http_request);
}
sub put_part {
my $self = shift;
my %args = ref($_[0]) ? {$_[0]} : @_;
#set default args
$args{s3} = $self->client->s3;
$args{key} = $self->key;
$args{bucket} = $self->bucket->name;
my $http_request = Net::Amazon::S3::Request::PutPart->new(%args)->http_request;
return $self->client->_send_request($http_request);
}
sub list_parts {
confess "Not implemented";
#TODO - Net::Amazon::S3::Request:ListParts is implemented, but need to define best interface at this level. Currently returns raw XML
}
sub uri {
my $self = shift;
return Net::Amazon::S3::Request::GetObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
method => 'GET',
)->http_request->uri;
}
sub query_string_authentication_uri {
my $self = shift;
return Net::Amazon::S3::Request::GetObject->new(
s3 => $self->client->s3,
bucket => $self->bucket->name,
key => $self->key,
method => 'GET',
)->query_string_authentication_uri( $self->expires->epoch );
}
sub _content_sub {
my $self = shift;
my $filename = shift;
my $stat = stat($filename);
my $remaining = $stat->size;
my $blksize = $stat->blksize || 4096;
confess "$filename not a readable file with fixed size"
unless -r $filename and ( -f _ || $remaining );
my $fh = IO::File->new( $filename, 'r' )
or confess "Could not open $filename: $!";
$fh->binmode;
return sub {
my $buffer;
# upon retries the file is closed and we must reopen it
unless ( $fh->opened ) {
$fh = IO::File->new( $filename, 'r' )
or confess "Could not open $filename: $!";
$fh->binmode;
$remaining = $stat->size;
}
# warn "read remaining $remaining";
unless ( my $read = $fh->read( $buffer, $blksize ) ) {
# warn "read $read buffer $buffer remaining $remaining";
confess
"Error while reading upload content $filename ($remaining remaining) $!"
if $! and $remaining;
# otherwise, we found EOF
$fh->close
or confess "close of upload content $filename failed: $!";
$buffer ||= ''
; # LWP expects an emptry string on finish, read returns 0
}
$remaining -= length($buffer);
return $buffer;
};
}
sub _etag {
my ( $self, $http_response ) = @_;
my $etag = $http_response->header('ETag');
if ($etag) {
$etag =~ s/^"//;
$etag =~ s/"$//;
}
return $etag;
}
sub _is_multipart_etag {
my ( $self, $etag ) = @_;
return 1 if($etag =~ /\-\d+$/);
}
1;
__END__
=for test_synopsis
no strict 'vars'
=head1 SYNOPSIS
# show the key
print $object->key . "\n";
# show the etag of an existing object (if fetched by listing
# a bucket)
print $object->etag . "\n";
# show the size of an existing object (if fetched by listing
# a bucket)
print $object->size . "\n";
# to create a new object
my $object = $bucket->object( key => 'this is the key' );
$object->put('this is the value');
# to get the vaue of an object
my $value = $object->get;
# to see if an object exists
if ($object->exists) { ... }
# to delete an object
$object->delete;
# to create a new object which is publically-accessible with a
# content-type of text/plain which expires on 2010-01-02
my $object = $bucket->object(
key => 'this is the public key',
acl_short => 'public-read',
content_type => 'text/plain',
expires => '2010-01-02',
);
$object->put('this is the public value');
# return the URI of a publically-accessible object
my $uri = $object->uri;
# upload a file
my $object = $bucket->object(
key => 'images/my_hat.jpg',
content_type => 'image/jpeg',
);
$object->put_filename('hat.jpg');
# upload a file if you already know its md5_hex and size
my $object = $bucket->object(
key => 'images/my_hat.jpg',
content_type => 'image/jpeg',
etag => $md5_hex,
size => $size,
);
$object->put_filename('hat.jpg');
# download the value of the object into a file
my $object = $bucket->object( key => 'images/my_hat.jpg' );
$object->get_filename('hat_backup.jpg');
# use query string authentication
my $object = $bucket->object(
key => 'images/my_hat.jpg',
expires => '2009-03-01',
);
my $uri = $object->query_string_authentication_uri();
=head1 DESCRIPTION
This module represents objects in buckets.
=head1 METHODS
=head2 etag
# show the etag of an existing object (if fetched by listing
# a bucket)
print $object->etag . "\n";
=head2 delete
# to delete an object
$object->delete;
=head2 exists
# to see if an object exists
if ($object->exists) { ... }
=head2 get
# to get the vaue of an object
my $value = $object->get;
=head2 get_filename
# download the value of the object into a file
my $object = $bucket->object( key => 'images/my_hat.jpg' );
$object->get_filename('hat_backup.jpg');
=head2 key
# show the key
print $object->key . "\n";
=head2 put
# to create a new object
my $object = $bucket->object( key => 'this is the key' );
$object->put('this is the value');
# to create a new object which is publically-accessible with a
# content-type of text/plain
my $object = $bucket->object(
key => 'this is the public key',
acl_short => 'public-read',
content_type => 'text/plain',
);
$object->put('this is the public value');
You may also set Content-Encoding using content_encoding, and
Content-Disposition using content_disposition.
=head2 put_filename
# upload a file
my $object = $bucket->object(
key => 'images/my_hat.jpg',
content_type => 'image/jpeg',
);
$object->put_filename('hat.jpg');
# upload a file if you already know its md5_hex and size
my $object = $bucket->object(
key => 'images/my_hat.jpg',
content_type => 'image/jpeg',
etag => $md5_hex,
size => $size,
);
$object->put_filename('hat.jpg');
You may also set Content-Encoding using content_encoding, and
Content-Disposition using content_disposition.
=head2 query_string_authentication_uri
# use query string authentication
my $object = $bucket->object(
key => 'images/my_hat.jpg',
expires => '2009-03-01',
);
my $uri = $object->query_string_authentication_uri();
=head2 size
# show the size of an existing object (if fetched by listing
# a bucket)
print $object->size . "\n";
=head2 uri
# return the URI of a publically-accessible object
my $uri = $object->uri;
=head2 initiate_multipart_upload
#initiate a new multipart upload for this object
my $object = $bucket->object(
key => 'massive_video.avi'
);
my $upload_id = $object->initiate_multipart_upload;
=head2 put_part
#add a part to a multipart upload
my $put_part_response = $object->put_part(
upload_id => $upload_id,
part_number => 1,
value => $chunk_content,
);
my $part_etag = $put_part_response->header('ETag')
Returns an L<HTTP::Response> object. It is necessary to keep the ETags for each part, as these are required to complete the upload.
=head2 complete_multipart_upload
#complete a multipart upload
$object->complete_multipart_upload(
upload_id => $upload_id,
etags => [$etag_1, $etag_2],
part_numbers => [$part_number_1, $part_number2],
);
The etag and part_numbers parameters are ordered lists specifying the part numbers and ETags for each individual part of the multipart upload.