@@ -15,7 +15,7 @@ #if TARGET_OS_IPHONE #import <CFNetwork/CFNetwork.h> #endif -#import <zlib.h> +#import <stdio.h> typedef enum _ASINetworkErrorType { ASIConnectionFailureErrorType = 1, @@ -24,7 +24,8 @@ typedef enum _ASINetworkErrorType { ASIRequestCancelledErrorType = 4, ASIUnableToCreateRequestErrorType = 5, ASIInternalErrorWhileBuildingRequestType = 6, - ASIInternalErrorWhileApplyingCredentialsType = 7 + ASIInternalErrorWhileApplyingCredentialsType = 7, + ASIFileManagementError = 8 } ASINetworkErrorType; @@ -70,6 +71,9 @@ typedef enum _ASINetworkErrorType { // If downloadDestinationPath is not set, download data will be stored in memory NSString *downloadDestinationPath; + //The location that files will be downloaded to. Once a download is complete, files will be decompressed (if necessary) and moved to downloadDestinationPath + NSString *temporaryFileDownloadPath; + // Used for writing data to a file when downloadDestinationPath is set NSOutputStream *outputStream; @@ -195,6 +199,9 @@ typedef enum _ASINetworkErrorType { // Response data, automatically uncompressed where appropriate - (NSData *)responseData; +// Returns true if the response was gzip compressed +- (BOOL)isResponseCompressed; + #pragma mark request logic // Start loading the request @@ -284,6 +291,9 @@ typedef enum _ASINetworkErrorType { // Uncompress gzipped data with zlib + (NSData *)uncompressZippedData:(NSData*)compressedData; +// Uncompress gzipped data from a file into another file, used when downloading to a file ++ (int)uncompressZippedDataFromFile:(NSString *)sourcePath toFile:(NSString *)destinationPath; ++ (int)uncompressZippedDataFromSource:(FILE *)source toDestination:(FILE *)dest; @property (retain) NSString *username; @property (retain) NSString *password; @@ -296,6 +306,7 @@ typedef enum _ASINetworkErrorType { @property (assign) BOOL useKeychainPersistance; @property (assign) BOOL useSessionPersistance; @property (retain) NSString *downloadDestinationPath; +@property (retain,readonly) NSString *temporaryFileDownloadPath; @property (assign) SEL didFinishSelector; @property (assign) SEL didFailSelector; @property (retain,readonly) NSString *authenticationRealm; ASIHTTPRequest.h @@ -12,6 +12,7 @@ #import "ASIHTTPRequest.h" #import "NSHTTPCookieAdditions.h" +#import <zlib.h> // We use our own custom run loop mode as CoreAnimation seems to want to hijack our threads otherwise static CFStringRef ASIHTTPRequestRunMode = CFSTR("ASIHTTPRequest"); @@ -105,6 +106,7 @@ static NSError *ASIUnableToCreateRequestError; [requestHeaders release]; [requestCookies release]; [downloadDestinationPath release]; + [temporaryFileDownloadPath release]; [outputStream release]; [username release]; [password release]; @@ -178,11 +180,15 @@ static NSError *ASIUnableToCreateRequestError; return [[[NSString alloc] initWithBytes:[data bytes] length:[data length] encoding:[self responseEncoding]] autorelease]; } +- (BOOL)isResponseCompressed +{ + NSString *encoding = [[self responseHeaders] objectForKey:@"Content-Encoding"]; + return encoding && [encoding rangeOfString:@"gzip"].location != NSNotFound; +} - (NSData *)responseData { - NSString *encoding = [[self responseHeaders] objectForKey:@"Content-Encoding"]; - if(encoding && [encoding rangeOfString:@"gzip"].location != NSNotFound) { + if ([self isResponseCompressed]) { return [ASIHTTPRequest uncompressZippedData:[self rawResponseData]]; } else { return [self rawResponseData]; @@ -417,9 +423,9 @@ static NSError *ASIUnableToCreateRequestError; [self setRawResponseData:nil]; // If we were downloading to a file, let's remove it - } else if (downloadDestinationPath) { + } else if (temporaryFileDownloadPath) { [outputStream close]; - [[NSFileManager defaultManager] removeItemAtPath:downloadDestinationPath error:NULL]; + [[NSFileManager defaultManager] removeItemAtPath:temporaryFileDownloadPath error:NULL]; } [self setResponseHeaders:nil]; @@ -1036,7 +1042,9 @@ static NSError *ASIUnableToCreateRequestError; // Are we downloading to a file? if (downloadDestinationPath) { if (!outputStream) { - outputStream = [[NSOutputStream alloc] initToFileAtPath:downloadDestinationPath append:NO]; + [temporaryFileDownloadPath release]; + temporaryFileDownloadPath = [[NSTemporaryDirectory() stringByAppendingPathComponent:[[NSProcessInfo processInfo] globallyUniqueString]] retain]; + outputStream = [[NSOutputStream alloc] initToFileAtPath:temporaryFileDownloadPath append:NO]; [outputStream open]; } [outputStream write:buffer maxLength:bytesRead]; @@ -1046,15 +1054,10 @@ static NSError *ASIUnableToCreateRequestError; [rawResponseData appendBytes:buffer length:bytesRead]; } } - - } - - (void)handleStreamComplete { - - //Try to read the headers (if this is a HEAD request handleBytesAvailable available may not be called) if (!responseHeaders) { if ([self readResponseHeadersReturningAuthenticationFailure]) { @@ -1074,13 +1077,51 @@ static NSError *ASIUnableToCreateRequestError; readStream = NULL; } + NSError *fileError = nil; + // Close the output stream as we're done writing to the file - if (downloadDestinationPath) { + if (temporaryFileDownloadPath) { [outputStream close]; + + // Decompress the file (if necessary) directly to the destination path + if ([self isResponseCompressed]) { + int decompressionStatus = [ASIHTTPRequest uncompressZippedDataFromFile:temporaryFileDownloadPath toFile:downloadDestinationPath]; + if (decompressionStatus != Z_OK) { + fileError = [NSError errorWithDomain:NetworkRequestErrorDomain code:ASIFileManagementError userInfo:[NSDictionary dictionaryWithObjectsAndKeys:[NSString stringWithFormat:@"Decompression of %@ failed with code %hi",temporaryFileDownloadPath,decompressionStatus],NSLocalizedDescriptionKey,nil]]; + } + + //Remove the temporary file + NSError *removeError = nil; + [[NSFileManager defaultManager] removeItemAtPath:temporaryFileDownloadPath error:&removeError]; + if (removeError) { + fileError = [NSError errorWithDomain:NetworkRequestErrorDomain code:ASIFileManagementError userInfo:[NSDictionary dictionaryWithObjectsAndKeys:[NSString stringWithFormat:@"Failed to delete file at %@ with error: %@",temporaryFileDownloadPath,removeError],NSLocalizedDescriptionKey,removeError,NSUnderlyingErrorKey,nil]]; + } + } else { + + //Remove any file at the destination path + NSError *moveError = nil; + if ([[NSFileManager defaultManager] fileExistsAtPath:downloadDestinationPath]) { + [[NSFileManager defaultManager] removeItemAtPath:downloadDestinationPath error:&moveError]; + if (moveError) { + fileError = [NSError errorWithDomain:NetworkRequestErrorDomain code:ASIFileManagementError userInfo:[NSDictionary dictionaryWithObjectsAndKeys:[NSString stringWithFormat:@"Unable to remove file at path '%@'",downloadDestinationPath],NSLocalizedDescriptionKey,moveError,NSUnderlyingErrorKey,nil]]; + } + } + + //Move the temporary file to the destination path + if (!fileError) { + [[NSFileManager defaultManager] moveItemAtPath:temporaryFileDownloadPath toPath:downloadDestinationPath error:&moveError]; + if (moveError) { + fileError = [NSError errorWithDomain:NetworkRequestErrorDomain code:ASIFileManagementError userInfo:[NSDictionary dictionaryWithObjectsAndKeys:[NSString stringWithFormat:@"Failed to move file from '%@' to '%@'",temporaryFileDownloadPath,downloadDestinationPath],NSLocalizedDescriptionKey,moveError,NSUnderlyingErrorKey,nil]]; + } + } + } } [progressLock unlock]; - [self requestFinished]; - + if (fileError) { + [self failWithError:fileError]; + } else { + [self requestFinished]; + } } @@ -1235,6 +1276,91 @@ static NSError *ASIUnableToCreateRequestError; } } + ++ (int)uncompressZippedDataFromFile:(NSString *)sourcePath toFile:(NSString *)destinationPath +{ + // Get a FILE struct for the source file + FILE *source = fdopen([[NSFileHandle fileHandleForReadingAtPath:sourcePath] fileDescriptor], "r"); + + // Create an empty file at the destination path + [[NSFileManager defaultManager] createFileAtPath:destinationPath contents:[NSData data] attributes:nil]; + + // Get a FILE struct for the destination path + FILE *dest = fdopen([[NSFileHandle fileHandleForWritingAtPath:destinationPath] fileDescriptor], "w"); + + // Uncompress data in source and save in destination + int status = [ASIHTTPRequest uncompressZippedDataFromSource:source toDestination:dest]; + + // Close the files + fclose(source); + fclose(dest); + return status; +} + +// +// From the zlib sample code by Mark Adler, code here: +// http://www.zlib.net/zpipe.c +// +#define CHUNK 16384 ++ (int)uncompressZippedDataFromSource:(FILE *)source toDestination:(FILE *)dest +{ + int ret; + unsigned have; + z_stream strm; + unsigned char in[CHUNK]; + unsigned char out[CHUNK]; + + /* allocate inflate state */ + strm.zalloc = Z_NULL; + strm.zfree = Z_NULL; + strm.opaque = Z_NULL; + strm.avail_in = 0; + strm.next_in = Z_NULL; + ret = inflateInit2(&strm, (15+32)); + if (ret != Z_OK) + return ret; + + /* decompress until deflate stream ends or end of file */ + do { + strm.avail_in = fread(in, 1, CHUNK, source); + if (ferror(source)) { + (void)inflateEnd(&strm); + return Z_ERRNO; + } + if (strm.avail_in == 0) + break; + strm.next_in = in; + + /* run inflate() on input until output buffer not full */ + do { + strm.avail_out = CHUNK; + strm.next_out = out; + ret = inflate(&strm, Z_NO_FLUSH); + assert(ret != Z_STREAM_ERROR); /* state not clobbered */ + switch (ret) { + case Z_NEED_DICT: + ret = Z_DATA_ERROR; /* and fall through */ + case Z_DATA_ERROR: + case Z_MEM_ERROR: + (void)inflateEnd(&strm); + return ret; + } + have = CHUNK - strm.avail_out; + if (fwrite(&out, 1, have, dest) != have || ferror(dest)) { + (void)inflateEnd(&strm); + return Z_ERRNO; + } + } while (strm.avail_out == 0); + + /* done when inflate() says it's done */ + } while (ret != Z_STREAM_END); + + /* clean up and return */ + (void)inflateEnd(&strm); + return ret == Z_STREAM_END ? Z_OK : Z_DATA_ERROR; +} + + @synthesize username; @synthesize password; @synthesize domain; @@ -1246,6 +1372,7 @@ static NSError *ASIUnableToCreateRequestError; @synthesize useSessionPersistance; @synthesize useCookiePersistance; @synthesize downloadDestinationPath; +@synthesize temporaryFileDownloadPath; @synthesize didFinishSelector; @synthesize didFailSelector; @synthesize authenticationRealm; ASIHTTPRequest.m @@ -26,5 +26,5 @@ - (void)testDigestAuthentication; - (void)testCharacterEncoding; - (void)testCompressedResponse; - +- (void)testCompressedResponseDownloadToFile; @end ASIHTTPRequestTests.h @@ -126,16 +126,42 @@ - (void)testFileDownload { + NSString *path = [[[[NSBundle mainBundle] bundlePath] stringByDeletingLastPathComponent] stringByAppendingPathComponent:@"testimage.png"]; + + NSURL *url = [[[NSURL alloc] initWithString:@"http://allseeing-i.com/i/logo.png"] autorelease]; + ASIHTTPRequest *request = [[[ASIHTTPRequest alloc] initWithURL:url] autorelease]; + [request setDownloadDestinationPath:path]; + [request start]; + + NSString *tempPath = [request temporaryFileDownloadPath]; + STAssertNotNil(tempPath,@"Failed to download file to temporary location"); + + //BOOL success = (![[NSFileManager defaultManager] fileExistsAtPath:tempPath]); + //STAssertTrue(success,@"Failed to remove file from temporary location"); + + NSImage *image = [[[NSImage alloc] initWithContentsOfFile:path] autorelease]; + STAssertNotNil(image,@"Failed to download data to a file"); +} + +- (void)testCompressedResponseDownloadToFile +{ NSString *path = [[[[NSBundle mainBundle] bundlePath] stringByDeletingLastPathComponent] stringByAppendingPathComponent:@"testfile"]; NSURL *url = [[[NSURL alloc] initWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/first"] autorelease]; - ASIHTTPRequest *request1 = [[[ASIHTTPRequest alloc] initWithURL:url] autorelease]; - [request1 setDownloadDestinationPath:path]; - [request1 start]; + ASIHTTPRequest *request = [[[ASIHTTPRequest alloc] initWithURL:url] autorelease]; + [request setDownloadDestinationPath:path]; + [request start]; + + NSString *tempPath = [request temporaryFileDownloadPath]; + STAssertNotNil(tempPath,@"Failed to download file to temporary location"); + + //BOOL success = (![[NSFileManager defaultManager] fileExistsAtPath:tempPath]); + //STAssertTrue(success,@"Failed to remove file from temporary location"); - NSString *s = [NSString stringWithContentsOfURL:[NSURL fileURLWithPath:path]]; BOOL success = [[NSString stringWithContentsOfURL:[NSURL fileURLWithPath:path]] isEqualToString:@"This is the expected content for the first string"]; STAssertTrue(success,@"Failed to download data to a file"); + + } @@ -425,4 +451,5 @@ } + @end ASIHTTPRequestTests.m @@ -46,7 +46,7 @@ - (void)imageFetchComplete:(ASIHTTPRequest *)request { - UIImage *img = [UIImage imageWithData:[request receivedData]]; + UIImage *img = [UIImage imageWithData:[request responseData]]; if (img) { if ([imageView1 image]) { if ([imageView2 image]) { QueueViewController.m @@ -19,8 +19,8 @@ [request addRequestHeader:@"User-Agent" value:@"ASIHTTPRequest"]; [request start]; - if ([request dataString]) { - [htmlSource setText:[request dataString]]; + if ([request responseString]) { + [htmlSource setText:[request responseString]]; } } SynchronousViewController.m @@ -11,8 +11,9 @@ 8D11072D0486CEB800E47090 /* Mac-OS-Sample-main.m in Sources */ = {isa = PBXBuildFile; fileRef = 29B97316FDCFA39411CA2CEA /* Mac-OS-Sample-main.m */; settings = {ATTRIBUTES = (); }; }; B568AFFC0F49D7AE00FA13C8 /* libz.1.2.3.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = B568AFFB0F49D7AE00FA13C8 /* libz.1.2.3.dylib */; }; B568B0050F49D7CE00FA13C8 /* libz.1.2.3.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = B568AFFB0F49D7AE00FA13C8 /* libz.1.2.3.dylib */; }; + B568B0E50F49FCB900FA13C8 /* ASIHTTPRequestTests.m in Sources */ = {isa = PBXBuildFile; fileRef = B568B0D10F49FC7900FA13C8 /* ASIHTTPRequestTests.m */; }; B5731BD00E4319940008024F /* Cocoa.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B5731BCF0E4319940008024F /* Cocoa.framework */; }; - B5731C300E431B340008024F /* ASIHTTPRequestTests in Sources */ = {isa = PBXBuildFile; fileRef = B5731AFB0E430B1F0008024F /* ASIHTTPRequestTests */; }; + B58610B80F4F31E600159EBD /* libz.1.2.3.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = B58610B70F4F31E600159EBD /* libz.1.2.3.dylib */; }; B5ABC7BB0E24C5620072F422 /* ASIHTTPRequest.m in Sources */ = {isa = PBXBuildFile; fileRef = B5ABC7B90E24C5620072F422 /* ASIHTTPRequest.m */; }; B5ABC80F0E24CB100072F422 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = B5ABC80E0E24CB100072F422 /* AppDelegate.m */; }; B5B03D520EC5C0330089D01F /* ASINetworkQueue.m in Sources */ = {isa = PBXBuildFile; fileRef = B5F4C4370EC49EAB00D4F31C /* ASINetworkQueue.m */; }; @@ -64,12 +65,13 @@ 8D1107310486CEB800E47090 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; }; 8D1107320486CEB800E47090 /* asi-http-request.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "asi-http-request.app"; sourceTree = BUILT_PRODUCTS_DIR; }; B568AFFB0F49D7AE00FA13C8 /* libz.1.2.3.dylib */ = {isa = PBXFileReference; lastKnownFileType = "compiled.mach-o.dylib"; name = libz.1.2.3.dylib; path = usr/lib/libz.1.2.3.dylib; sourceTree = SDKROOT; }; + B568B0D10F49FC7900FA13C8 /* ASIHTTPRequestTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASIHTTPRequestTests.m; sourceTree = "<group>"; }; B5731AE60E430AC30008024F /* Tests.octest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = Tests.octest; sourceTree = BUILT_PRODUCTS_DIR; }; B5731AE70E430AC30008024F /* Tests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "Tests-Info.plist"; sourceTree = "<group>"; }; B5731AFA0E430B1F0008024F /* ASIHTTPRequestTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASIHTTPRequestTests.h; sourceTree = "<group>"; }; - B5731AFB0E430B1F0008024F /* ASIHTTPRequestTests */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = ASIHTTPRequestTests; sourceTree = "<group>"; }; B5731B620E430F430008024F /* SenTestingKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SenTestingKit.framework; path = Library/Frameworks/SenTestingKit.framework; sourceTree = DEVELOPER_DIR; }; B5731BCF0E4319940008024F /* Cocoa.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Cocoa.framework; path = System/Library/Frameworks/Cocoa.framework; sourceTree = SDKROOT; }; + B58610B70F4F31E600159EBD /* libz.1.2.3.dylib */ = {isa = PBXFileReference; lastKnownFileType = "compiled.mach-o.dylib"; name = libz.1.2.3.dylib; path = usr/lib/libz.1.2.3.dylib; sourceTree = SDKROOT; }; B5ABC7B90E24C5620072F422 /* ASIHTTPRequest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ASIHTTPRequest.m; sourceTree = "<group>"; }; B5ABC7BA0E24C5620072F422 /* ASIHTTPRequest.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ASIHTTPRequest.h; sourceTree = "<group>"; }; B5ABC80D0E24CB100072F422 /* AppDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = AppDelegate.h; sourceTree = "<group>"; }; @@ -129,6 +131,7 @@ isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( + B58610B80F4F31E600159EBD /* libz.1.2.3.dylib in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -195,6 +198,7 @@ B5B5314D0F0B59A1007E2A5C /* CoreServices.framework */, B5B532560F0B5CA9007E2A5C /* UploadProgress.xib */, B568AFFB0F49D7AE00FA13C8 /* libz.1.2.3.dylib */, + B58610B70F4F31E600159EBD /* libz.1.2.3.dylib */, ); name = "asi-http-request"; sourceTree = "<group>"; @@ -231,7 +235,7 @@ B5B03DA50EC5D0930089D01F /* ASINetworkQueueTests.h */, B5B03DA60EC5D0930089D01F /* ASINetworkQueueTests.m */, B5731AFA0E430B1F0008024F /* ASIHTTPRequestTests.h */, - B5731AFB0E430B1F0008024F /* ASIHTTPRequestTests */, + B568B0D10F49FC7900FA13C8 /* ASIHTTPRequestTests.m */, ); name = Tests; sourceTree = "<group>"; @@ -406,13 +410,13 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( - B5731C300E431B340008024F /* ASIHTTPRequestTests in Sources */, B5F4C3470EC47B0400D4F31C /* ASIHTTPRequest.m in Sources */, B5F4C3490EC47B1700D4F31C /* NSHTTPCookieAdditions.m in Sources */, B5B03D520EC5C0330089D01F /* ASINetworkQueue.m in Sources */, B5B03DA70EC5D0930089D01F /* ASINetworkQueueTests.m in Sources */, B5B03F130EC5DB0E0089D01F /* ASIFormDataRequest.m in Sources */, B5B03F9C0EC5DEF80089D01F /* ASIFormDataRequestTests.m in Sources */, + B568B0E50F49FCB900FA13C8 /* ASIHTTPRequestTests.m in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -543,7 +547,7 @@ ); PREBINDING = NO; PRODUCT_NAME = "AHR Sample"; - SDKROOT = iphonesimulator2.1; + SDKROOT = iphonesimulator2.2; }; name = Debug; }; @@ -571,7 +575,7 @@ PREBINDING = NO; PRODUCT_NAME = "AHR Sample"; PROVISIONING_PROFILE = "117D7881-B33E-4AFD-9EB2-E32F1E6033D8"; - SDKROOT = iphoneos2.1; + SDKROOT = iphonesimulator2.2; ZERO_LINK = NO; }; name = Release; asi-http-request.xcodeproj/project.pbxproj 35bc9cae2ea8594943ee2c5e8693a0afabad621f Ben Copsey ben@allseeing-i.com http://github.com/pokeb/asi-http-request/commit/192dc941900470299efce20f274928b05d806fbb 192dc941900470299efce20f274928b05d806fbb 2009-02-23T03:41:04-08:00 2009-02-23T03:41:04-08:00 Make gzipped file downloads work Fix iphone sample to work with renamed properties 0520dfe9ae52aba4109e35f1d4d44c503e51b2b6 Ben Copsey ben@allseeing-i.com