Synnefo » Pithos MacOS & iOS Common Lib

//  ASIPithosRequest.m

//  Based on ASICloudFilesRequest.m

//  Part of ASIHTTPRequest -> http://allseeing-i.com/ASIHTTPRequest

//

// Copyright 2011-2012 GRNET S.A. All rights reserved.

//

// Redistribution and use in source and binary forms, with or

// without modification, are permitted provided that the following

// conditions are met:

// 

//   1. Redistributions of source code must retain the above

//      copyright notice, this list of conditions and the following

//      disclaimer.

// 

//   2. Redistributions in binary form must reproduce the above

//      copyright notice, this list of conditions and the following

//      disclaimer in the documentation and/or other materials

//      provided with the distribution.

// 

// THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

// OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

// USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

// AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

// POSSIBILITY OF SUCH DAMAGE.

// 

// The views and conclusions contained in the software and

// documentation are those of the authors and should not be

// interpreted as representing official policies, either expressed

// or implied, of GRNET S.A.

#import "ASIPithosRequest.h"

#import "ASIPithos.h"

#import "ASIPithosAccount.h"

#import "SBJson.h"

@implementation ASIPithosRequest

@synthesize currentElement, currentContent, currentAccount;

#pragma mark -

#pragma mark Constructors

+ (id)authRequestWithMethod:(NSString *)method pithos:(ASIPithos *)pithos queryString:(NSString *)queryString useAuthToken:(BOOL)useAuthToken {

    NSString *urlString = [NSString stringWithString:pithos.authURL];

    if (queryString)

        urlString = [urlString stringByAppendingString:queryString];

    ASIPithosRequest *request = [self requestWithURL:[NSURL URLWithString:urlString]];

	[request setRequestMethod:method];

    if (useAuthToken)

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

	return request;

}

+ (id)authRequestWithMethod:(NSString *)method pithos:(ASIPithos *)pithos useAuthToken:(BOOL)useAuthToken {

	return [self authRequestWithMethod:method pithos:pithos queryString:nil useAuthToken:useAuthToken];

}

#pragma mark -

#pragma mark Memory Management

- (void)dealloc {

	[currentAccount release];

    [currentContent release];

    [currentElement release];

    [sharingAccounts release];

	[super dealloc];

}

#pragma mark -

#pragma mark Authentication

+ (id)authenticationRequestWithPithos:(ASIPithos *)pithos {

    ASIPithosRequest *request = [self authRequestWithMethod:@"GET" pithos:pithos useAuthToken:NO];

	[request addRequestHeader:@"X-Auth-User" value:pithos.authUser];

	[request addRequestHeader:@"X-Auth-Key" value:pithos.authKey];

	return request;

}

+ (ASIPithos *)authenticateWithPithos:(ASIPithos *)pithos error:(NSError **)error {

	ASIPithosRequest *request = [self authenticationRequestWithPithos:pithos];

	[request startSynchronous];

	// XXX start asynchronous with polling loop?

    if (error != NULL) {

        *error = [request error];

        if (!*error) {

            NSDictionary *responseHeaders = [request responseHeaders];

            pithos.authToken = [responseHeaders objectForKey:@"X-Auth-Token"];

            pithos.storageURL = [responseHeaders objectForKey:@"X-Storage-Url"];

            return pithos;

        }

    }

	return nil;

}

#pragma mark -

#pragma mark User Catalog

// POST userCatalogURL

