Synnefo » Pithos iOS Client

//

//  OpenStackRequest.m

//  OpenStack

//

//  Created by Mike Mayo on 10/8/10.

//  The OpenStack project is provided under the Apache 2.0 license.

//

#import "OpenStackRequest.h"

#import "Provider.h"

#import "OpenStackAccount.h"

#import "JSON.h"

#import "Container.h"

#import "StorageObject.h"

#import "Folder.h"

#import "AccountManager.h"

#import "APICallback.h"

#import "APILogEntry.h"

#import "NSString+Conveniences.h"

@implementation OpenStackRequest

@synthesize account, callback, errorAlerter, retryWithUpdatedURL, retryBaseURL, retryType, followUpSelectorString, notificationURL;

#pragma mark - Constructors

#pragma mark Generic

+ (id)requestWithoutToken:(OpenStackAccount *)account method:(NSString *)method url:(NSURL *)url {

	OpenStackRequest *request = [[[self alloc] initWithURL:url] autorelease];

    request.account = account;

	request.requestMethod = method;

    [request addRequestHeader:@"Content-Type" value:@"application/json"];

    request.timeOutSeconds = 60;

    request.numberOfTimesToRetryOnTimeout = 5;

    request.validatesSecureCertificate = !account.ignoreSSLErrors;

    request.retryWithUpdatedURL = NO;

	return request;

}

+ (id)request:(OpenStackAccount *)account method:(NSString *)method url:(NSURL *)url {

	OpenStackRequest *request = [self requestWithoutToken:account method:method url:url];

    request.retryWithUpdatedURL = (account.provider.manual ? NO : YES);

	[request addRequestHeader:@"X-Auth-Token" value:account.authToken];

	return request;

}

+ (id)filesRequest:(OpenStackAccount *)account method:(NSString *)method path:(NSString *)path {

    NSString *urlString = [[account.provider.authEndpointURL

                            URLByAppendingPathComponent:(account.sharingAccount ? account.sharingAccount : account.username)] description];

	NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"%@%@?format=json%@",

                                       urlString,

                                       path,

                                       (account.shared ? @"&shared=" : @"")]];

    OpenStackRequest *request = [self request:account method:method url:url];

    request.retryBaseURL = account.provider.authEndpointURL;

    request.retryType = OpenStackRequestTypeAuthEndpoint;

    return request;

}

#pragma mark NSCopying

- (id)copyWithZone:(NSZone *)zone {

    OpenStackRequest *newRequest = [super copyWithZone:zone];

    newRequest.account = self.account;

    newRequest.callback = self.callback;

    newRequest.errorAlerter = self.errorAlerter;

    newRequest.retryWithUpdatedURL = self.retryWithUpdatedURL;

    newRequest.retryBaseURL = self.retryBaseURL;

    newRequest.retryType = self.retryType;

    newRequest.followUpSelectorString = self.followUpSelectorString;

    newRequest.notificationURL = self.notificationURL;

    return newRequest;

}

#pragma mark Service Catalog

+ (id)serviceCatalogRequest:(OpenStackAccount *)account {

    OpenStackRequest *request = [self requestWithoutToken:account method:@"POST" url:account.provider.tokensURL];

    if (account.authToken.length)

        [request appendPostData:[[NSString stringWithFormat:@"{\"auth\":{\"token\":{\"id\":\"%@\"}}}", account.authToken]

                                 dataUsingEncoding:NSUTF8StringEncoding]];

    return request;

}

- (NSDictionary *)access {

    SBJSON *parser = [[[SBJSON alloc] init] autorelease];

    NSDictionary *access = [[parser objectWithString:[self responseString]] objectForKey:@"access"];

    return access;

}

- (NSDictionary *)token {

    return [[self access] objectForKey:@"token"];

}

- (NSArray *)serviceCatalog {

    return [[self access] objectForKey:@"serviceCatalog"];

}

- (NSArray *)user {

    return [[self access] objectForKey:@"user"];

}

#pragma mark User Catalog

