Ben Copsey

Merge branch 'new-s3-changes' into v1.8-merge

Conflicts:
	Mac.xcodeproj/project.pbxproj
... ... @@ -60,15 +60,12 @@
// Use for deleting buckets - they must be empty for this to succeed
+ (id)DELETERequestWithBucket:(NSString *)bucket;
//Builds a query string out of the list parameters we supplied
- (void)createQueryString;
@property (retain) NSString *bucket;
@property (retain) NSString *subResource;
@property (retain) NSString *prefix;
@property (retain) NSString *marker;
@property (assign) int maxResultCount;
@property (retain) NSString *delimiter;
@property (retain, nonatomic) NSString *bucket;
@property (retain, nonatomic) NSString *subResource;
@property (retain, nonatomic) NSString *prefix;
@property (retain, nonatomic) NSString *marker;
@property (assign, nonatomic) int maxResultCount;
@property (retain, nonatomic) NSString *delimiter;
@property (retain, readonly) NSMutableArray *objects;
@property (retain, readonly) NSMutableArray *commonPrefixes;
@property (assign, readonly) BOOL isTruncated;
... ...
... ... @@ -30,20 +30,19 @@
+ (id)requestWithBucket:(NSString *)bucket
{
ASIS3BucketRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com",bucket]]] autorelease];
ASIS3BucketRequest *request = [[[self alloc] initWithURL:nil] autorelease];
[request setBucket:bucket];
return request;
}
+ (id)requestWithBucket:(NSString *)bucket subResource:(NSString *)subResource
{
ASIS3BucketRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com/?%@",bucket,subResource]]] autorelease];
ASIS3BucketRequest *request = [[[self alloc] initWithURL:nil] autorelease];
[request setBucket:bucket];
[request setSubResource:subResource];
return request;
}
+ (id)PUTRequestWithBucket:(NSString *)bucket
{
ASIS3BucketRequest *request = [self requestWithBucket:bucket];
... ... @@ -80,8 +79,14 @@
return [NSString stringWithFormat:@"/%@/",[self bucket]];
}
- (void)createQueryString
- (void)buildURL
{
NSString *baseURL;
if ([self subResource]) {
baseURL = [NSString stringWithFormat:@"%@://%@.%@/?%@",[self requestScheme],[self bucket],[[self class] S3Host],[self subResource]];
} else {
baseURL = [NSString stringWithFormat:@"%@://%@.%@",[self requestScheme],[self bucket],[[self class] S3Host]];
}
NSMutableArray *queryParts = [[[NSMutableArray alloc] init] autorelease];
if ([self prefix]) {
[queryParts addObject:[NSString stringWithFormat:@"prefix=%@",[[self prefix] stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]]];
... ... @@ -95,20 +100,16 @@
if ([self maxResultCount] > 0) {
[queryParts addObject:[NSString stringWithFormat:@"max-keys=%hi",[self maxResultCount]]];
}
if ([queryParts count])
{
if ([queryParts count]) {
NSString* template = @"%@?%@";
if ([[self subResource] length] > 0) {
template = @"%@&%@";
}
[self setURL:[NSURL URLWithString:[NSString stringWithFormat:template,[[self url] absoluteString],[queryParts componentsJoinedByString:@"&"]]]];
}
}
[self setURL:[NSURL URLWithString:[NSString stringWithFormat:template,baseURL,[queryParts componentsJoinedByString:@"&"]]]];
} else {
[self setURL:[NSURL URLWithString:baseURL]];
- (void)main
{
[self createQueryString];
[super main];
}
}
- (void)parser:(NSXMLParser *)parser didStartElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName attributes:(NSDictionary *)attributeDict
... ... @@ -146,7 +147,6 @@
}
}
#pragma mark NSCopying
- (id)copyWithZone:(NSZone *)zone
... ... @@ -161,9 +161,6 @@
return newRequest;
}
@synthesize bucket;
@synthesize subResource;
@synthesize currentObject;
... ...
... ... @@ -10,6 +10,9 @@
#import <Foundation/Foundation.h>
#import "ASIS3Request.h"
// Constants for storage class
extern NSString *const ASIS3StorageClassStandard;
extern NSString *const ASIS3StorageClassReducedRedundancy;
@interface ASIS3ObjectRequest : ASIS3Request {
... ... @@ -28,7 +31,14 @@
// Can be autodetected when PUTing a file from disk, will default to 'application/octet-stream' when PUTing data
NSString *mimeType;
// Set this to specify you want to work with a particular subresource (eg an acl for that resource)
// See requestWithBucket:key:subResource:, below.
NSString* subResource;
// The storage class to be used for PUT requests
// Set this to ASIS3StorageClassReducedRedundancy to save money on storage, at (presumably) a slightly higher risk you will lose the data
// If this is not set, no x-amz-storage-class header will be sent to S3, and their default will be used
NSString *storageClass;
}
// Create a request, building an appropriate url
... ... @@ -60,11 +70,11 @@
// Creates a HEAD request for the object at path
+ (id)HEADRequestWithBucket:(NSString *)bucket key:(NSString *)key;
@property (retain) NSString *bucket;
@property (retain) NSString *key;
@property (retain) NSString *sourceBucket;
@property (retain) NSString *sourceKey;
@property (retain, nonatomic) NSString *bucket;
@property (retain, nonatomic) NSString *key;
@property (retain, nonatomic) NSString *sourceBucket;
@property (retain, nonatomic) NSString *sourceKey;
@property (retain, nonatomic) NSString *mimeType;
@property (retain) NSString *subResource;
@property (retain, nonatomic) NSString *subResource;
@property (retain, nonatomic) NSString *storageClass;
@end
... ...
... ... @@ -8,6 +8,8 @@
#import "ASIS3ObjectRequest.h"
NSString *const ASIS3StorageClassStandard = @"STANDARD";
NSString *const ASIS3StorageClassReducedRedundancy = @"REDUCED_REDUNDANCY";
@implementation ASIS3ObjectRequest
... ... @@ -21,8 +23,7 @@
+ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key
{
NSString *path = [ASIS3Request stringByURLEncodingForS3Path:key];
ASIS3ObjectRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com%@",bucket,path]]] autorelease];
ASIS3ObjectRequest *request = [[[self alloc] initWithURL:nil] autorelease];
[request setBucket:bucket];
[request setKey:key];
return request;
... ... @@ -30,8 +31,7 @@
+ (id)requestWithBucket:(NSString *)bucket key:(NSString *)key subResource:(NSString *)subResource
{
NSString *path = [ASIS3Request stringByURLEncodingForS3Path:key];
ASIS3ObjectRequest *request = [[[self alloc] initWithURL:[NSURL URLWithString:[NSString stringWithFormat:@"http://%@.s3.amazonaws.com%@?%@",bucket,path,subResource]]] autorelease];
ASIS3ObjectRequest *request = [[[self alloc] initWithURL:nil] autorelease];
[request setSubResource:subResource];
[request setBucket:bucket];
[request setKey:key];
... ... @@ -79,8 +79,6 @@
return request;
}
- (id)copyWithZone:(NSZone *)zone
{
ASIS3ObjectRequest *newRequest = [super copyWithZone:zone];
... ... @@ -100,9 +98,19 @@
[sourceKey release];
[sourceBucket release];
[subResource release];
[storageClass release];
[super dealloc];
}
- (void)buildURL
{
if ([self subResource]) {
[self setURL:[NSURL URLWithString:[NSString stringWithFormat:@"%@://%@.%@%@?%@",[self requestScheme],[self bucket],[[self class] S3Host],[ASIS3Request stringByURLEncodingForS3Path:[self key]],[self subResource]]]];
} else {
[self setURL:[NSURL URLWithString:[NSString stringWithFormat:@"%@://%@.%@%@",[self requestScheme],[self bucket],[[self class] S3Host],[ASIS3Request stringByURLEncodingForS3Path:[self key]]]]];
}
}
- (NSString *)mimeType
{
if (mimeType) {
... ... @@ -129,6 +137,9 @@
NSString *path = [ASIS3Request stringByURLEncodingForS3Path:[self sourceKey]];
[headers setObject:[[self sourceBucket] stringByAppendingString:path] forKey:@"x-amz-copy-source"];
}
if ([self storageClass]) {
[headers setObject:[self storageClass] forKey:@"x-amz-storage-class"];
}
return headers;
}
... ... @@ -141,12 +152,11 @@
return [super stringToSignForHeaders:canonicalizedAmzHeaders resource:canonicalizedResource];
}
@synthesize bucket;
@synthesize key;
@synthesize sourceBucket;
@synthesize sourceKey;
@synthesize mimeType;
@synthesize subResource;
@synthesize storageClass;
@end
... ...
... ... @@ -18,16 +18,24 @@
// See http://docs.amazonwebservices.com/AmazonS3/2006-03-01/index.html?RESTAccessPolicy.html for what these mean
extern NSString *const ASIS3AccessPolicyPrivate; // This is the default in S3 when no access policy header is provided
extern NSString *const ASIS3AccessPolicyPublicRead;
extern NSString *const ASIS3AccessPolicyPublicReadWrote;
extern NSString *const ASIS3AccessPolicyPublicReadWrite;
extern NSString *const ASIS3AccessPolicyAuthenticatedRead;
extern NSString *const ASIS3AccessPolicyBucketOwnerRead;
extern NSString *const ASIS3AccessPolicyBucketOwnerFullControl;
// Constants for requestScheme - defaults is ASIS3RequestSchemeHTTP
extern NSString *const ASIS3RequestSchemeHTTP;
extern NSString *const ASIS3RequestSchemeHTTPS;
typedef enum _ASIS3ErrorType {
ASIS3ResponseParsingFailedType = 1,
ASIS3ResponseErrorType = 2
} ASIS3ErrorType;
@interface ASIS3Request : ASIHTTPRequest <NSCopying, NSXMLParserDelegate> {
// Your S3 access key. Set it on the request, or set it globally using [ASIS3Request setSharedAccessKey:]
... ... @@ -36,6 +44,9 @@ typedef enum _ASIS3ErrorType {
// Your S3 secret access key. Set it on the request, or set it globally using [ASIS3Request setSharedSecretAccessKey:]
NSString *secretAccessKey;
// Set to ASIS3RequestSchemeHTTPS to send your requests via HTTPS (default is ASIS3RequestSchemeHTTP)
NSString *requestScheme;
// The string that will be used in the HTTP date header. Generally you'll want to ignore this and let the class add the current date for you, but the accessor is used by the tests
NSString *dateString;
... ... @@ -68,7 +79,7 @@ typedef enum _ASIS3ErrorType {
+ (void)setSharedAccessKey:(NSString *)newAccessKey;
+ (NSString *)sharedSecretAccessKey;
+ (void)setSharedSecretAccessKey:(NSString *)newAccessKey;
# pragma mark helpers
// Returns a date formatter than can be used to parse a date from S3
... ... @@ -82,7 +93,11 @@ typedef enum _ASIS3ErrorType {
// You shouldn't normally need to use this yourself
+ (NSString *)stringByURLEncodingForS3Path:(NSString *)key;
// Returns a string for the hostname used for S3 requests. You shouldn't ever need to change this.
+ (NSString *)S3Host;
// This is called automatically before the request starts to build the request URL (if one has not been manually set already)
- (void)buildURL;
@property (retain) NSString *dateString;
@property (retain) NSString *accessKey;
... ... @@ -90,4 +105,5 @@ typedef enum _ASIS3ErrorType {
@property (retain) NSString *accessPolicy;
@property (retain) NSString *currentXMLElementContent;
@property (retain) NSMutableArray *currentXMLElementStack;
@property (retain) NSString *requestScheme;
@end
... ...
... ... @@ -9,10 +9,15 @@
#import "ASIS3Request.h"
#import <CommonCrypto/CommonHMAC.h>
NSString* const ASIS3AccessPolicyPrivate = @"private";
NSString* const ASIS3AccessPolicyPublicRead = @"public-read";
NSString* const ASIS3AccessPolicyPublicReadWrote = @"public-read-write";
NSString* const ASIS3AccessPolicyAuthenticatedRead = @"authenticated-read";
NSString *const ASIS3AccessPolicyPrivate = @"private";
NSString *const ASIS3AccessPolicyPublicRead = @"public-read";
NSString *const ASIS3AccessPolicyPublicReadWrite = @"public-read-write";
NSString *const ASIS3AccessPolicyAuthenticatedRead = @"authenticated-read";
NSString *const ASIS3AccessPolicyBucketOwnerRead = @"bucket-owner-read";
NSString *const ASIS3AccessPolicyBucketOwnerFullControl = @"bucket-owner-full-control";
NSString *const ASIS3RequestSchemeHTTP = @"http";
NSString *const ASIS3RequestSchemeHTTPS = @"https";
static NSString *sharedAccessKey = nil;
static NSString *sharedSecretAccessKey = nil;
... ... @@ -29,6 +34,7 @@ static NSString *sharedSecretAccessKey = nil;
self = [super initWithURL:newURL];
// After a bit of experimentation/guesswork, this number seems to reduce the chance of a 'RequestTimeout' error
[self setPersistentConnectionTimeoutSeconds:20];
[self setRequestScheme:ASIS3RequestSchemeHTTP];
return self;
}
... ... @@ -41,6 +47,7 @@ static NSString *sharedSecretAccessKey = nil;
[accessKey release];
[secretAccessKey release];
[accessPolicy release];
[requestScheme release];
[super dealloc];
}
... ... @@ -67,6 +74,14 @@ static NSString *sharedSecretAccessKey = nil;
return headers;
}
- (void)main
{
if (![self url]) {
[self buildURL];
}
[super main];
}
- (NSString *)canonicalizedResource
{
return @"/";
... ... @@ -79,6 +94,9 @@ static NSString *sharedSecretAccessKey = nil;
- (void)buildRequestHeaders
{
if (![self url]) {
[self buildURL];
}
[super buildRequestHeaders];
// If an access key / secret access key haven't been set for this request, let's use the shared keys
... ... @@ -100,7 +118,7 @@ static NSString *sharedSecretAccessKey = nil;
// Add a header for the access policy if one was set, otherwise we won't add one (and S3 will default to private)
NSMutableDictionary *amzHeaders = [self S3Headers];
NSString *canonicalizedAmzHeaders = @"";
for (NSString *header in [amzHeaders keyEnumerator]) {
for (NSString *header in [amzHeaders keysSortedByValueUsingSelector:@selector(compare:)]) {
canonicalizedAmzHeaders = [NSString stringWithFormat:@"%@%@:%@\n",canonicalizedAmzHeaders,[header lowercaseString],[amzHeaders objectForKey:header]];
[self addRequestHeader:header value:[amzHeaders objectForKey:header]];
}
... ... @@ -274,6 +292,14 @@ static NSString *sharedSecretAccessKey = nil;
return [NSData dataWithBytes:digest length:CC_SHA1_DIGEST_LENGTH];
}
+ (NSString *)S3Host
{
return @"s3.amazonaws.com";
}
- (void)buildURL
{
}
@synthesize dateString;
@synthesize accessKey;
... ... @@ -281,4 +307,5 @@ static NSString *sharedSecretAccessKey = nil;
@synthesize currentXMLElementContent;
@synthesize currentXMLElementStack;
@synthesize accessPolicy;
@synthesize requestScheme;
@end
... ...
... ... @@ -21,10 +21,10 @@
+ (id)serviceRequest
{
return [[[self alloc] initWithURL:[NSURL URLWithString:@"http://s3.amazonaws.com"]] autorelease];
ASIS3ServiceRequest *request = [[[self alloc] initWithURL:nil] autorelease];
return request;
}
- (id)initWithURL:(NSURL *)newURL
{
self = [super initWithURL:newURL];
... ... @@ -32,7 +32,6 @@
return self;
}
- (void)dealloc
{
[buckets release];
... ... @@ -42,6 +41,11 @@
[super dealloc];
}
- (void)buildURL
{
[self setURL:[NSURL URLWithString:[NSString stringWithFormat:@"%@://%@",[self requestScheme],[[self class] S3Host]]]];
}
- (void)parser:(NSXMLParser *)parser didStartElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName attributes:(NSDictionary *)attributeDict
{
if ([elementName isEqualToString:@"Bucket"]) {
... ...
... ... @@ -21,6 +21,8 @@
- (void)testListRequest;
- (void)testSubclasses;
- (void)createTestBucket;
- (void)testCopy;
- (void)testHTTPS;
@property (retain,nonatomic) ASINetworkQueue *networkQueue;
@end
... ...
... ... @@ -20,8 +20,6 @@ static NSString *accessKey = @"";
// You should run these tests on a bucket that does not yet exist
static NSString *bucket = @"";
// Used for subclass test
@interface ASIS3ObjectRequestSubclass : ASIS3ObjectRequest {}
@end
... ... @@ -220,6 +218,7 @@ static NSString *bucket = @"";
ASIS3ObjectRequest *request = [ASIS3ObjectRequest PUTRequestForFile:filePath withBucket:bucket key:key];
[request setSecretAccessKey:secretAccessKey];
[request setAccessKey:accessKey];
[request setStorageClass:ASIS3StorageClassReducedRedundancy];
[request startSynchronous];
success = [[request responseString] isEqualToString:@""];
GHAssertTrue(success,@"Failed to PUT a file to S3");
... ... @@ -452,7 +451,7 @@ static NSString *bucket = @"";
[listRequest setPrefix:@"foo"];
[listRequest setMarker:@"bar"];
[listRequest setMaxResultCount:5];
[listRequest createQueryString];
[listRequest buildURL];
NSString *expectedURL = [NSString stringWithFormat:@"http://%@.s3.amazonaws.com/?acl&prefix=foo&marker=bar&delimiter=/&max-keys=5",bucket];
success = ([[[listRequest url] absoluteString] isEqualToString:expectedURL]);
GHAssertTrue(success,@"Generated the wrong url when requesting a subresource");
... ... @@ -757,6 +756,94 @@ static NSString *bucket = @"";
}
- (void)testHTTPS
{
[ASIS3Request setSharedAccessKey:accessKey];
[ASIS3Request setSharedSecretAccessKey:secretAccessKey];
// Create a bucket
ASIS3Request *request = [ASIS3BucketRequest PUTRequestWithBucket:bucket];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
GHAssertNil([request error],@"Failed to create a bucket");
// PUT something in it
NSString *key = @"king";
request = [ASIS3ObjectRequest PUTRequestForData:[@"fink" dataUsingEncoding:NSUTF8StringEncoding] withBucket:bucket key:key];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
BOOL success = [[request responseString] isEqualToString:@""];
GHAssertTrue(success,@"Failed to PUT some data into S3");
// GET it
request = [ASIS3ObjectRequest requestWithBucket:bucket key:key];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
success = [[request responseString] isEqualToString:@"fink"];
GHAssertTrue(success,@"Failed to GET the correct data from S3");
// DELETE it
request = [ASIS3ObjectRequest DELETERequestWithBucket:bucket key:@"king"];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
success = [[request responseString] isEqualToString:@""];
GHAssertTrue(success,@"Failed to DELETE the object from S3");
// Delete the bucket
request = [ASIS3BucketRequest DELETERequestWithBucket:bucket];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
GHAssertNil([request error],@"Failed to delete a bucket");
[ASIS3Request setSharedAccessKey:nil];
[ASIS3Request setSharedSecretAccessKey:nil];
}
// Ideally this test would actually parse the ACL XML and check it, but for now it just makes sure S3 doesn't return an error
- (void)testCannedACLs
{
[ASIS3Request setSharedAccessKey:accessKey];
[ASIS3Request setSharedSecretAccessKey:secretAccessKey];
// Create a bucket
ASIS3Request *request = [ASIS3BucketRequest PUTRequestWithBucket:bucket];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
GHAssertNil([request error],@"Failed to create a bucket");
NSArray *ACLs = [NSArray arrayWithObjects:ASIS3AccessPolicyPrivate,ASIS3AccessPolicyPublicRead,ASIS3AccessPolicyPublicReadWrite,ASIS3AccessPolicyAuthenticatedRead,ASIS3AccessPolicyBucketOwnerRead,ASIS3AccessPolicyBucketOwnerFullControl,nil];
for (NSString *cannedACL in ACLs) {
// PUT object
NSString *key = @"king";
request = [ASIS3ObjectRequest PUTRequestForData:[@"fink" dataUsingEncoding:NSUTF8StringEncoding] withBucket:bucket key:key];
[request setAccessPolicy:cannedACL];
[request startSynchronous];
GHAssertNil([request error],@"Failed to PUT some data into S3");
// GET object ACL
request = [ASIS3ObjectRequest requestWithBucket:bucket key:key subResource:@"acl"];
[request startSynchronous];
GHAssertNil([request error],@"Failed to fetch the object");
}
// DELETE it
request = [ASIS3ObjectRequest DELETERequestWithBucket:bucket key:@"king"];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
BOOL success = [[request responseString] isEqualToString:@""];
GHAssertTrue(success,@"Failed to DELETE the object from S3");
// Delete the bucket
request = [ASIS3BucketRequest DELETERequestWithBucket:bucket];
[request setRequestScheme:ASIS3RequestSchemeHTTPS];
[request startSynchronous];
GHAssertNil([request error],@"Failed to delete a bucket");
[ASIS3Request setSharedAccessKey:nil];
[ASIS3Request setSharedSecretAccessKey:nil];
}
@synthesize networkQueue;
... ...