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;

#pragma mark - Constructors

#pragma mark Generic

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

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

    request.account = account;

	request.requestMethod = method;

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

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

    request.timeOutSeconds = 60;

    request.numberOfTimesToRetryOnTimeout = 5;

	return request;

}

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

    NSString *urlString = [account.filesURL description];

    if (account.sharingAccount) {

        urlString = [NSString stringWithFormat:@"%@%@",

                     [urlString substringToIndex:[urlString rangeOfString:account.username].location],

                     account.sharingAccount];

    }

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

                                       urlString,

                                       path,

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

    return [self request:account method:method url:url];

}

#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];

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

    if (displaynames) {

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

            [dataString appendFormat:@"\"%@\"%@", [displaynames objectAtIndex:index], ((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 ? account.authToken : @"")];

    request.timeOutSeconds = 60;

    request.numberOfTimesToRetryOnTimeout = 5;

	return request;

}

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

    NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"%@?format=json", account.provider.authEndpointURL]];

    return [self request:account method:@"GET" url:url];

}

- (NSArray *)sharingAccounts {

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

    NSArray *sharingAccounts = [parser objectWithString:[self responseString]];

    return sharingAccounts;

}

#pragma mark Account

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

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

}

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

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

}

- (NSMutableDictionary *)containers {

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

    NSArray *jsonObjects = [parser objectWithString:[self responseString]];

    NSMutableDictionary *containers = [NSMutableDictionary dictionaryWithCapacity:[jsonObjects count]];

    for (NSDictionary *dict in jsonObjects) {

        Container *container = [Container fromJSON:dict];

        [containers setObject:container forKey:container.name];

    }

    return containers;

}

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

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

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

    for (NSString *groupName in groups) {

        NSString *group = [NSString encodeToPercentEscape:[groups objectForKey:groupName]];

        groupName = [NSString encodeToPercentEscape:groupName];

        [request.requestHeaders setObject:group forKey:[NSString stringWithFormat:@"X-Account-Group-%@", groupName]];

    }

    if ([groups count] == 0)

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

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

    for (NSString *metadataKey in accountMetadata) {

        NSString *metadataValue = [NSString encodeToPercentEscape:[accountMetadata objectForKey:metadataKey]];

        metadataKey = [NSString encodeToPercentEscape:[accountMetadata objectForKey:metadataKey]];

        [request.requestHeaders setObject:metadataValue forKey:[NSString stringWithFormat:@"X-Account-Meta-%@",metadataKey]];

    }

    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 {

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

}

- (NSMutableDictionary *)objects {

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

    NSArray *jsonObjects = [parser objectWithString:[self responseString]];

    NSMutableDictionary *objects = [NSMutableDictionary dictionaryWithCapacity:[jsonObjects count]];

    for (NSDictionary *dict in jsonObjects) {

        StorageObject *object = [StorageObject fromJSON:dict];

        [objects setObject:object forKey:object.name];

    }

    return objects;

}

+ (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];

    } 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.url description]];

    NSString *callbackName = [NSString stringWithFormat:@"%@ %@ %@ %@", [self isSuccess] ? @"SUCCESS" : @"FAILURE", self.requestMethod, [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];

    [self releaseBackupBlocksOnMainThread];

    [super dealloc];

}

@end