+ (id)userCatalogRequest:(OpenStackAccount *)account displaynames:(NSArray *)displaynames UUIDs:(NSArray *)UUIDs {

    OpenStackRequest *request = [self request:account method:@"POST" url:account.provider.userCatalogURL];

    request.retryBaseURL = account.provider.userCatalogURL;

    request.retryType = OpenStackRequestTypeUserCatalog;

    NSMutableString *dataString = [NSMutableString stringWithString:@"{\"displaynames\":["];

    if (displaynames) {

        for (NSUInteger index = 0 ; index < displaynames.count ; index++) {

            [dataString appendFormat:@"\"%@\"%@",

             [[[displaynames objectAtIndex:index] stringByReplacingOccurrencesOfString:@"\\" withString:@"\\\\"]

              stringByReplacingOccurrencesOfString:@"\"" withString:@"\\\""],

             ((index == displaynames.count - 1) ? @"" : @",")];

        }

    }

    [dataString appendFormat:@"],\"uuids\":["];

    if (UUIDs) {

        for (NSUInteger index = 0 ; index < UUIDs.count ; index++) {

            [dataString appendFormat:@"\"%@\"%@", [UUIDs objectAtIndex:index], ((index == UUIDs.count - 1) ? @"" : @",")];

        }

    }

    [dataString appendFormat:@"]}"];

    [request appendPostData:[dataString dataUsingEncoding:NSUTF8StringEncoding]];

    return request;

}

- (NSDictionary *)catalogs {

    SBJSON *parser = [[[SBJSON alloc] init] autorelease];

    NSDictionary *catalogs = [parser objectWithString:[self responseString]];

    return catalogs;

}

- (NSDictionary *)displaynameCatalog {

    return [[self catalogs] objectForKey:@"displayname_catalog"];

}

- (NSDictionary *)UUIDCatalog {

    return [[self catalogs] objectForKey:@"uuid_catalog"];

}

#pragma mark Top

+ (id)authenticationRequest:(OpenStackAccount *)account {

	OpenStackRequest *request = [[[self alloc] initWithURL:account.provider.authEndpointURL] autorelease];

    request.account = account;

    request.requestMethod = @"GET";

    [request addRequestHeader:@"X-Auth-User" value:account.username];

    [request addRequestHeader:@"X-Auth-Token" value:account.authToken];

    request.timeOutSeconds = 60;

    request.numberOfTimesToRetryOnTimeout = 5;

    request.validatesSecureCertificate = !account.ignoreSSLErrors;

    request.retryWithUpdatedURL = (account.provider.manual ? NO : YES);

    request.retryBaseURL = account.provider.authEndpointURL;

    request.retryType = OpenStackRequestTypeAuthEndpoint;

	return request;

}

+ (id)getSharingAccountsRequest:(OpenStackAccount *)account

                         marker:(NSString *)marker sharingAccountsBuffer:(NSMutableDictionary *)sharingAccountsBuffer {

    OpenStackRequest *request = [self request:account method:@"GET"

                                          url:[NSURL URLWithString:[NSString stringWithFormat:@"%@?format=json",

                                                                    account.provider.authEndpointURL]]];

    request.retryBaseURL = account.provider.authEndpointURL;

    request.retryType = OpenStackRequestTypeAuthEndpoint;

    if (marker)

        request.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@&marker=%@", request.url.description, [NSString encodeToPercentEscape:marker]]];

    if (!sharingAccountsBuffer)

        sharingAccountsBuffer = [NSMutableDictionary dictionary];

    request.userInfo = [NSMutableDictionary dictionaryWithObjectsAndKeys:

                        sharingAccountsBuffer, @"sharingAccountsBuffer",

                        nil];

    return request;

}

+ (id)getSharingAccountsRequest:(OpenStackAccount *)account {

    return [self getSharingAccountsRequest:account marker:nil sharingAccountsBuffer:nil];

}

- (NSArray *)jsonSharingAccounts {

    return [[[[SBJSON alloc] init] autorelease] objectWithString:[self responseString]];

}

#pragma mark Account

+ (id)getStorageAccountInfoRequest:(OpenStackAccount *)account {

    return [self filesRequest:account method:@"HEAD" path:@""];

}

+ (id)getContainersRequest:(OpenStackAccount *)account

                    marker:(NSString *)marker containersBuffer:(NSMutableDictionary *)containersBuffer {

    OpenStackRequest *request = [self filesRequest:account method:@"GET" path:@""];

    if (marker)

        request.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@&marker=%@", request.url.description, [NSString encodeToPercentEscape:marker]]];

    if (!containersBuffer)

        containersBuffer = [NSMutableDictionary dictionary];

    request.userInfo = [NSMutableDictionary dictionaryWithObjectsAndKeys:

                        containersBuffer, @"containersBuffer",

                        nil];

    return request;

}

+ (id)getContainersRequest:(OpenStackAccount *)account {

    return [self getContainersRequest:account marker:nil containersBuffer:nil];

}

- (NSArray *)jsonContainers {

    return [[[[SBJSON alloc] init] autorelease] objectWithString:[self responseString]];

}