+ (id)userCatalogRequestWithPithos:(ASIPithos *)pithos displaynames:(NSArray *)displaynames UUIDs:(NSArray *)UUIDs {

    NSString *urlString = [NSString stringWithString:pithos.userCatalogURL];

    ASIPithosRequest *request = [self requestWithURL:[NSURL URLWithString:urlString]];

	[request setRequestMethod:@"POST"];

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

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

    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 {

    SBJsonParser *parser = [[SBJsonParser alloc] init];

    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 -

#pragma mark GET

// GET authURL

+ (id)listSharingAccountsRequestWithPithos:(ASIPithos *)pithos {

    return [self authRequestWithMethod:@"GET" pithos:pithos queryString:@"?format=xml" useAuthToken:YES];

}

// GET authURL?[limit=limit]&[marker=marker]

+ (id)listSharingAccountsRequestWithPithos:(ASIPithos *)pithos limit:(NSUInteger)limit marker:(NSString *)marker {

    NSString *queryString = @"?format=xml";

	if (limit && (limit > 0))

		queryString = [queryString stringByAppendingString:[NSString stringWithFormat:@"&limit=%lu", limit]];

	if (marker)

		queryString = [queryString stringByAppendingString:[NSString stringWithFormat:@"&marker=%@", [self encodeToPercentEscape:marker]]];

    return [self authRequestWithMethod:@"GET" pithos:pithos queryString:queryString useAuthToken:YES];

}

- (NSArray *)sharingAccounts {

    if (sharingAccounts == nil) {

        sharingAccounts = [[NSMutableArray alloc] init];

        NSXMLParser *parser = [[[NSXMLParser alloc] initWithData:[self responseData]] autorelease];

        [parser setDelegate:self];

        [parser setShouldProcessNamespaces:NO];

        [parser setShouldReportNamespacePrefixes:NO];

        [parser setShouldResolveExternalEntities:NO];

        [parser parse];

    }    

	return sharingAccounts;

}

#pragma mark -

#pragma mark NSXMLParserDelegate

- (void)parser:(NSXMLParser *)parser didStartElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName attributes:(NSDictionary *)attributeDict {

	self.currentElement = elementName;

	if ([elementName isEqualToString:@"account"]) {

		self.currentAccount = [ASIPithosAccount account];

	}

	self.currentContent = @"";

}

- (void)parser:(NSXMLParser *)parser didEndElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName {

	if ([elementName isEqualToString:@"name"]) {

        currentAccount.name = currentContent;

	} else if ([elementName isEqualToString:@"count"]) {

        currentAccount.containerCount = [currentContent integerValue];

    } else if ([elementName isEqualToString:@"last_modified"]) {

        currentAccount.lastModified = [[self dateFormatterWithFormatId:0] dateFromString:

                                       [currentContent stringByReplacingOccurrencesOfString:@":" 

                                                                                 withString:@"" 

                                                                                    options:NSBackwardsSearch 

                                                                                      range:NSMakeRange(([currentContent length] - 3), 1)]];

	} else if ([elementName isEqualToString:@"bytes"]) {

        currentAccount.bytesUsed = [currentContent integerValue];

	} else if ([elementName isEqualToString:@"account"]) {

		[sharingAccounts addObject:currentAccount];

        self.currentAccount = nil;

	}

}

- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string {

    self.currentContent = [currentContent stringByAppendingString:string];

}

#pragma mark -

#pragma mark Date Formatters

// We store our date formatters in the calling thread's dictionary

// NSDateFormatter is not thread-safe, this approach ensures each formatter is only used on a single thread

// Each formatter can be reused many times in parsing a single response, so it would be expensive to keep creating new date formatters

-(NSDateFormatter *)dateFormatterWithFormatId:(NSUInteger)formatId {

    NSMutableDictionary *threadDict = [[NSThread currentThread] threadDictionary];

    NSString *dateFormatterKey = [NSString stringWithFormat:@"ASIPithosDateFormatter%lu", formatId];

    NSDateFormatter *dateFormatter = [threadDict objectForKey:dateFormatterKey];

	if (dateFormatter == nil) {

        switch (formatId) {

            case 0:

                // date format: 2009-11-04T19:46:20.123456+0000

                // Needed for last_modified

                dateFormatter = [[[NSDateFormatter alloc] init] autorelease];

                [dateFormatter setLocale:[[[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"] autorelease]];

                [dateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ"];

                [threadDict setObject:dateFormatter forKey:dateFormatterKey];

                break;

            case 1:

                // date to format (RFC 1123): Sun, 06 Nov 1994 08:49:37 GMT

                // Needed for reading X-Account-Until-Timestamp, Last-Modified

                // and writing If-Modified-Since, If-Unmodified-Since in the request headers

                dateFormatter = [[[NSDateFormatter alloc] init] autorelease];

                [dateFormatter setTimeZone:[NSTimeZone timeZoneWithAbbreviation:@"GMT"]];

                [dateFormatter setDateFormat:@"eee, dd MMM yyyy HH:mm:ss 'GMT'"];

                [threadDict setObject:dateFormatter forKey:dateFormatterKey];

                break;

            default:

                break;

        }

    }

    return dateFormatter;

}

#pragma mark -

#pragma mark Extra Headers

- (void)addRequestIfModifiedSinceHeader:(NSDate *)sinceTimestamp {

    if (sinceTimestamp)

        [self addRequestHeader:@"If-Modified-Since" value:[[self dateFormatterWithFormatId:1] stringFromDate:sinceTimestamp]];        

}

- (void)addRequestIfUnmodifiedSinceHeader:(NSDate *)sinceTimestamp {

    if (sinceTimestamp)

        [self addRequestHeader:@"If-Unmodified-Since" value:[[self dateFormatterWithFormatId:1] stringFromDate:sinceTimestamp]];

}

- (void)addRequestIfMatchHeader:(NSString *)matchETag {

    if (matchETag)

        [self addRequestHeader:@"If-Match" value:matchETag];

}

- (void)addRequestIfNoneMatchHeader:(NSString *)matchETag {

    if (matchETag)

        [self addRequestHeader:@"If-None-Match" value:matchETag];

}

- (void)addRequestRangeHeader:(NSString *)rangeString {

    if (rangeString)

        [self addRequestHeader:@"Range" value:rangeString];    

}

- (void)addRequestRangeHeader:(NSString *)rangeString ifRangeETag:(NSString *)rangeETag {

    if (rangeString) {

        [self addRequestHeader:@"Range" value:rangeString];

        if (rangeETag)

            [self addRequestHeader:@"If-Range" value:rangeETag];

    }

}

- (void)addRequestRangeHeader:(NSString *)rangeString ifRangeTimestamp:(NSDate *)rangeTimestamp {

    if (rangeString) {

        [self addRequestHeader:@"Range" value:rangeString];

        if (rangeTimestamp)

            [self addRequestHeader:@"If-Range" value:[[self dateFormatterWithFormatId:1] stringFromDate:rangeTimestamp]];

    }

}

#pragma mark -

#pragma mark Request User

- (void)setRequestUserFromDefaultTo:(NSString *)newAuthUser withPithos:(ASIPithos *)pithos {

    NSString *urlString = [self.url description];

    NSRange storageURLRange = [urlString rangeOfString:pithos.storageURL];

    if (storageURLRange.length && (storageURLRange.location == 0))

        self.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@%@", 

                                         [pithos storageURLWithAuthUser:newAuthUser], 

                                         [urlString substringFromIndex:storageURLRange.length]]];

}

- (void)changeRequestUserFrom:(NSString *)oldAuthUser To:(NSString *)newAuthUser withPithos:(ASIPithos *)pithos {

    NSString *urlString = [self.url description];

    NSRange storageURLRange = [urlString rangeOfString:[pithos storageURLWithAuthUser:oldAuthUser]];

    if (storageURLRange.length && (storageURLRange.location == 0))

        self.url = [NSURL URLWithString:[NSString stringWithFormat:@"%@%@", 

                                         [pithos storageURLWithAuthUser:newAuthUser], 

                                         [urlString substringFromIndex:storageURLRange.length]]];

}

#pragma mark -

#pragma mark Internal

- (NSMutableDictionary *)getHeadersDictionaryForPrefix:(NSString *)prefix {

    NSMutableDictionary *headersDictionary = [NSMutableDictionary dictionary];

    for (NSString *key in [self responseHeaders]) {

        NSRange prefixRange = [key rangeOfString:prefix];

        if (prefixRange.location == 0) {

            [headersDictionary setObject:[self decodeFromPercentEscape:[[self responseHeaders] objectForKey:key]] 

                                  forKey:[[[self decodeFromPercentEscape:[key substringFromIndex:prefix.length]] 

                                           stringByReplacingOccurrencesOfString:@"-" withString:@"_"] 

                                          lowercaseString]];

        }

    }

    return headersDictionary;

}

// http://cybersam.com/programming/proper-url-percent-encoding-in-ios

+ (NSString *)encodeToPercentEscape:(NSString *)string {

    return [((NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, 

                                                                 (CFStringRef)string, 

                                                                 NULL, 

                                                                 (CFStringRef)@"!*'();:@&=+$,/?%#[]", 

                                                                 kCFStringEncodingUTF8)) autorelease];

}

+ (NSString *)decodeFromPercentEscape:(NSString *)string {

    return [((NSString *)CFURLCreateStringByReplacingPercentEscapesUsingEncoding(NULL, 

                                                                                 (CFStringRef)string,

                                                                                 (CFStringRef)@"", 

                                                                                 kCFStringEncodingUTF8)) autorelease];

}

- (NSString *)encodeToPercentEscape:(NSString *)string {

    return [ASIPithosRequest encodeToPercentEscape:string];

}

- (NSString *)decodeFromPercentEscape:(NSString *)string {

    return [ASIPithosRequest decodeFromPercentEscape:string];

}

@end