+ (id)writeAccountMetadataRequest:(OpenStackAccount *)account withAccountInfo:(NSDictionary *)accountInfo {

    OpenStackRequest *request = [self filesRequest:account method:@"POST" path:@""];

    NSMutableDictionary *groups = [accountInfo objectForKey:@"groups"];

    if (groups.count) {

        for (NSString *groupName in groups) {

            [request.requestHeaders setObject:[NSString encodeToPercentEscape:[groups objectForKey:groupName]]

                                       forKey:[NSString stringWithFormat:@"X-Account-Group-%@", [NSString encodeToPercentEscape:groupName]]];

        }

    } else {

        [request.requestHeaders setObject:@"" forKey:@"X-Account-Group-group"];

    }

    NSMutableDictionary *metadata = [accountInfo objectForKey:@"metadata"];

    for (NSString *key in metadata) {

        [request.requestHeaders setObject:[NSString encodeToPercentEscape:[metadata objectForKey:key]]

                                   forKey:[NSString stringWithFormat:@"X-Account-Meta-%@", [NSString encodeToPercentEscape:key]]];

    }

    return request;

}

#pragma mark Container

+ (id)getContainerInfoRequest:(OpenStackAccount *)account container:(Container *)container {

    return [self filesRequest:account method:@"HEAD" path:[NSString stringWithFormat:@"/%@", [NSString encodeToPercentEscape:container.name]]];

}

+ (id)createContainerRequest:(OpenStackAccount *)account container:(Container *)container {

    return [self filesRequest:account method:@"PUT" path:[NSString stringWithFormat:@"/%@", [NSString encodeToPercentEscape:container.name]]];

}

+ (id)deleteContainerRequest:(OpenStackAccount *)account container:(Container *)container {

    return [self filesRequest:account method:@"DELETE" path:[NSString stringWithFormat:@"/%@", [NSString encodeToPercentEscape:container.name]]];

}

+ (id)getObjectsRequest:(OpenStackAccount *)account container:(Container *)container

                 marker:(NSString *)marker objectsBuffer:(NSMutableDictionary *)objectsBuffer {

    OpenStackRequest *request = [self filesRequest:account method:@"GET" path:[NSString stringWithFormat:@"/%@", [NSString encodeToPercentEscape:container.name]]];

    if (marker)

        request.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@&marker=%@", request.url.description, [NSString encodeToPercentEscape:marker]]];

    if (!objectsBuffer)

        objectsBuffer = [NSMutableDictionary dictionary];

    request.userInfo = [NSMutableDictionary dictionaryWithObjectsAndKeys:

                        container, @"container",

                        objectsBuffer, @"objectsBuffer",

                        nil];

    return request;

}

+ (id)getObjectsRequest:(OpenStackAccount *)account container:(Container *)container {

    return [self getObjectsRequest:account container:container marker:nil objectsBuffer:nil];

}

- (NSArray *)jsonObjects {

    return [[[[SBJSON alloc] init] autorelease] objectWithString:[self responseString]];

}

+ (id)writeContainerPolicyRequest:(OpenStackAccount *)account container:(Container *)container {

    OpenStackRequest *request = [self filesRequest:account method:@"PUT" path:[NSString stringWithFormat:@"/%@", [NSString encodeToPercentEscape:container.name]]];

    [request.requestHeaders setObject:container.versioning forKey:@"X-Container-Policy-Versioning"];

    [request.requestHeaders setObject:[NSString stringWithFormat:@"%u", container.quota] forKey:@"X-Container-Policy-Quota"];

    return request;

}

#pragma mark Storage Object

+ (id)getObjectInfoRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object {

    NSString *objectFullPath = object.fullPath;

    if ([objectFullPath hasPrefix:@"/"])

        objectFullPath = [objectFullPath substringFromIndex:1];

    return [self filesRequest:account method:@"HEAD" path:[NSString stringWithFormat:@"/%@/%@", [NSString encodeToPercentEscape:container.name], [NSString encodeToPercentEscape:objectFullPath charactersToEncode:@"!*'();:@&=+$,?%#[]"]]];

}

+ (id)getObjectInfoRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object version:(NSString *)version {

    OpenStackRequest *request = [self getObjectInfoRequest:account container:container object:object];

    request.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@&version=%@", request.url.description, version]];

    return request;

}

+ (id)getObjectVersionsRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object {

    OpenStackRequest *request = [self filesRequest:account method:@"GET" path:[NSString stringWithFormat:@"/%@/%@", [NSString encodeToPercentEscape:container.name], [NSString encodeToPercentEscape:object.fullPath charactersToEncode:@"!*'();:@&=+$,?%#[]"]]];

    request.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@&version=list", request.url.description]];

    return request;

}

- (NSMutableArray *)versions {

    SBJSON *parser = [[[SBJSON alloc] init] autorelease];

    NSArray *jsonVersions = [[parser objectWithString:[self responseString]] objectForKey:@"versions"];

    NSMutableArray *versions = [NSMutableArray arrayWithCapacity:[jsonVersions count]];

    for (NSArray *jsonVersion in jsonVersions) {

        [versions addObject:[NSDictionary dictionaryWithObjectsAndKeys:

                             [jsonVersion objectAtIndex:0], @"versionID",

                             [NSDate dateWithTimeIntervalSince1970:[[jsonVersion objectAtIndex:1] doubleValue]], @"versionDate",

                             nil]];

    }

    return versions;

}

+ (id)getObjectRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object {

    return [self filesRequest:account method:@"GET" path:[NSString stringWithFormat:@"/%@/%@", [NSString encodeToPercentEscape:container.name], [NSString encodeToPercentEscape:object.fullPath charactersToEncode:@"!*'();:@&=+$,?%#[]"]]];

}

+ (id)getObjectRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object version:(NSString *)version {

    OpenStackRequest *request = [self getObjectRequest:account container:container object:object];

    if (version)

        request.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@&version=%@", request.url.description, version]];

    return request;

}

+ (id)writeObjectRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object {

    NSString *objectFullPath = object.fullPath;

    if ([objectFullPath hasPrefix:@"/"])

        objectFullPath = [objectFullPath substringFromIndex:1];

    OpenStackRequest *request = [self filesRequest:account method:@"PUT" path:[NSString stringWithFormat:@"/%@/%@", [NSString encodeToPercentEscape:container.name], [NSString encodeToPercentEscape:objectFullPath charactersToEncode:@"!*'();:@&=+$,?%#[]"]]];

    if (object.sharing)

        [request.requestHeaders setObject:object.sharing forKey:@"X-Object-Sharing"];

    NSString *metadataKeyHeaderPrefix;

    if ([objectFullPath length] == 0)

        metadataKeyHeaderPrefix = @"X-Container-Meta-";

    else

        metadataKeyHeaderPrefix = @"X-Object-Meta-";

    for (NSString *metadataKey in object.metadata) {

        NSString *metadataKeyHeader = [NSString stringWithFormat:@"%@%@", metadataKeyHeaderPrefix, metadataKey];

        metadataKeyHeader = [NSString encodeToPercentEscape:metadataKeyHeader];

        NSString *metadataValue = [NSString encodeToPercentEscape:[object.metadata objectForKey:metadataKey]];

        [request.requestHeaders setObject:metadataValue forKey:metadataKeyHeader];

    }

	[request setPostBody:[NSMutableData dataWithData:object.data]];

    [request.requestHeaders setObject:object.contentType forKey:@"Content-Type"];

	return request;

}

+ (id)writeObjectMetadataRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object {

    NSString *objectFullPath = object.fullPath;

    if ([objectFullPath hasPrefix:@"/"])

        objectFullPath = [objectFullPath substringFromIndex:1];

    OpenStackRequest *request = [self filesRequest:account method:@"POST" path:[NSString stringWithFormat:@"/%@/%@", [NSString encodeToPercentEscape:container.name], [NSString encodeToPercentEscape:objectFullPath charactersToEncode:@"!*'();:@&=+$,?%#[]"]]];

    NSString *metadataKeyHeaderPrefix;

    if ([objectFullPath length] == 0)

        metadataKeyHeaderPrefix = @"X-Container-Meta-";

    else

        metadataKeyHeaderPrefix = @"X-Object-Meta-";

    for (NSString *metadataKey in object.metadata) {

        NSString *metadataKeyHeader = [NSString stringWithFormat:@"%@%@", metadataKeyHeaderPrefix, metadataKey];

        metadataKeyHeader = [NSString encodeToPercentEscape:metadataKeyHeader];

        NSString *metadataValue = [NSString encodeToPercentEscape:[object.metadata objectForKey:metadataKey]];

        [request.requestHeaders setObject:metadataValue forKey:metadataKeyHeader];

    }

    if (!account.sharingAccount) {

        [request.requestHeaders setObject:([object.publicURI length] ? @"true" : @"false") forKey:@"X-Object-Public"];

        if (object.sharing) {

            [request.requestHeaders setObject:[NSString encodeToPercentEscape:object.sharing] forKey:@"X-Object-Sharing"];

        }

    }

    return request;

}

+ (id)deleteObjectRequest:(OpenStackAccount *)account container:(Container *)container object:(StorageObject *)object {

    NSString *objectFullPath = object.fullPath;

    if ([objectFullPath hasPrefix:@"/"])

        objectFullPath = [objectFullPath substringFromIndex:1];

    return [self filesRequest:account method:@"DELETE" path:[NSString stringWithFormat:@"/%@/%@", [NSString encodeToPercentEscape:container.name], [NSString encodeToPercentEscape:objectFullPath charactersToEncode:@"!*'();:@&=+$,?%#[]"]]];

}

#pragma mark - ASIHTTPRequest Overrides

- (void)setCompletionBlock:(ASIBasicBlock)aCompletionBlock {

    [super setCompletionBlock:aCompletionBlock];

    [backupCompletionBlock release];

    backupCompletionBlock = [aCompletionBlock copy];

}

- (void)setFailedBlock:(ASIBasicBlock)aFailedBlock {

    [super setFailedBlock:aFailedBlock];

    [backupFailureBlock release];

    backupFailureBlock = [aFailedBlock copy];

}

- (void)failWithError:(NSError *)theError {

    if (responseStatusCode == 503) {

        NSNotification *notification = [NSNotification notificationWithName:@"serviceUnavailable" object:nil userInfo:nil];

        [[NSNotificationCenter defaultCenter] postNotification:notification];

        // This crashes the app, check if it can be removed completely.

//    } else if (responseStatusCode == 0) {

//        NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];

//        if (![defaults boolForKey:@"already_failed_on_connection"]) {

//            UIAlertView *alert = [[UIAlertView alloc] initWithTitle:@"Connection Error" message:@"Please check your connection or API URL and try again." delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil];

//            [alert show];

//            [alert release];

//        }

//        [defaults setBool:YES forKey:@"already_failed_on_connection"];

//        [defaults synchronize];

    }

    [super failWithError:theError];

}

#pragma mark - Actions

- (BOOL)isSuccess {

	return (200 <= [self responseStatusCode]) && ([self responseStatusCode] <= 299);

}

#pragma mark - Notifications

- (void)notify:(NSString *)name {

    NSDictionary *callbackUserInfo = [NSDictionary dictionaryWithObject:self forKey:@"response"];

    NSNotification *notification = [NSNotification notificationWithName:name object:nil userInfo:callbackUserInfo];

    [[NSNotificationCenter defaultCenter] postNotification:notification];

}

- (void)notify {

    NSString *observeName = [NSString stringWithFormat:@"%@ %@ %@", [self isSuccess] ? @"SUCCESS" : @"FAILURE", self.requestMethod, (self.notificationURL ? self.notificationURL.description : self.url.description)];

    NSString *callbackName = [NSString stringWithFormat:@"%@ %@ %@ %@", [self isSuccess] ? @"SUCCESS" : @"FAILURE", self.requestMethod, (self.notificationURL ? self.notificationURL.description : self.url.description), self.callback.uuid];

    NSDictionary *callbackUserInfo = [NSDictionary dictionaryWithObject:self forKey:@"response"];

    NSNotification *observeNotification = [NSNotification notificationWithName:observeName object:nil userInfo:callbackUserInfo];

    [[NSNotificationCenter defaultCenter] postNotification:observeNotification];

    NSNotification *callbackNotification = [NSNotification notificationWithName:callbackName object:nil userInfo:callbackUserInfo];

    [[NSNotificationCenter defaultCenter] postNotification:callbackNotification];

}

#pragma mark - Memory Management

- (void)releaseBackupBlocksOnMainThread {

	NSMutableArray *blocks = [NSMutableArray array];

	if (backupCompletionBlock) {

		[blocks addObject:backupCompletionBlock];

		[backupCompletionBlock release];

		backupCompletionBlock = nil;

	}

	if (backupFailureBlock) {

		[blocks addObject:backupFailureBlock];

		[backupFailureBlock release];

		backupFailureBlock = nil;

	}

	[[self class] performSelectorOnMainThread:@selector(releaseBackupBlocks:) withObject:blocks waitUntilDone:[NSThread isMainThread]];

}

// Always called on main thread

+ (void)releaseBackupBlocks:(NSArray *)blocks {

	// Blocks will be released when this method exits

}

- (void)dealloc {

    [account release];

    [errorAlerter release];

    [retryBaseURL release];

    [followUpSelectorString release];

    [notificationURL release];

    [self releaseBackupBlocksOnMainThread];

    [super dealloc];

}

@end