From e008c14c2d554ea9e54558b361f1770a10d86c6f Mon Sep 17 00:00:00 2001 From: Dmitry Soldatenkov Date: Fri, 25 Mar 2022 11:47:55 +0300 Subject: [PATCH] iOS: remade local server on CocoaHTTPServer --- CREDITS | 4 +- LICENSE | 2 +- .../iphone/Classes/CocoaServer/CCocoaServer.h | 27 + .../iphone/Classes/CocoaServer/CCocoaServer.m | 107 + .../Classes/CocoaServer/RhoHTTPConnection.h | 13 + .../Classes/CocoaServer/RhoHTTPConnection.m | 157 + .../CocoaHTTPServer/Core/Categories/DDData.h | 14 + .../CocoaHTTPServer/Core/Categories/DDData.m | 158 + .../Core/Categories/DDNumber.h | 12 + .../Core/Categories/DDNumber.m | 88 + .../CocoaHTTPServer/Core/Categories/DDRange.h | 56 + .../CocoaHTTPServer/Core/Categories/DDRange.m | 104 + .../Core/HTTPAuthenticationRequest.h | 45 + .../Core/HTTPAuthenticationRequest.m | 195 + .../CocoaHTTPServer/Core/HTTPConnection.h | 119 + .../CocoaHTTPServer/Core/HTTPConnection.m | 2708 ++++++ .../iphone/CocoaHTTPServer/Core/HTTPLogging.h | 136 + .../iphone/CocoaHTTPServer/Core/HTTPMessage.h | 48 + .../iphone/CocoaHTTPServer/Core/HTTPMessage.m | 113 + .../CocoaHTTPServer/Core/HTTPResponse.h | 149 + .../iphone/CocoaHTTPServer/Core/HTTPServer.h | 205 + .../iphone/CocoaHTTPServer/Core/HTTPServer.m | 772 ++ .../Core/Mime/MultipartFormDataParser.h | 65 + .../Core/Mime/MultipartFormDataParser.m | 529 ++ .../Core/Mime/MultipartMessageHeader.h | 33 + .../Core/Mime/MultipartMessageHeader.m | 86 + .../Core/Mime/MultipartMessageHeaderField.h | 23 + .../Core/Mime/MultipartMessageHeaderField.m | 211 + .../Core/Responses/HTTPAsyncFileResponse.h | 75 + .../Core/Responses/HTTPAsyncFileResponse.m | 405 + .../Core/Responses/HTTPDataResponse.h | 13 + .../Core/Responses/HTTPDataResponse.m | 79 + .../Core/Responses/HTTPDynamicFileResponse.h | 52 + .../Core/Responses/HTTPDynamicFileResponse.m | 292 + .../Core/Responses/HTTPErrorResponse.h | 9 + .../Core/Responses/HTTPErrorResponse.m | 38 + .../Core/Responses/HTTPFileResponse.h | 25 + .../Core/Responses/HTTPFileResponse.m | 237 + .../Core/Responses/HTTPRedirectResponse.h | 12 + .../Core/Responses/HTTPRedirectResponse.m | 73 + .../iphone/CocoaHTTPServer/Core/WebSocket.h | 105 + .../iphone/CocoaHTTPServer/Core/WebSocket.m | 791 ++ .../Extensions/WebDAV/DAVConnection.h | 7 + .../Extensions/WebDAV/DAVConnection.m | 160 + .../Extensions/WebDAV/DAVResponse.h | 11 + .../Extensions/WebDAV/DAVResponse.m | 372 + .../Extensions/WebDAV/DELETEResponse.h | 7 + .../Extensions/WebDAV/DELETEResponse.m | 49 + .../Extensions/WebDAV/PUTResponse.h | 8 + .../Extensions/WebDAV/PUTResponse.m | 69 + platform/iphone/CocoaHTTPServer/LICENSE.txt | 18 + .../Vendor/CocoaAsyncSocket/About.txt | 4 + .../Vendor/CocoaAsyncSocket/GCDAsyncSocket.h | 1074 +++ .../Vendor/CocoaAsyncSocket/GCDAsyncSocket.m | 7430 +++++++++++++++++ .../Vendor/CocoaLumberjack/About.txt | 33 + .../Vendor/CocoaLumberjack/DDASLLogger.h | 41 + .../Vendor/CocoaLumberjack/DDASLLogger.m | 99 + .../DDAbstractDatabaseLogger.h | 102 + .../DDAbstractDatabaseLogger.m | 727 ++ .../Vendor/CocoaLumberjack/DDFileLogger.h | 334 + .../Vendor/CocoaLumberjack/DDFileLogger.m | 1353 +++ .../Vendor/CocoaLumberjack/DDLog.h | 601 ++ .../Vendor/CocoaLumberjack/DDLog.m | 1083 +++ .../Vendor/CocoaLumberjack/DDTTYLogger.h | 167 + .../Vendor/CocoaLumberjack/DDTTYLogger.m | 1479 ++++ .../Extensions/ContextFilterLogFormatter.h | 65 + .../Extensions/ContextFilterLogFormatter.m | 191 + .../Extensions/DispatchQueueLogFormatter.h | 116 + .../Extensions/DispatchQueueLogFormatter.m | 251 + .../CocoaLumberjack/Extensions/README.txt | 7 + .../RhoAppBaseLib.xcodeproj/project.pbxproj | 364 + platform/shared/common/RhodesApp.cpp | 21 +- platform/shared/net/HttpServer.cpp | 14 + .../templates/application/rhoconfig.txt | 4 + 74 files changed, 24643 insertions(+), 3 deletions(-) create mode 100644 platform/iphone/Classes/CocoaServer/CCocoaServer.h create mode 100644 platform/iphone/Classes/CocoaServer/CCocoaServer.m create mode 100644 platform/iphone/Classes/CocoaServer/RhoHTTPConnection.h create mode 100644 platform/iphone/Classes/CocoaServer/RhoHTTPConnection.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Categories/DDData.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Categories/DDData.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPConnection.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPConnection.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPLogging.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPMessage.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPMessage.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPServer.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/HTTPServer.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Core/WebSocket.h create mode 100644 platform/iphone/CocoaHTTPServer/Core/WebSocket.m create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.h create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.m create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.h create mode 100644 platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.m create mode 100644 platform/iphone/CocoaHTTPServer/LICENSE.txt create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/About.txt create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.h create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.m create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/About.txt create mode 100755 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.h create mode 100755 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.m create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.h create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.m create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.h create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.m create mode 100755 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.h create mode 100755 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.m create mode 100755 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.h create mode 100755 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.m create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.h create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.m create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.h create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.m create mode 100644 platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/README.txt diff --git a/CREDITS b/CREDITS index da37f660bc9..180e0914015 100644 --- a/CREDITS +++ b/CREDITS @@ -2227,4 +2227,6 @@ Rhodes contains code from the following other projects: JXcore (https://github.com/jxcore/jxcore) License: MIT-Style (https://github.com/jxcore/jxcore/blob/master/JXCORE_LICENSE) - + + CocoaHTTPServer (https://github.com/robbiehanson/CocoaHTTPServer) + License: BSD-style (https://github.com/robbiehanson/CocoaHTTPServer/blob/master/LICENSE.txt) diff --git a/LICENSE b/LICENSE index 4cc01a8623b..9a2a106dcd9 100644 --- a/LICENSE +++ b/LICENSE @@ -2,7 +2,7 @@ Copyright (c) 2008-2010 Rhomobile, Inc. Copyright (c) 2011-2016 Symbol Technologies LLC -Copyright (c) 2016-2020 Tau Technologies, Inc. +Copyright (c) 2016-2022 Tau Technologies, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/platform/iphone/Classes/CocoaServer/CCocoaServer.h b/platform/iphone/Classes/CocoaServer/CCocoaServer.h new file mode 100644 index 00000000000..5fe16866634 --- /dev/null +++ b/platform/iphone/Classes/CocoaServer/CCocoaServer.h @@ -0,0 +1,27 @@ + +#import +#import "HTTPServer.h" + + + + +@interface CCocoaServer : NSObject { + + HTTPServer *httpServer; + +} + ++ (CCocoaServer*)sharedInstance; + + +-(id)init; +-(void)start; +-(void)stop; + + + +-(void) createServer; + +@end + + diff --git a/platform/iphone/Classes/CocoaServer/CCocoaServer.m b/platform/iphone/Classes/CocoaServer/CCocoaServer.m new file mode 100644 index 00000000000..2ab8aff4cc3 --- /dev/null +++ b/platform/iphone/Classes/CocoaServer/CCocoaServer.m @@ -0,0 +1,107 @@ + +#import "CCocoaServer.h" +#import "RhoHTTPConnection.h" + + +#import "DDLog.h" +#import "DDTTYLogger.h" + + +extern int rho_http_get_port(); +extern const char* rho_http_direct_request( const char* method, const char* uri, const char* query, const void* headers, const char* body, int bodylen, int* responseLength ); +extern void rho_http_free_response( const char* data ); + +extern void* rho_http_init_headers_list(); +extern void rho_http_add_header( void* list, const char* name, const char* value ); +extern void rho_http_free_headers_list( void* list ); + +static const int ddLogLevel = LOG_LEVEL_VERBOSE; + + +static CCocoaServer* ourSharedInstance = nil; + +@implementation CCocoaServer + ++ (CCocoaServer*)sharedInstance { + if (ourSharedInstance == nil) { + ourSharedInstance = [[CCocoaServer alloc] init]; + } + return ourSharedInstance; +} + +-(id)init { + [super init]; + httpServer = nil; + return self; +} + +-(void) createServer { + NSLog(@"$$$$$ HTTP SERVER CREATE()"); + + [DDLog addLogger:[DDTTYLogger sharedInstance]]; + + httpServer = [[HTTPServer alloc] init]; + [httpServer setType:@"_http._tcp."]; + [httpServer setPort:rho_http_get_port()]; // setup port + [httpServer setInterface:@"localhost"]; // accept only inner connections + [httpServer setConnectionClass:[RhoHTTPConnection class]]; // replace connection for replace responce functionlity +} + +-(void)start{ + + if (httpServer == nil) { + NSLog(@"$$$$$ HTTP SERVER START() - NO SERVER !"); + return; + } + NSLog(@"$$$$$ HTTP SERVER START()"); + + NSError *error; + + if (![httpServer isRunning]) { + if([httpServer start:&error]) + { + NSLog(@"Started HTTP Server on port %hu", [httpServer listeningPort]); + } + else + { + NSLog(@"Error starting HTTP Server: %@", [error localizedDescription]); + } + } +} + + + +-(void)stop { + if (httpServer == nil) { + NSLog(@"$$$$$ HTTP SERVER STOP() - NO SERVER !"); + + return; + } + NSLog(@"$$$$$ HTTP SERVER STOP()"); + + if ([httpServer isRunning]) { + [httpServer stop]; + } +} + + +@end + + + + +void rho_cocoa_server_init() { + CCocoaServer* server = [CCocoaServer sharedInstance]; + [server createServer]; + [server start]; +} + +void rho_cocoa_server_stop() { + CCocoaServer* server = [CCocoaServer sharedInstance]; + [server stop]; +} + +void rho_cocoa_server_start() { + CCocoaServer* server = [CCocoaServer sharedInstance]; + [server start]; +} diff --git a/platform/iphone/Classes/CocoaServer/RhoHTTPConnection.h b/platform/iphone/Classes/CocoaServer/RhoHTTPConnection.h new file mode 100644 index 00000000000..ba281f011b1 --- /dev/null +++ b/platform/iphone/Classes/CocoaServer/RhoHTTPConnection.h @@ -0,0 +1,13 @@ +#import +#import "HTTPConnection.h" + + + +@interface RhoHTTPConnection : HTTPConnection +{ +} + +- (void)replyToHTTPRequest; + +@end + diff --git a/platform/iphone/Classes/CocoaServer/RhoHTTPConnection.m b/platform/iphone/Classes/CocoaServer/RhoHTTPConnection.m new file mode 100644 index 00000000000..a5ecb55d245 --- /dev/null +++ b/platform/iphone/Classes/CocoaServer/RhoHTTPConnection.m @@ -0,0 +1,157 @@ +#import "RhoHTTPConnection.h" +#import "GCDAsyncSocket.h" +#import "HTTPServer.h" +#import "HTTPMessage.h" +#import "HTTPResponse.h" +#import "HTTPAuthenticationRequest.h" +#import "DDNumber.h" +#import "DDRange.h" +#import "DDData.h" +#import "HTTPFileResponse.h" +#import "HTTPAsyncFileResponse.h" +#import "WebSocket.h" +#import "HTTPLogging.h" + + +extern const char* rho_http_direct_request( const char* method, const char* uri, const char* query, const void* headers, const char* body, int bodylen, int* responseLength ); +extern void rho_http_free_response( const char* data ); + +extern void* rho_http_init_headers_list(); +extern void rho_http_add_header( void* list, const char* name, const char* value ); +extern void rho_http_free_headers_list( void* list ); + +#define HTTP_RESPONSE 90 +#define HTTP_FINAL_RESPONSE 91 +#define TIMEOUT_WRITE_BODY -1 + +static const int ddLogLevel = LOG_LEVEL_VERBOSE; + +@implementation RhoHTTPConnection + + +- (BOOL)supportsMethod:(NSString *)method atPath:(NSString *)path +{ + + if ([method isEqualToString:@"GET"]) + return YES; + + if ([method isEqualToString:@"POST"]) + return YES; + + if ([method isEqualToString:@"PUT"]) + return YES; + + if ([method isEqualToString:@"HEAD"]) + return YES; + + return NO; +} + +/* + - (BOOL)expectsRequestBodyFromMethod:(NSString *)method atPath:(NSString *)path { + return YES; +} +*/ + +- (void)processBodyData:(NSData *)postDataChunk { + // only up to 256 Kb !!! - if larger we must accumulate data ! + [request setBody:postDataChunk]; +} + +- (void)replyToHTTPRequest { + + NSString *requestUri = [self requestURI]; + + NSURL* nsurl = [NSURL URLWithString:requestUri]; + NSString *requestMethod = [request method]; + NSDictionary* requestHeaders = [request allHeaderFields]; + NSData* requestBody = [request body]; + + + + + + const char* uri = [[nsurl path] UTF8String]; + const char* method = [requestMethod UTF8String]; + const char* body = [requestBody bytes]; + int bodylen = (int)requestBody.length; + const char* query = [[nsurl query] UTF8String]; + + void* cHeaders = rho_http_init_headers_list(); + + for (NSString* key in requestHeaders) { + NSString* value = [requestHeaders objectForKey:key]; + + rho_http_add_header(cHeaders, [key UTF8String], [value UTF8String]); + + } + + int len = 0; + + //if ([requestUri isEqualToString:@"/system/js_api_entrypoint"]) { + // int o= 9; + // o = 0; + //} + + + + const char* response = rho_http_direct_request(method, uri, query, cHeaders, body, bodylen, &len); + + rho_http_free_headers_list(cHeaders); + + //CRhoURLResponse* resp = nil; + + if ( response != 0 ) { + + /* + // parse http responce for prepare detailed responce instead of raw data + // not used currently - just send raw data + + self.httpStatusCode = 0; + self.httpBody = nil; + self.httpHeaderName = nil; + self.httpHeaders = nil; + + http_parser_settings settings; + settings.on_header_field = on_http_header; + settings.on_header_value = on_http_header_value; + settings.on_body = on_http_body; + settings.on_status = on_http_status; + + settings.on_headers_complete = on_http_cb; + settings.on_message_begin = on_http_cb; + settings.on_message_complete = on_http_cb; + settings.on_url = on_http_data_cb; + http_parser *parser = malloc(sizeof(http_parser)); + parser->data = self; + http_parser_init(parser, HTTP_RESPONSE); + http_parser_execute(parser, &settings, response, len); + + NSString* strHttpVer = [NSString stringWithFormat:@"%d.%d",parser->http_major,parser->http_minor]; + + self.httpStatusCode = parser->status_code; + + free(parser); + */ + + NSData* responseData = [[NSData dataWithBytes:response length:len] copy]; + rho_http_free_response(response); + + char a[1]; + a[0] = 0; + NSData* zz = [NSData dataWithBytes:a length:1]; + + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_BODY tag:HTTP_FINAL_RESPONSE]; + + [self finishResponse]; + } + else { + [self handleResourceNotFound]; + } + + // totally replace responce functionality + //[super replyToHTTPRequest]; +} + + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Categories/DDData.h b/platform/iphone/CocoaHTTPServer/Core/Categories/DDData.h new file mode 100644 index 00000000000..23f3d1cd192 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Categories/DDData.h @@ -0,0 +1,14 @@ +#import + +@interface NSData (DDData) + +- (NSData *)md5Digest; + +- (NSData *)sha1Digest; + +- (NSString *)hexStringValue; + +- (NSString *)base64Encoded; +- (NSData *)base64Decoded; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Categories/DDData.m b/platform/iphone/CocoaHTTPServer/Core/Categories/DDData.m new file mode 100644 index 00000000000..82c60df3fc8 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Categories/DDData.m @@ -0,0 +1,158 @@ +#import "DDData.h" +#import + + +@implementation NSData (DDData) + +static char encodingTable[64] = { +'A','B','C','D','E','F','G','H','I','J','K','L','M','N','O','P', +'Q','R','S','T','U','V','W','X','Y','Z','a','b','c','d','e','f', +'g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v', +'w','x','y','z','0','1','2','3','4','5','6','7','8','9','+','/' }; + +- (NSData *)md5Digest +{ + unsigned char result[CC_MD5_DIGEST_LENGTH]; + + CC_MD5([self bytes], (CC_LONG)[self length], result); + return [NSData dataWithBytes:result length:CC_MD5_DIGEST_LENGTH]; +} + +- (NSData *)sha1Digest +{ + unsigned char result[CC_SHA1_DIGEST_LENGTH]; + + CC_SHA1([self bytes], (CC_LONG)[self length], result); + return [NSData dataWithBytes:result length:CC_SHA1_DIGEST_LENGTH]; +} + +- (NSString *)hexStringValue +{ + NSMutableString *stringBuffer = [NSMutableString stringWithCapacity:([self length] * 2)]; + + const unsigned char *dataBuffer = [self bytes]; + int i; + + for (i = 0; i < [self length]; ++i) + { + [stringBuffer appendFormat:@"%02x", (unsigned int)dataBuffer[i]]; + } + + return [stringBuffer copy]; +} + +- (NSString *)base64Encoded +{ + const unsigned char *bytes = [self bytes]; + NSMutableString *result = [NSMutableString stringWithCapacity:[self length]]; + unsigned long ixtext = 0; + unsigned long lentext = [self length]; + long ctremaining = 0; + unsigned char inbuf[3], outbuf[4]; + unsigned short i = 0; + unsigned short charsonline = 0, ctcopy = 0; + unsigned long ix = 0; + + while( YES ) + { + ctremaining = lentext - ixtext; + if( ctremaining <= 0 ) break; + + for( i = 0; i < 3; i++ ) { + ix = ixtext + i; + if( ix < lentext ) inbuf[i] = bytes[ix]; + else inbuf [i] = 0; + } + + outbuf [0] = (inbuf [0] & 0xFC) >> 2; + outbuf [1] = ((inbuf [0] & 0x03) << 4) | ((inbuf [1] & 0xF0) >> 4); + outbuf [2] = ((inbuf [1] & 0x0F) << 2) | ((inbuf [2] & 0xC0) >> 6); + outbuf [3] = inbuf [2] & 0x3F; + ctcopy = 4; + + switch( ctremaining ) + { + case 1: + ctcopy = 2; + break; + case 2: + ctcopy = 3; + break; + } + + for( i = 0; i < ctcopy; i++ ) + [result appendFormat:@"%c", encodingTable[outbuf[i]]]; + + for( i = ctcopy; i < 4; i++ ) + [result appendString:@"="]; + + ixtext += 3; + charsonline += 4; + } + + return [NSString stringWithString:result]; +} + +- (NSData *)base64Decoded +{ + const unsigned char *bytes = [self bytes]; + NSMutableData *result = [NSMutableData dataWithCapacity:[self length]]; + + unsigned long ixtext = 0; + unsigned long lentext = [self length]; + unsigned char ch = 0; + unsigned char inbuf[4] = {0, 0, 0, 0}; + unsigned char outbuf[3] = {0, 0, 0}; + short i = 0, ixinbuf = 0; + BOOL flignore = NO; + BOOL flendtext = NO; + + while( YES ) + { + if( ixtext >= lentext ) break; + ch = bytes[ixtext++]; + flignore = NO; + + if( ( ch >= 'A' ) && ( ch <= 'Z' ) ) ch = ch - 'A'; + else if( ( ch >= 'a' ) && ( ch <= 'z' ) ) ch = ch - 'a' + 26; + else if( ( ch >= '0' ) && ( ch <= '9' ) ) ch = ch - '0' + 52; + else if( ch == '+' ) ch = 62; + else if( ch == '=' ) flendtext = YES; + else if( ch == '/' ) ch = 63; + else flignore = YES; + + if( ! flignore ) + { + short ctcharsinbuf = 3; + BOOL flbreak = NO; + + if( flendtext ) + { + if( ! ixinbuf ) break; + if( ( ixinbuf == 1 ) || ( ixinbuf == 2 ) ) ctcharsinbuf = 1; + else ctcharsinbuf = 2; + ixinbuf = 3; + flbreak = YES; + } + + inbuf [ixinbuf++] = ch; + + if( ixinbuf == 4 ) + { + ixinbuf = 0; + outbuf [0] = ( inbuf[0] << 2 ) | ( ( inbuf[1] & 0x30) >> 4 ); + outbuf [1] = ( ( inbuf[1] & 0x0F ) << 4 ) | ( ( inbuf[2] & 0x3C ) >> 2 ); + outbuf [2] = ( ( inbuf[2] & 0x03 ) << 6 ) | ( inbuf[3] & 0x3F ); + + for( i = 0; i < ctcharsinbuf; i++ ) + [result appendBytes:&outbuf[i] length:1]; + } + + if( flbreak ) break; + } + } + + return [NSData dataWithData:result]; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.h b/platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.h new file mode 100644 index 00000000000..26436103ea5 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.h @@ -0,0 +1,12 @@ +#import + + +@interface NSNumber (DDNumber) + ++ (BOOL)parseString:(NSString *)str intoSInt64:(SInt64 *)pNum; ++ (BOOL)parseString:(NSString *)str intoUInt64:(UInt64 *)pNum; + ++ (BOOL)parseString:(NSString *)str intoNSInteger:(NSInteger *)pNum; ++ (BOOL)parseString:(NSString *)str intoNSUInteger:(NSUInteger *)pNum; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.m b/platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.m new file mode 100644 index 00000000000..d384d39c59c --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Categories/DDNumber.m @@ -0,0 +1,88 @@ +#import "DDNumber.h" + + +@implementation NSNumber (DDNumber) + ++ (BOOL)parseString:(NSString *)str intoSInt64:(SInt64 *)pNum +{ + if(str == nil) + { + *pNum = 0; + return NO; + } + + errno = 0; + + // On both 32-bit and 64-bit machines, long long = 64 bit + + *pNum = strtoll([str UTF8String], NULL, 10); + + if(errno != 0) + return NO; + else + return YES; +} + ++ (BOOL)parseString:(NSString *)str intoUInt64:(UInt64 *)pNum +{ + if(str == nil) + { + *pNum = 0; + return NO; + } + + errno = 0; + + // On both 32-bit and 64-bit machines, unsigned long long = 64 bit + + *pNum = strtoull([str UTF8String], NULL, 10); + + if(errno != 0) + return NO; + else + return YES; +} + ++ (BOOL)parseString:(NSString *)str intoNSInteger:(NSInteger *)pNum +{ + if(str == nil) + { + *pNum = 0; + return NO; + } + + errno = 0; + + // On LP64, NSInteger = long = 64 bit + // Otherwise, NSInteger = int = long = 32 bit + + *pNum = strtol([str UTF8String], NULL, 10); + + if(errno != 0) + return NO; + else + return YES; +} + ++ (BOOL)parseString:(NSString *)str intoNSUInteger:(NSUInteger *)pNum +{ + if(str == nil) + { + *pNum = 0; + return NO; + } + + errno = 0; + + // On LP64, NSUInteger = unsigned long = 64 bit + // Otherwise, NSUInteger = unsigned int = unsigned long = 32 bit + + *pNum = strtoul([str UTF8String], NULL, 10); + + if(errno != 0) + return NO; + else + return YES; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.h b/platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.h new file mode 100644 index 00000000000..e95974a7169 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.h @@ -0,0 +1,56 @@ +/** + * DDRange is the functional equivalent of a 64 bit NSRange. + * The HTTP Server is designed to support very large files. + * On 32 bit architectures (ppc, i386) NSRange uses unsigned 32 bit integers. + * This only supports a range of up to 4 gigabytes. + * By defining our own variant, we can support a range up to 16 exabytes. + * + * All effort is given such that DDRange functions EXACTLY the same as NSRange. +**/ + +#import +#import + +@class NSString; + +typedef struct _DDRange { + UInt64 location; + UInt64 length; +} DDRange; + +typedef DDRange *DDRangePointer; + +NS_INLINE DDRange DDMakeRange(UInt64 loc, UInt64 len) { + DDRange r; + r.location = loc; + r.length = len; + return r; +} + +NS_INLINE UInt64 DDMaxRange(DDRange range) { + return (range.location + range.length); +} + +NS_INLINE BOOL DDLocationInRange(UInt64 loc, DDRange range) { + return (loc - range.location < range.length); +} + +NS_INLINE BOOL DDEqualRanges(DDRange range1, DDRange range2) { + return ((range1.location == range2.location) && (range1.length == range2.length)); +} + +FOUNDATION_EXPORT DDRange DDUnionRange(DDRange range1, DDRange range2); +FOUNDATION_EXPORT DDRange DDIntersectionRange(DDRange range1, DDRange range2); +FOUNDATION_EXPORT NSString *DDStringFromRange(DDRange range); +FOUNDATION_EXPORT DDRange DDRangeFromString(NSString *aString); + +NSInteger DDRangeCompare(DDRangePointer pDDRange1, DDRangePointer pDDRange2); + +@interface NSValue (NSValueDDRangeExtensions) + ++ (NSValue *)valueWithDDRange:(DDRange)range; +- (DDRange)ddrangeValue; + +- (NSInteger)ddrangeCompare:(NSValue *)ddrangeValue; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.m b/platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.m new file mode 100644 index 00000000000..379e7cf38f3 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Categories/DDRange.m @@ -0,0 +1,104 @@ +#import "DDRange.h" +#import "DDNumber.h" + +DDRange DDUnionRange(DDRange range1, DDRange range2) +{ + DDRange result; + + result.location = MIN(range1.location, range2.location); + result.length = MAX(DDMaxRange(range1), DDMaxRange(range2)) - result.location; + + return result; +} + +DDRange DDIntersectionRange(DDRange range1, DDRange range2) +{ + DDRange result; + + if((DDMaxRange(range1) < range2.location) || (DDMaxRange(range2) < range1.location)) + { + return DDMakeRange(0, 0); + } + + result.location = MAX(range1.location, range2.location); + result.length = MIN(DDMaxRange(range1), DDMaxRange(range2)) - result.location; + + return result; +} + +NSString *DDStringFromRange(DDRange range) +{ + return [NSString stringWithFormat:@"{%qu, %qu}", range.location, range.length]; +} + +DDRange DDRangeFromString(NSString *aString) +{ + DDRange result = DDMakeRange(0, 0); + + // NSRange will ignore '-' characters, but not '+' characters + NSCharacterSet *cset = [NSCharacterSet characterSetWithCharactersInString:@"+0123456789"]; + + NSScanner *scanner = [NSScanner scannerWithString:aString]; + [scanner setCharactersToBeSkipped:[cset invertedSet]]; + + NSString *str1 = nil; + NSString *str2 = nil; + + BOOL found1 = [scanner scanCharactersFromSet:cset intoString:&str1]; + BOOL found2 = [scanner scanCharactersFromSet:cset intoString:&str2]; + + if(found1) [NSNumber parseString:str1 intoUInt64:&result.location]; + if(found2) [NSNumber parseString:str2 intoUInt64:&result.length]; + + return result; +} + +NSInteger DDRangeCompare(DDRangePointer pDDRange1, DDRangePointer pDDRange2) +{ + // Comparison basis: + // Which range would you encouter first if you started at zero, and began walking towards infinity. + // If you encouter both ranges at the same time, which range would end first. + + if(pDDRange1->location < pDDRange2->location) + { + return NSOrderedAscending; + } + if(pDDRange1->location > pDDRange2->location) + { + return NSOrderedDescending; + } + if(pDDRange1->length < pDDRange2->length) + { + return NSOrderedAscending; + } + if(pDDRange1->length > pDDRange2->length) + { + return NSOrderedDescending; + } + + return NSOrderedSame; +} + +@implementation NSValue (NSValueDDRangeExtensions) + ++ (NSValue *)valueWithDDRange:(DDRange)range +{ + return [NSValue valueWithBytes:&range objCType:@encode(DDRange)]; +} + +- (DDRange)ddrangeValue +{ + DDRange result; + [self getValue:&result]; + return result; +} + +- (NSInteger)ddrangeCompare:(NSValue *)other +{ + DDRange r1 = [self ddrangeValue]; + DDRange r2 = [other ddrangeValue]; + + return DDRangeCompare(&r1, &r2); +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.h b/platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.h new file mode 100644 index 00000000000..4d64236d0ab --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.h @@ -0,0 +1,45 @@ +#import + +#if TARGET_OS_IPHONE + // Note: You may need to add the CFNetwork Framework to your project + #import +#endif + +@class HTTPMessage; + + +@interface HTTPAuthenticationRequest : NSObject +{ + BOOL isBasic; + BOOL isDigest; + + NSString *base64Credentials; + + NSString *username; + NSString *realm; + NSString *nonce; + NSString *uri; + NSString *qop; + NSString *nc; + NSString *cnonce; + NSString *response; +} +- (id)initWithRequest:(HTTPMessage *)request; + +- (BOOL)isBasic; +- (BOOL)isDigest; + +// Basic +- (NSString *)base64Credentials; + +// Digest +- (NSString *)username; +- (NSString *)realm; +- (NSString *)nonce; +- (NSString *)uri; +- (NSString *)qop; +- (NSString *)nc; +- (NSString *)cnonce; +- (NSString *)response; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.m b/platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.m new file mode 100644 index 00000000000..4d2f51b2587 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPAuthenticationRequest.m @@ -0,0 +1,195 @@ +#import "HTTPAuthenticationRequest.h" +#import "HTTPMessage.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +@interface HTTPAuthenticationRequest (PrivateAPI) +- (NSString *)quotedSubHeaderFieldValue:(NSString *)param fromHeaderFieldValue:(NSString *)header; +- (NSString *)nonquotedSubHeaderFieldValue:(NSString *)param fromHeaderFieldValue:(NSString *)header; +@end + + +@implementation HTTPAuthenticationRequest + +- (id)initWithRequest:(HTTPMessage *)request +{ + if ((self = [super init])) + { + NSString *authInfo = [request headerField:@"Authorization"]; + + isBasic = NO; + if ([authInfo length] >= 6) + { + isBasic = [[authInfo substringToIndex:6] caseInsensitiveCompare:@"Basic "] == NSOrderedSame; + } + + isDigest = NO; + if ([authInfo length] >= 7) + { + isDigest = [[authInfo substringToIndex:7] caseInsensitiveCompare:@"Digest "] == NSOrderedSame; + } + + if (isBasic) + { + NSMutableString *temp = [[authInfo substringFromIndex:6] mutableCopy]; + CFStringTrimWhitespace((__bridge CFMutableStringRef)temp); + + base64Credentials = [temp copy]; + } + + if (isDigest) + { + username = [self quotedSubHeaderFieldValue:@"username" fromHeaderFieldValue:authInfo]; + realm = [self quotedSubHeaderFieldValue:@"realm" fromHeaderFieldValue:authInfo]; + nonce = [self quotedSubHeaderFieldValue:@"nonce" fromHeaderFieldValue:authInfo]; + uri = [self quotedSubHeaderFieldValue:@"uri" fromHeaderFieldValue:authInfo]; + + // It appears from RFC 2617 that the qop is to be given unquoted + // Tests show that Firefox performs this way, but Safari does not + // Thus we'll attempt to retrieve the value as nonquoted, but we'll verify it doesn't start with a quote + qop = [self nonquotedSubHeaderFieldValue:@"qop" fromHeaderFieldValue:authInfo]; + if(qop && ([qop characterAtIndex:0] == '"')) + { + qop = [self quotedSubHeaderFieldValue:@"qop" fromHeaderFieldValue:authInfo]; + } + + nc = [self nonquotedSubHeaderFieldValue:@"nc" fromHeaderFieldValue:authInfo]; + cnonce = [self quotedSubHeaderFieldValue:@"cnonce" fromHeaderFieldValue:authInfo]; + response = [self quotedSubHeaderFieldValue:@"response" fromHeaderFieldValue:authInfo]; + } + } + return self; +} + + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Accessors: +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)isBasic { + return isBasic; +} + +- (BOOL)isDigest { + return isDigest; +} + +- (NSString *)base64Credentials { + return base64Credentials; +} + +- (NSString *)username { + return username; +} + +- (NSString *)realm { + return realm; +} + +- (NSString *)nonce { + return nonce; +} + +- (NSString *)uri { + return uri; +} + +- (NSString *)qop { + return qop; +} + +- (NSString *)nc { + return nc; +} + +- (NSString *)cnonce { + return cnonce; +} + +- (NSString *)response { + return response; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Private API: +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Retrieves a "Sub Header Field Value" from a given header field value. + * The sub header field is expected to be quoted. + * + * In the following header field: + * Authorization: Digest username="Mufasa", qop=auth, response="6629fae4939" + * The sub header field titled 'username' is quoted, and this method would return the value @"Mufasa". +**/ +- (NSString *)quotedSubHeaderFieldValue:(NSString *)param fromHeaderFieldValue:(NSString *)header +{ + NSRange startRange = [header rangeOfString:[NSString stringWithFormat:@"%@=\"", param]]; + if(startRange.location == NSNotFound) + { + // The param was not found anywhere in the header + return nil; + } + + NSUInteger postStartRangeLocation = startRange.location + startRange.length; + NSUInteger postStartRangeLength = [header length] - postStartRangeLocation; + NSRange postStartRange = NSMakeRange(postStartRangeLocation, postStartRangeLength); + + NSRange endRange = [header rangeOfString:@"\"" options:0 range:postStartRange]; + if(endRange.location == NSNotFound) + { + // The ending double-quote was not found anywhere in the header + return nil; + } + + NSRange subHeaderRange = NSMakeRange(postStartRangeLocation, endRange.location - postStartRangeLocation); + return [header substringWithRange:subHeaderRange]; +} + +/** + * Retrieves a "Sub Header Field Value" from a given header field value. + * The sub header field is expected to not be quoted. + * + * In the following header field: + * Authorization: Digest username="Mufasa", qop=auth, response="6629fae4939" + * The sub header field titled 'qop' is nonquoted, and this method would return the value @"auth". +**/ +- (NSString *)nonquotedSubHeaderFieldValue:(NSString *)param fromHeaderFieldValue:(NSString *)header +{ + NSRange startRange = [header rangeOfString:[NSString stringWithFormat:@"%@=", param]]; + if(startRange.location == NSNotFound) + { + // The param was not found anywhere in the header + return nil; + } + + NSUInteger postStartRangeLocation = startRange.location + startRange.length; + NSUInteger postStartRangeLength = [header length] - postStartRangeLocation; + NSRange postStartRange = NSMakeRange(postStartRangeLocation, postStartRangeLength); + + NSRange endRange = [header rangeOfString:@"," options:0 range:postStartRange]; + if(endRange.location == NSNotFound) + { + // The ending comma was not found anywhere in the header + // However, if the nonquoted param is at the end of the string, there would be no comma + // This is only possible if there are no spaces anywhere + NSRange endRange2 = [header rangeOfString:@" " options:0 range:postStartRange]; + if(endRange2.location != NSNotFound) + { + return nil; + } + else + { + return [header substringWithRange:postStartRange]; + } + } + else + { + NSRange subHeaderRange = NSMakeRange(postStartRangeLocation, endRange.location - postStartRangeLocation); + return [header substringWithRange:subHeaderRange]; + } +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPConnection.h b/platform/iphone/CocoaHTTPServer/Core/HTTPConnection.h new file mode 100644 index 00000000000..224141cfe3b --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPConnection.h @@ -0,0 +1,119 @@ +#import + +@class GCDAsyncSocket; +@class HTTPMessage; +@class HTTPServer; +@class WebSocket; +@protocol HTTPResponse; + + +#define HTTPConnectionDidDieNotification @"HTTPConnectionDidDie" + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@interface HTTPConfig : NSObject +{ + HTTPServer __unsafe_unretained *server; + NSString __strong *documentRoot; + dispatch_queue_t queue; +} + +- (id)initWithServer:(HTTPServer *)server documentRoot:(NSString *)documentRoot; +- (id)initWithServer:(HTTPServer *)server documentRoot:(NSString *)documentRoot queue:(dispatch_queue_t)q; + +@property (nonatomic, unsafe_unretained, readonly) HTTPServer *server; +@property (nonatomic, strong, readonly) NSString *documentRoot; +@property (nonatomic, readonly) dispatch_queue_t queue; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@interface HTTPConnection : NSObject +{ + dispatch_queue_t connectionQueue; + GCDAsyncSocket *asyncSocket; + HTTPConfig *config; + + BOOL started; + + HTTPMessage *request; + unsigned int numHeaderLines; + + BOOL sentResponseHeaders; + + NSString *nonce; + long lastNC; + + NSObject *httpResponse; + + NSMutableArray *ranges; + NSMutableArray *ranges_headers; + NSString *ranges_boundry; + int rangeIndex; + + UInt64 requestContentLength; + UInt64 requestContentLengthReceived; + UInt64 requestChunkSize; + UInt64 requestChunkSizeReceived; + + NSMutableArray *responseDataSizes; +} + +- (id)initWithAsyncSocket:(GCDAsyncSocket *)newSocket configuration:(HTTPConfig *)aConfig; + +- (void)start; +- (void)stop; + +- (void)startConnection; + +- (BOOL)supportsMethod:(NSString *)method atPath:(NSString *)path; +- (BOOL)expectsRequestBodyFromMethod:(NSString *)method atPath:(NSString *)path; + +- (BOOL)isSecureServer; +- (NSArray *)sslIdentityAndCertificates; + +- (BOOL)isPasswordProtected:(NSString *)path; +- (BOOL)useDigestAccessAuthentication; +- (NSString *)realm; +- (NSString *)passwordForUser:(NSString *)username; + +- (NSDictionary *)parseParams:(NSString *)query; +- (NSDictionary *)parseGetParams; + +- (NSString *)requestURI; + +- (NSArray *)directoryIndexFileNames; +- (NSString *)filePathForURI:(NSString *)path; +- (NSString *)filePathForURI:(NSString *)path allowDirectory:(BOOL)allowDirectory; +- (NSObject *)httpResponseForMethod:(NSString *)method URI:(NSString *)path; +- (WebSocket *)webSocketForURI:(NSString *)path; + +- (void)prepareForBodyWithSize:(UInt64)contentLength; +- (void)processBodyData:(NSData *)postDataChunk; +- (void)finishBody; + +- (void)handleVersionNotSupported:(NSString *)version; +- (void)handleAuthenticationFailed; +- (void)handleResourceNotFound; +- (void)handleInvalidRequest:(NSData *)data; +- (void)handleUnknownMethod:(NSString *)method; + +- (NSData *)preprocessResponse:(HTTPMessage *)response; +- (NSData *)preprocessErrorResponse:(HTTPMessage *)response; + +- (void)finishResponse; + +- (BOOL)shouldDie; +- (void)die; + +@end + +@interface HTTPConnection (AsynchronousHTTPResponse) +- (void)responseHasAvailableData:(NSObject *)sender; +- (void)responseDidAbort:(NSObject *)sender; +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPConnection.m b/platform/iphone/CocoaHTTPServer/Core/HTTPConnection.m new file mode 100644 index 00000000000..d4ac82f5487 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPConnection.m @@ -0,0 +1,2708 @@ +#import "GCDAsyncSocket.h" +#import "HTTPServer.h" +#import "HTTPConnection.h" +#import "HTTPMessage.h" +#import "HTTPResponse.h" +#import "HTTPAuthenticationRequest.h" +#import "DDNumber.h" +#import "DDRange.h" +#import "DDData.h" +#import "HTTPFileResponse.h" +#import "HTTPAsyncFileResponse.h" +#import "WebSocket.h" +#import "HTTPLogging.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels: off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; // | HTTP_LOG_FLAG_TRACE; + +// Define chunk size used to read in data for responses +// This is how much data will be read from disk into RAM at a time +#if TARGET_OS_IPHONE + #define READ_CHUNKSIZE (1024 * 256) +#else + #define READ_CHUNKSIZE (1024 * 512) +#endif + +// Define chunk size used to read in POST upload data +#if TARGET_OS_IPHONE + #define POST_CHUNKSIZE (1024 * 256) +#else + #define POST_CHUNKSIZE (1024 * 512) +#endif + +// Define the various timeouts (in seconds) for various parts of the HTTP process +#define TIMEOUT_READ_FIRST_HEADER_LINE 30 +#define TIMEOUT_READ_SUBSEQUENT_HEADER_LINE 30 +#define TIMEOUT_READ_BODY -1 +#define TIMEOUT_WRITE_HEAD 30 +#define TIMEOUT_WRITE_BODY -1 +#define TIMEOUT_WRITE_ERROR 30 +#define TIMEOUT_NONCE 300 + +// Define the various limits +// MAX_HEADER_LINE_LENGTH: Max length (in bytes) of any single line in a header (including \r\n) +// MAX_HEADER_LINES : Max number of lines in a single header (including first GET line) +#define MAX_HEADER_LINE_LENGTH 8190 +#define MAX_HEADER_LINES 100 +// MAX_CHUNK_LINE_LENGTH : For accepting chunked transfer uploads, max length of chunk size line (including \r\n) +#define MAX_CHUNK_LINE_LENGTH 200 + +// Define the various tags we'll use to differentiate what it is we're currently doing +#define HTTP_REQUEST_HEADER 10 +#define HTTP_REQUEST_BODY 11 +#define HTTP_REQUEST_CHUNK_SIZE 12 +#define HTTP_REQUEST_CHUNK_DATA 13 +#define HTTP_REQUEST_CHUNK_TRAILER 14 +#define HTTP_REQUEST_CHUNK_FOOTER 15 +#define HTTP_PARTIAL_RESPONSE 20 +#define HTTP_PARTIAL_RESPONSE_HEADER 21 +#define HTTP_PARTIAL_RESPONSE_BODY 22 +#define HTTP_CHUNKED_RESPONSE_HEADER 30 +#define HTTP_CHUNKED_RESPONSE_BODY 31 +#define HTTP_CHUNKED_RESPONSE_FOOTER 32 +#define HTTP_PARTIAL_RANGE_RESPONSE_BODY 40 +#define HTTP_PARTIAL_RANGES_RESPONSE_BODY 50 +#define HTTP_RESPONSE 90 +#define HTTP_FINAL_RESPONSE 91 + +// A quick note about the tags: +// +// The HTTP_RESPONSE and HTTP_FINAL_RESPONSE are designated tags signalling that the response is completely sent. +// That is, in the onSocket:didWriteDataWithTag: method, if the tag is HTTP_RESPONSE or HTTP_FINAL_RESPONSE, +// it is assumed that the response is now completely sent. +// Use HTTP_RESPONSE if it's the end of a response, and you want to start reading more requests afterwards. +// Use HTTP_FINAL_RESPONSE if you wish to terminate the connection after sending the response. +// +// If you are sending multiple data segments in a custom response, make sure that only the last segment has +// the HTTP_RESPONSE tag. For all other segments prior to the last segment use HTTP_PARTIAL_RESPONSE, or some other +// tag of your own invention. + +@interface HTTPConnection (PrivateAPI) +- (void)startReadingRequest; +- (void)sendResponseHeadersAndBody; +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation HTTPConnection + +static dispatch_queue_t recentNonceQueue; +static NSMutableArray *recentNonces; + +/** + * This method is automatically called (courtesy of Cocoa) before the first instantiation of this class. + * We use it to initialize any static variables. +**/ ++ (void)initialize +{ + static dispatch_once_t onceToken; + dispatch_once(&onceToken, ^{ + + // Initialize class variables + recentNonceQueue = dispatch_queue_create("HTTPConnection-Nonce", NULL); + recentNonces = [[NSMutableArray alloc] initWithCapacity:5]; + }); +} + +/** + * Generates and returns an authentication nonce. + * A nonce is a server-specified string uniquely generated for each 401 response. + * The default implementation uses a single nonce for each session. +**/ ++ (NSString *)generateNonce +{ + // We use the Core Foundation UUID class to generate a nonce value for us + // UUIDs (Universally Unique Identifiers) are 128-bit values guaranteed to be unique. + CFUUIDRef theUUID = CFUUIDCreate(NULL); + NSString *newNonce = (__bridge_transfer NSString *)CFUUIDCreateString(NULL, theUUID); + CFRelease(theUUID); + + // We have to remember that the HTTP protocol is stateless. + // Even though with version 1.1 persistent connections are the norm, they are not guaranteed. + // Thus if we generate a nonce for this connection, + // it should be honored for other connections in the near future. + // + // In fact, this is absolutely necessary in order to support QuickTime. + // When QuickTime makes it's initial connection, it will be unauthorized, and will receive a nonce. + // It then disconnects, and creates a new connection with the nonce, and proper authentication. + // If we don't honor the nonce for the second connection, QuickTime will repeat the process and never connect. + + dispatch_async(recentNonceQueue, ^{ @autoreleasepool { + + [recentNonces addObject:newNonce]; + }}); + + double delayInSeconds = TIMEOUT_NONCE; + dispatch_time_t popTime = dispatch_time(DISPATCH_TIME_NOW, delayInSeconds * NSEC_PER_SEC); + dispatch_after(popTime, recentNonceQueue, ^{ @autoreleasepool { + + [recentNonces removeObject:newNonce]; + }}); + + return newNonce; +} + +/** + * Returns whether or not the given nonce is in the list of recently generated nonce's. +**/ ++ (BOOL)hasRecentNonce:(NSString *)recentNonce +{ + __block BOOL result = NO; + + dispatch_sync(recentNonceQueue, ^{ @autoreleasepool { + + result = [recentNonces containsObject:recentNonce]; + }}); + + return result; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Init, Dealloc: +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Sole Constructor. + * Associates this new HTTP connection with the given AsyncSocket. + * This HTTP connection object will become the socket's delegate and take over responsibility for the socket. +**/ +- (id)initWithAsyncSocket:(GCDAsyncSocket *)newSocket configuration:(HTTPConfig *)aConfig +{ + if ((self = [super init])) + { + HTTPLogTrace(); + + if (aConfig.queue) + { + connectionQueue = aConfig.queue; + #if !OS_OBJECT_USE_OBJC + dispatch_retain(connectionQueue); + #endif + } + else + { + connectionQueue = dispatch_queue_create("HTTPConnection", NULL); + } + + // Take over ownership of the socket + asyncSocket = newSocket; + [asyncSocket setDelegate:self delegateQueue:connectionQueue]; + + // Store configuration + config = aConfig; + + // Initialize lastNC (last nonce count). + // Used with digest access authentication. + // These must increment for each request from the client. + lastNC = 0; + + // Create a new HTTP message + request = [[HTTPMessage alloc] initEmptyRequest]; + + numHeaderLines = 0; + + responseDataSizes = [[NSMutableArray alloc] initWithCapacity:5]; + } + return self; +} + +/** + * Standard Deconstructor. +**/ +- (void)dealloc +{ + HTTPLogTrace(); + + #if !OS_OBJECT_USE_OBJC + dispatch_release(connectionQueue); + #endif + + [asyncSocket setDelegate:nil delegateQueue:NULL]; + [asyncSocket disconnect]; + + if ([httpResponse respondsToSelector:@selector(connectionDidClose)]) + { + [httpResponse connectionDidClose]; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Method Support +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns whether or not the server will accept messages of a given method + * at a particular URI. +**/ +- (BOOL)supportsMethod:(NSString *)method atPath:(NSString *)path +{ + HTTPLogTrace(); + + // Override me to support methods such as POST. + // + // Things you may want to consider: + // - Does the given path represent a resource that is designed to accept this method? + // - If accepting an upload, is the size of the data being uploaded too big? + // To do this you can check the requestContentLength variable. + // + // For more information, you can always access the HTTPMessage request variable. + // + // You should fall through with a call to [super supportsMethod:method atPath:path] + // + // See also: expectsRequestBodyFromMethod:atPath: + + if ([method isEqualToString:@"GET"]) + return YES; + + if ([method isEqualToString:@"HEAD"]) + return YES; + + return NO; +} + +/** + * Returns whether or not the server expects a body from the given method. + * + * In other words, should the server expect a content-length header and associated body from this method. + * This would be true in the case of a POST, where the client is sending data, + * or for something like PUT where the client is supposed to be uploading a file. +**/ +- (BOOL)expectsRequestBodyFromMethod:(NSString *)method atPath:(NSString *)path +{ + HTTPLogTrace(); + + // Override me to add support for other methods that expect the client + // to send a body along with the request header. + // + // You should fall through with a call to [super expectsRequestBodyFromMethod:method atPath:path] + // + // See also: supportsMethod:atPath: + + if ([method isEqualToString:@"POST"]) + return YES; + + if ([method isEqualToString:@"PUT"]) + return YES; + + return NO; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark HTTPS +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns whether or not the server is configured to be a secure server. + * In other words, all connections to this server are immediately secured, thus only secure connections are allowed. + * This is the equivalent of having an https server, where it is assumed that all connections must be secure. + * If this is the case, then unsecure connections will not be allowed on this server, and a separate unsecure server + * would need to be run on a separate port in order to support unsecure connections. + * + * Note: In order to support secure connections, the sslIdentityAndCertificates method must be implemented. +**/ +- (BOOL)isSecureServer +{ + HTTPLogTrace(); + + // Override me to create an https server... + + return NO; +} + +/** + * This method is expected to returns an array appropriate for use in kCFStreamSSLCertificates SSL Settings. + * It should be an array of SecCertificateRefs except for the first element in the array, which is a SecIdentityRef. +**/ +- (NSArray *)sslIdentityAndCertificates +{ + HTTPLogTrace(); + + // Override me to provide the proper required SSL identity. + + return nil; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Password Protection +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns whether or not the requested resource is password protected. + * In this generic implementation, nothing is password protected. +**/ +- (BOOL)isPasswordProtected:(NSString *)path +{ + HTTPLogTrace(); + + // Override me to provide password protection... + // You can configure it for the entire server, or based on the current request + + return NO; +} + +/** + * Returns whether or not the authentication challenge should use digest access authentication. + * The alternative is basic authentication. + * + * If at all possible, digest access authentication should be used because it's more secure. + * Basic authentication sends passwords in the clear and should be avoided unless using SSL/TLS. +**/ +- (BOOL)useDigestAccessAuthentication +{ + HTTPLogTrace(); + + // Override me to customize the authentication scheme + // Make sure you understand the security risks of using the weaker basic authentication + + return YES; +} + +/** + * Returns the authentication realm. + * In this generic implmentation, a default realm is used for the entire server. +**/ +- (NSString *)realm +{ + HTTPLogTrace(); + + // Override me to provide a custom realm... + // You can configure it for the entire server, or based on the current request + + return @"defaultRealm@host.com"; +} + +/** + * Returns the password for the given username. +**/ +- (NSString *)passwordForUser:(NSString *)username +{ + HTTPLogTrace(); + + // Override me to provide proper password authentication + // You can configure a password for the entire server, or custom passwords for users and/or resources + + // Security Note: + // A nil password means no access at all. (Such as for user doesn't exist) + // An empty string password is allowed, and will be treated as any other password. (To support anonymous access) + + return nil; +} + +/** + * Returns whether or not the user is properly authenticated. +**/ +- (BOOL)isAuthenticated +{ + HTTPLogTrace(); + + // Extract the authentication information from the Authorization header + HTTPAuthenticationRequest *auth = [[HTTPAuthenticationRequest alloc] initWithRequest:request]; + + if ([self useDigestAccessAuthentication]) + { + // Digest Access Authentication (RFC 2617) + + if(![auth isDigest]) + { + // User didn't send proper digest access authentication credentials + return NO; + } + + if ([auth username] == nil) + { + // The client didn't provide a username + // Most likely they didn't provide any authentication at all + return NO; + } + + NSString *password = [self passwordForUser:[auth username]]; + if (password == nil) + { + // No access allowed (username doesn't exist in system) + return NO; + } + + NSString *url = [[request url] relativeString]; + + if (![url isEqualToString:[auth uri]]) + { + // Requested URL and Authorization URI do not match + // This could be a replay attack + // IE - attacker provides same authentication information, but requests a different resource + return NO; + } + + // The nonce the client provided will most commonly be stored in our local (cached) nonce variable + if (![nonce isEqualToString:[auth nonce]]) + { + // The given nonce may be from another connection + // We need to search our list of recent nonce strings that have been recently distributed + if ([[self class] hasRecentNonce:[auth nonce]]) + { + // Store nonce in local (cached) nonce variable to prevent array searches in the future + nonce = [[auth nonce] copy]; + + // The client has switched to using a different nonce value + // This may happen if the client tries to get a file in a directory with different credentials. + // The previous credentials wouldn't work, and the client would receive a 401 error + // along with a new nonce value. The client then uses this new nonce value and requests the file again. + // Whatever the case may be, we need to reset lastNC, since that variable is on a per nonce basis. + lastNC = 0; + } + else + { + // We have no knowledge of ever distributing such a nonce. + // This could be a replay attack from a previous connection in the past. + return NO; + } + } + + long authNC = strtol([[auth nc] UTF8String], NULL, 16); + + if (authNC <= lastNC) + { + // The nc value (nonce count) hasn't been incremented since the last request. + // This could be a replay attack. + return NO; + } + lastNC = authNC; + + NSString *HA1str = [NSString stringWithFormat:@"%@:%@:%@", [auth username], [auth realm], password]; + NSString *HA2str = [NSString stringWithFormat:@"%@:%@", [request method], [auth uri]]; + + NSString *HA1 = [[[HA1str dataUsingEncoding:NSUTF8StringEncoding] md5Digest] hexStringValue]; + + NSString *HA2 = [[[HA2str dataUsingEncoding:NSUTF8StringEncoding] md5Digest] hexStringValue]; + + NSString *responseStr = [NSString stringWithFormat:@"%@:%@:%@:%@:%@:%@", + HA1, [auth nonce], [auth nc], [auth cnonce], [auth qop], HA2]; + + NSString *response = [[[responseStr dataUsingEncoding:NSUTF8StringEncoding] md5Digest] hexStringValue]; + + return [response isEqualToString:[auth response]]; + } + else + { + // Basic Authentication + + if (![auth isBasic]) + { + // User didn't send proper base authentication credentials + return NO; + } + + // Decode the base 64 encoded credentials + NSString *base64Credentials = [auth base64Credentials]; + + NSData *temp = [[base64Credentials dataUsingEncoding:NSUTF8StringEncoding] base64Decoded]; + + NSString *credentials = [[NSString alloc] initWithData:temp encoding:NSUTF8StringEncoding]; + + // The credentials should be of the form "username:password" + // The username is not allowed to contain a colon + + NSRange colonRange = [credentials rangeOfString:@":"]; + + if (colonRange.length == 0) + { + // Malformed credentials + return NO; + } + + NSString *credUsername = [credentials substringToIndex:colonRange.location]; + NSString *credPassword = [credentials substringFromIndex:(colonRange.location + colonRange.length)]; + + NSString *password = [self passwordForUser:credUsername]; + if (password == nil) + { + // No access allowed (username doesn't exist in system) + return NO; + } + + return [password isEqualToString:credPassword]; + } +} + +/** + * Adds a digest access authentication challenge to the given response. +**/ +- (void)addDigestAuthChallenge:(HTTPMessage *)response +{ + HTTPLogTrace(); + + NSString *authFormat = @"Digest realm=\"%@\", qop=\"auth\", nonce=\"%@\""; + NSString *authInfo = [NSString stringWithFormat:authFormat, [self realm], [[self class] generateNonce]]; + + [response setHeaderField:@"WWW-Authenticate" value:authInfo]; +} + +/** + * Adds a basic authentication challenge to the given response. +**/ +- (void)addBasicAuthChallenge:(HTTPMessage *)response +{ + HTTPLogTrace(); + + NSString *authFormat = @"Basic realm=\"%@\""; + NSString *authInfo = [NSString stringWithFormat:authFormat, [self realm]]; + + [response setHeaderField:@"WWW-Authenticate" value:authInfo]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Core +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Starting point for the HTTP connection after it has been fully initialized (including subclasses). + * This method is called by the HTTP server. +**/ +- (void)start +{ + dispatch_async(connectionQueue, ^{ @autoreleasepool { + + if (!started) + { + started = YES; + [self startConnection]; + } + }}); +} + +/** + * This method is called by the HTTPServer if it is asked to stop. + * The server, in turn, invokes stop on each HTTPConnection instance. +**/ +- (void)stop +{ + dispatch_async(connectionQueue, ^{ @autoreleasepool { + + // Disconnect the socket. + // The socketDidDisconnect delegate method will handle everything else. + [asyncSocket disconnect]; + }}); +} + +/** + * Starting point for the HTTP connection. +**/ +- (void)startConnection +{ + // Override me to do any custom work before the connection starts. + // + // Be sure to invoke [super startConnection] when you're done. + + HTTPLogTrace(); + + if ([self isSecureServer]) + { + // We are configured to be an HTTPS server. + // That is, we secure via SSL/TLS the connection prior to any communication. + + NSArray *certificates = [self sslIdentityAndCertificates]; + + if ([certificates count] > 0) + { + // All connections are assumed to be secure. Only secure connections are allowed on this server. + NSMutableDictionary *settings = [NSMutableDictionary dictionaryWithCapacity:3]; + + // Configure this connection as the server + [settings setObject:[NSNumber numberWithBool:YES] + forKey:(NSString *)kCFStreamSSLIsServer]; + + [settings setObject:certificates + forKey:(NSString *)kCFStreamSSLCertificates]; + + // Configure this connection to use the highest possible SSL level + [settings setObject:(NSString *)kCFStreamSocketSecurityLevelNegotiatedSSL + forKey:(NSString *)kCFStreamSSLLevel]; + + [asyncSocket startTLS:settings]; + } + } + + [self startReadingRequest]; +} + +/** + * Starts reading an HTTP request. +**/ +- (void)startReadingRequest +{ + HTTPLogTrace(); + + [asyncSocket readDataToData:[GCDAsyncSocket CRLFData] + withTimeout:TIMEOUT_READ_FIRST_HEADER_LINE + maxLength:MAX_HEADER_LINE_LENGTH + tag:HTTP_REQUEST_HEADER]; +} + +/** + * Parses the given query string. + * + * For example, if the query is "q=John%20Mayer%20Trio&num=50" + * then this method would return the following dictionary: + * { + * q = "John Mayer Trio" + * num = "50" + * } +**/ +- (NSDictionary *)parseParams:(NSString *)query +{ + NSArray *components = [query componentsSeparatedByString:@"&"]; + NSMutableDictionary *result = [NSMutableDictionary dictionaryWithCapacity:[components count]]; + + NSUInteger i; + for (i = 0; i < [components count]; i++) + { + NSString *component = [components objectAtIndex:i]; + if ([component length] > 0) + { + NSRange range = [component rangeOfString:@"="]; + if (range.location != NSNotFound) + { + NSString *escapedKey = [component substringToIndex:(range.location + 0)]; + NSString *escapedValue = [component substringFromIndex:(range.location + 1)]; + + if ([escapedKey length] > 0) + { + CFStringRef k, v; + + k = CFURLCreateStringByReplacingPercentEscapes(NULL, (__bridge CFStringRef)escapedKey, CFSTR("")); + v = CFURLCreateStringByReplacingPercentEscapes(NULL, (__bridge CFStringRef)escapedValue, CFSTR("")); + + NSString *key, *value; + + key = (__bridge_transfer NSString *)k; + value = (__bridge_transfer NSString *)v; + + if (key) + { + if (value) + [result setObject:value forKey:key]; + else + [result setObject:[NSNull null] forKey:key]; + } + } + } + } + } + + return result; +} + +/** + * Parses the query variables in the request URI. + * + * For example, if the request URI was "/search.html?q=John%20Mayer%20Trio&num=50" + * then this method would return the following dictionary: + * { + * q = "John Mayer Trio" + * num = "50" + * } +**/ +- (NSDictionary *)parseGetParams +{ + if(![request isHeaderComplete]) return nil; + + NSDictionary *result = nil; + + NSURL *url = [request url]; + if(url) + { + NSString *query = [url query]; + if (query) + { + result = [self parseParams:query]; + } + } + + return result; +} + +/** + * Attempts to parse the given range header into a series of sequential non-overlapping ranges. + * If successfull, the variables 'ranges' and 'rangeIndex' will be updated, and YES will be returned. + * Otherwise, NO is returned, and the range request should be ignored. + **/ +- (BOOL)parseRangeRequest:(NSString *)rangeHeader withContentLength:(UInt64)contentLength +{ + HTTPLogTrace(); + + // Examples of byte-ranges-specifier values (assuming an entity-body of length 10000): + // + // - The first 500 bytes (byte offsets 0-499, inclusive): bytes=0-499 + // + // - The second 500 bytes (byte offsets 500-999, inclusive): bytes=500-999 + // + // - The final 500 bytes (byte offsets 9500-9999, inclusive): bytes=-500 + // + // - Or bytes=9500- + // + // - The first and last bytes only (bytes 0 and 9999): bytes=0-0,-1 + // + // - Several legal but not canonical specifications of the second 500 bytes (byte offsets 500-999, inclusive): + // bytes=500-600,601-999 + // bytes=500-700,601-999 + // + + NSRange eqsignRange = [rangeHeader rangeOfString:@"="]; + + if(eqsignRange.location == NSNotFound) return NO; + + NSUInteger tIndex = eqsignRange.location; + NSUInteger fIndex = eqsignRange.location + eqsignRange.length; + + NSMutableString *rangeType = [[rangeHeader substringToIndex:tIndex] mutableCopy]; + NSMutableString *rangeValue = [[rangeHeader substringFromIndex:fIndex] mutableCopy]; + + CFStringTrimWhitespace((__bridge CFMutableStringRef)rangeType); + CFStringTrimWhitespace((__bridge CFMutableStringRef)rangeValue); + + if([rangeType caseInsensitiveCompare:@"bytes"] != NSOrderedSame) return NO; + + NSArray *rangeComponents = [rangeValue componentsSeparatedByString:@","]; + + if([rangeComponents count] == 0) return NO; + + ranges = [[NSMutableArray alloc] initWithCapacity:[rangeComponents count]]; + + rangeIndex = 0; + + // Note: We store all range values in the form of DDRange structs, wrapped in NSValue objects. + // Since DDRange consists of UInt64 values, the range extends up to 16 exabytes. + + NSUInteger i; + for (i = 0; i < [rangeComponents count]; i++) + { + NSString *rangeComponent = [rangeComponents objectAtIndex:i]; + + NSRange dashRange = [rangeComponent rangeOfString:@"-"]; + + if (dashRange.location == NSNotFound) + { + // We're dealing with an individual byte number + + UInt64 byteIndex; + if(![NSNumber parseString:rangeComponent intoUInt64:&byteIndex]) return NO; + + if(byteIndex >= contentLength) return NO; + + [ranges addObject:[NSValue valueWithDDRange:DDMakeRange(byteIndex, 1)]]; + } + else + { + // We're dealing with a range of bytes + + tIndex = dashRange.location; + fIndex = dashRange.location + dashRange.length; + + NSString *r1str = [rangeComponent substringToIndex:tIndex]; + NSString *r2str = [rangeComponent substringFromIndex:fIndex]; + + UInt64 r1, r2; + + BOOL hasR1 = [NSNumber parseString:r1str intoUInt64:&r1]; + BOOL hasR2 = [NSNumber parseString:r2str intoUInt64:&r2]; + + if (!hasR1) + { + // We're dealing with a "-[#]" range + // + // r2 is the number of ending bytes to include in the range + + if(!hasR2) return NO; + if(r2 > contentLength) return NO; + + UInt64 startIndex = contentLength - r2; + + [ranges addObject:[NSValue valueWithDDRange:DDMakeRange(startIndex, r2)]]; + } + else if (!hasR2) + { + // We're dealing with a "[#]-" range + // + // r1 is the starting index of the range, which goes all the way to the end + + if(r1 >= contentLength) return NO; + + [ranges addObject:[NSValue valueWithDDRange:DDMakeRange(r1, contentLength - r1)]]; + } + else + { + // We're dealing with a normal "[#]-[#]" range + // + // Note: The range is inclusive. So 0-1 has a length of 2 bytes. + + if(r1 > r2) return NO; + if(r2 >= contentLength) return NO; + + [ranges addObject:[NSValue valueWithDDRange:DDMakeRange(r1, r2 - r1 + 1)]]; + } + } + } + + if([ranges count] == 0) return NO; + + // Now make sure none of the ranges overlap + + for (i = 0; i < [ranges count] - 1; i++) + { + DDRange range1 = [[ranges objectAtIndex:i] ddrangeValue]; + + NSUInteger j; + for (j = i+1; j < [ranges count]; j++) + { + DDRange range2 = [[ranges objectAtIndex:j] ddrangeValue]; + + DDRange iRange = DDIntersectionRange(range1, range2); + + if(iRange.length != 0) + { + return NO; + } + } + } + + // Sort the ranges + + [ranges sortUsingSelector:@selector(ddrangeCompare:)]; + + return YES; +} + +- (NSString *)requestURI +{ + if(request == nil) return nil; + + return [[request url] relativeString]; +} + +/** + * This method is called after a full HTTP request has been received. + * The current request is in the HTTPMessage request variable. +**/ +- (void)replyToHTTPRequest +{ + HTTPLogTrace(); + + if (HTTP_LOG_VERBOSE) + { + NSData *tempData = [request messageData]; + + NSString *tempStr = [[NSString alloc] initWithData:tempData encoding:NSUTF8StringEncoding]; + HTTPLogVerbose(@"%@[%p]: Received HTTP request:\n%@", THIS_FILE, self, tempStr); + } + + // Check the HTTP version + // We only support version 1.0 and 1.1 + + NSString *version = [request version]; + if (![version isEqualToString:HTTPVersion1_1] && ![version isEqualToString:HTTPVersion1_0]) + { + [self handleVersionNotSupported:version]; + return; + } + + // Extract requested URI + NSString *uri = [self requestURI]; + + // Check for WebSocket request + if ([WebSocket isWebSocketRequest:request]) + { + HTTPLogVerbose(@"isWebSocket"); + + WebSocket *ws = [self webSocketForURI:uri]; + + if (ws == nil) + { + [self handleResourceNotFound]; + } + else + { + [ws start]; + + [[config server] addWebSocket:ws]; + + // The WebSocket should now be the delegate of the underlying socket. + // But gracefully handle the situation if it forgot. + if ([asyncSocket delegate] == self) + { + HTTPLogWarn(@"%@[%p]: WebSocket forgot to set itself as socket delegate", THIS_FILE, self); + + // Disconnect the socket. + // The socketDidDisconnect delegate method will handle everything else. + [asyncSocket disconnect]; + } + else + { + // The WebSocket is using the socket, + // so make sure we don't disconnect it in the dealloc method. + asyncSocket = nil; + + [self die]; + + // Note: There is a timing issue here that should be pointed out. + // + // A bug that existed in previous versions happend like so: + // - We invoked [self die] + // - This caused us to get released, and our dealloc method to start executing + // - Meanwhile, AsyncSocket noticed a disconnect, and began to dispatch a socketDidDisconnect at us + // - The dealloc method finishes execution, and our instance gets freed + // - The socketDidDisconnect gets run, and a crash occurs + // + // So the issue we want to avoid is releasing ourself when there is a possibility + // that AsyncSocket might be gearing up to queue a socketDidDisconnect for us. + // + // In this particular situation notice that we invoke [asyncSocket delegate]. + // This method is synchronous concerning AsyncSocket's internal socketQueue. + // Which means we can be sure, when it returns, that AsyncSocket has already + // queued any delegate methods for us if it was going to. + // And if the delegate methods are queued, then we've been properly retained. + // Meaning we won't get released / dealloc'd until the delegate method has finished executing. + // + // In this rare situation, the die method will get invoked twice. + } + } + + return; + } + + // Check Authentication (if needed) + // If not properly authenticated for resource, issue Unauthorized response + if ([self isPasswordProtected:uri] && ![self isAuthenticated]) + { + [self handleAuthenticationFailed]; + return; + } + + // Extract the method + NSString *method = [request method]; + + // Note: We already checked to ensure the method was supported in onSocket:didReadData:withTag: + + // Respond properly to HTTP 'GET' and 'HEAD' commands + httpResponse = [self httpResponseForMethod:method URI:uri]; + + if (httpResponse == nil) + { + [self handleResourceNotFound]; + return; + } + + [self sendResponseHeadersAndBody]; +} + +/** + * Prepares a single-range response. + * + * Note: The returned HTTPMessage is owned by the sender, who is responsible for releasing it. +**/ +- (HTTPMessage *)newUniRangeResponse:(UInt64)contentLength +{ + HTTPLogTrace(); + + // Status Code 206 - Partial Content + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:206 description:nil version:HTTPVersion1_1]; + + DDRange range = [[ranges objectAtIndex:0] ddrangeValue]; + + NSString *contentLengthStr = [NSString stringWithFormat:@"%qu", range.length]; + [response setHeaderField:@"Content-Length" value:contentLengthStr]; + + NSString *rangeStr = [NSString stringWithFormat:@"%qu-%qu", range.location, DDMaxRange(range) - 1]; + NSString *contentRangeStr = [NSString stringWithFormat:@"bytes %@/%qu", rangeStr, contentLength]; + [response setHeaderField:@"Content-Range" value:contentRangeStr]; + + return response; +} + +/** + * Prepares a multi-range response. + * + * Note: The returned HTTPMessage is owned by the sender, who is responsible for releasing it. +**/ +- (HTTPMessage *)newMultiRangeResponse:(UInt64)contentLength +{ + HTTPLogTrace(); + + // Status Code 206 - Partial Content + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:206 description:nil version:HTTPVersion1_1]; + + // We have to send each range using multipart/byteranges + // So each byterange has to be prefix'd and suffix'd with the boundry + // Example: + // + // HTTP/1.1 206 Partial Content + // Content-Length: 220 + // Content-Type: multipart/byteranges; boundary=4554d24e986f76dd6 + // + // + // --4554d24e986f76dd6 + // Content-Range: bytes 0-25/4025 + // + // [...] + // --4554d24e986f76dd6 + // Content-Range: bytes 3975-4024/4025 + // + // [...] + // --4554d24e986f76dd6-- + + ranges_headers = [[NSMutableArray alloc] initWithCapacity:[ranges count]]; + + CFUUIDRef theUUID = CFUUIDCreate(NULL); + ranges_boundry = (__bridge_transfer NSString *)CFUUIDCreateString(NULL, theUUID); + CFRelease(theUUID); + + NSString *startingBoundryStr = [NSString stringWithFormat:@"\r\n--%@\r\n", ranges_boundry]; + NSString *endingBoundryStr = [NSString stringWithFormat:@"\r\n--%@--\r\n", ranges_boundry]; + + UInt64 actualContentLength = 0; + + NSUInteger i; + for (i = 0; i < [ranges count]; i++) + { + DDRange range = [[ranges objectAtIndex:i] ddrangeValue]; + + NSString *rangeStr = [NSString stringWithFormat:@"%qu-%qu", range.location, DDMaxRange(range) - 1]; + NSString *contentRangeVal = [NSString stringWithFormat:@"bytes %@/%qu", rangeStr, contentLength]; + NSString *contentRangeStr = [NSString stringWithFormat:@"Content-Range: %@\r\n\r\n", contentRangeVal]; + + NSString *fullHeader = [startingBoundryStr stringByAppendingString:contentRangeStr]; + NSData *fullHeaderData = [fullHeader dataUsingEncoding:NSUTF8StringEncoding]; + + [ranges_headers addObject:fullHeaderData]; + + actualContentLength += [fullHeaderData length]; + actualContentLength += range.length; + } + + NSData *endingBoundryData = [endingBoundryStr dataUsingEncoding:NSUTF8StringEncoding]; + + actualContentLength += [endingBoundryData length]; + + NSString *contentLengthStr = [NSString stringWithFormat:@"%qu", actualContentLength]; + [response setHeaderField:@"Content-Length" value:contentLengthStr]; + + NSString *contentTypeStr = [NSString stringWithFormat:@"multipart/byteranges; boundary=%@", ranges_boundry]; + [response setHeaderField:@"Content-Type" value:contentTypeStr]; + + return response; +} + +/** + * Returns the chunk size line that must precede each chunk of data when using chunked transfer encoding. + * This consists of the size of the data, in hexadecimal, followed by a CRLF. +**/ +- (NSData *)chunkedTransferSizeLineForLength:(NSUInteger)length +{ + return [[NSString stringWithFormat:@"%lx\r\n", (unsigned long)length] dataUsingEncoding:NSUTF8StringEncoding]; +} + +/** + * Returns the data that signals the end of a chunked transfer. +**/ +- (NSData *)chunkedTransferFooter +{ + // Each data chunk is preceded by a size line (in hex and including a CRLF), + // followed by the data itself, followed by another CRLF. + // After every data chunk has been sent, a zero size line is sent, + // followed by optional footer (which are just more headers), + // and followed by a CRLF on a line by itself. + + return [@"\r\n0\r\n\r\n" dataUsingEncoding:NSUTF8StringEncoding]; +} + +- (void)sendResponseHeadersAndBody +{ + if ([httpResponse respondsToSelector:@selector(delayResponseHeaders)]) + { + if ([httpResponse delayResponseHeaders]) + { + return; + } + } + + BOOL isChunked = NO; + + if ([httpResponse respondsToSelector:@selector(isChunked)]) + { + isChunked = [httpResponse isChunked]; + } + + // If a response is "chunked", this simply means the HTTPResponse object + // doesn't know the content-length in advance. + + UInt64 contentLength = 0; + + if (!isChunked) + { + contentLength = [httpResponse contentLength]; + } + + // Check for specific range request + NSString *rangeHeader = [request headerField:@"Range"]; + + BOOL isRangeRequest = NO; + + // If the response is "chunked" then we don't know the exact content-length. + // This means we'll be unable to process any range requests. + // This is because range requests might include a range like "give me the last 100 bytes" + + if (!isChunked && rangeHeader) + { + if ([self parseRangeRequest:rangeHeader withContentLength:contentLength]) + { + isRangeRequest = YES; + } + } + + HTTPMessage *response; + + if (!isRangeRequest) + { + // Create response + // Default status code: 200 - OK + NSInteger status = 200; + + if ([httpResponse respondsToSelector:@selector(status)]) + { + status = [httpResponse status]; + } + response = [[HTTPMessage alloc] initResponseWithStatusCode:status description:nil version:HTTPVersion1_1]; + + if (isChunked) + { + [response setHeaderField:@"Transfer-Encoding" value:@"chunked"]; + } + else + { + NSString *contentLengthStr = [NSString stringWithFormat:@"%qu", contentLength]; + [response setHeaderField:@"Content-Length" value:contentLengthStr]; + } + } + else + { + if ([ranges count] == 1) + { + response = [self newUniRangeResponse:contentLength]; + } + else + { + response = [self newMultiRangeResponse:contentLength]; + } + } + + BOOL isZeroLengthResponse = !isChunked && (contentLength == 0); + + // If they issue a 'HEAD' command, we don't have to include the file + // If they issue a 'GET' command, we need to include the file + + if ([[request method] isEqualToString:@"HEAD"] || isZeroLengthResponse) + { + NSData *responseData = [self preprocessResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_RESPONSE]; + + sentResponseHeaders = YES; + } + else + { + // Write the header response + NSData *responseData = [self preprocessResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_PARTIAL_RESPONSE_HEADER]; + + sentResponseHeaders = YES; + + // Now we need to send the body of the response + if (!isRangeRequest) + { + // Regular request + NSData *data = [httpResponse readDataOfLength:READ_CHUNKSIZE]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + if (isChunked) + { + NSData *chunkSize = [self chunkedTransferSizeLineForLength:[data length]]; + [asyncSocket writeData:chunkSize withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_CHUNKED_RESPONSE_HEADER]; + + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:HTTP_CHUNKED_RESPONSE_BODY]; + + if ([httpResponse isDone]) + { + NSData *footer = [self chunkedTransferFooter]; + [asyncSocket writeData:footer withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_RESPONSE]; + } + else + { + NSData *footer = [GCDAsyncSocket CRLFData]; + [asyncSocket writeData:footer withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_CHUNKED_RESPONSE_FOOTER]; + } + } + else + { + long tag = [httpResponse isDone] ? HTTP_RESPONSE : HTTP_PARTIAL_RESPONSE_BODY; + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:tag]; + } + } + } + else + { + // Client specified a byte range in request + + if ([ranges count] == 1) + { + // Client is requesting a single range + DDRange range = [[ranges objectAtIndex:0] ddrangeValue]; + + [httpResponse setOffset:range.location]; + + NSUInteger bytesToRead = range.length < READ_CHUNKSIZE ? (NSUInteger)range.length : READ_CHUNKSIZE; + + NSData *data = [httpResponse readDataOfLength:bytesToRead]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + long tag = [data length] == range.length ? HTTP_RESPONSE : HTTP_PARTIAL_RANGE_RESPONSE_BODY; + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:tag]; + } + } + else + { + // Client is requesting multiple ranges + // We have to send each range using multipart/byteranges + + // Write range header + NSData *rangeHeaderData = [ranges_headers objectAtIndex:0]; + [asyncSocket writeData:rangeHeaderData withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_PARTIAL_RESPONSE_HEADER]; + + // Start writing range body + DDRange range = [[ranges objectAtIndex:0] ddrangeValue]; + + [httpResponse setOffset:range.location]; + + NSUInteger bytesToRead = range.length < READ_CHUNKSIZE ? (NSUInteger)range.length : READ_CHUNKSIZE; + + NSData *data = [httpResponse readDataOfLength:bytesToRead]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:HTTP_PARTIAL_RANGES_RESPONSE_BODY]; + } + } + } + } + +} + +/** + * Returns the number of bytes of the http response body that are sitting in asyncSocket's write queue. + * + * We keep track of this information in order to keep our memory footprint low while + * working with asynchronous HTTPResponse objects. +**/ +- (NSUInteger)writeQueueSize +{ + NSUInteger result = 0; + + NSUInteger i; + for(i = 0; i < [responseDataSizes count]; i++) + { + result += [[responseDataSizes objectAtIndex:i] unsignedIntegerValue]; + } + + return result; +} + +/** + * Sends more data, if needed, without growing the write queue over its approximate size limit. + * The last chunk of the response body will be sent with a tag of HTTP_RESPONSE. + * + * This method should only be called for standard (non-range) responses. +**/ +- (void)continueSendingStandardResponseBody +{ + HTTPLogTrace(); + + // This method is called when either asyncSocket has finished writing one of the response data chunks, + // or when an asynchronous HTTPResponse object informs us that it has more available data for us to send. + // In the case of the asynchronous HTTPResponse, we don't want to blindly grab the new data, + // and shove it onto asyncSocket's write queue. + // Doing so could negatively affect the memory footprint of the application. + // Instead, we always ensure that we place no more than READ_CHUNKSIZE bytes onto the write queue. + // + // Note that this does not affect the rate at which the HTTPResponse object may generate data. + // The HTTPResponse is free to do as it pleases, and this is up to the application's developer. + // If the memory footprint is a concern, the developer creating the custom HTTPResponse object may freely + // use the calls to readDataOfLength as an indication to start generating more data. + // This provides an easy way for the HTTPResponse object to throttle its data allocation in step with the rate + // at which the socket is able to send it. + + NSUInteger writeQueueSize = [self writeQueueSize]; + + if(writeQueueSize >= READ_CHUNKSIZE) return; + + NSUInteger available = READ_CHUNKSIZE - writeQueueSize; + NSData *data = [httpResponse readDataOfLength:available]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + BOOL isChunked = NO; + + if ([httpResponse respondsToSelector:@selector(isChunked)]) + { + isChunked = [httpResponse isChunked]; + } + + if (isChunked) + { + NSData *chunkSize = [self chunkedTransferSizeLineForLength:[data length]]; + [asyncSocket writeData:chunkSize withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_CHUNKED_RESPONSE_HEADER]; + + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:HTTP_CHUNKED_RESPONSE_BODY]; + + if([httpResponse isDone]) + { + NSData *footer = [self chunkedTransferFooter]; + [asyncSocket writeData:footer withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_RESPONSE]; + } + else + { + NSData *footer = [GCDAsyncSocket CRLFData]; + [asyncSocket writeData:footer withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_CHUNKED_RESPONSE_FOOTER]; + } + } + else + { + long tag = [httpResponse isDone] ? HTTP_RESPONSE : HTTP_PARTIAL_RESPONSE_BODY; + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:tag]; + } + } +} + +/** + * Sends more data, if needed, without growing the write queue over its approximate size limit. + * The last chunk of the response body will be sent with a tag of HTTP_RESPONSE. + * + * This method should only be called for single-range responses. +**/ +- (void)continueSendingSingleRangeResponseBody +{ + HTTPLogTrace(); + + // This method is called when either asyncSocket has finished writing one of the response data chunks, + // or when an asynchronous response informs us that is has more available data for us to send. + // In the case of the asynchronous response, we don't want to blindly grab the new data, + // and shove it onto asyncSocket's write queue. + // Doing so could negatively affect the memory footprint of the application. + // Instead, we always ensure that we place no more than READ_CHUNKSIZE bytes onto the write queue. + // + // Note that this does not affect the rate at which the HTTPResponse object may generate data. + // The HTTPResponse is free to do as it pleases, and this is up to the application's developer. + // If the memory footprint is a concern, the developer creating the custom HTTPResponse object may freely + // use the calls to readDataOfLength as an indication to start generating more data. + // This provides an easy way for the HTTPResponse object to throttle its data allocation in step with the rate + // at which the socket is able to send it. + + NSUInteger writeQueueSize = [self writeQueueSize]; + + if(writeQueueSize >= READ_CHUNKSIZE) return; + + DDRange range = [[ranges objectAtIndex:0] ddrangeValue]; + + UInt64 offset = [httpResponse offset]; + UInt64 bytesRead = offset - range.location; + UInt64 bytesLeft = range.length - bytesRead; + + if (bytesLeft > 0) + { + NSUInteger available = READ_CHUNKSIZE - writeQueueSize; + NSUInteger bytesToRead = bytesLeft < available ? (NSUInteger)bytesLeft : available; + + NSData *data = [httpResponse readDataOfLength:bytesToRead]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + long tag = [data length] == bytesLeft ? HTTP_RESPONSE : HTTP_PARTIAL_RANGE_RESPONSE_BODY; + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:tag]; + } + } +} + +/** + * Sends more data, if needed, without growing the write queue over its approximate size limit. + * The last chunk of the response body will be sent with a tag of HTTP_RESPONSE. + * + * This method should only be called for multi-range responses. +**/ +- (void)continueSendingMultiRangeResponseBody +{ + HTTPLogTrace(); + + // This method is called when either asyncSocket has finished writing one of the response data chunks, + // or when an asynchronous HTTPResponse object informs us that is has more available data for us to send. + // In the case of the asynchronous HTTPResponse, we don't want to blindly grab the new data, + // and shove it onto asyncSocket's write queue. + // Doing so could negatively affect the memory footprint of the application. + // Instead, we always ensure that we place no more than READ_CHUNKSIZE bytes onto the write queue. + // + // Note that this does not affect the rate at which the HTTPResponse object may generate data. + // The HTTPResponse is free to do as it pleases, and this is up to the application's developer. + // If the memory footprint is a concern, the developer creating the custom HTTPResponse object may freely + // use the calls to readDataOfLength as an indication to start generating more data. + // This provides an easy way for the HTTPResponse object to throttle its data allocation in step with the rate + // at which the socket is able to send it. + + NSUInteger writeQueueSize = [self writeQueueSize]; + + if(writeQueueSize >= READ_CHUNKSIZE) return; + + DDRange range = [[ranges objectAtIndex:rangeIndex] ddrangeValue]; + + UInt64 offset = [httpResponse offset]; + UInt64 bytesRead = offset - range.location; + UInt64 bytesLeft = range.length - bytesRead; + + if (bytesLeft > 0) + { + NSUInteger available = READ_CHUNKSIZE - writeQueueSize; + NSUInteger bytesToRead = bytesLeft < available ? (NSUInteger)bytesLeft : available; + + NSData *data = [httpResponse readDataOfLength:bytesToRead]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:HTTP_PARTIAL_RANGES_RESPONSE_BODY]; + } + } + else + { + if (++rangeIndex < [ranges count]) + { + // Write range header + NSData *rangeHeader = [ranges_headers objectAtIndex:rangeIndex]; + [asyncSocket writeData:rangeHeader withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_PARTIAL_RESPONSE_HEADER]; + + // Start writing range body + range = [[ranges objectAtIndex:rangeIndex] ddrangeValue]; + + [httpResponse setOffset:range.location]; + + NSUInteger available = READ_CHUNKSIZE - writeQueueSize; + NSUInteger bytesToRead = range.length < available ? (NSUInteger)range.length : available; + + NSData *data = [httpResponse readDataOfLength:bytesToRead]; + + if ([data length] > 0) + { + [responseDataSizes addObject:[NSNumber numberWithUnsignedInteger:[data length]]]; + + [asyncSocket writeData:data withTimeout:TIMEOUT_WRITE_BODY tag:HTTP_PARTIAL_RANGES_RESPONSE_BODY]; + } + } + else + { + // We're not done yet - we still have to send the closing boundry tag + NSString *endingBoundryStr = [NSString stringWithFormat:@"\r\n--%@--\r\n", ranges_boundry]; + NSData *endingBoundryData = [endingBoundryStr dataUsingEncoding:NSUTF8StringEncoding]; + + [asyncSocket writeData:endingBoundryData withTimeout:TIMEOUT_WRITE_HEAD tag:HTTP_RESPONSE]; + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Responses +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns an array of possible index pages. + * For example: {"index.html", "index.htm"} +**/ +- (NSArray *)directoryIndexFileNames +{ + HTTPLogTrace(); + + // Override me to support other index pages. + + return [NSArray arrayWithObjects:@"index.html", @"index.htm", nil]; +} + +- (NSString *)filePathForURI:(NSString *)path +{ + return [self filePathForURI:path allowDirectory:NO]; +} + +/** + * Converts relative URI path into full file-system path. +**/ +- (NSString *)filePathForURI:(NSString *)path allowDirectory:(BOOL)allowDirectory +{ + HTTPLogTrace(); + + // Override me to perform custom path mapping. + // For example you may want to use a default file other than index.html, or perhaps support multiple types. + + NSString *documentRoot = [config documentRoot]; + + // Part 0: Validate document root setting. + // + // If there is no configured documentRoot, + // then it makes no sense to try to return anything. + + if (documentRoot == nil) + { + HTTPLogWarn(@"%@[%p]: No configured document root", THIS_FILE, self); + return nil; + } + + // Part 1: Strip parameters from the url + // + // E.g.: /page.html?q=22&var=abc -> /page.html + + NSURL *docRoot = [NSURL fileURLWithPath:documentRoot isDirectory:YES]; + if (docRoot == nil) + { + HTTPLogWarn(@"%@[%p]: Document root is invalid file path", THIS_FILE, self); + return nil; + } + + NSString *relativePath = [[NSURL URLWithString:path relativeToURL:docRoot] relativePath]; + + // Part 2: Append relative path to document root (base path) + // + // E.g.: relativePath="/images/icon.png" + // documentRoot="/Users/robbie/Sites" + // fullPath="/Users/robbie/Sites/images/icon.png" + // + // We also standardize the path. + // + // E.g.: "Users/robbie/Sites/images/../index.html" -> "/Users/robbie/Sites/index.html" + + NSString *fullPath = [[documentRoot stringByAppendingPathComponent:relativePath] stringByStandardizingPath]; + + if ([relativePath isEqualToString:@"/"]) + { + fullPath = [fullPath stringByAppendingString:@"/"]; + } + + // Part 3: Prevent serving files outside the document root. + // + // Sneaky requests may include ".." in the path. + // + // E.g.: relativePath="../Documents/TopSecret.doc" + // documentRoot="/Users/robbie/Sites" + // fullPath="/Users/robbie/Documents/TopSecret.doc" + // + // E.g.: relativePath="../Sites_Secret/TopSecret.doc" + // documentRoot="/Users/robbie/Sites" + // fullPath="/Users/robbie/Sites_Secret/TopSecret" + + if (![documentRoot hasSuffix:@"/"]) + { + documentRoot = [documentRoot stringByAppendingString:@"/"]; + } + + if (![fullPath hasPrefix:documentRoot]) + { + HTTPLogWarn(@"%@[%p]: Request for file outside document root", THIS_FILE, self); + return nil; + } + + // Part 4: Search for index page if path is pointing to a directory + if (!allowDirectory) + { + BOOL isDir = NO; + if ([[NSFileManager defaultManager] fileExistsAtPath:fullPath isDirectory:&isDir] && isDir) + { + NSArray *indexFileNames = [self directoryIndexFileNames]; + + for (NSString *indexFileName in indexFileNames) + { + NSString *indexFilePath = [fullPath stringByAppendingPathComponent:indexFileName]; + + if ([[NSFileManager defaultManager] fileExistsAtPath:indexFilePath isDirectory:&isDir] && !isDir) + { + return indexFilePath; + } + } + + // No matching index files found in directory + return nil; + } + } + + return fullPath; +} + +/** + * This method is called to get a response for a request. + * You may return any object that adopts the HTTPResponse protocol. + * The HTTPServer comes with two such classes: HTTPFileResponse and HTTPDataResponse. + * HTTPFileResponse is a wrapper for an NSFileHandle object, and is the preferred way to send a file response. + * HTTPDataResponse is a wrapper for an NSData object, and may be used to send a custom response. +**/ +- (NSObject *)httpResponseForMethod:(NSString *)method URI:(NSString *)path +{ + HTTPLogTrace(); + + // Override me to provide custom responses. + + NSString *filePath = [self filePathForURI:path allowDirectory:NO]; + + BOOL isDir = NO; + + if (filePath && [[NSFileManager defaultManager] fileExistsAtPath:filePath isDirectory:&isDir] && !isDir) + { + return [[HTTPFileResponse alloc] initWithFilePath:filePath forConnection:self]; + + // Use me instead for asynchronous file IO. + // Generally better for larger files. + + // return [[[HTTPAsyncFileResponse alloc] initWithFilePath:filePath forConnection:self] autorelease]; + } + + return nil; +} + +- (WebSocket *)webSocketForURI:(NSString *)path +{ + HTTPLogTrace(); + + // Override me to provide custom WebSocket responses. + // To do so, simply override the base WebSocket implementation, and add your custom functionality. + // Then return an instance of your custom WebSocket here. + // + // For example: + // + // if ([path isEqualToString:@"/myAwesomeWebSocketStream"]) + // { + // return [[[MyWebSocket alloc] initWithRequest:request socket:asyncSocket] autorelease]; + // } + // + // return [super webSocketForURI:path]; + + return nil; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Uploads +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method is called after receiving all HTTP headers, but before reading any of the request body. +**/ +- (void)prepareForBodyWithSize:(UInt64)contentLength +{ + // Override me to allocate buffers, file handles, etc. +} + +/** + * This method is called to handle data read from a POST / PUT. + * The given data is part of the request body. +**/ +- (void)processBodyData:(NSData *)postDataChunk +{ + // Override me to do something useful with a POST / PUT. + // If the post is small, such as a simple form, you may want to simply append the data to the request. + // If the post is big, such as a file upload, you may want to store the file to disk. + // + // Remember: In order to support LARGE POST uploads, the data is read in chunks. + // This prevents a 50 MB upload from being stored in RAM. + // The size of the chunks are limited by the POST_CHUNKSIZE definition. + // Therefore, this method may be called multiple times for the same POST request. +} + +/** + * This method is called after the request body has been fully read but before the HTTP request is processed. +**/ +- (void)finishBody +{ + // Override me to perform any final operations on an upload. + // For example, if you were saving the upload to disk this would be + // the hook to flush any pending data to disk and maybe close the file. +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Errors +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Called if the HTML version is other than what is supported +**/ +- (void)handleVersionNotSupported:(NSString *)version +{ + // Override me for custom error handling of unsupported http version responses + // If you simply want to add a few extra header fields, see the preprocessErrorResponse: method. + // You can also use preprocessErrorResponse: to add an optional HTML body. + + HTTPLogWarn(@"HTTP Server: Error 505 - Version Not Supported: %@ (%@)", version, [self requestURI]); + + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:505 description:nil version:HTTPVersion1_1]; + [response setHeaderField:@"Content-Length" value:@"0"]; + + NSData *responseData = [self preprocessErrorResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_ERROR tag:HTTP_RESPONSE]; + +} + +/** + * Called if the authentication information was required and absent, or if authentication failed. +**/ +- (void)handleAuthenticationFailed +{ + // Override me for custom handling of authentication challenges + // If you simply want to add a few extra header fields, see the preprocessErrorResponse: method. + // You can also use preprocessErrorResponse: to add an optional HTML body. + + HTTPLogInfo(@"HTTP Server: Error 401 - Unauthorized (%@)", [self requestURI]); + + // Status Code 401 - Unauthorized + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:401 description:nil version:HTTPVersion1_1]; + [response setHeaderField:@"Content-Length" value:@"0"]; + + if ([self useDigestAccessAuthentication]) + { + [self addDigestAuthChallenge:response]; + } + else + { + [self addBasicAuthChallenge:response]; + } + + NSData *responseData = [self preprocessErrorResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_ERROR tag:HTTP_RESPONSE]; + +} + +/** + * Called if we receive some sort of malformed HTTP request. + * The data parameter is the invalid HTTP header line, including CRLF, as read from GCDAsyncSocket. + * The data parameter may also be nil if the request as a whole was invalid, such as a POST with no Content-Length. +**/ +- (void)handleInvalidRequest:(NSData *)data +{ + // Override me for custom error handling of invalid HTTP requests + // If you simply want to add a few extra header fields, see the preprocessErrorResponse: method. + // You can also use preprocessErrorResponse: to add an optional HTML body. + + HTTPLogWarn(@"HTTP Server: Error 400 - Bad Request (%@)", [self requestURI]); + + // Status Code 400 - Bad Request + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:400 description:nil version:HTTPVersion1_1]; + [response setHeaderField:@"Content-Length" value:@"0"]; + [response setHeaderField:@"Connection" value:@"close"]; + + NSData *responseData = [self preprocessErrorResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_ERROR tag:HTTP_FINAL_RESPONSE]; + + + // Note: We used the HTTP_FINAL_RESPONSE tag to disconnect after the response is sent. + // We do this because we couldn't parse the request, + // so we won't be able to recover and move on to another request afterwards. + // In other words, we wouldn't know where the first request ends and the second request begins. +} + +/** + * Called if we receive a HTTP request with a method other than GET or HEAD. +**/ +- (void)handleUnknownMethod:(NSString *)method +{ + // Override me for custom error handling of 405 method not allowed responses. + // If you simply want to add a few extra header fields, see the preprocessErrorResponse: method. + // You can also use preprocessErrorResponse: to add an optional HTML body. + // + // See also: supportsMethod:atPath: + + HTTPLogWarn(@"HTTP Server: Error 405 - Method Not Allowed: %@ (%@)", method, [self requestURI]); + + // Status code 405 - Method Not Allowed + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:405 description:nil version:HTTPVersion1_1]; + [response setHeaderField:@"Content-Length" value:@"0"]; + [response setHeaderField:@"Connection" value:@"close"]; + + NSData *responseData = [self preprocessErrorResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_ERROR tag:HTTP_FINAL_RESPONSE]; + + + // Note: We used the HTTP_FINAL_RESPONSE tag to disconnect after the response is sent. + // We do this because the method may include an http body. + // Since we can't be sure, we should close the connection. +} + +/** + * Called if we're unable to find the requested resource. +**/ +- (void)handleResourceNotFound +{ + // Override me for custom error handling of 404 not found responses + // If you simply want to add a few extra header fields, see the preprocessErrorResponse: method. + // You can also use preprocessErrorResponse: to add an optional HTML body. + + HTTPLogInfo(@"HTTP Server: Error 404 - Not Found (%@)", [self requestURI]); + + // Status Code 404 - Not Found + HTTPMessage *response = [[HTTPMessage alloc] initResponseWithStatusCode:404 description:nil version:HTTPVersion1_1]; + [response setHeaderField:@"Content-Length" value:@"0"]; + + NSData *responseData = [self preprocessErrorResponse:response]; + [asyncSocket writeData:responseData withTimeout:TIMEOUT_WRITE_ERROR tag:HTTP_RESPONSE]; + +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Headers +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Gets the current date and time, formatted properly (according to RFC) for insertion into an HTTP header. +**/ +- (NSString *)dateAsString:(NSDate *)date +{ + // From Apple's Documentation (Data Formatting Guide -> Date Formatters -> Cache Formatters for Efficiency): + // + // "Creating a date formatter is not a cheap operation. If you are likely to use a formatter frequently, + // it is typically more efficient to cache a single instance than to create and dispose of multiple instances. + // One approach is to use a static variable." + // + // This was discovered to be true in massive form via issue #46: + // + // "Was doing some performance benchmarking using instruments and httperf. Using this single optimization + // I got a 26% speed improvement - from 1000req/sec to 3800req/sec. Not insignificant. + // The culprit? Why, NSDateFormatter, of course!" + // + // Thus, we are using a static NSDateFormatter here. + + static NSDateFormatter *df; + + static dispatch_once_t onceToken; + dispatch_once(&onceToken, ^{ + + // Example: Sun, 06 Nov 1994 08:49:37 GMT + + df = [[NSDateFormatter alloc] init]; + [df setFormatterBehavior:NSDateFormatterBehavior10_4]; + [df setTimeZone:[NSTimeZone timeZoneWithAbbreviation:@"GMT"]]; + [df setDateFormat:@"EEE, dd MMM y HH:mm:ss 'GMT'"]; + [df setLocale:[[NSLocale alloc] initWithLocaleIdentifier:@"en_US"]]; + + // For some reason, using zzz in the format string produces GMT+00:00 + }); + + return [df stringFromDate:date]; +} + +/** + * This method is called immediately prior to sending the response headers. + * This method adds standard header fields, and then converts the response to an NSData object. +**/ +- (NSData *)preprocessResponse:(HTTPMessage *)response +{ + HTTPLogTrace(); + + // Override me to customize the response headers + // You'll likely want to add your own custom headers, and then return [super preprocessResponse:response] + + // Add standard headers + NSString *now = [self dateAsString:[NSDate date]]; + [response setHeaderField:@"Date" value:now]; + + // Add server capability headers + [response setHeaderField:@"Accept-Ranges" value:@"bytes"]; + + // Add optional response headers + if ([httpResponse respondsToSelector:@selector(httpHeaders)]) + { + NSDictionary *responseHeaders = [httpResponse httpHeaders]; + + NSEnumerator *keyEnumerator = [responseHeaders keyEnumerator]; + NSString *key; + + while ((key = [keyEnumerator nextObject])) + { + NSString *value = [responseHeaders objectForKey:key]; + + [response setHeaderField:key value:value]; + } + } + + return [response messageData]; +} + +/** + * This method is called immediately prior to sending the response headers (for an error). + * This method adds standard header fields, and then converts the response to an NSData object. +**/ +- (NSData *)preprocessErrorResponse:(HTTPMessage *)response +{ + HTTPLogTrace(); + + // Override me to customize the error response headers + // You'll likely want to add your own custom headers, and then return [super preprocessErrorResponse:response] + // + // Notes: + // You can use [response statusCode] to get the type of error. + // You can use [response setBody:data] to add an optional HTML body. + // If you add a body, don't forget to update the Content-Length. + // + // if ([response statusCode] == 404) + // { + // NSString *msg = @"Error 404 - Not Found"; + // NSData *msgData = [msg dataUsingEncoding:NSUTF8StringEncoding]; + // + // [response setBody:msgData]; + // + // NSString *contentLengthStr = [NSString stringWithFormat:@"%lu", (unsigned long)[msgData length]]; + // [response setHeaderField:@"Content-Length" value:contentLengthStr]; + // } + + // Add standard headers + NSString *now = [self dateAsString:[NSDate date]]; + [response setHeaderField:@"Date" value:now]; + + // Add server capability headers + [response setHeaderField:@"Accept-Ranges" value:@"bytes"]; + + // Add optional response headers + if ([httpResponse respondsToSelector:@selector(httpHeaders)]) + { + NSDictionary *responseHeaders = [httpResponse httpHeaders]; + + NSEnumerator *keyEnumerator = [responseHeaders keyEnumerator]; + NSString *key; + + while((key = [keyEnumerator nextObject])) + { + NSString *value = [responseHeaders objectForKey:key]; + + [response setHeaderField:key value:value]; + } + } + + return [response messageData]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark GCDAsyncSocket Delegate +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method is called after the socket has successfully read data from the stream. + * Remember that this method will only be called after the socket reaches a CRLF, or after it's read the proper length. +**/ +- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData*)data withTag:(long)tag +{ + if (tag == HTTP_REQUEST_HEADER) + { + // Append the header line to the http message + BOOL result = [request appendData:data]; + if (!result) + { + HTTPLogWarn(@"%@[%p]: Malformed request", THIS_FILE, self); + + [self handleInvalidRequest:data]; + } + else if (![request isHeaderComplete]) + { + // We don't have a complete header yet + // That is, we haven't yet received a CRLF on a line by itself, indicating the end of the header + if (++numHeaderLines > MAX_HEADER_LINES) + { + // Reached the maximum amount of header lines in a single HTTP request + // This could be an attempted DOS attack + [asyncSocket disconnect]; + + // Explictly return to ensure we don't do anything after the socket disconnect + return; + } + else + { + [asyncSocket readDataToData:[GCDAsyncSocket CRLFData] + withTimeout:TIMEOUT_READ_SUBSEQUENT_HEADER_LINE + maxLength:MAX_HEADER_LINE_LENGTH + tag:HTTP_REQUEST_HEADER]; + } + } + else + { + // We have an entire HTTP request header from the client + + // Extract the method (such as GET, HEAD, POST, etc) + NSString *method = [request method]; + + // Extract the uri (such as "/index.html") + NSString *uri = [self requestURI]; + + // Check for a Transfer-Encoding field + NSString *transferEncoding = [request headerField:@"Transfer-Encoding"]; + + // Check for a Content-Length field + NSString *contentLength = [request headerField:@"Content-Length"]; + + // Content-Length MUST be present for upload methods (such as POST or PUT) + // and MUST NOT be present for other methods. + BOOL expectsUpload = [self expectsRequestBodyFromMethod:method atPath:uri]; + + if (expectsUpload) + { + if (transferEncoding && ![transferEncoding caseInsensitiveCompare:@"Chunked"]) + { + requestContentLength = -1; + } + else + { + if (contentLength == nil) + { + HTTPLogWarn(@"%@[%p]: Method expects request body, but had no specified Content-Length", + THIS_FILE, self); + + [self handleInvalidRequest:nil]; + return; + } + + if (![NSNumber parseString:(NSString *)contentLength intoUInt64:&requestContentLength]) + { + HTTPLogWarn(@"%@[%p]: Unable to parse Content-Length header into a valid number", + THIS_FILE, self); + + [self handleInvalidRequest:nil]; + return; + } + } + } + else + { + if (contentLength != nil) + { + // Received Content-Length header for method not expecting an upload. + // This better be zero... + + if (![NSNumber parseString:(NSString *)contentLength intoUInt64:&requestContentLength]) + { + HTTPLogWarn(@"%@[%p]: Unable to parse Content-Length header into a valid number", + THIS_FILE, self); + + [self handleInvalidRequest:nil]; + return; + } + + if (requestContentLength > 0) + { + HTTPLogWarn(@"%@[%p]: Method not expecting request body had non-zero Content-Length", + THIS_FILE, self); + + [self handleInvalidRequest:nil]; + return; + } + } + + requestContentLength = 0; + requestContentLengthReceived = 0; + } + + // Check to make sure the given method is supported + if (![self supportsMethod:method atPath:uri]) + { + // The method is unsupported - either in general, or for this specific request + // Send a 405 - Method not allowed response + [self handleUnknownMethod:method]; + return; + } + + if (expectsUpload) + { + // Reset the total amount of data received for the upload + requestContentLengthReceived = 0; + + // Prepare for the upload + [self prepareForBodyWithSize:requestContentLength]; + + if (requestContentLength > 0) + { + // Start reading the request body + if (requestContentLength == -1) + { + // Chunked transfer + + [asyncSocket readDataToData:[GCDAsyncSocket CRLFData] + withTimeout:TIMEOUT_READ_BODY + maxLength:MAX_CHUNK_LINE_LENGTH + tag:HTTP_REQUEST_CHUNK_SIZE]; + } + else + { + NSUInteger bytesToRead; + if (requestContentLength < POST_CHUNKSIZE) + bytesToRead = (NSUInteger)requestContentLength; + else + bytesToRead = POST_CHUNKSIZE; + + [asyncSocket readDataToLength:bytesToRead + withTimeout:TIMEOUT_READ_BODY + tag:HTTP_REQUEST_BODY]; + } + } + else + { + // Empty upload + [self finishBody]; + [self replyToHTTPRequest]; + } + } + else + { + // Now we need to reply to the request + [self replyToHTTPRequest]; + } + } + } + else + { + BOOL doneReadingRequest = NO; + + // A chunked message body contains a series of chunks, + // followed by a line with "0" (zero), + // followed by optional footers (just like headers), + // and a blank line. + // + // Each chunk consists of two parts: + // + // 1. A line with the size of the chunk data, in hex, + // possibly followed by a semicolon and extra parameters you can ignore (none are currently standard), + // and ending with CRLF. + // 2. The data itself, followed by CRLF. + // + // Part 1 is represented by HTTP_REQUEST_CHUNK_SIZE + // Part 2 is represented by HTTP_REQUEST_CHUNK_DATA and HTTP_REQUEST_CHUNK_TRAILER + // where the trailer is the CRLF that follows the data. + // + // The optional footers and blank line are represented by HTTP_REQUEST_CHUNK_FOOTER. + + if (tag == HTTP_REQUEST_CHUNK_SIZE) + { + // We have just read in a line with the size of the chunk data, in hex, + // possibly followed by a semicolon and extra parameters that can be ignored, + // and ending with CRLF. + + NSString *sizeLine = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]; + + errno = 0; // Reset errno before calling strtoull() to ensure it is always zero on success + requestChunkSize = (UInt64)strtoull([sizeLine UTF8String], NULL, 16); + requestChunkSizeReceived = 0; + + if (errno != 0) + { + HTTPLogWarn(@"%@[%p]: Method expects chunk size, but received something else", THIS_FILE, self); + + [self handleInvalidRequest:nil]; + return; + } + + if (requestChunkSize > 0) + { + NSUInteger bytesToRead; + bytesToRead = (requestChunkSize < POST_CHUNKSIZE) ? (NSUInteger)requestChunkSize : POST_CHUNKSIZE; + + [asyncSocket readDataToLength:bytesToRead + withTimeout:TIMEOUT_READ_BODY + tag:HTTP_REQUEST_CHUNK_DATA]; + } + else + { + // This is the "0" (zero) line, + // which is to be followed by optional footers (just like headers) and finally a blank line. + + [asyncSocket readDataToData:[GCDAsyncSocket CRLFData] + withTimeout:TIMEOUT_READ_BODY + maxLength:MAX_HEADER_LINE_LENGTH + tag:HTTP_REQUEST_CHUNK_FOOTER]; + } + + return; + } + else if (tag == HTTP_REQUEST_CHUNK_DATA) + { + // We just read part of the actual data. + + requestContentLengthReceived += [data length]; + requestChunkSizeReceived += [data length]; + + [self processBodyData:data]; + + UInt64 bytesLeft = requestChunkSize - requestChunkSizeReceived; + if (bytesLeft > 0) + { + NSUInteger bytesToRead = (bytesLeft < POST_CHUNKSIZE) ? (NSUInteger)bytesLeft : POST_CHUNKSIZE; + + [asyncSocket readDataToLength:bytesToRead + withTimeout:TIMEOUT_READ_BODY + tag:HTTP_REQUEST_CHUNK_DATA]; + } + else + { + // We've read in all the data for this chunk. + // The data is followed by a CRLF, which we need to read (and basically ignore) + + [asyncSocket readDataToLength:2 + withTimeout:TIMEOUT_READ_BODY + tag:HTTP_REQUEST_CHUNK_TRAILER]; + } + + return; + } + else if (tag == HTTP_REQUEST_CHUNK_TRAILER) + { + // This should be the CRLF following the data. + // Just ensure it's a CRLF. + + if (![data isEqualToData:[GCDAsyncSocket CRLFData]]) + { + HTTPLogWarn(@"%@[%p]: Method expects chunk trailer, but is missing", THIS_FILE, self); + + [self handleInvalidRequest:nil]; + return; + } + + // Now continue with the next chunk + + [asyncSocket readDataToData:[GCDAsyncSocket CRLFData] + withTimeout:TIMEOUT_READ_BODY + maxLength:MAX_CHUNK_LINE_LENGTH + tag:HTTP_REQUEST_CHUNK_SIZE]; + + } + else if (tag == HTTP_REQUEST_CHUNK_FOOTER) + { + if (++numHeaderLines > MAX_HEADER_LINES) + { + // Reached the maximum amount of header lines in a single HTTP request + // This could be an attempted DOS attack + [asyncSocket disconnect]; + + // Explictly return to ensure we don't do anything after the socket disconnect + return; + } + + if ([data length] > 2) + { + // We read in a footer. + // In the future we may want to append these to the request. + // For now we ignore, and continue reading the footers, waiting for the final blank line. + + [asyncSocket readDataToData:[GCDAsyncSocket CRLFData] + withTimeout:TIMEOUT_READ_BODY + maxLength:MAX_HEADER_LINE_LENGTH + tag:HTTP_REQUEST_CHUNK_FOOTER]; + } + else + { + doneReadingRequest = YES; + } + } + else // HTTP_REQUEST_BODY + { + // Handle a chunk of data from the POST body + + requestContentLengthReceived += [data length]; + [self processBodyData:data]; + + if (requestContentLengthReceived < requestContentLength) + { + // We're not done reading the post body yet... + + UInt64 bytesLeft = requestContentLength - requestContentLengthReceived; + + NSUInteger bytesToRead = bytesLeft < POST_CHUNKSIZE ? (NSUInteger)bytesLeft : POST_CHUNKSIZE; + + [asyncSocket readDataToLength:bytesToRead + withTimeout:TIMEOUT_READ_BODY + tag:HTTP_REQUEST_BODY]; + } + else + { + doneReadingRequest = YES; + } + } + + // Now that the entire body has been received, we need to reply to the request + + if (doneReadingRequest) + { + [self finishBody]; + [self replyToHTTPRequest]; + } + } +} + +/** + * This method is called after the socket has successfully written data to the stream. +**/ +- (void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag +{ + BOOL doneSendingResponse = NO; + + if (tag == HTTP_PARTIAL_RESPONSE_BODY) + { + // Update the amount of data we have in asyncSocket's write queue + if ([responseDataSizes count] > 0) { + [responseDataSizes removeObjectAtIndex:0]; + } + + // We only wrote a part of the response - there may be more + [self continueSendingStandardResponseBody]; + } + else if (tag == HTTP_CHUNKED_RESPONSE_BODY) + { + // Update the amount of data we have in asyncSocket's write queue. + // This will allow asynchronous responses to continue sending more data. + if ([responseDataSizes count] > 0) { + [responseDataSizes removeObjectAtIndex:0]; + } + // Don't continue sending the response yet. + // The chunked footer that was sent after the body will tell us if we have more data to send. + } + else if (tag == HTTP_CHUNKED_RESPONSE_FOOTER) + { + // Normal chunked footer indicating we have more data to send (non final footer). + [self continueSendingStandardResponseBody]; + } + else if (tag == HTTP_PARTIAL_RANGE_RESPONSE_BODY) + { + // Update the amount of data we have in asyncSocket's write queue + if ([responseDataSizes count] > 0) { + [responseDataSizes removeObjectAtIndex:0]; + } + // We only wrote a part of the range - there may be more + [self continueSendingSingleRangeResponseBody]; + } + else if (tag == HTTP_PARTIAL_RANGES_RESPONSE_BODY) + { + // Update the amount of data we have in asyncSocket's write queue + if ([responseDataSizes count] > 0) { + [responseDataSizes removeObjectAtIndex:0]; + } + // We only wrote part of the range - there may be more, or there may be more ranges + [self continueSendingMultiRangeResponseBody]; + } + else if (tag == HTTP_RESPONSE || tag == HTTP_FINAL_RESPONSE) + { + // Update the amount of data we have in asyncSocket's write queue + if ([responseDataSizes count] > 0) + { + [responseDataSizes removeObjectAtIndex:0]; + } + + doneSendingResponse = YES; + } + + if (doneSendingResponse) + { + // Inform the http response that we're done + if ([httpResponse respondsToSelector:@selector(connectionDidClose)]) + { + [httpResponse connectionDidClose]; + } + + + if (tag == HTTP_FINAL_RESPONSE) + { + // Cleanup after the last request + [self finishResponse]; + + // Terminate the connection + [asyncSocket disconnect]; + + // Explictly return to ensure we don't do anything after the socket disconnects + return; + } + else + { + if ([self shouldDie]) + { + // Cleanup after the last request + // Note: Don't do this before calling shouldDie, as it needs the request object still. + [self finishResponse]; + + // The only time we should invoke [self die] is from socketDidDisconnect, + // or if the socket gets taken over by someone else like a WebSocket. + + [asyncSocket disconnect]; + } + else + { + // Cleanup after the last request + [self finishResponse]; + + // Prepare for the next request + + // If this assertion fails, it likely means you overrode the + // finishBody method and forgot to call [super finishBody]. + NSAssert(request == nil, @"Request not properly released in finishBody"); + + request = [[HTTPMessage alloc] initEmptyRequest]; + + numHeaderLines = 0; + sentResponseHeaders = NO; + + // And start listening for more requests + [self startReadingRequest]; + } + } + } +} + +/** + * Sent after the socket has been disconnected. +**/ +- (void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)err +{ + HTTPLogTrace(); + + asyncSocket = nil; + + [self die]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark HTTPResponse Notifications +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method may be called by asynchronous HTTPResponse objects. + * That is, HTTPResponse objects that return YES in their "- (BOOL)isAsynchronous" method. + * + * This informs us that the response object has generated more data that we may be able to send. +**/ +- (void)responseHasAvailableData:(NSObject *)sender +{ + HTTPLogTrace(); + + // We always dispatch this asynchronously onto our connectionQueue, + // even if the connectionQueue is the current queue. + // + // We do this to give the HTTPResponse classes the flexibility to call + // this method whenever they want, even from within a readDataOfLength method. + + dispatch_async(connectionQueue, ^{ @autoreleasepool { + + if (sender != httpResponse) + { + HTTPLogWarn(@"%@[%p]: %@ - Sender is not current httpResponse", THIS_FILE, self, THIS_METHOD); + return; + } + + if (!sentResponseHeaders) + { + [self sendResponseHeadersAndBody]; + } + else + { + if (ranges == nil) + { + [self continueSendingStandardResponseBody]; + } + else + { + if ([ranges count] == 1) + [self continueSendingSingleRangeResponseBody]; + else + [self continueSendingMultiRangeResponseBody]; + } + } + }}); +} + +/** + * This method is called if the response encounters some critical error, + * and it will be unable to fullfill the request. +**/ +- (void)responseDidAbort:(NSObject *)sender +{ + HTTPLogTrace(); + + // We always dispatch this asynchronously onto our connectionQueue, + // even if the connectionQueue is the current queue. + // + // We do this to give the HTTPResponse classes the flexibility to call + // this method whenever they want, even from within a readDataOfLength method. + + dispatch_async(connectionQueue, ^{ @autoreleasepool { + + if (sender != httpResponse) + { + HTTPLogWarn(@"%@[%p]: %@ - Sender is not current httpResponse", THIS_FILE, self, THIS_METHOD); + return; + } + + [asyncSocket disconnectAfterWriting]; + }}); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Post Request +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method is called after each response has been fully sent. + * Since a single connection may handle multiple request/responses, this method may be called multiple times. + * That is, it will be called after completion of each response. +**/ +- (void)finishResponse +{ + HTTPLogTrace(); + + // Override me if you want to perform any custom actions after a response has been fully sent. + // This is the place to release memory or resources associated with the last request. + // + // If you override this method, you should take care to invoke [super finishResponse] at some point. + + request = nil; + + httpResponse = nil; + + ranges = nil; + ranges_headers = nil; + ranges_boundry = nil; +} + +/** + * This method is called after each successful response has been fully sent. + * It determines whether the connection should stay open and handle another request. +**/ +- (BOOL)shouldDie +{ + HTTPLogTrace(); + + // Override me if you have any need to force close the connection. + // You may do so by simply returning YES. + // + // If you override this method, you should take care to fall through with [super shouldDie] + // instead of returning NO. + + + BOOL shouldDie = NO; + + NSString *version = [request version]; + if ([version isEqualToString:HTTPVersion1_1]) + { + // HTTP version 1.1 + // Connection should only be closed if request included "Connection: close" header + + NSString *connection = [request headerField:@"Connection"]; + + shouldDie = (connection && ([connection caseInsensitiveCompare:@"close"] == NSOrderedSame)); + } + else if ([version isEqualToString:HTTPVersion1_0]) + { + // HTTP version 1.0 + // Connection should be closed unless request included "Connection: Keep-Alive" header + + NSString *connection = [request headerField:@"Connection"]; + + if (connection == nil) + shouldDie = YES; + else + shouldDie = [connection caseInsensitiveCompare:@"Keep-Alive"] != NSOrderedSame; + } + + return shouldDie; +} + +- (void)die +{ + HTTPLogTrace(); + + // Override me if you want to perform any custom actions when a connection is closed. + // Then call [super die] when you're done. + // + // See also the finishResponse method. + // + // Important: There is a rare timing condition where this method might get invoked twice. + // If you override this method, you should be prepared for this situation. + + // Inform the http response that we're done + if ([httpResponse respondsToSelector:@selector(connectionDidClose)]) + { + [httpResponse connectionDidClose]; + } + + // Release the http response so we don't call it's connectionDidClose method again in our dealloc method + httpResponse = nil; + + // Post notification of dead connection + // This will allow our server to release us from its array of connections + [[NSNotificationCenter defaultCenter] postNotificationName:HTTPConnectionDidDieNotification object:self]; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation HTTPConfig + +@synthesize server; +@synthesize documentRoot; +@synthesize queue; + +- (id)initWithServer:(HTTPServer *)aServer documentRoot:(NSString *)aDocumentRoot +{ + if ((self = [super init])) + { + server = aServer; + documentRoot = aDocumentRoot; + } + return self; +} + +- (id)initWithServer:(HTTPServer *)aServer documentRoot:(NSString *)aDocumentRoot queue:(dispatch_queue_t)q +{ + if ((self = [super init])) + { + server = aServer; + + documentRoot = [aDocumentRoot stringByStandardizingPath]; + if ([documentRoot hasSuffix:@"/"]) + { + documentRoot = [documentRoot stringByAppendingString:@"/"]; + } + + if (q) + { + queue = q; + #if !OS_OBJECT_USE_OBJC + dispatch_retain(queue); + #endif + } + } + return self; +} + +- (void)dealloc +{ + #if !OS_OBJECT_USE_OBJC + if (queue) dispatch_release(queue); + #endif +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPLogging.h b/platform/iphone/CocoaHTTPServer/Core/HTTPLogging.h new file mode 100644 index 00000000000..2e4bbcd0d2a --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPLogging.h @@ -0,0 +1,136 @@ +/** + * In order to provide fast and flexible logging, this project uses Cocoa Lumberjack. + * + * The Google Code page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * Here's what you need to know concerning how logging is setup for CocoaHTTPServer: + * + * There are 4 log levels: + * - Error + * - Warning + * - Info + * - Verbose + * + * In addition to this, there is a Trace flag that can be enabled. + * When tracing is enabled, it spits out the methods that are being called. + * + * Please note that tracing is separate from the log levels. + * For example, one could set the log level to warning, and enable tracing. + * + * All logging is asynchronous, except errors. + * To use logging within your own custom files, follow the steps below. + * + * Step 1: + * Import this header in your implementation file: + * + * #import "HTTPLogging.h" + * + * Step 2: + * Define your logging level in your implementation file: + * + * // Log levels: off, error, warn, info, verbose + * static const int httpLogLevel = HTTP_LOG_LEVEL_VERBOSE; + * + * If you wish to enable tracing, you could do something like this: + * + * // Debug levels: off, error, warn, info, verbose + * static const int httpLogLevel = HTTP_LOG_LEVEL_INFO | HTTP_LOG_FLAG_TRACE; + * + * Step 3: + * Replace your NSLog statements with HTTPLog statements according to the severity of the message. + * + * NSLog(@"Fatal error, no dohickey found!"); -> HTTPLogError(@"Fatal error, no dohickey found!"); + * + * HTTPLog works exactly the same as NSLog. + * This means you can pass it multiple variables just like NSLog. +**/ + +#import "DDLog.h" + +// Define logging context for every log message coming from the HTTP server. +// The logging context can be extracted from the DDLogMessage from within the logging framework, +// which gives loggers, formatters, and filters the ability to optionally process them differently. + +#define HTTP_LOG_CONTEXT 80 + +// Configure log levels. + +#define HTTP_LOG_FLAG_ERROR (1 << 0) // 0...00001 +#define HTTP_LOG_FLAG_WARN (1 << 1) // 0...00010 +#define HTTP_LOG_FLAG_INFO (1 << 2) // 0...00100 +#define HTTP_LOG_FLAG_VERBOSE (1 << 3) // 0...01000 + +#define HTTP_LOG_LEVEL_OFF 0 // 0...00000 +#define HTTP_LOG_LEVEL_ERROR (HTTP_LOG_LEVEL_OFF | HTTP_LOG_FLAG_ERROR) // 0...00001 +#define HTTP_LOG_LEVEL_WARN (HTTP_LOG_LEVEL_ERROR | HTTP_LOG_FLAG_WARN) // 0...00011 +#define HTTP_LOG_LEVEL_INFO (HTTP_LOG_LEVEL_WARN | HTTP_LOG_FLAG_INFO) // 0...00111 +#define HTTP_LOG_LEVEL_VERBOSE (HTTP_LOG_LEVEL_INFO | HTTP_LOG_FLAG_VERBOSE) // 0...01111 + +// Setup fine grained logging. +// The first 4 bits are being used by the standard log levels (0 - 3) +// +// We're going to add tracing, but NOT as a log level. +// Tracing can be turned on and off independently of log level. + +#define HTTP_LOG_FLAG_TRACE (1 << 4) // 0...10000 + +// Setup the usual boolean macros. + +#define HTTP_LOG_ERROR (httpLogLevel & HTTP_LOG_FLAG_ERROR) +#define HTTP_LOG_WARN (httpLogLevel & HTTP_LOG_FLAG_WARN) +#define HTTP_LOG_INFO (httpLogLevel & HTTP_LOG_FLAG_INFO) +#define HTTP_LOG_VERBOSE (httpLogLevel & HTTP_LOG_FLAG_VERBOSE) +#define HTTP_LOG_TRACE (httpLogLevel & HTTP_LOG_FLAG_TRACE) + +// Configure asynchronous logging. +// We follow the default configuration, +// but we reserve a special macro to easily disable asynchronous logging for debugging purposes. + +#define HTTP_LOG_ASYNC_ENABLED YES + +#define HTTP_LOG_ASYNC_ERROR ( NO && HTTP_LOG_ASYNC_ENABLED) +#define HTTP_LOG_ASYNC_WARN (YES && HTTP_LOG_ASYNC_ENABLED) +#define HTTP_LOG_ASYNC_INFO (YES && HTTP_LOG_ASYNC_ENABLED) +#define HTTP_LOG_ASYNC_VERBOSE (YES && HTTP_LOG_ASYNC_ENABLED) +#define HTTP_LOG_ASYNC_TRACE (YES && HTTP_LOG_ASYNC_ENABLED) + +// Define logging primitives. + +#define HTTPLogError(frmt, ...) LOG_OBJC_MAYBE(HTTP_LOG_ASYNC_ERROR, httpLogLevel, HTTP_LOG_FLAG_ERROR, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogWarn(frmt, ...) LOG_OBJC_MAYBE(HTTP_LOG_ASYNC_WARN, httpLogLevel, HTTP_LOG_FLAG_WARN, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogInfo(frmt, ...) LOG_OBJC_MAYBE(HTTP_LOG_ASYNC_INFO, httpLogLevel, HTTP_LOG_FLAG_INFO, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogVerbose(frmt, ...) LOG_OBJC_MAYBE(HTTP_LOG_ASYNC_VERBOSE, httpLogLevel, HTTP_LOG_FLAG_VERBOSE, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogTrace() LOG_OBJC_MAYBE(HTTP_LOG_ASYNC_TRACE, httpLogLevel, HTTP_LOG_FLAG_TRACE, \ + HTTP_LOG_CONTEXT, @"%@[%p]: %@", THIS_FILE, self, THIS_METHOD) + +#define HTTPLogTrace2(frmt, ...) LOG_OBJC_MAYBE(HTTP_LOG_ASYNC_TRACE, httpLogLevel, HTTP_LOG_FLAG_TRACE, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + + +#define HTTPLogCError(frmt, ...) LOG_C_MAYBE(HTTP_LOG_ASYNC_ERROR, httpLogLevel, HTTP_LOG_FLAG_ERROR, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogCWarn(frmt, ...) LOG_C_MAYBE(HTTP_LOG_ASYNC_WARN, httpLogLevel, HTTP_LOG_FLAG_WARN, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogCInfo(frmt, ...) LOG_C_MAYBE(HTTP_LOG_ASYNC_INFO, httpLogLevel, HTTP_LOG_FLAG_INFO, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogCVerbose(frmt, ...) LOG_C_MAYBE(HTTP_LOG_ASYNC_VERBOSE, httpLogLevel, HTTP_LOG_FLAG_VERBOSE, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + +#define HTTPLogCTrace() LOG_C_MAYBE(HTTP_LOG_ASYNC_TRACE, httpLogLevel, HTTP_LOG_FLAG_TRACE, \ + HTTP_LOG_CONTEXT, @"%@[%p]: %@", THIS_FILE, self, __FUNCTION__) + +#define HTTPLogCTrace2(frmt, ...) LOG_C_MAYBE(HTTP_LOG_ASYNC_TRACE, httpLogLevel, HTTP_LOG_FLAG_TRACE, \ + HTTP_LOG_CONTEXT, frmt, ##__VA_ARGS__) + diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPMessage.h b/platform/iphone/CocoaHTTPServer/Core/HTTPMessage.h new file mode 100644 index 00000000000..20ea921c3b2 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPMessage.h @@ -0,0 +1,48 @@ +/** + * The HTTPMessage class is a simple Objective-C wrapper around Apple's CFHTTPMessage class. +**/ + +#import + +#if TARGET_OS_IPHONE + // Note: You may need to add the CFNetwork Framework to your project + #import +#endif + +#define HTTPVersion1_0 ((NSString *)kCFHTTPVersion1_0) +#define HTTPVersion1_1 ((NSString *)kCFHTTPVersion1_1) + + +@interface HTTPMessage : NSObject +{ + CFHTTPMessageRef message; +} + +- (id)initEmptyRequest; + +- (id)initRequestWithMethod:(NSString *)method URL:(NSURL *)url version:(NSString *)version; + +- (id)initResponseWithStatusCode:(NSInteger)code description:(NSString *)description version:(NSString *)version; + +- (BOOL)appendData:(NSData *)data; + +- (BOOL)isHeaderComplete; + +- (NSString *)version; + +- (NSString *)method; +- (NSURL *)url; + +- (NSInteger)statusCode; + +- (NSDictionary *)allHeaderFields; +- (NSString *)headerField:(NSString *)headerField; + +- (void)setHeaderField:(NSString *)headerField value:(NSString *)headerFieldValue; + +- (NSData *)messageData; + +- (NSData *)body; +- (void)setBody:(NSData *)body; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPMessage.m b/platform/iphone/CocoaHTTPServer/Core/HTTPMessage.m new file mode 100644 index 00000000000..e2c7e0077fb --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPMessage.m @@ -0,0 +1,113 @@ +#import "HTTPMessage.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + + +@implementation HTTPMessage + +- (id)initEmptyRequest +{ + if ((self = [super init])) + { + message = CFHTTPMessageCreateEmpty(NULL, YES); + } + return self; +} + +- (id)initRequestWithMethod:(NSString *)method URL:(NSURL *)url version:(NSString *)version +{ + if ((self = [super init])) + { + message = CFHTTPMessageCreateRequest(NULL, + (__bridge CFStringRef)method, + (__bridge CFURLRef)url, + (__bridge CFStringRef)version); + } + return self; +} + +- (id)initResponseWithStatusCode:(NSInteger)code description:(NSString *)description version:(NSString *)version +{ + if ((self = [super init])) + { + message = CFHTTPMessageCreateResponse(NULL, + (CFIndex)code, + (__bridge CFStringRef)description, + (__bridge CFStringRef)version); + } + return self; +} + +- (void)dealloc +{ + if (message) + { + CFRelease(message); + } +} + +- (BOOL)appendData:(NSData *)data +{ + return CFHTTPMessageAppendBytes(message, [data bytes], [data length]); +} + +- (BOOL)isHeaderComplete +{ + return CFHTTPMessageIsHeaderComplete(message); +} + +- (NSString *)version +{ + return (__bridge_transfer NSString *)CFHTTPMessageCopyVersion(message); +} + +- (NSString *)method +{ + return (__bridge_transfer NSString *)CFHTTPMessageCopyRequestMethod(message); +} + +- (NSURL *)url +{ + return (__bridge_transfer NSURL *)CFHTTPMessageCopyRequestURL(message); +} + +- (NSInteger)statusCode +{ + return (NSInteger)CFHTTPMessageGetResponseStatusCode(message); +} + +- (NSDictionary *)allHeaderFields +{ + return (__bridge_transfer NSDictionary *)CFHTTPMessageCopyAllHeaderFields(message); +} + +- (NSString *)headerField:(NSString *)headerField +{ + return (__bridge_transfer NSString *)CFHTTPMessageCopyHeaderFieldValue(message, (__bridge CFStringRef)headerField); +} + +- (void)setHeaderField:(NSString *)headerField value:(NSString *)headerFieldValue +{ + CFHTTPMessageSetHeaderFieldValue(message, + (__bridge CFStringRef)headerField, + (__bridge CFStringRef)headerFieldValue); +} + +- (NSData *)messageData +{ + return (__bridge_transfer NSData *)CFHTTPMessageCopySerializedMessage(message); +} + +- (NSData *)body +{ + return (__bridge_transfer NSData *)CFHTTPMessageCopyBody(message); +} + +- (void)setBody:(NSData *)body +{ + CFHTTPMessageSetBody(message, (__bridge CFDataRef)body); +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPResponse.h b/platform/iphone/CocoaHTTPServer/Core/HTTPResponse.h new file mode 100644 index 00000000000..f303cf30ba5 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPResponse.h @@ -0,0 +1,149 @@ +#import + + +@protocol HTTPResponse + +/** + * Returns the length of the data in bytes. + * If you don't know the length in advance, implement the isChunked method and have it return YES. +**/ +- (UInt64)contentLength; + +/** + * The HTTP server supports range requests in order to allow things like + * file download resumption and optimized streaming on mobile devices. +**/ +- (UInt64)offset; +- (void)setOffset:(UInt64)offset; + +/** + * Returns the data for the response. + * You do not have to return data of the exact length that is given. + * You may optionally return data of a lesser length. + * However, you must never return data of a greater length than requested. + * Doing so could disrupt proper support for range requests. + * + * To support asynchronous responses, read the discussion at the bottom of this header. +**/ +- (NSData *)readDataOfLength:(NSUInteger)length; + +/** + * Should only return YES after the HTTPConnection has read all available data. + * That is, all data for the response has been returned to the HTTPConnection via the readDataOfLength method. +**/ +- (BOOL)isDone; + +@optional + +/** + * If you need time to calculate any part of the HTTP response headers (status code or header fields), + * this method allows you to delay sending the headers so that you may asynchronously execute the calculations. + * Simply implement this method and return YES until you have everything you need concerning the headers. + * + * This method ties into the asynchronous response architecture of the HTTPConnection. + * You should read the full discussion at the bottom of this header. + * + * If you return YES from this method, + * the HTTPConnection will wait for you to invoke the responseHasAvailableData method. + * After you do, the HTTPConnection will again invoke this method to see if the response is ready to send the headers. + * + * You should only delay sending the headers until you have everything you need concerning just the headers. + * Asynchronously generating the body of the response is not an excuse to delay sending the headers. + * Instead you should tie into the asynchronous response architecture, and use techniques such as the isChunked method. + * + * Important: You should read the discussion at the bottom of this header. +**/ +- (BOOL)delayResponseHeaders; + +/** + * Status code for response. + * Allows for responses such as redirect (301), etc. +**/ +- (NSInteger)status; + +/** + * If you want to add any extra HTTP headers to the response, + * simply return them in a dictionary in this method. +**/ +- (NSDictionary *)httpHeaders; + +/** + * If you don't know the content-length in advance, + * implement this method in your custom response class and return YES. + * + * Important: You should read the discussion at the bottom of this header. +**/ +- (BOOL)isChunked; + +/** + * This method is called from the HTTPConnection class when the connection is closed, + * or when the connection is finished with the response. + * If your response is asynchronous, you should implement this method so you know not to + * invoke any methods on the HTTPConnection after this method is called (as the connection may be deallocated). +**/ +- (void)connectionDidClose; + +@end + + +/** + * Important notice to those implementing custom asynchronous and/or chunked responses: + * + * HTTPConnection supports asynchronous responses. All you have to do in your custom response class is + * asynchronously generate the response, and invoke HTTPConnection's responseHasAvailableData method. + * You don't have to wait until you have all of the response ready to invoke this method. For example, if you + * generate the response in incremental chunks, you could call responseHasAvailableData after generating + * each chunk. Please see the HTTPAsyncFileResponse class for an example of how to do this. + * + * The normal flow of events for an HTTPConnection while responding to a request is like this: + * - Send http resopnse headers + * - Get data from response via readDataOfLength method. + * - Add data to asyncSocket's write queue. + * - Wait for asyncSocket to notify it that the data has been sent. + * - Get more data from response via readDataOfLength method. + * - ... continue this cycle until the entire response has been sent. + * + * With an asynchronous response, the flow is a little different. + * + * First the HTTPResponse is given the opportunity to postpone sending the HTTP response headers. + * This allows the response to asynchronously execute any code needed to calculate a part of the header. + * An example might be the response needs to generate some custom header fields, + * or perhaps the response needs to look for a resource on network-attached storage. + * Since the network-attached storage may be slow, the response doesn't know whether to send a 200 or 404 yet. + * In situations such as this, the HTTPResponse simply implements the delayResponseHeaders method and returns YES. + * After returning YES from this method, the HTTPConnection will wait until the response invokes its + * responseHasAvailableData method. After this occurs, the HTTPConnection will again query the delayResponseHeaders + * method to see if the response is ready to send the headers. + * This cycle will continue until the delayResponseHeaders method returns NO. + * + * You should only delay sending the response headers until you have everything you need concerning just the headers. + * Asynchronously generating the body of the response is not an excuse to delay sending the headers. + * + * After the response headers have been sent, the HTTPConnection calls your readDataOfLength method. + * You may or may not have any available data at this point. If you don't, then simply return nil. + * You should later invoke HTTPConnection's responseHasAvailableData when you have data to send. + * + * You don't have to keep track of when you return nil in the readDataOfLength method, or how many times you've invoked + * responseHasAvailableData. Just simply call responseHasAvailableData whenever you've generated new data, and + * return nil in your readDataOfLength whenever you don't have any available data in the requested range. + * HTTPConnection will automatically detect when it should be requesting new data and will act appropriately. + * + * It's important that you also keep in mind that the HTTP server supports range requests. + * The setOffset method is mandatory, and should not be ignored. + * Make sure you take into account the offset within the readDataOfLength method. + * You should also be aware that the HTTPConnection automatically sorts any range requests. + * So if your setOffset method is called with a value of 100, then you can safely release bytes 0-99. + * + * HTTPConnection can also help you keep your memory footprint small. + * Imagine you're dynamically generating a 10 MB response. You probably don't want to load all this data into + * RAM, and sit around waiting for HTTPConnection to slowly send it out over the network. All you need to do + * is pay attention to when HTTPConnection requests more data via readDataOfLength. This is because HTTPConnection + * will never allow asyncSocket's write queue to get much bigger than READ_CHUNKSIZE bytes. You should + * consider how you might be able to take advantage of this fact to generate your asynchronous response on demand, + * while at the same time keeping your memory footprint small, and your application lightning fast. + * + * If you don't know the content-length in advanced, you should also implement the isChunked method. + * This means the response will not include a Content-Length header, and will instead use "Transfer-Encoding: chunked". + * There's a good chance that if your response is asynchronous and dynamic, it's also chunked. + * If your response is chunked, you don't need to worry about range requests. +**/ diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPServer.h b/platform/iphone/CocoaHTTPServer/Core/HTTPServer.h new file mode 100644 index 00000000000..1d37cb69704 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPServer.h @@ -0,0 +1,205 @@ +#import + +@class GCDAsyncSocket; +@class WebSocket; + +#if TARGET_OS_IPHONE + #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 40000 // iPhone 4.0 + #define IMPLEMENTED_PROTOCOLS + #else + #define IMPLEMENTED_PROTOCOLS + #endif +#else + #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1060 // Mac OS X 10.6 + #define IMPLEMENTED_PROTOCOLS + #else + #define IMPLEMENTED_PROTOCOLS + #endif +#endif + + +@interface HTTPServer : NSObject IMPLEMENTED_PROTOCOLS +{ + // Underlying asynchronous TCP/IP socket + GCDAsyncSocket *asyncSocket; + + // Dispatch queues + dispatch_queue_t serverQueue; + dispatch_queue_t connectionQueue; + void *IsOnServerQueueKey; + void *IsOnConnectionQueueKey; + + // HTTP server configuration + NSString *documentRoot; + Class connectionClass; + NSString *interface; + UInt16 port; + + // NSNetService and related variables + NSNetService *netService; + NSString *domain; + NSString *type; + NSString *name; + NSString *publishedName; + NSDictionary *txtRecordDictionary; + + // Connection management + NSMutableArray *connections; + NSMutableArray *webSockets; + NSLock *connectionsLock; + NSLock *webSocketsLock; + + BOOL isRunning; +} + +/** + * Specifies the document root to serve files from. + * For example, if you set this to "/Users//Sites", + * then it will serve files out of the local Sites directory (including subdirectories). + * + * The default value is nil. + * The default server configuration will not serve any files until this is set. + * + * If you change the documentRoot while the server is running, + * the change will affect future incoming http connections. +**/ +- (NSString *)documentRoot; +- (void)setDocumentRoot:(NSString *)value; + +/** + * The connection class is the class used to handle incoming HTTP connections. + * + * The default value is [HTTPConnection class]. + * You can override HTTPConnection, and then set this to [MyHTTPConnection class]. + * + * If you change the connectionClass while the server is running, + * the change will affect future incoming http connections. +**/ +- (Class)connectionClass; +- (void)setConnectionClass:(Class)value; + +/** + * Set what interface you'd like the server to listen on. + * By default this is nil, which causes the server to listen on all available interfaces like en1, wifi etc. + * + * The interface may be specified by name (e.g. "en1" or "lo0") or by IP address (e.g. "192.168.4.34"). + * You may also use the special strings "localhost" or "loopback" to specify that + * the socket only accept connections from the local machine. +**/ +- (NSString *)interface; +- (void)setInterface:(NSString *)value; + +/** + * The port number to run the HTTP server on. + * + * The default port number is zero, meaning the server will automatically use any available port. + * This is the recommended port value, as it avoids possible port conflicts with other applications. + * Technologies such as Bonjour can be used to allow other applications to automatically discover the port number. + * + * Note: As is common on most OS's, you need root privledges to bind to port numbers below 1024. + * + * You can change the port property while the server is running, but it won't affect the running server. + * To actually change the port the server is listening for connections on you'll need to restart the server. + * + * The listeningPort method will always return the port number the running server is listening for connections on. + * If the server is not running this method returns 0. +**/ +- (UInt16)port; +- (UInt16)listeningPort; +- (void)setPort:(UInt16)value; + +/** + * Bonjour domain for publishing the service. + * The default value is "local.". + * + * Note: Bonjour publishing requires you set a type. + * + * If you change the domain property after the bonjour service has already been published (server already started), + * you'll need to invoke the republishBonjour method to update the broadcasted bonjour service. +**/ +- (NSString *)domain; +- (void)setDomain:(NSString *)value; + +/** + * Bonjour name for publishing the service. + * The default value is "". + * + * If using an empty string ("") for the service name when registering, + * the system will automatically use the "Computer Name". + * Using an empty string will also handle name conflicts + * by automatically appending a digit to the end of the name. + * + * Note: Bonjour publishing requires you set a type. + * + * If you change the name after the bonjour service has already been published (server already started), + * you'll need to invoke the republishBonjour method to update the broadcasted bonjour service. + * + * The publishedName method will always return the actual name that was published via the bonjour service. + * If the service is not running this method returns nil. +**/ +- (NSString *)name; +- (NSString *)publishedName; +- (void)setName:(NSString *)value; + +/** + * Bonjour type for publishing the service. + * The default value is nil. + * The service will not be published via bonjour unless the type is set. + * + * If you wish to publish the service as a traditional HTTP server, you should set the type to be "_http._tcp.". + * + * If you change the type after the bonjour service has already been published (server already started), + * you'll need to invoke the republishBonjour method to update the broadcasted bonjour service. +**/ +- (NSString *)type; +- (void)setType:(NSString *)value; + +/** + * Republishes the service via bonjour if the server is running. + * If the service was not previously published, this method will publish it (if the server is running). +**/ +- (void)republishBonjour; + +/** + * +**/ +- (NSDictionary *)TXTRecordDictionary; +- (void)setTXTRecordDictionary:(NSDictionary *)dict; + +/** + * Attempts to starts the server on the configured port, interface, etc. + * + * If an error occurs, this method returns NO and sets the errPtr (if given). + * Otherwise returns YES on success. + * + * Some examples of errors that might occur: + * - You specified the server listen on a port which is already in use by another application. + * - You specified the server listen on a port number below 1024, which requires root priviledges. + * + * Code Example: + * + * NSError *err = nil; + * if (![httpServer start:&err]) + * { + * NSLog(@"Error starting http server: %@", err); + * } +**/ +- (BOOL)start:(NSError **)errPtr; + +/** + * Stops the server, preventing it from accepting any new connections. + * You may specify whether or not you want to close the existing client connections. + * + * The default stop method (with no arguments) will close any existing connections. (It invokes [self stop:NO]) +**/ +- (void)stop; +- (void)stop:(BOOL)keepExistingConnections; + +- (BOOL)isRunning; + +- (void)addWebSocket:(WebSocket *)ws; + +- (NSUInteger)numberOfHTTPConnections; +- (NSUInteger)numberOfWebSocketConnections; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/HTTPServer.m b/platform/iphone/CocoaHTTPServer/Core/HTTPServer.m new file mode 100644 index 00000000000..57384f79b69 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/HTTPServer.m @@ -0,0 +1,772 @@ +#import "HTTPServer.h" +#import "GCDAsyncSocket.h" +#import "HTTPConnection.h" +#import "WebSocket.h" +#import "HTTPLogging.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels: off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_INFO; // | HTTP_LOG_FLAG_TRACE; + +@interface HTTPServer (PrivateAPI) + +- (void)unpublishBonjour; +- (void)publishBonjour; + ++ (void)startBonjourThreadIfNeeded; ++ (void)performBonjourBlock:(dispatch_block_t)block; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation HTTPServer + +/** + * Standard Constructor. + * Instantiates an HTTP server, but does not start it. +**/ +- (id)init +{ + if ((self = [super init])) + { + HTTPLogTrace(); + + // Setup underlying dispatch queues + serverQueue = dispatch_queue_create("HTTPServer", NULL); + connectionQueue = dispatch_queue_create("HTTPConnection", NULL); + + IsOnServerQueueKey = &IsOnServerQueueKey; + IsOnConnectionQueueKey = &IsOnConnectionQueueKey; + + void *nonNullUnusedPointer = (__bridge void *)self; // Whatever, just not null + + dispatch_queue_set_specific(serverQueue, IsOnServerQueueKey, nonNullUnusedPointer, NULL); + dispatch_queue_set_specific(connectionQueue, IsOnConnectionQueueKey, nonNullUnusedPointer, NULL); + + // Initialize underlying GCD based tcp socket + asyncSocket = [[GCDAsyncSocket alloc] initWithDelegate:self delegateQueue:serverQueue]; + + // Use default connection class of HTTPConnection + connectionClass = [HTTPConnection self]; + + // By default bind on all available interfaces, en1, wifi etc + interface = nil; + + // Use a default port of 0 + // This will allow the kernel to automatically pick an open port for us + port = 0; + + // Configure default values for bonjour service + + // Bonjour domain. Use the local domain by default + domain = @"local."; + + // If using an empty string ("") for the service name when registering, + // the system will automatically use the "Computer Name". + // Passing in an empty string will also handle name conflicts + // by automatically appending a digit to the end of the name. + name = @""; + + // Initialize arrays to hold all the HTTP and webSocket connections + connections = [[NSMutableArray alloc] init]; + webSockets = [[NSMutableArray alloc] init]; + + connectionsLock = [[NSLock alloc] init]; + webSocketsLock = [[NSLock alloc] init]; + + // Register for notifications of closed connections + [[NSNotificationCenter defaultCenter] addObserver:self + selector:@selector(connectionDidDie:) + name:HTTPConnectionDidDieNotification + object:nil]; + + // Register for notifications of closed websocket connections + [[NSNotificationCenter defaultCenter] addObserver:self + selector:@selector(webSocketDidDie:) + name:WebSocketDidDieNotification + object:nil]; + + isRunning = NO; + } + return self; +} + +/** + * Standard Deconstructor. + * Stops the server, and clients, and releases any resources connected with this instance. +**/ +- (void)dealloc +{ + HTTPLogTrace(); + + // Remove notification observer + [[NSNotificationCenter defaultCenter] removeObserver:self]; + + // Stop the server if it's running + [self stop]; + + // Release all instance variables + + #if !OS_OBJECT_USE_OBJC + dispatch_release(serverQueue); + dispatch_release(connectionQueue); + #endif + + [asyncSocket setDelegate:nil delegateQueue:NULL]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Server Configuration +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * The document root is filesystem root for the webserver. + * Thus requests for /index.html will be referencing the index.html file within the document root directory. + * All file requests are relative to this document root. +**/ +- (NSString *)documentRoot +{ + __block NSString *result; + + dispatch_sync(serverQueue, ^{ + result = documentRoot; + }); + + return result; +} + +- (void)setDocumentRoot:(NSString *)value +{ + HTTPLogTrace(); + + // Document root used to be of type NSURL. + // Add type checking for early warning to developers upgrading from older versions. + + if (value && ![value isKindOfClass:[NSString class]]) + { + HTTPLogWarn(@"%@: %@ - Expecting NSString parameter, received %@ parameter", + THIS_FILE, THIS_METHOD, NSStringFromClass([value class])); + return; + } + + NSString *valueCopy = [value copy]; + + dispatch_async(serverQueue, ^{ + documentRoot = valueCopy; + }); + +} + +/** + * The connection class is the class that will be used to handle connections. + * That is, when a new connection is created, an instance of this class will be intialized. + * The default connection class is HTTPConnection. + * If you use a different connection class, it is assumed that the class extends HTTPConnection +**/ +- (Class)connectionClass +{ + __block Class result; + + dispatch_sync(serverQueue, ^{ + result = connectionClass; + }); + + return result; +} + +- (void)setConnectionClass:(Class)value +{ + HTTPLogTrace(); + + dispatch_async(serverQueue, ^{ + connectionClass = value; + }); +} + +/** + * What interface to bind the listening socket to. +**/ +- (NSString *)interface +{ + __block NSString *result; + + dispatch_sync(serverQueue, ^{ + result = interface; + }); + + return result; +} + +- (void)setInterface:(NSString *)value +{ + NSString *valueCopy = [value copy]; + + dispatch_async(serverQueue, ^{ + interface = valueCopy; + }); + +} + +/** + * The port to listen for connections on. + * By default this port is initially set to zero, which allows the kernel to pick an available port for us. + * After the HTTP server has started, the port being used may be obtained by this method. +**/ +- (UInt16)port +{ + __block UInt16 result; + + dispatch_sync(serverQueue, ^{ + result = port; + }); + + return result; +} + +- (UInt16)listeningPort +{ + __block UInt16 result; + + dispatch_sync(serverQueue, ^{ + if (isRunning) + result = [asyncSocket localPort]; + else + result = 0; + }); + + return result; +} + +- (void)setPort:(UInt16)value +{ + HTTPLogTrace(); + + dispatch_async(serverQueue, ^{ + port = value; + }); +} + +/** + * Domain on which to broadcast this service via Bonjour. + * The default domain is @"local". +**/ +- (NSString *)domain +{ + __block NSString *result; + + dispatch_sync(serverQueue, ^{ + result = domain; + }); + + return result; +} + +- (void)setDomain:(NSString *)value +{ + HTTPLogTrace(); + + NSString *valueCopy = [value copy]; + + dispatch_async(serverQueue, ^{ + domain = valueCopy; + }); + +} + +/** + * The name to use for this service via Bonjour. + * The default name is an empty string, + * which should result in the published name being the host name of the computer. +**/ +- (NSString *)name +{ + __block NSString *result; + + dispatch_sync(serverQueue, ^{ + result = name; + }); + + return result; +} + +- (NSString *)publishedName +{ + __block NSString *result; + + dispatch_sync(serverQueue, ^{ + + if (netService == nil) + { + result = nil; + } + else + { + + dispatch_block_t bonjourBlock = ^{ + result = [[netService name] copy]; + }; + + [[self class] performBonjourBlock:bonjourBlock]; + } + }); + + return result; +} + +- (void)setName:(NSString *)value +{ + NSString *valueCopy = [value copy]; + + dispatch_async(serverQueue, ^{ + name = valueCopy; + }); + +} + +/** + * The type of service to publish via Bonjour. + * No type is set by default, and one must be set in order for the service to be published. +**/ +- (NSString *)type +{ + __block NSString *result; + + dispatch_sync(serverQueue, ^{ + result = type; + }); + + return result; +} + +- (void)setType:(NSString *)value +{ + NSString *valueCopy = [value copy]; + + dispatch_async(serverQueue, ^{ + type = valueCopy; + }); + +} + +/** + * The extra data to use for this service via Bonjour. +**/ +- (NSDictionary *)TXTRecordDictionary +{ + __block NSDictionary *result; + + dispatch_sync(serverQueue, ^{ + result = txtRecordDictionary; + }); + + return result; +} + +- (void)setTXTRecordDictionary:(NSDictionary *)value +{ + HTTPLogTrace(); + + NSDictionary *valueCopy = [value copy]; + + dispatch_async(serverQueue, ^{ + + txtRecordDictionary = valueCopy; + + // Update the txtRecord of the netService if it has already been published + if (netService) + { + NSNetService *theNetService = netService; + NSData *txtRecordData = nil; + if (txtRecordDictionary) + txtRecordData = [NSNetService dataFromTXTRecordDictionary:txtRecordDictionary]; + + dispatch_block_t bonjourBlock = ^{ + [theNetService setTXTRecordData:txtRecordData]; + }; + + [[self class] performBonjourBlock:bonjourBlock]; + } + }); + +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Server Control +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)start:(NSError **)errPtr +{ + HTTPLogTrace(); + + __block BOOL success = YES; + __block NSError *err = nil; + + dispatch_sync(serverQueue, ^{ @autoreleasepool { + + success = [asyncSocket acceptOnInterface:interface port:port error:&err]; + if (success) + { + HTTPLogInfo(@"%@: Started HTTP server on port %hu", THIS_FILE, [asyncSocket localPort]); + + isRunning = YES; + [self publishBonjour]; + } + else + { + HTTPLogError(@"%@: Failed to start HTTP Server: %@", THIS_FILE, err); + } + }}); + + if (errPtr) + *errPtr = err; + + return success; +} + +- (void)stop +{ + [self stop:NO]; +} + +- (void)stop:(BOOL)keepExistingConnections +{ + HTTPLogTrace(); + + dispatch_sync(serverQueue, ^{ @autoreleasepool { + + // First stop publishing the service via bonjour + [self unpublishBonjour]; + + // Stop listening / accepting incoming connections + [asyncSocket disconnect]; + isRunning = NO; + + if (!keepExistingConnections) + { + // Stop all HTTP connections the server owns + [connectionsLock lock]; + for (HTTPConnection *connection in connections) + { + [connection stop]; + } + [connections removeAllObjects]; + [connectionsLock unlock]; + + // Stop all WebSocket connections the server owns + [webSocketsLock lock]; + for (WebSocket *webSocket in webSockets) + { + [webSocket stop]; + } + [webSockets removeAllObjects]; + [webSocketsLock unlock]; + } + }}); +} + +- (BOOL)isRunning +{ + __block BOOL result; + + dispatch_sync(serverQueue, ^{ + result = isRunning; + }); + + return result; +} + +- (void)addWebSocket:(WebSocket *)ws +{ + [webSocketsLock lock]; + + HTTPLogTrace(); + [webSockets addObject:ws]; + + [webSocketsLock unlock]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Server Status +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns the number of http client connections that are currently connected to the server. +**/ +- (NSUInteger)numberOfHTTPConnections +{ + NSUInteger result = 0; + + [connectionsLock lock]; + result = [connections count]; + [connectionsLock unlock]; + + return result; +} + +/** + * Returns the number of websocket client connections that are currently connected to the server. +**/ +- (NSUInteger)numberOfWebSocketConnections +{ + NSUInteger result = 0; + + [webSocketsLock lock]; + result = [webSockets count]; + [webSocketsLock unlock]; + + return result; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Incoming Connections +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (HTTPConfig *)config +{ + // Override me if you want to provide a custom config to the new connection. + // + // Generally this involves overriding the HTTPConfig class to include any custom settings, + // and then having this method return an instance of 'MyHTTPConfig'. + + // Note: Think you can make the server faster by putting each connection on its own queue? + // Then benchmark it before and after and discover for yourself the shocking truth! + // + // Try the apache benchmark tool (already installed on your Mac): + // $ ab -n 1000 -c 1 http://localhost:/some_path.html + + return [[HTTPConfig alloc] initWithServer:self documentRoot:documentRoot queue:connectionQueue]; +} + +- (void)socket:(GCDAsyncSocket *)sock didAcceptNewSocket:(GCDAsyncSocket *)newSocket +{ + HTTPConnection *newConnection = (HTTPConnection *)[[connectionClass alloc] initWithAsyncSocket:newSocket + configuration:[self config]]; + [connectionsLock lock]; + [connections addObject:newConnection]; + [connectionsLock unlock]; + + [newConnection start]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Bonjour +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)publishBonjour +{ + HTTPLogTrace(); + + NSAssert(dispatch_get_specific(IsOnServerQueueKey) != NULL, @"Must be on serverQueue"); + + if (type) + { + netService = [[NSNetService alloc] initWithDomain:domain type:type name:name port:[asyncSocket localPort]]; + [netService setDelegate:self]; + + NSNetService *theNetService = netService; + NSData *txtRecordData = nil; + if (txtRecordDictionary) + txtRecordData = [NSNetService dataFromTXTRecordDictionary:txtRecordDictionary]; + + dispatch_block_t bonjourBlock = ^{ + + [theNetService removeFromRunLoop:[NSRunLoop mainRunLoop] forMode:NSRunLoopCommonModes]; + [theNetService scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSRunLoopCommonModes]; + [theNetService publish]; + + // Do not set the txtRecordDictionary prior to publishing!!! + // This will cause the OS to crash!!! + if (txtRecordData) + { + [theNetService setTXTRecordData:txtRecordData]; + } + }; + + [[self class] startBonjourThreadIfNeeded]; + [[self class] performBonjourBlock:bonjourBlock]; + } +} + +- (void)unpublishBonjour +{ + HTTPLogTrace(); + + NSAssert(dispatch_get_specific(IsOnServerQueueKey) != NULL, @"Must be on serverQueue"); + + if (netService) + { + NSNetService *theNetService = netService; + + dispatch_block_t bonjourBlock = ^{ + + [theNetService stop]; + }; + + [[self class] performBonjourBlock:bonjourBlock]; + + netService = nil; + } +} + +/** + * Republishes the service via bonjour if the server is running. + * If the service was not previously published, this method will publish it (if the server is running). +**/ +- (void)republishBonjour +{ + HTTPLogTrace(); + + dispatch_async(serverQueue, ^{ + + [self unpublishBonjour]; + [self publishBonjour]; + }); +} + +/** + * Called when our bonjour service has been successfully published. + * This method does nothing but output a log message telling us about the published service. +**/ +- (void)netServiceDidPublish:(NSNetService *)ns +{ + // Override me to do something here... + // + // Note: This method is invoked on our bonjour thread. + + HTTPLogInfo(@"Bonjour Service Published: domain(%@) type(%@) name(%@)", [ns domain], [ns type], [ns name]); +} + +/** + * Called if our bonjour service failed to publish itself. + * This method does nothing but output a log message telling us about the published service. +**/ +- (void)netService:(NSNetService *)ns didNotPublish:(NSDictionary *)errorDict +{ + // Override me to do something here... + // + // Note: This method in invoked on our bonjour thread. + + HTTPLogWarn(@"Failed to Publish Service: domain(%@) type(%@) name(%@) - %@", + [ns domain], [ns type], [ns name], errorDict); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Notifications +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method is automatically called when a notification of type HTTPConnectionDidDieNotification is posted. + * It allows us to remove the connection from our array. +**/ +- (void)connectionDidDie:(NSNotification *)notification +{ + // Note: This method is called on the connection queue that posted the notification + + [connectionsLock lock]; + + HTTPLogTrace(); + [connections removeObject:[notification object]]; + + [connectionsLock unlock]; +} + +/** + * This method is automatically called when a notification of type WebSocketDidDieNotification is posted. + * It allows us to remove the websocket from our array. +**/ +- (void)webSocketDidDie:(NSNotification *)notification +{ + // Note: This method is called on the connection queue that posted the notification + + [webSocketsLock lock]; + + HTTPLogTrace(); + [webSockets removeObject:[notification object]]; + + [webSocketsLock unlock]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Bonjour Thread +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * NSNetService is runloop based, so it requires a thread with a runloop. + * This gives us two options: + * + * - Use the main thread + * - Setup our own dedicated thread + * + * Since we have various blocks of code that need to synchronously access the netservice objects, + * using the main thread becomes troublesome and a potential for deadlock. +**/ + +static NSThread *bonjourThread; + ++ (void)startBonjourThreadIfNeeded +{ + HTTPLogTrace(); + + static dispatch_once_t predicate; + dispatch_once(&predicate, ^{ + + HTTPLogVerbose(@"%@: Starting bonjour thread...", THIS_FILE); + + bonjourThread = [[NSThread alloc] initWithTarget:self + selector:@selector(bonjourThread) + object:nil]; + [bonjourThread start]; + }); +} + ++ (void)bonjourThread +{ + @autoreleasepool { + + HTTPLogVerbose(@"%@: BonjourThread: Started", THIS_FILE); + + // We can't run the run loop unless it has an associated input source or a timer. + // So we'll just create a timer that will never fire - unless the server runs for 10,000 years. +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wundeclared-selector" + [NSTimer scheduledTimerWithTimeInterval:[[NSDate distantFuture] timeIntervalSinceNow] + target:self + selector:@selector(donothingatall:) + userInfo:nil + repeats:YES]; +#pragma clang diagnostic pop + + [[NSRunLoop currentRunLoop] run]; + + HTTPLogVerbose(@"%@: BonjourThread: Aborted", THIS_FILE); + + } +} + ++ (void)executeBonjourBlock:(dispatch_block_t)block +{ + HTTPLogTrace(); + + NSAssert([NSThread currentThread] == bonjourThread, @"Executed on incorrect thread"); + + block(); +} + ++ (void)performBonjourBlock:(dispatch_block_t)block +{ + HTTPLogTrace(); + + [self performSelector:@selector(executeBonjourBlock:) + onThread:bonjourThread + withObject:block + waitUntilDone:YES]; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.h b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.h new file mode 100644 index 00000000000..ac0e8ab2e88 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.h @@ -0,0 +1,65 @@ + +#import "MultipartMessageHeader.h" + +/* +Part one: http://tools.ietf.org/html/rfc2045 (Format of Internet Message Bodies) +Part two: http://tools.ietf.org/html/rfc2046 (Media Types) +Part three: http://tools.ietf.org/html/rfc2047 (Message Header Extensions for Non-ASCII Text) +Part four: http://tools.ietf.org/html/rfc4289 (Registration Procedures) +Part five: http://tools.ietf.org/html/rfc2049 (Conformance Criteria and Examples) + +Internet message format: http://tools.ietf.org/html/rfc2822 + +Multipart/form-data http://tools.ietf.org/html/rfc2388 +*/ + +@class MultipartFormDataParser; + +//----------------------------------------------------------------- +// protocol MultipartFormDataParser +//----------------------------------------------------------------- + +@protocol MultipartFormDataParserDelegate +@optional +- (void) processContent:(NSData*) data WithHeader:(MultipartMessageHeader*) header; +- (void) processEndOfPartWithHeader:(MultipartMessageHeader*) header; +- (void) processPreambleData:(NSData*) data; +- (void) processEpilogueData:(NSData*) data; +- (void) processStartOfPartWithHeader:(MultipartMessageHeader*) header; +@end + +//----------------------------------------------------------------- +// interface MultipartFormDataParser +//----------------------------------------------------------------- + +@interface MultipartFormDataParser : NSObject { +NSMutableData* pendingData; + NSData* boundaryData; + MultipartMessageHeader* currentHeader; + + BOOL waitingForCRLF; + BOOL reachedEpilogue; + BOOL processedPreamble; + BOOL checkForContentEnd; + +#if __has_feature(objc_arc_weak) + __weak id delegate; +#else + __unsafe_unretained id delegate; +#endif + int currentEncoding; + NSStringEncoding formEncoding; +} + +- (BOOL) appendData:(NSData*) data; + +- (id) initWithBoundary:(NSString*) boundary formEncoding:(NSStringEncoding) formEncoding; + +#if __has_feature(objc_arc_weak) + @property(weak, readwrite) id delegate; +#else + @property(unsafe_unretained, readwrite) id delegate; +#endif +@property(readwrite) NSStringEncoding formEncoding; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.m b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.m new file mode 100644 index 00000000000..4a19aee5b2c --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartFormDataParser.m @@ -0,0 +1,529 @@ + +#import "MultipartFormDataParser.h" +#import "DDData.h" +#import "HTTPLogging.h" + +#pragma mark log level + +#ifdef DEBUG +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; +#else +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; +#endif + +#ifdef __x86_64__ +#define FMTNSINT "li" +#else +#define FMTNSINT "i" +#endif + + +//----------------------------------------------------------------- +// interface MultipartFormDataParser (private) +//----------------------------------------------------------------- + + +@interface MultipartFormDataParser (private) ++ (NSData*) decodedDataFromData:(NSData*) data encoding:(int) encoding; + +- (int) findHeaderEnd:(NSData*) workingData fromOffset:(int) offset; +- (int) findContentEnd:(NSData*) data fromOffset:(int) offset; + +- (int) numberOfBytesToLeavePendingWithData:(NSData*) data length:(NSUInteger) length encoding:(int) encoding; +- (int) offsetTillNewlineSinceOffset:(int) offset inData:(NSData*) data; + +- (int) processPreamble:(NSData*) workingData; + +@end + + +//----------------------------------------------------------------- +// implementation MultipartFormDataParser +//----------------------------------------------------------------- + + +@implementation MultipartFormDataParser +@synthesize delegate,formEncoding; + +- (id) initWithBoundary:(NSString*) boundary formEncoding:(NSStringEncoding) _formEncoding { + if( nil == (self = [super init]) ){ + return self; + } + if( nil == boundary ) { + HTTPLogWarn(@"MultipartFormDataParser: init with zero boundary"); + return nil; + } + boundaryData = [[@"\r\n--" stringByAppendingString:boundary] dataUsingEncoding:NSASCIIStringEncoding]; + + pendingData = [[NSMutableData alloc] init]; + currentEncoding = contentTransferEncoding_binary; + currentHeader = nil; + + formEncoding = _formEncoding; + reachedEpilogue = NO; + processedPreamble = NO; + + return self; +} + + +- (BOOL) appendData:(NSData *)data { + // Can't parse without boundary; + if( nil == boundaryData ) { + HTTPLogError(@"MultipartFormDataParser: Trying to parse multipart without specifying a valid boundary"); + assert(false); + return NO; + } + NSData* workingData = data; + + if( pendingData.length ) { + [pendingData appendData:data]; + workingData = pendingData; + } + + // the parser saves parse stat in the offset variable, which indicates offset of unhandled part in + // currently received chunk. Before returning, we always drop all data up to offset, leaving + // only unhandled for the next call + + int offset = 0; + + // don't parse data unless its size is greater then boundary length, so we couldn't + // misfind the boundary, if it got split into different data chunks + NSUInteger sizeToLeavePending = boundaryData.length; + + if( !reachedEpilogue && workingData.length <= sizeToLeavePending ) { + // not enough data even to start parsing. + // save to pending data. + if( !pendingData.length ) { + [pendingData appendData:data]; + } + if( checkForContentEnd ) { + if( pendingData.length >= 2 ) { + if( *(uint16_t*)(pendingData.bytes + offset) == 0x2D2D ) { + // we found the multipart end. all coming next is an epilogue. + HTTPLogVerbose(@"MultipartFormDataParser: End of multipart message"); + waitingForCRLF = YES; + reachedEpilogue = YES; + offset+= 2; + } + else { + checkForContentEnd = NO; + waitingForCRLF = YES; + return YES; + } + } else { + return YES; + } + + } + else { + return YES; + } + } + while( true ) { + if( checkForContentEnd ) { + // the flag will be raised to check if the last part was the last one. + if( offset < workingData.length -1 ) { + char* bytes = (char*) workingData.bytes; + if( *(uint16_t*)(bytes + offset) == 0x2D2D ) { + // we found the multipart end. all coming next is an epilogue. + HTTPLogVerbose(@"MultipartFormDataParser: End of multipart message"); + checkForContentEnd = NO; + reachedEpilogue = YES; + // still wait for CRLF, that comes after boundary, but before epilogue. + waitingForCRLF = YES; + offset += 2; + } + else { + // it's not content end, we have to wait till separator line end before next part comes + waitingForCRLF = YES; + checkForContentEnd = NO; + } + } + else { + // we haven't got enough data to check for content end. + // save current unhandled data (it may be 1 byte) to pending and recheck on next chunk received + if( offset < workingData.length ) { + [pendingData setData:[NSData dataWithBytes:workingData.bytes + workingData.length-1 length:1]]; + } + else { + // there is no unhandled data now, wait for more chunks + [pendingData setData:[NSData data]]; + } + return YES; + } + } + if( waitingForCRLF ) { + + // the flag will be raised in the code below, meaning, we've read the boundary, but + // didnt find the end of boundary line yet. + + offset = [self offsetTillNewlineSinceOffset:offset inData:workingData]; + if( -1 == offset ) { + // didnt find the endl again. + if( offset ) { + // we still have to save the unhandled data (maybe it's 1 byte CR) + if( *((char*)workingData.bytes + workingData.length -1) == '\r' ) { + [pendingData setData:[NSData dataWithBytes:workingData.bytes + workingData.length-1 length:1]]; + } + else { + // or save nothing if it wasnt + [pendingData setData:[NSData data]]; + } + } + return YES; + } + waitingForCRLF = NO; + } + if( !processedPreamble ) { + // got to find the first boundary before the actual content begins. + offset = [self processPreamble:workingData]; + // wait for more data for preamble + if( -1 == offset ) + return YES; + // invoke continue to skip newline after boundary. + continue; + } + + if( reachedEpilogue ) { + // parse all epilogue data to delegate. + if( [delegate respondsToSelector:@selector(processEpilogueData:)] ) { + NSData* epilogueData = [NSData dataWithBytesNoCopy: (char*) workingData.bytes + offset length: workingData.length - offset freeWhenDone:NO]; + [delegate processEpilogueData: epilogueData]; + } + return YES; + } + + if( nil == currentHeader ) { + // nil == currentHeader is a state flag, indicating we are waiting for header now. + // whenever part is over, currentHeader is set to nil. + + // try to find CRLFCRLF bytes in the data, which indicates header end. + // we won't parse header parts, as they won't be too large. + int headerEnd = [self findHeaderEnd:workingData fromOffset:offset]; + if( -1 == headerEnd ) { + // didn't recieve the full header yet. + if( !pendingData.length) { + // store the unprocessed data till next chunks come + [pendingData appendBytes:data.bytes + offset length:data.length - offset]; + } + else { + if( offset ) { + // save the current parse state; drop all handled data and save unhandled only. + pendingData = [[NSMutableData alloc] initWithBytes: (char*) workingData.bytes + offset length:workingData.length - offset]; + } + } + return YES; + } + else { + + // let the header parser do it's job from now on. + NSData * headerData = [NSData dataWithBytesNoCopy: (char*) workingData.bytes + offset length:headerEnd + 2 - offset freeWhenDone:NO]; + currentHeader = [[MultipartMessageHeader alloc] initWithData:headerData formEncoding:formEncoding]; + + if( nil == currentHeader ) { + // we've found the data is in wrong format. + HTTPLogError(@"MultipartFormDataParser: MultipartFormDataParser: wrong input format, coulnd't get a valid header"); + return NO; + } + if( [delegate respondsToSelector:@selector(processStartOfPartWithHeader:)] ) { + [delegate processStartOfPartWithHeader:currentHeader]; + } + + HTTPLogVerbose(@"MultipartFormDataParser: MultipartFormDataParser: Retrieved part header."); + } + // skip the two trailing \r\n, in addition to the whole header. + offset = headerEnd + 4; + } + // after we've got the header, we try to + // find the boundary in the data. + int contentEnd = [self findContentEnd:workingData fromOffset:offset]; + + if( contentEnd == -1 ) { + + // this case, we didn't find the boundary, so the data is related to the current part. + // we leave the sizeToLeavePending amount of bytes to make sure we don't include + // boundary part in processed data. + NSUInteger sizeToPass = workingData.length - offset - sizeToLeavePending; + + // if we parse BASE64 encoded data, or Quoted-Printable data, we will make sure we don't break the format + int leaveTrailing = [self numberOfBytesToLeavePendingWithData:data length:sizeToPass encoding:currentEncoding]; + sizeToPass -= leaveTrailing; + + if( sizeToPass <= 0 ) { + // wait for more data! + if( offset ) { + [pendingData setData:[NSData dataWithBytes:(char*) workingData.bytes + offset length:workingData.length - offset]]; + } + return YES; + } + // decode the chunk and let the delegate use it (store in a file, for example) + NSData* decodedData = [MultipartFormDataParser decodedDataFromData:[NSData dataWithBytesNoCopy:(char*)workingData.bytes + offset length:workingData.length - offset - sizeToLeavePending freeWhenDone:NO] encoding:currentEncoding]; + + if( [delegate respondsToSelector:@selector(processContent:WithHeader:)] ) { + HTTPLogVerbose(@"MultipartFormDataParser: Processed %"FMTNSINT" bytes of body",sizeToPass); + + [delegate processContent: decodedData WithHeader:currentHeader]; + } + + // store the unprocessed data till the next chunks come. + [pendingData setData:[NSData dataWithBytes:(char*)workingData.bytes + workingData.length - sizeToLeavePending length:sizeToLeavePending]]; + return YES; + } + else { + + // Here we found the boundary. + // let the delegate process it, and continue going to the next parts. + if( [delegate respondsToSelector:@selector(processContent:WithHeader:)] ) { + [delegate processContent:[NSData dataWithBytesNoCopy:(char*) workingData.bytes + offset length:contentEnd - offset freeWhenDone:NO] WithHeader:currentHeader]; + } + + if( [delegate respondsToSelector:@selector(processEndOfPartWithHeader:)] ){ + [delegate processEndOfPartWithHeader:currentHeader]; + HTTPLogVerbose(@"MultipartFormDataParser: End of body part"); + } + currentHeader = nil; + + // set up offset to continue with the remaining data (if any) + // cast to int because above comment suggests a small number + offset = contentEnd + (int)boundaryData.length; + checkForContentEnd = YES; + // setting the flag tells the parser to skip all the data till CRLF + } + } + return YES; +} + + +//----------------------------------------------------------------- +#pragma mark private methods + +- (int) offsetTillNewlineSinceOffset:(int) offset inData:(NSData*) data { + char* bytes = (char*) data.bytes; + NSUInteger length = data.length; + if( offset >= length - 1 ) + return -1; + + while ( *(uint16_t*)(bytes + offset) != 0x0A0D ) { + // find the trailing \r\n after the boundary. The boundary line might have any number of whitespaces before CRLF, according to rfc2046 + + // in debug, we might also want to know, if the file is somehow misformatted. +#ifdef DEBUG + if( !isspace(*(bytes+offset)) ) { + HTTPLogWarn(@"MultipartFormDataParser: Warning, non-whitespace character '%c' between boundary bytes and CRLF in boundary line",*(bytes+offset) ); + } + if( !isspace(*(bytes+offset+1)) ) { + HTTPLogWarn(@"MultipartFormDataParser: Warning, non-whitespace character '%c' between boundary bytes and CRLF in boundary line",*(bytes+offset+1) ); + } +#endif + offset++; + if( offset >= length ) { + // no endl found within current data + return -1; + } + } + + offset += 2; + return offset; +} + + +- (int) processPreamble:(NSData*) data { + int offset = 0; + + char* boundaryBytes = (char*) boundaryData.bytes + 2; // the first boundary won't have CRLF preceding. + char* dataBytes = (char*) data.bytes; + NSUInteger boundaryLength = boundaryData.length - 2; + NSUInteger dataLength = data.length; + + // find the boundary without leading CRLF. + while( offset < dataLength - boundaryLength +1 ) { + int i; + for( i = 0;i < boundaryLength; i++ ) { + if( boundaryBytes[i] != dataBytes[offset + i] ) + break; + } + if( i == boundaryLength ) { + break; + } + offset++; + } + + if( offset == dataLength ) { + // the end of preamble wasn't found in this chunk + NSUInteger sizeToProcess = dataLength - boundaryLength; + if( sizeToProcess > 0) { + if( [delegate respondsToSelector:@selector(processPreambleData:)] ) { + NSData* preambleData = [NSData dataWithBytesNoCopy: (char*) data.bytes length: data.length - offset - boundaryLength freeWhenDone:NO]; + [delegate processPreambleData:preambleData]; + HTTPLogVerbose(@"MultipartFormDataParser: processed preamble"); + } + pendingData = [NSMutableData dataWithBytes: data.bytes + data.length - boundaryLength length:boundaryLength]; + } + return -1; + } + else { + if ( offset && [delegate respondsToSelector:@selector(processPreambleData:)] ) { + NSData* preambleData = [NSData dataWithBytesNoCopy: (char*) data.bytes length: offset freeWhenDone:NO]; + [delegate processPreambleData:preambleData]; + } + offset +=boundaryLength; + // tells to skip CRLF after the boundary. + processedPreamble = YES; + waitingForCRLF = YES; + } + return offset; +} + + + +- (int) findHeaderEnd:(NSData*) workingData fromOffset:(int)offset { + char* bytes = (char*) workingData.bytes; + NSUInteger inputLength = workingData.length; + uint16_t separatorBytes = 0x0A0D; + + while( true ) { + if(inputLength < offset + 3 ) { + // wait for more data + return -1; + } + if( (*((uint16_t*) (bytes+offset)) == separatorBytes) && (*((uint16_t*) (bytes+offset)+1) == separatorBytes) ) { + return offset; + } + offset++; + } + return -1; +} + + +- (int) findContentEnd:(NSData*) data fromOffset:(int) offset { + char* boundaryBytes = (char*) boundaryData.bytes; + char* dataBytes = (char*) data.bytes; + NSUInteger boundaryLength = boundaryData.length; + NSUInteger dataLength = data.length; + + while( offset < dataLength - boundaryLength +1 ) { + int i; + for( i = 0;i < boundaryLength; i++ ) { + if( boundaryBytes[i] != dataBytes[offset + i] ) + break; + } + if( i == boundaryLength ) { + return offset; + } + offset++; + } + return -1; +} + + +- (int) numberOfBytesToLeavePendingWithData:(NSData*) data length:(int) length encoding:(int) encoding { + // If we have BASE64 or Quoted-Printable encoded data, we have to be sure + // we don't break the format. + int sizeToLeavePending = 0; + + if( encoding == contentTransferEncoding_base64 ) { + char* bytes = (char*) data.bytes; + int i; + for( i = length - 1; i > 0; i++ ) { + if( * (uint16_t*) (bytes + i) == 0x0A0D ) { + break; + } + } + // now we've got to be sure that the length of passed data since last line + // is multiplier of 4. + sizeToLeavePending = (length - i) & ~0x11; // size to leave pending = length-i - (length-i) %4; + return sizeToLeavePending; + } + + if( encoding == contentTransferEncoding_quotedPrintable ) { + // we don't pass more less then 3 bytes anyway. + if( length <= 2 ) + return length; + // check the last bytes to be start of encoded symbol. + const char* bytes = data.bytes + length - 2; + if( bytes[0] == '=' ) + return 2; + if( bytes[1] == '=' ) + return 1; + return 0; + } + return 0; +} + + +//----------------------------------------------------------------- +#pragma mark decoding + + ++ (NSData*) decodedDataFromData:(NSData*) data encoding:(int) encoding { + switch (encoding) { + case contentTransferEncoding_base64: { + return [data base64Decoded]; + } break; + + case contentTransferEncoding_quotedPrintable: { + return [self decodedDataFromQuotedPrintableData:data]; + } break; + + default: { + return data; + } break; + } +} + + ++ (NSData*) decodedDataFromQuotedPrintableData:(NSData *)data { +// http://tools.ietf.org/html/rfc2045#section-6.7 + + const char hex [] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', }; + + NSMutableData* result = [[NSMutableData alloc] initWithLength:data.length]; + const char* bytes = (const char*) data.bytes; + int count = 0; + NSUInteger length = data.length; + while( count < length ) { + if( bytes[count] == '=' ) { + [result appendBytes:bytes length:count]; + bytes = bytes + count + 1; + length -= count + 1; + count = 0; + + if( length < 3 ) { + HTTPLogWarn(@"MultipartFormDataParser: warning, trailing '=' in quoted printable data"); + } + // soft newline + if( bytes[0] == '\r' ) { + bytes += 1; + if(bytes[1] == '\n' ) { + bytes += 2; + } + continue; + } + char encodedByte = 0; + + for( int i = 0; i < sizeof(hex); i++ ) { + if( hex[i] == bytes[0] ) { + encodedByte += i << 4; + } + if( hex[i] == bytes[1] ) { + encodedByte += i; + } + } + [result appendBytes:&encodedByte length:1]; + bytes += 2; + } + +#ifdef DEBUG + if( (unsigned char) bytes[count] > 126 ) { + HTTPLogWarn(@"MultipartFormDataParser: Warning, character with code above 126 appears in quoted printable encoded data"); + } +#endif + + count++; + } + return result; +} + + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.h b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.h new file mode 100644 index 00000000000..4d10f96e480 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.h @@ -0,0 +1,33 @@ +// +// MultipartMessagePart.h +// HttpServer +// +// Created by Валерий Гаврилов on 29.03.12. +// Copyright (c) 2012 LLC "Online Publishing Partners" (onlinepp.ru). All rights reserved. +// + +#import + + +//----------------------------------------------------------------- +// interface MultipartMessageHeader +//----------------------------------------------------------------- +enum { + contentTransferEncoding_unknown, + contentTransferEncoding_7bit, + contentTransferEncoding_8bit, + contentTransferEncoding_binary, + contentTransferEncoding_base64, + contentTransferEncoding_quotedPrintable, +}; + +@interface MultipartMessageHeader : NSObject { + NSMutableDictionary* fields; + int encoding; + NSString* contentDispositionName; +} +@property (strong,readonly) NSDictionary* fields; +@property (readonly) int encoding; + +- (id) initWithData:(NSData*) data formEncoding:(NSStringEncoding) encoding; +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.m b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.m new file mode 100644 index 00000000000..9d91d469494 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeader.m @@ -0,0 +1,86 @@ +// +// MultipartMessagePart.m +// HttpServer +// +// Created by Валерий Гаврилов on 29.03.12. +// Copyright (c) 2012 LLC "Online Publishing Partners" (onlinepp.ru). All rights reserved. + +#import "MultipartMessageHeader.h" +#import "MultipartMessageHeaderField.h" + +#import "HTTPLogging.h" + +//----------------------------------------------------------------- +#pragma mark log level + +#ifdef DEBUG +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; +#else +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; +#endif + +//----------------------------------------------------------------- +// implementation MultipartMessageHeader +//----------------------------------------------------------------- + + +@implementation MultipartMessageHeader +@synthesize fields,encoding; + + +- (id) initWithData:(NSData *)data formEncoding:(NSStringEncoding) formEncoding { + if( nil == (self = [super init]) ) { + return self; + } + + fields = [[NSMutableDictionary alloc] initWithCapacity:1]; + + // In case encoding is not mentioned, + encoding = contentTransferEncoding_unknown; + + char* bytes = (char*)data.bytes; + NSUInteger length = data.length; + int offset = 0; + + // split header into header fields, separated by \r\n + uint16_t fields_separator = 0x0A0D; // \r\n + while( offset < length - 2 ) { + + // the !isspace condition is to support header unfolding + if( (*(uint16_t*) (bytes+offset) == fields_separator) && ((offset == length - 2) || !(isspace(bytes[offset+2])) )) { + NSData* fieldData = [NSData dataWithBytesNoCopy:bytes length:offset freeWhenDone:NO]; + MultipartMessageHeaderField* field = [[MultipartMessageHeaderField alloc] initWithData: fieldData contentEncoding:formEncoding]; + if( field ) { + [fields setObject:field forKey:field.name]; + HTTPLogVerbose(@"MultipartFormDataParser: Processed Header field '%@'",field.name); + } + else { + NSString* fieldStr = [[NSString alloc] initWithData:fieldData encoding:NSASCIIStringEncoding]; + HTTPLogWarn(@"MultipartFormDataParser: Failed to parse MIME header field. Input ASCII string:%@",fieldStr); + } + + // move to the next header field + bytes += offset + 2; + length -= offset + 2; + offset = 0; + continue; + } + ++ offset; + } + + if( !fields.count ) { + // it was an empty header. + // we have to set default values. + // default header. + [fields setObject:@"text/plain" forKey:@"Content-Type"]; + } + + return self; +} + +- (NSString *)description { + return [NSString stringWithFormat:@"%@",fields]; +} + + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.h b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.h new file mode 100644 index 00000000000..69a4a0763c9 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.h @@ -0,0 +1,23 @@ + +#import + +//----------------------------------------------------------------- +// interface MultipartMessageHeaderField +//----------------------------------------------------------------- + +@interface MultipartMessageHeaderField : NSObject { + NSString* name; + NSString* value; + NSMutableDictionary* params; +} + +@property (strong, readonly) NSString* value; +@property (strong, readonly) NSDictionary* params; +@property (strong, readonly) NSString* name; + +//- (id) initWithLine:(NSString*) line; +//- (id) initWithName:(NSString*) paramName value:(NSString*) paramValue; + +- (id) initWithData:(NSData*) data contentEncoding:(NSStringEncoding) encoding; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.m b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.m new file mode 100644 index 00000000000..00ecac84036 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Mime/MultipartMessageHeaderField.m @@ -0,0 +1,211 @@ + +#import "MultipartMessageHeaderField.h" +#import "HTTPLogging.h" + +//----------------------------------------------------------------- +#pragma mark log level + +#ifdef DEBUG +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; +#else +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; +#endif + + +// helpers +int findChar(const char* str,NSUInteger length, char c); +NSString* extractParamValue(const char* bytes, NSUInteger length, NSStringEncoding encoding); + +//----------------------------------------------------------------- +// interface MultipartMessageHeaderField (private) +//----------------------------------------------------------------- + + +@interface MultipartMessageHeaderField (private) +-(BOOL) parseHeaderValueBytes:(char*) bytes length:(NSUInteger) length encoding:(NSStringEncoding) encoding; +@end + + +//----------------------------------------------------------------- +// implementation MultipartMessageHeaderField +//----------------------------------------------------------------- + +@implementation MultipartMessageHeaderField +@synthesize name,value,params; + +- (id) initWithData:(NSData *)data contentEncoding:(NSStringEncoding)encoding { + params = [[NSMutableDictionary alloc] initWithCapacity:1]; + + char* bytes = (char*)data.bytes; + NSUInteger length = data.length; + + int separatorOffset = findChar(bytes, length, ':'); + if( (-1 == separatorOffset) || (separatorOffset >= length-2) ) { + HTTPLogError(@"MultipartFormDataParser: Bad format.No colon in field header."); + // tear down + return nil; + } + + // header name is always ascii encoded; + name = [[NSString alloc] initWithBytes: bytes length: separatorOffset encoding: NSASCIIStringEncoding]; + if( nil == name ) { + HTTPLogError(@"MultipartFormDataParser: Bad MIME header name."); + // tear down + return nil; + } + + // skip the separator and the next ' ' symbol + bytes += separatorOffset + 2; + length -= separatorOffset + 2; + + separatorOffset = findChar(bytes, length, ';'); + if( separatorOffset == -1 ) { + // couldn't find ';', means we don't have extra params here. + value = [[NSString alloc] initWithBytes:bytes length: length encoding:encoding]; + + if( nil == value ) { + HTTPLogError(@"MultipartFormDataParser: Bad MIME header value for header name: '%@'",name); + // tear down + return nil; + } + return self; + } + + value = [[NSString alloc] initWithBytes:bytes length: separatorOffset encoding:encoding]; + HTTPLogVerbose(@"MultipartFormDataParser: Processing header field '%@' : '%@'",name,value); + // skipe the separator and the next ' ' symbol + bytes += separatorOffset + 2; + length -= separatorOffset + 2; + + // parse the "params" part of the header + if( ![self parseHeaderValueBytes:bytes length:length encoding:encoding] ) { + NSString* paramsStr = [[NSString alloc] initWithBytes:bytes length:length encoding:NSASCIIStringEncoding]; + HTTPLogError(@"MultipartFormDataParser: Bad params for header with name '%@' and value '%@'",name,value); + HTTPLogError(@"MultipartFormDataParser: Params str: %@",paramsStr); + + return nil; + } + return self; +} + +-(BOOL) parseHeaderValueBytes:(char*) bytes length:(NSUInteger) length encoding:(NSStringEncoding) encoding { + int offset = 0; + NSString* currentParam = nil; + BOOL insideQuote = NO; + while( offset < length ) { + if( bytes[offset] == '\"' ) { + if( !offset || bytes[offset-1] != '\\' ) { + insideQuote = !insideQuote; + } + } + + // skip quoted symbols + if( insideQuote ) { + ++ offset; + continue; + } + if( bytes[offset] == '=' ) { + if( currentParam ) { + // found '=' before terminating previous param. + return NO; + } + currentParam = [[NSString alloc] initWithBytes:bytes length:offset encoding:NSASCIIStringEncoding]; + + bytes+=offset + 1; + length -= offset + 1; + offset = 0; + continue; + } + if( bytes[offset] == ';' ) { + if( !currentParam ) { + // found ; before stating '='. + HTTPLogError(@"MultipartFormDataParser: Unexpected ';' when parsing header"); + return NO; + } + NSString* paramValue = extractParamValue(bytes, offset,encoding); + if( nil == paramValue ) { + HTTPLogWarn(@"MultipartFormDataParser: Failed to exctract paramValue for key %@ in header %@",currentParam,name); + } + else { +#ifdef DEBUG + if( [params objectForKey:currentParam] ) { + HTTPLogWarn(@"MultipartFormDataParser: param %@ mentioned more then once in header %@",currentParam,name); + } +#endif + [params setObject:paramValue forKey:currentParam]; + HTTPLogVerbose(@"MultipartFormDataParser: header param: %@ = %@",currentParam,paramValue); + } + + currentParam = nil; + + // ';' separator has ' ' following, skip them. + bytes+=offset + 2; + length -= offset + 2; + offset = 0; + } + ++ offset; + } + + // add last param + if( insideQuote ) { + HTTPLogWarn(@"MultipartFormDataParser: unterminated quote in header %@",name); +// return YES; + } + if( currentParam ) { + NSString* paramValue = extractParamValue(bytes, length, encoding); + + if( nil == paramValue ) { + HTTPLogError(@"MultipartFormDataParser: Failed to exctract paramValue for key %@ in header %@",currentParam,name); + } + +#ifdef DEBUG + if( [params objectForKey:currentParam] ) { + HTTPLogWarn(@"MultipartFormDataParser: param %@ mentioned more then once in one header",currentParam); + } +#endif + [params setObject:paramValue forKey:currentParam]; + HTTPLogVerbose(@"MultipartFormDataParser: header param: %@ = %@",currentParam,paramValue); + currentParam = nil; + } + + return YES; +} + +- (NSString *)description { + return [NSString stringWithFormat:@"%@:%@\n params: %@",name,value,params]; +} + +@end + +int findChar(const char* str, NSUInteger length, char c) { + int offset = 0; + while( offset < length ) { + if( str[offset] == c ) + return offset; + ++ offset; + } + return -1; +} + +NSString* extractParamValue(const char* bytes, NSUInteger length, NSStringEncoding encoding) { + if( !length ) + return nil; + NSMutableString* value = nil; + + if( bytes[0] == '"' ) { + // values may be quoted. Strip the quotes to get what we need. + value = [[NSMutableString alloc] initWithBytes:bytes + 1 length: length - 2 encoding:encoding]; + } + else { + value = [[NSMutableString alloc] initWithBytes:bytes length: length encoding:encoding]; + } + // restore escaped symbols + NSRange range= [value rangeOfString:@"\\"]; + while ( range.length ) { + [value deleteCharactersInRange:range]; + range.location ++; + range = [value rangeOfString:@"\\" options:NSLiteralSearch range: range]; + } + return value; +} + diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.h b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.h new file mode 100644 index 00000000000..fd60ea83982 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.h @@ -0,0 +1,75 @@ +#import +#import "HTTPResponse.h" + +@class HTTPConnection; + +/** + * This is an asynchronous version of HTTPFileResponse. + * It reads data from the given file asynchronously via GCD. + * + * It may be overriden to allow custom post-processing of the data that has been read from the file. + * An example of this is the HTTPDynamicFileResponse class. +**/ + +@interface HTTPAsyncFileResponse : NSObject +{ + HTTPConnection *connection; + + NSString *filePath; + UInt64 fileLength; + UInt64 fileOffset; // File offset as pertains to data given to connection + UInt64 readOffset; // File offset as pertains to data read from file (but maybe not returned to connection) + + BOOL aborted; + + NSData *data; + + int fileFD; + void *readBuffer; + NSUInteger readBufferSize; // Malloced size of readBuffer + NSUInteger readBufferOffset; // Offset within readBuffer where the end of existing data is + NSUInteger readRequestLength; + dispatch_queue_t readQueue; + dispatch_source_t readSource; + BOOL readSourceSuspended; +} + +- (id)initWithFilePath:(NSString *)filePath forConnection:(HTTPConnection *)connection; +- (NSString *)filePath; + +@end + +/** + * Explanation of Variables (excluding those that are obvious) + * + * fileOffset + * This is the number of bytes that have been returned to the connection via the readDataOfLength method. + * If 1KB of data has been read from the file, but none of that data has yet been returned to the connection, + * then the fileOffset variable remains at zero. + * This variable is used in the calculation of the isDone method. + * Only after all data has been returned to the connection are we actually done. + * + * readOffset + * Represents the offset of the file descriptor. + * In other words, the file position indidcator for our read stream. + * It might be easy to think of it as the total number of bytes that have been read from the file. + * However, this isn't entirely accurate, as the setOffset: method may have caused us to + * jump ahead in the file (lseek). + * + * readBuffer + * Malloc'd buffer to hold data read from the file. + * + * readBufferSize + * Total allocation size of malloc'd buffer. + * + * readBufferOffset + * Represents the position in the readBuffer where we should store new bytes. + * + * readRequestLength + * The total number of bytes that were requested from the connection. + * It's OK if we return a lesser number of bytes to the connection. + * It's NOT OK if we return a greater number of bytes to the connection. + * Doing so would disrupt proper support for range requests. + * If, however, the response is chunked then we don't need to worry about this. + * Chunked responses inheritly don't support range requests. +**/ diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.m b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.m new file mode 100644 index 00000000000..edcbd48af4b --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.m @@ -0,0 +1,405 @@ +#import "HTTPAsyncFileResponse.h" +#import "HTTPConnection.h" +#import "HTTPLogging.h" + +#import +#import + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels : off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; // | HTTP_LOG_FLAG_TRACE; + +#define NULL_FD -1 + +/** + * Architecure overview: + * + * HTTPConnection will invoke our readDataOfLength: method to fetch data. + * We will return nil, and then proceed to read the data via our readSource on our readQueue. + * Once the requested amount of data has been read, we then pause our readSource, + * and inform the connection of the available data. + * + * While our read is in progress, we don't have to worry about the connection calling any other methods, + * except the connectionDidClose method, which would be invoked if the remote end closed the socket connection. + * To safely handle this, we do a synchronous dispatch on the readQueue, + * and nilify the connection as well as cancel our readSource. + * + * In order to minimize resource consumption during a HEAD request, + * we don't open the file until we have to (until the connection starts requesting data). +**/ + +@implementation HTTPAsyncFileResponse + +- (id)initWithFilePath:(NSString *)fpath forConnection:(HTTPConnection *)parent +{ + if ((self = [super init])) + { + HTTPLogTrace(); + + connection = parent; // Parents retain children, children do NOT retain parents + + fileFD = NULL_FD; + filePath = [fpath copy]; + if (filePath == nil) + { + HTTPLogWarn(@"%@: Init failed - Nil filePath", THIS_FILE); + + return nil; + } + + NSDictionary *fileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:filePath error:NULL]; + if (fileAttributes == nil) + { + HTTPLogWarn(@"%@: Init failed - Unable to get file attributes. filePath: %@", THIS_FILE, filePath); + + return nil; + } + + fileLength = (UInt64)[[fileAttributes objectForKey:NSFileSize] unsignedLongLongValue]; + fileOffset = 0; + + aborted = NO; + + // We don't bother opening the file here. + // If this is a HEAD request we only need to know the fileLength. + } + return self; +} + +- (void)abort +{ + HTTPLogTrace(); + + [connection responseDidAbort:self]; + aborted = YES; +} + +- (void)processReadBuffer +{ + // This method is here to allow superclasses to perform post-processing of the data. + // For an example, see the HTTPDynamicFileResponse class. + // + // At this point, the readBuffer has readBufferOffset bytes available. + // This method is in charge of updating the readBufferOffset. + // Failure to do so will cause the readBuffer to grow to fileLength. (Imagine a 1 GB file...) + + // Copy the data out of the temporary readBuffer. + data = [[NSData alloc] initWithBytes:readBuffer length:readBufferOffset]; + + // Reset the read buffer. + readBufferOffset = 0; + + // Notify the connection that we have data available for it. + [connection responseHasAvailableData:self]; +} + +- (void)pauseReadSource +{ + if (!readSourceSuspended) + { + HTTPLogVerbose(@"%@[%p]: Suspending readSource", THIS_FILE, self); + + readSourceSuspended = YES; + dispatch_suspend(readSource); + } +} + +- (void)resumeReadSource +{ + if (readSourceSuspended) + { + HTTPLogVerbose(@"%@[%p]: Resuming readSource", THIS_FILE, self); + + readSourceSuspended = NO; + dispatch_resume(readSource); + } +} + +- (void)cancelReadSource +{ + HTTPLogVerbose(@"%@[%p]: Canceling readSource", THIS_FILE, self); + + dispatch_source_cancel(readSource); + + // Cancelling a dispatch source doesn't + // invoke the cancel handler if the dispatch source is paused. + + if (readSourceSuspended) + { + readSourceSuspended = NO; + dispatch_resume(readSource); + } +} + +- (BOOL)openFileAndSetupReadSource +{ + HTTPLogTrace(); + + fileFD = open([filePath UTF8String], (O_RDONLY | O_NONBLOCK)); + if (fileFD == NULL_FD) + { + HTTPLogError(@"%@: Unable to open file. filePath: %@", THIS_FILE, filePath); + + return NO; + } + + HTTPLogVerbose(@"%@[%p]: Open fd[%i] -> %@", THIS_FILE, self, fileFD, filePath); + + readQueue = dispatch_queue_create("HTTPAsyncFileResponse", NULL); + readSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, fileFD, 0, readQueue); + + + dispatch_source_set_event_handler(readSource, ^{ + + HTTPLogTrace2(@"%@: eventBlock - fd[%i]", THIS_FILE, fileFD); + + // Determine how much data we should read. + // + // It is OK if we ask to read more bytes than exist in the file. + // It is NOT OK to over-allocate the buffer. + + unsigned long long _bytesAvailableOnFD = dispatch_source_get_data(readSource); + + UInt64 _bytesLeftInFile = fileLength - readOffset; + + NSUInteger bytesAvailableOnFD; + NSUInteger bytesLeftInFile; + + bytesAvailableOnFD = (_bytesAvailableOnFD > NSUIntegerMax) ? NSUIntegerMax : (NSUInteger)_bytesAvailableOnFD; + bytesLeftInFile = (_bytesLeftInFile > NSUIntegerMax) ? NSUIntegerMax : (NSUInteger)_bytesLeftInFile; + + NSUInteger bytesLeftInRequest = readRequestLength - readBufferOffset; + + NSUInteger bytesLeft = MIN(bytesLeftInRequest, bytesLeftInFile); + + NSUInteger bytesToRead = MIN(bytesAvailableOnFD, bytesLeft); + + // Make sure buffer is big enough for read request. + // Do not over-allocate. + + if (readBuffer == NULL || bytesToRead > (readBufferSize - readBufferOffset)) + { + readBufferSize = bytesToRead; + readBuffer = reallocf(readBuffer, (size_t)bytesToRead); + + if (readBuffer == NULL) + { + HTTPLogError(@"%@[%p]: Unable to allocate buffer", THIS_FILE, self); + + [self pauseReadSource]; + [self abort]; + + return; + } + } + + // Perform the read + + HTTPLogVerbose(@"%@[%p]: Attempting to read %lu bytes from file", THIS_FILE, self, (unsigned long)bytesToRead); + + ssize_t result = read(fileFD, readBuffer + readBufferOffset, (size_t)bytesToRead); + + // Check the results + if (result < 0) + { + HTTPLogError(@"%@: Error(%i) reading file(%@)", THIS_FILE, errno, filePath); + + [self pauseReadSource]; + [self abort]; + } + else if (result == 0) + { + HTTPLogError(@"%@: Read EOF on file(%@)", THIS_FILE, filePath); + + [self pauseReadSource]; + [self abort]; + } + else // (result > 0) + { + HTTPLogVerbose(@"%@[%p]: Read %lu bytes from file", THIS_FILE, self, (unsigned long)result); + + readOffset += result; + readBufferOffset += result; + + [self pauseReadSource]; + [self processReadBuffer]; + } + + }); + + int theFileFD = fileFD; + #if !OS_OBJECT_USE_OBJC + dispatch_source_t theReadSource = readSource; + #endif + + dispatch_source_set_cancel_handler(readSource, ^{ + + // Do not access self from within this block in any way, shape or form. + // + // Note: You access self if you reference an iVar. + + HTTPLogTrace2(@"%@: cancelBlock - Close fd[%i]", THIS_FILE, theFileFD); + + #if !OS_OBJECT_USE_OBJC + dispatch_release(theReadSource); + #endif + close(theFileFD); + }); + + readSourceSuspended = YES; + + return YES; +} + +- (BOOL)openFileIfNeeded +{ + if (aborted) + { + // The file operation has been aborted. + // This could be because we failed to open the file, + // or the reading process failed. + return NO; + } + + if (fileFD != NULL_FD) + { + // File has already been opened. + return YES; + } + + return [self openFileAndSetupReadSource]; +} + +- (UInt64)contentLength +{ + HTTPLogTrace2(@"%@[%p]: contentLength - %llu", THIS_FILE, self, fileLength); + + return fileLength; +} + +- (UInt64)offset +{ + HTTPLogTrace(); + + return fileOffset; +} + +- (void)setOffset:(UInt64)offset +{ + HTTPLogTrace2(@"%@[%p]: setOffset:%llu", THIS_FILE, self, offset); + + if (![self openFileIfNeeded]) + { + // File opening failed, + // or response has been aborted due to another error. + return; + } + + fileOffset = offset; + readOffset = offset; + + off_t result = lseek(fileFD, (off_t)offset, SEEK_SET); + if (result == -1) + { + HTTPLogError(@"%@[%p]: lseek failed - errno(%i) filePath(%@)", THIS_FILE, self, errno, filePath); + + [self abort]; + } +} + +- (NSData *)readDataOfLength:(NSUInteger)length +{ + HTTPLogTrace2(@"%@[%p]: readDataOfLength:%lu", THIS_FILE, self, (unsigned long)length); + + if (data) + { + NSUInteger dataLength = [data length]; + + HTTPLogVerbose(@"%@[%p]: Returning data of length %lu", THIS_FILE, self, (unsigned long)dataLength); + + fileOffset += dataLength; + + NSData *result = data; + data = nil; + + return result; + } + else + { + if (![self openFileIfNeeded]) + { + // File opening failed, + // or response has been aborted due to another error. + return nil; + } + + dispatch_sync(readQueue, ^{ + + NSAssert(readSourceSuspended, @"Invalid logic - perhaps HTTPConnection has changed."); + + readRequestLength = length; + [self resumeReadSource]; + }); + + return nil; + } +} + +- (BOOL)isDone +{ + BOOL result = (fileOffset == fileLength); + + HTTPLogTrace2(@"%@[%p]: isDone - %@", THIS_FILE, self, (result ? @"YES" : @"NO")); + + return result; +} + +- (NSString *)filePath +{ + return filePath; +} + +- (BOOL)isAsynchronous +{ + HTTPLogTrace(); + + return YES; +} + +- (void)connectionDidClose +{ + HTTPLogTrace(); + + if (fileFD != NULL_FD) + { + dispatch_sync(readQueue, ^{ + + // Prevent any further calls to the connection + connection = nil; + + // Cancel the readSource. + // We do this here because the readSource's eventBlock has retained self. + // In other words, if we don't cancel the readSource, we will never get deallocated. + + [self cancelReadSource]; + }); + } +} + +- (void)dealloc +{ + HTTPLogTrace(); + + #if !OS_OBJECT_USE_OBJC + if (readQueue) dispatch_release(readQueue); + #endif + + if (readBuffer) + free(readBuffer); +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.h b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.h new file mode 100644 index 00000000000..66c5e401aff --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.h @@ -0,0 +1,13 @@ +#import +#import "HTTPResponse.h" + + +@interface HTTPDataResponse : NSObject +{ + NSUInteger offset; + NSData *data; +} + +- (id)initWithData:(NSData *)data; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.m b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.m new file mode 100644 index 00000000000..6525e37edf8 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDataResponse.m @@ -0,0 +1,79 @@ +#import "HTTPDataResponse.h" +#import "HTTPLogging.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels : off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_OFF; // | HTTP_LOG_FLAG_TRACE; + + +@implementation HTTPDataResponse + +- (id)initWithData:(NSData *)dataParam +{ + if((self = [super init])) + { + HTTPLogTrace(); + + offset = 0; + data = dataParam; + } + return self; +} + +- (void)dealloc +{ + HTTPLogTrace(); + +} + +- (UInt64)contentLength +{ + UInt64 result = (UInt64)[data length]; + + HTTPLogTrace2(@"%@[%p]: contentLength - %llu", THIS_FILE, self, result); + + return result; +} + +- (UInt64)offset +{ + HTTPLogTrace(); + + return offset; +} + +- (void)setOffset:(UInt64)offsetParam +{ + HTTPLogTrace2(@"%@[%p]: setOffset:%lu", THIS_FILE, self, (unsigned long)offset); + + offset = (NSUInteger)offsetParam; +} + +- (NSData *)readDataOfLength:(NSUInteger)lengthParameter +{ + HTTPLogTrace2(@"%@[%p]: readDataOfLength:%lu", THIS_FILE, self, (unsigned long)lengthParameter); + + NSUInteger remaining = [data length] - offset; + NSUInteger length = lengthParameter < remaining ? lengthParameter : remaining; + + void *bytes = (void *)([data bytes] + offset); + + offset += length; + + return [NSData dataWithBytesNoCopy:bytes length:length freeWhenDone:NO]; +} + +- (BOOL)isDone +{ + BOOL result = (offset == [data length]); + + HTTPLogTrace2(@"%@[%p]: isDone - %@", THIS_FILE, self, (result ? @"YES" : @"NO")); + + return result; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.h b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.h new file mode 100644 index 00000000000..d2763192fb5 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.h @@ -0,0 +1,52 @@ +#import +#import "HTTPResponse.h" +#import "HTTPAsyncFileResponse.h" + +/** + * This class is designed to assist with dynamic content. + * Imagine you have a file that you want to make dynamic: + * + * + * + *

ComputerName Control Panel

+ * ... + *
  • System Time: SysTime
    • + * + * + * + * Now you could generate the entire file in Objective-C, + * but this would be a horribly tedious process. + * Beside, you want to design the file with professional tools to make it look pretty. + * + * So all you have to do is escape your dynamic content like this: + * + * ... + *

    %%ComputerName%% Control Panel

    + * ... + *
  • System Time: %%SysTime%%
    • + * + * And then you create an instance of this class with: + * + * - separator = @"%%" + * - replacementDictionary = { "ComputerName"="Black MacBook", "SysTime"="2010-04-30 03:18:24" } + * + * This class will then perform the replacements for you, on the fly, as it reads the file data. + * This class is also asynchronous, so it will perform the file IO using its own GCD queue. + * + * All keys for the replacementDictionary must be NSString's. + * Values for the replacementDictionary may be NSString's, or any object that + * returns what you want when its description method is invoked. +**/ + +@interface HTTPDynamicFileResponse : HTTPAsyncFileResponse +{ + NSData *separator; + NSDictionary *replacementDict; +} + +- (id)initWithFilePath:(NSString *)filePath + forConnection:(HTTPConnection *)connection + separator:(NSString *)separatorStr + replacementDictionary:(NSDictionary *)dictionary; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.m b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.m new file mode 100644 index 00000000000..e55426a5db5 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.m @@ -0,0 +1,292 @@ +#import "HTTPDynamicFileResponse.h" +#import "HTTPConnection.h" +#import "HTTPLogging.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels : off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; // | HTTP_LOG_FLAG_TRACE; + +#define NULL_FD -1 + + +@implementation HTTPDynamicFileResponse + +- (id)initWithFilePath:(NSString *)fpath + forConnection:(HTTPConnection *)parent + separator:(NSString *)separatorStr + replacementDictionary:(NSDictionary *)dict +{ + if ((self = [super initWithFilePath:fpath forConnection:parent])) + { + HTTPLogTrace(); + + separator = [separatorStr dataUsingEncoding:NSUTF8StringEncoding]; + replacementDict = dict; + } + return self; +} + +- (BOOL)isChunked +{ + HTTPLogTrace(); + + return YES; +} + +- (UInt64)contentLength +{ + // This method shouldn't be called since we're using a chunked response. + // We override it just to be safe. + + HTTPLogTrace(); + + return 0; +} + +- (void)setOffset:(UInt64)offset +{ + // This method shouldn't be called since we're using a chunked response. + // We override it just to be safe. + + HTTPLogTrace(); +} + +- (BOOL)isDone +{ + BOOL result = (readOffset == fileLength) && (readBufferOffset == 0); + + HTTPLogTrace2(@"%@[%p]: isDone - %@", THIS_FILE, self, (result ? @"YES" : @"NO")); + + return result; +} + +- (void)processReadBuffer +{ + HTTPLogTrace(); + + // At this point, the readBuffer has readBufferOffset bytes available. + // This method is in charge of updating the readBufferOffset. + + NSUInteger bufLen = readBufferOffset; + NSUInteger sepLen = [separator length]; + + // We're going to start looking for the separator at the beginning of the buffer, + // and stop when we get to the point where the separator would no longer fit in the buffer. + + NSUInteger offset = 0; + NSUInteger stopOffset = (bufLen > sepLen) ? bufLen - sepLen + 1 : 0; + + // In order to do the replacement, we need to find the starting and ending separator. + // For example: + // + // %%USER_NAME%% + // + // Where "%%" is the separator. + + BOOL found1 = NO; + BOOL found2 = NO; + + NSUInteger s1 = 0; + NSUInteger s2 = 0; + + const void *sep = [separator bytes]; + + while (offset < stopOffset) + { + const void *subBuffer = readBuffer + offset; + + if (memcmp(subBuffer, sep, sepLen) == 0) + { + if (!found1) + { + // Found the first separator + + found1 = YES; + s1 = offset; + offset += sepLen; + + HTTPLogVerbose(@"%@[%p]: Found s1 at %lu", THIS_FILE, self, (unsigned long)s1); + } + else + { + // Found the second separator + + found2 = YES; + s2 = offset; + offset += sepLen; + + HTTPLogVerbose(@"%@[%p]: Found s2 at %lu", THIS_FILE, self, (unsigned long)s2); + } + + if (found1 && found2) + { + // We found our separators. + // Now extract the string between the two separators. + + NSRange fullRange = NSMakeRange(s1, (s2 - s1 + sepLen)); + NSRange strRange = NSMakeRange(s1 + sepLen, (s2 - s1 - sepLen)); + + // Wish we could use the simple subdataWithRange method. + // But that method copies the bytes... + // So for performance reasons, we need to use the methods that don't copy the bytes. + + void *strBuf = readBuffer + strRange.location; + NSUInteger strLen = strRange.length; + + NSString *key = [[NSString alloc] initWithBytes:strBuf length:strLen encoding:NSUTF8StringEncoding]; + if (key) + { + // Is there a given replacement for this key? + + id value = [replacementDict objectForKey:key]; + if (value) + { + // Found the replacement value. + // Now perform the replacement in the buffer. + + HTTPLogVerbose(@"%@[%p]: key(%@) -> value(%@)", THIS_FILE, self, key, value); + + NSData *v = [[value description] dataUsingEncoding:NSUTF8StringEncoding]; + NSUInteger vLength = [v length]; + + if (fullRange.length == vLength) + { + // Replacement is exactly the same size as what it is replacing + + // memcpy(void *restrict dst, const void *restrict src, size_t n); + + memcpy(readBuffer + fullRange.location, [v bytes], vLength); + } + else // (fullRange.length != vLength) + { + NSInteger diff = (NSInteger)vLength - (NSInteger)fullRange.length; + + if (diff > 0) + { + // Replacement is bigger than what it is replacing. + // Make sure there is room in the buffer for the replacement. + + if (diff > (readBufferSize - bufLen)) + { + NSUInteger inc = MAX(diff, 256); + + readBufferSize += inc; + readBuffer = reallocf(readBuffer, readBufferSize); + } + } + + // Move the data that comes after the replacement. + // + // If replacement is smaller than what it is replacing, + // then we are shifting the data toward the beginning of the buffer. + // + // If replacement is bigger than what it is replacing, + // then we are shifting the data toward the end of the buffer. + // + // memmove(void *dst, const void *src, size_t n); + // + // The memmove() function copies n bytes from src to dst. + // The two areas may overlap; the copy is always done in a non-destructive manner. + + void *src = readBuffer + fullRange.location + fullRange.length; + void *dst = readBuffer + fullRange.location + vLength; + + NSUInteger remaining = bufLen - (fullRange.location + fullRange.length); + + memmove(dst, src, remaining); + + // Now copy the replacement into its location. + // + // memcpy(void *restrict dst, const void *restrict src, size_t n) + // + // The memcpy() function copies n bytes from src to dst. + // If the two areas overlap, behavior is undefined. + + memcpy(readBuffer + fullRange.location, [v bytes], vLength); + + // And don't forget to update our indices. + + bufLen += diff; + offset += diff; + stopOffset += diff; + } + } + + } + + found1 = found2 = NO; + } + } + else + { + offset++; + } + } + + // We've gone through our buffer now, and performed all the replacements that we could. + // It's now time to update the amount of available data we have. + + if (readOffset == fileLength) + { + // We've read in the entire file. + // So there can be no more replacements. + + data = [[NSData alloc] initWithBytes:readBuffer length:bufLen]; + readBufferOffset = 0; + } + else + { + // There are a couple different situations that we need to take into account here. + // + // Imagine the following file: + // My name is %%USER_NAME%% + // + // Situation 1: + // The first chunk of data we read was "My name is %%". + // So we found the first separator, but not the second. + // In this case we can only return the data that precedes the first separator. + // + // Situation 2: + // The first chunk of data we read was "My name is %". + // So we didn't find any separators, but part of a separator may be included in our buffer. + + NSUInteger available; + if (found1) + { + // Situation 1 + available = s1; + } + else + { + // Situation 2 + available = stopOffset; + } + + // Copy available data + + data = [[NSData alloc] initWithBytes:readBuffer length:available]; + + // Remove the copied data from the buffer. + // We do this by shifting the remaining data toward the beginning of the buffer. + + NSUInteger remaining = bufLen - available; + + memmove(readBuffer, readBuffer + available, remaining); + readBufferOffset = remaining; + } + + [connection responseHasAvailableData:self]; +} + +- (void)dealloc +{ + HTTPLogTrace(); + + +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.h b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.h new file mode 100644 index 00000000000..7aa9c7eaacc --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.h @@ -0,0 +1,9 @@ +#import "HTTPResponse.h" + +@interface HTTPErrorResponse : NSObject { + NSInteger _status; +} + +- (id)initWithErrorCode:(int)httpErrorCode; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.m b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.m new file mode 100644 index 00000000000..02871ae195d --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPErrorResponse.m @@ -0,0 +1,38 @@ +#import "HTTPErrorResponse.h" + +@implementation HTTPErrorResponse + +-(id)initWithErrorCode:(int)httpErrorCode +{ + if ((self = [super init])) + { + _status = httpErrorCode; + } + + return self; +} + +- (UInt64) contentLength { + return 0; +} + +- (UInt64) offset { + return 0; +} + +- (void)setOffset:(UInt64)offset { + ; +} + +- (NSData*) readDataOfLength:(NSUInteger)length { + return nil; +} + +- (BOOL) isDone { + return YES; +} + +- (NSInteger) status { + return _status; +} +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.h b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.h new file mode 100644 index 00000000000..e334f4f9b99 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.h @@ -0,0 +1,25 @@ +#import +#import "HTTPResponse.h" + +@class HTTPConnection; + + +@interface HTTPFileResponse : NSObject +{ + HTTPConnection *connection; + + NSString *filePath; + UInt64 fileLength; + UInt64 fileOffset; + + BOOL aborted; + + int fileFD; + void *buffer; + NSUInteger bufferSize; +} + +- (id)initWithFilePath:(NSString *)filePath forConnection:(HTTPConnection *)connection; +- (NSString *)filePath; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.m b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.m new file mode 100644 index 00000000000..cf73cd2859a --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPFileResponse.m @@ -0,0 +1,237 @@ +#import "HTTPFileResponse.h" +#import "HTTPConnection.h" +#import "HTTPLogging.h" + +#import +#import + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels : off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; // | HTTP_LOG_FLAG_TRACE; + +#define NULL_FD -1 + + +@implementation HTTPFileResponse + +- (id)initWithFilePath:(NSString *)fpath forConnection:(HTTPConnection *)parent +{ + if((self = [super init])) + { + HTTPLogTrace(); + + connection = parent; // Parents retain children, children do NOT retain parents + + fileFD = NULL_FD; + filePath = [[fpath copy] stringByResolvingSymlinksInPath]; + if (filePath == nil) + { + HTTPLogWarn(@"%@: Init failed - Nil filePath", THIS_FILE); + + return nil; + } + + NSDictionary *fileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:filePath error:nil]; + if (fileAttributes == nil) + { + HTTPLogWarn(@"%@: Init failed - Unable to get file attributes. filePath: %@", THIS_FILE, filePath); + + return nil; + } + + fileLength = (UInt64)[[fileAttributes objectForKey:NSFileSize] unsignedLongLongValue]; + fileOffset = 0; + + aborted = NO; + + // We don't bother opening the file here. + // If this is a HEAD request we only need to know the fileLength. + } + return self; +} + +- (void)abort +{ + HTTPLogTrace(); + + [connection responseDidAbort:self]; + aborted = YES; +} + +- (BOOL)openFile +{ + HTTPLogTrace(); + + fileFD = open([filePath UTF8String], O_RDONLY); + if (fileFD == NULL_FD) + { + HTTPLogError(@"%@[%p]: Unable to open file. filePath: %@", THIS_FILE, self, filePath); + + [self abort]; + return NO; + } + + HTTPLogVerbose(@"%@[%p]: Open fd[%i] -> %@", THIS_FILE, self, fileFD, filePath); + + return YES; +} + +- (BOOL)openFileIfNeeded +{ + if (aborted) + { + // The file operation has been aborted. + // This could be because we failed to open the file, + // or the reading process failed. + return NO; + } + + if (fileFD != NULL_FD) + { + // File has already been opened. + return YES; + } + + return [self openFile]; +} + +- (UInt64)contentLength +{ + HTTPLogTrace(); + + return fileLength; +} + +- (UInt64)offset +{ + HTTPLogTrace(); + + return fileOffset; +} + +- (void)setOffset:(UInt64)offset +{ + HTTPLogTrace2(@"%@[%p]: setOffset:%llu", THIS_FILE, self, offset); + + if (![self openFileIfNeeded]) + { + // File opening failed, + // or response has been aborted due to another error. + return; + } + + fileOffset = offset; + + off_t result = lseek(fileFD, (off_t)offset, SEEK_SET); + if (result == -1) + { + HTTPLogError(@"%@[%p]: lseek failed - errno(%i) filePath(%@)", THIS_FILE, self, errno, filePath); + + [self abort]; + } +} + +- (NSData *)readDataOfLength:(NSUInteger)length +{ + HTTPLogTrace2(@"%@[%p]: readDataOfLength:%lu", THIS_FILE, self, (unsigned long)length); + + if (![self openFileIfNeeded]) + { + // File opening failed, + // or response has been aborted due to another error. + return nil; + } + + // Determine how much data we should read. + // + // It is OK if we ask to read more bytes than exist in the file. + // It is NOT OK to over-allocate the buffer. + + UInt64 bytesLeftInFile = fileLength - fileOffset; + + NSUInteger bytesToRead = (NSUInteger)MIN(length, bytesLeftInFile); + + // Make sure buffer is big enough for read request. + // Do not over-allocate. + + if (buffer == NULL || bufferSize < bytesToRead) + { + bufferSize = bytesToRead; + buffer = reallocf(buffer, (size_t)bufferSize); + + if (buffer == NULL) + { + HTTPLogError(@"%@[%p]: Unable to allocate buffer", THIS_FILE, self); + + [self abort]; + return nil; + } + } + + // Perform the read + + HTTPLogVerbose(@"%@[%p]: Attempting to read %lu bytes from file", THIS_FILE, self, (unsigned long)bytesToRead); + + ssize_t result = read(fileFD, buffer, bytesToRead); + + // Check the results + + if (result < 0) + { + HTTPLogError(@"%@: Error(%i) reading file(%@)", THIS_FILE, errno, filePath); + + [self abort]; + return nil; + } + else if (result == 0) + { + HTTPLogError(@"%@: Read EOF on file(%@)", THIS_FILE, filePath); + + [self abort]; + return nil; + } + else // (result > 0) + { + HTTPLogVerbose(@"%@[%p]: Read %ld bytes from file", THIS_FILE, self, (long)result); + + fileOffset += result; + + return [NSData dataWithBytes:buffer length:result]; + } +} + +- (BOOL)isDone +{ + BOOL result = (fileOffset == fileLength); + + HTTPLogTrace2(@"%@[%p]: isDone - %@", THIS_FILE, self, (result ? @"YES" : @"NO")); + + return result; +} + +- (NSString *)filePath +{ + return filePath; +} + +- (void)dealloc +{ + HTTPLogTrace(); + + if (fileFD != NULL_FD) + { + HTTPLogVerbose(@"%@[%p]: Close fd[%i]", THIS_FILE, self, fileFD); + + close(fileFD); + } + + if (buffer) + free(buffer); + +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.h b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.h new file mode 100644 index 00000000000..1e90123ed24 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.h @@ -0,0 +1,12 @@ +#import +#import "HTTPResponse.h" + + +@interface HTTPRedirectResponse : NSObject +{ + NSString *redirectPath; +} + +- (id)initWithPath:(NSString *)redirectPath; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.m b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.m new file mode 100644 index 00000000000..1fc7020f7df --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.m @@ -0,0 +1,73 @@ +#import "HTTPRedirectResponse.h" +#import "HTTPLogging.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels : off, error, warn, info, verbose +// Other flags: trace +static const int httpLogLevel = HTTP_LOG_LEVEL_OFF; // | HTTP_LOG_FLAG_TRACE; + + +@implementation HTTPRedirectResponse + +- (id)initWithPath:(NSString *)path +{ + if ((self = [super init])) + { + HTTPLogTrace(); + + redirectPath = [path copy]; + } + return self; +} + +- (UInt64)contentLength +{ + return 0; +} + +- (UInt64)offset +{ + return 0; +} + +- (void)setOffset:(UInt64)offset +{ + // Nothing to do +} + +- (NSData *)readDataOfLength:(NSUInteger)length +{ + HTTPLogTrace(); + + return nil; +} + +- (BOOL)isDone +{ + return YES; +} + +- (NSDictionary *)httpHeaders +{ + HTTPLogTrace(); + + return [NSDictionary dictionaryWithObject:redirectPath forKey:@"Location"]; +} + +- (NSInteger)status +{ + HTTPLogTrace(); + + return 302; +} + +- (void)dealloc +{ + HTTPLogTrace(); + +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/WebSocket.h b/platform/iphone/CocoaHTTPServer/Core/WebSocket.h new file mode 100644 index 00000000000..4ee51371c1a --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/WebSocket.h @@ -0,0 +1,105 @@ +#import + +@class HTTPMessage; +@class GCDAsyncSocket; + + +#define WebSocketDidDieNotification @"WebSocketDidDie" + +@interface WebSocket : NSObject +{ + dispatch_queue_t websocketQueue; + + HTTPMessage *request; + GCDAsyncSocket *asyncSocket; + + NSData *term; + + BOOL isStarted; + BOOL isOpen; + BOOL isVersion76; + + id __unsafe_unretained delegate; +} + ++ (BOOL)isWebSocketRequest:(HTTPMessage *)request; + +- (id)initWithRequest:(HTTPMessage *)request socket:(GCDAsyncSocket *)socket; + +/** + * Delegate option. + * + * In most cases it will be easier to subclass WebSocket, + * but some circumstances may lead one to prefer standard delegate callbacks instead. +**/ +@property (/* atomic */ unsafe_unretained) id delegate; + +/** + * The WebSocket class is thread-safe, generally via it's GCD queue. + * All public API methods are thread-safe, + * and the subclass API methods are thread-safe as they are all invoked on the same GCD queue. +**/ +@property (nonatomic, readonly) dispatch_queue_t websocketQueue; + +/** + * Public API + * + * These methods are automatically called by the HTTPServer. + * You may invoke the stop method yourself to close the WebSocket manually. +**/ +- (void)start; +- (void)stop; + +/** + * Public API + * + * Sends a message over the WebSocket. + * This method is thread-safe. + **/ +- (void)sendMessage:(NSString *)msg; + +/** + * Public API + * + * Sends a message over the WebSocket. + * This method is thread-safe. + **/ +- (void)sendData:(NSData *)msg; + +/** + * Subclass API + * + * These methods are designed to be overriden by subclasses. +**/ +- (void)didOpen; +- (void)didReceiveMessage:(NSString *)msg; +- (void)didClose; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * There are two ways to create your own custom WebSocket: + * + * - Subclass it and override the methods you're interested in. + * - Use traditional delegate paradigm along with your own custom class. + * + * They both exist to allow for maximum flexibility. + * In most cases it will be easier to subclass WebSocket. + * However some circumstances may lead one to prefer standard delegate callbacks instead. + * One such example, you're already subclassing another class, so subclassing WebSocket isn't an option. +**/ + +@protocol WebSocketDelegate +@optional + +- (void)webSocketDidOpen:(WebSocket *)ws; + +- (void)webSocket:(WebSocket *)ws didReceiveMessage:(NSString *)msg; + +- (void)webSocketDidClose:(WebSocket *)ws; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Core/WebSocket.m b/platform/iphone/CocoaHTTPServer/Core/WebSocket.m new file mode 100644 index 00000000000..9051ac3e05f --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Core/WebSocket.m @@ -0,0 +1,791 @@ +#import "WebSocket.h" +#import "HTTPMessage.h" +#import "GCDAsyncSocket.h" +#import "DDNumber.h" +#import "DDData.h" +#import "HTTPLogging.h" + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// Log levels: off, error, warn, info, verbose +// Other flags : trace +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; // | HTTP_LOG_FLAG_TRACE; + +#define TIMEOUT_NONE -1 +#define TIMEOUT_REQUEST_BODY 10 + +#define TAG_HTTP_REQUEST_BODY 100 +#define TAG_HTTP_RESPONSE_HEADERS 200 +#define TAG_HTTP_RESPONSE_BODY 201 + +#define TAG_PREFIX 300 +#define TAG_MSG_PLUS_SUFFIX 301 +#define TAG_MSG_WITH_LENGTH 302 +#define TAG_MSG_MASKING_KEY 303 +#define TAG_PAYLOAD_PREFIX 304 +#define TAG_PAYLOAD_LENGTH 305 +#define TAG_PAYLOAD_LENGTH16 306 +#define TAG_PAYLOAD_LENGTH64 307 + +#define WS_OP_CONTINUATION_FRAME 0 +#define WS_OP_TEXT_FRAME 1 +#define WS_OP_BINARY_FRAME 2 +#define WS_OP_CONNECTION_CLOSE 8 +#define WS_OP_PING 9 +#define WS_OP_PONG 10 + +static inline BOOL WS_OP_IS_FINAL_FRAGMENT(UInt8 frame) +{ + return (frame & 0x80) ? YES : NO; +} + +static inline BOOL WS_PAYLOAD_IS_MASKED(UInt8 frame) +{ + return (frame & 0x80) ? YES : NO; +} + +static inline NSUInteger WS_PAYLOAD_LENGTH(UInt8 frame) +{ + return frame & 0x7F; +} + +@interface WebSocket (PrivateAPI) + +- (void)readRequestBody; +- (void)sendResponseBody; +- (void)sendResponseHeaders; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation WebSocket +{ + BOOL isRFC6455; + BOOL nextFrameMasked; + NSUInteger nextOpCode; + NSData *maskingKey; +} + ++ (BOOL)isWebSocketRequest:(HTTPMessage *)request +{ + // Request (Draft 75): + // + // GET /demo HTTP/1.1 + // Upgrade: WebSocket + // Connection: Upgrade + // Host: example.com + // Origin: http://example.com + // WebSocket-Protocol: sample + // + // + // Request (Draft 76): + // + // GET /demo HTTP/1.1 + // Upgrade: WebSocket + // Connection: Upgrade + // Host: example.com + // Origin: http://example.com + // Sec-WebSocket-Protocol: sample + // Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5 + // Sec-WebSocket-Key2: 12998 5 Y3 1 .P00 + // + // ^n:ds[4U + + // Look for Upgrade: and Connection: headers. + // If we find them, and they have the proper value, + // we can safely assume this is a websocket request. + + NSString *upgradeHeaderValue = [request headerField:@"Upgrade"]; + NSString *connectionHeaderValue = [request headerField:@"Connection"]; + + BOOL isWebSocket = YES; + + if (!upgradeHeaderValue || !connectionHeaderValue) { + isWebSocket = NO; + } + else if (![upgradeHeaderValue caseInsensitiveCompare:@"WebSocket"] == NSOrderedSame) { + isWebSocket = NO; + } + else if ([connectionHeaderValue rangeOfString:@"Upgrade" options:NSCaseInsensitiveSearch].location == NSNotFound) { + isWebSocket = NO; + } + + HTTPLogTrace2(@"%@: %@ - %@", THIS_FILE, THIS_METHOD, (isWebSocket ? @"YES" : @"NO")); + + return isWebSocket; +} + ++ (BOOL)isVersion76Request:(HTTPMessage *)request +{ + NSString *key1 = [request headerField:@"Sec-WebSocket-Key1"]; + NSString *key2 = [request headerField:@"Sec-WebSocket-Key2"]; + + BOOL isVersion76; + + if (!key1 || !key2) { + isVersion76 = NO; + } + else { + isVersion76 = YES; + } + + HTTPLogTrace2(@"%@: %@ - %@", THIS_FILE, THIS_METHOD, (isVersion76 ? @"YES" : @"NO")); + + return isVersion76; +} + ++ (BOOL)isRFC6455Request:(HTTPMessage *)request +{ + NSString *key = [request headerField:@"Sec-WebSocket-Key"]; + BOOL isRFC6455 = (key != nil); + + HTTPLogTrace2(@"%@: %@ - %@", THIS_FILE, THIS_METHOD, (isRFC6455 ? @"YES" : @"NO")); + + return isRFC6455; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Setup and Teardown +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@synthesize websocketQueue; + +- (id)initWithRequest:(HTTPMessage *)aRequest socket:(GCDAsyncSocket *)socket +{ + HTTPLogTrace(); + + if (aRequest == nil) + { + return nil; + } + + if ((self = [super init])) + { + if (HTTP_LOG_VERBOSE) + { + NSData *requestHeaders = [aRequest messageData]; + + NSString *temp = [[NSString alloc] initWithData:requestHeaders encoding:NSUTF8StringEncoding]; + HTTPLogVerbose(@"%@[%p] Request Headers:\n%@", THIS_FILE, self, temp); + } + + websocketQueue = dispatch_queue_create("WebSocket", NULL); + request = aRequest; + + asyncSocket = socket; + [asyncSocket setDelegate:self delegateQueue:websocketQueue]; + + isOpen = NO; + isVersion76 = [[self class] isVersion76Request:request]; + isRFC6455 = [[self class] isRFC6455Request:request]; + + term = [[NSData alloc] initWithBytes:"\xFF" length:1]; + } + return self; +} + +- (void)dealloc +{ + HTTPLogTrace(); + + #if !OS_OBJECT_USE_OBJC + dispatch_release(websocketQueue); + #endif + + [asyncSocket setDelegate:nil delegateQueue:NULL]; + [asyncSocket disconnect]; +} + +- (id)delegate +{ + __block id result = nil; + + dispatch_sync(websocketQueue, ^{ + result = delegate; + }); + + return result; +} + +- (void)setDelegate:(id)newDelegate +{ + dispatch_async(websocketQueue, ^{ + delegate = newDelegate; + }); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Start and Stop +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Starting point for the WebSocket after it has been fully initialized (including subclasses). + * This method is called by the HTTPConnection it is spawned from. +**/ +- (void)start +{ + // This method is not exactly designed to be overriden. + // Subclasses are encouraged to override the didOpen method instead. + + dispatch_async(websocketQueue, ^{ @autoreleasepool { + + if (isStarted) return; + isStarted = YES; + + if (isVersion76) + { + [self readRequestBody]; + } + else + { + [self sendResponseHeaders]; + [self didOpen]; + } + }}); +} + +/** + * This method is called by the HTTPServer if it is asked to stop. + * The server, in turn, invokes stop on each WebSocket instance. +**/ +- (void)stop +{ + // This method is not exactly designed to be overriden. + // Subclasses are encouraged to override the didClose method instead. + + dispatch_async(websocketQueue, ^{ @autoreleasepool { + + [asyncSocket disconnect]; + }}); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark HTTP Response +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)readRequestBody +{ + HTTPLogTrace(); + + NSAssert(isVersion76, @"WebSocket version 75 doesn't contain a request body"); + + [asyncSocket readDataToLength:8 withTimeout:TIMEOUT_NONE tag:TAG_HTTP_REQUEST_BODY]; +} + +- (NSString *)originResponseHeaderValue +{ + HTTPLogTrace(); + + NSString *origin = [request headerField:@"Origin"]; + + if (origin == nil) + { + NSString *port = [NSString stringWithFormat:@"%hu", [asyncSocket localPort]]; + + return [NSString stringWithFormat:@"http://localhost:%@", port]; + } + else + { + return origin; + } +} + +- (NSString *)locationResponseHeaderValue +{ + HTTPLogTrace(); + + NSString *location; + + NSString *scheme = [asyncSocket isSecure] ? @"wss" : @"ws"; + NSString *host = [request headerField:@"Host"]; + + NSString *requestUri = [[request url] relativeString]; + + if (host == nil) + { + NSString *port = [NSString stringWithFormat:@"%hu", [asyncSocket localPort]]; + + location = [NSString stringWithFormat:@"%@://localhost:%@%@", scheme, port, requestUri]; + } + else + { + location = [NSString stringWithFormat:@"%@://%@%@", scheme, host, requestUri]; + } + + return location; +} + +- (NSString *)secWebSocketKeyResponseHeaderValue { + NSString *key = [request headerField: @"Sec-WebSocket-Key"]; + NSString *guid = @"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; + return [[key stringByAppendingString: guid] dataUsingEncoding: NSUTF8StringEncoding].sha1Digest.base64Encoded; +} + +- (void)sendResponseHeaders +{ + HTTPLogTrace(); + + // Request (Draft 75): + // + // GET /demo HTTP/1.1 + // Upgrade: WebSocket + // Connection: Upgrade + // Host: example.com + // Origin: http://example.com + // WebSocket-Protocol: sample + // + // + // Request (Draft 76): + // + // GET /demo HTTP/1.1 + // Upgrade: WebSocket + // Connection: Upgrade + // Host: example.com + // Origin: http://example.com + // Sec-WebSocket-Protocol: sample + // Sec-WebSocket-Key2: 12998 5 Y3 1 .P00 + // Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5 + // + // ^n:ds[4U + + + // Response (Draft 75): + // + // HTTP/1.1 101 Web Socket Protocol Handshake + // Upgrade: WebSocket + // Connection: Upgrade + // WebSocket-Origin: http://example.com + // WebSocket-Location: ws://example.com/demo + // WebSocket-Protocol: sample + // + // + // Response (Draft 76): + // + // HTTP/1.1 101 WebSocket Protocol Handshake + // Upgrade: WebSocket + // Connection: Upgrade + // Sec-WebSocket-Origin: http://example.com + // Sec-WebSocket-Location: ws://example.com/demo + // Sec-WebSocket-Protocol: sample + // + // 8jKS'y:G*Co,Wxa- + + + HTTPMessage *wsResponse = [[HTTPMessage alloc] initResponseWithStatusCode:101 + description:@"Web Socket Protocol Handshake" + version:HTTPVersion1_1]; + + [wsResponse setHeaderField:@"Upgrade" value:@"WebSocket"]; + [wsResponse setHeaderField:@"Connection" value:@"Upgrade"]; + + // Note: It appears that WebSocket-Origin and WebSocket-Location + // are required for Google's Chrome implementation to work properly. + // + // If we don't send either header, Chrome will never report the WebSocket as open. + // If we only send one of the two, Chrome will immediately close the WebSocket. + // + // In addition to this it appears that Chrome's implementation is very picky of the values of the headers. + // They have to match exactly with what Chrome sent us or it will close the WebSocket. + + NSString *originValue = [self originResponseHeaderValue]; + NSString *locationValue = [self locationResponseHeaderValue]; + + NSString *originField = isVersion76 ? @"Sec-WebSocket-Origin" : @"WebSocket-Origin"; + NSString *locationField = isVersion76 ? @"Sec-WebSocket-Location" : @"WebSocket-Location"; + + [wsResponse setHeaderField:originField value:originValue]; + [wsResponse setHeaderField:locationField value:locationValue]; + + NSString *acceptValue = [self secWebSocketKeyResponseHeaderValue]; + if (acceptValue) { + [wsResponse setHeaderField: @"Sec-WebSocket-Accept" value: acceptValue]; + } + + NSData *responseHeaders = [wsResponse messageData]; + + + if (HTTP_LOG_VERBOSE) + { + NSString *temp = [[NSString alloc] initWithData:responseHeaders encoding:NSUTF8StringEncoding]; + HTTPLogVerbose(@"%@[%p] Response Headers:\n%@", THIS_FILE, self, temp); + } + + [asyncSocket writeData:responseHeaders withTimeout:TIMEOUT_NONE tag:TAG_HTTP_RESPONSE_HEADERS]; +} + +- (NSData *)processKey:(NSString *)key +{ + HTTPLogTrace(); + + unichar c; + NSUInteger i; + NSUInteger length = [key length]; + + // Concatenate the digits into a string, + // and count the number of spaces. + + NSMutableString *numStr = [NSMutableString stringWithCapacity:10]; + long long numSpaces = 0; + + for (i = 0; i < length; i++) + { + c = [key characterAtIndex:i]; + + if (c >= '0' && c <= '9') + { + [numStr appendFormat:@"%C", c]; + } + else if (c == ' ') + { + numSpaces++; + } + } + + long long num = strtoll([numStr UTF8String], NULL, 10); + + long long resultHostNum; + + if (numSpaces == 0) + resultHostNum = 0; + else + resultHostNum = num / numSpaces; + + HTTPLogVerbose(@"key(%@) -> %qi / %qi = %qi", key, num, numSpaces, resultHostNum); + + // Convert result to 4 byte big-endian (network byte order) + // and then convert to raw data. + + UInt32 result = OSSwapHostToBigInt32((uint32_t)resultHostNum); + + return [NSData dataWithBytes:&result length:4]; +} + +- (void)sendResponseBody:(NSData *)d3 +{ + HTTPLogTrace(); + + NSAssert(isVersion76, @"WebSocket version 75 doesn't contain a response body"); + NSAssert([d3 length] == 8, @"Invalid requestBody length"); + + NSString *key1 = [request headerField:@"Sec-WebSocket-Key1"]; + NSString *key2 = [request headerField:@"Sec-WebSocket-Key2"]; + + NSData *d1 = [self processKey:key1]; + NSData *d2 = [self processKey:key2]; + + // Concatenated d1, d2 & d3 + + NSMutableData *d0 = [NSMutableData dataWithCapacity:(4+4+8)]; + [d0 appendData:d1]; + [d0 appendData:d2]; + [d0 appendData:d3]; + + // Hash the data using MD5 + + NSData *responseBody = [d0 md5Digest]; + + [asyncSocket writeData:responseBody withTimeout:TIMEOUT_NONE tag:TAG_HTTP_RESPONSE_BODY]; + + if (HTTP_LOG_VERBOSE) + { + NSString *s1 = [[NSString alloc] initWithData:d1 encoding:NSASCIIStringEncoding]; + NSString *s2 = [[NSString alloc] initWithData:d2 encoding:NSASCIIStringEncoding]; + NSString *s3 = [[NSString alloc] initWithData:d3 encoding:NSASCIIStringEncoding]; + + NSString *s0 = [[NSString alloc] initWithData:d0 encoding:NSASCIIStringEncoding]; + + NSString *sH = [[NSString alloc] initWithData:responseBody encoding:NSASCIIStringEncoding]; + + HTTPLogVerbose(@"key1 result : raw(%@) str(%@)", d1, s1); + HTTPLogVerbose(@"key2 result : raw(%@) str(%@)", d2, s2); + HTTPLogVerbose(@"key3 passed : raw(%@) str(%@)", d3, s3); + HTTPLogVerbose(@"key0 concat : raw(%@) str(%@)", d0, s0); + HTTPLogVerbose(@"responseBody: raw(%@) str(%@)", responseBody, sH); + + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Core Functionality +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)didOpen +{ + HTTPLogTrace(); + + // Override me to perform any custom actions once the WebSocket has been opened. + // This method is invoked on the websocketQueue. + // + // Don't forget to invoke [super didOpen] in your method. + + // Start reading for messages + [asyncSocket readDataToLength:1 withTimeout:TIMEOUT_NONE tag:(isRFC6455 ? TAG_PAYLOAD_PREFIX : TAG_PREFIX)]; + + // Notify delegate + if ([delegate respondsToSelector:@selector(webSocketDidOpen:)]) + { + [delegate webSocketDidOpen:self]; + } +} + +- (void)sendMessage:(NSString *)msg +{ + NSData *msgData = [msg dataUsingEncoding:NSUTF8StringEncoding]; + [self sendData:msgData]; +} + +- (void)sendData:(NSData *)msgData +{ + HTTPLogTrace(); + + NSMutableData *data = nil; + + if (isRFC6455) + { + NSUInteger length = msgData.length; + if (length <= 125) + { + data = [NSMutableData dataWithCapacity:(length + 2)]; + [data appendBytes: "\x81" length:1]; + UInt8 len = (UInt8)length; + [data appendBytes: &len length:1]; + [data appendData:msgData]; + } + else if (length <= 0xFFFF) + { + data = [NSMutableData dataWithCapacity:(length + 4)]; + [data appendBytes: "\x81\x7E" length:2]; + UInt16 len = (UInt16)length; + [data appendBytes: (UInt8[]){len >> 8, len & 0xFF} length:2]; + [data appendData:msgData]; + } + else + { + data = [NSMutableData dataWithCapacity:(length + 10)]; + [data appendBytes: "\x81\x7F" length:2]; + [data appendBytes: (UInt8[]){0, 0, 0, 0, (UInt8)(length >> 24), (UInt8)(length >> 16), (UInt8)(length >> 8), length & 0xFF} length:8]; + [data appendData:msgData]; + } + } + else + { + data = [NSMutableData dataWithCapacity:([msgData length] + 2)]; + + [data appendBytes:"\x00" length:1]; + [data appendData:msgData]; + [data appendBytes:"\xFF" length:1]; + } + + // Remember: GCDAsyncSocket is thread-safe + + [asyncSocket writeData:data withTimeout:TIMEOUT_NONE tag:0]; +} + +- (void)didReceiveMessage:(NSString *)msg +{ + HTTPLogTrace(); + + // Override me to process incoming messages. + // This method is invoked on the websocketQueue. + // + // For completeness, you should invoke [super didReceiveMessage:msg] in your method. + + // Notify delegate + if ([delegate respondsToSelector:@selector(webSocket:didReceiveMessage:)]) + { + [delegate webSocket:self didReceiveMessage:msg]; + } +} + +- (void)didClose +{ + HTTPLogTrace(); + + // Override me to perform any cleanup when the socket is closed + // This method is invoked on the websocketQueue. + // + // Don't forget to invoke [super didClose] at the end of your method. + + // Notify delegate + if ([delegate respondsToSelector:@selector(webSocketDidClose:)]) + { + [delegate webSocketDidClose:self]; + } + + // Notify HTTPServer + [[NSNotificationCenter defaultCenter] postNotificationName:WebSocketDidDieNotification object:self]; +} + +#pragma mark WebSocket Frame + +- (BOOL)isValidWebSocketFrame:(UInt8)frame +{ + NSUInteger rsv = frame & 0x70; + NSUInteger opcode = frame & 0x0F; + if (rsv || (3 <= opcode && opcode <= 7) || (0xB <= opcode && opcode <= 0xF)) + { + return NO; + } + return YES; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark AsyncSocket Delegate +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +// 0 1 2 3 +// 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +// +-+-+-+-+-------+-+-------------+-------------------------------+ +// |F|R|R|R| opcode|M| Payload len | Extended payload length | +// |I|S|S|S| (4) |A| (7) | (16/64) | +// |N|V|V|V| |S| | (if payload len==126/127) | +// | |1|2|3| |K| | | +// +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - + +// | Extended payload length continued, if payload len == 127 | +// + - - - - - - - - - - - - - - - +-------------------------------+ +// | |Masking-key, if MASK set to 1 | +// +-------------------------------+-------------------------------+ +// | Masking-key (continued) | Payload Data | +// +-------------------------------- - - - - - - - - - - - - - - - + +// : Payload Data continued ... : +// + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +// | Payload Data continued ... | +// +---------------------------------------------------------------+ + +- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag +{ + HTTPLogTrace(); + + if (tag == TAG_HTTP_REQUEST_BODY) + { + [self sendResponseHeaders]; + [self sendResponseBody:data]; + [self didOpen]; + } + else if (tag == TAG_PREFIX) + { + UInt8 *pFrame = (UInt8 *)[data bytes]; + UInt8 frame = *pFrame; + + if (frame <= 0x7F) + { + [asyncSocket readDataToData:term withTimeout:TIMEOUT_NONE tag:TAG_MSG_PLUS_SUFFIX]; + } + else + { + // Unsupported frame type + [self didClose]; + } + } + else if (tag == TAG_PAYLOAD_PREFIX) + { + UInt8 *pFrame = (UInt8 *)[data bytes]; + UInt8 frame = *pFrame; + + if ([self isValidWebSocketFrame: frame]) + { + nextOpCode = (frame & 0x0F); + [asyncSocket readDataToLength:1 withTimeout:TIMEOUT_NONE tag:TAG_PAYLOAD_LENGTH]; + } + else + { + // Unsupported frame type + [self didClose]; + } + } + else if (tag == TAG_PAYLOAD_LENGTH) + { + UInt8 frame = *(UInt8 *)[data bytes]; + BOOL masked = WS_PAYLOAD_IS_MASKED(frame); + NSUInteger length = WS_PAYLOAD_LENGTH(frame); + nextFrameMasked = masked; + maskingKey = nil; + if (length <= 125) + { + if (nextFrameMasked) + { + [asyncSocket readDataToLength:4 withTimeout:TIMEOUT_NONE tag:TAG_MSG_MASKING_KEY]; + } + [asyncSocket readDataToLength:length withTimeout:TIMEOUT_NONE tag:TAG_MSG_WITH_LENGTH]; + } + else if (length == 126) + { + [asyncSocket readDataToLength:2 withTimeout:TIMEOUT_NONE tag:TAG_PAYLOAD_LENGTH16]; + } + else + { + [asyncSocket readDataToLength:8 withTimeout:TIMEOUT_NONE tag:TAG_PAYLOAD_LENGTH64]; + } + } + else if (tag == TAG_PAYLOAD_LENGTH16) + { + UInt8 *pFrame = (UInt8 *)[data bytes]; + NSUInteger length = ((NSUInteger)pFrame[0] << 8) | (NSUInteger)pFrame[1]; + if (nextFrameMasked) { + [asyncSocket readDataToLength:4 withTimeout:TIMEOUT_NONE tag:TAG_MSG_MASKING_KEY]; + } + [asyncSocket readDataToLength:length withTimeout:TIMEOUT_NONE tag:TAG_MSG_WITH_LENGTH]; + } + else if (tag == TAG_PAYLOAD_LENGTH64) + { + // FIXME: 64bit data size in memory? + [self didClose]; + } + else if (tag == TAG_MSG_WITH_LENGTH) + { + NSUInteger msgLength = [data length]; + if (nextFrameMasked && maskingKey) { + NSMutableData *masked = data.mutableCopy; + UInt8 *pData = (UInt8 *)masked.mutableBytes; + UInt8 *pMask = (UInt8 *)maskingKey.bytes; + for (NSUInteger i = 0; i < msgLength; i++) + { + pData[i] = pData[i] ^ pMask[i % 4]; + } + data = masked; + } + if (nextOpCode == WS_OP_TEXT_FRAME) + { + NSString *msg = [[NSString alloc] initWithBytes:[data bytes] length:msgLength encoding:NSUTF8StringEncoding]; + [self didReceiveMessage:msg]; + } + else + { + [self didClose]; + return; + } + + // Read next frame + [asyncSocket readDataToLength:1 withTimeout:TIMEOUT_NONE tag:TAG_PAYLOAD_PREFIX]; + } + else if (tag == TAG_MSG_MASKING_KEY) + { + maskingKey = data.copy; + } + else + { + NSUInteger msgLength = [data length] - 1; // Excluding ending 0xFF frame + + NSString *msg = [[NSString alloc] initWithBytes:[data bytes] length:msgLength encoding:NSUTF8StringEncoding]; + + [self didReceiveMessage:msg]; + + + // Read next message + [asyncSocket readDataToLength:1 withTimeout:TIMEOUT_NONE tag:TAG_PREFIX]; + } +} + +- (void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)error +{ + HTTPLogTrace2(@"%@[%p]: socketDidDisconnect:withError: %@", THIS_FILE, self, error); + + [self didClose]; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.h b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.h new file mode 100644 index 00000000000..ebafb0c71f8 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.h @@ -0,0 +1,7 @@ +#import "HTTPConnection.h" + +@interface DAVConnection : HTTPConnection { + id requestContentBody; + NSOutputStream* requestContentStream; +} +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.m b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.m new file mode 100644 index 00000000000..b98975647d5 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVConnection.m @@ -0,0 +1,160 @@ +#import "DAVConnection.h" +#import "HTTPMessage.h" +#import "HTTPFileResponse.h" +#import "HTTPAsyncFileResponse.h" +#import "PUTResponse.h" +#import "DELETEResponse.h" +#import "DAVResponse.h" +#import "HTTPLogging.h" + +#define HTTP_BODY_MAX_MEMORY_SIZE (1024 * 1024) +#define HTTP_ASYNC_FILE_RESPONSE_THRESHOLD (16 * 1024 * 1024) + +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; + +@implementation DAVConnection + +- (void) dealloc { + [requestContentStream close]; + +} + +- (BOOL) supportsMethod:(NSString*)method atPath:(NSString*)path { + // HTTPFileResponse & HTTPAsyncFileResponse + if ([method isEqualToString:@"GET"]) return YES; + if ([method isEqualToString:@"HEAD"]) return YES; + + // PUTResponse + if ([method isEqualToString:@"PUT"]) return YES; + + // DELETEResponse + if ([method isEqualToString:@"DELETE"]) return YES; + + // DAVResponse + if ([method isEqualToString:@"OPTIONS"]) return YES; + if ([method isEqualToString:@"PROPFIND"]) return YES; + if ([method isEqualToString:@"MKCOL"]) return YES; + if ([method isEqualToString:@"MOVE"]) return YES; + if ([method isEqualToString:@"COPY"]) return YES; + if ([method isEqualToString:@"LOCK"]) return YES; + if ([method isEqualToString:@"UNLOCK"]) return YES; + + return NO; +} + +- (BOOL) expectsRequestBodyFromMethod:(NSString*)method atPath:(NSString*)path { + // PUTResponse + if ([method isEqualToString:@"PUT"]) { + return YES; + } + + // DAVResponse + if ([method isEqual:@"PROPFIND"] || [method isEqual:@"MKCOL"]) { + return [request headerField:@"Content-Length"] ? YES : NO; + } + if ([method isEqual:@"LOCK"]) { + return YES; + } + + return NO; +} + +- (void) prepareForBodyWithSize:(UInt64)contentLength { + NSAssert(requestContentStream == nil, @"requestContentStream should be nil"); + NSAssert(requestContentBody == nil, @"requestContentBody should be nil"); + + if (contentLength > HTTP_BODY_MAX_MEMORY_SIZE) { + requestContentBody = [[NSTemporaryDirectory() stringByAppendingString:[[NSProcessInfo processInfo] globallyUniqueString]] copy]; + requestContentStream = [[NSOutputStream alloc] initToFileAtPath:requestContentBody append:NO]; + [requestContentStream open]; + } else { + requestContentBody = [[NSMutableData alloc] initWithCapacity:(NSUInteger)contentLength]; + requestContentStream = nil; + } +} + +- (void) processBodyData:(NSData*)postDataChunk { + NSAssert(requestContentBody != nil, @"requestContentBody should not be nil"); + if (requestContentStream) { + [requestContentStream write:[postDataChunk bytes] maxLength:[postDataChunk length]]; + } else { + [(NSMutableData*)requestContentBody appendData:postDataChunk]; + } +} + +- (void) finishBody { + NSAssert(requestContentBody != nil, @"requestContentBody should not be nil"); + if (requestContentStream) { + [requestContentStream close]; + requestContentStream = nil; + } +} + +- (void)finishResponse { + NSAssert(requestContentStream == nil, @"requestContentStream should be nil"); + requestContentBody = nil; + + [super finishResponse]; +} + +- (NSObject*) httpResponseForMethod:(NSString*)method URI:(NSString*)path { + if ([method isEqualToString:@"HEAD"] || [method isEqualToString:@"GET"]) { + NSString* filePath = [self filePathForURI:path allowDirectory:NO]; + if (filePath) { + NSDictionary* fileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:filePath error:NULL]; + if (fileAttributes) { + if ([[fileAttributes objectForKey:NSFileSize] unsignedLongLongValue] > HTTP_ASYNC_FILE_RESPONSE_THRESHOLD) { + return [[HTTPAsyncFileResponse alloc] initWithFilePath:filePath forConnection:self]; + } else { + return [[HTTPFileResponse alloc] initWithFilePath:filePath forConnection:self]; + } + } + } + } + + if ([method isEqualToString:@"PUT"]) { + NSString* filePath = [self filePathForURI:path allowDirectory:YES]; + if (filePath) { + if ([requestContentBody isKindOfClass:[NSString class]]) { + return [[PUTResponse alloc] initWithFilePath:filePath headers:[request allHeaderFields] bodyFile:requestContentBody]; + } else if ([requestContentBody isKindOfClass:[NSData class]]) { + return [[PUTResponse alloc] initWithFilePath:filePath headers:[request allHeaderFields] bodyData:requestContentBody]; + } else { + HTTPLogError(@"Internal error"); + } + } + } + + if ([method isEqualToString:@"DELETE"]) { + NSString* filePath = [self filePathForURI:path allowDirectory:YES]; + if (filePath) { + return [[DELETEResponse alloc] initWithFilePath:filePath]; + } + } + + if ([method isEqualToString:@"OPTIONS"] || [method isEqualToString:@"PROPFIND"] || [method isEqualToString:@"MKCOL"] || + [method isEqualToString:@"MOVE"] || [method isEqualToString:@"COPY"] || [method isEqualToString:@"LOCK"] || [method isEqualToString:@"UNLOCK"]) { + NSString* filePath = [self filePathForURI:path allowDirectory:YES]; + if (filePath) { + NSString* rootPath = [config documentRoot]; + NSString* resourcePath = [filePath substringFromIndex:([rootPath length] + 1)]; + if (requestContentBody) { + if ([requestContentBody isKindOfClass:[NSString class]]) { + requestContentBody = [NSData dataWithContentsOfFile:requestContentBody]; + } else if (![requestContentBody isKindOfClass:[NSData class]]) { + HTTPLogError(@"Internal error"); + return nil; + } + } + return [[DAVResponse alloc] initWithMethod:method + headers:[request allHeaderFields] + bodyData:requestContentBody + resourcePath:resourcePath + rootPath:rootPath]; + } + } + + return nil; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.h b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.h new file mode 100644 index 00000000000..d7681770141 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.h @@ -0,0 +1,11 @@ +#import "HTTPResponse.h" + +@interface DAVResponse : NSObject { +@private + UInt64 _offset; + NSMutableDictionary* _headers; + NSData* _data; + NSInteger _status; +} +- (id) initWithMethod:(NSString*)method headers:(NSDictionary*)headers bodyData:(NSData*)body resourcePath:(NSString*)resourcePath rootPath:(NSString*)rootPath; +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.m b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.m new file mode 100644 index 00000000000..7bd69ace47d --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DAVResponse.m @@ -0,0 +1,372 @@ +#import + +#import "DAVResponse.h" +#import "HTTPLogging.h" + +// WebDAV specifications: http://webdav.org/specs/rfc4918.html + +typedef enum { + kDAVProperty_ResourceType = (1 << 0), + kDAVProperty_CreationDate = (1 << 1), + kDAVProperty_LastModified = (1 << 2), + kDAVProperty_ContentLength = (1 << 3), + kDAVAllProperties = kDAVProperty_ResourceType | kDAVProperty_CreationDate | kDAVProperty_LastModified | kDAVProperty_ContentLength +} DAVProperties; + +#define kXMLParseOptions (XML_PARSE_NONET | XML_PARSE_RECOVER | XML_PARSE_NOBLANKS | XML_PARSE_COMPACT | XML_PARSE_NOWARNING | XML_PARSE_NOERROR) + +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; + +@implementation DAVResponse + +static void _AddPropertyResponse(NSString* itemPath, NSString* resourcePath, DAVProperties properties, NSMutableString* xmlString) { + CFStringRef escapedPath = CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault, (__bridge CFStringRef)resourcePath, NULL, + CFSTR("<&>?+"), kCFStringEncodingUTF8); + if (escapedPath) { + NSDictionary* attributes = [[NSFileManager defaultManager] attributesOfItemAtPath:itemPath error:NULL]; + BOOL isDirectory = [[attributes fileType] isEqualToString:NSFileTypeDirectory]; + [xmlString appendString:@""]; + [xmlString appendFormat:@"%@", escapedPath]; + [xmlString appendString:@""]; + [xmlString appendString:@""]; + + if (properties & kDAVProperty_ResourceType) { + if (isDirectory) { + [xmlString appendString:@""]; + } else { + [xmlString appendString:@""]; + } + } + + if ((properties & kDAVProperty_CreationDate) && [attributes objectForKey:NSFileCreationDate]) { + NSDateFormatter* formatter = [[NSDateFormatter alloc] init]; + formatter.locale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US"]; + formatter.timeZone = [NSTimeZone timeZoneWithName:@"GMT"]; + formatter.dateFormat = @"yyyy-MM-dd'T'HH:mm:ss'+00:00'"; + [xmlString appendFormat:@"%@", [formatter stringFromDate:[attributes fileCreationDate]]]; + } + + if ((properties & kDAVProperty_LastModified) && [attributes objectForKey:NSFileModificationDate]) { + NSDateFormatter* formatter = [[NSDateFormatter alloc] init]; + formatter.locale = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US"]; + formatter.timeZone = [NSTimeZone timeZoneWithName:@"GMT"]; + formatter.dateFormat = @"EEE', 'd' 'MMM' 'yyyy' 'HH:mm:ss' GMT'"; + [xmlString appendFormat:@"%@", [formatter stringFromDate:[attributes fileModificationDate]]]; + } + + if ((properties & kDAVProperty_ContentLength) && !isDirectory && [attributes objectForKey:NSFileSize]) { + [xmlString appendFormat:@"%qu", [attributes fileSize]]; + } + + [xmlString appendString:@""]; + [xmlString appendString:@"HTTP/1.1 200 OK"]; + [xmlString appendString:@""]; + [xmlString appendString:@"\n"]; + CFRelease(escapedPath); + } +} + +static xmlNodePtr _XMLChildWithName(xmlNodePtr child, const xmlChar* name) { + while (child) { + if ((child->type == XML_ELEMENT_NODE) && !xmlStrcmp(child->name, name)) { + return child; + } + child = child->next; + } + return NULL; +} + +- (id) initWithMethod:(NSString*)method headers:(NSDictionary*)headers bodyData:(NSData*)body resourcePath:(NSString*)resourcePath rootPath:(NSString*)rootPath { + if ((self = [super init])) { + _status = 200; + _headers = [[NSMutableDictionary alloc] init]; + + // 10.1 DAV Header + if ([method isEqualToString:@"OPTIONS"]) { + if ([[headers objectForKey:@"User-Agent"] hasPrefix:@"WebDAVFS/"]) { // Mac OS X WebDAV support + [_headers setObject:@"1, 2" forKey:@"DAV"]; + } else { + [_headers setObject:@"1" forKey:@"DAV"]; + } + } + + // 9.1 PROPFIND Method + if ([method isEqualToString:@"PROPFIND"]) { + NSInteger depth; + NSString* depthHeader = [headers objectForKey:@"Depth"]; + if ([depthHeader isEqualToString:@"0"]) { + depth = 0; + } else if ([depthHeader isEqualToString:@"1"]) { + depth = 1; + } else { + HTTPLogError(@"Unsupported DAV depth \"%@\"", depthHeader); + return nil; + } + + DAVProperties properties = 0; + xmlDocPtr document = xmlReadMemory(body.bytes, (int)body.length, NULL, NULL, kXMLParseOptions); + if (document) { + xmlNodePtr node = _XMLChildWithName(document->children, (const xmlChar*)"propfind"); + if (node) { + node = _XMLChildWithName(node->children, (const xmlChar*)"prop"); + } + if (node) { + node = node->children; + while (node) { + if (!xmlStrcmp(node->name, (const xmlChar*)"resourcetype")) { + properties |= kDAVProperty_ResourceType; + } else if (!xmlStrcmp(node->name, (const xmlChar*)"creationdate")) { + properties |= kDAVProperty_CreationDate; + } else if (!xmlStrcmp(node->name, (const xmlChar*)"getlastmodified")) { + properties |= kDAVProperty_LastModified; + } else if (!xmlStrcmp(node->name, (const xmlChar*)"getcontentlength")) { + properties |= kDAVProperty_ContentLength; + } else { + HTTPLogWarn(@"Unknown DAV property requested \"%s\"", node->name); + } + node = node->next; + } + } else { + HTTPLogWarn(@"HTTP Server: Invalid DAV properties\n%@", [[NSString alloc] initWithData:body encoding:NSUTF8StringEncoding]); + } + xmlFreeDoc(document); + } + if (!properties) { + properties = kDAVAllProperties; + } + + NSString* basePath = [rootPath stringByAppendingPathComponent:resourcePath]; + if (![basePath hasPrefix:rootPath] || ![[NSFileManager defaultManager] fileExistsAtPath:basePath]) { + return nil; + } + + NSMutableString* xmlString = [NSMutableString stringWithString:@""]; + [xmlString appendString:@"\n"]; + if (![resourcePath hasPrefix:@"/"]) { + resourcePath = [@"/" stringByAppendingString:resourcePath]; + } + _AddPropertyResponse(basePath, resourcePath, properties, xmlString); + if (depth == 1) { + if (![resourcePath hasSuffix:@"/"]) { + resourcePath = [resourcePath stringByAppendingString:@"/"]; + } + NSDirectoryEnumerator* enumerator = [[NSFileManager defaultManager] enumeratorAtPath:basePath]; + NSString* path; + while ((path = [enumerator nextObject])) { + _AddPropertyResponse([basePath stringByAppendingPathComponent:path], [resourcePath stringByAppendingString:path], properties, xmlString); + [enumerator skipDescendents]; + } + } + [xmlString appendString:@""]; + + [_headers setObject:@"application/xml; charset=\"utf-8\"" forKey:@"Content-Type"]; + _data = [xmlString dataUsingEncoding:NSUTF8StringEncoding]; + _status = 207; + } + + // 9.3 MKCOL Method + if ([method isEqualToString:@"MKCOL"]) { + NSString* path = [rootPath stringByAppendingPathComponent:resourcePath]; + if (![path hasPrefix:rootPath]) { + return nil; + } + + if (![[NSFileManager defaultManager] fileExistsAtPath:[path stringByDeletingLastPathComponent]]) { + HTTPLogError(@"Missing intermediate collection(s) at \"%@\"", path); + _status = 409; + } else if (![[NSFileManager defaultManager] createDirectoryAtPath:path withIntermediateDirectories:NO attributes:nil error:NULL]) { + HTTPLogError(@"Failed creating collection at \"%@\"", path); + _status = 405; + } + } + + // 9.8 COPY Method + // 9.9 MOVE Method + if ([method isEqualToString:@"MOVE"] || [method isEqualToString:@"COPY"]) { + if ([method isEqualToString:@"COPY"] && ![[headers objectForKey:@"Depth"] isEqualToString:@"infinity"]) { + HTTPLogError(@"Unsupported DAV depth \"%@\"", [headers objectForKey:@"Depth"]); + return nil; + } + + NSString* sourcePath = [rootPath stringByAppendingPathComponent:resourcePath]; + if (![sourcePath hasPrefix:rootPath] || ![[NSFileManager defaultManager] fileExistsAtPath:sourcePath]) { + return nil; + } + + NSString* destination = [headers objectForKey:@"Destination"]; + NSRange range = [destination rangeOfString:[headers objectForKey:@"Host"]]; + if (range.location == NSNotFound) { + return nil; + } + NSString* destinationPath = [rootPath stringByAppendingPathComponent: + [[destination substringFromIndex:(range.location + range.length)] stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding]]; + if (![destinationPath hasPrefix:rootPath] || [[NSFileManager defaultManager] fileExistsAtPath:destinationPath]) { + return nil; + } + + BOOL isDirectory; + if (![[NSFileManager defaultManager] fileExistsAtPath:[destinationPath stringByDeletingLastPathComponent] isDirectory:&isDirectory] || !isDirectory) { + HTTPLogError(@"Invalid destination path \"%@\"", destinationPath); + _status = 409; + } else { + BOOL existing = [[NSFileManager defaultManager] fileExistsAtPath:destinationPath]; + if (existing && [[headers objectForKey:@"Overwrite"] isEqualToString:@"F"]) { + HTTPLogError(@"Pre-existing destination path \"%@\"", destinationPath); + _status = 412; + } else { + if ([method isEqualToString:@"COPY"]) { + if ([[NSFileManager defaultManager] copyItemAtPath:sourcePath toPath:destinationPath error:NULL]) { + _status = existing ? 204 : 201; + } else { + HTTPLogError(@"Failed copying \"%@\" to \"%@\"", sourcePath, destinationPath); + _status = 403; + } + } else { + if ([[NSFileManager defaultManager] moveItemAtPath:sourcePath toPath:destinationPath error:NULL]) { + _status = existing ? 204 : 201; + } else { + HTTPLogError(@"Failed moving \"%@\" to \"%@\"", sourcePath, destinationPath); + _status = 403; + } + } + } + } + } + + // 9.10 LOCK Method - TODO: Actually lock the resource + if ([method isEqualToString:@"LOCK"]) { + NSString* path = [rootPath stringByAppendingPathComponent:resourcePath]; + if (![path hasPrefix:rootPath]) { + return nil; + } + + NSString* depth = [headers objectForKey:@"Depth"]; + NSString* scope = nil; + NSString* type = nil; + NSString* owner = nil; + NSString* token = nil; + xmlDocPtr document = xmlReadMemory(body.bytes, (int)body.length, NULL, NULL, kXMLParseOptions); + if (document) { + xmlNodePtr node = _XMLChildWithName(document->children, (const xmlChar*)"lockinfo"); + if (node) { + xmlNodePtr scopeNode = _XMLChildWithName(node->children, (const xmlChar*)"lockscope"); + if (scopeNode && scopeNode->children && scopeNode->children->name) { + scope = [NSString stringWithUTF8String:(const char*)scopeNode->children->name]; + } + xmlNodePtr typeNode = _XMLChildWithName(node->children, (const xmlChar*)"locktype"); + if (typeNode && typeNode->children && typeNode->children->name) { + type = [NSString stringWithUTF8String:(const char*)typeNode->children->name]; + } + xmlNodePtr ownerNode = _XMLChildWithName(node->children, (const xmlChar*)"owner"); + if (ownerNode) { + ownerNode = _XMLChildWithName(ownerNode->children, (const xmlChar*)"href"); + if (ownerNode && ownerNode->children && ownerNode->children->content) { + owner = [NSString stringWithUTF8String:(const char*)ownerNode->children->content]; + } + } + } else { + HTTPLogWarn(@"HTTP Server: Invalid DAV properties\n%@", [[NSString alloc] initWithData:body encoding:NSUTF8StringEncoding]); + } + xmlFreeDoc(document); + } else { + // No body, see if they're trying to refresh an existing lock. If so, then just fake up the scope, type and depth so we fall + // into the lock create case. + NSString* lockToken; + if ((lockToken = [headers objectForKey:@"If"]) != nil) { + scope = @"exclusive"; + type = @"write"; + depth = @"0"; + token = [lockToken stringByTrimmingCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"(<>)"]]; + } + } + if ([scope isEqualToString:@"exclusive"] && [type isEqualToString:@"write"] && [depth isEqualToString:@"0"] && + ([[NSFileManager defaultManager] fileExistsAtPath:path] || [[NSData data] writeToFile:path atomically:YES])) { + NSString* timeout = [headers objectForKey:@"Timeout"]; + if (!token) { + CFUUIDRef uuid = CFUUIDCreate(kCFAllocatorDefault); + NSString *uuidStr = (__bridge_transfer NSString *)CFUUIDCreateString(kCFAllocatorDefault, uuid); + token = [NSString stringWithFormat:@"urn:uuid:%@", uuidStr]; + CFRelease(uuid); + } + + NSMutableString* xmlString = [NSMutableString stringWithString:@""]; + [xmlString appendString:@"\n"]; + [xmlString appendString:@"\n\n"]; + [xmlString appendFormat:@"\n", type]; + [xmlString appendFormat:@"\n", scope]; + [xmlString appendFormat:@"%@\n", depth]; + if (owner) { + [xmlString appendFormat:@"%@\n", owner]; + } + if (timeout) { + [xmlString appendFormat:@"%@\n", timeout]; + } + [xmlString appendFormat:@"%@\n", token]; + NSString* lockroot = [@"http://" stringByAppendingString:[[headers objectForKey:@"Host"] stringByAppendingString:[@"/" stringByAppendingString:resourcePath]]]; + [xmlString appendFormat:@"%@\n", lockroot]; + [xmlString appendString:@"\n\n"]; + [xmlString appendString:@""]; + + [_headers setObject:@"application/xml; charset=\"utf-8\"" forKey:@"Content-Type"]; + _data = [xmlString dataUsingEncoding:NSUTF8StringEncoding]; + _status = 200; + HTTPLogVerbose(@"Pretending to lock \"%@\"", resourcePath); + } else { + HTTPLogError(@"Locking request \"%@/%@/%@\" for \"%@\" is not allowed", scope, type, depth, resourcePath); + _status = 403; + } + } + + // 9.11 UNLOCK Method - TODO: Actually unlock the resource + if ([method isEqualToString:@"UNLOCK"]) { + NSString* path = [rootPath stringByAppendingPathComponent:resourcePath]; + if (![path hasPrefix:rootPath] || ![[NSFileManager defaultManager] fileExistsAtPath:path]) { + return nil; + } + + NSString* token = [headers objectForKey:@"Lock-Token"]; + _status = token ? 204 : 400; + HTTPLogVerbose(@"Pretending to unlock \"%@\"", resourcePath); + } + + } + return self; +} + + +- (UInt64) contentLength { + return _data ? _data.length : 0; +} + +- (UInt64) offset { + return _offset; +} + +- (void) setOffset:(UInt64)offset { + _offset = offset; +} + +- (NSData*) readDataOfLength:(NSUInteger)lengthParameter { + if (_data) { + NSUInteger remaining = _data.length - (NSUInteger)_offset; + NSUInteger length = lengthParameter < remaining ? lengthParameter : remaining; + void* bytes = (void*)(_data.bytes + _offset); + _offset += length; + return [NSData dataWithBytesNoCopy:bytes length:length freeWhenDone:NO]; + } + return nil; +} + +- (BOOL) isDone { + return _data ? _offset == _data.length : YES; +} + +- (NSInteger) status { + return _status; +} + +- (NSDictionary*) httpHeaders { + return _headers; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.h b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.h new file mode 100644 index 00000000000..0395327c133 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.h @@ -0,0 +1,7 @@ +#import "HTTPResponse.h" + +@interface DELETEResponse : NSObject { + NSInteger _status; +} +- (id) initWithFilePath:(NSString*)path; +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.m b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.m new file mode 100644 index 00000000000..d3d1d68fdea --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/DELETEResponse.m @@ -0,0 +1,49 @@ +#import "DELETEResponse.h" +#import "HTTPLogging.h" + +// HTTP methods: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html +// HTTP headers: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html +// HTTP status codes: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html + +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; + +@implementation DELETEResponse + +- (id) initWithFilePath:(NSString*)path { + if ((self = [super init])) { + BOOL exists = [[NSFileManager defaultManager] fileExistsAtPath:path]; + if ([[NSFileManager defaultManager] removeItemAtPath:path error:NULL]) { + _status = exists ? 200 : 204; + } else { + HTTPLogError(@"Failed deleting \"%@\"", path); + _status = 404; + } + } + return self; +} + +- (UInt64) contentLength { + return 0; +} + +- (UInt64) offset { + return 0; +} + +- (void)setOffset:(UInt64)offset { + ; +} + +- (NSData*) readDataOfLength:(NSUInteger)length { + return nil; +} + +- (BOOL) isDone { + return YES; +} + +- (NSInteger) status { + return _status; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.h b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.h new file mode 100644 index 00000000000..7d93a8f7d7f --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.h @@ -0,0 +1,8 @@ +#import "HTTPResponse.h" + +@interface PUTResponse : NSObject { + NSInteger _status; +} +- (id) initWithFilePath:(NSString*)path headers:(NSDictionary*)headers bodyData:(NSData*)body; +- (id) initWithFilePath:(NSString*)path headers:(NSDictionary*)headers bodyFile:(NSString*)body; +@end diff --git a/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.m b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.m new file mode 100644 index 00000000000..811d1a147ed --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Extensions/WebDAV/PUTResponse.m @@ -0,0 +1,69 @@ +#import "PUTResponse.h" +#import "HTTPLogging.h" + +// HTTP methods: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html +// HTTP headers: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html +// HTTP status codes: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html + +static const int httpLogLevel = HTTP_LOG_LEVEL_WARN; + +@implementation PUTResponse + +- (id) initWithFilePath:(NSString*)path headers:(NSDictionary*)headers body:(id)body { + if ((self = [super init])) { + if ([headers objectForKey:@"Content-Range"]) { + HTTPLogError(@"Content-Range not supported for upload to \"%@\"", path); + _status = 400; + } else { + BOOL overwrite = [[NSFileManager defaultManager] fileExistsAtPath:path]; + BOOL success; + if ([body isKindOfClass:[NSString class]]) { + [[NSFileManager defaultManager] removeItemAtPath:path error:NULL]; + success = [[NSFileManager defaultManager] moveItemAtPath:body toPath:path error:NULL]; + } else { + success = [body writeToFile:path atomically:YES]; + } + if (success) { + _status = overwrite ? 200 : 201; + } else { + HTTPLogError(@"Failed writing upload to \"%@\"", path); + _status = 403; + } + } + } + return self; +} + +- (id) initWithFilePath:(NSString*)path headers:(NSDictionary*)headers bodyData:(NSData*)body { + return [self initWithFilePath:path headers:headers body:body]; +} + +- (id) initWithFilePath:(NSString*)path headers:(NSDictionary*)headers bodyFile:(NSString*)body { + return [self initWithFilePath:path headers:headers body:body]; +} + +- (UInt64) contentLength { + return 0; +} + +- (UInt64) offset { + return 0; +} + +- (void) setOffset:(UInt64)offset { + ; +} + +- (NSData*) readDataOfLength:(NSUInteger)length { + return nil; +} + +- (BOOL) isDone { + return YES; +} + +- (NSInteger) status { + return _status; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/LICENSE.txt b/platform/iphone/CocoaHTTPServer/LICENSE.txt new file mode 100644 index 00000000000..64c3c902bf6 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/LICENSE.txt @@ -0,0 +1,18 @@ +Software License Agreement (BSD License) + +Copyright (c) 2011, Deusty, LLC +All rights reserved. + +Redistribution and use of this software in source and binary forms, +with or without modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above + copyright notice, this list of conditions and the + following disclaimer. + +* Neither the name of Deusty nor the names of its + contributors may be used to endorse or promote products + derived from this software without specific prior + written permission of Deusty, LLC. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER 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. \ No newline at end of file diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/About.txt b/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/About.txt new file mode 100644 index 00000000000..63547dd460e --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/About.txt @@ -0,0 +1,4 @@ +The CocoaAsyncSocket project is under Public Domain license. +http://code.google.com/p/cocoaasyncsocket/ + +The AsyncSocket project has been around since 2001 and is used in many applications and frameworks. \ No newline at end of file diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.h new file mode 100644 index 00000000000..cf9927f7708 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.h @@ -0,0 +1,1074 @@ +// +// GCDAsyncSocket.h +// +// This class is in the public domain. +// Originally created by Robbie Hanson in Q3 2010. +// Updated and maintained by Deusty LLC and the Apple development community. +// +// https://github.com/robbiehanson/CocoaAsyncSocket +// + +#import +#import +#import +#import + +@class GCDAsyncReadPacket; +@class GCDAsyncWritePacket; +@class GCDAsyncSocketPreBuffer; + +#if TARGET_OS_IPHONE + + // Compiling for iOS + + #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 50000 // iOS 5.0 supported + + #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 50000 // iOS 5.0 supported and required + + #define IS_SECURE_TRANSPORT_AVAILABLE YES + #define SECURE_TRANSPORT_MAYBE_AVAILABLE 1 + #define SECURE_TRANSPORT_MAYBE_UNAVAILABLE 0 + + #else // iOS 5.0 supported but not required + + #ifndef NSFoundationVersionNumber_iPhoneOS_5_0 + #define NSFoundationVersionNumber_iPhoneOS_5_0 881.00 + #endif + + #define IS_SECURE_TRANSPORT_AVAILABLE (NSFoundationVersionNumber >= NSFoundationVersionNumber_iPhoneOS_5_0) + #define SECURE_TRANSPORT_MAYBE_AVAILABLE 1 + #define SECURE_TRANSPORT_MAYBE_UNAVAILABLE 1 + + #endif + + #else // iOS 5.0 not supported + + #define IS_SECURE_TRANSPORT_AVAILABLE NO + #define SECURE_TRANSPORT_MAYBE_AVAILABLE 0 + #define SECURE_TRANSPORT_MAYBE_UNAVAILABLE 1 + + #endif + +#else + + // Compiling for Mac OS X + + #define IS_SECURE_TRANSPORT_AVAILABLE YES + #define SECURE_TRANSPORT_MAYBE_AVAILABLE 1 + #define SECURE_TRANSPORT_MAYBE_UNAVAILABLE 0 + +#endif + +extern NSString *const GCDAsyncSocketException; +extern NSString *const GCDAsyncSocketErrorDomain; + +extern NSString *const GCDAsyncSocketQueueName; +extern NSString *const GCDAsyncSocketThreadName; + +#if SECURE_TRANSPORT_MAYBE_AVAILABLE +extern NSString *const GCDAsyncSocketSSLCipherSuites; +#if TARGET_OS_IPHONE +extern NSString *const GCDAsyncSocketSSLProtocolVersionMin; +extern NSString *const GCDAsyncSocketSSLProtocolVersionMax; +#else +extern NSString *const GCDAsyncSocketSSLDiffieHellmanParameters; +#endif +#endif + +enum GCDAsyncSocketError +{ + GCDAsyncSocketNoError = 0, // Never used + GCDAsyncSocketBadConfigError, // Invalid configuration + GCDAsyncSocketBadParamError, // Invalid parameter was passed + GCDAsyncSocketConnectTimeoutError, // A connect operation timed out + GCDAsyncSocketReadTimeoutError, // A read operation timed out + GCDAsyncSocketWriteTimeoutError, // A write operation timed out + GCDAsyncSocketReadMaxedOutError, // Reached set maxLength without completing + GCDAsyncSocketClosedError, // The remote peer closed the connection + GCDAsyncSocketOtherError, // Description provided in userInfo +}; +typedef enum GCDAsyncSocketError GCDAsyncSocketError; + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@interface GCDAsyncSocket : NSObject + +/** + * GCDAsyncSocket uses the standard delegate paradigm, + * but executes all delegate callbacks on a given delegate dispatch queue. + * This allows for maximum concurrency, while at the same time providing easy thread safety. + * + * You MUST set a delegate AND delegate dispatch queue before attempting to + * use the socket, or you will get an error. + * + * The socket queue is optional. + * If you pass NULL, GCDAsyncSocket will automatically create it's own socket queue. + * If you choose to provide a socket queue, the socket queue must not be a concurrent queue. + * If you choose to provide a socket queue, and the socket queue has a configured target queue, + * then please see the discussion for the method markSocketQueueTargetQueue. + * + * The delegate queue and socket queue can optionally be the same. +**/ +- (id)init; +- (id)initWithSocketQueue:(dispatch_queue_t)sq; +- (id)initWithDelegate:(id)aDelegate delegateQueue:(dispatch_queue_t)dq; +- (id)initWithDelegate:(id)aDelegate delegateQueue:(dispatch_queue_t)dq socketQueue:(dispatch_queue_t)sq; + +#pragma mark Configuration + +- (id)delegate; +- (void)setDelegate:(id)delegate; +- (void)synchronouslySetDelegate:(id)delegate; + +- (dispatch_queue_t)delegateQueue; +- (void)setDelegateQueue:(dispatch_queue_t)delegateQueue; +- (void)synchronouslySetDelegateQueue:(dispatch_queue_t)delegateQueue; + +- (void)getDelegate:(id *)delegatePtr delegateQueue:(dispatch_queue_t *)delegateQueuePtr; +- (void)setDelegate:(id)delegate delegateQueue:(dispatch_queue_t)delegateQueue; +- (void)synchronouslySetDelegate:(id)delegate delegateQueue:(dispatch_queue_t)delegateQueue; + +/** + * By default, both IPv4 and IPv6 are enabled. + * + * For accepting incoming connections, this means GCDAsyncSocket automatically supports both protocols, + * and can simulataneously accept incoming connections on either protocol. + * + * For outgoing connections, this means GCDAsyncSocket can connect to remote hosts running either protocol. + * If a DNS lookup returns only IPv4 results, GCDAsyncSocket will automatically use IPv4. + * If a DNS lookup returns only IPv6 results, GCDAsyncSocket will automatically use IPv6. + * If a DNS lookup returns both IPv4 and IPv6 results, the preferred protocol will be chosen. + * By default, the preferred protocol is IPv4, but may be configured as desired. +**/ +- (BOOL)isIPv4Enabled; +- (void)setIPv4Enabled:(BOOL)flag; + +- (BOOL)isIPv6Enabled; +- (void)setIPv6Enabled:(BOOL)flag; + +- (BOOL)isIPv4PreferredOverIPv6; +- (void)setPreferIPv4OverIPv6:(BOOL)flag; + +/** + * User data allows you to associate arbitrary information with the socket. + * This data is not used internally by socket in any way. +**/ +- (id)userData; +- (void)setUserData:(id)arbitraryUserData; + +#pragma mark Accepting + +/** + * Tells the socket to begin listening and accepting connections on the given port. + * When a connection is accepted, a new instance of GCDAsyncSocket will be spawned to handle it, + * and the socket:didAcceptNewSocket: delegate method will be invoked. + * + * The socket will listen on all available interfaces (e.g. wifi, ethernet, etc) +**/ +- (BOOL)acceptOnPort:(uint16_t)port error:(NSError **)errPtr; + +/** + * This method is the same as acceptOnPort:error: with the + * additional option of specifying which interface to listen on. + * + * For example, you could specify that the socket should only accept connections over ethernet, + * and not other interfaces such as wifi. + * + * The interface may be specified by name (e.g. "en1" or "lo0") or by IP address (e.g. "192.168.4.34"). + * You may also use the special strings "localhost" or "loopback" to specify that + * the socket only accept connections from the local machine. + * + * You can see the list of interfaces via the command line utility "ifconfig", + * or programmatically via the getifaddrs() function. + * + * To accept connections on any interface pass nil, or simply use the acceptOnPort:error: method. +**/ +- (BOOL)acceptOnInterface:(NSString *)interface port:(uint16_t)port error:(NSError **)errPtr; + +#pragma mark Connecting + +/** + * Connects to the given host and port. + * + * This method invokes connectToHost:onPort:viaInterface:withTimeout:error: + * and uses the default interface, and no timeout. +**/ +- (BOOL)connectToHost:(NSString *)host onPort:(uint16_t)port error:(NSError **)errPtr; + +/** + * Connects to the given host and port with an optional timeout. + * + * This method invokes connectToHost:onPort:viaInterface:withTimeout:error: and uses the default interface. +**/ +- (BOOL)connectToHost:(NSString *)host + onPort:(uint16_t)port + withTimeout:(NSTimeInterval)timeout + error:(NSError **)errPtr; + +/** + * Connects to the given host & port, via the optional interface, with an optional timeout. + * + * The host may be a domain name (e.g. "deusty.com") or an IP address string (e.g. "192.168.0.2"). + * The host may also be the special strings "localhost" or "loopback" to specify connecting + * to a service on the local machine. + * + * The interface may be a name (e.g. "en1" or "lo0") or the corresponding IP address (e.g. "192.168.4.35"). + * The interface may also be used to specify the local port (see below). + * + * To not time out use a negative time interval. + * + * This method will return NO if an error is detected, and set the error pointer (if one was given). + * Possible errors would be a nil host, invalid interface, or socket is already connected. + * + * If no errors are detected, this method will start a background connect operation and immediately return YES. + * The delegate callbacks are used to notify you when the socket connects, or if the host was unreachable. + * + * Since this class supports queued reads and writes, you can immediately start reading and/or writing. + * All read/write operations will be queued, and upon socket connection, + * the operations will be dequeued and processed in order. + * + * The interface may optionally contain a port number at the end of the string, separated by a colon. + * This allows you to specify the local port that should be used for the outgoing connection. (read paragraph to end) + * To specify both interface and local port: "en1:8082" or "192.168.4.35:2424". + * To specify only local port: ":8082". + * Please note this is an advanced feature, and is somewhat hidden on purpose. + * You should understand that 99.999% of the time you should NOT specify the local port for an outgoing connection. + * If you think you need to, there is a very good chance you have a fundamental misunderstanding somewhere. + * Local ports do NOT need to match remote ports. In fact, they almost never do. + * This feature is here for networking professionals using very advanced techniques. +**/ +- (BOOL)connectToHost:(NSString *)host + onPort:(uint16_t)port + viaInterface:(NSString *)interface + withTimeout:(NSTimeInterval)timeout + error:(NSError **)errPtr; + +/** + * Connects to the given address, specified as a sockaddr structure wrapped in a NSData object. + * For example, a NSData object returned from NSNetService's addresses method. + * + * If you have an existing struct sockaddr you can convert it to a NSData object like so: + * struct sockaddr sa -> NSData *dsa = [NSData dataWithBytes:&remoteAddr length:remoteAddr.sa_len]; + * struct sockaddr *sa -> NSData *dsa = [NSData dataWithBytes:remoteAddr length:remoteAddr->sa_len]; + * + * This method invokes connectToAdd +**/ +- (BOOL)connectToAddress:(NSData *)remoteAddr error:(NSError **)errPtr; + +/** + * This method is the same as connectToAddress:error: with an additional timeout option. + * To not time out use a negative time interval, or simply use the connectToAddress:error: method. +**/ +- (BOOL)connectToAddress:(NSData *)remoteAddr withTimeout:(NSTimeInterval)timeout error:(NSError **)errPtr; + +/** + * Connects to the given address, using the specified interface and timeout. + * + * The address is specified as a sockaddr structure wrapped in a NSData object. + * For example, a NSData object returned from NSNetService's addresses method. + * + * If you have an existing struct sockaddr you can convert it to a NSData object like so: + * struct sockaddr sa -> NSData *dsa = [NSData dataWithBytes:&remoteAddr length:remoteAddr.sa_len]; + * struct sockaddr *sa -> NSData *dsa = [NSData dataWithBytes:remoteAddr length:remoteAddr->sa_len]; + * + * The interface may be a name (e.g. "en1" or "lo0") or the corresponding IP address (e.g. "192.168.4.35"). + * The interface may also be used to specify the local port (see below). + * + * The timeout is optional. To not time out use a negative time interval. + * + * This method will return NO if an error is detected, and set the error pointer (if one was given). + * Possible errors would be a nil host, invalid interface, or socket is already connected. + * + * If no errors are detected, this method will start a background connect operation and immediately return YES. + * The delegate callbacks are used to notify you when the socket connects, or if the host was unreachable. + * + * Since this class supports queued reads and writes, you can immediately start reading and/or writing. + * All read/write operations will be queued, and upon socket connection, + * the operations will be dequeued and processed in order. + * + * The interface may optionally contain a port number at the end of the string, separated by a colon. + * This allows you to specify the local port that should be used for the outgoing connection. (read paragraph to end) + * To specify both interface and local port: "en1:8082" or "192.168.4.35:2424". + * To specify only local port: ":8082". + * Please note this is an advanced feature, and is somewhat hidden on purpose. + * You should understand that 99.999% of the time you should NOT specify the local port for an outgoing connection. + * If you think you need to, there is a very good chance you have a fundamental misunderstanding somewhere. + * Local ports do NOT need to match remote ports. In fact, they almost never do. + * This feature is here for networking professionals using very advanced techniques. +**/ +- (BOOL)connectToAddress:(NSData *)remoteAddr + viaInterface:(NSString *)interface + withTimeout:(NSTimeInterval)timeout + error:(NSError **)errPtr; + +#pragma mark Disconnecting + +/** + * Disconnects immediately (synchronously). Any pending reads or writes are dropped. + * + * If the socket is not already disconnected, an invocation to the socketDidDisconnect:withError: delegate method + * will be queued onto the delegateQueue asynchronously (behind any previously queued delegate methods). + * In other words, the disconnected delegate method will be invoked sometime shortly after this method returns. + * + * Please note the recommended way of releasing a GCDAsyncSocket instance (e.g. in a dealloc method) + * [asyncSocket setDelegate:nil]; + * [asyncSocket disconnect]; + * [asyncSocket release]; + * + * If you plan on disconnecting the socket, and then immediately asking it to connect again, + * you'll likely want to do so like this: + * [asyncSocket setDelegate:nil]; + * [asyncSocket disconnect]; + * [asyncSocket setDelegate:self]; + * [asyncSocket connect...]; +**/ +- (void)disconnect; + +/** + * Disconnects after all pending reads have completed. + * After calling this, the read and write methods will do nothing. + * The socket will disconnect even if there are still pending writes. +**/ +- (void)disconnectAfterReading; + +/** + * Disconnects after all pending writes have completed. + * After calling this, the read and write methods will do nothing. + * The socket will disconnect even if there are still pending reads. +**/ +- (void)disconnectAfterWriting; + +/** + * Disconnects after all pending reads and writes have completed. + * After calling this, the read and write methods will do nothing. +**/ +- (void)disconnectAfterReadingAndWriting; + +#pragma mark Diagnostics + +/** + * Returns whether the socket is disconnected or connected. + * + * A disconnected socket may be recycled. + * That is, it can used again for connecting or listening. + * + * If a socket is in the process of connecting, it may be neither disconnected nor connected. +**/ +- (BOOL)isDisconnected; +- (BOOL)isConnected; + +/** + * Returns the local or remote host and port to which this socket is connected, or nil and 0 if not connected. + * The host will be an IP address. +**/ +- (NSString *)connectedHost; +- (uint16_t)connectedPort; + +- (NSString *)localHost; +- (uint16_t)localPort; + +/** + * Returns the local or remote address to which this socket is connected, + * specified as a sockaddr structure wrapped in a NSData object. + * + * See also the connectedHost, connectedPort, localHost and localPort methods. +**/ +- (NSData *)connectedAddress; +- (NSData *)localAddress; + +/** + * Returns whether the socket is IPv4 or IPv6. + * An accepting socket may be both. +**/ +- (BOOL)isIPv4; +- (BOOL)isIPv6; + +/** + * Returns whether or not the socket has been secured via SSL/TLS. + * + * See also the startTLS method. +**/ +- (BOOL)isSecure; + +#pragma mark Reading + +// The readData and writeData methods won't block (they are asynchronous). +// +// When a read is complete the socket:didReadData:withTag: delegate method is dispatched on the delegateQueue. +// When a write is complete the socket:didWriteDataWithTag: delegate method is dispatched on the delegateQueue. +// +// You may optionally set a timeout for any read/write operation. (To not timeout, use a negative time interval.) +// If a read/write opertion times out, the corresponding "socket:shouldTimeout..." delegate method +// is called to optionally allow you to extend the timeout. +// Upon a timeout, the "socket:didDisconnectWithError:" method is called +// +// The tag is for your convenience. +// You can use it as an array index, step number, state id, pointer, etc. + +/** + * Reads the first available bytes that become available on the socket. + * + * If the timeout value is negative, the read operation will not use a timeout. +**/ +- (void)readDataWithTimeout:(NSTimeInterval)timeout tag:(long)tag; + +/** + * Reads the first available bytes that become available on the socket. + * The bytes will be appended to the given byte buffer starting at the given offset. + * The given buffer will automatically be increased in size if needed. + * + * If the timeout value is negative, the read operation will not use a timeout. + * If the buffer if nil, the socket will create a buffer for you. + * + * If the bufferOffset is greater than the length of the given buffer, + * the method will do nothing, and the delegate will not be called. + * + * If you pass a buffer, you must not alter it in any way while the socket is using it. + * After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer. + * That is, it will reference the bytes that were appended to the given buffer via + * the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO]. +**/ +- (void)readDataWithTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + tag:(long)tag; + +/** + * Reads the first available bytes that become available on the socket. + * The bytes will be appended to the given byte buffer starting at the given offset. + * The given buffer will automatically be increased in size if needed. + * A maximum of length bytes will be read. + * + * If the timeout value is negative, the read operation will not use a timeout. + * If the buffer if nil, a buffer will automatically be created for you. + * If maxLength is zero, no length restriction is enforced. + * + * If the bufferOffset is greater than the length of the given buffer, + * the method will do nothing, and the delegate will not be called. + * + * If you pass a buffer, you must not alter it in any way while the socket is using it. + * After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer. + * That is, it will reference the bytes that were appended to the given buffer via + * the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO]. +**/ +- (void)readDataWithTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + maxLength:(NSUInteger)length + tag:(long)tag; + +/** + * Reads the given number of bytes. + * + * If the timeout value is negative, the read operation will not use a timeout. + * + * If the length is 0, this method does nothing and the delegate is not called. +**/ +- (void)readDataToLength:(NSUInteger)length withTimeout:(NSTimeInterval)timeout tag:(long)tag; + +/** + * Reads the given number of bytes. + * The bytes will be appended to the given byte buffer starting at the given offset. + * The given buffer will automatically be increased in size if needed. + * + * If the timeout value is negative, the read operation will not use a timeout. + * If the buffer if nil, a buffer will automatically be created for you. + * + * If the length is 0, this method does nothing and the delegate is not called. + * If the bufferOffset is greater than the length of the given buffer, + * the method will do nothing, and the delegate will not be called. + * + * If you pass a buffer, you must not alter it in any way while AsyncSocket is using it. + * After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer. + * That is, it will reference the bytes that were appended to the given buffer via + * the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO]. +**/ +- (void)readDataToLength:(NSUInteger)length + withTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + tag:(long)tag; + +/** + * Reads bytes until (and including) the passed "data" parameter, which acts as a separator. + * + * If the timeout value is negative, the read operation will not use a timeout. + * + * If you pass nil or zero-length data as the "data" parameter, + * the method will do nothing (except maybe print a warning), and the delegate will not be called. + * + * To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the "data" parameter. + * If you're developing your own custom protocol, be sure your separator can not occur naturally as + * part of the data between separators. + * For example, imagine you want to send several small documents over a socket. + * Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents. + * In this particular example, it would be better to use a protocol similar to HTTP with + * a header that includes the length of the document. + * Also be careful that your separator cannot occur naturally as part of the encoding for a character. + * + * The given data (separator) parameter should be immutable. + * For performance reasons, the socket will retain it, not copy it. + * So if it is immutable, don't modify it while the socket is using it. +**/ +- (void)readDataToData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag; + +/** + * Reads bytes until (and including) the passed "data" parameter, which acts as a separator. + * The bytes will be appended to the given byte buffer starting at the given offset. + * The given buffer will automatically be increased in size if needed. + * + * If the timeout value is negative, the read operation will not use a timeout. + * If the buffer if nil, a buffer will automatically be created for you. + * + * If the bufferOffset is greater than the length of the given buffer, + * the method will do nothing (except maybe print a warning), and the delegate will not be called. + * + * If you pass a buffer, you must not alter it in any way while the socket is using it. + * After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer. + * That is, it will reference the bytes that were appended to the given buffer via + * the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO]. + * + * To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the "data" parameter. + * If you're developing your own custom protocol, be sure your separator can not occur naturally as + * part of the data between separators. + * For example, imagine you want to send several small documents over a socket. + * Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents. + * In this particular example, it would be better to use a protocol similar to HTTP with + * a header that includes the length of the document. + * Also be careful that your separator cannot occur naturally as part of the encoding for a character. + * + * The given data (separator) parameter should be immutable. + * For performance reasons, the socket will retain it, not copy it. + * So if it is immutable, don't modify it while the socket is using it. +**/ +- (void)readDataToData:(NSData *)data + withTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + tag:(long)tag; + +/** + * Reads bytes until (and including) the passed "data" parameter, which acts as a separator. + * + * If the timeout value is negative, the read operation will not use a timeout. + * + * If maxLength is zero, no length restriction is enforced. + * Otherwise if maxLength bytes are read without completing the read, + * it is treated similarly to a timeout - the socket is closed with a GCDAsyncSocketReadMaxedOutError. + * The read will complete successfully if exactly maxLength bytes are read and the given data is found at the end. + * + * If you pass nil or zero-length data as the "data" parameter, + * the method will do nothing (except maybe print a warning), and the delegate will not be called. + * If you pass a maxLength parameter that is less than the length of the data parameter, + * the method will do nothing (except maybe print a warning), and the delegate will not be called. + * + * To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the "data" parameter. + * If you're developing your own custom protocol, be sure your separator can not occur naturally as + * part of the data between separators. + * For example, imagine you want to send several small documents over a socket. + * Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents. + * In this particular example, it would be better to use a protocol similar to HTTP with + * a header that includes the length of the document. + * Also be careful that your separator cannot occur naturally as part of the encoding for a character. + * + * The given data (separator) parameter should be immutable. + * For performance reasons, the socket will retain it, not copy it. + * So if it is immutable, don't modify it while the socket is using it. +**/ +- (void)readDataToData:(NSData *)data withTimeout:(NSTimeInterval)timeout maxLength:(NSUInteger)length tag:(long)tag; + +/** + * Reads bytes until (and including) the passed "data" parameter, which acts as a separator. + * The bytes will be appended to the given byte buffer starting at the given offset. + * The given buffer will automatically be increased in size if needed. + * + * If the timeout value is negative, the read operation will not use a timeout. + * If the buffer if nil, a buffer will automatically be created for you. + * + * If maxLength is zero, no length restriction is enforced. + * Otherwise if maxLength bytes are read without completing the read, + * it is treated similarly to a timeout - the socket is closed with a GCDAsyncSocketReadMaxedOutError. + * The read will complete successfully if exactly maxLength bytes are read and the given data is found at the end. + * + * If you pass a maxLength parameter that is less than the length of the data (separator) parameter, + * the method will do nothing (except maybe print a warning), and the delegate will not be called. + * If the bufferOffset is greater than the length of the given buffer, + * the method will do nothing (except maybe print a warning), and the delegate will not be called. + * + * If you pass a buffer, you must not alter it in any way while the socket is using it. + * After completion, the data returned in socket:didReadData:withTag: will be a subset of the given buffer. + * That is, it will reference the bytes that were appended to the given buffer via + * the method [NSData dataWithBytesNoCopy:length:freeWhenDone:NO]. + * + * To read a line from the socket, use the line separator (e.g. CRLF for HTTP, see below) as the "data" parameter. + * If you're developing your own custom protocol, be sure your separator can not occur naturally as + * part of the data between separators. + * For example, imagine you want to send several small documents over a socket. + * Using CRLF as a separator is likely unwise, as a CRLF could easily exist within the documents. + * In this particular example, it would be better to use a protocol similar to HTTP with + * a header that includes the length of the document. + * Also be careful that your separator cannot occur naturally as part of the encoding for a character. + * + * The given data (separator) parameter should be immutable. + * For performance reasons, the socket will retain it, not copy it. + * So if it is immutable, don't modify it while the socket is using it. +**/ +- (void)readDataToData:(NSData *)data + withTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + maxLength:(NSUInteger)length + tag:(long)tag; + +/** + * Returns progress of the current read, from 0.0 to 1.0, or NaN if no current read (use isnan() to check). + * The parameters "tag", "done" and "total" will be filled in if they aren't NULL. +**/ +- (float)progressOfReadReturningTag:(long *)tagPtr bytesDone:(NSUInteger *)donePtr total:(NSUInteger *)totalPtr; + +#pragma mark Writing + +/** + * Writes data to the socket, and calls the delegate when finished. + * + * If you pass in nil or zero-length data, this method does nothing and the delegate will not be called. + * If the timeout value is negative, the write operation will not use a timeout. + * + * Thread-Safety Note: + * If the given data parameter is mutable (NSMutableData) then you MUST NOT alter the data while + * the socket is writing it. In other words, it's not safe to alter the data until after the delegate method + * socket:didWriteDataWithTag: is invoked signifying that this particular write operation has completed. + * This is due to the fact that GCDAsyncSocket does NOT copy the data. It simply retains it. + * This is for performance reasons. Often times, if NSMutableData is passed, it is because + * a request/response was built up in memory. Copying this data adds an unwanted/unneeded overhead. + * If you need to write data from an immutable buffer, and you need to alter the buffer before the socket + * completes writing the bytes (which is NOT immediately after this method returns, but rather at a later time + * when the delegate method notifies you), then you should first copy the bytes, and pass the copy to this method. +**/ +- (void)writeData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag; + +/** + * Returns progress of the current write, from 0.0 to 1.0, or NaN if no current write (use isnan() to check). + * The parameters "tag", "done" and "total" will be filled in if they aren't NULL. +**/ +- (float)progressOfWriteReturningTag:(long *)tagPtr bytesDone:(NSUInteger *)donePtr total:(NSUInteger *)totalPtr; + +#pragma mark Security + +/** + * Secures the connection using SSL/TLS. + * + * This method may be called at any time, and the TLS handshake will occur after all pending reads and writes + * are finished. This allows one the option of sending a protocol dependent StartTLS message, and queuing + * the upgrade to TLS at the same time, without having to wait for the write to finish. + * Any reads or writes scheduled after this method is called will occur over the secured connection. + * + * The possible keys and values for the TLS settings are well documented. + * Standard keys are: + * + * - kCFStreamSSLLevel + * - kCFStreamSSLAllowsExpiredCertificates + * - kCFStreamSSLAllowsExpiredRoots + * - kCFStreamSSLAllowsAnyRoot + * - kCFStreamSSLValidatesCertificateChain + * - kCFStreamSSLPeerName + * - kCFStreamSSLCertificates + * - kCFStreamSSLIsServer + * + * If SecureTransport is available on iOS: + * + * - GCDAsyncSocketSSLCipherSuites + * - GCDAsyncSocketSSLProtocolVersionMin + * - GCDAsyncSocketSSLProtocolVersionMax + * + * If SecureTransport is available on Mac OS X: + * + * - GCDAsyncSocketSSLCipherSuites + * - GCDAsyncSocketSSLDiffieHellmanParameters; + * + * + * Please refer to Apple's documentation for associated values, as well as other possible keys. + * + * If you pass in nil or an empty dictionary, the default settings will be used. + * + * The default settings will check to make sure the remote party's certificate is signed by a + * trusted 3rd party certificate agency (e.g. verisign) and that the certificate is not expired. + * However it will not verify the name on the certificate unless you + * give it a name to verify against via the kCFStreamSSLPeerName key. + * The security implications of this are important to understand. + * Imagine you are attempting to create a secure connection to MySecureServer.com, + * but your socket gets directed to MaliciousServer.com because of a hacked DNS server. + * If you simply use the default settings, and MaliciousServer.com has a valid certificate, + * the default settings will not detect any problems since the certificate is valid. + * To properly secure your connection in this particular scenario you + * should set the kCFStreamSSLPeerName property to "MySecureServer.com". + * If you do not know the peer name of the remote host in advance (for example, you're not sure + * if it will be "domain.com" or "www.domain.com"), then you can use the default settings to validate the + * certificate, and then use the X509Certificate class to verify the issuer after the socket has been secured. + * The X509Certificate class is part of the CocoaAsyncSocket open source project. + **/ +- (void)startTLS:(NSDictionary *)tlsSettings; + +#pragma mark Advanced + +/** + * Traditionally sockets are not closed until the conversation is over. + * However, it is technically possible for the remote enpoint to close its write stream. + * Our socket would then be notified that there is no more data to be read, + * but our socket would still be writeable and the remote endpoint could continue to receive our data. + * + * The argument for this confusing functionality stems from the idea that a client could shut down its + * write stream after sending a request to the server, thus notifying the server there are to be no further requests. + * In practice, however, this technique did little to help server developers. + * + * To make matters worse, from a TCP perspective there is no way to tell the difference from a read stream close + * and a full socket close. They both result in the TCP stack receiving a FIN packet. The only way to tell + * is by continuing to write to the socket. If it was only a read stream close, then writes will continue to work. + * Otherwise an error will be occur shortly (when the remote end sends us a RST packet). + * + * In addition to the technical challenges and confusion, many high level socket/stream API's provide + * no support for dealing with the problem. If the read stream is closed, the API immediately declares the + * socket to be closed, and shuts down the write stream as well. In fact, this is what Apple's CFStream API does. + * It might sound like poor design at first, but in fact it simplifies development. + * + * The vast majority of the time if the read stream is closed it's because the remote endpoint closed its socket. + * Thus it actually makes sense to close the socket at this point. + * And in fact this is what most networking developers want and expect to happen. + * However, if you are writing a server that interacts with a plethora of clients, + * you might encounter a client that uses the discouraged technique of shutting down its write stream. + * If this is the case, you can set this property to NO, + * and make use of the socketDidCloseReadStream delegate method. + * + * The default value is YES. +**/ +- (BOOL)autoDisconnectOnClosedReadStream; +- (void)setAutoDisconnectOnClosedReadStream:(BOOL)flag; + +/** + * GCDAsyncSocket maintains thread safety by using an internal serial dispatch_queue. + * In most cases, the instance creates this queue itself. + * However, to allow for maximum flexibility, the internal queue may be passed in the init method. + * This allows for some advanced options such as controlling socket priority via target queues. + * However, when one begins to use target queues like this, they open the door to some specific deadlock issues. + * + * For example, imagine there are 2 queues: + * dispatch_queue_t socketQueue; + * dispatch_queue_t socketTargetQueue; + * + * If you do this (pseudo-code): + * socketQueue.targetQueue = socketTargetQueue; + * + * Then all socketQueue operations will actually get run on the given socketTargetQueue. + * This is fine and works great in most situations. + * But if you run code directly from within the socketTargetQueue that accesses the socket, + * you could potentially get deadlock. Imagine the following code: + * + * - (BOOL)socketHasSomething + * { + * __block BOOL result = NO; + * dispatch_block_t block = ^{ + * result = [self someInternalMethodToBeRunOnlyOnSocketQueue]; + * } + * if (is_executing_on_queue(socketQueue)) + * block(); + * else + * dispatch_sync(socketQueue, block); + * + * return result; + * } + * + * What happens if you call this method from the socketTargetQueue? The result is deadlock. + * This is because the GCD API offers no mechanism to discover a queue's targetQueue. + * Thus we have no idea if our socketQueue is configured with a targetQueue. + * If we had this information, we could easily avoid deadlock. + * But, since these API's are missing or unfeasible, you'll have to explicitly set it. + * + * IF you pass a socketQueue via the init method, + * AND you've configured the passed socketQueue with a targetQueue, + * THEN you should pass the end queue in the target hierarchy. + * + * For example, consider the following queue hierarchy: + * socketQueue -> ipQueue -> moduleQueue + * + * This example demonstrates priority shaping within some server. + * All incoming client connections from the same IP address are executed on the same target queue. + * And all connections for a particular module are executed on the same target queue. + * Thus, the priority of all networking for the entire module can be changed on the fly. + * Additionally, networking traffic from a single IP cannot monopolize the module. + * + * Here's how you would accomplish something like that: + * - (dispatch_queue_t)newSocketQueueForConnectionFromAddress:(NSData *)address onSocket:(GCDAsyncSocket *)sock + * { + * dispatch_queue_t socketQueue = dispatch_queue_create("", NULL); + * dispatch_queue_t ipQueue = [self ipQueueForAddress:address]; + * + * dispatch_set_target_queue(socketQueue, ipQueue); + * dispatch_set_target_queue(iqQueue, moduleQueue); + * + * return socketQueue; + * } + * - (void)socket:(GCDAsyncSocket *)sock didAcceptNewSocket:(GCDAsyncSocket *)newSocket + * { + * [clientConnections addObject:newSocket]; + * [newSocket markSocketQueueTargetQueue:moduleQueue]; + * } + * + * Note: This workaround is ONLY needed if you intend to execute code directly on the ipQueue or moduleQueue. + * This is often NOT the case, as such queues are used solely for execution shaping. +**/ +- (void)markSocketQueueTargetQueue:(dispatch_queue_t)socketQueuesPreConfiguredTargetQueue; +- (void)unmarkSocketQueueTargetQueue:(dispatch_queue_t)socketQueuesPreviouslyConfiguredTargetQueue; + +/** + * It's not thread-safe to access certain variables from outside the socket's internal queue. + * + * For example, the socket file descriptor. + * File descriptors are simply integers which reference an index in the per-process file table. + * However, when one requests a new file descriptor (by opening a file or socket), + * the file descriptor returned is guaranteed to be the lowest numbered unused descriptor. + * So if we're not careful, the following could be possible: + * + * - Thread A invokes a method which returns the socket's file descriptor. + * - The socket is closed via the socket's internal queue on thread B. + * - Thread C opens a file, and subsequently receives the file descriptor that was previously the socket's FD. + * - Thread A is now accessing/altering the file instead of the socket. + * + * In addition to this, other variables are not actually objects, + * and thus cannot be retained/released or even autoreleased. + * An example is the sslContext, of type SSLContextRef, which is actually a malloc'd struct. + * + * Although there are internal variables that make it difficult to maintain thread-safety, + * it is important to provide access to these variables + * to ensure this class can be used in a wide array of environments. + * This method helps to accomplish this by invoking the current block on the socket's internal queue. + * The methods below can be invoked from within the block to access + * those generally thread-unsafe internal variables in a thread-safe manner. + * The given block will be invoked synchronously on the socket's internal queue. + * + * If you save references to any protected variables and use them outside the block, you do so at your own peril. +**/ +- (void)performBlock:(dispatch_block_t)block; + +/** + * These methods are only available from within the context of a performBlock: invocation. + * See the documentation for the performBlock: method above. + * + * Provides access to the socket's file descriptor(s). + * If the socket is a server socket (is accepting incoming connections), + * it might actually have multiple internal socket file descriptors - one for IPv4 and one for IPv6. +**/ +- (int)socketFD; +- (int)socket4FD; +- (int)socket6FD; + +#if TARGET_OS_IPHONE + +/** + * These methods are only available from within the context of a performBlock: invocation. + * See the documentation for the performBlock: method above. + * + * Provides access to the socket's internal CFReadStream/CFWriteStream. + * + * These streams are only used as workarounds for specific iOS shortcomings: + * + * - Apple has decided to keep the SecureTransport framework private is iOS. + * This means the only supplied way to do SSL/TLS is via CFStream or some other API layered on top of it. + * Thus, in order to provide SSL/TLS support on iOS we are forced to rely on CFStream, + * instead of the preferred and faster and more powerful SecureTransport. + * + * - If a socket doesn't have backgrounding enabled, and that socket is closed while the app is backgrounded, + * Apple only bothers to notify us via the CFStream API. + * The faster and more powerful GCD API isn't notified properly in this case. + * + * See also: (BOOL)enableBackgroundingOnSocket +**/ +- (CFReadStreamRef)readStream; +- (CFWriteStreamRef)writeStream; + +/** + * This method is only available from within the context of a performBlock: invocation. + * See the documentation for the performBlock: method above. + * + * Configures the socket to allow it to operate when the iOS application has been backgrounded. + * In other words, this method creates a read & write stream, and invokes: + * + * CFReadStreamSetProperty(readStream, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP); + * CFWriteStreamSetProperty(writeStream, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP); + * + * Returns YES if successful, NO otherwise. + * + * Note: Apple does not officially support backgrounding server sockets. + * That is, if your socket is accepting incoming connections, Apple does not officially support + * allowing iOS applications to accept incoming connections while an app is backgrounded. + * + * Example usage: + * + * - (void)socket:(GCDAsyncSocket *)sock didConnectToHost:(NSString *)host port:(uint16_t)port + * { + * [asyncSocket performBlock:^{ + * [asyncSocket enableBackgroundingOnSocket]; + * }]; + * } +**/ +- (BOOL)enableBackgroundingOnSocket; + +#endif + +#if SECURE_TRANSPORT_MAYBE_AVAILABLE + +/** + * This method is only available from within the context of a performBlock: invocation. + * See the documentation for the performBlock: method above. + * + * Provides access to the socket's SSLContext, if SSL/TLS has been started on the socket. +**/ +- (SSLContextRef)sslContext; + +#endif + +#pragma mark Utilities + +/** + * Extracting host and port information from raw address data. +**/ ++ (NSString *)hostFromAddress:(NSData *)address; ++ (uint16_t)portFromAddress:(NSData *)address; ++ (BOOL)getHost:(NSString **)hostPtr port:(uint16_t *)portPtr fromAddress:(NSData *)address; + +/** + * A few common line separators, for use with the readDataToData:... methods. +**/ ++ (NSData *)CRLFData; // 0x0D0A ++ (NSData *)CRData; // 0x0D ++ (NSData *)LFData; // 0x0A ++ (NSData *)ZeroData; // 0x00 + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@protocol GCDAsyncSocketDelegate +@optional + +/** + * This method is called immediately prior to socket:didAcceptNewSocket:. + * It optionally allows a listening socket to specify the socketQueue for a new accepted socket. + * If this method is not implemented, or returns NULL, the new accepted socket will create its own default queue. + * + * Since you cannot autorelease a dispatch_queue, + * this method uses the "new" prefix in its name to specify that the returned queue has been retained. + * + * Thus you could do something like this in the implementation: + * return dispatch_queue_create("MyQueue", NULL); + * + * If you are placing multiple sockets on the same queue, + * then care should be taken to increment the retain count each time this method is invoked. + * + * For example, your implementation might look something like this: + * dispatch_retain(myExistingQueue); + * return myExistingQueue; +**/ +- (dispatch_queue_t)newSocketQueueForConnectionFromAddress:(NSData *)address onSocket:(GCDAsyncSocket *)sock; + +/** + * Called when a socket accepts a connection. + * Another socket is automatically spawned to handle it. + * + * You must retain the newSocket if you wish to handle the connection. + * Otherwise the newSocket instance will be released and the spawned connection will be closed. + * + * By default the new socket will have the same delegate and delegateQueue. + * You may, of course, change this at any time. +**/ +- (void)socket:(GCDAsyncSocket *)sock didAcceptNewSocket:(GCDAsyncSocket *)newSocket; + +/** + * Called when a socket connects and is ready for reading and writing. + * The host parameter will be an IP address, not a DNS name. +**/ +- (void)socket:(GCDAsyncSocket *)sock didConnectToHost:(NSString *)host port:(uint16_t)port; + +/** + * Called when a socket has completed reading the requested data into memory. + * Not called if there is an error. +**/ +- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag; + +/** + * Called when a socket has read in data, but has not yet completed the read. + * This would occur if using readToData: or readToLength: methods. + * It may be used to for things such as updating progress bars. +**/ +- (void)socket:(GCDAsyncSocket *)sock didReadPartialDataOfLength:(NSUInteger)partialLength tag:(long)tag; + +/** + * Called when a socket has completed writing the requested data. Not called if there is an error. +**/ +- (void)socket:(GCDAsyncSocket *)sock didWriteDataWithTag:(long)tag; + +/** + * Called when a socket has written some data, but has not yet completed the entire write. + * It may be used to for things such as updating progress bars. +**/ +- (void)socket:(GCDAsyncSocket *)sock didWritePartialDataOfLength:(NSUInteger)partialLength tag:(long)tag; + +/** + * Called if a read operation has reached its timeout without completing. + * This method allows you to optionally extend the timeout. + * If you return a positive time interval (> 0) the read's timeout will be extended by the given amount. + * If you don't implement this method, or return a non-positive time interval (<= 0) the read will timeout as usual. + * + * The elapsed parameter is the sum of the original timeout, plus any additions previously added via this method. + * The length parameter is the number of bytes that have been read so far for the read operation. + * + * Note that this method may be called multiple times for a single read if you return positive numbers. +**/ +- (NSTimeInterval)socket:(GCDAsyncSocket *)sock shouldTimeoutReadWithTag:(long)tag + elapsed:(NSTimeInterval)elapsed + bytesDone:(NSUInteger)length; + +/** + * Called if a write operation has reached its timeout without completing. + * This method allows you to optionally extend the timeout. + * If you return a positive time interval (> 0) the write's timeout will be extended by the given amount. + * If you don't implement this method, or return a non-positive time interval (<= 0) the write will timeout as usual. + * + * The elapsed parameter is the sum of the original timeout, plus any additions previously added via this method. + * The length parameter is the number of bytes that have been written so far for the write operation. + * + * Note that this method may be called multiple times for a single write if you return positive numbers. +**/ +- (NSTimeInterval)socket:(GCDAsyncSocket *)sock shouldTimeoutWriteWithTag:(long)tag + elapsed:(NSTimeInterval)elapsed + bytesDone:(NSUInteger)length; + +/** + * Conditionally called if the read stream closes, but the write stream may still be writeable. + * + * This delegate method is only called if autoDisconnectOnClosedReadStream has been set to NO. + * See the discussion on the autoDisconnectOnClosedReadStream method for more information. +**/ +- (void)socketDidCloseReadStream:(GCDAsyncSocket *)sock; + +/** + * Called when a socket disconnects with or without error. + * + * If you call the disconnect method, and the socket wasn't already disconnected, + * this delegate method will be called before the disconnect method returns. +**/ +- (void)socketDidDisconnect:(GCDAsyncSocket *)sock withError:(NSError *)err; + +/** + * Called after the socket has successfully completed SSL/TLS negotiation. + * This method is not called unless you use the provided startTLS method. + * + * If a SSL/TLS negotiation fails (invalid certificate, etc) then the socket will immediately close, + * and the socketDidDisconnect:withError: delegate method will be called with the specific SSL error code. +**/ +- (void)socketDidSecure:(GCDAsyncSocket *)sock; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.m new file mode 100644 index 00000000000..1ecc94afd71 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.m @@ -0,0 +1,7430 @@ +// +// GCDAsyncSocket.m +// +// This class is in the public domain. +// Originally created by Robbie Hanson in Q4 2010. +// Updated and maintained by Deusty LLC and the Apple development community. +// +// https://github.com/robbiehanson/CocoaAsyncSocket +// + +#import "GCDAsyncSocket.h" + +#if TARGET_OS_IPHONE +#import +#endif + +#import +#import +#import +#import +#import +#import +#import +#import +#import +#import +#import +#import + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +// For more information see: https://github.com/robbiehanson/CocoaAsyncSocket/wiki/ARC +#endif + +/** + * Does ARC support support GCD objects? + * It does if the minimum deployment target is iOS 6+ or Mac OS X 10.8+ +**/ +#if TARGET_OS_IPHONE + + // Compiling for iOS + + #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 60000 // iOS 6.0 or later + #define NEEDS_DISPATCH_RETAIN_RELEASE 0 + #else // iOS 5.X or earlier + #define NEEDS_DISPATCH_RETAIN_RELEASE 1 + #endif + +#else + + // Compiling for Mac OS X + + #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1080 // Mac OS X 10.8 or later + #define NEEDS_DISPATCH_RETAIN_RELEASE 0 + #else + #define NEEDS_DISPATCH_RETAIN_RELEASE 1 // Mac OS X 10.7 or earlier + #endif + +#endif + + +#if 0 + +// Logging Enabled - See log level below + +// Logging uses the CocoaLumberjack framework (which is also GCD based). +// https://github.com/robbiehanson/CocoaLumberjack +// +// It allows us to do a lot of logging without significantly slowing down the code. +#import "DDLog.h" + +#define LogAsync YES +#define LogContext 65535 + +#define LogObjc(flg, frmt, ...) LOG_OBJC_MAYBE(LogAsync, logLevel, flg, LogContext, frmt, ##__VA_ARGS__) +#define LogC(flg, frmt, ...) LOG_C_MAYBE(LogAsync, logLevel, flg, LogContext, frmt, ##__VA_ARGS__) + +#define LogError(frmt, ...) LogObjc(LOG_FLAG_ERROR, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) +#define LogWarn(frmt, ...) LogObjc(LOG_FLAG_WARN, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) +#define LogInfo(frmt, ...) LogObjc(LOG_FLAG_INFO, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) +#define LogVerbose(frmt, ...) LogObjc(LOG_FLAG_VERBOSE, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) + +#define LogCError(frmt, ...) LogC(LOG_FLAG_ERROR, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) +#define LogCWarn(frmt, ...) LogC(LOG_FLAG_WARN, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) +#define LogCInfo(frmt, ...) LogC(LOG_FLAG_INFO, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) +#define LogCVerbose(frmt, ...) LogC(LOG_FLAG_VERBOSE, (@"%@: " frmt), THIS_FILE, ##__VA_ARGS__) + +#define LogTrace() LogObjc(LOG_FLAG_VERBOSE, @"%@: %@", THIS_FILE, THIS_METHOD) +#define LogCTrace() LogC(LOG_FLAG_VERBOSE, @"%@: %s", THIS_FILE, __FUNCTION__) + +// Log levels : off, error, warn, info, verbose +static const int logLevel = LOG_LEVEL_VERBOSE; + +#else + +// Logging Disabled + +#define LogError(frmt, ...) {} +#define LogWarn(frmt, ...) {} +#define LogInfo(frmt, ...) {} +#define LogVerbose(frmt, ...) {} + +#define LogCError(frmt, ...) {} +#define LogCWarn(frmt, ...) {} +#define LogCInfo(frmt, ...) {} +#define LogCVerbose(frmt, ...) {} + +#define LogTrace() {} +#define LogCTrace(frmt, ...) {} + +#endif + +/** + * Seeing a return statements within an inner block + * can sometimes be mistaken for a return point of the enclosing method. + * This makes inline blocks a bit easier to read. +**/ +#define return_from_block return + +/** + * A socket file descriptor is really just an integer. + * It represents the index of the socket within the kernel. + * This makes invalid file descriptor comparisons easier to read. +**/ +#define SOCKET_NULL -1 + + +NSString *const GCDAsyncSocketException = @"GCDAsyncSocketException"; +NSString *const GCDAsyncSocketErrorDomain = @"GCDAsyncSocketErrorDomain"; + +NSString *const GCDAsyncSocketQueueName = @"GCDAsyncSocket"; +NSString *const GCDAsyncSocketThreadName = @"GCDAsyncSocket-CFStream"; + +#if SECURE_TRANSPORT_MAYBE_AVAILABLE +NSString *const GCDAsyncSocketSSLCipherSuites = @"GCDAsyncSocketSSLCipherSuites"; +#if TARGET_OS_IPHONE +NSString *const GCDAsyncSocketSSLProtocolVersionMin = @"GCDAsyncSocketSSLProtocolVersionMin"; +NSString *const GCDAsyncSocketSSLProtocolVersionMax = @"GCDAsyncSocketSSLProtocolVersionMax"; +#else +NSString *const GCDAsyncSocketSSLDiffieHellmanParameters = @"GCDAsyncSocketSSLDiffieHellmanParameters"; +#endif +#endif + +enum GCDAsyncSocketFlags +{ + kSocketStarted = 1 << 0, // If set, socket has been started (accepting/connecting) + kConnected = 1 << 1, // If set, the socket is connected + kForbidReadsWrites = 1 << 2, // If set, no new reads or writes are allowed + kReadsPaused = 1 << 3, // If set, reads are paused due to possible timeout + kWritesPaused = 1 << 4, // If set, writes are paused due to possible timeout + kDisconnectAfterReads = 1 << 5, // If set, disconnect after no more reads are queued + kDisconnectAfterWrites = 1 << 6, // If set, disconnect after no more writes are queued + kSocketCanAcceptBytes = 1 << 7, // If set, we know socket can accept bytes. If unset, it's unknown. + kReadSourceSuspended = 1 << 8, // If set, the read source is suspended + kWriteSourceSuspended = 1 << 9, // If set, the write source is suspended + kQueuedTLS = 1 << 10, // If set, we've queued an upgrade to TLS + kStartingReadTLS = 1 << 11, // If set, we're waiting for TLS negotiation to complete + kStartingWriteTLS = 1 << 12, // If set, we're waiting for TLS negotiation to complete + kSocketSecure = 1 << 13, // If set, socket is using secure communication via SSL/TLS + kSocketHasReadEOF = 1 << 14, // If set, we have read EOF from socket + kReadStreamClosed = 1 << 15, // If set, we've read EOF plus prebuffer has been drained +#if TARGET_OS_IPHONE + kAddedStreamsToRunLoop = 1 << 16, // If set, CFStreams have been added to listener thread + kUsingCFStreamForTLS = 1 << 17, // If set, we're forced to use CFStream instead of SecureTransport + kSecureSocketHasBytesAvailable = 1 << 18, // If set, CFReadStream has notified us of bytes available +#endif +}; + +enum GCDAsyncSocketConfig +{ + kIPv4Disabled = 1 << 0, // If set, IPv4 is disabled + kIPv6Disabled = 1 << 1, // If set, IPv6 is disabled + kPreferIPv6 = 1 << 2, // If set, IPv6 is preferred over IPv4 + kAllowHalfDuplexConnection = 1 << 3, // If set, the socket will stay open even if the read stream closes +}; + +#if TARGET_OS_IPHONE + static NSThread *cfstreamThread; // Used for CFStreams +#endif + +@interface GCDAsyncSocket () +{ + uint32_t flags; + uint16_t config; + +#if __has_feature(objc_arc_weak) + __weak id delegate; +#else + __unsafe_unretained id delegate; +#endif + dispatch_queue_t delegateQueue; + + int socket4FD; + int socket6FD; + int connectIndex; + NSData * connectInterface4; + NSData * connectInterface6; + + dispatch_queue_t socketQueue; + + dispatch_source_t accept4Source; + dispatch_source_t accept6Source; + dispatch_source_t connectTimer; + dispatch_source_t readSource; + dispatch_source_t writeSource; + dispatch_source_t readTimer; + dispatch_source_t writeTimer; + + NSMutableArray *readQueue; + NSMutableArray *writeQueue; + + GCDAsyncReadPacket *currentRead; + GCDAsyncWritePacket *currentWrite; + + unsigned long socketFDBytesAvailable; + + GCDAsyncSocketPreBuffer *preBuffer; + +#if TARGET_OS_IPHONE + CFStreamClientContext streamContext; + CFReadStreamRef readStream; + CFWriteStreamRef writeStream; +#endif +#if SECURE_TRANSPORT_MAYBE_AVAILABLE + SSLContextRef sslContext; + GCDAsyncSocketPreBuffer *sslPreBuffer; + size_t sslWriteCachedLength; + OSStatus sslErrCode; +#endif + + void *IsOnSocketQueueOrTargetQueueKey; + + id userData; +} +// Accepting +- (BOOL)doAccept:(int)socketFD; + +// Connecting +- (void)startConnectTimeout:(NSTimeInterval)timeout; +- (void)endConnectTimeout; +- (void)doConnectTimeout; +- (void)lookup:(int)aConnectIndex host:(NSString *)host port:(uint16_t)port; +- (void)lookup:(int)aConnectIndex didSucceedWithAddress4:(NSData *)address4 address6:(NSData *)address6; +- (void)lookup:(int)aConnectIndex didFail:(NSError *)error; +- (BOOL)connectWithAddress4:(NSData *)address4 address6:(NSData *)address6 error:(NSError **)errPtr; +- (void)didConnect:(int)aConnectIndex; +- (void)didNotConnect:(int)aConnectIndex error:(NSError *)error; + +// Disconnect +- (void)closeWithError:(NSError *)error; +- (void)maybeClose; + +// Errors +- (NSError *)badConfigError:(NSString *)msg; +- (NSError *)badParamError:(NSString *)msg; +- (NSError *)gaiError:(int)gai_error; +- (NSError *)errnoError; +- (NSError *)errnoErrorWithReason:(NSString *)reason; +- (NSError *)connectTimeoutError; +- (NSError *)otherError:(NSString *)msg; + +// Diagnostics +- (NSString *)connectedHost4; +- (NSString *)connectedHost6; +- (uint16_t)connectedPort4; +- (uint16_t)connectedPort6; +- (NSString *)localHost4; +- (NSString *)localHost6; +- (uint16_t)localPort4; +- (uint16_t)localPort6; +- (NSString *)connectedHostFromSocket4:(int)socketFD; +- (NSString *)connectedHostFromSocket6:(int)socketFD; +- (uint16_t)connectedPortFromSocket4:(int)socketFD; +- (uint16_t)connectedPortFromSocket6:(int)socketFD; +- (NSString *)localHostFromSocket4:(int)socketFD; +- (NSString *)localHostFromSocket6:(int)socketFD; +- (uint16_t)localPortFromSocket4:(int)socketFD; +- (uint16_t)localPortFromSocket6:(int)socketFD; + +// Utilities +- (void)getInterfaceAddress4:(NSMutableData **)addr4Ptr + address6:(NSMutableData **)addr6Ptr + fromDescription:(NSString *)interfaceDescription + port:(uint16_t)port; +- (void)setupReadAndWriteSourcesForNewlyConnectedSocket:(int)socketFD; +- (void)suspendReadSource; +- (void)resumeReadSource; +- (void)suspendWriteSource; +- (void)resumeWriteSource; + +// Reading +- (void)maybeDequeueRead; +- (void)flushSSLBuffers; +- (void)doReadData; +- (void)doReadEOF; +- (void)completeCurrentRead; +- (void)endCurrentRead; +- (void)setupReadTimerWithTimeout:(NSTimeInterval)timeout; +- (void)doReadTimeout; +- (void)doReadTimeoutWithExtension:(NSTimeInterval)timeoutExtension; + +// Writing +- (void)maybeDequeueWrite; +- (void)doWriteData; +- (void)completeCurrentWrite; +- (void)endCurrentWrite; +- (void)setupWriteTimerWithTimeout:(NSTimeInterval)timeout; +- (void)doWriteTimeout; +- (void)doWriteTimeoutWithExtension:(NSTimeInterval)timeoutExtension; + +// Security +- (void)maybeStartTLS; +#if SECURE_TRANSPORT_MAYBE_AVAILABLE +- (void)ssl_startTLS; +- (void)ssl_continueSSLHandshake; +#endif +#if TARGET_OS_IPHONE +- (void)cf_startTLS; +#endif + +// CFStream +#if TARGET_OS_IPHONE ++ (void)startCFStreamThreadIfNeeded; +- (BOOL)createReadAndWriteStream; +- (BOOL)registerForStreamCallbacksIncludingReadWrite:(BOOL)includeReadWrite; +- (BOOL)addStreamsToRunLoop; +- (BOOL)openStreams; +- (void)removeStreamsFromRunLoop; +#endif + +// Class Methods ++ (NSString *)hostFromSockaddr4:(const struct sockaddr_in *)pSockaddr4; ++ (NSString *)hostFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6; ++ (uint16_t)portFromSockaddr4:(const struct sockaddr_in *)pSockaddr4; ++ (uint16_t)portFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * A PreBuffer is used when there is more data available on the socket + * than is being requested by current read request. + * In this case we slurp up all data from the socket (to minimize sys calls), + * and store additional yet unread data in a "prebuffer". + * + * The prebuffer is entirely drained before we read from the socket again. + * In other words, a large chunk of data is written is written to the prebuffer. + * The prebuffer is then drained via a series of one or more reads (for subsequent read request(s)). + * + * A ring buffer was once used for this purpose. + * But a ring buffer takes up twice as much memory as needed (double the size for mirroring). + * In fact, it generally takes up more than twice the needed size as everything has to be rounded up to vm_page_size. + * And since the prebuffer is always completely drained after being written to, a full ring buffer isn't needed. + * + * The current design is very simple and straight-forward, while also keeping memory requirements lower. +**/ + +@interface GCDAsyncSocketPreBuffer : NSObject +{ + uint8_t *preBuffer; + size_t preBufferSize; + + uint8_t *readPointer; + uint8_t *writePointer; +} + +- (id)initWithCapacity:(size_t)numBytes; + +- (void)ensureCapacityForWrite:(size_t)numBytes; + +- (size_t)availableBytes; +- (uint8_t *)readBuffer; + +- (void)getReadBuffer:(uint8_t **)bufferPtr availableBytes:(size_t *)availableBytesPtr; + +- (size_t)availableSpace; +- (uint8_t *)writeBuffer; + +- (void)getWriteBuffer:(uint8_t **)bufferPtr availableSpace:(size_t *)availableSpacePtr; + +- (void)didRead:(size_t)bytesRead; +- (void)didWrite:(size_t)bytesWritten; + +- (void)reset; + +@end + +@implementation GCDAsyncSocketPreBuffer + +- (id)initWithCapacity:(size_t)numBytes +{ + if ((self = [super init])) + { + preBufferSize = numBytes; + preBuffer = malloc(preBufferSize); + + readPointer = preBuffer; + writePointer = preBuffer; + } + return self; +} + +- (void)dealloc +{ + if (preBuffer) + free(preBuffer); +} + +- (void)ensureCapacityForWrite:(size_t)numBytes +{ + size_t availableSpace = preBufferSize - (writePointer - readPointer); + + if (numBytes > availableSpace) + { + size_t additionalBytes = numBytes - availableSpace; + + size_t newPreBufferSize = preBufferSize + additionalBytes; + uint8_t *newPreBuffer = realloc(preBuffer, newPreBufferSize); + + size_t readPointerOffset = readPointer - preBuffer; + size_t writePointerOffset = writePointer - preBuffer; + + preBuffer = newPreBuffer; + preBufferSize = newPreBufferSize; + + readPointer = preBuffer + readPointerOffset; + writePointer = preBuffer + writePointerOffset; + } +} + +- (size_t)availableBytes +{ + return writePointer - readPointer; +} + +- (uint8_t *)readBuffer +{ + return readPointer; +} + +- (void)getReadBuffer:(uint8_t **)bufferPtr availableBytes:(size_t *)availableBytesPtr +{ + if (bufferPtr) *bufferPtr = readPointer; + if (availableBytesPtr) *availableBytesPtr = writePointer - readPointer; +} + +- (void)didRead:(size_t)bytesRead +{ + readPointer += bytesRead; + + if (readPointer == writePointer) + { + // The prebuffer has been drained. Reset pointers. + readPointer = preBuffer; + writePointer = preBuffer; + } +} + +- (size_t)availableSpace +{ + return preBufferSize - (writePointer - readPointer); +} + +- (uint8_t *)writeBuffer +{ + return writePointer; +} + +- (void)getWriteBuffer:(uint8_t **)bufferPtr availableSpace:(size_t *)availableSpacePtr +{ + if (bufferPtr) *bufferPtr = writePointer; + if (availableSpacePtr) *availableSpacePtr = preBufferSize - (writePointer - readPointer); +} + +- (void)didWrite:(size_t)bytesWritten +{ + writePointer += bytesWritten; +} + +- (void)reset +{ + readPointer = preBuffer; + writePointer = preBuffer; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * The GCDAsyncReadPacket encompasses the instructions for any given read. + * The content of a read packet allows the code to determine if we're: + * - reading to a certain length + * - reading to a certain separator + * - or simply reading the first chunk of available data +**/ +@interface GCDAsyncReadPacket : NSObject +{ + @public + NSMutableData *buffer; + NSUInteger startOffset; + NSUInteger bytesDone; + NSUInteger maxLength; + NSTimeInterval timeout; + NSUInteger readLength; + NSData *term; + BOOL bufferOwner; + NSUInteger originalBufferLength; + long tag; +} +- (id)initWithData:(NSMutableData *)d + startOffset:(NSUInteger)s + maxLength:(NSUInteger)m + timeout:(NSTimeInterval)t + readLength:(NSUInteger)l + terminator:(NSData *)e + tag:(long)i; + +- (void)ensureCapacityForAdditionalDataOfLength:(NSUInteger)bytesToRead; + +- (NSUInteger)optimalReadLengthWithDefault:(NSUInteger)defaultValue shouldPreBuffer:(BOOL *)shouldPreBufferPtr; + +- (NSUInteger)readLengthForNonTermWithHint:(NSUInteger)bytesAvailable; +- (NSUInteger)readLengthForTermWithHint:(NSUInteger)bytesAvailable shouldPreBuffer:(BOOL *)shouldPreBufferPtr; +- (NSUInteger)readLengthForTermWithPreBuffer:(GCDAsyncSocketPreBuffer *)preBuffer found:(BOOL *)foundPtr; + +- (NSInteger)searchForTermAfterPreBuffering:(ssize_t)numBytes; + +@end + +@implementation GCDAsyncReadPacket + +- (id)initWithData:(NSMutableData *)d + startOffset:(NSUInteger)s + maxLength:(NSUInteger)m + timeout:(NSTimeInterval)t + readLength:(NSUInteger)l + terminator:(NSData *)e + tag:(long)i +{ + if((self = [super init])) + { + bytesDone = 0; + maxLength = m; + timeout = t; + readLength = l; + term = [e copy]; + tag = i; + + if (d) + { + buffer = d; + startOffset = s; + bufferOwner = NO; + originalBufferLength = [d length]; + } + else + { + if (readLength > 0) + buffer = [[NSMutableData alloc] initWithLength:readLength]; + else + buffer = [[NSMutableData alloc] initWithLength:0]; + + startOffset = 0; + bufferOwner = YES; + originalBufferLength = 0; + } + } + return self; +} + +/** + * Increases the length of the buffer (if needed) to ensure a read of the given size will fit. +**/ +- (void)ensureCapacityForAdditionalDataOfLength:(NSUInteger)bytesToRead +{ + NSUInteger buffSize = [buffer length]; + NSUInteger buffUsed = startOffset + bytesDone; + + NSUInteger buffSpace = buffSize - buffUsed; + + if (bytesToRead > buffSpace) + { + NSUInteger buffInc = bytesToRead - buffSpace; + + [buffer increaseLengthBy:buffInc]; + } +} + +/** + * This method is used when we do NOT know how much data is available to be read from the socket. + * This method returns the default value unless it exceeds the specified readLength or maxLength. + * + * Furthermore, the shouldPreBuffer decision is based upon the packet type, + * and whether the returned value would fit in the current buffer without requiring a resize of the buffer. +**/ +- (NSUInteger)optimalReadLengthWithDefault:(NSUInteger)defaultValue shouldPreBuffer:(BOOL *)shouldPreBufferPtr +{ + NSUInteger result; + + if (readLength > 0) + { + // Read a specific length of data + + result = MIN(defaultValue, (readLength - bytesDone)); + + // There is no need to prebuffer since we know exactly how much data we need to read. + // Even if the buffer isn't currently big enough to fit this amount of data, + // it would have to be resized eventually anyway. + + if (shouldPreBufferPtr) + *shouldPreBufferPtr = NO; + } + else + { + // Either reading until we find a specified terminator, + // or we're simply reading all available data. + // + // In other words, one of: + // + // - readDataToData packet + // - readDataWithTimeout packet + + if (maxLength > 0) + result = MIN(defaultValue, (maxLength - bytesDone)); + else + result = defaultValue; + + // Since we don't know the size of the read in advance, + // the shouldPreBuffer decision is based upon whether the returned value would fit + // in the current buffer without requiring a resize of the buffer. + // + // This is because, in all likelyhood, the amount read from the socket will be less than the default value. + // Thus we should avoid over-allocating the read buffer when we can simply use the pre-buffer instead. + + if (shouldPreBufferPtr) + { + NSUInteger buffSize = [buffer length]; + NSUInteger buffUsed = startOffset + bytesDone; + + NSUInteger buffSpace = buffSize - buffUsed; + + if (buffSpace >= result) + *shouldPreBufferPtr = NO; + else + *shouldPreBufferPtr = YES; + } + } + + return result; +} + +/** + * For read packets without a set terminator, returns the amount of data + * that can be read without exceeding the readLength or maxLength. + * + * The given parameter indicates the number of bytes estimated to be available on the socket, + * which is taken into consideration during the calculation. + * + * The given hint MUST be greater than zero. +**/ +- (NSUInteger)readLengthForNonTermWithHint:(NSUInteger)bytesAvailable +{ + NSAssert(term == nil, @"This method does not apply to term reads"); + NSAssert(bytesAvailable > 0, @"Invalid parameter: bytesAvailable"); + + if (readLength > 0) + { + // Read a specific length of data + + return MIN(bytesAvailable, (readLength - bytesDone)); + + // No need to avoid resizing the buffer. + // If the user provided their own buffer, + // and told us to read a certain length of data that exceeds the size of the buffer, + // then it is clear that our code will resize the buffer during the read operation. + // + // This method does not actually do any resizing. + // The resizing will happen elsewhere if needed. + } + else + { + // Read all available data + + NSUInteger result = bytesAvailable; + + if (maxLength > 0) + { + result = MIN(result, (maxLength - bytesDone)); + } + + // No need to avoid resizing the buffer. + // If the user provided their own buffer, + // and told us to read all available data without giving us a maxLength, + // then it is clear that our code might resize the buffer during the read operation. + // + // This method does not actually do any resizing. + // The resizing will happen elsewhere if needed. + + return result; + } +} + +/** + * For read packets with a set terminator, returns the amount of data + * that can be read without exceeding the maxLength. + * + * The given parameter indicates the number of bytes estimated to be available on the socket, + * which is taken into consideration during the calculation. + * + * To optimize memory allocations, mem copies, and mem moves + * the shouldPreBuffer boolean value will indicate if the data should be read into a prebuffer first, + * or if the data can be read directly into the read packet's buffer. +**/ +- (NSUInteger)readLengthForTermWithHint:(NSUInteger)bytesAvailable shouldPreBuffer:(BOOL *)shouldPreBufferPtr +{ + NSAssert(term != nil, @"This method does not apply to non-term reads"); + NSAssert(bytesAvailable > 0, @"Invalid parameter: bytesAvailable"); + + + NSUInteger result = bytesAvailable; + + if (maxLength > 0) + { + result = MIN(result, (maxLength - bytesDone)); + } + + // Should the data be read into the read packet's buffer, or into a pre-buffer first? + // + // One would imagine the preferred option is the faster one. + // So which one is faster? + // + // Reading directly into the packet's buffer requires: + // 1. Possibly resizing packet buffer (malloc/realloc) + // 2. Filling buffer (read) + // 3. Searching for term (memcmp) + // 4. Possibly copying overflow into prebuffer (malloc/realloc, memcpy) + // + // Reading into prebuffer first: + // 1. Possibly resizing prebuffer (malloc/realloc) + // 2. Filling buffer (read) + // 3. Searching for term (memcmp) + // 4. Copying underflow into packet buffer (malloc/realloc, memcpy) + // 5. Removing underflow from prebuffer (memmove) + // + // Comparing the performance of the two we can see that reading + // data into the prebuffer first is slower due to the extra memove. + // + // However: + // The implementation of NSMutableData is open source via core foundation's CFMutableData. + // Decreasing the length of a mutable data object doesn't cause a realloc. + // In other words, the capacity of a mutable data object can grow, but doesn't shrink. + // + // This means the prebuffer will rarely need a realloc. + // The packet buffer, on the other hand, may often need a realloc. + // This is especially true if we are the buffer owner. + // Furthermore, if we are constantly realloc'ing the packet buffer, + // and then moving the overflow into the prebuffer, + // then we're consistently over-allocating memory for each term read. + // And now we get into a bit of a tradeoff between speed and memory utilization. + // + // The end result is that the two perform very similarly. + // And we can answer the original question very simply by another means. + // + // If we can read all the data directly into the packet's buffer without resizing it first, + // then we do so. Otherwise we use the prebuffer. + + if (shouldPreBufferPtr) + { + NSUInteger buffSize = [buffer length]; + NSUInteger buffUsed = startOffset + bytesDone; + + if ((buffSize - buffUsed) >= result) + *shouldPreBufferPtr = NO; + else + *shouldPreBufferPtr = YES; + } + + return result; +} + +/** + * For read packets with a set terminator, + * returns the amount of data that can be read from the given preBuffer, + * without going over a terminator or the maxLength. + * + * It is assumed the terminator has not already been read. +**/ +- (NSUInteger)readLengthForTermWithPreBuffer:(GCDAsyncSocketPreBuffer *)preBuffer found:(BOOL *)foundPtr +{ + NSAssert(term != nil, @"This method does not apply to non-term reads"); + NSAssert([preBuffer availableBytes] > 0, @"Invoked with empty pre buffer!"); + + // We know that the terminator, as a whole, doesn't exist in our own buffer. + // But it is possible that a _portion_ of it exists in our buffer. + // So we're going to look for the terminator starting with a portion of our own buffer. + // + // Example: + // + // term length = 3 bytes + // bytesDone = 5 bytes + // preBuffer length = 5 bytes + // + // If we append the preBuffer to our buffer, + // it would look like this: + // + // --------------------- + // |B|B|B|B|B|P|P|P|P|P| + // --------------------- + // + // So we start our search here: + // + // --------------------- + // |B|B|B|B|B|P|P|P|P|P| + // -------^-^-^--------- + // + // And move forwards... + // + // --------------------- + // |B|B|B|B|B|P|P|P|P|P| + // ---------^-^-^------- + // + // Until we find the terminator or reach the end. + // + // --------------------- + // |B|B|B|B|B|P|P|P|P|P| + // ---------------^-^-^- + + BOOL found = NO; + + NSUInteger termLength = [term length]; + NSUInteger preBufferLength = [preBuffer availableBytes]; + + if ((bytesDone + preBufferLength) < termLength) + { + // Not enough data for a full term sequence yet + return preBufferLength; + } + + NSUInteger maxPreBufferLength; + if (maxLength > 0) { + maxPreBufferLength = MIN(preBufferLength, (maxLength - bytesDone)); + + // Note: maxLength >= termLength + } + else { + maxPreBufferLength = preBufferLength; + } + + uint8_t seq[termLength]; + const void *termBuf = [term bytes]; + + NSUInteger bufLen = MIN(bytesDone, (termLength - 1)); + uint8_t *buf = (uint8_t *)[buffer mutableBytes] + startOffset + bytesDone - bufLen; + + NSUInteger preLen = termLength - bufLen; + const uint8_t *pre = [preBuffer readBuffer]; + + NSUInteger loopCount = bufLen + maxPreBufferLength - termLength + 1; // Plus one. See example above. + + NSUInteger result = maxPreBufferLength; + + NSUInteger i; + for (i = 0; i < loopCount; i++) + { + if (bufLen > 0) + { + // Combining bytes from buffer and preBuffer + + memcpy(seq, buf, bufLen); + memcpy(seq + bufLen, pre, preLen); + + if (memcmp(seq, termBuf, termLength) == 0) + { + result = preLen; + found = YES; + break; + } + + buf++; + bufLen--; + preLen++; + } + else + { + // Comparing directly from preBuffer + + if (memcmp(pre, termBuf, termLength) == 0) + { + NSUInteger preOffset = pre - [preBuffer readBuffer]; // pointer arithmetic + + result = preOffset + termLength; + found = YES; + break; + } + + pre++; + } + } + + // There is no need to avoid resizing the buffer in this particular situation. + + if (foundPtr) *foundPtr = found; + return result; +} + +/** + * For read packets with a set terminator, scans the packet buffer for the term. + * It is assumed the terminator had not been fully read prior to the new bytes. + * + * If the term is found, the number of excess bytes after the term are returned. + * If the term is not found, this method will return -1. + * + * Note: A return value of zero means the term was found at the very end. + * + * Prerequisites: + * The given number of bytes have been added to the end of our buffer. + * Our bytesDone variable has NOT been changed due to the prebuffered bytes. +**/ +- (NSInteger)searchForTermAfterPreBuffering:(ssize_t)numBytes +{ + NSAssert(term != nil, @"This method does not apply to non-term reads"); + + // The implementation of this method is very similar to the above method. + // See the above method for a discussion of the algorithm used here. + + uint8_t *buff = [buffer mutableBytes]; + NSUInteger buffLength = bytesDone + numBytes; + + const void *termBuff = [term bytes]; + NSUInteger termLength = [term length]; + + // Note: We are dealing with unsigned integers, + // so make sure the math doesn't go below zero. + + NSUInteger i = ((buffLength - numBytes) >= termLength) ? (buffLength - numBytes - termLength + 1) : 0; + + while (i + termLength <= buffLength) + { + uint8_t *subBuffer = buff + startOffset + i; + + if (memcmp(subBuffer, termBuff, termLength) == 0) + { + return buffLength - (i + termLength); + } + + i++; + } + + return -1; +} + + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * The GCDAsyncWritePacket encompasses the instructions for any given write. +**/ +@interface GCDAsyncWritePacket : NSObject +{ + @public + NSData *buffer; + NSUInteger bytesDone; + long tag; + NSTimeInterval timeout; +} +- (id)initWithData:(NSData *)d timeout:(NSTimeInterval)t tag:(long)i; +@end + +@implementation GCDAsyncWritePacket + +- (id)initWithData:(NSData *)d timeout:(NSTimeInterval)t tag:(long)i +{ + if((self = [super init])) + { + buffer = d; // Retain not copy. For performance as documented in header file. + bytesDone = 0; + timeout = t; + tag = i; + } + return self; +} + + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * The GCDAsyncSpecialPacket encompasses special instructions for interruptions in the read/write queues. + * This class my be altered to support more than just TLS in the future. +**/ +@interface GCDAsyncSpecialPacket : NSObject +{ + @public + NSDictionary *tlsSettings; +} +- (id)initWithTLSSettings:(NSDictionary *)settings; +@end + +@implementation GCDAsyncSpecialPacket + +- (id)initWithTLSSettings:(NSDictionary *)settings +{ + if((self = [super init])) + { + tlsSettings = [settings copy]; + } + return self; +} + + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation GCDAsyncSocket + +- (id)init +{ + return [self initWithDelegate:nil delegateQueue:NULL socketQueue:NULL]; +} + +- (id)initWithSocketQueue:(dispatch_queue_t)sq +{ + return [self initWithDelegate:nil delegateQueue:NULL socketQueue:sq]; +} + +- (id)initWithDelegate:(id)aDelegate delegateQueue:(dispatch_queue_t)dq +{ + return [self initWithDelegate:aDelegate delegateQueue:dq socketQueue:NULL]; +} + +- (id)initWithDelegate:(id)aDelegate delegateQueue:(dispatch_queue_t)dq socketQueue:(dispatch_queue_t)sq +{ + if((self = [super init])) + { + delegate = aDelegate; + delegateQueue = dq; + + #if NEEDS_DISPATCH_RETAIN_RELEASE + if (dq) dispatch_retain(dq); + #endif + + socket4FD = SOCKET_NULL; + socket6FD = SOCKET_NULL; + connectIndex = 0; + + if (sq) + { + NSAssert(sq != dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_LOW, 0), + @"The given socketQueue parameter must not be a concurrent queue."); + NSAssert(sq != dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), + @"The given socketQueue parameter must not be a concurrent queue."); + NSAssert(sq != dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), + @"The given socketQueue parameter must not be a concurrent queue."); + + socketQueue = sq; + #if NEEDS_DISPATCH_RETAIN_RELEASE + dispatch_retain(sq); + #endif + } + else + { + socketQueue = dispatch_queue_create([GCDAsyncSocketQueueName UTF8String], NULL); + } + + // The dispatch_queue_set_specific() and dispatch_get_specific() functions take a "void *key" parameter. + // From the documentation: + // + // > Keys are only compared as pointers and are never dereferenced. + // > Thus, you can use a pointer to a static variable for a specific subsystem or + // > any other value that allows you to identify the value uniquely. + // + // We're just going to use the memory address of an ivar. + // Specifically an ivar that is explicitly named for our purpose to make the code more readable. + // + // However, it feels tedious (and less readable) to include the "&" all the time: + // dispatch_get_specific(&IsOnSocketQueueOrTargetQueueKey) + // + // So we're going to make it so it doesn't matter if we use the '&' or not, + // by assigning the value of the ivar to the address of the ivar. + // Thus: IsOnSocketQueueOrTargetQueueKey == &IsOnSocketQueueOrTargetQueueKey; + + IsOnSocketQueueOrTargetQueueKey = &IsOnSocketQueueOrTargetQueueKey; + + void *nonNullUnusedPointer = (__bridge void *)self; + dispatch_queue_set_specific(socketQueue, IsOnSocketQueueOrTargetQueueKey, nonNullUnusedPointer, NULL); + + readQueue = [[NSMutableArray alloc] initWithCapacity:5]; + currentRead = nil; + + writeQueue = [[NSMutableArray alloc] initWithCapacity:5]; + currentWrite = nil; + + preBuffer = [[GCDAsyncSocketPreBuffer alloc] initWithCapacity:(1024 * 4)]; + } + return self; +} + +- (void)dealloc +{ + LogInfo(@"%@ - %@ (start)", THIS_METHOD, self); + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + [self closeWithError:nil]; + } + else + { + dispatch_sync(socketQueue, ^{ + [self closeWithError:nil]; + }); + } + + delegate = nil; + + #if NEEDS_DISPATCH_RETAIN_RELEASE + if (delegateQueue) dispatch_release(delegateQueue); + #endif + delegateQueue = NULL; + + #if NEEDS_DISPATCH_RETAIN_RELEASE + if (socketQueue) dispatch_release(socketQueue); + #endif + socketQueue = NULL; + + LogInfo(@"%@ - %@ (finish)", THIS_METHOD, self); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Configuration +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (id)delegate +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return delegate; + } + else + { + __block id result; + + dispatch_sync(socketQueue, ^{ + result = delegate; + }); + + return result; + } +} + +- (void)setDelegate:(id)newDelegate synchronously:(BOOL)synchronously +{ + dispatch_block_t block = ^{ + delegate = newDelegate; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) { + block(); + } + else { + if (synchronously) + dispatch_sync(socketQueue, block); + else + dispatch_async(socketQueue, block); + } +} + +- (void)setDelegate:(id)newDelegate +{ + [self setDelegate:newDelegate synchronously:NO]; +} + +- (void)synchronouslySetDelegate:(id)newDelegate +{ + [self setDelegate:newDelegate synchronously:YES]; +} + +- (dispatch_queue_t)delegateQueue +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return delegateQueue; + } + else + { + __block dispatch_queue_t result; + + dispatch_sync(socketQueue, ^{ + result = delegateQueue; + }); + + return result; + } +} + +- (void)setDelegateQueue:(dispatch_queue_t)newDelegateQueue synchronously:(BOOL)synchronously +{ + dispatch_block_t block = ^{ + + #if NEEDS_DISPATCH_RETAIN_RELEASE + if (delegateQueue) dispatch_release(delegateQueue); + if (newDelegateQueue) dispatch_retain(newDelegateQueue); + #endif + + delegateQueue = newDelegateQueue; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) { + block(); + } + else { + if (synchronously) + dispatch_sync(socketQueue, block); + else + dispatch_async(socketQueue, block); + } +} + +- (void)setDelegateQueue:(dispatch_queue_t)newDelegateQueue +{ + [self setDelegateQueue:newDelegateQueue synchronously:NO]; +} + +- (void)synchronouslySetDelegateQueue:(dispatch_queue_t)newDelegateQueue +{ + [self setDelegateQueue:newDelegateQueue synchronously:YES]; +} + +- (void)getDelegate:(id *)delegatePtr delegateQueue:(dispatch_queue_t *)delegateQueuePtr +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + if (delegatePtr) *delegatePtr = delegate; + if (delegateQueuePtr) *delegateQueuePtr = delegateQueue; + } + else + { + __block id dPtr = NULL; + __block dispatch_queue_t dqPtr = NULL; + + dispatch_sync(socketQueue, ^{ + dPtr = delegate; + dqPtr = delegateQueue; + }); + + if (delegatePtr) *delegatePtr = dPtr; + if (delegateQueuePtr) *delegateQueuePtr = dqPtr; + } +} + +- (void)setDelegate:(id)newDelegate delegateQueue:(dispatch_queue_t)newDelegateQueue synchronously:(BOOL)synchronously +{ + dispatch_block_t block = ^{ + + delegate = newDelegate; + + #if NEEDS_DISPATCH_RETAIN_RELEASE + if (delegateQueue) dispatch_release(delegateQueue); + if (newDelegateQueue) dispatch_retain(newDelegateQueue); + #endif + + delegateQueue = newDelegateQueue; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) { + block(); + } + else { + if (synchronously) + dispatch_sync(socketQueue, block); + else + dispatch_async(socketQueue, block); + } +} + +- (void)setDelegate:(id)newDelegate delegateQueue:(dispatch_queue_t)newDelegateQueue +{ + [self setDelegate:newDelegate delegateQueue:newDelegateQueue synchronously:NO]; +} + +- (void)synchronouslySetDelegate:(id)newDelegate delegateQueue:(dispatch_queue_t)newDelegateQueue +{ + [self setDelegate:newDelegate delegateQueue:newDelegateQueue synchronously:YES]; +} + +- (BOOL)isIPv4Enabled +{ + // Note: YES means kIPv4Disabled is OFF + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return ((config & kIPv4Disabled) == 0); + } + else + { + __block BOOL result; + + dispatch_sync(socketQueue, ^{ + result = ((config & kIPv4Disabled) == 0); + }); + + return result; + } +} + +- (void)setIPv4Enabled:(BOOL)flag +{ + // Note: YES means kIPv4Disabled is OFF + + dispatch_block_t block = ^{ + + if (flag) + config &= ~kIPv4Disabled; + else + config |= kIPv4Disabled; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_async(socketQueue, block); +} + +- (BOOL)isIPv6Enabled +{ + // Note: YES means kIPv6Disabled is OFF + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return ((config & kIPv6Disabled) == 0); + } + else + { + __block BOOL result; + + dispatch_sync(socketQueue, ^{ + result = ((config & kIPv6Disabled) == 0); + }); + + return result; + } +} + +- (void)setIPv6Enabled:(BOOL)flag +{ + // Note: YES means kIPv6Disabled is OFF + + dispatch_block_t block = ^{ + + if (flag) + config &= ~kIPv6Disabled; + else + config |= kIPv6Disabled; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_async(socketQueue, block); +} + +- (BOOL)isIPv4PreferredOverIPv6 +{ + // Note: YES means kPreferIPv6 is OFF + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return ((config & kPreferIPv6) == 0); + } + else + { + __block BOOL result; + + dispatch_sync(socketQueue, ^{ + result = ((config & kPreferIPv6) == 0); + }); + + return result; + } +} + +- (void)setPreferIPv4OverIPv6:(BOOL)flag +{ + // Note: YES means kPreferIPv6 is OFF + + dispatch_block_t block = ^{ + + if (flag) + config &= ~kPreferIPv6; + else + config |= kPreferIPv6; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_async(socketQueue, block); +} + +- (id)userData +{ + __block id result = nil; + + dispatch_block_t block = ^{ + + result = userData; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +- (void)setUserData:(id)arbitraryUserData +{ + dispatch_block_t block = ^{ + + if (userData != arbitraryUserData) + { + userData = arbitraryUserData; + } + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_async(socketQueue, block); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Accepting +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)acceptOnPort:(uint16_t)port error:(NSError **)errPtr +{ + return [self acceptOnInterface:nil port:port error:errPtr]; +} + +- (BOOL)acceptOnInterface:(NSString *)inInterface port:(uint16_t)port error:(NSError **)errPtr +{ + LogTrace(); + + // Just in-case interface parameter is immutable. + NSString *interface = [inInterface copy]; + + __block BOOL result = NO; + __block NSError *err = nil; + + // CreateSocket Block + // This block will be invoked within the dispatch block below. + + int(^createSocket)(int, NSData*) = ^int (int domain, NSData *interfaceAddr) { + + int socketFD = socket(domain, SOCK_STREAM, 0); + + if (socketFD == SOCKET_NULL) + { + NSString *reason = @"Error in socket() function"; + err = [self errnoErrorWithReason:reason]; + + return SOCKET_NULL; + } + + int status; + + // Set socket options + + status = fcntl(socketFD, F_SETFL, O_NONBLOCK); + if (status == -1) + { + NSString *reason = @"Error enabling non-blocking IO on socket (fcntl)"; + err = [self errnoErrorWithReason:reason]; + + LogVerbose(@"close(socketFD)"); + close(socketFD); + return SOCKET_NULL; + } + + int reuseOn = 1; + status = setsockopt(socketFD, SOL_SOCKET, SO_REUSEADDR, &reuseOn, sizeof(reuseOn)); + if (status == -1) + { + NSString *reason = @"Error enabling address reuse (setsockopt)"; + err = [self errnoErrorWithReason:reason]; + + LogVerbose(@"close(socketFD)"); + close(socketFD); + return SOCKET_NULL; + } + + // Bind socket + + status = bind(socketFD, (const struct sockaddr *)[interfaceAddr bytes], (socklen_t)[interfaceAddr length]); + if (status == -1) + { + NSString *reason = @"Error in bind() function"; + err = [self errnoErrorWithReason:reason]; + + LogVerbose(@"close(socketFD)"); + close(socketFD); + return SOCKET_NULL; + } + + // Listen + + status = listen(socketFD, 1024); + if (status == -1) + { + NSString *reason = @"Error in listen() function"; + err = [self errnoErrorWithReason:reason]; + + LogVerbose(@"close(socketFD)"); + close(socketFD); + return SOCKET_NULL; + } + + return socketFD; + }; + + // Create dispatch block and run on socketQueue + + dispatch_block_t block = ^{ @autoreleasepool { + + if (delegate == nil) // Must have delegate set + { + NSString *msg = @"Attempting to accept without a delegate. Set a delegate first."; + err = [self badConfigError:msg]; + + return_from_block; + } + + if (delegateQueue == NULL) // Must have delegate queue set + { + NSString *msg = @"Attempting to accept without a delegate queue. Set a delegate queue first."; + err = [self badConfigError:msg]; + + return_from_block; + } + + BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO; + BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO; + + if (isIPv4Disabled && isIPv6Disabled) // Must have IPv4 or IPv6 enabled + { + NSString *msg = @"Both IPv4 and IPv6 have been disabled. Must enable at least one protocol first."; + err = [self badConfigError:msg]; + + return_from_block; + } + + if (![self isDisconnected]) // Must be disconnected + { + NSString *msg = @"Attempting to accept while connected or accepting connections. Disconnect first."; + err = [self badConfigError:msg]; + + return_from_block; + } + + // Clear queues (spurious read/write requests post disconnect) + [readQueue removeAllObjects]; + [writeQueue removeAllObjects]; + + // Resolve interface from description + + NSMutableData *interface4 = nil; + NSMutableData *interface6 = nil; + + [self getInterfaceAddress4:&interface4 address6:&interface6 fromDescription:interface port:port]; + + if ((interface4 == nil) && (interface6 == nil)) + { + NSString *msg = @"Unknown interface. Specify valid interface by name (e.g. \"en1\") or IP address."; + err = [self badParamError:msg]; + + return_from_block; + } + + if (isIPv4Disabled && (interface6 == nil)) + { + NSString *msg = @"IPv4 has been disabled and specified interface doesn't support IPv6."; + err = [self badParamError:msg]; + + return_from_block; + } + + if (isIPv6Disabled && (interface4 == nil)) + { + NSString *msg = @"IPv6 has been disabled and specified interface doesn't support IPv4."; + err = [self badParamError:msg]; + + return_from_block; + } + + BOOL enableIPv4 = !isIPv4Disabled && (interface4 != nil); + BOOL enableIPv6 = !isIPv6Disabled && (interface6 != nil); + + // Create sockets, configure, bind, and listen + + if (enableIPv4) + { + LogVerbose(@"Creating IPv4 socket"); + socket4FD = createSocket(AF_INET, interface4); + + if (socket4FD == SOCKET_NULL) + { + return_from_block; + } + } + + if (enableIPv6) + { + LogVerbose(@"Creating IPv6 socket"); + + if (enableIPv4 && (port == 0)) + { + // No specific port was specified, so we allowed the OS to pick an available port for us. + // Now we need to make sure the IPv6 socket listens on the same port as the IPv4 socket. + + struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *)[interface6 mutableBytes]; + addr6->sin6_port = htons([self localPort4]); + } + + socket6FD = createSocket(AF_INET6, interface6); + + if (socket6FD == SOCKET_NULL) + { + if (socket4FD != SOCKET_NULL) + { + LogVerbose(@"close(socket4FD)"); + close(socket4FD); + } + + return_from_block; + } + } + + // Create accept sources + + if (enableIPv4) + { + accept4Source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, socket4FD, 0, socketQueue); + + int socketFD = socket4FD; + dispatch_source_t acceptSource = accept4Source; + + dispatch_source_set_event_handler(accept4Source, ^{ @autoreleasepool { + + LogVerbose(@"event4Block"); + + unsigned long i = 0; + unsigned long numPendingConnections = dispatch_source_get_data(acceptSource); + + LogVerbose(@"numPendingConnections: %lu", numPendingConnections); + + while ([self doAccept:socketFD] && (++i < numPendingConnections)); + }}); + + dispatch_source_set_cancel_handler(accept4Source, ^{ + + #if NEEDS_DISPATCH_RETAIN_RELEASE + LogVerbose(@"dispatch_release(accept4Source)"); + dispatch_release(acceptSource); + #endif + + LogVerbose(@"close(socket4FD)"); + close(socketFD); + }); + + LogVerbose(@"dispatch_resume(accept4Source)"); + dispatch_resume(accept4Source); + } + + if (enableIPv6) + { + accept6Source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, socket6FD, 0, socketQueue); + + int socketFD = socket6FD; + dispatch_source_t acceptSource = accept6Source; + + dispatch_source_set_event_handler(accept6Source, ^{ @autoreleasepool { + + LogVerbose(@"event6Block"); + + unsigned long i = 0; + unsigned long numPendingConnections = dispatch_source_get_data(acceptSource); + + LogVerbose(@"numPendingConnections: %lu", numPendingConnections); + + while ([self doAccept:socketFD] && (++i < numPendingConnections)); + }}); + + dispatch_source_set_cancel_handler(accept6Source, ^{ + + #if NEEDS_DISPATCH_RETAIN_RELEASE + LogVerbose(@"dispatch_release(accept6Source)"); + dispatch_release(acceptSource); + #endif + + LogVerbose(@"close(socket6FD)"); + close(socketFD); + }); + + LogVerbose(@"dispatch_resume(accept6Source)"); + dispatch_resume(accept6Source); + } + + flags |= kSocketStarted; + + result = YES; + }}; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + if (result == NO) + { + LogInfo(@"Error in accept: %@", err); + + if (errPtr) + *errPtr = err; + } + + return result; +} + +- (BOOL)doAccept:(int)parentSocketFD +{ + LogTrace(); + + BOOL isIPv4; + int childSocketFD; + NSData *childSocketAddress; + + if (parentSocketFD == socket4FD) + { + isIPv4 = YES; + + struct sockaddr_in addr; + socklen_t addrLen = sizeof(addr); + + childSocketFD = accept(parentSocketFD, (struct sockaddr *)&addr, &addrLen); + + if (childSocketFD == -1) + { + LogWarn(@"Accept failed with error: %@", [self errnoError]); + return NO; + } + + childSocketAddress = [NSData dataWithBytes:&addr length:addrLen]; + } + else // if (parentSocketFD == socket6FD) + { + isIPv4 = NO; + + struct sockaddr_in6 addr; + socklen_t addrLen = sizeof(addr); + + childSocketFD = accept(parentSocketFD, (struct sockaddr *)&addr, &addrLen); + + if (childSocketFD == -1) + { + LogWarn(@"Accept failed with error: %@", [self errnoError]); + return NO; + } + + childSocketAddress = [NSData dataWithBytes:&addr length:addrLen]; + } + + // Enable non-blocking IO on the socket + + int result = fcntl(childSocketFD, F_SETFL, O_NONBLOCK); + if (result == -1) + { + LogWarn(@"Error enabling non-blocking IO on accepted socket (fcntl)"); + return NO; + } + + // Prevent SIGPIPE signals + + int nosigpipe = 1; + setsockopt(childSocketFD, SOL_SOCKET, SO_NOSIGPIPE, &nosigpipe, sizeof(nosigpipe)); + + // Notify delegate + + if (delegateQueue) + { + __strong id theDelegate = delegate; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + // Query delegate for custom socket queue + + dispatch_queue_t childSocketQueue = NULL; + + if ([theDelegate respondsToSelector:@selector(newSocketQueueForConnectionFromAddress:onSocket:)]) + { + childSocketQueue = [theDelegate newSocketQueueForConnectionFromAddress:childSocketAddress + onSocket:self]; + } + + // Create GCDAsyncSocket instance for accepted socket + + GCDAsyncSocket *acceptedSocket = [[GCDAsyncSocket alloc] initWithDelegate:theDelegate + delegateQueue:delegateQueue + socketQueue:childSocketQueue]; + + if (isIPv4) + acceptedSocket->socket4FD = childSocketFD; + else + acceptedSocket->socket6FD = childSocketFD; + + acceptedSocket->flags = (kSocketStarted | kConnected); + + // Setup read and write sources for accepted socket + + dispatch_async(acceptedSocket->socketQueue, ^{ @autoreleasepool { + + [acceptedSocket setupReadAndWriteSourcesForNewlyConnectedSocket:childSocketFD]; + }}); + + // Notify delegate + + if ([theDelegate respondsToSelector:@selector(socket:didAcceptNewSocket:)]) + { + [theDelegate socket:self didAcceptNewSocket:acceptedSocket]; + } + + // Release the socket queue returned from the delegate (it was retained by acceptedSocket) + #if NEEDS_DISPATCH_RETAIN_RELEASE + if (childSocketQueue) dispatch_release(childSocketQueue); + #endif + + // The accepted socket should have been retained by the delegate. + // Otherwise it gets properly released when exiting the block. + }}); + } + + return YES; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Connecting +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method runs through the various checks required prior to a connection attempt. + * It is shared between the connectToHost and connectToAddress methods. + * +**/ +- (BOOL)preConnectWithInterface:(NSString *)interface error:(NSError **)errPtr +{ + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + if (delegate == nil) // Must have delegate set + { + if (errPtr) + { + NSString *msg = @"Attempting to connect without a delegate. Set a delegate first."; + *errPtr = [self badConfigError:msg]; + } + return NO; + } + + if (delegateQueue == NULL) // Must have delegate queue set + { + if (errPtr) + { + NSString *msg = @"Attempting to connect without a delegate queue. Set a delegate queue first."; + *errPtr = [self badConfigError:msg]; + } + return NO; + } + + if (![self isDisconnected]) // Must be disconnected + { + if (errPtr) + { + NSString *msg = @"Attempting to connect while connected or accepting connections. Disconnect first."; + *errPtr = [self badConfigError:msg]; + } + return NO; + } + + BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO; + BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO; + + if (isIPv4Disabled && isIPv6Disabled) // Must have IPv4 or IPv6 enabled + { + if (errPtr) + { + NSString *msg = @"Both IPv4 and IPv6 have been disabled. Must enable at least one protocol first."; + *errPtr = [self badConfigError:msg]; + } + return NO; + } + + if (interface) + { + NSMutableData *interface4 = nil; + NSMutableData *interface6 = nil; + + [self getInterfaceAddress4:&interface4 address6:&interface6 fromDescription:interface port:0]; + + if ((interface4 == nil) && (interface6 == nil)) + { + if (errPtr) + { + NSString *msg = @"Unknown interface. Specify valid interface by name (e.g. \"en1\") or IP address."; + *errPtr = [self badParamError:msg]; + } + return NO; + } + + if (isIPv4Disabled && (interface6 == nil)) + { + if (errPtr) + { + NSString *msg = @"IPv4 has been disabled and specified interface doesn't support IPv6."; + *errPtr = [self badParamError:msg]; + } + return NO; + } + + if (isIPv6Disabled && (interface4 == nil)) + { + if (errPtr) + { + NSString *msg = @"IPv6 has been disabled and specified interface doesn't support IPv4."; + *errPtr = [self badParamError:msg]; + } + return NO; + } + + connectInterface4 = interface4; + connectInterface6 = interface6; + } + + // Clear queues (spurious read/write requests post disconnect) + [readQueue removeAllObjects]; + [writeQueue removeAllObjects]; + + return YES; +} + +- (BOOL)connectToHost:(NSString*)host onPort:(uint16_t)port error:(NSError **)errPtr +{ + return [self connectToHost:host onPort:port withTimeout:-1 error:errPtr]; +} + +- (BOOL)connectToHost:(NSString *)host + onPort:(uint16_t)port + withTimeout:(NSTimeInterval)timeout + error:(NSError **)errPtr +{ + return [self connectToHost:host onPort:port viaInterface:nil withTimeout:timeout error:errPtr]; +} + +- (BOOL)connectToHost:(NSString *)inHost + onPort:(uint16_t)port + viaInterface:(NSString *)inInterface + withTimeout:(NSTimeInterval)timeout + error:(NSError **)errPtr +{ + LogTrace(); + + // Just in case immutable objects were passed + NSString *host = [inHost copy]; + NSString *interface = [inInterface copy]; + + __block BOOL result = NO; + __block NSError *err = nil; + + dispatch_block_t block = ^{ @autoreleasepool { + + // Check for problems with host parameter + + if ([host length] == 0) + { + NSString *msg = @"Invalid host parameter (nil or \"\"). Should be a domain name or IP address string."; + err = [self badParamError:msg]; + + return_from_block; + } + + // Run through standard pre-connect checks + + if (![self preConnectWithInterface:interface error:&err]) + { + return_from_block; + } + + // We've made it past all the checks. + // It's time to start the connection process. + + flags |= kSocketStarted; + + LogVerbose(@"Dispatching DNS lookup..."); + + // It's possible that the given host parameter is actually a NSMutableString. + // So we want to copy it now, within this block that will be executed synchronously. + // This way the asynchronous lookup block below doesn't have to worry about it changing. + + int aConnectIndex = connectIndex; + NSString *hostCpy = [host copy]; + + dispatch_queue_t globalConcurrentQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0); + dispatch_async(globalConcurrentQueue, ^{ @autoreleasepool { + + [self lookup:aConnectIndex host:hostCpy port:port]; + }}); + + [self startConnectTimeout:timeout]; + + result = YES; + }}; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + if (result == NO) + { + if (errPtr) + *errPtr = err; + } + + return result; +} + +- (BOOL)connectToAddress:(NSData *)remoteAddr error:(NSError **)errPtr +{ + return [self connectToAddress:remoteAddr viaInterface:nil withTimeout:-1 error:errPtr]; +} + +- (BOOL)connectToAddress:(NSData *)remoteAddr withTimeout:(NSTimeInterval)timeout error:(NSError **)errPtr +{ + return [self connectToAddress:remoteAddr viaInterface:nil withTimeout:timeout error:errPtr]; +} + +- (BOOL)connectToAddress:(NSData *)inRemoteAddr + viaInterface:(NSString *)inInterface + withTimeout:(NSTimeInterval)timeout + error:(NSError **)errPtr +{ + LogTrace(); + + // Just in case immutable objects were passed + NSData *remoteAddr = [inRemoteAddr copy]; + NSString *interface = [inInterface copy]; + + __block BOOL result = NO; + __block NSError *err = nil; + + dispatch_block_t block = ^{ @autoreleasepool { + + // Check for problems with remoteAddr parameter + + NSData *address4 = nil; + NSData *address6 = nil; + + if ([remoteAddr length] >= sizeof(struct sockaddr)) + { + const struct sockaddr *sockaddr = (const struct sockaddr *)[remoteAddr bytes]; + + if (sockaddr->sa_family == AF_INET) + { + if ([remoteAddr length] == sizeof(struct sockaddr_in)) + { + address4 = remoteAddr; + } + } + else if (sockaddr->sa_family == AF_INET6) + { + if ([remoteAddr length] == sizeof(struct sockaddr_in6)) + { + address6 = remoteAddr; + } + } + } + + if ((address4 == nil) && (address6 == nil)) + { + NSString *msg = @"A valid IPv4 or IPv6 address was not given"; + err = [self badParamError:msg]; + + return_from_block; + } + + BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO; + BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO; + + if (isIPv4Disabled && (address4 != nil)) + { + NSString *msg = @"IPv4 has been disabled and an IPv4 address was passed."; + err = [self badParamError:msg]; + + return_from_block; + } + + if (isIPv6Disabled && (address6 != nil)) + { + NSString *msg = @"IPv6 has been disabled and an IPv6 address was passed."; + err = [self badParamError:msg]; + + return_from_block; + } + + // Run through standard pre-connect checks + + if (![self preConnectWithInterface:interface error:&err]) + { + return_from_block; + } + + // We've made it past all the checks. + // It's time to start the connection process. + + if (![self connectWithAddress4:address4 address6:address6 error:&err]) + { + return_from_block; + } + + flags |= kSocketStarted; + + [self startConnectTimeout:timeout]; + + result = YES; + }}; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + if (result == NO) + { + if (errPtr) + *errPtr = err; + } + + return result; +} + +- (void)lookup:(int)aConnectIndex host:(NSString *)host port:(uint16_t)port +{ + LogTrace(); + + // This method is executed on a global concurrent queue. + // It posts the results back to the socket queue. + // The lookupIndex is used to ignore the results if the connect operation was cancelled or timed out. + + NSError *error = nil; + + NSData *address4 = nil; + NSData *address6 = nil; + + + if ([host isEqualToString:@"localhost"] || [host isEqualToString:@"loopback"]) + { + // Use LOOPBACK address + struct sockaddr_in nativeAddr; + nativeAddr.sin_len = sizeof(struct sockaddr_in); + nativeAddr.sin_family = AF_INET; + nativeAddr.sin_port = htons(port); + nativeAddr.sin_addr.s_addr = htonl(INADDR_LOOPBACK); + memset(&(nativeAddr.sin_zero), 0, sizeof(nativeAddr.sin_zero)); + + struct sockaddr_in6 nativeAddr6; + nativeAddr6.sin6_len = sizeof(struct sockaddr_in6); + nativeAddr6.sin6_family = AF_INET6; + nativeAddr6.sin6_port = htons(port); + nativeAddr6.sin6_flowinfo = 0; + nativeAddr6.sin6_addr = in6addr_loopback; + nativeAddr6.sin6_scope_id = 0; + + // Wrap the native address structures + address4 = [NSData dataWithBytes:&nativeAddr length:sizeof(nativeAddr)]; + address6 = [NSData dataWithBytes:&nativeAddr6 length:sizeof(nativeAddr6)]; + } + else + { + NSString *portStr = [NSString stringWithFormat:@"%hu", port]; + + struct addrinfo hints, *res, *res0; + + memset(&hints, 0, sizeof(hints)); + hints.ai_family = PF_UNSPEC; + hints.ai_socktype = SOCK_STREAM; + hints.ai_protocol = IPPROTO_TCP; + + int gai_error = getaddrinfo([host UTF8String], [portStr UTF8String], &hints, &res0); + + if (gai_error) + { + error = [self gaiError:gai_error]; + } + else + { + for(res = res0; res; res = res->ai_next) + { + if ((address4 == nil) && (res->ai_family == AF_INET)) + { + // Found IPv4 address + // Wrap the native address structure + address4 = [NSData dataWithBytes:res->ai_addr length:res->ai_addrlen]; + } + else if ((address6 == nil) && (res->ai_family == AF_INET6)) + { + // Found IPv6 address + // Wrap the native address structure + address6 = [NSData dataWithBytes:res->ai_addr length:res->ai_addrlen]; + } + } + freeaddrinfo(res0); + + if ((address4 == nil) && (address6 == nil)) + { + error = [self gaiError:EAI_FAIL]; + } + } + } + + if (error) + { + dispatch_async(socketQueue, ^{ @autoreleasepool { + + [self lookup:aConnectIndex didFail:error]; + }}); + } + else + { + dispatch_async(socketQueue, ^{ @autoreleasepool { + + [self lookup:aConnectIndex didSucceedWithAddress4:address4 address6:address6]; + }}); + } +} + +- (void)lookup:(int)aConnectIndex didSucceedWithAddress4:(NSData *)address4 address6:(NSData *)address6 +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + NSAssert(address4 || address6, @"Expected at least one valid address"); + + if (aConnectIndex != connectIndex) + { + LogInfo(@"Ignoring lookupDidSucceed, already disconnected"); + + // The connect operation has been cancelled. + // That is, socket was disconnected, or connection has already timed out. + return; + } + + // Check for problems + + BOOL isIPv4Disabled = (config & kIPv4Disabled) ? YES : NO; + BOOL isIPv6Disabled = (config & kIPv6Disabled) ? YES : NO; + + if (isIPv4Disabled && (address6 == nil)) + { + NSString *msg = @"IPv4 has been disabled and DNS lookup found no IPv6 address."; + + [self closeWithError:[self otherError:msg]]; + return; + } + + if (isIPv6Disabled && (address4 == nil)) + { + NSString *msg = @"IPv6 has been disabled and DNS lookup found no IPv4 address."; + + [self closeWithError:[self otherError:msg]]; + return; + } + + // Start the normal connection process + + NSError *err = nil; + if (![self connectWithAddress4:address4 address6:address6 error:&err]) + { + [self closeWithError:err]; + } +} + +/** + * This method is called if the DNS lookup fails. + * This method is executed on the socketQueue. + * + * Since the DNS lookup executed synchronously on a global concurrent queue, + * the original connection request may have already been cancelled or timed-out by the time this method is invoked. + * The lookupIndex tells us whether the lookup is still valid or not. +**/ +- (void)lookup:(int)aConnectIndex didFail:(NSError *)error +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + + if (aConnectIndex != connectIndex) + { + LogInfo(@"Ignoring lookup:didFail: - already disconnected"); + + // The connect operation has been cancelled. + // That is, socket was disconnected, or connection has already timed out. + return; + } + + [self endConnectTimeout]; + [self closeWithError:error]; +} + +- (BOOL)connectWithAddress4:(NSData *)address4 address6:(NSData *)address6 error:(NSError **)errPtr +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + LogVerbose(@"IPv4: %@:%hu", [[self class] hostFromAddress:address4], [[self class] portFromAddress:address4]); + LogVerbose(@"IPv6: %@:%hu", [[self class] hostFromAddress:address6], [[self class] portFromAddress:address6]); + + // Determine socket type + + BOOL preferIPv6 = (config & kPreferIPv6) ? YES : NO; + + BOOL useIPv6 = ((preferIPv6 && address6) || (address4 == nil)); + + // Create the socket + + int socketFD; + NSData *address; + NSData *connectInterface; + + if (useIPv6) + { + LogVerbose(@"Creating IPv6 socket"); + + socket6FD = socket(AF_INET6, SOCK_STREAM, 0); + + socketFD = socket6FD; + address = address6; + connectInterface = connectInterface6; + } + else + { + LogVerbose(@"Creating IPv4 socket"); + + socket4FD = socket(AF_INET, SOCK_STREAM, 0); + + socketFD = socket4FD; + address = address4; + connectInterface = connectInterface4; + } + + if (socketFD == SOCKET_NULL) + { + if (errPtr) + *errPtr = [self errnoErrorWithReason:@"Error in socket() function"]; + + return NO; + } + + // Bind the socket to the desired interface (if needed) + + if (connectInterface) + { + LogVerbose(@"Binding socket..."); + + if ([[self class] portFromAddress:connectInterface] > 0) + { + // Since we're going to be binding to a specific port, + // we should turn on reuseaddr to allow us to override sockets in time_wait. + + int reuseOn = 1; + setsockopt(socketFD, SOL_SOCKET, SO_REUSEADDR, &reuseOn, sizeof(reuseOn)); + } + + const struct sockaddr *interfaceAddr = (const struct sockaddr *)[connectInterface bytes]; + + int result = bind(socketFD, interfaceAddr, (socklen_t)[connectInterface length]); + if (result != 0) + { + if (errPtr) + *errPtr = [self errnoErrorWithReason:@"Error in bind() function"]; + + return NO; + } + } + + // Prevent SIGPIPE signals + + int nosigpipe = 1; + setsockopt(socketFD, SOL_SOCKET, SO_NOSIGPIPE, &nosigpipe, sizeof(nosigpipe)); + + // Start the connection process in a background queue + + int aConnectIndex = connectIndex; + + dispatch_queue_t globalConcurrentQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0); + dispatch_async(globalConcurrentQueue, ^{ + + int result = connect(socketFD, (const struct sockaddr *)[address bytes], (socklen_t)[address length]); + if (result == 0) + { + dispatch_async(socketQueue, ^{ @autoreleasepool { + + [self didConnect:aConnectIndex]; + }}); + } + else + { + NSError *error = [self errnoErrorWithReason:@"Error in connect() function"]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + [self didNotConnect:aConnectIndex error:error]; + }}); + } + }); + + LogVerbose(@"Connecting..."); + + return YES; +} + +- (void)didConnect:(int)aConnectIndex +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + + if (aConnectIndex != connectIndex) + { + LogInfo(@"Ignoring didConnect, already disconnected"); + + // The connect operation has been cancelled. + // That is, socket was disconnected, or connection has already timed out. + return; + } + + flags |= kConnected; + + [self endConnectTimeout]; + + #if TARGET_OS_IPHONE + // The endConnectTimeout method executed above incremented the connectIndex. + aConnectIndex = connectIndex; + #endif + + // Setup read/write streams (as workaround for specific shortcomings in the iOS platform) + // + // Note: + // There may be configuration options that must be set by the delegate before opening the streams. + // The primary example is the kCFStreamNetworkServiceTypeVoIP flag, which only works on an unopened stream. + // + // Thus we wait until after the socket:didConnectToHost:port: delegate method has completed. + // This gives the delegate time to properly configure the streams if needed. + + dispatch_block_t SetupStreamsPart1 = ^{ + #if TARGET_OS_IPHONE + + if (![self createReadAndWriteStream]) + { + [self closeWithError:[self otherError:@"Error creating CFStreams"]]; + return; + } + + if (![self registerForStreamCallbacksIncludingReadWrite:NO]) + { + [self closeWithError:[self otherError:@"Error in CFStreamSetClient"]]; + return; + } + + #endif + }; + dispatch_block_t SetupStreamsPart2 = ^{ + #if TARGET_OS_IPHONE + + if (aConnectIndex != connectIndex) + { + // The socket has been disconnected. + return; + } + + if (![self addStreamsToRunLoop]) + { + [self closeWithError:[self otherError:@"Error in CFStreamScheduleWithRunLoop"]]; + return; + } + + if (![self openStreams]) + { + [self closeWithError:[self otherError:@"Error creating CFStreams"]]; + return; + } + + #endif + }; + + // Notify delegate + + NSString *host = [self connectedHost]; + uint16_t port = [self connectedPort]; + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:didConnectToHost:port:)]) + { + SetupStreamsPart1(); + + __strong id theDelegate = delegate; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socket:self didConnectToHost:host port:port]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + SetupStreamsPart2(); + }}); + }}); + } + else + { + SetupStreamsPart1(); + SetupStreamsPart2(); + } + + // Get the connected socket + + int socketFD = (socket4FD != SOCKET_NULL) ? socket4FD : socket6FD; + + // Enable non-blocking IO on the socket + + int result = fcntl(socketFD, F_SETFL, O_NONBLOCK); + if (result == -1) + { + NSString *errMsg = @"Error enabling non-blocking IO on socket (fcntl)"; + [self closeWithError:[self otherError:errMsg]]; + + return; + } + + // Setup our read/write sources + + [self setupReadAndWriteSourcesForNewlyConnectedSocket:socketFD]; + + // Dequeue any pending read/write requests + + [self maybeDequeueRead]; + [self maybeDequeueWrite]; +} + +- (void)didNotConnect:(int)aConnectIndex error:(NSError *)error +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + + if (aConnectIndex != connectIndex) + { + LogInfo(@"Ignoring didNotConnect, already disconnected"); + + // The connect operation has been cancelled. + // That is, socket was disconnected, or connection has already timed out. + return; + } + + [self closeWithError:error]; +} + +- (void)startConnectTimeout:(NSTimeInterval)timeout +{ + if (timeout >= 0.0) + { + connectTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, socketQueue); + + dispatch_source_set_event_handler(connectTimer, ^{ @autoreleasepool { + + [self doConnectTimeout]; + }}); + + #if NEEDS_DISPATCH_RETAIN_RELEASE + dispatch_source_t theConnectTimer = connectTimer; + dispatch_source_set_cancel_handler(connectTimer, ^{ + LogVerbose(@"dispatch_release(connectTimer)"); + dispatch_release(theConnectTimer); + }); + #endif + + dispatch_time_t tt = dispatch_time(DISPATCH_TIME_NOW, (timeout * NSEC_PER_SEC)); + dispatch_source_set_timer(connectTimer, tt, DISPATCH_TIME_FOREVER, 0); + + dispatch_resume(connectTimer); + } +} + +- (void)endConnectTimeout +{ + LogTrace(); + + if (connectTimer) + { + dispatch_source_cancel(connectTimer); + connectTimer = NULL; + } + + // Increment connectIndex. + // This will prevent us from processing results from any related background asynchronous operations. + // + // Note: This should be called from close method even if connectTimer is NULL. + // This is because one might disconnect a socket prior to a successful connection which had no timeout. + + connectIndex++; + + if (connectInterface4) + { + connectInterface4 = nil; + } + if (connectInterface6) + { + connectInterface6 = nil; + } +} + +- (void)doConnectTimeout +{ + LogTrace(); + + [self endConnectTimeout]; + [self closeWithError:[self connectTimeoutError]]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Disconnecting +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)closeWithError:(NSError *)error +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + + [self endConnectTimeout]; + + if (currentRead != nil) [self endCurrentRead]; + if (currentWrite != nil) [self endCurrentWrite]; + + [readQueue removeAllObjects]; + [writeQueue removeAllObjects]; + + [preBuffer reset]; + + #if TARGET_OS_IPHONE + { + if (readStream || writeStream) + { + [self removeStreamsFromRunLoop]; + + if (readStream) + { + CFReadStreamSetClient(readStream, kCFStreamEventNone, NULL, NULL); + CFReadStreamClose(readStream); + CFRelease(readStream); + readStream = NULL; + } + if (writeStream) + { + CFWriteStreamSetClient(writeStream, kCFStreamEventNone, NULL, NULL); + CFWriteStreamClose(writeStream); + CFRelease(writeStream); + writeStream = NULL; + } + } + } + #endif + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + { + [sslPreBuffer reset]; + sslErrCode = noErr; + + if (sslContext) + { + // Getting a linker error here about the SSLx() functions? + // You need to add the Security Framework to your application. + + SSLClose(sslContext); + + #if TARGET_OS_IPHONE + CFRelease(sslContext); + #else + SSLDisposeContext(sslContext); + #endif + + sslContext = NULL; + } + } + #endif + + // For some crazy reason (in my opinion), cancelling a dispatch source doesn't + // invoke the cancel handler if the dispatch source is paused. + // So we have to unpause the source if needed. + // This allows the cancel handler to be run, which in turn releases the source and closes the socket. + + if (!accept4Source && !accept6Source && !readSource && !writeSource) + { + LogVerbose(@"manually closing close"); + + if (socket4FD != SOCKET_NULL) + { + LogVerbose(@"close(socket4FD)"); + close(socket4FD); + socket4FD = SOCKET_NULL; + } + + if (socket6FD != SOCKET_NULL) + { + LogVerbose(@"close(socket6FD)"); + close(socket6FD); + socket6FD = SOCKET_NULL; + } + } + else + { + if (accept4Source) + { + LogVerbose(@"dispatch_source_cancel(accept4Source)"); + dispatch_source_cancel(accept4Source); + + // We never suspend accept4Source + + accept4Source = NULL; + } + + if (accept6Source) + { + LogVerbose(@"dispatch_source_cancel(accept6Source)"); + dispatch_source_cancel(accept6Source); + + // We never suspend accept6Source + + accept6Source = NULL; + } + + if (readSource) + { + LogVerbose(@"dispatch_source_cancel(readSource)"); + dispatch_source_cancel(readSource); + + [self resumeReadSource]; + + readSource = NULL; + } + + if (writeSource) + { + LogVerbose(@"dispatch_source_cancel(writeSource)"); + dispatch_source_cancel(writeSource); + + [self resumeWriteSource]; + + writeSource = NULL; + } + + // The sockets will be closed by the cancel handlers of the corresponding source + + socket4FD = SOCKET_NULL; + socket6FD = SOCKET_NULL; + } + + // If the client has passed the connect/accept method, then the connection has at least begun. + // Notify delegate that it is now ending. + BOOL shouldCallDelegate = (flags & kSocketStarted); + + // Clear stored socket info and all flags (config remains as is) + socketFDBytesAvailable = 0; + flags = 0; + + if (shouldCallDelegate) + { + if (delegateQueue && [delegate respondsToSelector: @selector(socketDidDisconnect:withError:)]) + { + __strong id theDelegate = delegate; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socketDidDisconnect:self withError:error]; + }}); + } + } +} + +- (void)disconnect +{ + dispatch_block_t block = ^{ @autoreleasepool { + + if (flags & kSocketStarted) + { + [self closeWithError:nil]; + } + }}; + + // Synchronous disconnection, as documented in the header file + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); +} + +- (void)disconnectAfterReading +{ + dispatch_async(socketQueue, ^{ @autoreleasepool { + + if (flags & kSocketStarted) + { + flags |= (kForbidReadsWrites | kDisconnectAfterReads); + [self maybeClose]; + } + }}); +} + +- (void)disconnectAfterWriting +{ + dispatch_async(socketQueue, ^{ @autoreleasepool { + + if (flags & kSocketStarted) + { + flags |= (kForbidReadsWrites | kDisconnectAfterWrites); + [self maybeClose]; + } + }}); +} + +- (void)disconnectAfterReadingAndWriting +{ + dispatch_async(socketQueue, ^{ @autoreleasepool { + + if (flags & kSocketStarted) + { + flags |= (kForbidReadsWrites | kDisconnectAfterReads | kDisconnectAfterWrites); + [self maybeClose]; + } + }}); +} + +/** + * Closes the socket if possible. + * That is, if all writes have completed, and we're set to disconnect after writing, + * or if all reads have completed, and we're set to disconnect after reading. +**/ +- (void)maybeClose +{ + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + BOOL shouldClose = NO; + + if (flags & kDisconnectAfterReads) + { + if (([readQueue count] == 0) && (currentRead == nil)) + { + if (flags & kDisconnectAfterWrites) + { + if (([writeQueue count] == 0) && (currentWrite == nil)) + { + shouldClose = YES; + } + } + else + { + shouldClose = YES; + } + } + } + else if (flags & kDisconnectAfterWrites) + { + if (([writeQueue count] == 0) && (currentWrite == nil)) + { + shouldClose = YES; + } + } + + if (shouldClose) + { + [self closeWithError:nil]; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Errors +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (NSError *)badConfigError:(NSString *)errMsg +{ + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketBadConfigError userInfo:userInfo]; +} + +- (NSError *)badParamError:(NSString *)errMsg +{ + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketBadParamError userInfo:userInfo]; +} + +- (NSError *)gaiError:(int)gai_error +{ + NSString *errMsg = [NSString stringWithCString:gai_strerror(gai_error) encoding:NSASCIIStringEncoding]; + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:@"kCFStreamErrorDomainNetDB" code:gai_error userInfo:userInfo]; +} + +- (NSError *)errnoErrorWithReason:(NSString *)reason +{ + NSString *errMsg = [NSString stringWithUTF8String:strerror(errno)]; + NSDictionary *userInfo = [NSDictionary dictionaryWithObjectsAndKeys:errMsg, NSLocalizedDescriptionKey, + reason, NSLocalizedFailureReasonErrorKey, nil]; + + return [NSError errorWithDomain:NSPOSIXErrorDomain code:errno userInfo:userInfo]; +} + +- (NSError *)errnoError +{ + NSString *errMsg = [NSString stringWithUTF8String:strerror(errno)]; + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:NSPOSIXErrorDomain code:errno userInfo:userInfo]; +} + +- (NSError *)sslError:(OSStatus)ssl_error +{ + NSString *msg = @"Error code definition can be found in Apple's SecureTransport.h"; + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:msg forKey:NSLocalizedRecoverySuggestionErrorKey]; + + return [NSError errorWithDomain:@"kCFStreamErrorDomainSSL" code:ssl_error userInfo:userInfo]; +} + +- (NSError *)connectTimeoutError +{ + NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncSocketConnectTimeoutError", + @"GCDAsyncSocket", [NSBundle mainBundle], + @"Attempt to connect to host timed out", nil); + + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketConnectTimeoutError userInfo:userInfo]; +} + +/** + * Returns a standard AsyncSocket maxed out error. +**/ +- (NSError *)readMaxedOutError +{ + NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncSocketReadMaxedOutError", + @"GCDAsyncSocket", [NSBundle mainBundle], + @"Read operation reached set maximum length", nil); + + NSDictionary *info = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketReadMaxedOutError userInfo:info]; +} + +/** + * Returns a standard AsyncSocket write timeout error. +**/ +- (NSError *)readTimeoutError +{ + NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncSocketReadTimeoutError", + @"GCDAsyncSocket", [NSBundle mainBundle], + @"Read operation timed out", nil); + + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketReadTimeoutError userInfo:userInfo]; +} + +/** + * Returns a standard AsyncSocket write timeout error. +**/ +- (NSError *)writeTimeoutError +{ + NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncSocketWriteTimeoutError", + @"GCDAsyncSocket", [NSBundle mainBundle], + @"Write operation timed out", nil); + + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketWriteTimeoutError userInfo:userInfo]; +} + +- (NSError *)connectionClosedError +{ + NSString *errMsg = NSLocalizedStringWithDefaultValue(@"GCDAsyncSocketClosedError", + @"GCDAsyncSocket", [NSBundle mainBundle], + @"Socket closed by remote peer", nil); + + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketClosedError userInfo:userInfo]; +} + +- (NSError *)otherError:(NSString *)errMsg +{ + NSDictionary *userInfo = [NSDictionary dictionaryWithObject:errMsg forKey:NSLocalizedDescriptionKey]; + + return [NSError errorWithDomain:GCDAsyncSocketErrorDomain code:GCDAsyncSocketOtherError userInfo:userInfo]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Diagnostics +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)isDisconnected +{ + __block BOOL result = NO; + + dispatch_block_t block = ^{ + result = (flags & kSocketStarted) ? NO : YES; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +- (BOOL)isConnected +{ + __block BOOL result = NO; + + dispatch_block_t block = ^{ + result = (flags & kConnected) ? YES : NO; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +- (NSString *)connectedHost +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + if (socket4FD != SOCKET_NULL) + return [self connectedHostFromSocket4:socket4FD]; + if (socket6FD != SOCKET_NULL) + return [self connectedHostFromSocket6:socket6FD]; + + return nil; + } + else + { + __block NSString *result = nil; + + dispatch_sync(socketQueue, ^{ @autoreleasepool { + + if (socket4FD != SOCKET_NULL) + result = [self connectedHostFromSocket4:socket4FD]; + else if (socket6FD != SOCKET_NULL) + result = [self connectedHostFromSocket6:socket6FD]; + }}); + + return result; + } +} + +- (uint16_t)connectedPort +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + if (socket4FD != SOCKET_NULL) + return [self connectedPortFromSocket4:socket4FD]; + if (socket6FD != SOCKET_NULL) + return [self connectedPortFromSocket6:socket6FD]; + + return 0; + } + else + { + __block uint16_t result = 0; + + dispatch_sync(socketQueue, ^{ + // No need for autorelease pool + + if (socket4FD != SOCKET_NULL) + result = [self connectedPortFromSocket4:socket4FD]; + else if (socket6FD != SOCKET_NULL) + result = [self connectedPortFromSocket6:socket6FD]; + }); + + return result; + } +} + +- (NSString *)localHost +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + if (socket4FD != SOCKET_NULL) + return [self localHostFromSocket4:socket4FD]; + if (socket6FD != SOCKET_NULL) + return [self localHostFromSocket6:socket6FD]; + + return nil; + } + else + { + __block NSString *result = nil; + + dispatch_sync(socketQueue, ^{ @autoreleasepool { + + if (socket4FD != SOCKET_NULL) + result = [self localHostFromSocket4:socket4FD]; + else if (socket6FD != SOCKET_NULL) + result = [self localHostFromSocket6:socket6FD]; + }}); + + return result; + } +} + +- (uint16_t)localPort +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + if (socket4FD != SOCKET_NULL) + return [self localPortFromSocket4:socket4FD]; + if (socket6FD != SOCKET_NULL) + return [self localPortFromSocket6:socket6FD]; + + return 0; + } + else + { + __block uint16_t result = 0; + + dispatch_sync(socketQueue, ^{ + // No need for autorelease pool + + if (socket4FD != SOCKET_NULL) + result = [self localPortFromSocket4:socket4FD]; + else if (socket6FD != SOCKET_NULL) + result = [self localPortFromSocket6:socket6FD]; + }); + + return result; + } +} + +- (NSString *)connectedHost4 +{ + if (socket4FD != SOCKET_NULL) + return [self connectedHostFromSocket4:socket4FD]; + + return nil; +} + +- (NSString *)connectedHost6 +{ + if (socket6FD != SOCKET_NULL) + return [self connectedHostFromSocket6:socket6FD]; + + return nil; +} + +- (uint16_t)connectedPort4 +{ + if (socket4FD != SOCKET_NULL) + return [self connectedPortFromSocket4:socket4FD]; + + return 0; +} + +- (uint16_t)connectedPort6 +{ + if (socket6FD != SOCKET_NULL) + return [self connectedPortFromSocket6:socket6FD]; + + return 0; +} + +- (NSString *)localHost4 +{ + if (socket4FD != SOCKET_NULL) + return [self localHostFromSocket4:socket4FD]; + + return nil; +} + +- (NSString *)localHost6 +{ + if (socket6FD != SOCKET_NULL) + return [self localHostFromSocket6:socket6FD]; + + return nil; +} + +- (uint16_t)localPort4 +{ + if (socket4FD != SOCKET_NULL) + return [self localPortFromSocket4:socket4FD]; + + return 0; +} + +- (uint16_t)localPort6 +{ + if (socket6FD != SOCKET_NULL) + return [self localPortFromSocket6:socket6FD]; + + return 0; +} + +- (NSString *)connectedHostFromSocket4:(int)socketFD +{ + struct sockaddr_in sockaddr4; + socklen_t sockaddr4len = sizeof(sockaddr4); + + if (getpeername(socketFD, (struct sockaddr *)&sockaddr4, &sockaddr4len) < 0) + { + return nil; + } + return [[self class] hostFromSockaddr4:&sockaddr4]; +} + +- (NSString *)connectedHostFromSocket6:(int)socketFD +{ + struct sockaddr_in6 sockaddr6; + socklen_t sockaddr6len = sizeof(sockaddr6); + + if (getpeername(socketFD, (struct sockaddr *)&sockaddr6, &sockaddr6len) < 0) + { + return nil; + } + return [[self class] hostFromSockaddr6:&sockaddr6]; +} + +- (uint16_t)connectedPortFromSocket4:(int)socketFD +{ + struct sockaddr_in sockaddr4; + socklen_t sockaddr4len = sizeof(sockaddr4); + + if (getpeername(socketFD, (struct sockaddr *)&sockaddr4, &sockaddr4len) < 0) + { + return 0; + } + return [[self class] portFromSockaddr4:&sockaddr4]; +} + +- (uint16_t)connectedPortFromSocket6:(int)socketFD +{ + struct sockaddr_in6 sockaddr6; + socklen_t sockaddr6len = sizeof(sockaddr6); + + if (getpeername(socketFD, (struct sockaddr *)&sockaddr6, &sockaddr6len) < 0) + { + return 0; + } + return [[self class] portFromSockaddr6:&sockaddr6]; +} + +- (NSString *)localHostFromSocket4:(int)socketFD +{ + struct sockaddr_in sockaddr4; + socklen_t sockaddr4len = sizeof(sockaddr4); + + if (getsockname(socketFD, (struct sockaddr *)&sockaddr4, &sockaddr4len) < 0) + { + return nil; + } + return [[self class] hostFromSockaddr4:&sockaddr4]; +} + +- (NSString *)localHostFromSocket6:(int)socketFD +{ + struct sockaddr_in6 sockaddr6; + socklen_t sockaddr6len = sizeof(sockaddr6); + + if (getsockname(socketFD, (struct sockaddr *)&sockaddr6, &sockaddr6len) < 0) + { + return nil; + } + return [[self class] hostFromSockaddr6:&sockaddr6]; +} + +- (uint16_t)localPortFromSocket4:(int)socketFD +{ + struct sockaddr_in sockaddr4; + socklen_t sockaddr4len = sizeof(sockaddr4); + + if (getsockname(socketFD, (struct sockaddr *)&sockaddr4, &sockaddr4len) < 0) + { + return 0; + } + return [[self class] portFromSockaddr4:&sockaddr4]; +} + +- (uint16_t)localPortFromSocket6:(int)socketFD +{ + struct sockaddr_in6 sockaddr6; + socklen_t sockaddr6len = sizeof(sockaddr6); + + if (getsockname(socketFD, (struct sockaddr *)&sockaddr6, &sockaddr6len) < 0) + { + return 0; + } + return [[self class] portFromSockaddr6:&sockaddr6]; +} + +- (NSData *)connectedAddress +{ + __block NSData *result = nil; + + dispatch_block_t block = ^{ + if (socket4FD != SOCKET_NULL) + { + struct sockaddr_in sockaddr4; + socklen_t sockaddr4len = sizeof(sockaddr4); + + if (getpeername(socket4FD, (struct sockaddr *)&sockaddr4, &sockaddr4len) == 0) + { + result = [[NSData alloc] initWithBytes:&sockaddr4 length:sockaddr4len]; + } + } + + if (socket6FD != SOCKET_NULL) + { + struct sockaddr_in6 sockaddr6; + socklen_t sockaddr6len = sizeof(sockaddr6); + + if (getpeername(socket6FD, (struct sockaddr *)&sockaddr6, &sockaddr6len) == 0) + { + result = [[NSData alloc] initWithBytes:&sockaddr6 length:sockaddr6len]; + } + } + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +- (NSData *)localAddress +{ + __block NSData *result = nil; + + dispatch_block_t block = ^{ + if (socket4FD != SOCKET_NULL) + { + struct sockaddr_in sockaddr4; + socklen_t sockaddr4len = sizeof(sockaddr4); + + if (getsockname(socket4FD, (struct sockaddr *)&sockaddr4, &sockaddr4len) == 0) + { + result = [[NSData alloc] initWithBytes:&sockaddr4 length:sockaddr4len]; + } + } + + if (socket6FD != SOCKET_NULL) + { + struct sockaddr_in6 sockaddr6; + socklen_t sockaddr6len = sizeof(sockaddr6); + + if (getsockname(socket6FD, (struct sockaddr *)&sockaddr6, &sockaddr6len) == 0) + { + result = [[NSData alloc] initWithBytes:&sockaddr6 length:sockaddr6len]; + } + } + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +- (BOOL)isIPv4 +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return (socket4FD != SOCKET_NULL); + } + else + { + __block BOOL result = NO; + + dispatch_sync(socketQueue, ^{ + result = (socket4FD != SOCKET_NULL); + }); + + return result; + } +} + +- (BOOL)isIPv6 +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return (socket6FD != SOCKET_NULL); + } + else + { + __block BOOL result = NO; + + dispatch_sync(socketQueue, ^{ + result = (socket6FD != SOCKET_NULL); + }); + + return result; + } +} + +- (BOOL)isSecure +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return (flags & kSocketSecure) ? YES : NO; + } + else + { + __block BOOL result; + + dispatch_sync(socketQueue, ^{ + result = (flags & kSocketSecure) ? YES : NO; + }); + + return result; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Utilities +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Finds the address of an interface description. + * An inteface description may be an interface name (en0, en1, lo0) or corresponding IP (192.168.4.34). + * + * The interface description may optionally contain a port number at the end, separated by a colon. + * If a non-zero port parameter is provided, any port number in the interface description is ignored. + * + * The returned value is a 'struct sockaddr' wrapped in an NSMutableData object. +**/ +- (void)getInterfaceAddress4:(NSMutableData **)interfaceAddr4Ptr + address6:(NSMutableData **)interfaceAddr6Ptr + fromDescription:(NSString *)interfaceDescription + port:(uint16_t)port +{ + NSMutableData *addr4 = nil; + NSMutableData *addr6 = nil; + + NSString *interface = nil; + + NSArray *components = [interfaceDescription componentsSeparatedByString:@":"]; + if ([components count] > 0) + { + NSString *temp = [components objectAtIndex:0]; + if ([temp length] > 0) + { + interface = temp; + } + } + if ([components count] > 1 && port == 0) + { + long portL = strtol([[components objectAtIndex:1] UTF8String], NULL, 10); + + if (portL > 0 && portL <= UINT16_MAX) + { + port = (uint16_t)portL; + } + } + + if (interface == nil) + { + // ANY address + + struct sockaddr_in sockaddr4; + memset(&sockaddr4, 0, sizeof(sockaddr4)); + + sockaddr4.sin_len = sizeof(sockaddr4); + sockaddr4.sin_family = AF_INET; + sockaddr4.sin_port = htons(port); + sockaddr4.sin_addr.s_addr = htonl(INADDR_ANY); + + struct sockaddr_in6 sockaddr6; + memset(&sockaddr6, 0, sizeof(sockaddr6)); + + sockaddr6.sin6_len = sizeof(sockaddr6); + sockaddr6.sin6_family = AF_INET6; + sockaddr6.sin6_port = htons(port); + sockaddr6.sin6_addr = in6addr_any; + + addr4 = [NSMutableData dataWithBytes:&sockaddr4 length:sizeof(sockaddr4)]; + addr6 = [NSMutableData dataWithBytes:&sockaddr6 length:sizeof(sockaddr6)]; + } + else if ([interface isEqualToString:@"localhost"] || [interface isEqualToString:@"loopback"]) + { + // LOOPBACK address + + struct sockaddr_in sockaddr4; + memset(&sockaddr4, 0, sizeof(sockaddr4)); + + sockaddr4.sin_len = sizeof(sockaddr4); + sockaddr4.sin_family = AF_INET; + sockaddr4.sin_port = htons(port); + sockaddr4.sin_addr.s_addr = htonl(INADDR_LOOPBACK); + + struct sockaddr_in6 sockaddr6; + memset(&sockaddr6, 0, sizeof(sockaddr6)); + + sockaddr6.sin6_len = sizeof(sockaddr6); + sockaddr6.sin6_family = AF_INET6; + sockaddr6.sin6_port = htons(port); + sockaddr6.sin6_addr = in6addr_loopback; + + addr4 = [NSMutableData dataWithBytes:&sockaddr4 length:sizeof(sockaddr4)]; + addr6 = [NSMutableData dataWithBytes:&sockaddr6 length:sizeof(sockaddr6)]; + } + else + { + const char *iface = [interface UTF8String]; + + struct ifaddrs *addrs; + const struct ifaddrs *cursor; + + if ((getifaddrs(&addrs) == 0)) + { + cursor = addrs; + while (cursor != NULL) + { + if ((addr4 == nil) && (cursor->ifa_addr->sa_family == AF_INET)) + { + // IPv4 + + struct sockaddr_in nativeAddr4; + memcpy(&nativeAddr4, cursor->ifa_addr, sizeof(nativeAddr4)); + + if (strcmp(cursor->ifa_name, iface) == 0) + { + // Name match + + nativeAddr4.sin_port = htons(port); + + addr4 = [NSMutableData dataWithBytes:&nativeAddr4 length:sizeof(nativeAddr4)]; + } + else + { + char ip[INET_ADDRSTRLEN]; + + const char *conversion = inet_ntop(AF_INET, &nativeAddr4.sin_addr, ip, sizeof(ip)); + + if ((conversion != NULL) && (strcmp(ip, iface) == 0)) + { + // IP match + + nativeAddr4.sin_port = htons(port); + + addr4 = [NSMutableData dataWithBytes:&nativeAddr4 length:sizeof(nativeAddr4)]; + } + } + } + else if ((addr6 == nil) && (cursor->ifa_addr->sa_family == AF_INET6)) + { + // IPv6 + + struct sockaddr_in6 nativeAddr6; + memcpy(&nativeAddr6, cursor->ifa_addr, sizeof(nativeAddr6)); + + if (strcmp(cursor->ifa_name, iface) == 0) + { + // Name match + + nativeAddr6.sin6_port = htons(port); + + addr6 = [NSMutableData dataWithBytes:&nativeAddr6 length:sizeof(nativeAddr6)]; + } + else + { + char ip[INET6_ADDRSTRLEN]; + + const char *conversion = inet_ntop(AF_INET6, &nativeAddr6.sin6_addr, ip, sizeof(ip)); + + if ((conversion != NULL) && (strcmp(ip, iface) == 0)) + { + // IP match + + nativeAddr6.sin6_port = htons(port); + + addr6 = [NSMutableData dataWithBytes:&nativeAddr6 length:sizeof(nativeAddr6)]; + } + } + } + + cursor = cursor->ifa_next; + } + + freeifaddrs(addrs); + } + } + + if (interfaceAddr4Ptr) *interfaceAddr4Ptr = addr4; + if (interfaceAddr6Ptr) *interfaceAddr6Ptr = addr6; +} + +- (void)setupReadAndWriteSourcesForNewlyConnectedSocket:(int)socketFD +{ + readSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, socketFD, 0, socketQueue); + writeSource = dispatch_source_create(DISPATCH_SOURCE_TYPE_WRITE, socketFD, 0, socketQueue); + + // Setup event handlers + + dispatch_source_set_event_handler(readSource, ^{ @autoreleasepool { + + LogVerbose(@"readEventBlock"); + + socketFDBytesAvailable = dispatch_source_get_data(readSource); + LogVerbose(@"socketFDBytesAvailable: %lu", socketFDBytesAvailable); + + if (socketFDBytesAvailable > 0) + [self doReadData]; + else + [self doReadEOF]; + }}); + + dispatch_source_set_event_handler(writeSource, ^{ @autoreleasepool { + + LogVerbose(@"writeEventBlock"); + + flags |= kSocketCanAcceptBytes; + [self doWriteData]; + }}); + + // Setup cancel handlers + + __block int socketFDRefCount = 2; + + #if NEEDS_DISPATCH_RETAIN_RELEASE + dispatch_source_t theReadSource = readSource; + dispatch_source_t theWriteSource = writeSource; + #endif + + dispatch_source_set_cancel_handler(readSource, ^{ + + LogVerbose(@"readCancelBlock"); + + #if NEEDS_DISPATCH_RETAIN_RELEASE + LogVerbose(@"dispatch_release(readSource)"); + dispatch_release(theReadSource); + #endif + + if (--socketFDRefCount == 0) + { + LogVerbose(@"close(socketFD)"); + close(socketFD); + } + }); + + dispatch_source_set_cancel_handler(writeSource, ^{ + + LogVerbose(@"writeCancelBlock"); + + #if NEEDS_DISPATCH_RETAIN_RELEASE + LogVerbose(@"dispatch_release(writeSource)"); + dispatch_release(theWriteSource); + #endif + + if (--socketFDRefCount == 0) + { + LogVerbose(@"close(socketFD)"); + close(socketFD); + } + }); + + // We will not be able to read until data arrives. + // But we should be able to write immediately. + + socketFDBytesAvailable = 0; + flags &= ~kReadSourceSuspended; + + LogVerbose(@"dispatch_resume(readSource)"); + dispatch_resume(readSource); + + flags |= kSocketCanAcceptBytes; + flags |= kWriteSourceSuspended; +} + +- (BOOL)usingCFStreamForTLS +{ + #if TARGET_OS_IPHONE + { + if ((flags & kSocketSecure) && (flags & kUsingCFStreamForTLS)) + { + // Due to the fact that Apple doesn't give us the full power of SecureTransport on iOS, + // we are relegated to using the slower, less powerful, and RunLoop based CFStream API. :( Boo! + // + // Thus we're not able to use the GCD read/write sources in this particular scenario. + + return YES; + } + } + #endif + + return NO; +} + +- (BOOL)usingSecureTransportForTLS +{ + #if TARGET_OS_IPHONE + { + return ![self usingCFStreamForTLS]; + } + #endif + + return YES; +} + +- (void)suspendReadSource +{ + if (!(flags & kReadSourceSuspended)) + { + LogVerbose(@"dispatch_suspend(readSource)"); + + dispatch_suspend(readSource); + flags |= kReadSourceSuspended; + } +} + +- (void)resumeReadSource +{ + if (flags & kReadSourceSuspended) + { + LogVerbose(@"dispatch_resume(readSource)"); + + dispatch_resume(readSource); + flags &= ~kReadSourceSuspended; + } +} + +- (void)suspendWriteSource +{ + if (!(flags & kWriteSourceSuspended)) + { + LogVerbose(@"dispatch_suspend(writeSource)"); + + dispatch_suspend(writeSource); + flags |= kWriteSourceSuspended; + } +} + +- (void)resumeWriteSource +{ + if (flags & kWriteSourceSuspended) + { + LogVerbose(@"dispatch_resume(writeSource)"); + + dispatch_resume(writeSource); + flags &= ~kWriteSourceSuspended; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Reading +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)readDataWithTimeout:(NSTimeInterval)timeout tag:(long)tag +{ + [self readDataWithTimeout:timeout buffer:nil bufferOffset:0 maxLength:0 tag:tag]; +} + +- (void)readDataWithTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + tag:(long)tag +{ + [self readDataWithTimeout:timeout buffer:buffer bufferOffset:offset maxLength:0 tag:tag]; +} + +- (void)readDataWithTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + maxLength:(NSUInteger)length + tag:(long)tag +{ + if (offset > [buffer length]) { + LogWarn(@"Cannot read: offset > [buffer length]"); + return; + } + + GCDAsyncReadPacket *packet = [[GCDAsyncReadPacket alloc] initWithData:buffer + startOffset:offset + maxLength:length + timeout:timeout + readLength:0 + terminator:nil + tag:tag]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + LogTrace(); + + if ((flags & kSocketStarted) && !(flags & kForbidReadsWrites)) + { + [readQueue addObject:packet]; + [self maybeDequeueRead]; + } + }}); + + // Do not rely on the block being run in order to release the packet, + // as the queue might get released without the block completing. +} + +- (void)readDataToLength:(NSUInteger)length withTimeout:(NSTimeInterval)timeout tag:(long)tag +{ + [self readDataToLength:length withTimeout:timeout buffer:nil bufferOffset:0 tag:tag]; +} + +- (void)readDataToLength:(NSUInteger)length + withTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + tag:(long)tag +{ + if (length == 0) { + LogWarn(@"Cannot read: length == 0"); + return; + } + if (offset > [buffer length]) { + LogWarn(@"Cannot read: offset > [buffer length]"); + return; + } + + GCDAsyncReadPacket *packet = [[GCDAsyncReadPacket alloc] initWithData:buffer + startOffset:offset + maxLength:0 + timeout:timeout + readLength:length + terminator:nil + tag:tag]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + LogTrace(); + + if ((flags & kSocketStarted) && !(flags & kForbidReadsWrites)) + { + [readQueue addObject:packet]; + [self maybeDequeueRead]; + } + }}); + + // Do not rely on the block being run in order to release the packet, + // as the queue might get released without the block completing. +} + +- (void)readDataToData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag +{ + [self readDataToData:data withTimeout:timeout buffer:nil bufferOffset:0 maxLength:0 tag:tag]; +} + +- (void)readDataToData:(NSData *)data + withTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + tag:(long)tag +{ + [self readDataToData:data withTimeout:timeout buffer:buffer bufferOffset:offset maxLength:0 tag:tag]; +} + +- (void)readDataToData:(NSData *)data withTimeout:(NSTimeInterval)timeout maxLength:(NSUInteger)length tag:(long)tag +{ + [self readDataToData:data withTimeout:timeout buffer:nil bufferOffset:0 maxLength:length tag:tag]; +} + +- (void)readDataToData:(NSData *)data + withTimeout:(NSTimeInterval)timeout + buffer:(NSMutableData *)buffer + bufferOffset:(NSUInteger)offset + maxLength:(NSUInteger)maxLength + tag:(long)tag +{ + if ([data length] == 0) { + LogWarn(@"Cannot read: [data length] == 0"); + return; + } + if (offset > [buffer length]) { + LogWarn(@"Cannot read: offset > [buffer length]"); + return; + } + if (maxLength > 0 && maxLength < [data length]) { + LogWarn(@"Cannot read: maxLength > 0 && maxLength < [data length]"); + return; + } + + GCDAsyncReadPacket *packet = [[GCDAsyncReadPacket alloc] initWithData:buffer + startOffset:offset + maxLength:maxLength + timeout:timeout + readLength:0 + terminator:data + tag:tag]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + LogTrace(); + + if ((flags & kSocketStarted) && !(flags & kForbidReadsWrites)) + { + [readQueue addObject:packet]; + [self maybeDequeueRead]; + } + }}); + + // Do not rely on the block being run in order to release the packet, + // as the queue might get released without the block completing. +} + +- (float)progressOfReadReturningTag:(long *)tagPtr bytesDone:(NSUInteger *)donePtr total:(NSUInteger *)totalPtr +{ + __block float result = 0.0F; + + dispatch_block_t block = ^{ + + if (!currentRead || ![currentRead isKindOfClass:[GCDAsyncReadPacket class]]) + { + // We're not reading anything right now. + + if (tagPtr != NULL) *tagPtr = 0; + if (donePtr != NULL) *donePtr = 0; + if (totalPtr != NULL) *totalPtr = 0; + + result = NAN; + } + else + { + // It's only possible to know the progress of our read if we're reading to a certain length. + // If we're reading to data, we of course have no idea when the data will arrive. + // If we're reading to timeout, then we have no idea when the next chunk of data will arrive. + + NSUInteger done = currentRead->bytesDone; + NSUInteger total = currentRead->readLength; + + if (tagPtr != NULL) *tagPtr = currentRead->tag; + if (donePtr != NULL) *donePtr = done; + if (totalPtr != NULL) *totalPtr = total; + + if (total > 0) + result = (float)done / (float)total; + else + result = 1.0F; + } + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +/** + * This method starts a new read, if needed. + * + * It is called when: + * - a user requests a read + * - after a read request has finished (to handle the next request) + * - immediately after the socket opens to handle any pending requests + * + * This method also handles auto-disconnect post read/write completion. +**/ +- (void)maybeDequeueRead +{ + LogTrace(); + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + // If we're not currently processing a read AND we have an available read stream + if ((currentRead == nil) && (flags & kConnected)) + { + if ([readQueue count] > 0) + { + // Dequeue the next object in the write queue + currentRead = [readQueue objectAtIndex:0]; + [readQueue removeObjectAtIndex:0]; + + + if ([currentRead isKindOfClass:[GCDAsyncSpecialPacket class]]) + { + LogVerbose(@"Dequeued GCDAsyncSpecialPacket"); + + // Attempt to start TLS + flags |= kStartingReadTLS; + + // This method won't do anything unless both kStartingReadTLS and kStartingWriteTLS are set + [self maybeStartTLS]; + } + else + { + LogVerbose(@"Dequeued GCDAsyncReadPacket"); + + // Setup read timer (if needed) + [self setupReadTimerWithTimeout:currentRead->timeout]; + + // Immediately read, if possible + [self doReadData]; + } + } + else if (flags & kDisconnectAfterReads) + { + if (flags & kDisconnectAfterWrites) + { + if (([writeQueue count] == 0) && (currentWrite == nil)) + { + [self closeWithError:nil]; + } + } + else + { + [self closeWithError:nil]; + } + } + else if (flags & kSocketSecure) + { + [self flushSSLBuffers]; + + // Edge case: + // + // We just drained all data from the ssl buffers, + // and all known data from the socket (socketFDBytesAvailable). + // + // If we didn't get any data from this process, + // then we may have reached the end of the TCP stream. + // + // Be sure callbacks are enabled so we're notified about a disconnection. + + if ([preBuffer availableBytes] == 0) + { + if ([self usingCFStreamForTLS]) { + // Callbacks never disabled + } + else { + [self resumeReadSource]; + } + } + } + } +} + +- (void)flushSSLBuffers +{ + LogTrace(); + + NSAssert((flags & kSocketSecure), @"Cannot flush ssl buffers on non-secure socket"); + + if ([preBuffer availableBytes] > 0) + { + // Only flush the ssl buffers if the prebuffer is empty. + // This is to avoid growing the prebuffer inifinitely large. + + return; + } + +#if TARGET_OS_IPHONE + + if ([self usingCFStreamForTLS]) + { + if ((flags & kSecureSocketHasBytesAvailable) && CFReadStreamHasBytesAvailable(readStream)) + { + LogVerbose(@"%@ - Flushing ssl buffers into prebuffer...", THIS_METHOD); + + CFIndex defaultBytesToRead = (1024 * 4); + + [preBuffer ensureCapacityForWrite:defaultBytesToRead]; + + uint8_t *buffer = [preBuffer writeBuffer]; + + CFIndex result = CFReadStreamRead(readStream, buffer, defaultBytesToRead); + LogVerbose(@"%@ - CFReadStreamRead(): result = %i", THIS_METHOD, (int)result); + + if (result > 0) + { + [preBuffer didWrite:result]; + } + + flags &= ~kSecureSocketHasBytesAvailable; + } + + return; + } + +#endif +#if SECURE_TRANSPORT_MAYBE_AVAILABLE + + __block NSUInteger estimatedBytesAvailable = 0; + + dispatch_block_t updateEstimatedBytesAvailable = ^{ + + // Figure out if there is any data available to be read + // + // socketFDBytesAvailable <- Number of encrypted bytes we haven't read from the bsd socket + // [sslPreBuffer availableBytes] <- Number of encrypted bytes we've buffered from bsd socket + // sslInternalBufSize <- Number of decrypted bytes SecureTransport has buffered + // + // We call the variable "estimated" because we don't know how many decrypted bytes we'll get + // from the encrypted bytes in the sslPreBuffer. + // However, we do know this is an upper bound on the estimation. + + estimatedBytesAvailable = socketFDBytesAvailable + [sslPreBuffer availableBytes]; + + size_t sslInternalBufSize = 0; + SSLGetBufferedReadSize(sslContext, &sslInternalBufSize); + + estimatedBytesAvailable += sslInternalBufSize; + }; + + updateEstimatedBytesAvailable(); + + if (estimatedBytesAvailable > 0) + { + LogVerbose(@"%@ - Flushing ssl buffers into prebuffer...", THIS_METHOD); + + BOOL done = NO; + do + { + LogVerbose(@"%@ - estimatedBytesAvailable = %lu", THIS_METHOD, (unsigned long)estimatedBytesAvailable); + + // Make sure there's enough room in the prebuffer + + [preBuffer ensureCapacityForWrite:estimatedBytesAvailable]; + + // Read data into prebuffer + + uint8_t *buffer = [preBuffer writeBuffer]; + size_t bytesRead = 0; + + OSStatus result = SSLRead(sslContext, buffer, (size_t)estimatedBytesAvailable, &bytesRead); + LogVerbose(@"%@ - read from secure socket = %u", THIS_METHOD, (unsigned)bytesRead); + + if (bytesRead > 0) + { + [preBuffer didWrite:bytesRead]; + } + + LogVerbose(@"%@ - prebuffer.length = %zu", THIS_METHOD, [preBuffer availableBytes]); + + if (result != noErr) + { + done = YES; + } + else + { + updateEstimatedBytesAvailable(); + } + + } while (!done && estimatedBytesAvailable > 0); + } + +#endif +} + +- (void)doReadData +{ + LogTrace(); + + // This method is called on the socketQueue. + // It might be called directly, or via the readSource when data is available to be read. + + if ((currentRead == nil) || (flags & kReadsPaused)) + { + LogVerbose(@"No currentRead or kReadsPaused"); + + // Unable to read at this time + + if (flags & kSocketSecure) + { + // Here's the situation: + // + // We have an established secure connection. + // There may not be a currentRead, but there might be encrypted data sitting around for us. + // When the user does get around to issuing a read, that encrypted data will need to be decrypted. + // + // So why make the user wait? + // We might as well get a head start on decrypting some data now. + // + // The other reason we do this has to do with detecting a socket disconnection. + // The SSL/TLS protocol has it's own disconnection handshake. + // So when a secure socket is closed, a "goodbye" packet comes across the wire. + // We want to make sure we read the "goodbye" packet so we can properly detect the TCP disconnection. + + [self flushSSLBuffers]; + } + + if ([self usingCFStreamForTLS]) + { + // CFReadStream only fires once when there is available data. + // It won't fire again until we've invoked CFReadStreamRead. + } + else + { + // If the readSource is firing, we need to pause it + // or else it will continue to fire over and over again. + // + // If the readSource is not firing, + // we want it to continue monitoring the socket. + + if (socketFDBytesAvailable > 0) + { + [self suspendReadSource]; + } + } + return; + } + + BOOL hasBytesAvailable = NO; + unsigned long estimatedBytesAvailable = 0; + + if ([self usingCFStreamForTLS]) + { + #if TARGET_OS_IPHONE + + // Relegated to using CFStream... :( Boo! Give us a full SecureTransport stack Apple! + + estimatedBytesAvailable = 0; + if ((flags & kSecureSocketHasBytesAvailable) && CFReadStreamHasBytesAvailable(readStream)) + hasBytesAvailable = YES; + else + hasBytesAvailable = NO; + + #endif + } + else + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + + estimatedBytesAvailable = socketFDBytesAvailable; + + if (flags & kSocketSecure) + { + // There are 2 buffers to be aware of here. + // + // We are using SecureTransport, a TLS/SSL security layer which sits atop TCP. + // We issue a read to the SecureTranport API, which in turn issues a read to our SSLReadFunction. + // Our SSLReadFunction then reads from the BSD socket and returns the encrypted data to SecureTransport. + // SecureTransport then decrypts the data, and finally returns the decrypted data back to us. + // + // The first buffer is one we create. + // SecureTransport often requests small amounts of data. + // This has to do with the encypted packets that are coming across the TCP stream. + // But it's non-optimal to do a bunch of small reads from the BSD socket. + // So our SSLReadFunction reads all available data from the socket (optimizing the sys call) + // and may store excess in the sslPreBuffer. + + estimatedBytesAvailable += [sslPreBuffer availableBytes]; + + // The second buffer is within SecureTransport. + // As mentioned earlier, there are encrypted packets coming across the TCP stream. + // SecureTransport needs the entire packet to decrypt it. + // But if the entire packet produces X bytes of decrypted data, + // and we only asked SecureTransport for X/2 bytes of data, + // it must store the extra X/2 bytes of decrypted data for the next read. + // + // The SSLGetBufferedReadSize function will tell us the size of this internal buffer. + // From the documentation: + // + // "This function does not block or cause any low-level read operations to occur." + + size_t sslInternalBufSize = 0; + SSLGetBufferedReadSize(sslContext, &sslInternalBufSize); + + estimatedBytesAvailable += sslInternalBufSize; + } + + hasBytesAvailable = (estimatedBytesAvailable > 0); + + #endif + } + + if ((hasBytesAvailable == NO) && ([preBuffer availableBytes] == 0)) + { + LogVerbose(@"No data available to read..."); + + // No data available to read. + + if (![self usingCFStreamForTLS]) + { + // Need to wait for readSource to fire and notify us of + // available data in the socket's internal read buffer. + + [self resumeReadSource]; + } + return; + } + + if (flags & kStartingReadTLS) + { + LogVerbose(@"Waiting for SSL/TLS handshake to complete"); + + // The readQueue is waiting for SSL/TLS handshake to complete. + + if (flags & kStartingWriteTLS) + { + if ([self usingSecureTransportForTLS]) + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + + // We are in the process of a SSL Handshake. + // We were waiting for incoming data which has just arrived. + + [self ssl_continueSSLHandshake]; + + #endif + } + } + else + { + // We are still waiting for the writeQueue to drain and start the SSL/TLS process. + // We now know data is available to read. + + if (![self usingCFStreamForTLS]) + { + // Suspend the read source or else it will continue to fire nonstop. + + [self suspendReadSource]; + } + } + + return; + } + + BOOL done = NO; // Completed read operation + NSError *error = nil; // Error occured + + NSUInteger totalBytesReadForCurrentRead = 0; + + // + // STEP 1 - READ FROM PREBUFFER + // + + if ([preBuffer availableBytes] > 0) + { + // There are 3 types of read packets: + // + // 1) Read all available data. + // 2) Read a specific length of data. + // 3) Read up to a particular terminator. + + NSUInteger bytesToCopy; + + if (currentRead->term != nil) + { + // Read type #3 - read up to a terminator + + bytesToCopy = [currentRead readLengthForTermWithPreBuffer:preBuffer found:&done]; + } + else + { + // Read type #1 or #2 + + bytesToCopy = [currentRead readLengthForNonTermWithHint:[preBuffer availableBytes]]; + } + + // Make sure we have enough room in the buffer for our read. + + [currentRead ensureCapacityForAdditionalDataOfLength:bytesToCopy]; + + // Copy bytes from prebuffer into packet buffer + + uint8_t *buffer = (uint8_t *)[currentRead->buffer mutableBytes] + currentRead->startOffset + + currentRead->bytesDone; + + memcpy(buffer, [preBuffer readBuffer], bytesToCopy); + + // Remove the copied bytes from the preBuffer + [preBuffer didRead:bytesToCopy]; + + LogVerbose(@"copied(%lu) preBufferLength(%zu)", (unsigned long)bytesToCopy, [preBuffer availableBytes]); + + // Update totals + + currentRead->bytesDone += bytesToCopy; + totalBytesReadForCurrentRead += bytesToCopy; + + // Check to see if the read operation is done + + if (currentRead->readLength > 0) + { + // Read type #2 - read a specific length of data + + done = (currentRead->bytesDone == currentRead->readLength); + } + else if (currentRead->term != nil) + { + // Read type #3 - read up to a terminator + + // Our 'done' variable was updated via the readLengthForTermWithPreBuffer:found: method + + if (!done && currentRead->maxLength > 0) + { + // We're not done and there's a set maxLength. + // Have we reached that maxLength yet? + + if (currentRead->bytesDone >= currentRead->maxLength) + { + error = [self readMaxedOutError]; + } + } + } + else + { + // Read type #1 - read all available data + // + // We're done as soon as + // - we've read all available data (in prebuffer and socket) + // - we've read the maxLength of read packet. + + done = ((currentRead->maxLength > 0) && (currentRead->bytesDone == currentRead->maxLength)); + } + + } + + // + // STEP 2 - READ FROM SOCKET + // + + BOOL socketEOF = (flags & kSocketHasReadEOF) ? YES : NO; // Nothing more to via socket (end of file) + BOOL waiting = !done && !error && !socketEOF && !hasBytesAvailable; // Ran out of data, waiting for more + + if (!done && !error && !socketEOF && !waiting && hasBytesAvailable) + { + NSAssert(([preBuffer availableBytes] == 0), @"Invalid logic"); + + // There are 3 types of read packets: + // + // 1) Read all available data. + // 2) Read a specific length of data. + // 3) Read up to a particular terminator. + + BOOL readIntoPreBuffer = NO; + NSUInteger bytesToRead; + + if ([self usingCFStreamForTLS]) + { + // Since Apple hasn't made the full power of SecureTransport available on iOS, + // we are relegated to using the slower, less powerful, RunLoop based CFStream API. + // + // This API doesn't tell us how much data is available on the socket to be read. + // If we had that information we could optimize our memory allocations, and sys calls. + // + // But alas... + // So we do it old school, and just read as much data from the socket as we can. + + NSUInteger defaultReadLength = (1024 * 32); + + bytesToRead = [currentRead optimalReadLengthWithDefault:defaultReadLength + shouldPreBuffer:&readIntoPreBuffer]; + } + else + { + if (currentRead->term != nil) + { + // Read type #3 - read up to a terminator + + bytesToRead = [currentRead readLengthForTermWithHint:estimatedBytesAvailable + shouldPreBuffer:&readIntoPreBuffer]; + } + else + { + // Read type #1 or #2 + + bytesToRead = [currentRead readLengthForNonTermWithHint:estimatedBytesAvailable]; + } + } + + if (bytesToRead > SIZE_MAX) // NSUInteger may be bigger than size_t (read param 3) + { + bytesToRead = SIZE_MAX; + } + + // Make sure we have enough room in the buffer for our read. + // + // We are either reading directly into the currentRead->buffer, + // or we're reading into the temporary preBuffer. + + uint8_t *buffer; + + if (readIntoPreBuffer) + { + [preBuffer ensureCapacityForWrite:bytesToRead]; + + buffer = [preBuffer writeBuffer]; + } + else + { + [currentRead ensureCapacityForAdditionalDataOfLength:bytesToRead]; + + buffer = (uint8_t *)[currentRead->buffer mutableBytes] + currentRead->startOffset + currentRead->bytesDone; + } + + // Read data into buffer + + size_t bytesRead = 0; + + if (flags & kSocketSecure) + { + if ([self usingCFStreamForTLS]) + { + #if TARGET_OS_IPHONE + + CFIndex result = CFReadStreamRead(readStream, buffer, (CFIndex)bytesToRead); + LogVerbose(@"CFReadStreamRead(): result = %i", (int)result); + + if (result < 0) + { + error = (__bridge_transfer NSError *)CFReadStreamCopyError(readStream); + } + else if (result == 0) + { + socketEOF = YES; + } + else + { + waiting = YES; + bytesRead = (size_t)result; + } + + // We only know how many decrypted bytes were read. + // The actual number of bytes read was likely more due to the overhead of the encryption. + // So we reset our flag, and rely on the next callback to alert us of more data. + flags &= ~kSecureSocketHasBytesAvailable; + + #endif + } + else + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + + // The documentation from Apple states: + // + // "a read operation might return errSSLWouldBlock, + // indicating that less data than requested was actually transferred" + // + // However, starting around 10.7, the function will sometimes return noErr, + // even if it didn't read as much data as requested. So we need to watch out for that. + + OSStatus result; + do + { + void *loop_buffer = buffer + bytesRead; + size_t loop_bytesToRead = (size_t)bytesToRead - bytesRead; + size_t loop_bytesRead = 0; + + result = SSLRead(sslContext, loop_buffer, loop_bytesToRead, &loop_bytesRead); + LogVerbose(@"read from secure socket = %u", (unsigned)bytesRead); + + bytesRead += loop_bytesRead; + + } while ((result == noErr) && (bytesRead < bytesToRead)); + + + if (result != noErr) + { + if (result == errSSLWouldBlock) + waiting = YES; + else + { + if (result == errSSLClosedGraceful || result == errSSLClosedAbort) + { + // We've reached the end of the stream. + // Handle this the same way we would an EOF from the socket. + socketEOF = YES; + sslErrCode = result; + } + else + { + error = [self sslError:result]; + } + } + // It's possible that bytesRead > 0, even if the result was errSSLWouldBlock. + // This happens when the SSLRead function is able to read some data, + // but not the entire amount we requested. + + if (bytesRead <= 0) + { + bytesRead = 0; + } + } + + // Do not modify socketFDBytesAvailable. + // It will be updated via the SSLReadFunction(). + + #endif + } + } + else + { + int socketFD = (socket4FD == SOCKET_NULL) ? socket6FD : socket4FD; + + ssize_t result = read(socketFD, buffer, (size_t)bytesToRead); + LogVerbose(@"read from socket = %i", (int)result); + + if (result < 0) + { + if (errno == EWOULDBLOCK) + waiting = YES; + else + error = [self errnoErrorWithReason:@"Error in read() function"]; + + socketFDBytesAvailable = 0; + } + else if (result == 0) + { + socketEOF = YES; + socketFDBytesAvailable = 0; + } + else + { + bytesRead = result; + + if (bytesRead < bytesToRead) + { + // The read returned less data than requested. + // This means socketFDBytesAvailable was a bit off due to timing, + // because we read from the socket right when the readSource event was firing. + socketFDBytesAvailable = 0; + } + else + { + if (socketFDBytesAvailable <= bytesRead) + socketFDBytesAvailable = 0; + else + socketFDBytesAvailable -= bytesRead; + } + + if (socketFDBytesAvailable == 0) + { + waiting = YES; + } + } + } + + if (bytesRead > 0) + { + // Check to see if the read operation is done + + if (currentRead->readLength > 0) + { + // Read type #2 - read a specific length of data + // + // Note: We should never be using a prebuffer when we're reading a specific length of data. + + NSAssert(readIntoPreBuffer == NO, @"Invalid logic"); + + currentRead->bytesDone += bytesRead; + totalBytesReadForCurrentRead += bytesRead; + + done = (currentRead->bytesDone == currentRead->readLength); + } + else if (currentRead->term != nil) + { + // Read type #3 - read up to a terminator + + if (readIntoPreBuffer) + { + // We just read a big chunk of data into the preBuffer + + [preBuffer didWrite:bytesRead]; + LogVerbose(@"read data into preBuffer - preBuffer.length = %zu", [preBuffer availableBytes]); + + // Search for the terminating sequence + + bytesToRead = [currentRead readLengthForTermWithPreBuffer:preBuffer found:&done]; + LogVerbose(@"copying %lu bytes from preBuffer", (unsigned long)bytesToRead); + + // Ensure there's room on the read packet's buffer + + [currentRead ensureCapacityForAdditionalDataOfLength:bytesToRead]; + + // Copy bytes from prebuffer into read buffer + + uint8_t *readBuf = (uint8_t *)[currentRead->buffer mutableBytes] + currentRead->startOffset + + currentRead->bytesDone; + + memcpy(readBuf, [preBuffer readBuffer], bytesToRead); + + // Remove the copied bytes from the prebuffer + [preBuffer didRead:bytesToRead]; + LogVerbose(@"preBuffer.length = %zu", [preBuffer availableBytes]); + + // Update totals + currentRead->bytesDone += bytesToRead; + totalBytesReadForCurrentRead += bytesToRead; + + // Our 'done' variable was updated via the readLengthForTermWithPreBuffer:found: method above + } + else + { + // We just read a big chunk of data directly into the packet's buffer. + // We need to move any overflow into the prebuffer. + + NSInteger overflow = [currentRead searchForTermAfterPreBuffering:bytesRead]; + + if (overflow == 0) + { + // Perfect match! + // Every byte we read stays in the read buffer, + // and the last byte we read was the last byte of the term. + + currentRead->bytesDone += bytesRead; + totalBytesReadForCurrentRead += bytesRead; + done = YES; + } + else if (overflow > 0) + { + // The term was found within the data that we read, + // and there are extra bytes that extend past the end of the term. + // We need to move these excess bytes out of the read packet and into the prebuffer. + + NSInteger underflow = bytesRead - overflow; + + // Copy excess data into preBuffer + + LogVerbose(@"copying %ld overflow bytes into preBuffer", (long)overflow); + [preBuffer ensureCapacityForWrite:overflow]; + + uint8_t *overflowBuffer = buffer + underflow; + memcpy([preBuffer writeBuffer], overflowBuffer, overflow); + + [preBuffer didWrite:overflow]; + LogVerbose(@"preBuffer.length = %zu", [preBuffer availableBytes]); + + // Note: The completeCurrentRead method will trim the buffer for us. + + currentRead->bytesDone += underflow; + totalBytesReadForCurrentRead += underflow; + done = YES; + } + else + { + // The term was not found within the data that we read. + + currentRead->bytesDone += bytesRead; + totalBytesReadForCurrentRead += bytesRead; + done = NO; + } + } + + if (!done && currentRead->maxLength > 0) + { + // We're not done and there's a set maxLength. + // Have we reached that maxLength yet? + + if (currentRead->bytesDone >= currentRead->maxLength) + { + error = [self readMaxedOutError]; + } + } + } + else + { + // Read type #1 - read all available data + + if (readIntoPreBuffer) + { + // We just read a chunk of data into the preBuffer + + [preBuffer didWrite:bytesRead]; + + // Now copy the data into the read packet. + // + // Recall that we didn't read directly into the packet's buffer to avoid + // over-allocating memory since we had no clue how much data was available to be read. + // + // Ensure there's room on the read packet's buffer + + [currentRead ensureCapacityForAdditionalDataOfLength:bytesRead]; + + // Copy bytes from prebuffer into read buffer + + uint8_t *readBuf = (uint8_t *)[currentRead->buffer mutableBytes] + currentRead->startOffset + + currentRead->bytesDone; + + memcpy(readBuf, [preBuffer readBuffer], bytesRead); + + // Remove the copied bytes from the prebuffer + [preBuffer didRead:bytesRead]; + + // Update totals + currentRead->bytesDone += bytesRead; + totalBytesReadForCurrentRead += bytesRead; + } + else + { + currentRead->bytesDone += bytesRead; + totalBytesReadForCurrentRead += bytesRead; + } + + done = YES; + } + + } // if (bytesRead > 0) + + } // if (!done && !error && !socketEOF && !waiting && hasBytesAvailable) + + + if (!done && currentRead->readLength == 0 && currentRead->term == nil) + { + // Read type #1 - read all available data + // + // We might arrive here if we read data from the prebuffer but not from the socket. + + done = (totalBytesReadForCurrentRead > 0); + } + + // Check to see if we're done, or if we've made progress + + if (done) + { + [self completeCurrentRead]; + + if (!error && (!socketEOF || [preBuffer availableBytes] > 0)) + { + [self maybeDequeueRead]; + } + } + else if (totalBytesReadForCurrentRead > 0) + { + // We're not done read type #2 or #3 yet, but we have read in some bytes + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:didReadPartialDataOfLength:tag:)]) + { + __strong id theDelegate = delegate; + long theReadTag = currentRead->tag; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socket:self didReadPartialDataOfLength:totalBytesReadForCurrentRead tag:theReadTag]; + }}); + } + } + + // Check for errors + + if (error) + { + [self closeWithError:error]; + } + else if (socketEOF) + { + [self doReadEOF]; + } + else if (waiting) + { + if (![self usingCFStreamForTLS]) + { + // Monitor the socket for readability (if we're not already doing so) + [self resumeReadSource]; + } + } + + // Do not add any code here without first adding return statements in the error cases above. +} + +- (void)doReadEOF +{ + LogTrace(); + + // This method may be called more than once. + // If the EOF is read while there is still data in the preBuffer, + // then this method may be called continually after invocations of doReadData to see if it's time to disconnect. + + flags |= kSocketHasReadEOF; + + if (flags & kSocketSecure) + { + // If the SSL layer has any buffered data, flush it into the preBuffer now. + + [self flushSSLBuffers]; + } + + BOOL shouldDisconnect; + NSError *error = nil; + + if ((flags & kStartingReadTLS) || (flags & kStartingWriteTLS)) + { + // We received an EOF during or prior to startTLS. + // The SSL/TLS handshake is now impossible, so this is an unrecoverable situation. + + shouldDisconnect = YES; + + if ([self usingSecureTransportForTLS]) + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + error = [self sslError:errSSLClosedAbort]; + #endif + } + } + else if (flags & kReadStreamClosed) + { + // The preBuffer has already been drained. + // The config allows half-duplex connections. + // We've previously checked the socket, and it appeared writeable. + // So we marked the read stream as closed and notified the delegate. + // + // As per the half-duplex contract, the socket will be closed when a write fails, + // or when the socket is manually closed. + + shouldDisconnect = NO; + } + else if ([preBuffer availableBytes] > 0) + { + LogVerbose(@"Socket reached EOF, but there is still data available in prebuffer"); + + // Although we won't be able to read any more data from the socket, + // there is existing data that has been prebuffered that we can read. + + shouldDisconnect = NO; + } + else if (config & kAllowHalfDuplexConnection) + { + // We just received an EOF (end of file) from the socket's read stream. + // This means the remote end of the socket (the peer we're connected to) + // has explicitly stated that it will not be sending us any more data. + // + // Query the socket to see if it is still writeable. (Perhaps the peer will continue reading data from us) + + int socketFD = (socket4FD == SOCKET_NULL) ? socket6FD : socket4FD; + + struct pollfd pfd[1]; + pfd[0].fd = socketFD; + pfd[0].events = POLLOUT; + pfd[0].revents = 0; + + poll(pfd, 1, 0); + + if (pfd[0].revents & POLLOUT) + { + // Socket appears to still be writeable + + shouldDisconnect = NO; + flags |= kReadStreamClosed; + + // Notify the delegate that we're going half-duplex + + if (delegateQueue && [delegate respondsToSelector:@selector(socketDidCloseReadStream:)]) + { + __strong id theDelegate = delegate; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socketDidCloseReadStream:self]; + }}); + } + } + else + { + shouldDisconnect = YES; + } + } + else + { + shouldDisconnect = YES; + } + + + if (shouldDisconnect) + { + if (error == nil) + { + if ([self usingSecureTransportForTLS]) + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + if (sslErrCode != noErr && sslErrCode != errSSLClosedGraceful) + { + error = [self sslError:sslErrCode]; + } + else + { + error = [self connectionClosedError]; + } + #endif + } + else + { + error = [self connectionClosedError]; + } + } + [self closeWithError:error]; + } + else + { + if (![self usingCFStreamForTLS]) + { + // Suspend the read source (if needed) + + [self suspendReadSource]; + } + } +} + +- (void)completeCurrentRead +{ + LogTrace(); + + NSAssert(currentRead, @"Trying to complete current read when there is no current read."); + + + NSData *result; + + if (currentRead->bufferOwner) + { + // We created the buffer on behalf of the user. + // Trim our buffer to be the proper size. + [currentRead->buffer setLength:currentRead->bytesDone]; + + result = currentRead->buffer; + } + else + { + // We did NOT create the buffer. + // The buffer is owned by the caller. + // Only trim the buffer if we had to increase its size. + + if ([currentRead->buffer length] > currentRead->originalBufferLength) + { + NSUInteger readSize = currentRead->startOffset + currentRead->bytesDone; + NSUInteger origSize = currentRead->originalBufferLength; + + NSUInteger buffSize = MAX(readSize, origSize); + + [currentRead->buffer setLength:buffSize]; + } + + uint8_t *buffer = (uint8_t *)[currentRead->buffer mutableBytes] + currentRead->startOffset; + + result = [NSData dataWithBytesNoCopy:buffer length:currentRead->bytesDone freeWhenDone:NO]; + } + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:didReadData:withTag:)]) + { + __strong id theDelegate = delegate; + GCDAsyncReadPacket *theRead = currentRead; // Ensure currentRead retained since result may not own buffer + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socket:self didReadData:result withTag:theRead->tag]; + }}); + } + + [self endCurrentRead]; +} + +- (void)endCurrentRead +{ + if (readTimer) + { + dispatch_source_cancel(readTimer); + readTimer = NULL; + } + + currentRead = nil; +} + +- (void)setupReadTimerWithTimeout:(NSTimeInterval)timeout +{ + if (timeout >= 0.0) + { + readTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, socketQueue); + + dispatch_source_set_event_handler(readTimer, ^{ @autoreleasepool { + + [self doReadTimeout]; + }}); + + #if NEEDS_DISPATCH_RETAIN_RELEASE + dispatch_source_t theReadTimer = readTimer; + dispatch_source_set_cancel_handler(readTimer, ^{ + LogVerbose(@"dispatch_release(readTimer)"); + dispatch_release(theReadTimer); + }); + #endif + + dispatch_time_t tt = dispatch_time(DISPATCH_TIME_NOW, (timeout * NSEC_PER_SEC)); + + dispatch_source_set_timer(readTimer, tt, DISPATCH_TIME_FOREVER, 0); + dispatch_resume(readTimer); + } +} + +- (void)doReadTimeout +{ + // This is a little bit tricky. + // Ideally we'd like to synchronously query the delegate about a timeout extension. + // But if we do so synchronously we risk a possible deadlock. + // So instead we have to do so asynchronously, and callback to ourselves from within the delegate block. + + flags |= kReadsPaused; + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:shouldTimeoutReadWithTag:elapsed:bytesDone:)]) + { + __strong id theDelegate = delegate; + GCDAsyncReadPacket *theRead = currentRead; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + NSTimeInterval timeoutExtension = 0.0; + + timeoutExtension = [theDelegate socket:self shouldTimeoutReadWithTag:theRead->tag + elapsed:theRead->timeout + bytesDone:theRead->bytesDone]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + [self doReadTimeoutWithExtension:timeoutExtension]; + }}); + }}); + } + else + { + [self doReadTimeoutWithExtension:0.0]; + } +} + +- (void)doReadTimeoutWithExtension:(NSTimeInterval)timeoutExtension +{ + if (currentRead) + { + if (timeoutExtension > 0.0) + { + currentRead->timeout += timeoutExtension; + + // Reschedule the timer + dispatch_time_t tt = dispatch_time(DISPATCH_TIME_NOW, (timeoutExtension * NSEC_PER_SEC)); + dispatch_source_set_timer(readTimer, tt, DISPATCH_TIME_FOREVER, 0); + + // Unpause reads, and continue + flags &= ~kReadsPaused; + [self doReadData]; + } + else + { + LogVerbose(@"ReadTimeout"); + + [self closeWithError:[self readTimeoutError]]; + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Writing +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)writeData:(NSData *)data withTimeout:(NSTimeInterval)timeout tag:(long)tag +{ + if ([data length] == 0) return; + + GCDAsyncWritePacket *packet = [[GCDAsyncWritePacket alloc] initWithData:data timeout:timeout tag:tag]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + LogTrace(); + + if ((flags & kSocketStarted) && !(flags & kForbidReadsWrites)) + { + [writeQueue addObject:packet]; + [self maybeDequeueWrite]; + } + }}); + + // Do not rely on the block being run in order to release the packet, + // as the queue might get released without the block completing. +} + +- (float)progressOfWriteReturningTag:(long *)tagPtr bytesDone:(NSUInteger *)donePtr total:(NSUInteger *)totalPtr +{ + __block float result = 0.0F; + + dispatch_block_t block = ^{ + + if (!currentWrite || ![currentWrite isKindOfClass:[GCDAsyncWritePacket class]]) + { + // We're not writing anything right now. + + if (tagPtr != NULL) *tagPtr = 0; + if (donePtr != NULL) *donePtr = 0; + if (totalPtr != NULL) *totalPtr = 0; + + result = NAN; + } + else + { + NSUInteger done = currentWrite->bytesDone; + NSUInteger total = [currentWrite->buffer length]; + + if (tagPtr != NULL) *tagPtr = currentWrite->tag; + if (donePtr != NULL) *donePtr = done; + if (totalPtr != NULL) *totalPtr = total; + + result = (float)done / (float)total; + } + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); + + return result; +} + +/** + * Conditionally starts a new write. + * + * It is called when: + * - a user requests a write + * - after a write request has finished (to handle the next request) + * - immediately after the socket opens to handle any pending requests + * + * This method also handles auto-disconnect post read/write completion. +**/ +- (void)maybeDequeueWrite +{ + LogTrace(); + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + + // If we're not currently processing a write AND we have an available write stream + if ((currentWrite == nil) && (flags & kConnected)) + { + if ([writeQueue count] > 0) + { + // Dequeue the next object in the write queue + currentWrite = [writeQueue objectAtIndex:0]; + [writeQueue removeObjectAtIndex:0]; + + + if ([currentWrite isKindOfClass:[GCDAsyncSpecialPacket class]]) + { + LogVerbose(@"Dequeued GCDAsyncSpecialPacket"); + + // Attempt to start TLS + flags |= kStartingWriteTLS; + + // This method won't do anything unless both kStartingReadTLS and kStartingWriteTLS are set + [self maybeStartTLS]; + } + else + { + LogVerbose(@"Dequeued GCDAsyncWritePacket"); + + // Setup write timer (if needed) + [self setupWriteTimerWithTimeout:currentWrite->timeout]; + + // Immediately write, if possible + [self doWriteData]; + } + } + else if (flags & kDisconnectAfterWrites) + { + if (flags & kDisconnectAfterReads) + { + if (([readQueue count] == 0) && (currentRead == nil)) + { + [self closeWithError:nil]; + } + } + else + { + [self closeWithError:nil]; + } + } + } +} + +- (void)doWriteData +{ + LogTrace(); + + // This method is called by the writeSource via the socketQueue + + if ((currentWrite == nil) || (flags & kWritesPaused)) + { + LogVerbose(@"No currentWrite or kWritesPaused"); + + // Unable to write at this time + + if ([self usingCFStreamForTLS]) + { + // CFWriteStream only fires once when there is available data. + // It won't fire again until we've invoked CFWriteStreamWrite. + } + else + { + // If the writeSource is firing, we need to pause it + // or else it will continue to fire over and over again. + + if (flags & kSocketCanAcceptBytes) + { + [self suspendWriteSource]; + } + } + return; + } + + if (!(flags & kSocketCanAcceptBytes)) + { + LogVerbose(@"No space available to write..."); + + // No space available to write. + + if (![self usingCFStreamForTLS]) + { + // Need to wait for writeSource to fire and notify us of + // available space in the socket's internal write buffer. + + [self resumeWriteSource]; + } + return; + } + + if (flags & kStartingWriteTLS) + { + LogVerbose(@"Waiting for SSL/TLS handshake to complete"); + + // The writeQueue is waiting for SSL/TLS handshake to complete. + + if (flags & kStartingReadTLS) + { + if ([self usingSecureTransportForTLS]) + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + + // We are in the process of a SSL Handshake. + // We were waiting for available space in the socket's internal OS buffer to continue writing. + + [self ssl_continueSSLHandshake]; + + #endif + } + } + else + { + // We are still waiting for the readQueue to drain and start the SSL/TLS process. + // We now know we can write to the socket. + + if (![self usingCFStreamForTLS]) + { + // Suspend the write source or else it will continue to fire nonstop. + + [self suspendWriteSource]; + } + } + + return; + } + + // Note: This method is not called if currentWrite is a GCDAsyncSpecialPacket (startTLS packet) + + BOOL waiting = NO; + NSError *error = nil; + size_t bytesWritten = 0; + + if (flags & kSocketSecure) + { + if ([self usingCFStreamForTLS]) + { + #if TARGET_OS_IPHONE + + // + // Writing data using CFStream (over internal TLS) + // + + const uint8_t *buffer = (const uint8_t *)[currentWrite->buffer bytes] + currentWrite->bytesDone; + + NSUInteger bytesToWrite = [currentWrite->buffer length] - currentWrite->bytesDone; + + if (bytesToWrite > SIZE_MAX) // NSUInteger may be bigger than size_t (write param 3) + { + bytesToWrite = SIZE_MAX; + } + + CFIndex result = CFWriteStreamWrite(writeStream, buffer, (CFIndex)bytesToWrite); + LogVerbose(@"CFWriteStreamWrite(%lu) = %li", (unsigned long)bytesToWrite, result); + + if (result < 0) + { + error = (__bridge_transfer NSError *)CFWriteStreamCopyError(writeStream); + } + else + { + bytesWritten = (size_t)result; + + // We always set waiting to true in this scenario. + // CFStream may have altered our underlying socket to non-blocking. + // Thus if we attempt to write without a callback, we may end up blocking our queue. + waiting = YES; + } + + #endif + } + else + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + + // We're going to use the SSLWrite function. + // + // OSStatus SSLWrite(SSLContextRef context, const void *data, size_t dataLength, size_t *processed) + // + // Parameters: + // context - An SSL session context reference. + // data - A pointer to the buffer of data to write. + // dataLength - The amount, in bytes, of data to write. + // processed - On return, the length, in bytes, of the data actually written. + // + // It sounds pretty straight-forward, + // but there are a few caveats you should be aware of. + // + // The SSLWrite method operates in a non-obvious (and rather annoying) manner. + // According to the documentation: + // + // Because you may configure the underlying connection to operate in a non-blocking manner, + // a write operation might return errSSLWouldBlock, indicating that less data than requested + // was actually transferred. In this case, you should repeat the call to SSLWrite until some + // other result is returned. + // + // This sounds perfect, but when our SSLWriteFunction returns errSSLWouldBlock, + // then the SSLWrite method returns (with the proper errSSLWouldBlock return value), + // but it sets processed to dataLength !! + // + // In other words, if the SSLWrite function doesn't completely write all the data we tell it to, + // then it doesn't tell us how many bytes were actually written. So, for example, if we tell it to + // write 256 bytes then it might actually write 128 bytes, but then report 0 bytes written. + // + // You might be wondering: + // If the SSLWrite function doesn't tell us how many bytes were written, + // then how in the world are we supposed to update our parameters (buffer & bytesToWrite) + // for the next time we invoke SSLWrite? + // + // The answer is that SSLWrite cached all the data we told it to write, + // and it will push out that data next time we call SSLWrite. + // If we call SSLWrite with new data, it will push out the cached data first, and then the new data. + // If we call SSLWrite with empty data, then it will simply push out the cached data. + // + // For this purpose we're going to break large writes into a series of smaller writes. + // This allows us to report progress back to the delegate. + + OSStatus result; + + BOOL hasCachedDataToWrite = (sslWriteCachedLength > 0); + BOOL hasNewDataToWrite = YES; + + if (hasCachedDataToWrite) + { + size_t processed = 0; + + result = SSLWrite(sslContext, NULL, 0, &processed); + + if (result == noErr) + { + bytesWritten = sslWriteCachedLength; + sslWriteCachedLength = 0; + + if ([currentWrite->buffer length] == (currentWrite->bytesDone + bytesWritten)) + { + // We've written all data for the current write. + hasNewDataToWrite = NO; + } + } + else + { + if (result == errSSLWouldBlock) + { + waiting = YES; + } + else + { + error = [self sslError:result]; + } + + // Can't write any new data since we were unable to write the cached data. + hasNewDataToWrite = NO; + } + } + + if (hasNewDataToWrite) + { + const uint8_t *buffer = (const uint8_t *)[currentWrite->buffer bytes] + + currentWrite->bytesDone + + bytesWritten; + + NSUInteger bytesToWrite = [currentWrite->buffer length] - currentWrite->bytesDone - bytesWritten; + + if (bytesToWrite > SIZE_MAX) // NSUInteger may be bigger than size_t (write param 3) + { + bytesToWrite = SIZE_MAX; + } + + size_t bytesRemaining = bytesToWrite; + + BOOL keepLooping = YES; + while (keepLooping) + { + size_t sslBytesToWrite = MIN(bytesRemaining, 32768); + size_t sslBytesWritten = 0; + + result = SSLWrite(sslContext, buffer, sslBytesToWrite, &sslBytesWritten); + + if (result == noErr) + { + buffer += sslBytesWritten; + bytesWritten += sslBytesWritten; + bytesRemaining -= sslBytesWritten; + + keepLooping = (bytesRemaining > 0); + } + else + { + if (result == errSSLWouldBlock) + { + waiting = YES; + sslWriteCachedLength = sslBytesToWrite; + } + else + { + error = [self sslError:result]; + } + + keepLooping = NO; + } + + } // while (keepLooping) + + } // if (hasNewDataToWrite) + + #endif + } + } + else + { + // + // Writing data directly over raw socket + // + + int socketFD = (socket4FD == SOCKET_NULL) ? socket6FD : socket4FD; + + const uint8_t *buffer = (const uint8_t *)[currentWrite->buffer bytes] + currentWrite->bytesDone; + + NSUInteger bytesToWrite = [currentWrite->buffer length] - currentWrite->bytesDone; + + if (bytesToWrite > SIZE_MAX) // NSUInteger may be bigger than size_t (write param 3) + { + bytesToWrite = SIZE_MAX; + } + + ssize_t result = write(socketFD, buffer, (size_t)bytesToWrite); + LogVerbose(@"wrote to socket = %zd", result); + + // Check results + if (result < 0) + { + if (errno == EWOULDBLOCK) + { + waiting = YES; + } + else + { + error = [self errnoErrorWithReason:@"Error in write() function"]; + } + } + else + { + bytesWritten = result; + } + } + + // We're done with our writing. + // If we explictly ran into a situation where the socket told us there was no room in the buffer, + // then we immediately resume listening for notifications. + // + // We must do this before we dequeue another write, + // as that may in turn invoke this method again. + // + // Note that if CFStream is involved, it may have maliciously put our socket in blocking mode. + + if (waiting) + { + flags &= ~kSocketCanAcceptBytes; + + if (![self usingCFStreamForTLS]) + { + [self resumeWriteSource]; + } + } + + // Check our results + + BOOL done = NO; + + if (bytesWritten > 0) + { + // Update total amount read for the current write + currentWrite->bytesDone += bytesWritten; + LogVerbose(@"currentWrite->bytesDone = %lu", (unsigned long)currentWrite->bytesDone); + + // Is packet done? + done = (currentWrite->bytesDone == [currentWrite->buffer length]); + } + + if (done) + { + [self completeCurrentWrite]; + + if (!error) + { + [self maybeDequeueWrite]; + } + } + else + { + // We were unable to finish writing the data, + // so we're waiting for another callback to notify us of available space in the lower-level output buffer. + + if (!waiting & !error) + { + // This would be the case if our write was able to accept some data, but not all of it. + + flags &= ~kSocketCanAcceptBytes; + + if (![self usingCFStreamForTLS]) + { + [self resumeWriteSource]; + } + } + + if (bytesWritten > 0) + { + // We're not done with the entire write, but we have written some bytes + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:didWritePartialDataOfLength:tag:)]) + { + __strong id theDelegate = delegate; + long theWriteTag = currentWrite->tag; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socket:self didWritePartialDataOfLength:bytesWritten tag:theWriteTag]; + }}); + } + } + } + + // Check for errors + + if (error) + { + [self closeWithError:[self errnoErrorWithReason:@"Error in write() function"]]; + } + + // Do not add any code here without first adding a return statement in the error case above. +} + +- (void)completeCurrentWrite +{ + LogTrace(); + + NSAssert(currentWrite, @"Trying to complete current write when there is no current write."); + + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:didWriteDataWithTag:)]) + { + __strong id theDelegate = delegate; + long theWriteTag = currentWrite->tag; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socket:self didWriteDataWithTag:theWriteTag]; + }}); + } + + [self endCurrentWrite]; +} + +- (void)endCurrentWrite +{ + if (writeTimer) + { + dispatch_source_cancel(writeTimer); + writeTimer = NULL; + } + + currentWrite = nil; +} + +- (void)setupWriteTimerWithTimeout:(NSTimeInterval)timeout +{ + if (timeout >= 0.0) + { + writeTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, socketQueue); + + dispatch_source_set_event_handler(writeTimer, ^{ @autoreleasepool { + + [self doWriteTimeout]; + }}); + + #if NEEDS_DISPATCH_RETAIN_RELEASE + dispatch_source_t theWriteTimer = writeTimer; + dispatch_source_set_cancel_handler(writeTimer, ^{ + LogVerbose(@"dispatch_release(writeTimer)"); + dispatch_release(theWriteTimer); + }); + #endif + + dispatch_time_t tt = dispatch_time(DISPATCH_TIME_NOW, (timeout * NSEC_PER_SEC)); + + dispatch_source_set_timer(writeTimer, tt, DISPATCH_TIME_FOREVER, 0); + dispatch_resume(writeTimer); + } +} + +- (void)doWriteTimeout +{ + // This is a little bit tricky. + // Ideally we'd like to synchronously query the delegate about a timeout extension. + // But if we do so synchronously we risk a possible deadlock. + // So instead we have to do so asynchronously, and callback to ourselves from within the delegate block. + + flags |= kWritesPaused; + + if (delegateQueue && [delegate respondsToSelector:@selector(socket:shouldTimeoutWriteWithTag:elapsed:bytesDone:)]) + { + __strong id theDelegate = delegate; + GCDAsyncWritePacket *theWrite = currentWrite; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + NSTimeInterval timeoutExtension = 0.0; + + timeoutExtension = [theDelegate socket:self shouldTimeoutWriteWithTag:theWrite->tag + elapsed:theWrite->timeout + bytesDone:theWrite->bytesDone]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + [self doWriteTimeoutWithExtension:timeoutExtension]; + }}); + }}); + } + else + { + [self doWriteTimeoutWithExtension:0.0]; + } +} + +- (void)doWriteTimeoutWithExtension:(NSTimeInterval)timeoutExtension +{ + if (currentWrite) + { + if (timeoutExtension > 0.0) + { + currentWrite->timeout += timeoutExtension; + + // Reschedule the timer + dispatch_time_t tt = dispatch_time(DISPATCH_TIME_NOW, (timeoutExtension * NSEC_PER_SEC)); + dispatch_source_set_timer(writeTimer, tt, DISPATCH_TIME_FOREVER, 0); + + // Unpause writes, and continue + flags &= ~kWritesPaused; + [self doWriteData]; + } + else + { + LogVerbose(@"WriteTimeout"); + + [self closeWithError:[self writeTimeoutError]]; + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Security +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)startTLS:(NSDictionary *)tlsSettings +{ + LogTrace(); + + if (tlsSettings == nil) + { + // Passing nil/NULL to CFReadStreamSetProperty will appear to work the same as passing an empty dictionary, + // but causes problems if we later try to fetch the remote host's certificate. + // + // To be exact, it causes the following to return NULL instead of the normal result: + // CFReadStreamCopyProperty(readStream, kCFStreamPropertySSLPeerCertificates) + // + // So we use an empty dictionary instead, which works perfectly. + + tlsSettings = [NSDictionary dictionary]; + } + + GCDAsyncSpecialPacket *packet = [[GCDAsyncSpecialPacket alloc] initWithTLSSettings:tlsSettings]; + + dispatch_async(socketQueue, ^{ @autoreleasepool { + + if ((flags & kSocketStarted) && !(flags & kQueuedTLS) && !(flags & kForbidReadsWrites)) + { + [readQueue addObject:packet]; + [writeQueue addObject:packet]; + + flags |= kQueuedTLS; + + [self maybeDequeueRead]; + [self maybeDequeueWrite]; + } + }}); + +} + +- (void)maybeStartTLS +{ + // We can't start TLS until: + // - All queued reads prior to the user calling startTLS are complete + // - All queued writes prior to the user calling startTLS are complete + // + // We'll know these conditions are met when both kStartingReadTLS and kStartingWriteTLS are set + + if ((flags & kStartingReadTLS) && (flags & kStartingWriteTLS)) + { + BOOL canUseSecureTransport = YES; + + #if TARGET_OS_IPHONE + { + GCDAsyncSpecialPacket *tlsPacket = (GCDAsyncSpecialPacket *)currentRead; + NSDictionary *tlsSettings = tlsPacket->tlsSettings; + + NSNumber *value; + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLAllowsAnyRoot]; + if (value && [value boolValue] == YES) + canUseSecureTransport = NO; + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLAllowsExpiredRoots]; + if (value && [value boolValue] == YES) + canUseSecureTransport = NO; + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLValidatesCertificateChain]; + if (value && [value boolValue] == NO) + canUseSecureTransport = NO; + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLAllowsExpiredCertificates]; + if (value && [value boolValue] == YES) + canUseSecureTransport = NO; + } + #endif + + if (IS_SECURE_TRANSPORT_AVAILABLE && canUseSecureTransport) + { + #if SECURE_TRANSPORT_MAYBE_AVAILABLE + [self ssl_startTLS]; + #endif + } + else + { + #if TARGET_OS_IPHONE + [self cf_startTLS]; + #endif + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Security via SecureTransport +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#if SECURE_TRANSPORT_MAYBE_AVAILABLE + +- (OSStatus)sslReadWithBuffer:(void *)buffer length:(size_t *)bufferLength +{ + LogVerbose(@"sslReadWithBuffer:%p length:%lu", buffer, (unsigned long)*bufferLength); + + if ((socketFDBytesAvailable == 0) && ([sslPreBuffer availableBytes] == 0)) + { + LogVerbose(@"%@ - No data available to read...", THIS_METHOD); + + // No data available to read. + // + // Need to wait for readSource to fire and notify us of + // available data in the socket's internal read buffer. + + [self resumeReadSource]; + + *bufferLength = 0; + return errSSLWouldBlock; + } + + size_t totalBytesRead = 0; + size_t totalBytesLeftToBeRead = *bufferLength; + + BOOL done = NO; + BOOL socketError = NO; + + // + // STEP 1 : READ FROM SSL PRE BUFFER + // + + size_t sslPreBufferLength = [sslPreBuffer availableBytes]; + + if (sslPreBufferLength > 0) + { + LogVerbose(@"%@: Reading from SSL pre buffer...", THIS_METHOD); + + size_t bytesToCopy; + if (sslPreBufferLength > totalBytesLeftToBeRead) + bytesToCopy = totalBytesLeftToBeRead; + else + bytesToCopy = sslPreBufferLength; + + LogVerbose(@"%@: Copying %zu bytes from sslPreBuffer", THIS_METHOD, bytesToCopy); + + memcpy(buffer, [sslPreBuffer readBuffer], bytesToCopy); + [sslPreBuffer didRead:bytesToCopy]; + + LogVerbose(@"%@: sslPreBuffer.length = %zu", THIS_METHOD, [sslPreBuffer availableBytes]); + + totalBytesRead += bytesToCopy; + totalBytesLeftToBeRead -= bytesToCopy; + + done = (totalBytesLeftToBeRead == 0); + + if (done) LogVerbose(@"%@: Complete", THIS_METHOD); + } + + // + // STEP 2 : READ FROM SOCKET + // + + if (!done && (socketFDBytesAvailable > 0)) + { + LogVerbose(@"%@: Reading from socket...", THIS_METHOD); + + int socketFD = (socket6FD == SOCKET_NULL) ? socket4FD : socket6FD; + + BOOL readIntoPreBuffer; + size_t bytesToRead; + uint8_t *buf; + + if (socketFDBytesAvailable > totalBytesLeftToBeRead) + { + // Read all available data from socket into sslPreBuffer. + // Then copy requested amount into dataBuffer. + + LogVerbose(@"%@: Reading into sslPreBuffer...", THIS_METHOD); + + [sslPreBuffer ensureCapacityForWrite:socketFDBytesAvailable]; + + readIntoPreBuffer = YES; + bytesToRead = (size_t)socketFDBytesAvailable; + buf = [sslPreBuffer writeBuffer]; + } + else + { + // Read available data from socket directly into dataBuffer. + + LogVerbose(@"%@: Reading directly into dataBuffer...", THIS_METHOD); + + readIntoPreBuffer = NO; + bytesToRead = totalBytesLeftToBeRead; + buf = (uint8_t *)buffer + totalBytesRead; + } + + ssize_t result = read(socketFD, buf, bytesToRead); + LogVerbose(@"%@: read from socket = %zd", THIS_METHOD, result); + + if (result < 0) + { + LogVerbose(@"%@: read errno = %i", THIS_METHOD, errno); + + if (errno != EWOULDBLOCK) + { + socketError = YES; + } + + socketFDBytesAvailable = 0; + } + else if (result == 0) + { + LogVerbose(@"%@: read EOF", THIS_METHOD); + + socketError = YES; + socketFDBytesAvailable = 0; + } + else + { + size_t bytesReadFromSocket = result; + + if (socketFDBytesAvailable > bytesReadFromSocket) + socketFDBytesAvailable -= bytesReadFromSocket; + else + socketFDBytesAvailable = 0; + + if (readIntoPreBuffer) + { + [sslPreBuffer didWrite:bytesReadFromSocket]; + + size_t bytesToCopy = MIN(totalBytesLeftToBeRead, bytesReadFromSocket); + + LogVerbose(@"%@: Copying %zu bytes out of sslPreBuffer", THIS_METHOD, bytesToCopy); + + memcpy((uint8_t *)buffer + totalBytesRead, [sslPreBuffer readBuffer], bytesToCopy); + [sslPreBuffer didRead:bytesToCopy]; + + totalBytesRead += bytesToCopy; + totalBytesLeftToBeRead -= bytesToCopy; + + LogVerbose(@"%@: sslPreBuffer.length = %zu", THIS_METHOD, [sslPreBuffer availableBytes]); + } + else + { + totalBytesRead += bytesReadFromSocket; + totalBytesLeftToBeRead -= bytesReadFromSocket; + } + + done = (totalBytesLeftToBeRead == 0); + + if (done) LogVerbose(@"%@: Complete", THIS_METHOD); + } + } + + *bufferLength = totalBytesRead; + + if (done) + return noErr; + + if (socketError) + return errSSLClosedAbort; + + return errSSLWouldBlock; +} + +- (OSStatus)sslWriteWithBuffer:(const void *)buffer length:(size_t *)bufferLength +{ + if (!(flags & kSocketCanAcceptBytes)) + { + // Unable to write. + // + // Need to wait for writeSource to fire and notify us of + // available space in the socket's internal write buffer. + + [self resumeWriteSource]; + + *bufferLength = 0; + return errSSLWouldBlock; + } + + size_t bytesToWrite = *bufferLength; + size_t bytesWritten = 0; + + BOOL done = NO; + BOOL socketError = NO; + + int socketFD = (socket4FD == SOCKET_NULL) ? socket6FD : socket4FD; + + ssize_t result = write(socketFD, buffer, bytesToWrite); + + if (result < 0) + { + if (errno != EWOULDBLOCK) + { + socketError = YES; + } + + flags &= ~kSocketCanAcceptBytes; + } + else if (result == 0) + { + flags &= ~kSocketCanAcceptBytes; + } + else + { + bytesWritten = result; + + done = (bytesWritten == bytesToWrite); + } + + *bufferLength = bytesWritten; + + if (done) + return noErr; + + if (socketError) + return errSSLClosedAbort; + + return errSSLWouldBlock; +} + +static OSStatus SSLReadFunction(SSLConnectionRef connection, void *data, size_t *dataLength) +{ + GCDAsyncSocket *asyncSocket = (__bridge GCDAsyncSocket *)connection; + + NSCAssert(dispatch_get_specific(asyncSocket->IsOnSocketQueueOrTargetQueueKey), @"What the deuce?"); + + return [asyncSocket sslReadWithBuffer:data length:dataLength]; +} + +static OSStatus SSLWriteFunction(SSLConnectionRef connection, const void *data, size_t *dataLength) +{ + GCDAsyncSocket *asyncSocket = (__bridge GCDAsyncSocket *)connection; + + NSCAssert(dispatch_get_specific(asyncSocket->IsOnSocketQueueOrTargetQueueKey), @"What the deuce?"); + + return [asyncSocket sslWriteWithBuffer:data length:dataLength]; +} + +- (void)ssl_startTLS +{ + LogTrace(); + + LogVerbose(@"Starting TLS (via SecureTransport)..."); + + OSStatus status; + + GCDAsyncSpecialPacket *tlsPacket = (GCDAsyncSpecialPacket *)currentRead; + NSDictionary *tlsSettings = tlsPacket->tlsSettings; + + // Create SSLContext, and setup IO callbacks and connection ref + + BOOL isServer = [[tlsSettings objectForKey:(NSString *)kCFStreamSSLIsServer] boolValue]; + + #if TARGET_OS_IPHONE + { + if (isServer) + sslContext = SSLCreateContext(kCFAllocatorDefault, kSSLServerSide, kSSLStreamType); + else + sslContext = SSLCreateContext(kCFAllocatorDefault, kSSLClientSide, kSSLStreamType); + + if (sslContext == NULL) + { + [self closeWithError:[self otherError:@"Error in SSLCreateContext"]]; + return; + } + } + #else + { + status = SSLNewContext(isServer, &sslContext); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLNewContext"]]; + return; + } + } + #endif + + status = SSLSetIOFuncs(sslContext, &SSLReadFunction, &SSLWriteFunction); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetIOFuncs"]]; + return; + } + + status = SSLSetConnection(sslContext, (__bridge SSLConnectionRef)self); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetConnection"]]; + return; + } + + // Configure SSLContext from given settings + // + // Checklist: + // 1. kCFStreamSSLPeerName + // 2. kCFStreamSSLAllowsAnyRoot + // 3. kCFStreamSSLAllowsExpiredRoots + // 4. kCFStreamSSLValidatesCertificateChain + // 5. kCFStreamSSLAllowsExpiredCertificates + // 6. kCFStreamSSLCertificates + // 7. kCFStreamSSLLevel (GCDAsyncSocketSSLProtocolVersionMin / GCDAsyncSocketSSLProtocolVersionMax) + // 8. GCDAsyncSocketSSLCipherSuites + // 9. GCDAsyncSocketSSLDiffieHellmanParameters (Mac) + + id value; + + // 1. kCFStreamSSLPeerName + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLPeerName]; + if ([value isKindOfClass:[NSString class]]) + { + NSString *peerName = (NSString *)value; + + const char *peer = [peerName UTF8String]; + size_t peerLen = strlen(peer); + + status = SSLSetPeerDomainName(sslContext, peer, peerLen); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetPeerDomainName"]]; + return; + } + } + + // 2. kCFStreamSSLAllowsAnyRoot + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLAllowsAnyRoot]; + if (value) + { + #if TARGET_OS_IPHONE + NSAssert(NO, @"Security option unavailable via SecureTransport in iOS - kCFStreamSSLAllowsAnyRoot"); + #else + + BOOL allowsAnyRoot = [value boolValue]; + + status = SSLSetAllowsAnyRoot(sslContext, allowsAnyRoot); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetAllowsAnyRoot"]]; + return; + } + + #endif + } + + // 3. kCFStreamSSLAllowsExpiredRoots + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLAllowsExpiredRoots]; + if (value) + { + #if TARGET_OS_IPHONE + NSAssert(NO, @"Security option unavailable via SecureTransport in iOS - kCFStreamSSLAllowsExpiredRoots"); + #else + + BOOL allowsExpiredRoots = [value boolValue]; + + status = SSLSetAllowsExpiredRoots(sslContext, allowsExpiredRoots); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetAllowsExpiredRoots"]]; + return; + } + + #endif + } + + // 4. kCFStreamSSLValidatesCertificateChain + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLValidatesCertificateChain]; + if (value) + { + #if TARGET_OS_IPHONE + NSAssert(NO, @"Security option unavailable via SecureTransport in iOS - kCFStreamSSLValidatesCertificateChain"); + #else + + BOOL validatesCertChain = [value boolValue]; + + status = SSLSetEnableCertVerify(sslContext, validatesCertChain); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetEnableCertVerify"]]; + return; + } + + #endif + } + + // 5. kCFStreamSSLAllowsExpiredCertificates + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLAllowsExpiredCertificates]; + if (value) + { + #if TARGET_OS_IPHONE + NSAssert(NO, @"Security option unavailable via SecureTransport in iOS - kCFStreamSSLAllowsExpiredCertificates"); + #else + + BOOL allowsExpiredCerts = [value boolValue]; + + status = SSLSetAllowsExpiredCerts(sslContext, allowsExpiredCerts); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetAllowsExpiredCerts"]]; + return; + } + + #endif + } + + // 6. kCFStreamSSLCertificates + + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLCertificates]; + if (value) + { + CFArrayRef certs = (__bridge CFArrayRef)value; + + status = SSLSetCertificate(sslContext, certs); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetCertificate"]]; + return; + } + } + + // 7. kCFStreamSSLLevel + + #if TARGET_OS_IPHONE + { + NSString *sslLevel = [tlsSettings objectForKey:(NSString *)kCFStreamSSLLevel]; + + NSString *sslMinLevel = [tlsSettings objectForKey:GCDAsyncSocketSSLProtocolVersionMin]; + NSString *sslMaxLevel = [tlsSettings objectForKey:GCDAsyncSocketSSLProtocolVersionMax]; + + if (sslLevel) + { + if (sslMinLevel || sslMaxLevel) + { + LogWarn(@"kCFStreamSSLLevel security option ignored. Overriden by " + @"GCDAsyncSocketSSLProtocolVersionMin and/or GCDAsyncSocketSSLProtocolVersionMax"); + } + else + { + if ([sslLevel isEqualToString:(NSString *)kCFStreamSocketSecurityLevelSSLv3]) + { + sslMinLevel = sslMaxLevel = @"kSSLProtocol3"; + } + else if ([sslLevel isEqualToString:(NSString *)kCFStreamSocketSecurityLevelTLSv1]) + { + sslMinLevel = sslMaxLevel = @"kTLSProtocol1"; + } + else + { + LogWarn(@"Unable to match kCFStreamSSLLevel security option to valid SSL protocol min/max"); + } + } + } + + if (sslMinLevel || sslMaxLevel) + { + OSStatus status1 = noErr; + OSStatus status2 = noErr; + + SSLProtocol (^sslProtocolForString)(NSString*) = ^SSLProtocol (NSString *protocolStr) { + + if ([protocolStr isEqualToString:@"kSSLProtocol3"]) return kSSLProtocol3; + if ([protocolStr isEqualToString:@"kTLSProtocol1"]) return kTLSProtocol1; + if ([protocolStr isEqualToString:@"kTLSProtocol11"]) return kTLSProtocol11; + if ([protocolStr isEqualToString:@"kTLSProtocol12"]) return kTLSProtocol12; + + return kSSLProtocolUnknown; + }; + + SSLProtocol minProtocol = sslProtocolForString(sslMinLevel); + SSLProtocol maxProtocol = sslProtocolForString(sslMaxLevel); + + if (minProtocol != kSSLProtocolUnknown) + { + status1 = SSLSetProtocolVersionMin(sslContext, minProtocol); + } + if (maxProtocol != kSSLProtocolUnknown) + { + status2 = SSLSetProtocolVersionMax(sslContext, maxProtocol); + } + + if (status1 != noErr || status2 != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetProtocolVersionMinMax"]]; + return; + } + } + } + #else + { + value = [tlsSettings objectForKey:(NSString *)kCFStreamSSLLevel]; + if (value) + { + NSString *sslLevel = (NSString *)value; + + OSStatus status1 = noErr; + OSStatus status2 = noErr; + OSStatus status3 = noErr; + + if ([sslLevel isEqualToString:(NSString *)kCFStreamSocketSecurityLevelSSLv2]) + { + // kCFStreamSocketSecurityLevelSSLv2: + // + // Specifies that SSL version 2 be set as the security protocol. + + status1 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocolAll, NO); + status2 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocol2, YES); + } + else if ([sslLevel isEqualToString:(NSString *)kCFStreamSocketSecurityLevelSSLv3]) + { + // kCFStreamSocketSecurityLevelSSLv3: + // + // Specifies that SSL version 3 be set as the security protocol. + // If SSL version 3 is not available, specifies that SSL version 2 be set as the security protocol. + + status1 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocolAll, NO); + status2 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocol2, YES); + status3 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocol3, YES); + } + else if ([sslLevel isEqualToString:(NSString *)kCFStreamSocketSecurityLevelTLSv1]) + { + // kCFStreamSocketSecurityLevelTLSv1: + // + // Specifies that TLS version 1 be set as the security protocol. + + status1 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocolAll, NO); + status2 = SSLSetProtocolVersionEnabled(sslContext, kTLSProtocol1, YES); + } + else if ([sslLevel isEqualToString:(NSString *)kCFStreamSocketSecurityLevelNegotiatedSSL]) + { + // kCFStreamSocketSecurityLevelNegotiatedSSL: + // + // Specifies that the highest level security protocol that can be negotiated be used. + + status1 = SSLSetProtocolVersionEnabled(sslContext, kSSLProtocolAll, YES); + } + + if (status1 != noErr || status2 != noErr || status3 != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetProtocolVersionEnabled"]]; + return; + } + } + } + #endif + + // 8. GCDAsyncSocketSSLCipherSuites + + value = [tlsSettings objectForKey:GCDAsyncSocketSSLCipherSuites]; + if (value) + { + NSArray *cipherSuites = (NSArray *)value; + NSUInteger numberCiphers = [cipherSuites count]; + SSLCipherSuite ciphers[numberCiphers]; + + NSUInteger cipherIndex; + for (cipherIndex = 0; cipherIndex < numberCiphers; cipherIndex++) + { + NSNumber *cipherObject = [cipherSuites objectAtIndex:cipherIndex]; + ciphers[cipherIndex] = [cipherObject shortValue]; + } + + status = SSLSetEnabledCiphers(sslContext, ciphers, numberCiphers); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetEnabledCiphers"]]; + return; + } + } + + // 9. GCDAsyncSocketSSLDiffieHellmanParameters + + #if !TARGET_OS_IPHONE + value = [tlsSettings objectForKey:GCDAsyncSocketSSLDiffieHellmanParameters]; + if (value) + { + NSData *diffieHellmanData = (NSData *)value; + + status = SSLSetDiffieHellmanParams(sslContext, [diffieHellmanData bytes], [diffieHellmanData length]); + if (status != noErr) + { + [self closeWithError:[self otherError:@"Error in SSLSetDiffieHellmanParams"]]; + return; + } + } + #endif + + // Setup the sslPreBuffer + // + // Any data in the preBuffer needs to be moved into the sslPreBuffer, + // as this data is now part of the secure read stream. + + sslPreBuffer = [[GCDAsyncSocketPreBuffer alloc] initWithCapacity:(1024 * 4)]; + + size_t preBufferLength = [preBuffer availableBytes]; + + if (preBufferLength > 0) + { + [sslPreBuffer ensureCapacityForWrite:preBufferLength]; + + memcpy([sslPreBuffer writeBuffer], [preBuffer readBuffer], preBufferLength); + [preBuffer didRead:preBufferLength]; + [sslPreBuffer didWrite:preBufferLength]; + } + + sslErrCode = noErr; + + // Start the SSL Handshake process + + [self ssl_continueSSLHandshake]; +} + +- (void)ssl_continueSSLHandshake +{ + LogTrace(); + + // If the return value is noErr, the session is ready for normal secure communication. + // If the return value is errSSLWouldBlock, the SSLHandshake function must be called again. + // Otherwise, the return value indicates an error code. + + OSStatus status = SSLHandshake(sslContext); + + if (status == noErr) + { + LogVerbose(@"SSLHandshake complete"); + + flags &= ~kStartingReadTLS; + flags &= ~kStartingWriteTLS; + + flags |= kSocketSecure; + + if (delegateQueue && [delegate respondsToSelector:@selector(socketDidSecure:)]) + { + __strong id theDelegate = delegate; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socketDidSecure:self]; + }}); + } + + [self endCurrentRead]; + [self endCurrentWrite]; + + [self maybeDequeueRead]; + [self maybeDequeueWrite]; + } + else if (status == errSSLWouldBlock) + { + LogVerbose(@"SSLHandshake continues..."); + + // Handshake continues... + // + // This method will be called again from doReadData or doWriteData. + } + else + { + [self closeWithError:[self sslError:status]]; + } +} + +#endif + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Security via CFStream +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#if TARGET_OS_IPHONE + +- (void)cf_finishSSLHandshake +{ + LogTrace(); + + if ((flags & kStartingReadTLS) && (flags & kStartingWriteTLS)) + { + flags &= ~kStartingReadTLS; + flags &= ~kStartingWriteTLS; + + flags |= kSocketSecure; + + if (delegateQueue && [delegate respondsToSelector:@selector(socketDidSecure:)]) + { + __strong id theDelegate = delegate; + + dispatch_async(delegateQueue, ^{ @autoreleasepool { + + [theDelegate socketDidSecure:self]; + }}); + } + + [self endCurrentRead]; + [self endCurrentWrite]; + + [self maybeDequeueRead]; + [self maybeDequeueWrite]; + } +} + +- (void)cf_abortSSLHandshake:(NSError *)error +{ + LogTrace(); + + if ((flags & kStartingReadTLS) && (flags & kStartingWriteTLS)) + { + flags &= ~kStartingReadTLS; + flags &= ~kStartingWriteTLS; + + [self closeWithError:error]; + } +} + +- (void)cf_startTLS +{ + LogTrace(); + + LogVerbose(@"Starting TLS (via CFStream)..."); + + if ([preBuffer availableBytes] > 0) + { + NSString *msg = @"Invalid TLS transition. Handshake has already been read from socket."; + + [self closeWithError:[self otherError:msg]]; + return; + } + + [self suspendReadSource]; + [self suspendWriteSource]; + + socketFDBytesAvailable = 0; + flags &= ~kSocketCanAcceptBytes; + flags &= ~kSecureSocketHasBytesAvailable; + + flags |= kUsingCFStreamForTLS; + + if (![self createReadAndWriteStream]) + { + [self closeWithError:[self otherError:@"Error in CFStreamCreatePairWithSocket"]]; + return; + } + + if (![self registerForStreamCallbacksIncludingReadWrite:YES]) + { + [self closeWithError:[self otherError:@"Error in CFStreamSetClient"]]; + return; + } + + if (![self addStreamsToRunLoop]) + { + [self closeWithError:[self otherError:@"Error in CFStreamScheduleWithRunLoop"]]; + return; + } + + NSAssert([currentRead isKindOfClass:[GCDAsyncSpecialPacket class]], @"Invalid read packet for startTLS"); + NSAssert([currentWrite isKindOfClass:[GCDAsyncSpecialPacket class]], @"Invalid write packet for startTLS"); + + GCDAsyncSpecialPacket *tlsPacket = (GCDAsyncSpecialPacket *)currentRead; + CFDictionaryRef tlsSettings = (__bridge CFDictionaryRef)tlsPacket->tlsSettings; + + // Getting an error concerning kCFStreamPropertySSLSettings ? + // You need to add the CFNetwork framework to your iOS application. + + BOOL r1 = CFReadStreamSetProperty(readStream, kCFStreamPropertySSLSettings, tlsSettings); + BOOL r2 = CFWriteStreamSetProperty(writeStream, kCFStreamPropertySSLSettings, tlsSettings); + + // For some reason, starting around the time of iOS 4.3, + // the first call to set the kCFStreamPropertySSLSettings will return true, + // but the second will return false. + // + // Order doesn't seem to matter. + // So you could call CFReadStreamSetProperty and then CFWriteStreamSetProperty, or you could reverse the order. + // Either way, the first call will return true, and the second returns false. + // + // Interestingly, this doesn't seem to affect anything. + // Which is not altogether unusual, as the documentation seems to suggest that (for many settings) + // setting it on one side of the stream automatically sets it for the other side of the stream. + // + // Although there isn't anything in the documentation to suggest that the second attempt would fail. + // + // Furthermore, this only seems to affect streams that are negotiating a security upgrade. + // In other words, the socket gets connected, there is some back-and-forth communication over the unsecure + // connection, and then a startTLS is issued. + // So this mostly affects newer protocols (XMPP, IMAP) as opposed to older protocols (HTTPS). + + if (!r1 && !r2) // Yes, the && is correct - workaround for apple bug. + { + [self closeWithError:[self otherError:@"Error in CFStreamSetProperty"]]; + return; + } + + if (![self openStreams]) + { + [self closeWithError:[self otherError:@"Error in CFStreamOpen"]]; + return; + } + + LogVerbose(@"Waiting for SSL Handshake to complete..."); +} + +#endif + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark CFStream +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#if TARGET_OS_IPHONE + ++ (void)startCFStreamThreadIfNeeded +{ + static dispatch_once_t predicate; + dispatch_once(&predicate, ^{ + + cfstreamThread = [[NSThread alloc] initWithTarget:self + selector:@selector(cfstreamThread) + object:nil]; + [cfstreamThread start]; + }); +} + ++ (void)cfstreamThread { @autoreleasepool +{ + [[NSThread currentThread] setName:GCDAsyncSocketThreadName]; + + LogInfo(@"CFStreamThread: Started"); + + // We can't run the run loop unless it has an associated input source or a timer. + // So we'll just create a timer that will never fire - unless the server runs for decades. + [NSTimer scheduledTimerWithTimeInterval:[[NSDate distantFuture] timeIntervalSinceNow] + target:self + selector:@selector(doNothingAtAll:) + userInfo:nil + repeats:YES]; + + [[NSRunLoop currentRunLoop] run]; + + LogInfo(@"CFStreamThread: Stopped"); +}} + ++ (void)scheduleCFStreams:(GCDAsyncSocket *)asyncSocket +{ + LogTrace(); + NSAssert([NSThread currentThread] == cfstreamThread, @"Invoked on wrong thread"); + + CFRunLoopRef runLoop = CFRunLoopGetCurrent(); + + if (asyncSocket->readStream) + CFReadStreamScheduleWithRunLoop(asyncSocket->readStream, runLoop, kCFRunLoopDefaultMode); + + if (asyncSocket->writeStream) + CFWriteStreamScheduleWithRunLoop(asyncSocket->writeStream, runLoop, kCFRunLoopDefaultMode); +} + ++ (void)unscheduleCFStreams:(GCDAsyncSocket *)asyncSocket +{ + LogTrace(); + NSAssert([NSThread currentThread] == cfstreamThread, @"Invoked on wrong thread"); + + CFRunLoopRef runLoop = CFRunLoopGetCurrent(); + + if (asyncSocket->readStream) + CFReadStreamUnscheduleFromRunLoop(asyncSocket->readStream, runLoop, kCFRunLoopDefaultMode); + + if (asyncSocket->writeStream) + CFWriteStreamUnscheduleFromRunLoop(asyncSocket->writeStream, runLoop, kCFRunLoopDefaultMode); +} + +static void CFReadStreamCallback (CFReadStreamRef stream, CFStreamEventType type, void *pInfo) +{ + GCDAsyncSocket *asyncSocket = (__bridge GCDAsyncSocket *)pInfo; + + switch(type) + { + case kCFStreamEventHasBytesAvailable: + { + dispatch_async(asyncSocket->socketQueue, ^{ @autoreleasepool { + + LogCVerbose(@"CFReadStreamCallback - HasBytesAvailable"); + + if (asyncSocket->readStream != stream) + return_from_block; + + if ((asyncSocket->flags & kStartingReadTLS) && (asyncSocket->flags & kStartingWriteTLS)) + { + // If we set kCFStreamPropertySSLSettings before we opened the streams, this might be a lie. + // (A callback related to the tcp stream, but not to the SSL layer). + + if (CFReadStreamHasBytesAvailable(asyncSocket->readStream)) + { + asyncSocket->flags |= kSecureSocketHasBytesAvailable; + [asyncSocket cf_finishSSLHandshake]; + } + } + else + { + asyncSocket->flags |= kSecureSocketHasBytesAvailable; + [asyncSocket doReadData]; + } + }}); + + break; + } + default: + { + NSError *error = (__bridge_transfer NSError *)CFReadStreamCopyError(stream); + + if (error == nil && type == kCFStreamEventEndEncountered) + { + error = [asyncSocket connectionClosedError]; + } + + dispatch_async(asyncSocket->socketQueue, ^{ @autoreleasepool { + + LogCVerbose(@"CFReadStreamCallback - Other"); + + if (asyncSocket->readStream != stream) + return_from_block; + + if ((asyncSocket->flags & kStartingReadTLS) && (asyncSocket->flags & kStartingWriteTLS)) + { + [asyncSocket cf_abortSSLHandshake:error]; + } + else + { + [asyncSocket closeWithError:error]; + } + }}); + + break; + } + } + +} + +static void CFWriteStreamCallback (CFWriteStreamRef stream, CFStreamEventType type, void *pInfo) +{ + GCDAsyncSocket *asyncSocket = (__bridge GCDAsyncSocket *)pInfo; + + switch(type) + { + case kCFStreamEventCanAcceptBytes: + { + dispatch_async(asyncSocket->socketQueue, ^{ @autoreleasepool { + + LogCVerbose(@"CFWriteStreamCallback - CanAcceptBytes"); + + if (asyncSocket->writeStream != stream) + return_from_block; + + if ((asyncSocket->flags & kStartingReadTLS) && (asyncSocket->flags & kStartingWriteTLS)) + { + // If we set kCFStreamPropertySSLSettings before we opened the streams, this might be a lie. + // (A callback related to the tcp stream, but not to the SSL layer). + + if (CFWriteStreamCanAcceptBytes(asyncSocket->writeStream)) + { + asyncSocket->flags |= kSocketCanAcceptBytes; + [asyncSocket cf_finishSSLHandshake]; + } + } + else + { + asyncSocket->flags |= kSocketCanAcceptBytes; + [asyncSocket doWriteData]; + } + }}); + + break; + } + default: + { + NSError *error = (__bridge_transfer NSError *)CFWriteStreamCopyError(stream); + + if (error == nil && type == kCFStreamEventEndEncountered) + { + error = [asyncSocket connectionClosedError]; + } + + dispatch_async(asyncSocket->socketQueue, ^{ @autoreleasepool { + + LogCVerbose(@"CFWriteStreamCallback - Other"); + + if (asyncSocket->writeStream != stream) + return_from_block; + + if ((asyncSocket->flags & kStartingReadTLS) && (asyncSocket->flags & kStartingWriteTLS)) + { + [asyncSocket cf_abortSSLHandshake:error]; + } + else + { + [asyncSocket closeWithError:error]; + } + }}); + + break; + } + } + +} + +- (BOOL)createReadAndWriteStream +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + + + if (readStream || writeStream) + { + // Streams already created + return YES; + } + + int socketFD = (socket6FD == SOCKET_NULL) ? socket4FD : socket6FD; + + if (socketFD == SOCKET_NULL) + { + // Cannot create streams without a file descriptor + return NO; + } + + if (![self isConnected]) + { + // Cannot create streams until file descriptor is connected + return NO; + } + + LogVerbose(@"Creating read and write stream..."); + + CFStreamCreatePairWithSocket(NULL, (CFSocketNativeHandle)socketFD, &readStream, &writeStream); + + // The kCFStreamPropertyShouldCloseNativeSocket property should be false by default (for our case). + // But let's not take any chances. + + if (readStream) + CFReadStreamSetProperty(readStream, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanFalse); + if (writeStream) + CFWriteStreamSetProperty(writeStream, kCFStreamPropertyShouldCloseNativeSocket, kCFBooleanFalse); + + if ((readStream == NULL) || (writeStream == NULL)) + { + LogWarn(@"Unable to create read and write stream..."); + + if (readStream) + { + CFReadStreamClose(readStream); + CFRelease(readStream); + readStream = NULL; + } + if (writeStream) + { + CFWriteStreamClose(writeStream); + CFRelease(writeStream); + writeStream = NULL; + } + + return NO; + } + + return YES; +} + +- (BOOL)registerForStreamCallbacksIncludingReadWrite:(BOOL)includeReadWrite +{ + LogVerbose(@"%@ %@", THIS_METHOD, (includeReadWrite ? @"YES" : @"NO")); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + NSAssert((readStream != NULL && writeStream != NULL), @"Read/Write stream is null"); + + streamContext.version = 0; + streamContext.info = (__bridge void *)(self); + streamContext.retain = nil; + streamContext.release = nil; + streamContext.copyDescription = nil; + + CFOptionFlags readStreamEvents = kCFStreamEventErrorOccurred | kCFStreamEventEndEncountered; + if (includeReadWrite) + readStreamEvents |= kCFStreamEventHasBytesAvailable; + + if (!CFReadStreamSetClient(readStream, readStreamEvents, &CFReadStreamCallback, &streamContext)) + { + return NO; + } + + CFOptionFlags writeStreamEvents = kCFStreamEventErrorOccurred | kCFStreamEventEndEncountered; + if (includeReadWrite) + writeStreamEvents |= kCFStreamEventCanAcceptBytes; + + if (!CFWriteStreamSetClient(writeStream, writeStreamEvents, &CFWriteStreamCallback, &streamContext)) + { + return NO; + } + + return YES; +} + +- (BOOL)addStreamsToRunLoop +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + NSAssert((readStream != NULL && writeStream != NULL), @"Read/Write stream is null"); + + if (!(flags & kAddedStreamsToRunLoop)) + { + LogVerbose(@"Adding streams to runloop..."); + + [[self class] startCFStreamThreadIfNeeded]; + [[self class] performSelector:@selector(scheduleCFStreams:) + onThread:cfstreamThread + withObject:self + waitUntilDone:YES]; + + flags |= kAddedStreamsToRunLoop; + } + + return YES; +} + +- (void)removeStreamsFromRunLoop +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + NSAssert((readStream != NULL && writeStream != NULL), @"Read/Write stream is null"); + + if (flags & kAddedStreamsToRunLoop) + { + LogVerbose(@"Removing streams from runloop..."); + + [[self class] performSelector:@selector(unscheduleCFStreams:) + onThread:cfstreamThread + withObject:self + waitUntilDone:YES]; + + flags &= ~kAddedStreamsToRunLoop; + } +} + +- (BOOL)openStreams +{ + LogTrace(); + + NSAssert(dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey), @"Must be dispatched on socketQueue"); + NSAssert((readStream != NULL && writeStream != NULL), @"Read/Write stream is null"); + + CFStreamStatus readStatus = CFReadStreamGetStatus(readStream); + CFStreamStatus writeStatus = CFWriteStreamGetStatus(writeStream); + + if ((readStatus == kCFStreamStatusNotOpen) || (writeStatus == kCFStreamStatusNotOpen)) + { + LogVerbose(@"Opening read and write stream..."); + + BOOL r1 = CFReadStreamOpen(readStream); + BOOL r2 = CFWriteStreamOpen(writeStream); + + if (!r1 || !r2) + { + LogError(@"Error in CFStreamOpen"); + return NO; + } + } + + return YES; +} + +#endif + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Advanced +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * See header file for big discussion of this method. +**/ +- (BOOL)autoDisconnectOnClosedReadStream +{ + // Note: YES means kAllowHalfDuplexConnection is OFF + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + return ((config & kAllowHalfDuplexConnection) == 0); + } + else + { + __block BOOL result; + + dispatch_sync(socketQueue, ^{ + result = ((config & kAllowHalfDuplexConnection) == 0); + }); + + return result; + } +} + +/** + * See header file for big discussion of this method. +**/ +- (void)setAutoDisconnectOnClosedReadStream:(BOOL)flag +{ + // Note: YES means kAllowHalfDuplexConnection is OFF + + dispatch_block_t block = ^{ + + if (flag) + config &= ~kAllowHalfDuplexConnection; + else + config |= kAllowHalfDuplexConnection; + }; + + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_async(socketQueue, block); +} + + +/** + * See header file for big discussion of this method. +**/ +- (void)markSocketQueueTargetQueue:(dispatch_queue_t)socketNewTargetQueue +{ + void *nonNullUnusedPointer = (__bridge void *)self; + dispatch_queue_set_specific(socketNewTargetQueue, IsOnSocketQueueOrTargetQueueKey, nonNullUnusedPointer, NULL); +} + +/** + * See header file for big discussion of this method. +**/ +- (void)unmarkSocketQueueTargetQueue:(dispatch_queue_t)socketOldTargetQueue +{ + dispatch_queue_set_specific(socketOldTargetQueue, IsOnSocketQueueOrTargetQueueKey, NULL, NULL); +} + +/** + * See header file for big discussion of this method. +**/ +- (void)performBlock:(dispatch_block_t)block +{ + if (dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + block(); + else + dispatch_sync(socketQueue, block); +} + +/** + * Questions? Have you read the header file? +**/ +- (int)socketFD +{ + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return SOCKET_NULL; + } + + if (socket4FD != SOCKET_NULL) + return socket4FD; + else + return socket6FD; +} + +/** + * Questions? Have you read the header file? +**/ +- (int)socket4FD +{ + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return SOCKET_NULL; + } + + return socket4FD; +} + +/** + * Questions? Have you read the header file? +**/ +- (int)socket6FD +{ + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return SOCKET_NULL; + } + + return socket6FD; +} + +#if TARGET_OS_IPHONE + +/** + * Questions? Have you read the header file? +**/ +- (CFReadStreamRef)readStream +{ + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return NULL; + } + + if (readStream == NULL) + [self createReadAndWriteStream]; + + return readStream; +} + +/** + * Questions? Have you read the header file? +**/ +- (CFWriteStreamRef)writeStream +{ + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return NULL; + } + + if (writeStream == NULL) + [self createReadAndWriteStream]; + + return writeStream; +} + +- (BOOL)enableBackgroundingOnSocketWithCaveat:(BOOL)caveat +{ + if (![self createReadAndWriteStream]) + { + // Error occured creating streams (perhaps socket isn't open) + return NO; + } + + BOOL r1, r2; + + LogVerbose(@"Enabling backgrouding on socket"); + + r1 = CFReadStreamSetProperty(readStream, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP); + r2 = CFWriteStreamSetProperty(writeStream, kCFStreamNetworkServiceType, kCFStreamNetworkServiceTypeVoIP); + + if (!r1 || !r2) + { + return NO; + } + + if (!caveat) + { + if (![self openStreams]) + { + return NO; + } + } + + return YES; +} + +/** + * Questions? Have you read the header file? +**/ +- (BOOL)enableBackgroundingOnSocket +{ + LogTrace(); + + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return NO; + } + + return [self enableBackgroundingOnSocketWithCaveat:NO]; +} + +- (BOOL)enableBackgroundingOnSocketWithCaveat // Deprecated in iOS 4.??? +{ + // This method was created as a workaround for a bug in iOS. + // Apple has since fixed this bug. + // I'm not entirely sure which version of iOS they fixed it in... + + LogTrace(); + + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return NO; + } + + return [self enableBackgroundingOnSocketWithCaveat:YES]; +} + +#endif + +#if SECURE_TRANSPORT_MAYBE_AVAILABLE + +- (SSLContextRef)sslContext +{ + if (!dispatch_get_specific(IsOnSocketQueueOrTargetQueueKey)) + { + LogWarn(@"%@ - Method only available from within the context of a performBlock: invocation", THIS_METHOD); + return NULL; + } + + return sslContext; +} + +#endif + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Class Methods +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + ++ (NSString *)hostFromSockaddr4:(const struct sockaddr_in *)pSockaddr4 +{ + char addrBuf[INET_ADDRSTRLEN]; + + if (inet_ntop(AF_INET, &pSockaddr4->sin_addr, addrBuf, (socklen_t)sizeof(addrBuf)) == NULL) + { + addrBuf[0] = '\0'; + } + + return [NSString stringWithCString:addrBuf encoding:NSASCIIStringEncoding]; +} + ++ (NSString *)hostFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6 +{ + char addrBuf[INET6_ADDRSTRLEN]; + + if (inet_ntop(AF_INET6, &pSockaddr6->sin6_addr, addrBuf, (socklen_t)sizeof(addrBuf)) == NULL) + { + addrBuf[0] = '\0'; + } + + return [NSString stringWithCString:addrBuf encoding:NSASCIIStringEncoding]; +} + ++ (uint16_t)portFromSockaddr4:(const struct sockaddr_in *)pSockaddr4 +{ + return ntohs(pSockaddr4->sin_port); +} + ++ (uint16_t)portFromSockaddr6:(const struct sockaddr_in6 *)pSockaddr6 +{ + return ntohs(pSockaddr6->sin6_port); +} + ++ (NSString *)hostFromAddress:(NSData *)address +{ + NSString *host; + + if ([self getHost:&host port:NULL fromAddress:address]) + return host; + else + return nil; +} + ++ (uint16_t)portFromAddress:(NSData *)address +{ + uint16_t port; + + if ([self getHost:NULL port:&port fromAddress:address]) + return port; + else + return 0; +} + ++ (BOOL)getHost:(NSString **)hostPtr port:(uint16_t *)portPtr fromAddress:(NSData *)address +{ + if ([address length] >= sizeof(struct sockaddr)) + { + const struct sockaddr *sockaddrX = [address bytes]; + + if (sockaddrX->sa_family == AF_INET) + { + if ([address length] >= sizeof(struct sockaddr_in)) + { + struct sockaddr_in sockaddr4; + memcpy(&sockaddr4, sockaddrX, sizeof(sockaddr4)); + + if (hostPtr) *hostPtr = [self hostFromSockaddr4:&sockaddr4]; + if (portPtr) *portPtr = [self portFromSockaddr4:&sockaddr4]; + + return YES; + } + } + else if (sockaddrX->sa_family == AF_INET6) + { + if ([address length] >= sizeof(struct sockaddr_in6)) + { + struct sockaddr_in6 sockaddr6; + memcpy(&sockaddr6, sockaddrX, sizeof(sockaddr6)); + + if (hostPtr) *hostPtr = [self hostFromSockaddr6:&sockaddr6]; + if (portPtr) *portPtr = [self portFromSockaddr6:&sockaddr6]; + + return YES; + } + } + } + + return NO; +} + ++ (NSData *)CRLFData +{ + return [NSData dataWithBytes:"\x0D\x0A" length:2]; +} + ++ (NSData *)CRData +{ + return [NSData dataWithBytes:"\x0D" length:1]; +} + ++ (NSData *)LFData +{ + return [NSData dataWithBytes:"\x0A" length:1]; +} + ++ (NSData *)ZeroData +{ + return [NSData dataWithBytes:"" length:1]; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/About.txt b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/About.txt new file mode 100644 index 00000000000..bf0f1fd3ee0 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/About.txt @@ -0,0 +1,33 @@ +CocoaLumberjack is under the New BSD License. +https://github.com/robbiehanson/CocoaLumberjack + +Extensive documentation, tutorials, etc are available: +https://github.com/robbiehanson/CocoaLumberjack/wiki + +Overview of the project (copied from google code homepage): + + + +The lumberjack framework is fast & simple, yet powerful & flexible. +It is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for objective-c, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the objective-c runtime. + +Lumberjack is fast: +In most cases it is an order of magnitude faster than NSLog. + +Lumberjack is simple: +It takes as little as a single line of code to configure lumberjack when your application launches. Then simply replace your NSLog statements with DDLog statements and that's about it. (And the DDLog macros have the exact same format and syntax as NSLog, so it's super easy.) + +Lumberjack is powerful: +One log statement can be sent to multiple loggers, meaning you can log to a file and the console simultaneously. Want more? Create your own loggers (it's easy) and send your log statements over the network. Or to a database or distributed file system. The sky is the limit. + +Lumberjack is flexible: +Configure your logging however you want. Change log levels per file (perfect for debugging). Change log levels per logger (verbose console, but concise log file). Change log levels per xcode configuration (verbose debug, but concise release). Have your log statements compiled out of the release build. Customize the number of log levels for your application. Add your own fine-grained logging. Dynamically change log levels during runtime. Choose how & when you want your log files to be rolled. Upload your log files to a central server. Compress archived log files to save disk space... + + + +This framework is for you if: + +You're looking for a way to track down that impossible-to-reproduce bug that keeps popping up in the field. +You're frustrated with the super short console log on the iPhone. +You're looking to take your application to the next level in terms of support and stability. +You're looking for an enterprise level logging solution for your application (Mac or iPhone). \ No newline at end of file diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.h new file mode 100755 index 00000000000..0f2e9633ef8 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.h @@ -0,0 +1,41 @@ +#import +#import + +#import "DDLog.h" + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * + * This class provides a logger for the Apple System Log facility. + * + * As described in the "Getting Started" page, + * the traditional NSLog() function directs it's output to two places: + * + * - Apple System Log + * - StdErr (if stderr is a TTY) so log statements show up in Xcode console + * + * To duplicate NSLog() functionality you can simply add this logger and a tty logger. + * However, if you instead choose to use file logging (for faster performance), + * you may choose to use a file logger and a tty logger. +**/ + +@interface DDASLLogger : DDAbstractLogger +{ + aslclient client; +} + ++ (DDASLLogger *)sharedInstance; + +// Inherited from DDAbstractLogger + +// - (id )logFormatter; +// - (void)setLogFormatter:(id )formatter; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.m new file mode 100755 index 00000000000..0c35f2fcf15 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.m @@ -0,0 +1,99 @@ +#import "DDASLLogger.h" + +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + + +@implementation DDASLLogger + +static DDASLLogger *sharedInstance; + +/** + * The runtime sends initialize to each class in a program exactly one time just before the class, + * or any class that inherits from it, is sent its first message from within the program. (Thus the + * method may never be invoked if the class is not used.) The runtime sends the initialize message to + * classes in a thread-safe manner. Superclasses receive this message before their subclasses. + * + * This method may also be called directly (assumably by accident), hence the safety mechanism. +**/ ++ (void)initialize +{ + static BOOL initialized = NO; + if (!initialized) + { + initialized = YES; + + sharedInstance = [[DDASLLogger alloc] init]; + } +} + ++ (DDASLLogger *)sharedInstance +{ + return sharedInstance; +} + +- (id)init +{ + if (sharedInstance != nil) + { + return nil; + } + + if ((self = [super init])) + { + // A default asl client is provided for the main thread, + // but background threads need to create their own client. + + client = asl_open(NULL, "com.apple.console", 0); + } + return self; +} + +- (void)logMessage:(DDLogMessage *)logMessage +{ + NSString *logMsg = logMessage->logMsg; + + if (formatter) + { + logMsg = [formatter formatLogMessage:logMessage]; + } + + if (logMsg) + { + const char *msg = [logMsg UTF8String]; + + int aslLogLevel; + switch (logMessage->logFlag) + { + // Note: By default ASL will filter anything above level 5 (Notice). + // So our mappings shouldn't go above that level. + + case LOG_FLAG_ERROR : aslLogLevel = ASL_LEVEL_CRIT; break; + case LOG_FLAG_WARN : aslLogLevel = ASL_LEVEL_ERR; break; + case LOG_FLAG_INFO : aslLogLevel = ASL_LEVEL_WARNING; break; + default : aslLogLevel = ASL_LEVEL_NOTICE; break; + } + + asl_log(client, NULL, aslLogLevel, "%s", msg); + } +} + +- (NSString *)loggerName +{ + return @"cocoa.lumberjack.aslLogger"; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.h new file mode 100644 index 00000000000..436234e25b4 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.h @@ -0,0 +1,102 @@ +#import + +#import "DDLog.h" + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * + * This class provides an abstract implementation of a database logger. + * + * That is, it provides the base implementation for a database logger to build atop of. + * All that is needed for a concrete database logger is to extend this class + * and override the methods in the implementation file that are prefixed with "db_". +**/ + +@interface DDAbstractDatabaseLogger : DDAbstractLogger { +@protected + NSUInteger saveThreshold; + NSTimeInterval saveInterval; + NSTimeInterval maxAge; + NSTimeInterval deleteInterval; + BOOL deleteOnEverySave; + + BOOL saveTimerSuspended; + NSUInteger unsavedCount; + dispatch_time_t unsavedTime; + dispatch_source_t saveTimer; + dispatch_time_t lastDeleteTime; + dispatch_source_t deleteTimer; +} + +/** + * Specifies how often to save the data to disk. + * Since saving is an expensive operation (disk io) it is not done after every log statement. + * These properties allow you to configure how/when the logger saves to disk. + * + * A save is done when either (whichever happens first): + * + * - The number of unsaved log entries reaches saveThreshold + * - The amount of time since the oldest unsaved log entry was created reaches saveInterval + * + * You can optionally disable the saveThreshold by setting it to zero. + * If you disable the saveThreshold you are entirely dependent on the saveInterval. + * + * You can optionally disable the saveInterval by setting it to zero (or a negative value). + * If you disable the saveInterval you are entirely dependent on the saveThreshold. + * + * It's not wise to disable both saveThreshold and saveInterval. + * + * The default saveThreshold is 500. + * The default saveInterval is 60 seconds. +**/ +@property (assign, readwrite) NSUInteger saveThreshold; +@property (assign, readwrite) NSTimeInterval saveInterval; + +/** + * It is likely you don't want the log entries to persist forever. + * Doing so would allow the database to grow infinitely large over time. + * + * The maxAge property provides a way to specify how old a log statement can get + * before it should get deleted from the database. + * + * The deleteInterval specifies how often to sweep for old log entries. + * Since deleting is an expensive operation (disk io) is is done on a fixed interval. + * + * An alternative to the deleteInterval is the deleteOnEverySave option. + * This specifies that old log entries should be deleted during every save operation. + * + * You can optionally disable the maxAge by setting it to zero (or a negative value). + * If you disable the maxAge then old log statements are not deleted. + * + * You can optionally disable the deleteInterval by setting it to zero (or a negative value). + * + * If you disable both deleteInterval and deleteOnEverySave then old log statements are not deleted. + * + * It's not wise to enable both deleteInterval and deleteOnEverySave. + * + * The default maxAge is 7 days. + * The default deleteInterval is 5 minutes. + * The default deleteOnEverySave is NO. +**/ +@property (assign, readwrite) NSTimeInterval maxAge; +@property (assign, readwrite) NSTimeInterval deleteInterval; +@property (assign, readwrite) BOOL deleteOnEverySave; + +/** + * Forces a save of any pending log entries (flushes log entries to disk). +**/ +- (void)savePendingLogEntries; + +/** + * Removes any log entries that are older than maxAge. +**/ +- (void)deleteOldLogEntries; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.m new file mode 100644 index 00000000000..c7366a69c52 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.m @@ -0,0 +1,727 @@ +#import "DDAbstractDatabaseLogger.h" +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +@interface DDAbstractDatabaseLogger () +- (void)destroySaveTimer; +- (void)destroyDeleteTimer; +@end + +#pragma mark - + +@implementation DDAbstractDatabaseLogger + +- (id)init +{ + if ((self = [super init])) + { + saveThreshold = 500; + saveInterval = 60; // 60 seconds + maxAge = (60 * 60 * 24 * 7); // 7 days + deleteInterval = (60 * 5); // 5 minutes + } + return self; +} + +- (void)dealloc +{ + [self destroySaveTimer]; + [self destroyDeleteTimer]; + +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Override Me +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)db_log:(DDLogMessage *)logMessage +{ + // Override me and add your implementation. + // + // Return YES if an item was added to the buffer. + // Return NO if the logMessage was ignored. + + return NO; +} + +- (void)db_save +{ + // Override me and add your implementation. +} + +- (void)db_delete +{ + // Override me and add your implementation. +} + +- (void)db_saveAndDelete +{ + // Override me and add your implementation. +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Private API +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)performSaveAndSuspendSaveTimer +{ + if (unsavedCount > 0) + { + if (deleteOnEverySave) + [self db_saveAndDelete]; + else + [self db_save]; + } + + unsavedCount = 0; + unsavedTime = 0; + + if (saveTimer && !saveTimerSuspended) + { + dispatch_suspend(saveTimer); + saveTimerSuspended = YES; + } +} + +- (void)performDelete +{ + if (maxAge > 0.0) + { + [self db_delete]; + + lastDeleteTime = dispatch_time(DISPATCH_TIME_NOW, 0); + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Timers +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)destroySaveTimer +{ + if (saveTimer) + { + dispatch_source_cancel(saveTimer); + if (saveTimerSuspended) + { + // Must resume a timer before releasing it (or it will crash) + dispatch_resume(saveTimer); + saveTimerSuspended = NO; + } + #if !OS_OBJECT_USE_OBJC + dispatch_release(saveTimer); + #endif + saveTimer = NULL; + } +} + +- (void)updateAndResumeSaveTimer +{ + if ((saveTimer != NULL) && (saveInterval > 0.0) && (unsavedTime > 0.0)) + { + uint64_t interval = (uint64_t)(saveInterval * NSEC_PER_SEC); + dispatch_time_t startTime = dispatch_time(unsavedTime, interval); + + dispatch_source_set_timer(saveTimer, startTime, interval, 1.0); + + if (saveTimerSuspended) + { + dispatch_resume(saveTimer); + saveTimerSuspended = NO; + } + } +} + +- (void)createSuspendedSaveTimer +{ + if ((saveTimer == NULL) && (saveInterval > 0.0)) + { + saveTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, loggerQueue); + + dispatch_source_set_event_handler(saveTimer, ^{ @autoreleasepool { + + [self performSaveAndSuspendSaveTimer]; + + }}); + + saveTimerSuspended = YES; + } +} + +- (void)destroyDeleteTimer +{ + if (deleteTimer) + { + dispatch_source_cancel(deleteTimer); + #if !OS_OBJECT_USE_OBJC + dispatch_release(deleteTimer); + #endif + deleteTimer = NULL; + } +} + +- (void)updateDeleteTimer +{ + if ((deleteTimer != NULL) && (deleteInterval > 0.0) && (maxAge > 0.0)) + { + uint64_t interval = (uint64_t)(deleteInterval * NSEC_PER_SEC); + dispatch_time_t startTime; + + if (lastDeleteTime > 0) + startTime = dispatch_time(lastDeleteTime, interval); + else + startTime = dispatch_time(DISPATCH_TIME_NOW, interval); + + dispatch_source_set_timer(deleteTimer, startTime, interval, 1.0); + } +} + +- (void)createAndStartDeleteTimer +{ + if ((deleteTimer == NULL) && (deleteInterval > 0.0) && (maxAge > 0.0)) + { + deleteTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, loggerQueue); + + if (deleteTimer != NULL) { + dispatch_source_set_event_handler(deleteTimer, ^{ @autoreleasepool { + + [self performDelete]; + + }}); + + [self updateDeleteTimer]; + + dispatch_resume(deleteTimer); + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Configuration +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (NSUInteger)saveThreshold +{ + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block NSUInteger result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = saveThreshold; + }); + }); + + return result; +} + +- (void)setSaveThreshold:(NSUInteger)threshold +{ + dispatch_block_t block = ^{ @autoreleasepool { + + if (saveThreshold != threshold) + { + saveThreshold = threshold; + + // Since the saveThreshold has changed, + // we check to see if the current unsavedCount has surpassed the new threshold. + // + // If it has, we immediately save the log. + + if ((unsavedCount >= saveThreshold) && (saveThreshold > 0)) + { + [self performSaveAndSuspendSaveTimer]; + } + } + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (NSTimeInterval)saveInterval +{ + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block NSTimeInterval result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = saveInterval; + }); + }); + + return result; +} + +- (void)setSaveInterval:(NSTimeInterval)interval +{ + dispatch_block_t block = ^{ @autoreleasepool { + + // C99 recommended floating point comparison macro + // Read: isLessThanOrGreaterThan(floatA, floatB) + + if (/* saveInterval != interval */ islessgreater(saveInterval, interval)) + { + saveInterval = interval; + + // There are several cases we need to handle here. + // + // 1. If the saveInterval was previously enabled and it just got disabled, + // then we need to stop the saveTimer. (And we might as well release it.) + // + // 2. If the saveInterval was previously disabled and it just got enabled, + // then we need to setup the saveTimer. (Plus we might need to do an immediate save.) + // + // 3. If the saveInterval increased, then we need to reset the timer so that it fires at the later date. + // + // 4. If the saveInterval decreased, then we need to reset the timer so that it fires at an earlier date. + // (Plus we might need to do an immediate save.) + + if (saveInterval > 0.0) + { + if (saveTimer == NULL) + { + // Handles #2 + // + // Since the saveTimer uses the unsavedTime to calculate it's first fireDate, + // if a save is needed the timer will fire immediately. + + [self createSuspendedSaveTimer]; + [self updateAndResumeSaveTimer]; + } + else + { + // Handles #3 + // Handles #4 + // + // Since the saveTimer uses the unsavedTime to calculate it's first fireDate, + // if a save is needed the timer will fire immediately. + + [self updateAndResumeSaveTimer]; + } + } + else if (saveTimer) + { + // Handles #1 + + [self destroySaveTimer]; + } + } + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (NSTimeInterval)maxAge +{ + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block NSTimeInterval result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = maxAge; + }); + }); + + return result; +} + +- (void)setMaxAge:(NSTimeInterval)interval +{ + dispatch_block_t block = ^{ @autoreleasepool { + + // C99 recommended floating point comparison macro + // Read: isLessThanOrGreaterThan(floatA, floatB) + + if (/* maxAge != interval */ islessgreater(maxAge, interval)) + { + NSTimeInterval oldMaxAge = maxAge; + NSTimeInterval newMaxAge = interval; + + maxAge = interval; + + // There are several cases we need to handle here. + // + // 1. If the maxAge was previously enabled and it just got disabled, + // then we need to stop the deleteTimer. (And we might as well release it.) + // + // 2. If the maxAge was previously disabled and it just got enabled, + // then we need to setup the deleteTimer. (Plus we might need to do an immediate delete.) + // + // 3. If the maxAge was increased, + // then we don't need to do anything. + // + // 4. If the maxAge was decreased, + // then we should do an immediate delete. + + BOOL shouldDeleteNow = NO; + + if (oldMaxAge > 0.0) + { + if (newMaxAge <= 0.0) + { + // Handles #1 + + [self destroyDeleteTimer]; + } + else if (oldMaxAge > newMaxAge) + { + // Handles #4 + shouldDeleteNow = YES; + } + } + else if (newMaxAge > 0.0) + { + // Handles #2 + shouldDeleteNow = YES; + } + + if (shouldDeleteNow) + { + [self performDelete]; + + if (deleteTimer) + [self updateDeleteTimer]; + else + [self createAndStartDeleteTimer]; + } + } + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (NSTimeInterval)deleteInterval +{ + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block NSTimeInterval result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = deleteInterval; + }); + }); + + return result; +} + +- (void)setDeleteInterval:(NSTimeInterval)interval +{ + dispatch_block_t block = ^{ @autoreleasepool { + + // C99 recommended floating point comparison macro + // Read: isLessThanOrGreaterThan(floatA, floatB) + + if (/* deleteInterval != interval */ islessgreater(deleteInterval, interval)) + { + deleteInterval = interval; + + // There are several cases we need to handle here. + // + // 1. If the deleteInterval was previously enabled and it just got disabled, + // then we need to stop the deleteTimer. (And we might as well release it.) + // + // 2. If the deleteInterval was previously disabled and it just got enabled, + // then we need to setup the deleteTimer. (Plus we might need to do an immediate delete.) + // + // 3. If the deleteInterval increased, then we need to reset the timer so that it fires at the later date. + // + // 4. If the deleteInterval decreased, then we need to reset the timer so that it fires at an earlier date. + // (Plus we might need to do an immediate delete.) + + if (deleteInterval > 0.0) + { + if (deleteTimer == NULL) + { + // Handles #2 + // + // Since the deleteTimer uses the lastDeleteTime to calculate it's first fireDate, + // if a delete is needed the timer will fire immediately. + + [self createAndStartDeleteTimer]; + } + else + { + // Handles #3 + // Handles #4 + // + // Since the deleteTimer uses the lastDeleteTime to calculate it's first fireDate, + // if a save is needed the timer will fire immediately. + + [self updateDeleteTimer]; + } + } + else if (deleteTimer) + { + // Handles #1 + + [self destroyDeleteTimer]; + } + } + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (BOOL)deleteOnEverySave +{ + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block BOOL result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = deleteOnEverySave; + }); + }); + + return result; +} + +- (void)setDeleteOnEverySave:(BOOL)flag +{ + dispatch_block_t block = ^{ + + deleteOnEverySave = flag; + }; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Public API +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)savePendingLogEntries +{ + dispatch_block_t block = ^{ @autoreleasepool { + + [self performSaveAndSuspendSaveTimer]; + }}; + + if ([self isOnInternalLoggerQueue]) + block(); + else + dispatch_async(loggerQueue, block); +} + +- (void)deleteOldLogEntries +{ + dispatch_block_t block = ^{ @autoreleasepool { + + [self performDelete]; + }}; + + if ([self isOnInternalLoggerQueue]) + block(); + else + dispatch_async(loggerQueue, block); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark DDLogger +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)didAddLogger +{ + // If you override me be sure to invoke [super didAddLogger]; + + [self createSuspendedSaveTimer]; + + [self createAndStartDeleteTimer]; +} + +- (void)willRemoveLogger +{ + // If you override me be sure to invoke [super willRemoveLogger]; + + [self performSaveAndSuspendSaveTimer]; + + [self destroySaveTimer]; + [self destroyDeleteTimer]; +} + +- (void)logMessage:(DDLogMessage *)logMessage +{ + if ([self db_log:logMessage]) + { + BOOL firstUnsavedEntry = (++unsavedCount == 1); + + if ((unsavedCount >= saveThreshold) && (saveThreshold > 0)) + { + [self performSaveAndSuspendSaveTimer]; + } + else if (firstUnsavedEntry) + { + unsavedTime = dispatch_time(DISPATCH_TIME_NOW, 0); + [self updateAndResumeSaveTimer]; + } + } +} + +- (void)flush +{ + // This method is invoked by DDLog's flushLog method. + // + // It is called automatically when the application quits, + // or if the developer invokes DDLog's flushLog method prior to crashing or something. + + [self performSaveAndSuspendSaveTimer]; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.h new file mode 100644 index 00000000000..5af637649ab --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.h @@ -0,0 +1,334 @@ +#import +#import "DDLog.h" + +@class DDLogFileInfo; + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * + * This class provides a logger to write log statements to a file. +**/ + + +// Default configuration and safety/sanity values. +// +// maximumFileSize -> DEFAULT_LOG_MAX_FILE_SIZE +// rollingFrequency -> DEFAULT_LOG_ROLLING_FREQUENCY +// maximumNumberOfLogFiles -> DEFAULT_LOG_MAX_NUM_LOG_FILES +// +// You should carefully consider the proper configuration values for your application. + +#define DEFAULT_LOG_MAX_FILE_SIZE (1024 * 1024) // 1 MB +#define DEFAULT_LOG_ROLLING_FREQUENCY (60 * 60 * 24) // 24 Hours +#define DEFAULT_LOG_MAX_NUM_LOG_FILES (5) // 5 Files + + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +// The LogFileManager protocol is designed to allow you to control all aspects of your log files. +// +// The primary purpose of this is to allow you to do something with the log files after they have been rolled. +// Perhaps you want to compress them to save disk space. +// Perhaps you want to upload them to an FTP server. +// Perhaps you want to run some analytics on the file. +// +// A default LogFileManager is, of course, provided. +// The default LogFileManager simply deletes old log files according to the maximumNumberOfLogFiles property. +// +// This protocol provides various methods to fetch the list of log files. +// +// There are two variants: sorted and unsorted. +// If sorting is not necessary, the unsorted variant is obviously faster. +// The sorted variant will return an array sorted by when the log files were created, +// with the most recently created log file at index 0, and the oldest log file at the end of the array. +// +// You can fetch only the log file paths (full path including name), log file names (name only), +// or an array of DDLogFileInfo objects. +// The DDLogFileInfo class is documented below, and provides a handy wrapper that +// gives you easy access to various file attributes such as the creation date or the file size. + +@protocol DDLogFileManager +@required + +// Public properties + +/** + * The maximum number of archived log files to keep on disk. + * For example, if this property is set to 3, + * then the LogFileManager will only keep 3 archived log files (plus the current active log file) on disk. + * Once the active log file is rolled/archived, then the oldest of the existing 3 rolled/archived log files is deleted. + * + * You may optionally disable deleting old/rolled/archived log files by setting this property to zero. +**/ +@property (readwrite, assign) NSUInteger maximumNumberOfLogFiles; + +// Public methods + +- (NSString *)logsDirectory; + +- (NSArray *)unsortedLogFilePaths; +- (NSArray *)unsortedLogFileNames; +- (NSArray *)unsortedLogFileInfos; + +- (NSArray *)sortedLogFilePaths; +- (NSArray *)sortedLogFileNames; +- (NSArray *)sortedLogFileInfos; + +// Private methods (only to be used by DDFileLogger) + +- (NSString *)createNewLogFile; + +@optional + +// Notifications from DDFileLogger + +- (void)didArchiveLogFile:(NSString *)logFilePath; +- (void)didRollAndArchiveLogFile:(NSString *)logFilePath; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Default log file manager. + * + * All log files are placed inside the logsDirectory. + * If a specific logsDirectory isn't specified, the default directory is used. + * On Mac, this is in ~/Library/Logs/. + * On iPhone, this is in ~/Library/Caches/Logs. + * + * Log files are named "log-.txt", + * where uuid is a 6 character hexadecimal consisting of the set [0123456789ABCDEF]. + * + * Archived log files are automatically deleted according to the maximumNumberOfLogFiles property. +**/ +@interface DDLogFileManagerDefault : NSObject +{ + NSUInteger maximumNumberOfLogFiles; + NSString *_logsDirectory; +} + +- (id)init; +- (id)initWithLogsDirectory:(NSString *)logsDirectory; + +/* Inherited from DDLogFileManager protocol: + +@property (readwrite, assign) NSUInteger maximumNumberOfLogFiles; + +- (NSString *)logsDirectory; + +- (NSArray *)unsortedLogFilePaths; +- (NSArray *)unsortedLogFileNames; +- (NSArray *)unsortedLogFileInfos; + +- (NSArray *)sortedLogFilePaths; +- (NSArray *)sortedLogFileNames; +- (NSArray *)sortedLogFileInfos; + +*/ + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Most users will want file log messages to be prepended with the date and time. + * Rather than forcing the majority of users to write their own formatter, + * we will supply a logical default formatter. + * Users can easily replace this formatter with their own by invoking the setLogFormatter method. + * It can also be removed by calling setLogFormatter, and passing a nil parameter. + * + * In addition to the convenience of having a logical default formatter, + * it will also provide a template that makes it easy for developers to copy and change. +**/ +@interface DDLogFileFormatterDefault : NSObject +{ + NSDateFormatter *dateFormatter; +} + +- (id)init; +- (id)initWithDateFormatter:(NSDateFormatter *)dateFormatter; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@interface DDFileLogger : DDAbstractLogger +{ + __strong id logFileManager; + + DDLogFileInfo *currentLogFileInfo; + NSFileHandle *currentLogFileHandle; + + dispatch_source_t rollingTimer; + + unsigned long long maximumFileSize; + NSTimeInterval rollingFrequency; +} + +- (id)init; +- (id)initWithLogFileManager:(id )logFileManager; + +/** + * Log File Rolling: + * + * maximumFileSize: + * The approximate maximum size to allow log files to grow. + * If a log file is larger than this value after a log statement is appended, + * then the log file is rolled. + * + * rollingFrequency + * How often to roll the log file. + * The frequency is given as an NSTimeInterval, which is a double that specifies the interval in seconds. + * Once the log file gets to be this old, it is rolled. + * + * Both the maximumFileSize and the rollingFrequency are used to manage rolling. + * Whichever occurs first will cause the log file to be rolled. + * + * For example: + * The rollingFrequency is 24 hours, + * but the log file surpasses the maximumFileSize after only 20 hours. + * The log file will be rolled at that 20 hour mark. + * A new log file will be created, and the 24 hour timer will be restarted. + * + * You may optionally disable rolling due to filesize by setting maximumFileSize to zero. + * If you do so, rolling is based solely on rollingFrequency. + * + * You may optionally disable rolling due to time by setting rollingFrequency to zero (or any non-positive number). + * If you do so, rolling is based solely on maximumFileSize. + * + * If you disable both maximumFileSize and rollingFrequency, then the log file won't ever be rolled. + * This is strongly discouraged. +**/ +@property (readwrite, assign) unsigned long long maximumFileSize; +@property (readwrite, assign) NSTimeInterval rollingFrequency; + +/** + * The DDLogFileManager instance can be used to retrieve the list of log files, + * and configure the maximum number of archived log files to keep. + * + * @see DDLogFileManager.maximumNumberOfLogFiles +**/ +@property (strong, nonatomic, readonly) id logFileManager; + + +// You can optionally force the current log file to be rolled with this method. + +- (void)rollLogFile; + +// Inherited from DDAbstractLogger + +// - (id )logFormatter; +// - (void)setLogFormatter:(id )formatter; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * DDLogFileInfo is a simple class that provides access to various file attributes. + * It provides good performance as it only fetches the information if requested, + * and it caches the information to prevent duplicate fetches. + * + * It was designed to provide quick snapshots of the current state of log files, + * and to help sort log files in an array. + * + * This class does not monitor the files, or update it's cached attribute values if the file changes on disk. + * This is not what the class was designed for. + * + * If you absolutely must get updated values, + * you can invoke the reset method which will clear the cache. +**/ +@interface DDLogFileInfo : NSObject +{ + __strong NSString *filePath; + __strong NSString *fileName; + + __strong NSDictionary *fileAttributes; + + __strong NSDate *creationDate; + __strong NSDate *modificationDate; + + unsigned long long fileSize; +} + +@property (strong, nonatomic, readonly) NSString *filePath; +@property (strong, nonatomic, readonly) NSString *fileName; + +@property (strong, nonatomic, readonly) NSDictionary *fileAttributes; + +@property (strong, nonatomic, readonly) NSDate *creationDate; +@property (strong, nonatomic, readonly) NSDate *modificationDate; + +@property (nonatomic, readonly) unsigned long long fileSize; + +@property (nonatomic, readonly) NSTimeInterval age; + +@property (nonatomic, readwrite) BOOL isArchived; + ++ (id)logFileWithPath:(NSString *)filePath; + +- (id)initWithFilePath:(NSString *)filePath; + +- (void)reset; +- (void)renameFile:(NSString *)newFileName; + +#if TARGET_IPHONE_SIMULATOR + +// So here's the situation. +// Extended attributes are perfect for what we're trying to do here (marking files as archived). +// This is exactly what extended attributes were designed for. +// +// But Apple screws us over on the simulator. +// Everytime you build-and-go, they copy the application into a new folder on the hard drive, +// and as part of the process they strip extended attributes from our log files. +// Normally, a copy of a file preserves extended attributes. +// So obviously Apple has gone to great lengths to piss us off. +// +// Thus we use a slightly different tactic for marking log files as archived in the simulator. +// That way it "just works" and there's no confusion when testing. +// +// The difference in method names is indicative of the difference in functionality. +// On the simulator we add an attribute by appending a filename extension. +// +// For example: +// log-ABC123.txt -> log-ABC123.archived.txt + +- (BOOL)hasExtensionAttributeWithName:(NSString *)attrName; + +- (void)addExtensionAttributeWithName:(NSString *)attrName; +- (void)removeExtensionAttributeWithName:(NSString *)attrName; + +#else + +// Normal use of extended attributes used everywhere else, +// such as on Macs and on iPhone devices. + +- (BOOL)hasExtendedAttributeWithName:(NSString *)attrName; + +- (void)addExtendedAttributeWithName:(NSString *)attrName; +- (void)removeExtendedAttributeWithName:(NSString *)attrName; + +#endif + +- (NSComparisonResult)reverseCompareByCreationDate:(DDLogFileInfo *)another; +- (NSComparisonResult)reverseCompareByModificationDate:(DDLogFileInfo *)another; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.m new file mode 100644 index 00000000000..afe7cc13807 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.m @@ -0,0 +1,1353 @@ +#import "DDFileLogger.h" + +#import +#import +#import +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// We probably shouldn't be using DDLog() statements within the DDLog implementation. +// But we still want to leave our log statements for any future debugging, +// and to allow other developers to trace the implementation (which is a great learning tool). +// +// So we use primitive logging macros around NSLog. +// We maintain the NS prefix on the macros to be explicit about the fact that we're using NSLog. + +#define LOG_LEVEL 2 + +#define NSLogError(frmt, ...) do{ if(LOG_LEVEL >= 1) NSLog((frmt), ##__VA_ARGS__); } while(0) +#define NSLogWarn(frmt, ...) do{ if(LOG_LEVEL >= 2) NSLog((frmt), ##__VA_ARGS__); } while(0) +#define NSLogInfo(frmt, ...) do{ if(LOG_LEVEL >= 3) NSLog((frmt), ##__VA_ARGS__); } while(0) +#define NSLogVerbose(frmt, ...) do{ if(LOG_LEVEL >= 4) NSLog((frmt), ##__VA_ARGS__); } while(0) + +@interface DDLogFileManagerDefault (PrivateAPI) + +- (void)deleteOldLogFiles; +- (NSString *)defaultLogsDirectory; + +@end + +@interface DDFileLogger (PrivateAPI) + +- (void)rollLogFileNow; +- (void)maybeRollLogFileDueToAge; +- (void)maybeRollLogFileDueToSize; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDLogFileManagerDefault + +@synthesize maximumNumberOfLogFiles; + +- (id)init +{ + return [self initWithLogsDirectory:nil]; +} + +- (id)initWithLogsDirectory:(NSString *)aLogsDirectory +{ + if ((self = [super init])) + { + maximumNumberOfLogFiles = DEFAULT_LOG_MAX_NUM_LOG_FILES; + + if (aLogsDirectory) + _logsDirectory = [aLogsDirectory copy]; + else + _logsDirectory = [[self defaultLogsDirectory] copy]; + + NSKeyValueObservingOptions kvoOptions = NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew; + + [self addObserver:self forKeyPath:@"maximumNumberOfLogFiles" options:kvoOptions context:nil]; + + NSLogVerbose(@"DDFileLogManagerDefault: logsDirectory:\n%@", [self logsDirectory]); + NSLogVerbose(@"DDFileLogManagerDefault: sortedLogFileNames:\n%@", [self sortedLogFileNames]); + } + return self; +} + +- (void)dealloc +{ + [self removeObserver:self forKeyPath:@"maximumNumberOfLogFiles"]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Configuration +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)observeValueForKeyPath:(NSString *)keyPath + ofObject:(id)object + change:(NSDictionary *)change + context:(void *)context +{ + NSNumber *old = [change objectForKey:NSKeyValueChangeOldKey]; + NSNumber *new = [change objectForKey:NSKeyValueChangeNewKey]; + + if ([old isEqual:new]) + { + // No change in value - don't bother with any processing. + return; + } + + if ([keyPath isEqualToString:@"maximumNumberOfLogFiles"]) + { + NSLogInfo(@"DDFileLogManagerDefault: Responding to configuration change: maximumNumberOfLogFiles"); + + dispatch_async([DDLog loggingQueue], ^{ @autoreleasepool { + + [self deleteOldLogFiles]; + }}); + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark File Deleting +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Deletes archived log files that exceed the maximumNumberOfLogFiles configuration value. +**/ +- (void)deleteOldLogFiles +{ + NSLogVerbose(@"DDLogFileManagerDefault: deleteOldLogFiles"); + + NSUInteger maxNumLogFiles = self.maximumNumberOfLogFiles; + if (maxNumLogFiles == 0) + { + // Unlimited - don't delete any log files + return; + } + + NSArray *sortedLogFileInfos = [self sortedLogFileInfos]; + + // Do we consider the first file? + // We are only supposed to be deleting archived files. + // In most cases, the first file is likely the log file that is currently being written to. + // So in most cases, we do not want to consider this file for deletion. + + NSUInteger count = [sortedLogFileInfos count]; + BOOL excludeFirstFile = NO; + + if (count > 0) + { + DDLogFileInfo *logFileInfo = [sortedLogFileInfos objectAtIndex:0]; + + if (!logFileInfo.isArchived) + { + excludeFirstFile = YES; + } + } + + NSArray *sortedArchivedLogFileInfos; + if (excludeFirstFile) + { + count--; + sortedArchivedLogFileInfos = [sortedLogFileInfos subarrayWithRange:NSMakeRange(1, count)]; + } + else + { + sortedArchivedLogFileInfos = sortedLogFileInfos; + } + + NSUInteger i; + for (i = maxNumLogFiles; i < count; i++) + { + DDLogFileInfo *logFileInfo = [sortedArchivedLogFileInfos objectAtIndex:i]; + + NSLogInfo(@"DDLogFileManagerDefault: Deleting file: %@", logFileInfo.fileName); + + [[NSFileManager defaultManager] removeItemAtPath:logFileInfo.filePath error:nil]; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Log Files +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns the path to the default logs directory. + * If the logs directory doesn't exist, this method automatically creates it. +**/ +- (NSString *)defaultLogsDirectory +{ +#if TARGET_OS_IPHONE + NSArray *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES); + NSString *baseDir = ([paths count] > 0) ? [paths objectAtIndex:0] : nil; + NSString *logsDirectory = [baseDir stringByAppendingPathComponent:@"Logs"]; + +#else + NSString *appName = [[NSProcessInfo processInfo] processName]; + NSArray *paths = NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES); + NSString *basePath = ([paths count] > 0) ? [paths objectAtIndex:0] : NSTemporaryDirectory(); + NSString *logsDirectory = [[basePath stringByAppendingPathComponent:@"Logs"] stringByAppendingPathComponent:appName]; + +#endif + + return logsDirectory; +} + +- (NSString *)logsDirectory +{ + // We could do this check once, during initalization, and not bother again. + // But this way the code continues to work if the directory gets deleted while the code is running. + + if (![[NSFileManager defaultManager] fileExistsAtPath:_logsDirectory]) + { + NSError *err = nil; + if (![[NSFileManager defaultManager] createDirectoryAtPath:_logsDirectory + withIntermediateDirectories:YES attributes:nil error:&err]) + { + NSLogError(@"DDFileLogManagerDefault: Error creating logsDirectory: %@", err); + } + } + + return _logsDirectory; +} + +- (BOOL)isLogFile:(NSString *)fileName +{ + // A log file has a name like "log-.txt", where is a HEX-string of 6 characters. + // + // For example: log-DFFE99.txt + + BOOL hasProperPrefix = [fileName hasPrefix:@"log-"]; + + BOOL hasProperLength = [fileName length] >= 10; + + + if (hasProperPrefix && hasProperLength) + { + NSCharacterSet *hexSet = [NSCharacterSet characterSetWithCharactersInString:@"0123456789ABCDEF"]; + + NSString *hex = [fileName substringWithRange:NSMakeRange(4, 6)]; + NSString *nohex = [hex stringByTrimmingCharactersInSet:hexSet]; + + if ([nohex length] == 0) + { + return YES; + } + } + + return NO; +} + +/** + * Returns an array of NSString objects, + * each of which is the filePath to an existing log file on disk. +**/ +- (NSArray *)unsortedLogFilePaths +{ + NSString *logsDirectory = [self logsDirectory]; + NSArray *fileNames = [[NSFileManager defaultManager] contentsOfDirectoryAtPath:logsDirectory error:nil]; + + NSMutableArray *unsortedLogFilePaths = [NSMutableArray arrayWithCapacity:[fileNames count]]; + + for (NSString *fileName in fileNames) + { + // Filter out any files that aren't log files. (Just for extra safety) + + if ([self isLogFile:fileName]) + { + NSString *filePath = [logsDirectory stringByAppendingPathComponent:fileName]; + + [unsortedLogFilePaths addObject:filePath]; + } + } + + return unsortedLogFilePaths; +} + +/** + * Returns an array of NSString objects, + * each of which is the fileName of an existing log file on disk. +**/ +- (NSArray *)unsortedLogFileNames +{ + NSArray *unsortedLogFilePaths = [self unsortedLogFilePaths]; + + NSMutableArray *unsortedLogFileNames = [NSMutableArray arrayWithCapacity:[unsortedLogFilePaths count]]; + + for (NSString *filePath in unsortedLogFilePaths) + { + [unsortedLogFileNames addObject:[filePath lastPathComponent]]; + } + + return unsortedLogFileNames; +} + +/** + * Returns an array of DDLogFileInfo objects, + * each representing an existing log file on disk, + * and containing important information about the log file such as it's modification date and size. +**/ +- (NSArray *)unsortedLogFileInfos +{ + NSArray *unsortedLogFilePaths = [self unsortedLogFilePaths]; + + NSMutableArray *unsortedLogFileInfos = [NSMutableArray arrayWithCapacity:[unsortedLogFilePaths count]]; + + for (NSString *filePath in unsortedLogFilePaths) + { + DDLogFileInfo *logFileInfo = [[DDLogFileInfo alloc] initWithFilePath:filePath]; + + [unsortedLogFileInfos addObject:logFileInfo]; + } + + return unsortedLogFileInfos; +} + +/** + * Just like the unsortedLogFilePaths method, but sorts the array. + * The items in the array are sorted by modification date. + * The first item in the array will be the most recently modified log file. +**/ +- (NSArray *)sortedLogFilePaths +{ + NSArray *sortedLogFileInfos = [self sortedLogFileInfos]; + + NSMutableArray *sortedLogFilePaths = [NSMutableArray arrayWithCapacity:[sortedLogFileInfos count]]; + + for (DDLogFileInfo *logFileInfo in sortedLogFileInfos) + { + [sortedLogFilePaths addObject:[logFileInfo filePath]]; + } + + return sortedLogFilePaths; +} + +/** + * Just like the unsortedLogFileNames method, but sorts the array. + * The items in the array are sorted by modification date. + * The first item in the array will be the most recently modified log file. +**/ +- (NSArray *)sortedLogFileNames +{ + NSArray *sortedLogFileInfos = [self sortedLogFileInfos]; + + NSMutableArray *sortedLogFileNames = [NSMutableArray arrayWithCapacity:[sortedLogFileInfos count]]; + + for (DDLogFileInfo *logFileInfo in sortedLogFileInfos) + { + [sortedLogFileNames addObject:[logFileInfo fileName]]; + } + + return sortedLogFileNames; +} + +/** + * Just like the unsortedLogFileInfos method, but sorts the array. + * The items in the array are sorted by modification date. + * The first item in the array will be the most recently modified log file. +**/ +- (NSArray *)sortedLogFileInfos +{ + return [[self unsortedLogFileInfos] sortedArrayUsingSelector:@selector(reverseCompareByCreationDate:)]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Creation +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Generates a short UUID suitable for use in the log file's name. + * The result will have six characters, all in the hexadecimal set [0123456789ABCDEF]. +**/ +- (NSString *)generateShortUUID +{ + CFUUIDRef uuid = CFUUIDCreate(NULL); + + CFStringRef fullStr = CFUUIDCreateString(NULL, uuid); + NSString *result = (__bridge_transfer NSString *)CFStringCreateWithSubstring(NULL, fullStr, CFRangeMake(0, 6)); + + CFRelease(fullStr); + CFRelease(uuid); + + return result; +} + +/** + * Generates a new unique log file path, and creates the corresponding log file. +**/ +- (NSString *)createNewLogFile +{ + // Generate a random log file name, and create the file (if there isn't a collision) + + NSString *logsDirectory = [self logsDirectory]; + do + { + NSString *fileName = [NSString stringWithFormat:@"log-%@.txt", [self generateShortUUID]]; + + NSString *filePath = [logsDirectory stringByAppendingPathComponent:fileName]; + + if (![[NSFileManager defaultManager] fileExistsAtPath:filePath]) + { + NSLogVerbose(@"DDLogFileManagerDefault: Creating new log file: %@", fileName); + + [[NSFileManager defaultManager] createFileAtPath:filePath contents:nil attributes:nil]; + + // Since we just created a new log file, we may need to delete some old log files + [self deleteOldLogFiles]; + + return filePath; + } + + } while(YES); +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDLogFileFormatterDefault + +- (id)init +{ + return [self initWithDateFormatter:nil]; +} + +- (id)initWithDateFormatter:(NSDateFormatter *)aDateFormatter +{ + if ((self = [super init])) + { + if (aDateFormatter) + { + dateFormatter = aDateFormatter; + } + else + { + dateFormatter = [[NSDateFormatter alloc] init]; + [dateFormatter setFormatterBehavior:NSDateFormatterBehavior10_4]; // 10.4+ style + [dateFormatter setDateFormat:@"yyyy/MM/dd HH:mm:ss:SSS"]; + } + } + return self; +} + +- (NSString *)formatLogMessage:(DDLogMessage *)logMessage +{ + NSString *dateAndTime = [dateFormatter stringFromDate:(logMessage->timestamp)]; + + return [NSString stringWithFormat:@"%@ %@", dateAndTime, logMessage->logMsg]; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDFileLogger + +- (id)init +{ + DDLogFileManagerDefault *defaultLogFileManager = [[DDLogFileManagerDefault alloc] init]; + + return [self initWithLogFileManager:defaultLogFileManager]; +} + +- (id)initWithLogFileManager:(id )aLogFileManager +{ + if ((self = [super init])) + { + maximumFileSize = DEFAULT_LOG_MAX_FILE_SIZE; + rollingFrequency = DEFAULT_LOG_ROLLING_FREQUENCY; + + logFileManager = aLogFileManager; + + formatter = [[DDLogFileFormatterDefault alloc] init]; + } + return self; +} + +- (void)dealloc +{ + [currentLogFileHandle synchronizeFile]; + [currentLogFileHandle closeFile]; + + if (rollingTimer) + { + dispatch_source_cancel(rollingTimer); + rollingTimer = NULL; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Properties +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@synthesize logFileManager; + +- (unsigned long long)maximumFileSize +{ + __block unsigned long long result; + + dispatch_block_t block = ^{ + result = maximumFileSize; + }; + + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the maximumFileSize variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, block); + }); + + return result; +} + +- (void)setMaximumFileSize:(unsigned long long)newMaximumFileSize +{ + dispatch_block_t block = ^{ @autoreleasepool { + + maximumFileSize = newMaximumFileSize; + [self maybeRollLogFileDueToSize]; + + }}; + + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the maximumFileSize variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); +} + +- (NSTimeInterval)rollingFrequency +{ + __block NSTimeInterval result; + + dispatch_block_t block = ^{ + result = rollingFrequency; + }; + + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation should access the rollingFrequency variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, block); + }); + + return result; +} + +- (void)setRollingFrequency:(NSTimeInterval)newRollingFrequency +{ + dispatch_block_t block = ^{ @autoreleasepool { + + rollingFrequency = newRollingFrequency; + [self maybeRollLogFileDueToAge]; + }}; + + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation should access the rollingFrequency variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark File Rolling +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)scheduleTimerToRollLogFileDueToAge +{ + if (rollingTimer) + { + dispatch_source_cancel(rollingTimer); + rollingTimer = NULL; + } + + if (currentLogFileInfo == nil || rollingFrequency <= 0.0) + { + return; + } + + NSDate *logFileCreationDate = [currentLogFileInfo creationDate]; + + NSTimeInterval ti = [logFileCreationDate timeIntervalSinceReferenceDate]; + ti += rollingFrequency; + + NSDate *logFileRollingDate = [NSDate dateWithTimeIntervalSinceReferenceDate:ti]; + + NSLogVerbose(@"DDFileLogger: scheduleTimerToRollLogFileDueToAge"); + + NSLogVerbose(@"DDFileLogger: logFileCreationDate: %@", logFileCreationDate); + NSLogVerbose(@"DDFileLogger: logFileRollingDate : %@", logFileRollingDate); + + rollingTimer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, loggerQueue); + + dispatch_source_set_event_handler(rollingTimer, ^{ @autoreleasepool { + + [self maybeRollLogFileDueToAge]; + + }}); + + #if !OS_OBJECT_USE_OBJC + dispatch_source_t theRollingTimer = rollingTimer; + dispatch_source_set_cancel_handler(rollingTimer, ^{ + dispatch_release(theRollingTimer); + }); + #endif + + uint64_t delay = (uint64_t)([logFileRollingDate timeIntervalSinceNow] * NSEC_PER_SEC); + dispatch_time_t fireTime = dispatch_time(DISPATCH_TIME_NOW, delay); + + dispatch_source_set_timer(rollingTimer, fireTime, DISPATCH_TIME_FOREVER, 1.0); + dispatch_resume(rollingTimer); +} + +- (void)rollLogFile +{ + // This method is public. + // We need to execute the rolling on our logging thread/queue. + + dispatch_block_t block = ^{ @autoreleasepool { + + [self rollLogFileNow]; + }}; + + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)rollLogFileNow +{ + NSLogVerbose(@"DDFileLogger: rollLogFileNow"); + + + if (currentLogFileHandle == nil) return; + + [currentLogFileHandle synchronizeFile]; + [currentLogFileHandle closeFile]; + currentLogFileHandle = nil; + + currentLogFileInfo.isArchived = YES; + + if ([logFileManager respondsToSelector:@selector(didRollAndArchiveLogFile:)]) + { + [logFileManager didRollAndArchiveLogFile:(currentLogFileInfo.filePath)]; + } + + currentLogFileInfo = nil; + + if (rollingTimer) + { + dispatch_source_cancel(rollingTimer); + rollingTimer = NULL; + } +} + +- (void)maybeRollLogFileDueToAge +{ + if (rollingFrequency > 0.0 && currentLogFileInfo.age >= rollingFrequency) + { + NSLogVerbose(@"DDFileLogger: Rolling log file due to age..."); + + [self rollLogFileNow]; + } + else + { + [self scheduleTimerToRollLogFileDueToAge]; + } +} + +- (void)maybeRollLogFileDueToSize +{ + // This method is called from logMessage. + // Keep it FAST. + + // Note: Use direct access to maximumFileSize variable. + // We specifically wrote our own getter/setter method to allow us to do this (for performance reasons). + + if (maximumFileSize > 0) + { + unsigned long long fileSize = [currentLogFileHandle offsetInFile]; + + if (fileSize >= maximumFileSize) + { + NSLogVerbose(@"DDFileLogger: Rolling log file due to size (%qu)...", fileSize); + + [self rollLogFileNow]; + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark File Logging +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * Returns the log file that should be used. + * If there is an existing log file that is suitable, + * within the constraints of maximumFileSize and rollingFrequency, then it is returned. + * + * Otherwise a new file is created and returned. +**/ +- (DDLogFileInfo *)currentLogFileInfo +{ + if (currentLogFileInfo == nil) + { + NSArray *sortedLogFileInfos = [logFileManager sortedLogFileInfos]; + + if ([sortedLogFileInfos count] > 0) + { + DDLogFileInfo *mostRecentLogFileInfo = [sortedLogFileInfos objectAtIndex:0]; + + BOOL useExistingLogFile = YES; + BOOL shouldArchiveMostRecent = NO; + + if (mostRecentLogFileInfo.isArchived) + { + useExistingLogFile = NO; + shouldArchiveMostRecent = NO; + } + else if (maximumFileSize > 0 && mostRecentLogFileInfo.fileSize >= maximumFileSize) + { + useExistingLogFile = NO; + shouldArchiveMostRecent = YES; + } + else if (rollingFrequency > 0.0 && mostRecentLogFileInfo.age >= rollingFrequency) + { + useExistingLogFile = NO; + shouldArchiveMostRecent = YES; + } + + if (useExistingLogFile) + { + NSLogVerbose(@"DDFileLogger: Resuming logging with file %@", mostRecentLogFileInfo.fileName); + + currentLogFileInfo = mostRecentLogFileInfo; + } + else + { + if (shouldArchiveMostRecent) + { + mostRecentLogFileInfo.isArchived = YES; + + if ([logFileManager respondsToSelector:@selector(didArchiveLogFile:)]) + { + [logFileManager didArchiveLogFile:(mostRecentLogFileInfo.filePath)]; + } + } + } + } + + if (currentLogFileInfo == nil) + { + NSString *currentLogFilePath = [logFileManager createNewLogFile]; + + currentLogFileInfo = [[DDLogFileInfo alloc] initWithFilePath:currentLogFilePath]; + } + } + + return currentLogFileInfo; +} + +- (NSFileHandle *)currentLogFileHandle +{ + if (currentLogFileHandle == nil) + { + NSString *logFilePath = [[self currentLogFileInfo] filePath]; + + currentLogFileHandle = [NSFileHandle fileHandleForWritingAtPath:logFilePath]; + [currentLogFileHandle seekToEndOfFile]; + + if (currentLogFileHandle) + { + [self scheduleTimerToRollLogFileDueToAge]; + } + } + + return currentLogFileHandle; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark DDLogger Protocol +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)logMessage:(DDLogMessage *)logMessage +{ + NSString *logMsg = logMessage->logMsg; + + if (formatter) + { + logMsg = [formatter formatLogMessage:logMessage]; + } + + if (logMsg) + { + if (![logMsg hasSuffix:@"\n"]) + { + logMsg = [logMsg stringByAppendingString:@"\n"]; + } + + NSData *logData = [logMsg dataUsingEncoding:NSUTF8StringEncoding]; + + [[self currentLogFileHandle] writeData:logData]; + + [self maybeRollLogFileDueToSize]; + } +} + +- (void)willRemoveLogger +{ + // If you override me be sure to invoke [super willRemoveLogger]; + + [self rollLogFileNow]; +} + +- (NSString *)loggerName +{ + return @"cocoa.lumberjack.fileLogger"; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#if TARGET_IPHONE_SIMULATOR + #define XATTR_ARCHIVED_NAME @"archived" +#else + #define XATTR_ARCHIVED_NAME @"lumberjack.log.archived" +#endif + +@implementation DDLogFileInfo + +@synthesize filePath; + +@dynamic fileName; +@dynamic fileAttributes; +@dynamic creationDate; +@dynamic modificationDate; +@dynamic fileSize; +@dynamic age; + +@dynamic isArchived; + + +#pragma mark Lifecycle + ++ (id)logFileWithPath:(NSString *)aFilePath +{ + return [[DDLogFileInfo alloc] initWithFilePath:aFilePath]; +} + +- (id)initWithFilePath:(NSString *)aFilePath +{ + if ((self = [super init])) + { + filePath = [aFilePath copy]; + } + return self; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Standard Info +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (NSDictionary *)fileAttributes +{ + if (fileAttributes == nil) + { + fileAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:filePath error:nil]; + } + return fileAttributes; +} + +- (NSString *)fileName +{ + if (fileName == nil) + { + fileName = [filePath lastPathComponent]; + } + return fileName; +} + +- (NSDate *)modificationDate +{ + if (modificationDate == nil) + { + modificationDate = [[self fileAttributes] objectForKey:NSFileModificationDate]; + } + + return modificationDate; +} + +- (NSDate *)creationDate +{ + if (creationDate == nil) + { + + #if TARGET_OS_IPHONE + + const char *path = [filePath UTF8String]; + + struct attrlist attrList; + memset(&attrList, 0, sizeof(attrList)); + attrList.bitmapcount = ATTR_BIT_MAP_COUNT; + attrList.commonattr = ATTR_CMN_CRTIME; + + struct { + u_int32_t attrBufferSizeInBytes; + struct timespec crtime; + } attrBuffer; + + int result = getattrlist(path, &attrList, &attrBuffer, sizeof(attrBuffer), 0); + if (result == 0) + { + double seconds = (double)(attrBuffer.crtime.tv_sec); + double nanos = (double)(attrBuffer.crtime.tv_nsec); + + NSTimeInterval ti = seconds + (nanos / 1000000000.0); + + creationDate = [NSDate dateWithTimeIntervalSince1970:ti]; + } + else + { + NSLogError(@"DDLogFileInfo: creationDate(%@): getattrlist result = %i", self.fileName, result); + } + + #else + + creationDate = [[self fileAttributes] objectForKey:NSFileCreationDate]; + + #endif + + } + return creationDate; +} + +- (unsigned long long)fileSize +{ + if (fileSize == 0) + { + fileSize = [[[self fileAttributes] objectForKey:NSFileSize] unsignedLongLongValue]; + } + + return fileSize; +} + +- (NSTimeInterval)age +{ + return [[self creationDate] timeIntervalSinceNow] * -1.0; +} + +- (NSString *)description +{ + return [@{@"filePath": self.filePath, + @"fileName": self.fileName, + @"fileAttributes": self.fileAttributes, + @"creationDate": self.creationDate, + @"modificationDate": self.modificationDate, + @"fileSize": @(self.fileSize), + @"age": @(self.age), + @"isArchived": @(self.isArchived)} description]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Archiving +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)isArchived +{ + +#if TARGET_IPHONE_SIMULATOR + + // Extended attributes don't work properly on the simulator. + // So we have to use a less attractive alternative. + // See full explanation in the header file. + + return [self hasExtensionAttributeWithName:XATTR_ARCHIVED_NAME]; + +#else + + return [self hasExtendedAttributeWithName:XATTR_ARCHIVED_NAME]; + +#endif +} + +- (void)setIsArchived:(BOOL)flag +{ + +#if TARGET_IPHONE_SIMULATOR + + // Extended attributes don't work properly on the simulator. + // So we have to use a less attractive alternative. + // See full explanation in the header file. + + if (flag) + [self addExtensionAttributeWithName:XATTR_ARCHIVED_NAME]; + else + [self removeExtensionAttributeWithName:XATTR_ARCHIVED_NAME]; + +#else + + if (flag) + [self addExtendedAttributeWithName:XATTR_ARCHIVED_NAME]; + else + [self removeExtendedAttributeWithName:XATTR_ARCHIVED_NAME]; + +#endif +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Changes +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (void)reset +{ + fileName = nil; + fileAttributes = nil; + creationDate = nil; + modificationDate = nil; +} + +- (void)renameFile:(NSString *)newFileName +{ + // This method is only used on the iPhone simulator, where normal extended attributes are broken. + // See full explanation in the header file. + + if (![newFileName isEqualToString:[self fileName]]) + { + NSString *fileDir = [filePath stringByDeletingLastPathComponent]; + + NSString *newFilePath = [fileDir stringByAppendingPathComponent:newFileName]; + + NSLogVerbose(@"DDLogFileInfo: Renaming file: '%@' -> '%@'", self.fileName, newFileName); + + NSError *error = nil; + if (![[NSFileManager defaultManager] moveItemAtPath:filePath toPath:newFilePath error:&error]) + { + NSLogError(@"DDLogFileInfo: Error renaming file (%@): %@", self.fileName, error); + } + + filePath = newFilePath; + [self reset]; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Attribute Management +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +#if TARGET_IPHONE_SIMULATOR + +// Extended attributes don't work properly on the simulator. +// So we have to use a less attractive alternative. +// See full explanation in the header file. + +- (BOOL)hasExtensionAttributeWithName:(NSString *)attrName +{ + // This method is only used on the iPhone simulator, where normal extended attributes are broken. + // See full explanation in the header file. + + // Split the file name into components. + // + // log-ABC123.archived.uploaded.txt + // + // 0. log-ABC123 + // 1. archived + // 2. uploaded + // 3. txt + // + // So we want to search for the attrName in the components (ignoring the first and last array indexes). + + NSArray *components = [[self fileName] componentsSeparatedByString:@"."]; + + // Watch out for file names without an extension + + NSUInteger count = [components count]; + NSUInteger max = (count >= 2) ? count-1 : count; + + NSUInteger i; + for (i = 1; i < max; i++) + { + NSString *attr = [components objectAtIndex:i]; + + if ([attrName isEqualToString:attr]) + { + return YES; + } + } + + return NO; +} + +- (void)addExtensionAttributeWithName:(NSString *)attrName +{ + // This method is only used on the iPhone simulator, where normal extended attributes are broken. + // See full explanation in the header file. + + if ([attrName length] == 0) return; + + // Example: + // attrName = "archived" + // + // "log-ABC123.txt" -> "log-ABC123.archived.txt" + + NSArray *components = [[self fileName] componentsSeparatedByString:@"."]; + + NSUInteger count = [components count]; + + NSUInteger estimatedNewLength = [[self fileName] length] + [attrName length] + 1; + NSMutableString *newFileName = [NSMutableString stringWithCapacity:estimatedNewLength]; + + if (count > 0) + { + [newFileName appendString:[components objectAtIndex:0]]; + } + + NSString *lastExt = @""; + + NSUInteger i; + for (i = 1; i < count; i++) + { + NSString *attr = [components objectAtIndex:i]; + if ([attr length] == 0) + { + continue; + } + + if ([attrName isEqualToString:attr]) + { + // Extension attribute already exists in file name + return; + } + + if ([lastExt length] > 0) + { + [newFileName appendFormat:@".%@", lastExt]; + } + + lastExt = attr; + } + + [newFileName appendFormat:@".%@", attrName]; + + if ([lastExt length] > 0) + { + [newFileName appendFormat:@".%@", lastExt]; + } + + [self renameFile:newFileName]; +} + +- (void)removeExtensionAttributeWithName:(NSString *)attrName +{ + // This method is only used on the iPhone simulator, where normal extended attributes are broken. + // See full explanation in the header file. + + if ([attrName length] == 0) return; + + // Example: + // attrName = "archived" + // + // "log-ABC123.txt" -> "log-ABC123.archived.txt" + + NSArray *components = [[self fileName] componentsSeparatedByString:@"."]; + + NSUInteger count = [components count]; + + NSUInteger estimatedNewLength = [[self fileName] length]; + NSMutableString *newFileName = [NSMutableString stringWithCapacity:estimatedNewLength]; + + if (count > 0) + { + [newFileName appendString:[components objectAtIndex:0]]; + } + + BOOL found = NO; + + NSUInteger i; + for (i = 1; i < count; i++) + { + NSString *attr = [components objectAtIndex:i]; + + if ([attrName isEqualToString:attr]) + { + found = YES; + } + else + { + [newFileName appendFormat:@".%@", attr]; + } + } + + if (found) + { + [self renameFile:newFileName]; + } +} + +#else + +- (BOOL)hasExtendedAttributeWithName:(NSString *)attrName +{ + const char *path = [filePath UTF8String]; + const char *name = [attrName UTF8String]; + + ssize_t result = getxattr(path, name, NULL, 0, 0, 0); + + return (result >= 0); +} + +- (void)addExtendedAttributeWithName:(NSString *)attrName +{ + const char *path = [filePath UTF8String]; + const char *name = [attrName UTF8String]; + + int result = setxattr(path, name, NULL, 0, 0, 0); + + if (result < 0) + { + NSLogError(@"DDLogFileInfo: setxattr(%@, %@): error = %i", attrName, self.fileName, result); + } +} + +- (void)removeExtendedAttributeWithName:(NSString *)attrName +{ + const char *path = [filePath UTF8String]; + const char *name = [attrName UTF8String]; + + int result = removexattr(path, name, 0); + + if (result < 0 && errno != ENOATTR) + { + NSLogError(@"DDLogFileInfo: removexattr(%@, %@): error = %i", attrName, self.fileName, result); + } +} + +#endif + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Comparisons +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (BOOL)isEqual:(id)object +{ + if ([object isKindOfClass:[self class]]) + { + DDLogFileInfo *another = (DDLogFileInfo *)object; + + return [filePath isEqualToString:[another filePath]]; + } + + return NO; +} + +- (NSComparisonResult)reverseCompareByCreationDate:(DDLogFileInfo *)another +{ + NSDate *us = [self creationDate]; + NSDate *them = [another creationDate]; + + NSComparisonResult result = [us compare:them]; + + if (result == NSOrderedAscending) + return NSOrderedDescending; + + if (result == NSOrderedDescending) + return NSOrderedAscending; + + return NSOrderedSame; +} + +- (NSComparisonResult)reverseCompareByModificationDate:(DDLogFileInfo *)another +{ + NSDate *us = [self modificationDate]; + NSDate *them = [another modificationDate]; + + NSComparisonResult result = [us compare:them]; + + if (result == NSOrderedAscending) + return NSOrderedDescending; + + if (result == NSOrderedDescending) + return NSOrderedAscending; + + return NSOrderedSame; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.h new file mode 100755 index 00000000000..5da184938ee --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.h @@ -0,0 +1,601 @@ +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * Otherwise, here is a quick refresher. + * There are three steps to using the macros: + * + * Step 1: + * Import the header in your implementation file: + * + * #import "DDLog.h" + * + * Step 2: + * Define your logging level in your implementation file: + * + * // Log levels: off, error, warn, info, verbose + * static const int ddLogLevel = LOG_LEVEL_VERBOSE; + * + * Step 3: + * Replace your NSLog statements with DDLog statements according to the severity of the message. + * + * NSLog(@"Fatal error, no dohickey found!"); -> DDLogError(@"Fatal error, no dohickey found!"); + * + * DDLog works exactly the same as NSLog. + * This means you can pass it multiple variables just like NSLog. +**/ + + +@class DDLogMessage; + +@protocol DDLogger; +@protocol DDLogFormatter; + +/** + * This is the single macro that all other macros below compile into. + * This big multiline macro makes all the other macros easier to read. +**/ + +#define LOG_MACRO(isAsynchronous, lvl, flg, ctx, atag, fnct, frmt, ...) \ + [DDLog log:isAsynchronous \ + level:lvl \ + flag:flg \ + context:ctx \ + file:__FILE__ \ + function:fnct \ + line:__LINE__ \ + tag:atag \ + format:(frmt), ##__VA_ARGS__] + +/** + * Define the Objective-C and C versions of the macro. + * These automatically inject the proper function name for either an objective-c method or c function. + * + * We also define shorthand versions for asynchronous and synchronous logging. +**/ + +#define LOG_OBJC_MACRO(async, lvl, flg, ctx, frmt, ...) \ + LOG_MACRO(async, lvl, flg, ctx, nil, sel_getName(_cmd), frmt, ##__VA_ARGS__) + +#define LOG_C_MACRO(async, lvl, flg, ctx, frmt, ...) \ + LOG_MACRO(async, lvl, flg, ctx, nil, __FUNCTION__, frmt, ##__VA_ARGS__) + +#define SYNC_LOG_OBJC_MACRO(lvl, flg, ctx, frmt, ...) \ + LOG_OBJC_MACRO( NO, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +#define ASYNC_LOG_OBJC_MACRO(lvl, flg, ctx, frmt, ...) \ + LOG_OBJC_MACRO(YES, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +#define SYNC_LOG_C_MACRO(lvl, flg, ctx, frmt, ...) \ + LOG_C_MACRO( NO, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +#define ASYNC_LOG_C_MACRO(lvl, flg, ctx, frmt, ...) \ + LOG_C_MACRO(YES, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +/** + * Define version of the macro that only execute if the logLevel is above the threshold. + * The compiled versions essentially look like this: + * + * if (logFlagForThisLogMsg & ddLogLevel) { execute log message } + * + * As shown further below, Lumberjack actually uses a bitmask as opposed to primitive log levels. + * This allows for a great amount of flexibility and some pretty advanced fine grained logging techniques. + * + * Note that when compiler optimizations are enabled (as they are for your release builds), + * the log messages above your logging threshold will automatically be compiled out. + * + * (If the compiler sees ddLogLevel declared as a constant, the compiler simply checks to see if the 'if' statement + * would execute, and if not it strips it from the binary.) + * + * We also define shorthand versions for asynchronous and synchronous logging. +**/ + +#define LOG_MAYBE(async, lvl, flg, ctx, fnct, frmt, ...) \ + do { if(lvl & flg) LOG_MACRO(async, lvl, flg, ctx, nil, fnct, frmt, ##__VA_ARGS__); } while(0) + +#define LOG_OBJC_MAYBE(async, lvl, flg, ctx, frmt, ...) \ + LOG_MAYBE(async, lvl, flg, ctx, sel_getName(_cmd), frmt, ##__VA_ARGS__) + +#define LOG_C_MAYBE(async, lvl, flg, ctx, frmt, ...) \ + LOG_MAYBE(async, lvl, flg, ctx, __FUNCTION__, frmt, ##__VA_ARGS__) + +#define SYNC_LOG_OBJC_MAYBE(lvl, flg, ctx, frmt, ...) \ + LOG_OBJC_MAYBE( NO, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +#define ASYNC_LOG_OBJC_MAYBE(lvl, flg, ctx, frmt, ...) \ + LOG_OBJC_MAYBE(YES, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +#define SYNC_LOG_C_MAYBE(lvl, flg, ctx, frmt, ...) \ + LOG_C_MAYBE( NO, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +#define ASYNC_LOG_C_MAYBE(lvl, flg, ctx, frmt, ...) \ + LOG_C_MAYBE(YES, lvl, flg, ctx, frmt, ##__VA_ARGS__) + +/** + * Define versions of the macros that also accept tags. + * + * The DDLogMessage object includes a 'tag' ivar that may be used for a variety of purposes. + * It may be used to pass custom information to loggers or formatters. + * Or it may be used by 3rd party extensions to the framework. + * + * Thes macros just make it a little easier to extend logging functionality. +**/ + +#define LOG_OBJC_TAG_MACRO(async, lvl, flg, ctx, tag, frmt, ...) \ + LOG_MACRO(async, lvl, flg, ctx, tag, sel_getName(_cmd), frmt, ##__VA_ARGS__) + +#define LOG_C_TAG_MACRO(async, lvl, flg, ctx, tag, frmt, ...) \ + LOG_MACRO(async, lvl, flg, ctx, tag, __FUNCTION__, frmt, ##__VA_ARGS__) + +#define LOG_TAG_MAYBE(async, lvl, flg, ctx, tag, fnct, frmt, ...) \ + do { if(lvl & flg) LOG_MACRO(async, lvl, flg, ctx, tag, fnct, frmt, ##__VA_ARGS__); } while(0) + +#define LOG_OBJC_TAG_MAYBE(async, lvl, flg, ctx, tag, frmt, ...) \ + LOG_TAG_MAYBE(async, lvl, flg, ctx, tag, sel_getName(_cmd), frmt, ##__VA_ARGS__) + +#define LOG_C_TAG_MAYBE(async, lvl, flg, ctx, tag, frmt, ...) \ + LOG_TAG_MAYBE(async, lvl, flg, ctx, tag, __FUNCTION__, frmt, ##__VA_ARGS__) + +/** + * Define the standard options. + * + * We default to only 4 levels because it makes it easier for beginners + * to make the transition to a logging framework. + * + * More advanced users may choose to completely customize the levels (and level names) to suite their needs. + * For more information on this see the "Custom Log Levels" page: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomLogLevels + * + * Advanced users may also notice that we're using a bitmask. + * This is to allow for custom fine grained logging: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/FineGrainedLogging + * + * -- Flags -- + * + * Typically you will use the LOG_LEVELS (see below), but the flags may be used directly in certain situations. + * For example, say you have a lot of warning log messages, and you wanted to disable them. + * However, you still needed to see your error and info log messages. + * You could accomplish that with the following: + * + * static const int ddLogLevel = LOG_FLAG_ERROR | LOG_FLAG_INFO; + * + * Flags may also be consulted when writing custom log formatters, + * as the DDLogMessage class captures the individual flag that caused the log message to fire. + * + * -- Levels -- + * + * Log levels are simply the proper bitmask of the flags. + * + * -- Booleans -- + * + * The booleans may be used when your logging code involves more than one line. + * For example: + * + * if (LOG_VERBOSE) { + * for (id sprocket in sprockets) + * DDLogVerbose(@"sprocket: %@", [sprocket description]) + * } + * + * -- Async -- + * + * Defines the default asynchronous options. + * The default philosophy for asynchronous logging is very simple: + * + * Log messages with errors should be executed synchronously. + * After all, an error just occurred. The application could be unstable. + * + * All other log messages, such as debug output, are executed asynchronously. + * After all, if it wasn't an error, then it was just informational output, + * or something the application was easily able to recover from. + * + * -- Changes -- + * + * You are strongly discouraged from modifying this file. + * If you do, you make it more difficult on yourself to merge future bug fixes and improvements from the project. + * Instead, create your own MyLogging.h or ApplicationNameLogging.h or CompanyLogging.h + * + * For an example of customizing your logging experience, see the "Custom Log Levels" page: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomLogLevels +**/ + +#define LOG_FLAG_ERROR (1 << 0) // 0...0001 +#define LOG_FLAG_WARN (1 << 1) // 0...0010 +#define LOG_FLAG_INFO (1 << 2) // 0...0100 +#define LOG_FLAG_VERBOSE (1 << 3) // 0...1000 + +#define LOG_LEVEL_OFF 0 +#define LOG_LEVEL_ERROR (LOG_FLAG_ERROR) // 0...0001 +#define LOG_LEVEL_WARN (LOG_FLAG_ERROR | LOG_FLAG_WARN) // 0...0011 +#define LOG_LEVEL_INFO (LOG_FLAG_ERROR | LOG_FLAG_WARN | LOG_FLAG_INFO) // 0...0111 +#define LOG_LEVEL_VERBOSE (LOG_FLAG_ERROR | LOG_FLAG_WARN | LOG_FLAG_INFO | LOG_FLAG_VERBOSE) // 0...1111 + +#define LOG_ERROR (ddLogLevel & LOG_FLAG_ERROR) +#define LOG_WARN (ddLogLevel & LOG_FLAG_WARN) +#define LOG_INFO (ddLogLevel & LOG_FLAG_INFO) +#define LOG_VERBOSE (ddLogLevel & LOG_FLAG_VERBOSE) + +#define LOG_ASYNC_ENABLED YES + +#define LOG_ASYNC_ERROR ( NO && LOG_ASYNC_ENABLED) +#define LOG_ASYNC_WARN (YES && LOG_ASYNC_ENABLED) +#define LOG_ASYNC_INFO (YES && LOG_ASYNC_ENABLED) +#define LOG_ASYNC_VERBOSE (YES && LOG_ASYNC_ENABLED) + +#define DDLogError(frmt, ...) LOG_OBJC_MAYBE(LOG_ASYNC_ERROR, ddLogLevel, LOG_FLAG_ERROR, 0, frmt, ##__VA_ARGS__) +#define DDLogWarn(frmt, ...) LOG_OBJC_MAYBE(LOG_ASYNC_WARN, ddLogLevel, LOG_FLAG_WARN, 0, frmt, ##__VA_ARGS__) +#define DDLogInfo(frmt, ...) LOG_OBJC_MAYBE(LOG_ASYNC_INFO, ddLogLevel, LOG_FLAG_INFO, 0, frmt, ##__VA_ARGS__) +#define DDLogVerbose(frmt, ...) LOG_OBJC_MAYBE(LOG_ASYNC_VERBOSE, ddLogLevel, LOG_FLAG_VERBOSE, 0, frmt, ##__VA_ARGS__) + +#define DDLogCError(frmt, ...) LOG_C_MAYBE(LOG_ASYNC_ERROR, ddLogLevel, LOG_FLAG_ERROR, 0, frmt, ##__VA_ARGS__) +#define DDLogCWarn(frmt, ...) LOG_C_MAYBE(LOG_ASYNC_WARN, ddLogLevel, LOG_FLAG_WARN, 0, frmt, ##__VA_ARGS__) +#define DDLogCInfo(frmt, ...) LOG_C_MAYBE(LOG_ASYNC_INFO, ddLogLevel, LOG_FLAG_INFO, 0, frmt, ##__VA_ARGS__) +#define DDLogCVerbose(frmt, ...) LOG_C_MAYBE(LOG_ASYNC_VERBOSE, ddLogLevel, LOG_FLAG_VERBOSE, 0, frmt, ##__VA_ARGS__) + +/** + * The THIS_FILE macro gives you an NSString of the file name. + * For simplicity and clarity, the file name does not include the full path or file extension. + * + * For example: DDLogWarn(@"%@: Unable to find thingy", THIS_FILE) -> @"MyViewController: Unable to find thingy" +**/ + +NSString *DDExtractFileNameWithoutExtension(const char *filePath, BOOL copy); + +#define THIS_FILE (DDExtractFileNameWithoutExtension(__FILE__, NO)) + +/** + * The THIS_METHOD macro gives you the name of the current objective-c method. + * + * For example: DDLogWarn(@"%@ - Requires non-nil strings", THIS_METHOD) -> @"setMake:model: requires non-nil strings" + * + * Note: This does NOT work in straight C functions (non objective-c). + * Instead you should use the predefined __FUNCTION__ macro. +**/ + +#define THIS_METHOD NSStringFromSelector(_cmd) + + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@interface DDLog : NSObject + +/** + * Provides access to the underlying logging queue. + * This may be helpful to Logger classes for things like thread synchronization. +**/ + ++ (dispatch_queue_t)loggingQueue; + +/** + * Logging Primitive. + * + * This method is used by the macros above. + * It is suggested you stick with the macros as they're easier to use. +**/ + ++ (void)log:(BOOL)synchronous + level:(int)level + flag:(int)flag + context:(int)context + file:(const char *)file + function:(const char *)function + line:(int)line + tag:(id)tag + format:(NSString *)format, ... __attribute__ ((format (__NSString__, 9, 10))); + +/** + * Logging Primitive. + * + * This method can be used if you have a prepared va_list. +**/ + ++ (void)log:(BOOL)asynchronous + level:(int)level + flag:(int)flag + context:(int)context + file:(const char *)file + function:(const char *)function + line:(int)line + tag:(id)tag + format:(NSString *)format + args:(va_list)argList; + + +/** + * Since logging can be asynchronous, there may be times when you want to flush the logs. + * The framework invokes this automatically when the application quits. +**/ + ++ (void)flushLog; + +/** + * Loggers + * + * If you want your log statements to go somewhere, + * you should create and add a logger. +**/ + ++ (void)addLogger:(id )logger; ++ (void)removeLogger:(id )logger; + ++ (void)removeAllLoggers; + +/** + * Registered Dynamic Logging + * + * These methods allow you to obtain a list of classes that are using registered dynamic logging, + * and also provides methods to get and set their log level during run time. +**/ + ++ (NSArray *)registeredClasses; ++ (NSArray *)registeredClassNames; + ++ (int)logLevelForClass:(Class)aClass; ++ (int)logLevelForClassWithName:(NSString *)aClassName; + ++ (void)setLogLevel:(int)logLevel forClass:(Class)aClass; ++ (void)setLogLevel:(int)logLevel forClassWithName:(NSString *)aClassName; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@protocol DDLogger +@required + +- (void)logMessage:(DDLogMessage *)logMessage; + +/** + * Formatters may optionally be added to any logger. + * + * If no formatter is set, the logger simply logs the message as it is given in logMessage, + * or it may use its own built in formatting style. +**/ +- (id )logFormatter; +- (void)setLogFormatter:(id )formatter; + +@optional + +/** + * Since logging is asynchronous, adding and removing loggers is also asynchronous. + * In other words, the loggers are added and removed at appropriate times with regards to log messages. + * + * - Loggers will not receive log messages that were executed prior to when they were added. + * - Loggers will not receive log messages that were executed after they were removed. + * + * These methods are executed in the logging thread/queue. + * This is the same thread/queue that will execute every logMessage: invocation. + * Loggers may use these methods for thread synchronization or other setup/teardown tasks. +**/ +- (void)didAddLogger; +- (void)willRemoveLogger; + +/** + * Some loggers may buffer IO for optimization purposes. + * For example, a database logger may only save occasionaly as the disk IO is slow. + * In such loggers, this method should be implemented to flush any pending IO. + * + * This allows invocations of DDLog's flushLog method to be propogated to loggers that need it. + * + * Note that DDLog's flushLog method is invoked automatically when the application quits, + * and it may be also invoked manually by the developer prior to application crashes, or other such reasons. +**/ +- (void)flush; + +/** + * Each logger is executed concurrently with respect to the other loggers. + * Thus, a dedicated dispatch queue is used for each logger. + * Logger implementations may optionally choose to provide their own dispatch queue. +**/ +- (dispatch_queue_t)loggerQueue; + +/** + * If the logger implementation does not choose to provide its own queue, + * one will automatically be created for it. + * The created queue will receive its name from this method. + * This may be helpful for debugging or profiling reasons. +**/ +- (NSString *)loggerName; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@protocol DDLogFormatter +@required + +/** + * Formatters may optionally be added to any logger. + * This allows for increased flexibility in the logging environment. + * For example, log messages for log files may be formatted differently than log messages for the console. + * + * For more information about formatters, see the "Custom Formatters" page: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomFormatters + * + * The formatter may also optionally filter the log message by returning nil, + * in which case the logger will not log the message. +**/ +- (NSString *)formatLogMessage:(DDLogMessage *)logMessage; + +@optional + +/** + * A single formatter instance can be added to multiple loggers. + * These methods provides hooks to notify the formatter of when it's added/removed. + * + * This is primarily for thread-safety. + * If a formatter is explicitly not thread-safe, it may wish to throw an exception if added to multiple loggers. + * Or if a formatter has potentially thread-unsafe code (e.g. NSDateFormatter), + * it could possibly use these hooks to switch to thread-safe versions of the code. +**/ +- (void)didAddToLogger:(id )logger; +- (void)willRemoveFromLogger:(id )logger; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@protocol DDRegisteredDynamicLogging + +/** + * Implement these methods to allow a file's log level to be managed from a central location. + * + * This is useful if you'd like to be able to change log levels for various parts + * of your code from within the running application. + * + * Imagine pulling up the settings for your application, + * and being able to configure the logging level on a per file basis. + * + * The implementation can be very straight-forward: + * + * + (int)ddLogLevel + * { + * return ddLogLevel; + * } + * + * + (void)ddSetLogLevel:(int)logLevel + * { + * ddLogLevel = logLevel; + * } +**/ + ++ (int)ddLogLevel; ++ (void)ddSetLogLevel:(int)logLevel; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * The DDLogMessage class encapsulates information about the log message. + * If you write custom loggers or formatters, you will be dealing with objects of this class. +**/ + +enum { + DDLogMessageCopyFile = 1 << 0, + DDLogMessageCopyFunction = 1 << 1 +}; +typedef int DDLogMessageOptions; + +@interface DDLogMessage : NSObject +{ + +// The public variables below can be accessed directly (for speed). +// For example: logMessage->logLevel + +@public + int logLevel; + int logFlag; + int logContext; + NSString *logMsg; + NSDate *timestamp; + char *file; + char *function; + int lineNumber; + mach_port_t machThreadID; + char *queueLabel; + NSString *threadName; + + // For 3rd party extensions to the framework, where flags and contexts aren't enough. + id tag; + + // For 3rd party extensions that manually create DDLogMessage instances. + DDLogMessageOptions options; +} + +/** + * Standard init method for a log message object. + * Used by the logging primitives. (And the macros use the logging primitives.) + * + * If you find need to manually create logMessage objects, there is one thing you should be aware of: + * + * If no flags are passed, the method expects the file and function parameters to be string literals. + * That is, it expects the given strings to exist for the duration of the object's lifetime, + * and it expects the given strings to be immutable. + * In other words, it does not copy these strings, it simply points to them. + * This is due to the fact that __FILE__ and __FUNCTION__ are usually used to specify these parameters, + * so it makes sense to optimize and skip the unnecessary allocations. + * However, if you need them to be copied you may use the options parameter to specify this. + * Options is a bitmask which supports DDLogMessageCopyFile and DDLogMessageCopyFunction. +**/ +- (id)initWithLogMsg:(NSString *)logMsg + level:(int)logLevel + flag:(int)logFlag + context:(int)logContext + file:(const char *)file + function:(const char *)function + line:(int)line + tag:(id)tag + options:(DDLogMessageOptions)optionsMask; + +/** + * Returns the threadID as it appears in NSLog. + * That is, it is a hexadecimal value which is calculated from the machThreadID. +**/ +- (NSString *)threadID; + +/** + * Convenience property to get just the file name, as the file variable is generally the full file path. + * This method does not include the file extension, which is generally unwanted for logging purposes. +**/ +- (NSString *)fileName; + +/** + * Returns the function variable in NSString form. +**/ +- (NSString *)methodName; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * The DDLogger protocol specifies that an optional formatter can be added to a logger. + * Most (but not all) loggers will want to support formatters. + * + * However, writting getters and setters in a thread safe manner, + * while still maintaining maximum speed for the logging process, is a difficult task. + * + * To do it right, the implementation of the getter/setter has strict requiremenets: + * - Must NOT require the logMessage method to acquire a lock. + * - Must NOT require the logMessage method to access an atomic property (also a lock of sorts). + * + * To simplify things, an abstract logger is provided that implements the getter and setter. + * + * Logger implementations may simply extend this class, + * and they can ACCESS THE FORMATTER VARIABLE DIRECTLY from within their logMessage method! +**/ + +@interface DDAbstractLogger : NSObject +{ + id formatter; + + dispatch_queue_t loggerQueue; +} + +- (id )logFormatter; +- (void)setLogFormatter:(id )formatter; + +// For thread-safety assertions +- (BOOL)isOnGlobalLoggingQueue; +- (BOOL)isOnInternalLoggerQueue; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.m new file mode 100755 index 00000000000..1e1ddd6143c --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.m @@ -0,0 +1,1083 @@ +#import "DDLog.h" + +#import +#import +#import +#import +#import + + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// We probably shouldn't be using DDLog() statements within the DDLog implementation. +// But we still want to leave our log statements for any future debugging, +// and to allow other developers to trace the implementation (which is a great learning tool). +// +// So we use a primitive logging macro around NSLog. +// We maintain the NS prefix on the macros to be explicit about the fact that we're using NSLog. + +#define DD_DEBUG NO + +#define NSLogDebug(frmt, ...) do{ if(DD_DEBUG) NSLog((frmt), ##__VA_ARGS__); } while(0) + +// Specifies the maximum queue size of the logging thread. +// +// Since most logging is asynchronous, its possible for rogue threads to flood the logging queue. +// That is, to issue an abundance of log statements faster than the logging thread can keepup. +// Typically such a scenario occurs when log statements are added haphazardly within large loops, +// but may also be possible if relatively slow loggers are being used. +// +// This property caps the queue size at a given number of outstanding log statements. +// If a thread attempts to issue a log statement when the queue is already maxed out, +// the issuing thread will block until the queue size drops below the max again. + +#define LOG_MAX_QUEUE_SIZE 1000 // Should not exceed INT32_MAX + +// The "global logging queue" refers to [DDLog loggingQueue]. +// It is the queue that all log statements go through. +// +// The logging queue sets a flag via dispatch_queue_set_specific using this key. +// We can check for this key via dispatch_get_specific() to see if we're on the "global logging queue". + +static void *const GlobalLoggingQueueIdentityKey = (void *)&GlobalLoggingQueueIdentityKey; + + +@interface DDLoggerNode : NSObject { +@public + id logger; + dispatch_queue_t loggerQueue; +} + ++ (DDLoggerNode *)nodeWithLogger:(id )logger loggerQueue:(dispatch_queue_t)loggerQueue; + +@end + + +@interface DDLog (PrivateAPI) + ++ (void)lt_addLogger:(id )logger; ++ (void)lt_removeLogger:(id )logger; ++ (void)lt_removeAllLoggers; ++ (void)lt_log:(DDLogMessage *)logMessage; ++ (void)lt_flush; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDLog + +// An array used to manage all the individual loggers. +// The array is only modified on the loggingQueue/loggingThread. +static NSMutableArray *loggers; + +// All logging statements are added to the same queue to ensure FIFO operation. +static dispatch_queue_t loggingQueue; + +// Individual loggers are executed concurrently per log statement. +// Each logger has it's own associated queue, and a dispatch group is used for synchrnoization. +static dispatch_group_t loggingGroup; + +// In order to prevent to queue from growing infinitely large, +// a maximum size is enforced (LOG_MAX_QUEUE_SIZE). +static dispatch_semaphore_t queueSemaphore; + +// Minor optimization for uniprocessor machines +static unsigned int numProcessors; + +/** + * The runtime sends initialize to each class in a program exactly one time just before the class, + * or any class that inherits from it, is sent its first message from within the program. (Thus the + * method may never be invoked if the class is not used.) The runtime sends the initialize message to + * classes in a thread-safe manner. Superclasses receive this message before their subclasses. + * + * This method may also be called directly (assumably by accident), hence the safety mechanism. +**/ ++ (void)initialize +{ + static BOOL initialized = NO; + if (!initialized) + { + initialized = YES; + + loggers = [[NSMutableArray alloc] initWithCapacity:4]; + + NSLogDebug(@"DDLog: Using grand central dispatch"); + + loggingQueue = dispatch_queue_create("cocoa.lumberjack", NULL); + loggingGroup = dispatch_group_create(); + + void *nonNullValue = GlobalLoggingQueueIdentityKey; // Whatever, just not null + dispatch_queue_set_specific(loggingQueue, GlobalLoggingQueueIdentityKey, nonNullValue, NULL); + + queueSemaphore = dispatch_semaphore_create(LOG_MAX_QUEUE_SIZE); + + // Figure out how many processors are available. + // This may be used later for an optimization on uniprocessor machines. + + host_basic_info_data_t hostInfo; + mach_msg_type_number_t infoCount; + + infoCount = HOST_BASIC_INFO_COUNT; + host_info(mach_host_self(), HOST_BASIC_INFO, (host_info_t)&hostInfo, &infoCount); + + unsigned int result = (unsigned int)(hostInfo.max_cpus); + unsigned int one = (unsigned int)(1); + + numProcessors = MAX(result, one); + + NSLogDebug(@"DDLog: numProcessors = %u", numProcessors); + + + #if TARGET_OS_IPHONE + NSString *notificationName = @"UIApplicationWillTerminateNotification"; + #else + NSString *notificationName = @"NSApplicationWillTerminateNotification"; + #endif + + [[NSNotificationCenter defaultCenter] addObserver:self + selector:@selector(applicationWillTerminate:) + name:notificationName + object:nil]; + } +} + +/** + * Provides access to the logging queue. +**/ ++ (dispatch_queue_t)loggingQueue +{ + return loggingQueue; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Notifications +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + ++ (void)applicationWillTerminate:(NSNotification *)notification +{ + [self flushLog]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Logger Management +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + ++ (void)addLogger:(id )logger +{ + if (logger == nil) return; + + dispatch_async(loggingQueue, ^{ @autoreleasepool { + + [self lt_addLogger:logger]; + }}); +} + ++ (void)removeLogger:(id )logger +{ + if (logger == nil) return; + + dispatch_async(loggingQueue, ^{ @autoreleasepool { + + [self lt_removeLogger:logger]; + }}); +} + ++ (void)removeAllLoggers +{ + dispatch_async(loggingQueue, ^{ @autoreleasepool { + + [self lt_removeAllLoggers]; + }}); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Master Logging +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + ++ (void)queueLogMessage:(DDLogMessage *)logMessage asynchronously:(BOOL)asyncFlag +{ + // We have a tricky situation here... + // + // In the common case, when the queueSize is below the maximumQueueSize, + // we want to simply enqueue the logMessage. And we want to do this as fast as possible, + // which means we don't want to block and we don't want to use any locks. + // + // However, if the queueSize gets too big, we want to block. + // But we have very strict requirements as to when we block, and how long we block. + // + // The following example should help illustrate our requirements: + // + // Imagine that the maximum queue size is configured to be 5, + // and that there are already 5 log messages queued. + // Let us call these 5 queued log messages A, B, C, D, and E. (A is next to be executed) + // + // Now if our thread issues a log statement (let us call the log message F), + // it should block before the message is added to the queue. + // Furthermore, it should be unblocked immediately after A has been unqueued. + // + // The requirements are strict in this manner so that we block only as long as necessary, + // and so that blocked threads are unblocked in the order in which they were blocked. + // + // Returning to our previous example, let us assume that log messages A through E are still queued. + // Our aforementioned thread is blocked attempting to queue log message F. + // Now assume we have another separate thread that attempts to issue log message G. + // It should block until log messages A and B have been unqueued. + + + // We are using a counting semaphore provided by GCD. + // The semaphore is initialized with our LOG_MAX_QUEUE_SIZE value. + // Everytime we want to queue a log message we decrement this value. + // If the resulting value is less than zero, + // the semaphore function waits in FIFO order for a signal to occur before returning. + // + // A dispatch semaphore is an efficient implementation of a traditional counting semaphore. + // Dispatch semaphores call down to the kernel only when the calling thread needs to be blocked. + // If the calling semaphore does not need to block, no kernel call is made. + + dispatch_semaphore_wait(queueSemaphore, DISPATCH_TIME_FOREVER); + + // We've now sure we won't overflow the queue. + // It is time to queue our log message. + + dispatch_block_t logBlock = ^{ @autoreleasepool { + + [self lt_log:logMessage]; + }}; + + if (asyncFlag) + dispatch_async(loggingQueue, logBlock); + else + dispatch_sync(loggingQueue, logBlock); +} + ++ (void)log:(BOOL)asynchronous + level:(int)level + flag:(int)flag + context:(int)context + file:(const char *)file + function:(const char *)function + line:(int)line + tag:(id)tag + format:(NSString *)format, ... +{ + va_list args; + if (format) + { + va_start(args, format); + + NSString *logMsg = [[NSString alloc] initWithFormat:format arguments:args]; + DDLogMessage *logMessage = [[DDLogMessage alloc] initWithLogMsg:logMsg + level:level + flag:flag + context:context + file:file + function:function + line:line + tag:tag + options:0]; + + [self queueLogMessage:logMessage asynchronously:asynchronous]; + + va_end(args); + } +} + ++ (void)log:(BOOL)asynchronous + level:(int)level + flag:(int)flag + context:(int)context + file:(const char *)file + function:(const char *)function + line:(int)line + tag:(id)tag + format:(NSString *)format + args:(va_list)args +{ + if (format) + { + NSString *logMsg = [[NSString alloc] initWithFormat:format arguments:args]; + DDLogMessage *logMessage = [[DDLogMessage alloc] initWithLogMsg:logMsg + level:level + flag:flag + context:context + file:file + function:function + line:line + tag:tag + options:0]; + + [self queueLogMessage:logMessage asynchronously:asynchronous]; + } +} + ++ (void)flushLog +{ + dispatch_sync(loggingQueue, ^{ @autoreleasepool { + + [self lt_flush]; + }}); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Registered Dynamic Logging +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + ++ (BOOL)isRegisteredClass:(Class)class +{ + SEL getterSel = @selector(ddLogLevel); + SEL setterSel = @selector(ddSetLogLevel:); + +#if TARGET_OS_IPHONE && !TARGET_IPHONE_SIMULATOR + + // Issue #6 (GoogleCode) - Crashes on iOS 4.2.1 and iPhone 4 + // + // Crash caused by class_getClassMethod(2). + // + // "It's a bug with UIAccessibilitySafeCategory__NSObject so it didn't pop up until + // users had VoiceOver enabled [...]. I was able to work around it by searching the + // result of class_copyMethodList() instead of calling class_getClassMethod()" + + BOOL result = NO; + + unsigned int methodCount, i; + Method *methodList = class_copyMethodList(object_getClass(class), &methodCount); + + if (methodList != NULL) + { + BOOL getterFound = NO; + BOOL setterFound = NO; + + for (i = 0; i < methodCount; ++i) + { + SEL currentSel = method_getName(methodList[i]); + + if (currentSel == getterSel) + { + getterFound = YES; + } + else if (currentSel == setterSel) + { + setterFound = YES; + } + + if (getterFound && setterFound) + { + result = YES; + break; + } + } + + free(methodList); + } + + return result; + +#else + + // Issue #24 (GitHub) - Crashing in in ARC+Simulator + // + // The method +[DDLog isRegisteredClass] will crash a project when using it with ARC + Simulator. + // For running in the Simulator, it needs to execute the non-iOS code. + + Method getter = class_getClassMethod(class, getterSel); + Method setter = class_getClassMethod(class, setterSel); + + if ((getter != NULL) && (setter != NULL)) + { + return YES; + } + + return NO; + +#endif +} + ++ (NSArray *)registeredClasses +{ + int numClasses, i; + + // We're going to get the list of all registered classes. + // The Objective-C runtime library automatically registers all the classes defined in your source code. + // + // To do this we use the following method (documented in the Objective-C Runtime Reference): + // + // int objc_getClassList(Class *buffer, int bufferLen) + // + // We can pass (NULL, 0) to obtain the total number of + // registered class definitions without actually retrieving any class definitions. + // This allows us to allocate the minimum amount of memory needed for the application. + + numClasses = objc_getClassList(NULL, 0); + + // The numClasses method now tells us how many classes we have. + // So we can allocate our buffer, and get pointers to all the class definitions. + + Class *classes = (Class *)malloc(sizeof(Class) * numClasses); + + numClasses = objc_getClassList(classes, numClasses); + + // We can now loop through the classes, and test each one to see if it is a DDLogging class. + + NSMutableArray *result = [NSMutableArray arrayWithCapacity:numClasses]; + + for (i = 0; i < numClasses; i++) + { + Class class = classes[i]; + + if ([self isRegisteredClass:class]) + { + [result addObject:class]; + } + } + + free(classes); + + return result; +} + ++ (NSArray *)registeredClassNames +{ + NSArray *registeredClasses = [self registeredClasses]; + NSMutableArray *result = [NSMutableArray arrayWithCapacity:[registeredClasses count]]; + + for (Class class in registeredClasses) + { + [result addObject:NSStringFromClass(class)]; + } + + return result; +} + ++ (int)logLevelForClass:(Class)aClass +{ + if ([self isRegisteredClass:aClass]) + { + return [aClass ddLogLevel]; + } + + return -1; +} + ++ (int)logLevelForClassWithName:(NSString *)aClassName +{ + Class aClass = NSClassFromString(aClassName); + + return [self logLevelForClass:aClass]; +} + ++ (void)setLogLevel:(int)logLevel forClass:(Class)aClass +{ + if ([self isRegisteredClass:aClass]) + { + [aClass ddSetLogLevel:logLevel]; + } +} + ++ (void)setLogLevel:(int)logLevel forClassWithName:(NSString *)aClassName +{ + Class aClass = NSClassFromString(aClassName); + + [self setLogLevel:logLevel forClass:aClass]; +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Logging Thread +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This method should only be run on the logging thread/queue. +**/ ++ (void)lt_addLogger:(id )logger +{ + // Add to loggers array. + // Need to create loggerQueue if loggerNode doesn't provide one. + + dispatch_queue_t loggerQueue = NULL; + + if ([logger respondsToSelector:@selector(loggerQueue)]) + { + // Logger may be providing its own queue + + loggerQueue = [logger loggerQueue]; + } + + if (loggerQueue == nil) + { + // Automatically create queue for the logger. + // Use the logger name as the queue name if possible. + + const char *loggerQueueName = NULL; + if ([logger respondsToSelector:@selector(loggerName)]) + { + loggerQueueName = [[logger loggerName] UTF8String]; + } + + loggerQueue = dispatch_queue_create(loggerQueueName, NULL); + } + + DDLoggerNode *loggerNode = [DDLoggerNode nodeWithLogger:logger loggerQueue:loggerQueue]; + [loggers addObject:loggerNode]; + + if ([logger respondsToSelector:@selector(didAddLogger)]) + { + dispatch_async(loggerNode->loggerQueue, ^{ @autoreleasepool { + + [logger didAddLogger]; + }}); + } +} + +/** + * This method should only be run on the logging thread/queue. +**/ ++ (void)lt_removeLogger:(id )logger +{ + // Find associated loggerNode in list of added loggers + + DDLoggerNode *loggerNode = nil; + + for (DDLoggerNode *node in loggers) + { + if (node->logger == logger) + { + loggerNode = node; + break; + } + } + + if (loggerNode == nil) + { + NSLogDebug(@"DDLog: Request to remove logger which wasn't added"); + return; + } + + // Notify logger + + if ([logger respondsToSelector:@selector(willRemoveLogger)]) + { + dispatch_async(loggerNode->loggerQueue, ^{ @autoreleasepool { + + [logger willRemoveLogger]; + }}); + } + + // Remove from loggers array + + [loggers removeObject:loggerNode]; +} + +/** + * This method should only be run on the logging thread/queue. +**/ ++ (void)lt_removeAllLoggers +{ + // Notify all loggers + + for (DDLoggerNode *loggerNode in loggers) + { + if ([loggerNode->logger respondsToSelector:@selector(willRemoveLogger)]) + { + dispatch_async(loggerNode->loggerQueue, ^{ @autoreleasepool { + + [loggerNode->logger willRemoveLogger]; + }}); + } + } + + // Remove all loggers from array + + [loggers removeAllObjects]; +} + +/** + * This method should only be run on the logging thread/queue. +**/ ++ (void)lt_log:(DDLogMessage *)logMessage +{ + // Execute the given log message on each of our loggers. + + if (numProcessors > 1) + { + // Execute each logger concurrently, each within its own queue. + // All blocks are added to same group. + // After each block has been queued, wait on group. + // + // The waiting ensures that a slow logger doesn't end up with a large queue of pending log messages. + // This would defeat the purpose of the efforts we made earlier to restrict the max queue size. + + for (DDLoggerNode *loggerNode in loggers) + { + dispatch_group_async(loggingGroup, loggerNode->loggerQueue, ^{ @autoreleasepool { + + [loggerNode->logger logMessage:logMessage]; + + }}); + } + + dispatch_group_wait(loggingGroup, DISPATCH_TIME_FOREVER); + } + else + { + // Execute each logger serialy, each within its own queue. + + for (DDLoggerNode *loggerNode in loggers) + { + dispatch_sync(loggerNode->loggerQueue, ^{ @autoreleasepool { + + [loggerNode->logger logMessage:logMessage]; + + }}); + } + } + + // If our queue got too big, there may be blocked threads waiting to add log messages to the queue. + // Since we've now dequeued an item from the log, we may need to unblock the next thread. + + // We are using a counting semaphore provided by GCD. + // The semaphore is initialized with our LOG_MAX_QUEUE_SIZE value. + // When a log message is queued this value is decremented. + // When a log message is dequeued this value is incremented. + // If the value ever drops below zero, + // the queueing thread blocks and waits in FIFO order for us to signal it. + // + // A dispatch semaphore is an efficient implementation of a traditional counting semaphore. + // Dispatch semaphores call down to the kernel only when the calling thread needs to be blocked. + // If the calling semaphore does not need to block, no kernel call is made. + + dispatch_semaphore_signal(queueSemaphore); +} + +/** + * This method should only be run on the background logging thread. +**/ ++ (void)lt_flush +{ + // All log statements issued before the flush method was invoked have now been executed. + // + // Now we need to propogate the flush request to any loggers that implement the flush method. + // This is designed for loggers that buffer IO. + + for (DDLoggerNode *loggerNode in loggers) + { + if ([loggerNode->logger respondsToSelector:@selector(flush)]) + { + dispatch_group_async(loggingGroup, loggerNode->loggerQueue, ^{ @autoreleasepool { + + [loggerNode->logger flush]; + + }}); + } + } + + dispatch_group_wait(loggingGroup, DISPATCH_TIME_FOREVER); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Utilities +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +NSString *DDExtractFileNameWithoutExtension(const char *filePath, BOOL copy) +{ + if (filePath == NULL) return nil; + + char *lastSlash = NULL; + char *lastDot = NULL; + + char *p = (char *)filePath; + + while (*p != '\0') + { + if (*p == '/') + lastSlash = p; + else if (*p == '.') + lastDot = p; + + p++; + } + + char *subStr; + NSUInteger subLen; + + if (lastSlash) + { + if (lastDot) + { + // lastSlash -> lastDot + subStr = lastSlash + 1; + subLen = lastDot - subStr; + } + else + { + // lastSlash -> endOfString + subStr = lastSlash + 1; + subLen = p - subStr; + } + } + else + { + if (lastDot) + { + // startOfString -> lastDot + subStr = (char *)filePath; + subLen = lastDot - subStr; + } + else + { + // startOfString -> endOfString + subStr = (char *)filePath; + subLen = p - subStr; + } + } + + if (copy) + { + return [[NSString alloc] initWithBytes:subStr + length:subLen + encoding:NSUTF8StringEncoding]; + } + else + { + // We can take advantage of the fact that __FILE__ is a string literal. + // Specifically, we don't need to waste time copying the string. + // We can just tell NSString to point to a range within the string literal. + + return [[NSString alloc] initWithBytesNoCopy:subStr + length:subLen + encoding:NSUTF8StringEncoding + freeWhenDone:NO]; + } +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDLoggerNode + +- (id)initWithLogger:(id )aLogger loggerQueue:(dispatch_queue_t)aLoggerQueue +{ + if ((self = [super init])) + { + logger = aLogger; + + if (aLoggerQueue) { + loggerQueue = aLoggerQueue; + #if !OS_OBJECT_USE_OBJC + dispatch_retain(loggerQueue); + #endif + } + } + return self; +} + ++ (DDLoggerNode *)nodeWithLogger:(id )logger loggerQueue:(dispatch_queue_t)loggerQueue +{ + return [[DDLoggerNode alloc] initWithLogger:logger loggerQueue:loggerQueue]; +} + +- (void)dealloc +{ + #if !OS_OBJECT_USE_OBJC + if (loggerQueue) dispatch_release(loggerQueue); + #endif +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDLogMessage + +static char *dd_str_copy(const char *str) +{ + if (str == NULL) return NULL; + + size_t length = strlen(str); + char * result = malloc(length + 1); + strncpy(result, str, length); + result[length] = 0; + + return result; +} + +- (id)initWithLogMsg:(NSString *)msg + level:(int)level + flag:(int)flag + context:(int)context + file:(const char *)aFile + function:(const char *)aFunction + line:(int)line + tag:(id)aTag + options:(DDLogMessageOptions)optionsMask +{ + if ((self = [super init])) + { + logMsg = msg; + logLevel = level; + logFlag = flag; + logContext = context; + lineNumber = line; + tag = aTag; + options = optionsMask; + + if (options & DDLogMessageCopyFile) + file = dd_str_copy(aFile); + else + file = (char *)aFile; + + if (options & DDLogMessageCopyFunction) + function = dd_str_copy(aFunction); + else + function = (char *)aFunction; + + timestamp = [[NSDate alloc] init]; + + machThreadID = pthread_mach_thread_np(pthread_self()); + + #pragma clang diagnostic push + #pragma clang diagnostic ignored "-Wdeprecated-declarations" + // The documentation for dispatch_get_current_queue() states: + // + // > [This method is] "recommended for debugging and logging purposes only"... + // + // Well that's exactly how we're using it here. Literally for logging purposes only. + // However, Apple has decided to deprecate this method anyway. + // However they have not given us an alternate version of dispatch_queue_get_label() that + // automatically uses the current queue, thus dispatch_get_current_queue() is still required. + // + // If dispatch_get_current_queue() disappears, without a dispatch_queue_get_label() alternative, + // Apple will have effectively taken away our ability to properly log the name of executing dispatch queue. + + dispatch_queue_t currentQueue = dispatch_get_current_queue(); + #pragma clang diagnostic pop + + queueLabel = dd_str_copy(dispatch_queue_get_label(currentQueue)); + + threadName = [[NSThread currentThread] name]; + } + return self; +} + +- (NSString *)threadID +{ + return [[NSString alloc] initWithFormat:@"%x", machThreadID]; +} + +- (NSString *)fileName +{ + return DDExtractFileNameWithoutExtension(file, NO); +} + +- (NSString *)methodName +{ + if (function == NULL) + return nil; + else + return [[NSString alloc] initWithUTF8String:function]; +} + +- (void)dealloc +{ + if (file && (options & DDLogMessageCopyFile)) + free(file); + + if (function && (options & DDLogMessageCopyFunction)) + free(function); + + if (queueLabel) + free(queueLabel); +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDAbstractLogger + +- (id)init +{ + if ((self = [super init])) + { + const char *loggerQueueName = NULL; + if ([self respondsToSelector:@selector(loggerName)]) + { + loggerQueueName = [[self loggerName] UTF8String]; + } + + loggerQueue = dispatch_queue_create(loggerQueueName, NULL); + + // We're going to use dispatch_queue_set_specific() to "mark" our loggerQueue. + // Later we can use dispatch_get_specific() to determine if we're executing on our loggerQueue. + // The documentation states: + // + // > Keys are only compared as pointers and are never dereferenced. + // > Thus, you can use a pointer to a static variable for a specific subsystem or + // > any other value that allows you to identify the value uniquely. + // > Specifying a pointer to a string constant is not recommended. + // + // So we're going to use the very convenient key of "self", + // which also works when multiple logger classes extend this class, as each will have a different "self" key. + // + // This is used primarily for thread-safety assertions (via the isOnInternalLoggerQueue method below). + + void *key = (__bridge void *)self; + void *nonNullValue = (__bridge void *)self; + + dispatch_queue_set_specific(loggerQueue, key, nonNullValue, NULL); + } + return self; +} + +- (void)dealloc +{ + #if !OS_OBJECT_USE_OBJC + if (loggerQueue) dispatch_release(loggerQueue); + #endif +} + +- (void)logMessage:(DDLogMessage *)logMessage +{ + // Override me +} + +- (id )logFormatter +{ + // This method must be thread safe and intuitive. + // Therefore if somebody executes the following code: + // + // [logger setLogFormatter:myFormatter]; + // formatter = [logger logFormatter]; + // + // They would expect formatter to equal myFormatter. + // This functionality must be ensured by the getter and setter method. + // + // The thread safety must not come at a cost to the performance of the logMessage method. + // This method is likely called sporadically, while the logMessage method is called repeatedly. + // This means, the implementation of this method: + // - Must NOT require the logMessage method to acquire a lock. + // - Must NOT require the logMessage method to access an atomic property (also a lock of sorts). + // + // Thread safety is ensured by executing access to the formatter variable on the loggerQueue. + // This is the same queue that the logMessage method operates on. + // + // Note: The last time I benchmarked the performance of direct access vs atomic property access, + // direct access was over twice as fast on the desktop and over 6 times as fast on the iPhone. + // + // Furthermore, consider the following code: + // + // DDLogVerbose(@"log msg 1"); + // DDLogVerbose(@"log msg 2"); + // [logger setFormatter:myFormatter]; + // DDLogVerbose(@"log msg 3"); + // + // Our intuitive requirement means that the new formatter will only apply to the 3rd log message. + // This must remain true even when using asynchronous logging. + // We must keep in mind the various queue's that are in play here: + // + // loggerQueue : Our own private internal queue that the logMessage method runs on. + // Operations are added to this queue from the global loggingQueue. + // + // globalLoggingQueue : The queue that all log messages go through before they arrive in our loggerQueue. + // + // All log statements go through the serial gloabalLoggingQueue before they arrive at our loggerQueue. + // Thus this method also goes through the serial globalLoggingQueue to ensure intuitive operation. + + // IMPORTANT NOTE: + // + // Methods within the DDLogger implementation MUST access the formatter ivar directly. + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block id result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = formatter; + }); + }); + + return result; +} + +- (void)setLogFormatter:(id )logFormatter +{ + // The design of this method is documented extensively in the logFormatter message (above in code). + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_block_t block = ^{ @autoreleasepool { + + if (formatter != logFormatter) + { + if ([formatter respondsToSelector:@selector(willRemoveFromLogger:)]) { + [formatter willRemoveFromLogger:self]; + } + + formatter = logFormatter; + + if ([formatter respondsToSelector:@selector(didAddToLogger:)]) { + [formatter didAddToLogger:self]; + } + } + }}; + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); +} + +- (dispatch_queue_t)loggerQueue +{ + return loggerQueue; +} + +- (NSString *)loggerName +{ + return NSStringFromClass([self class]); +} + +- (BOOL)isOnGlobalLoggingQueue +{ + return (dispatch_get_specific(GlobalLoggingQueueIdentityKey) != NULL); +} + +- (BOOL)isOnInternalLoggerQueue +{ + void *key = (__bridge void *)self; + return (dispatch_get_specific(key) != NULL); +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.h new file mode 100755 index 00000000000..4cbd2e8e9b9 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.h @@ -0,0 +1,167 @@ +#import +#if TARGET_OS_IPHONE +#import +#else +#import +#endif + +#import "DDLog.h" + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * + * This class provides a logger for Terminal output or Xcode console output, + * depending on where you are running your code. + * + * As described in the "Getting Started" page, + * the traditional NSLog() function directs it's output to two places: + * + * - Apple System Log (so it shows up in Console.app) + * - StdErr (if stderr is a TTY, so log statements show up in Xcode console) + * + * To duplicate NSLog() functionality you can simply add this logger and an asl logger. + * However, if you instead choose to use file logging (for faster performance), + * you may choose to use only a file logger and a tty logger. +**/ + +@interface DDTTYLogger : DDAbstractLogger +{ + NSCalendar *calendar; + NSUInteger calendarUnitFlags; + + NSString *appName; + char *app; + size_t appLen; + + NSString *processID; + char *pid; + size_t pidLen; + + BOOL colorsEnabled; + NSMutableArray *colorProfilesArray; + NSMutableDictionary *colorProfilesDict; +} + ++ (DDTTYLogger *)sharedInstance; + +/* Inherited from the DDLogger protocol: + * + * Formatters may optionally be added to any logger. + * + * If no formatter is set, the logger simply logs the message as it is given in logMessage, + * or it may use its own built in formatting style. + * + * More information about formatters can be found here: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomFormatters + * + * The actual implementation of these methods is inherited from DDAbstractLogger. + +- (id )logFormatter; +- (void)setLogFormatter:(id )formatter; + +*/ + +/** + * Want to use different colors for different log levels? + * Enable this property. + * + * If you run the application via the Terminal (not Xcode), + * the logger will map colors to xterm-256color or xterm-color (if available). + * + * Xcode does NOT natively support colors in the Xcode debugging console. + * You'll need to install the XcodeColors plugin to see colors in the Xcode console. + * https://github.com/robbiehanson/XcodeColors + * + * The default value if NO. +**/ +@property (readwrite, assign) BOOL colorsEnabled; + +/** + * The default color set (foregroundColor, backgroundColor) is: + * + * - LOG_FLAG_ERROR = (red, nil) + * - LOG_FLAG_WARN = (orange, nil) + * + * You can customize the colors however you see fit. + * Please note that you are passing a flag, NOT a level. + * + * GOOD : [ttyLogger setForegroundColor:pink backgroundColor:nil forFlag:LOG_FLAG_INFO]; // <- Good :) + * BAD : [ttyLogger setForegroundColor:pink backgroundColor:nil forFlag:LOG_LEVEL_INFO]; // <- BAD! :( + * + * LOG_FLAG_INFO = 0...00100 + * LOG_LEVEL_INFO = 0...00111 <- Would match LOG_FLAG_INFO and LOG_FLAG_WARN and LOG_FLAG_ERROR + * + * If you run the application within Xcode, then the XcodeColors plugin is required. + * + * If you run the application from a shell, then DDTTYLogger will automatically map the given color to + * the closest available color. (xterm-256color or xterm-color which have 256 and 16 supported colors respectively.) + * + * This method invokes setForegroundColor:backgroundColor:forFlag:context: and passes the default context (0). +**/ +#if TARGET_OS_IPHONE +- (void)setForegroundColor:(UIColor *)txtColor backgroundColor:(UIColor *)bgColor forFlag:(int)mask; +#else +- (void)setForegroundColor:(NSColor *)txtColor backgroundColor:(NSColor *)bgColor forFlag:(int)mask; +#endif + +/** + * Just like setForegroundColor:backgroundColor:flag, but allows you to specify a particular logging context. + * + * A logging context is often used to identify log messages coming from a 3rd party framework, + * although logging context's can be used for many different functions. + * + * Logging context's are explained in further detail here: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomContext +**/ +#if TARGET_OS_IPHONE +- (void)setForegroundColor:(UIColor *)txtColor backgroundColor:(UIColor *)bgColor forFlag:(int)mask context:(int)ctxt; +#else +- (void)setForegroundColor:(NSColor *)txtColor backgroundColor:(NSColor *)bgColor forFlag:(int)mask context:(int)ctxt; +#endif + +/** + * Similar to the methods above, but allows you to map DDLogMessage->tag to a particular color profile. + * For example, you could do something like this: + * + * static NSString *const PurpleTag = @"PurpleTag"; + * + * #define DDLogPurple(frmt, ...) LOG_OBJC_TAG_MACRO(NO, 0, 0, 0, PurpleTag, frmt, ##__VA_ARGS__) + * + * And then in your applicationDidFinishLaunching, or wherever you configure Lumberjack: + * + * #if TARGET_OS_IPHONE + * UIColor *purple = [UIColor colorWithRed:(64/255.0) green:(0/255.0) blue:(128/255.0) alpha:1.0]; + * #else + * NSColor *purple = [NSColor colorWithCalibratedRed:(64/255.0) green:(0/255.0) blue:(128/255.0) alpha:1.0]; + * + * [[DDTTYLogger sharedInstance] setForegroundColor:purple backgroundColor:nil forTag:PurpleTag]; + * [DDLog addLogger:[DDTTYLogger sharedInstance]]; + * + * This would essentially give you a straight NSLog replacement that prints in purple: + * + * DDLogPurple(@"I'm a purple log message!"); +**/ +#if TARGET_OS_IPHONE +- (void)setForegroundColor:(UIColor *)txtColor backgroundColor:(UIColor *)bgColor forTag:(id )tag; +#else +- (void)setForegroundColor:(NSColor *)txtColor backgroundColor:(NSColor *)bgColor forTag:(id )tag; +#endif + +/** + * Clearing color profiles. +**/ +- (void)clearColorsForFlag:(int)mask; +- (void)clearColorsForFlag:(int)mask context:(int)context; +- (void)clearColorsForTag:(id )tag; +- (void)clearColorsForAllFlags; +- (void)clearColorsForAllTags; +- (void)clearAllColors; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.m new file mode 100755 index 00000000000..2906463cb4c --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.m @@ -0,0 +1,1479 @@ +#import "DDTTYLogger.h" + +#import +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +// We probably shouldn't be using DDLog() statements within the DDLog implementation. +// But we still want to leave our log statements for any future debugging, +// and to allow other developers to trace the implementation (which is a great learning tool). +// +// So we use primitive logging macros around NSLog. +// We maintain the NS prefix on the macros to be explicit about the fact that we're using NSLog. + +#define LOG_LEVEL 2 + +#define NSLogError(frmt, ...) do{ if(LOG_LEVEL >= 1) NSLog((frmt), ##__VA_ARGS__); } while(0) +#define NSLogWarn(frmt, ...) do{ if(LOG_LEVEL >= 2) NSLog((frmt), ##__VA_ARGS__); } while(0) +#define NSLogInfo(frmt, ...) do{ if(LOG_LEVEL >= 3) NSLog((frmt), ##__VA_ARGS__); } while(0) +#define NSLogVerbose(frmt, ...) do{ if(LOG_LEVEL >= 4) NSLog((frmt), ##__VA_ARGS__); } while(0) + +// Xcode does NOT natively support colors in the Xcode debugging console. +// You'll need to install the XcodeColors plugin to see colors in the Xcode console. +// https://github.com/robbiehanson/XcodeColors +// +// The following is documentation from the XcodeColors project: +// +// +// How to apply color formatting to your log statements: +// +// To set the foreground color: +// Insert the ESCAPE_SEQ into your string, followed by "fg124,12,255;" where r=124, g=12, b=255. +// +// To set the background color: +// Insert the ESCAPE_SEQ into your string, followed by "bg12,24,36;" where r=12, g=24, b=36. +// +// To reset the foreground color (to default value): +// Insert the ESCAPE_SEQ into your string, followed by "fg;" +// +// To reset the background color (to default value): +// Insert the ESCAPE_SEQ into your string, followed by "bg;" +// +// To reset the foreground and background color (to default values) in one operation: +// Insert the ESCAPE_SEQ into your string, followed by ";" + +#define XCODE_COLORS_ESCAPE_SEQ "\033[" + +#define XCODE_COLORS_RESET_FG XCODE_COLORS_ESCAPE_SEQ "fg;" // Clear any foreground color +#define XCODE_COLORS_RESET_BG XCODE_COLORS_ESCAPE_SEQ "bg;" // Clear any background color +#define XCODE_COLORS_RESET XCODE_COLORS_ESCAPE_SEQ ";" // Clear any foreground or background color + +// Some simple defines to make life easier on ourself + +#if TARGET_OS_IPHONE + #define MakeColor(r, g, b) [UIColor colorWithRed:(r/255.0f) green:(g/255.0f) blue:(b/255.0f) alpha:1.0f] +#else + #define MakeColor(r, g, b) [NSColor colorWithCalibratedRed:(r/255.0f) green:(g/255.0f) blue:(b/255.0f) alpha:1.0f] +#endif + +#if TARGET_OS_IPHONE + #define OSColor UIColor +#else + #define OSColor NSColor +#endif + +// If running in a shell, not all RGB colors will be supported. +// In this case we automatically map to the closest available color. +// In order to provide this mapping, we have a hard-coded set of the standard RGB values available in the shell. +// However, not every shell is the same, and Apple likes to think different even when it comes to shell colors. +// +// Map to standard Terminal.app colors (1), or +// map to standard xterm colors (0). + +#define MAP_TO_TERMINAL_APP_COLORS 1 + + +@interface DDTTYLoggerColorProfile : NSObject { +@public + int mask; + int context; + + uint8_t fg_r; + uint8_t fg_g; + uint8_t fg_b; + + uint8_t bg_r; + uint8_t bg_g; + uint8_t bg_b; + + NSUInteger fgCodeIndex; + NSString *fgCodeRaw; + + NSUInteger bgCodeIndex; + NSString *bgCodeRaw; + + char fgCode[24]; + size_t fgCodeLen; + + char bgCode[24]; + size_t bgCodeLen; + + char resetCode[8]; + size_t resetCodeLen; +} + +- (id)initWithForegroundColor:(OSColor *)fgColor backgroundColor:(OSColor *)bgColor flag:(int)mask context:(int)ctxt; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDTTYLogger + +static BOOL isaColorTTY; +static BOOL isaColor256TTY; +static BOOL isaXcodeColorTTY; + +static NSArray *codes_fg = nil; +static NSArray *codes_bg = nil; +static NSArray *colors = nil; + +static DDTTYLogger *sharedInstance; + +/** + * Initializes the colors array, as well as the codes_fg and codes_bg arrays, for 16 color mode. + * + * This method is used when the application is running from within a shell that only supports 16 color mode. + * This method is not invoked if the application is running within Xcode, or via normal UI app launch. +**/ ++ (void)initialize_colors_16 +{ + if (codes_fg || codes_bg || colors) return; + + NSMutableArray *m_codes_fg = [NSMutableArray arrayWithCapacity:16]; + NSMutableArray *m_codes_bg = [NSMutableArray arrayWithCapacity:16]; + NSMutableArray *m_colors = [NSMutableArray arrayWithCapacity:16]; + + // In a standard shell only 16 colors are supported. + // + // More information about ansi escape codes can be found online. + // http://en.wikipedia.org/wiki/ANSI_escape_code + + [m_codes_fg addObject:@"30m"]; // normal - black + [m_codes_fg addObject:@"31m"]; // normal - red + [m_codes_fg addObject:@"32m"]; // normal - green + [m_codes_fg addObject:@"33m"]; // normal - yellow + [m_codes_fg addObject:@"34m"]; // normal - blue + [m_codes_fg addObject:@"35m"]; // normal - magenta + [m_codes_fg addObject:@"36m"]; // normal - cyan + [m_codes_fg addObject:@"37m"]; // normal - gray + [m_codes_fg addObject:@"1;30m"]; // bright - darkgray + [m_codes_fg addObject:@"1;31m"]; // bright - red + [m_codes_fg addObject:@"1;32m"]; // bright - green + [m_codes_fg addObject:@"1;33m"]; // bright - yellow + [m_codes_fg addObject:@"1;34m"]; // bright - blue + [m_codes_fg addObject:@"1;35m"]; // bright - magenta + [m_codes_fg addObject:@"1;36m"]; // bright - cyan + [m_codes_fg addObject:@"1;37m"]; // bright - white + + [m_codes_bg addObject:@"40m"]; // normal - black + [m_codes_bg addObject:@"41m"]; // normal - red + [m_codes_bg addObject:@"42m"]; // normal - green + [m_codes_bg addObject:@"43m"]; // normal - yellow + [m_codes_bg addObject:@"44m"]; // normal - blue + [m_codes_bg addObject:@"45m"]; // normal - magenta + [m_codes_bg addObject:@"46m"]; // normal - cyan + [m_codes_bg addObject:@"47m"]; // normal - gray + [m_codes_bg addObject:@"1;40m"]; // bright - darkgray + [m_codes_bg addObject:@"1;41m"]; // bright - red + [m_codes_bg addObject:@"1;42m"]; // bright - green + [m_codes_bg addObject:@"1;43m"]; // bright - yellow + [m_codes_bg addObject:@"1;44m"]; // bright - blue + [m_codes_bg addObject:@"1;45m"]; // bright - magenta + [m_codes_bg addObject:@"1;46m"]; // bright - cyan + [m_codes_bg addObject:@"1;47m"]; // bright - white + +#if MAP_TO_TERMINAL_APP_COLORS + + // Standard Terminal.app colors: + // + // These are the default colors used by Apple's Terminal.app. + + [m_colors addObject:MakeColor( 0, 0, 0)]; // normal - black + [m_colors addObject:MakeColor(194, 54, 33)]; // normal - red + [m_colors addObject:MakeColor( 37, 188, 36)]; // normal - green + [m_colors addObject:MakeColor(173, 173, 39)]; // normal - yellow + [m_colors addObject:MakeColor( 73, 46, 225)]; // normal - blue + [m_colors addObject:MakeColor(211, 56, 211)]; // normal - magenta + [m_colors addObject:MakeColor( 51, 187, 200)]; // normal - cyan + [m_colors addObject:MakeColor(203, 204, 205)]; // normal - gray + [m_colors addObject:MakeColor(129, 131, 131)]; // bright - darkgray + [m_colors addObject:MakeColor(252, 57, 31)]; // bright - red + [m_colors addObject:MakeColor( 49, 231, 34)]; // bright - green + [m_colors addObject:MakeColor(234, 236, 35)]; // bright - yellow + [m_colors addObject:MakeColor( 88, 51, 255)]; // bright - blue + [m_colors addObject:MakeColor(249, 53, 248)]; // bright - magenta + [m_colors addObject:MakeColor( 20, 240, 240)]; // bright - cyan + [m_colors addObject:MakeColor(233, 235, 235)]; // bright - white + +#else + + // Standard xterm colors: + // + // These are the default colors used by most xterm shells. + + [m_colors addObject:MakeColor( 0, 0, 0)]; // normal - black + [m_colors addObject:MakeColor(205, 0, 0)]; // normal - red + [m_colors addObject:MakeColor( 0, 205, 0)]; // normal - green + [m_colors addObject:MakeColor(205, 205, 0)]; // normal - yellow + [m_colors addObject:MakeColor( 0, 0, 238)]; // normal - blue + [m_colors addObject:MakeColor(205, 0, 205)]; // normal - magenta + [m_colors addObject:MakeColor( 0, 205, 205)]; // normal - cyan + [m_colors addObject:MakeColor(229, 229, 229)]; // normal - gray + [m_colors addObject:MakeColor(127, 127, 127)]; // bright - darkgray + [m_colors addObject:MakeColor(255, 0, 0)]; // bright - red + [m_colors addObject:MakeColor( 0, 255, 0)]; // bright - green + [m_colors addObject:MakeColor(255, 255, 0)]; // bright - yellow + [m_colors addObject:MakeColor( 92, 92, 255)]; // bright - blue + [m_colors addObject:MakeColor(255, 0, 255)]; // bright - magenta + [m_colors addObject:MakeColor( 0, 255, 255)]; // bright - cyan + [m_colors addObject:MakeColor(255, 255, 255)]; // bright - white + +#endif + + codes_fg = [m_codes_fg copy]; + codes_bg = [m_codes_bg copy]; + colors = [m_colors copy]; + + NSAssert([codes_fg count] == [codes_bg count], @"Invalid colors/codes array(s)"); + NSAssert([codes_fg count] == [colors count], @"Invalid colors/codes array(s)"); +} + +/** + * Initializes the colors array, as well as the codes_fg and codes_bg arrays, for 256 color mode. + * + * This method is used when the application is running from within a shell that supports 256 color mode. + * This method is not invoked if the application is running within Xcode, or via normal UI app launch. +**/ ++ (void)initialize_colors_256 +{ + if (codes_fg || codes_bg || colors) return; + + NSMutableArray *m_codes_fg = [NSMutableArray arrayWithCapacity:(256-16)]; + NSMutableArray *m_codes_bg = [NSMutableArray arrayWithCapacity:(256-16)]; + NSMutableArray *m_colors = [NSMutableArray arrayWithCapacity:(256-16)]; + + #if MAP_TO_TERMINAL_APP_COLORS + + // Standard Terminal.app colors: + // + // These are the colors the Terminal.app uses in xterm-256color mode. + // In this mode, the terminal supports 256 different colors, specified by 256 color codes. + // + // The first 16 color codes map to the original 16 color codes supported by the earlier xterm-color mode. + // These are actually configurable, and thus we ignore them for the purposes of mapping, + // as we can't rely on them being constant. They are largely duplicated anyway. + // + // The next 216 color codes are designed to run the spectrum, with several shades of every color. + // While the color codes are standardized, the actual RGB values for each color code is not. + // Apple's Terminal.app uses different RGB values from that of a standard xterm. + // Apple's choices in colors are designed to be a little nicer on the eyes. + // + // The last 24 color codes represent a grayscale. + // + // Unfortunately, unlike the standard xterm color chart, + // Apple's RGB values cannot be calculated using a simple formula (at least not that I know of). + // Also, I don't know of any ways to programmatically query the shell for the RGB values. + // So this big giant color chart had to be made by hand. + // + // More information about ansi escape codes can be found online. + // http://en.wikipedia.org/wiki/ANSI_escape_code + + // Colors + + [m_colors addObject:MakeColor( 47, 49, 49)]; + [m_colors addObject:MakeColor( 60, 42, 144)]; + [m_colors addObject:MakeColor( 66, 44, 183)]; + [m_colors addObject:MakeColor( 73, 46, 222)]; + [m_colors addObject:MakeColor( 81, 50, 253)]; + [m_colors addObject:MakeColor( 88, 51, 255)]; + + [m_colors addObject:MakeColor( 42, 128, 37)]; + [m_colors addObject:MakeColor( 42, 127, 128)]; + [m_colors addObject:MakeColor( 44, 126, 169)]; + [m_colors addObject:MakeColor( 56, 125, 209)]; + [m_colors addObject:MakeColor( 59, 124, 245)]; + [m_colors addObject:MakeColor( 66, 123, 255)]; + + [m_colors addObject:MakeColor( 51, 163, 41)]; + [m_colors addObject:MakeColor( 39, 162, 121)]; + [m_colors addObject:MakeColor( 42, 161, 162)]; + [m_colors addObject:MakeColor( 53, 160, 202)]; + [m_colors addObject:MakeColor( 45, 159, 240)]; + [m_colors addObject:MakeColor( 58, 158, 255)]; + + [m_colors addObject:MakeColor( 31, 196, 37)]; + [m_colors addObject:MakeColor( 48, 196, 115)]; + [m_colors addObject:MakeColor( 39, 195, 155)]; + [m_colors addObject:MakeColor( 49, 195, 195)]; + [m_colors addObject:MakeColor( 32, 194, 235)]; + [m_colors addObject:MakeColor( 53, 193, 255)]; + + [m_colors addObject:MakeColor( 50, 229, 35)]; + [m_colors addObject:MakeColor( 40, 229, 109)]; + [m_colors addObject:MakeColor( 27, 229, 149)]; + [m_colors addObject:MakeColor( 49, 228, 189)]; + [m_colors addObject:MakeColor( 33, 228, 228)]; + [m_colors addObject:MakeColor( 53, 227, 255)]; + + [m_colors addObject:MakeColor( 27, 254, 30)]; + [m_colors addObject:MakeColor( 30, 254, 103)]; + [m_colors addObject:MakeColor( 45, 254, 143)]; + [m_colors addObject:MakeColor( 38, 253, 182)]; + [m_colors addObject:MakeColor( 38, 253, 222)]; + [m_colors addObject:MakeColor( 42, 253, 252)]; + + [m_colors addObject:MakeColor(140, 48, 40)]; + [m_colors addObject:MakeColor(136, 51, 136)]; + [m_colors addObject:MakeColor(135, 52, 177)]; + [m_colors addObject:MakeColor(134, 52, 217)]; + [m_colors addObject:MakeColor(135, 56, 248)]; + [m_colors addObject:MakeColor(134, 53, 255)]; + + [m_colors addObject:MakeColor(125, 125, 38)]; + [m_colors addObject:MakeColor(124, 125, 125)]; + [m_colors addObject:MakeColor(122, 124, 166)]; + [m_colors addObject:MakeColor(123, 124, 207)]; + [m_colors addObject:MakeColor(123, 122, 247)]; + [m_colors addObject:MakeColor(124, 121, 255)]; + + [m_colors addObject:MakeColor(119, 160, 35)]; + [m_colors addObject:MakeColor(117, 160, 120)]; + [m_colors addObject:MakeColor(117, 160, 160)]; + [m_colors addObject:MakeColor(115, 159, 201)]; + [m_colors addObject:MakeColor(116, 158, 240)]; + [m_colors addObject:MakeColor(117, 157, 255)]; + + [m_colors addObject:MakeColor(113, 195, 39)]; + [m_colors addObject:MakeColor(110, 194, 114)]; + [m_colors addObject:MakeColor(111, 194, 154)]; + [m_colors addObject:MakeColor(108, 194, 194)]; + [m_colors addObject:MakeColor(109, 193, 234)]; + [m_colors addObject:MakeColor(108, 192, 255)]; + + [m_colors addObject:MakeColor(105, 228, 30)]; + [m_colors addObject:MakeColor(103, 228, 109)]; + [m_colors addObject:MakeColor(105, 228, 148)]; + [m_colors addObject:MakeColor(100, 227, 188)]; + [m_colors addObject:MakeColor( 99, 227, 227)]; + [m_colors addObject:MakeColor( 99, 226, 253)]; + + [m_colors addObject:MakeColor( 92, 253, 34)]; + [m_colors addObject:MakeColor( 96, 253, 103)]; + [m_colors addObject:MakeColor( 97, 253, 142)]; + [m_colors addObject:MakeColor( 88, 253, 182)]; + [m_colors addObject:MakeColor( 93, 253, 221)]; + [m_colors addObject:MakeColor( 88, 254, 251)]; + + [m_colors addObject:MakeColor(177, 53, 34)]; + [m_colors addObject:MakeColor(174, 54, 131)]; + [m_colors addObject:MakeColor(172, 55, 172)]; + [m_colors addObject:MakeColor(171, 57, 213)]; + [m_colors addObject:MakeColor(170, 55, 249)]; + [m_colors addObject:MakeColor(170, 57, 255)]; + + [m_colors addObject:MakeColor(165, 123, 37)]; + [m_colors addObject:MakeColor(163, 123, 123)]; + [m_colors addObject:MakeColor(162, 123, 164)]; + [m_colors addObject:MakeColor(161, 122, 205)]; + [m_colors addObject:MakeColor(161, 121, 241)]; + [m_colors addObject:MakeColor(161, 121, 255)]; + + [m_colors addObject:MakeColor(158, 159, 33)]; + [m_colors addObject:MakeColor(157, 158, 118)]; + [m_colors addObject:MakeColor(157, 158, 159)]; + [m_colors addObject:MakeColor(155, 157, 199)]; + [m_colors addObject:MakeColor(155, 157, 239)]; + [m_colors addObject:MakeColor(154, 156, 255)]; + + [m_colors addObject:MakeColor(152, 193, 40)]; + [m_colors addObject:MakeColor(151, 193, 113)]; + [m_colors addObject:MakeColor(150, 193, 153)]; + [m_colors addObject:MakeColor(150, 192, 193)]; + [m_colors addObject:MakeColor(148, 192, 232)]; + [m_colors addObject:MakeColor(149, 191, 253)]; + + [m_colors addObject:MakeColor(146, 227, 28)]; + [m_colors addObject:MakeColor(144, 227, 108)]; + [m_colors addObject:MakeColor(144, 227, 147)]; + [m_colors addObject:MakeColor(144, 227, 187)]; + [m_colors addObject:MakeColor(142, 226, 227)]; + [m_colors addObject:MakeColor(142, 225, 252)]; + + [m_colors addObject:MakeColor(138, 253, 36)]; + [m_colors addObject:MakeColor(137, 253, 102)]; + [m_colors addObject:MakeColor(136, 253, 141)]; + [m_colors addObject:MakeColor(138, 254, 181)]; + [m_colors addObject:MakeColor(135, 255, 220)]; + [m_colors addObject:MakeColor(133, 255, 250)]; + + [m_colors addObject:MakeColor(214, 57, 30)]; + [m_colors addObject:MakeColor(211, 59, 126)]; + [m_colors addObject:MakeColor(209, 57, 168)]; + [m_colors addObject:MakeColor(208, 55, 208)]; + [m_colors addObject:MakeColor(207, 58, 247)]; + [m_colors addObject:MakeColor(206, 61, 255)]; + + [m_colors addObject:MakeColor(204, 121, 32)]; + [m_colors addObject:MakeColor(202, 121, 121)]; + [m_colors addObject:MakeColor(201, 121, 161)]; + [m_colors addObject:MakeColor(200, 120, 202)]; + [m_colors addObject:MakeColor(200, 120, 241)]; + [m_colors addObject:MakeColor(198, 119, 255)]; + + [m_colors addObject:MakeColor(198, 157, 37)]; + [m_colors addObject:MakeColor(196, 157, 116)]; + [m_colors addObject:MakeColor(195, 156, 157)]; + [m_colors addObject:MakeColor(195, 156, 197)]; + [m_colors addObject:MakeColor(194, 155, 236)]; + [m_colors addObject:MakeColor(193, 155, 255)]; + + [m_colors addObject:MakeColor(191, 192, 36)]; + [m_colors addObject:MakeColor(190, 191, 112)]; + [m_colors addObject:MakeColor(189, 191, 152)]; + [m_colors addObject:MakeColor(189, 191, 191)]; + [m_colors addObject:MakeColor(188, 190, 230)]; + [m_colors addObject:MakeColor(187, 190, 253)]; + + [m_colors addObject:MakeColor(185, 226, 28)]; + [m_colors addObject:MakeColor(184, 226, 106)]; + [m_colors addObject:MakeColor(183, 225, 146)]; + [m_colors addObject:MakeColor(183, 225, 186)]; + [m_colors addObject:MakeColor(182, 225, 225)]; + [m_colors addObject:MakeColor(181, 224, 252)]; + + [m_colors addObject:MakeColor(178, 255, 35)]; + [m_colors addObject:MakeColor(178, 255, 101)]; + [m_colors addObject:MakeColor(177, 254, 141)]; + [m_colors addObject:MakeColor(176, 254, 180)]; + [m_colors addObject:MakeColor(176, 254, 220)]; + [m_colors addObject:MakeColor(175, 253, 249)]; + + [m_colors addObject:MakeColor(247, 56, 30)]; + [m_colors addObject:MakeColor(245, 57, 122)]; + [m_colors addObject:MakeColor(243, 59, 163)]; + [m_colors addObject:MakeColor(244, 60, 204)]; + [m_colors addObject:MakeColor(242, 59, 241)]; + [m_colors addObject:MakeColor(240, 55, 255)]; + + [m_colors addObject:MakeColor(241, 119, 36)]; + [m_colors addObject:MakeColor(240, 120, 118)]; + [m_colors addObject:MakeColor(238, 119, 158)]; + [m_colors addObject:MakeColor(237, 119, 199)]; + [m_colors addObject:MakeColor(237, 118, 238)]; + [m_colors addObject:MakeColor(236, 118, 255)]; + + [m_colors addObject:MakeColor(235, 154, 36)]; + [m_colors addObject:MakeColor(235, 154, 114)]; + [m_colors addObject:MakeColor(234, 154, 154)]; + [m_colors addObject:MakeColor(232, 154, 194)]; + [m_colors addObject:MakeColor(232, 153, 234)]; + [m_colors addObject:MakeColor(232, 153, 255)]; + + [m_colors addObject:MakeColor(230, 190, 30)]; + [m_colors addObject:MakeColor(229, 189, 110)]; + [m_colors addObject:MakeColor(228, 189, 150)]; + [m_colors addObject:MakeColor(227, 189, 190)]; + [m_colors addObject:MakeColor(227, 189, 229)]; + [m_colors addObject:MakeColor(226, 188, 255)]; + + [m_colors addObject:MakeColor(224, 224, 35)]; + [m_colors addObject:MakeColor(223, 224, 105)]; + [m_colors addObject:MakeColor(222, 224, 144)]; + [m_colors addObject:MakeColor(222, 223, 184)]; + [m_colors addObject:MakeColor(222, 223, 224)]; + [m_colors addObject:MakeColor(220, 223, 253)]; + + [m_colors addObject:MakeColor(217, 253, 28)]; + [m_colors addObject:MakeColor(217, 253, 99)]; + [m_colors addObject:MakeColor(216, 252, 139)]; + [m_colors addObject:MakeColor(216, 252, 179)]; + [m_colors addObject:MakeColor(215, 252, 218)]; + [m_colors addObject:MakeColor(215, 251, 250)]; + + [m_colors addObject:MakeColor(255, 61, 30)]; + [m_colors addObject:MakeColor(255, 60, 118)]; + [m_colors addObject:MakeColor(255, 58, 159)]; + [m_colors addObject:MakeColor(255, 56, 199)]; + [m_colors addObject:MakeColor(255, 55, 238)]; + [m_colors addObject:MakeColor(255, 59, 255)]; + + [m_colors addObject:MakeColor(255, 117, 29)]; + [m_colors addObject:MakeColor(255, 117, 115)]; + [m_colors addObject:MakeColor(255, 117, 155)]; + [m_colors addObject:MakeColor(255, 117, 195)]; + [m_colors addObject:MakeColor(255, 116, 235)]; + [m_colors addObject:MakeColor(254, 116, 255)]; + + [m_colors addObject:MakeColor(255, 152, 27)]; + [m_colors addObject:MakeColor(255, 152, 111)]; + [m_colors addObject:MakeColor(254, 152, 152)]; + [m_colors addObject:MakeColor(255, 152, 192)]; + [m_colors addObject:MakeColor(254, 151, 231)]; + [m_colors addObject:MakeColor(253, 151, 253)]; + + [m_colors addObject:MakeColor(255, 187, 33)]; + [m_colors addObject:MakeColor(253, 187, 107)]; + [m_colors addObject:MakeColor(252, 187, 148)]; + [m_colors addObject:MakeColor(253, 187, 187)]; + [m_colors addObject:MakeColor(254, 187, 227)]; + [m_colors addObject:MakeColor(252, 186, 252)]; + + [m_colors addObject:MakeColor(252, 222, 34)]; + [m_colors addObject:MakeColor(251, 222, 103)]; + [m_colors addObject:MakeColor(251, 222, 143)]; + [m_colors addObject:MakeColor(250, 222, 182)]; + [m_colors addObject:MakeColor(251, 221, 222)]; + [m_colors addObject:MakeColor(252, 221, 252)]; + + [m_colors addObject:MakeColor(251, 252, 15)]; + [m_colors addObject:MakeColor(251, 252, 97)]; + [m_colors addObject:MakeColor(249, 252, 137)]; + [m_colors addObject:MakeColor(247, 252, 177)]; + [m_colors addObject:MakeColor(247, 253, 217)]; + [m_colors addObject:MakeColor(254, 255, 255)]; + + // Grayscale + + [m_colors addObject:MakeColor( 52, 53, 53)]; + [m_colors addObject:MakeColor( 57, 58, 59)]; + [m_colors addObject:MakeColor( 66, 67, 67)]; + [m_colors addObject:MakeColor( 75, 76, 76)]; + [m_colors addObject:MakeColor( 83, 85, 85)]; + [m_colors addObject:MakeColor( 92, 93, 94)]; + + [m_colors addObject:MakeColor(101, 102, 102)]; + [m_colors addObject:MakeColor(109, 111, 111)]; + [m_colors addObject:MakeColor(118, 119, 119)]; + [m_colors addObject:MakeColor(126, 127, 128)]; + [m_colors addObject:MakeColor(134, 136, 136)]; + [m_colors addObject:MakeColor(143, 144, 145)]; + + [m_colors addObject:MakeColor(151, 152, 153)]; + [m_colors addObject:MakeColor(159, 161, 161)]; + [m_colors addObject:MakeColor(167, 169, 169)]; + [m_colors addObject:MakeColor(176, 177, 177)]; + [m_colors addObject:MakeColor(184, 185, 186)]; + [m_colors addObject:MakeColor(192, 193, 194)]; + + [m_colors addObject:MakeColor(200, 201, 202)]; + [m_colors addObject:MakeColor(208, 209, 210)]; + [m_colors addObject:MakeColor(216, 218, 218)]; + [m_colors addObject:MakeColor(224, 226, 226)]; + [m_colors addObject:MakeColor(232, 234, 234)]; + [m_colors addObject:MakeColor(240, 242, 242)]; + + // Color codes + + int index = 16; + + while (index < 256) + { + [m_codes_fg addObject:[NSString stringWithFormat:@"38;5;%dm", index]]; + [m_codes_bg addObject:[NSString stringWithFormat:@"48;5;%dm", index]]; + + index++; + } + + #else + + // Standard xterm colors: + // + // These are the colors xterm shells use in xterm-256color mode. + // In this mode, the shell supports 256 different colors, specified by 256 color codes. + // + // The first 16 color codes map to the original 16 color codes supported by the earlier xterm-color mode. + // These are generally configurable, and thus we ignore them for the purposes of mapping, + // as we can't rely on them being constant. They are largely duplicated anyway. + // + // The next 216 color codes are designed to run the spectrum, with several shades of every color. + // The last 24 color codes represent a grayscale. + // + // While the color codes are standardized, the actual RGB values for each color code is not. + // However most standard xterms follow a well known color chart, + // which can easily be calculated using the simple formula below. + // + // More information about ansi escape codes can be found online. + // http://en.wikipedia.org/wiki/ANSI_escape_code + + int index = 16; + + int r; // red + int g; // green + int b; // blue + + int ri; // r increment + int gi; // g increment + int bi; // b increment + + // Calculate xterm colors (using standard algorithm) + + int r = 0; + int g = 0; + int b = 0; + + for (ri = 0; ri < 6; ri++) + { + r = (ri == 0) ? 0 : 95 + (40 * (ri - 1)); + + for (gi = 0; gi < 6; gi++) + { + g = (gi == 0) ? 0 : 95 + (40 * (gi - 1)); + + for (bi = 0; bi < 6; bi++) + { + b = (bi == 0) ? 0 : 95 + (40 * (bi - 1)); + + [m_codes_fg addObject:[NSString stringWithFormat:@"38;5;%dm", index]]; + [m_codes_bg addObject:[NSString stringWithFormat:@"48;5;%dm", index]]; + [m_colors addObject:MakeColor(r, g, b)]; + + index++; + } + } + } + + // Calculate xterm grayscale (using standard algorithm) + + r = 8; + g = 8; + b = 8; + + while (index < 256) + { + [m_codes_fg addObject:[NSString stringWithFormat:@"38;5;%dm", index]]; + [m_codes_bg addObject:[NSString stringWithFormat:@"48;5;%dm", index]]; + [m_colors addObject:MakeColor(r, g, b)]; + + r += 10; + g += 10; + b += 10; + + index++; + } + + #endif + + codes_fg = [m_codes_fg copy]; + codes_bg = [m_codes_bg copy]; + colors = [m_colors copy]; + + NSAssert([codes_fg count] == [codes_bg count], @"Invalid colors/codes array(s)"); + NSAssert([codes_fg count] == [colors count], @"Invalid colors/codes array(s)"); +} + ++ (void)getRed:(CGFloat *)rPtr green:(CGFloat *)gPtr blue:(CGFloat *)bPtr fromColor:(OSColor *)color +{ + #if TARGET_OS_IPHONE + + // iOS + + if ([color respondsToSelector:@selector(getRed:green:blue:alpha:)]) + { + [color getRed:rPtr green:gPtr blue:bPtr alpha:NULL]; + } + else + { + // The method getRed:green:blue:alpha: was only available starting iOS 5. + // So in iOS 4 and earlier, we have to jump through hoops. + + CGColorSpaceRef rgbColorSpace = CGColorSpaceCreateDeviceRGB(); + + unsigned char pixel[4]; + CGContextRef context = CGBitmapContextCreate(&pixel, 1, 1, 8, 4, rgbColorSpace, kCGImageAlphaNoneSkipLast); + + CGContextSetFillColorWithColor(context, [color CGColor]); + CGContextFillRect(context, CGRectMake(0, 0, 1, 1)); + + if (rPtr) { *rPtr = pixel[0] / 255.0f; } + if (gPtr) { *gPtr = pixel[1] / 255.0f; } + if (bPtr) { *bPtr = pixel[2] / 255.0f; } + + CGContextRelease(context); + CGColorSpaceRelease(rgbColorSpace); + } + + #else + + // Mac OS X + + [color getRed:rPtr green:gPtr blue:bPtr alpha:NULL]; + + #endif +} + +/** + * Maps the given color to the closest available color supported by the shell. + * The shell may support 256 colors, or only 16. + * + * This method loops through the known supported color set, and calculates the closest color. + * The array index of that color, within the colors array, is then returned. + * This array index may also be used as the index within the codes_fg and codes_bg arrays. +**/ ++ (NSUInteger)codeIndexForColor:(OSColor *)inColor +{ + CGFloat inR, inG, inB; + [self getRed:&inR green:&inG blue:&inB fromColor:inColor]; + + NSUInteger bestIndex = 0; + CGFloat lowestDistance = 100.0f; + + NSUInteger i = 0; + for (OSColor *color in colors) + { + // Calculate Euclidean distance (lower value means closer to given color) + + CGFloat r, g, b; + [self getRed:&r green:&g blue:&b fromColor:color]; + + #if CGFLOAT_IS_DOUBLE + CGFloat distance = sqrt(pow(r-inR, 2.0) + pow(g-inG, 2.0) + pow(b-inB, 2.0)); + #else + CGFloat distance = sqrtf(powf(r-inR, 2.0f) + powf(g-inG, 2.0f) + powf(b-inB, 2.0f)); + #endif + + NSLogVerbose(@"DDTTYLogger: %3lu : %.3f,%.3f,%.3f & %.3f,%.3f,%.3f = %.6f", + (unsigned long)i, inR, inG, inB, r, g, b, distance); + + if (distance < lowestDistance) + { + bestIndex = i; + lowestDistance = distance; + + NSLogVerbose(@"DDTTYLogger: New best index = %lu", (unsigned long)bestIndex); + } + + i++; + } + + return bestIndex; +} + +/** + * The runtime sends initialize to each class in a program exactly one time just before the class, + * or any class that inherits from it, is sent its first message from within the program. (Thus the + * method may never be invoked if the class is not used.) The runtime sends the initialize message to + * classes in a thread-safe manner. Superclasses receive this message before their subclasses. + * + * This method may also be called directly (assumably by accident), hence the safety mechanism. +**/ ++ (void)initialize +{ + static BOOL initialized = NO; + if (!initialized) + { + initialized = YES; + + char *term = getenv("TERM"); + if (term) + { + if (strcasestr(term, "color") != NULL) + { + isaColorTTY = YES; + isaColor256TTY = (strcasestr(term, "256") != NULL); + + if (isaColor256TTY) + [self initialize_colors_256]; + else + [self initialize_colors_16]; + } + } + else + { + // Xcode does NOT natively support colors in the Xcode debugging console. + // You'll need to install the XcodeColors plugin to see colors in the Xcode console. + // + // PS - Please read the header file before diving into the source code. + + char *xcode_colors = getenv("XcodeColors"); + if (xcode_colors && (strcmp(xcode_colors, "YES") == 0)) + { + isaXcodeColorTTY = YES; + } + } + + NSLogInfo(@"DDTTYLogger: isaColorTTY = %@", (isaColorTTY ? @"YES" : @"NO")); + NSLogInfo(@"DDTTYLogger: isaColor256TTY: %@", (isaColor256TTY ? @"YES" : @"NO")); + NSLogInfo(@"DDTTYLogger: isaXcodeColorTTY: %@", (isaXcodeColorTTY ? @"YES" : @"NO")); + + sharedInstance = [[DDTTYLogger alloc] init]; + } +} + ++ (DDTTYLogger *)sharedInstance +{ + return sharedInstance; +} + +- (id)init +{ + if (sharedInstance != nil) + { + return nil; + } + + if ((self = [super init])) + { + calendar = [NSCalendar autoupdatingCurrentCalendar]; + + calendarUnitFlags = 0; + calendarUnitFlags |= NSYearCalendarUnit; + calendarUnitFlags |= NSMonthCalendarUnit; + calendarUnitFlags |= NSDayCalendarUnit; + calendarUnitFlags |= NSHourCalendarUnit; + calendarUnitFlags |= NSMinuteCalendarUnit; + calendarUnitFlags |= NSSecondCalendarUnit; + + // Initialze 'app' variable (char *) + + appName = [[NSProcessInfo processInfo] processName]; + + appLen = [appName lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + app = (char *)malloc(appLen + 1); + + [appName getCString:app maxLength:(appLen+1) encoding:NSUTF8StringEncoding]; + + // Initialize 'pid' variable (char *) + + processID = [NSString stringWithFormat:@"%i", (int)getpid()]; + + pidLen = [processID lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + pid = (char *)malloc(pidLen + 1); + + [processID getCString:pid maxLength:(pidLen+1) encoding:NSUTF8StringEncoding]; + + // Initialize color stuff + + colorsEnabled = NO; + colorProfilesArray = [[NSMutableArray alloc] initWithCapacity:8]; + colorProfilesDict = [[NSMutableDictionary alloc] initWithCapacity:8]; + } + return self; +} + +- (void)loadDefaultColorProfiles +{ + [self setForegroundColor:MakeColor(214, 57, 30) backgroundColor:nil forFlag:LOG_FLAG_ERROR]; + [self setForegroundColor:MakeColor(204, 121, 32) backgroundColor:nil forFlag:LOG_FLAG_WARN]; +} + +- (BOOL)colorsEnabled +{ + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + __block BOOL result; + + dispatch_sync(globalLoggingQueue, ^{ + dispatch_sync(loggerQueue, ^{ + result = colorsEnabled; + }); + }); + + return result; +} + +- (void)setColorsEnabled:(BOOL)newColorsEnabled +{ + dispatch_block_t block = ^{ @autoreleasepool { + + colorsEnabled = newColorsEnabled; + + if ([colorProfilesArray count] == 0) { + [self loadDefaultColorProfiles]; + } + }}; + + // The design of this method is taken from the DDAbstractLogger implementation. + // For extensive documentation please refer to the DDAbstractLogger implementation. + + // Note: The internal implementation MUST access the colorsEnabled variable directly, + // This method is designed explicitly for external access. + // + // Using "self." syntax to go through this method will cause immediate deadlock. + // This is the intended result. Fix it by accessing the ivar directly. + // Great strides have been take to ensure this is safe to do. Plus it's MUCH faster. + + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + NSAssert(![self isOnInternalLoggerQueue], @"MUST access ivar directly, NOT via self.* syntax."); + + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); +} + +- (void)setForegroundColor:(OSColor *)txtColor backgroundColor:(OSColor *)bgColor forFlag:(int)mask +{ + [self setForegroundColor:txtColor backgroundColor:bgColor forFlag:mask context:0]; +} + +- (void)setForegroundColor:(OSColor *)txtColor backgroundColor:(OSColor *)bgColor forFlag:(int)mask context:(int)ctxt +{ + dispatch_block_t block = ^{ @autoreleasepool { + + DDTTYLoggerColorProfile *newColorProfile = + [[DDTTYLoggerColorProfile alloc] initWithForegroundColor:txtColor + backgroundColor:bgColor + flag:mask + context:ctxt]; + + NSLogInfo(@"DDTTYLogger: newColorProfile: %@", newColorProfile); + + NSUInteger i = 0; + for (DDTTYLoggerColorProfile *colorProfile in colorProfilesArray) + { + if ((colorProfile->mask == mask) && (colorProfile->context == ctxt)) + { + break; + } + + i++; + } + + if (i < [colorProfilesArray count]) + [colorProfilesArray replaceObjectAtIndex:i withObject:newColorProfile]; + else + [colorProfilesArray addObject:newColorProfile]; + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)setForegroundColor:(OSColor *)txtColor backgroundColor:(OSColor *)bgColor forTag:(id )tag +{ + NSAssert([(id )tag conformsToProtocol:@protocol(NSCopying)], @"Invalid tag"); + + dispatch_block_t block = ^{ @autoreleasepool { + + DDTTYLoggerColorProfile *newColorProfile = + [[DDTTYLoggerColorProfile alloc] initWithForegroundColor:txtColor + backgroundColor:bgColor + flag:0 + context:0]; + + NSLogInfo(@"DDTTYLogger: newColorProfile: %@", newColorProfile); + + [colorProfilesDict setObject:newColorProfile forKey:tag]; + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)clearColorsForFlag:(int)mask +{ + [self clearColorsForFlag:mask context:0]; +} + +- (void)clearColorsForFlag:(int)mask context:(int)context +{ + dispatch_block_t block = ^{ @autoreleasepool { + + NSUInteger i = 0; + for (DDTTYLoggerColorProfile *colorProfile in colorProfilesArray) + { + if ((colorProfile->mask == mask) && (colorProfile->context == context)) + { + break; + } + + i++; + } + + if (i < [colorProfilesArray count]) + { + [colorProfilesArray removeObjectAtIndex:i]; + } + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)clearColorsForTag:(id )tag +{ + NSAssert([(id )tag conformsToProtocol:@protocol(NSCopying)], @"Invalid tag"); + + dispatch_block_t block = ^{ @autoreleasepool { + + [colorProfilesDict removeObjectForKey:tag]; + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)clearColorsForAllFlags +{ + dispatch_block_t block = ^{ @autoreleasepool { + + [colorProfilesArray removeAllObjects]; + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)clearColorsForAllTags +{ + dispatch_block_t block = ^{ @autoreleasepool { + + [colorProfilesDict removeAllObjects]; + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)clearAllColors +{ + dispatch_block_t block = ^{ @autoreleasepool { + + [colorProfilesArray removeAllObjects]; + [colorProfilesDict removeAllObjects]; + }}; + + // The design of the setter logic below is taken from the DDAbstractLogger implementation. + // For documentation please refer to the DDAbstractLogger implementation. + + if ([self isOnInternalLoggerQueue]) + { + block(); + } + else + { + dispatch_queue_t globalLoggingQueue = [DDLog loggingQueue]; + NSAssert(![self isOnGlobalLoggingQueue], @"Core architecture requirement failure"); + + dispatch_async(globalLoggingQueue, ^{ + dispatch_async(loggerQueue, block); + }); + } +} + +- (void)logMessage:(DDLogMessage *)logMessage +{ + NSString *logMsg = logMessage->logMsg; + BOOL isFormatted = NO; + + if (formatter) + { + logMsg = [formatter formatLogMessage:logMessage]; + isFormatted = logMsg != logMessage->logMsg; + } + + if (logMsg) + { + // Search for a color profile associated with the log message + + DDTTYLoggerColorProfile *colorProfile = nil; + + if (colorsEnabled) + { + if (logMessage->tag) + { + colorProfile = [colorProfilesDict objectForKey:logMessage->tag]; + } + if (colorProfile == nil) + { + for (DDTTYLoggerColorProfile *cp in colorProfilesArray) + { + if ((logMessage->logFlag & cp->mask) && (logMessage->logContext == cp->context)) + { + colorProfile = cp; + break; + } + } + } + } + + // Convert log message to C string. + // + // We use the stack instead of the heap for speed if possible. + // But we're extra cautious to avoid a stack overflow. + + NSUInteger msgLen = [logMsg lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + const BOOL useStack = msgLen < (1024 * 4); + + char msgStack[useStack ? (msgLen + 1) : 1]; // Analyzer doesn't like zero-size array, hence the 1 + char *msg = useStack ? msgStack : (char *)malloc(msgLen + 1); + + [logMsg getCString:msg maxLength:(msgLen + 1) encoding:NSUTF8StringEncoding]; + + // Write the log message to STDERR + + if (isFormatted) + { + // The log message has already been formatted. + + struct iovec v[5]; + + if (colorProfile) + { + v[0].iov_base = colorProfile->fgCode; + v[0].iov_len = colorProfile->fgCodeLen; + + v[1].iov_base = colorProfile->bgCode; + v[1].iov_len = colorProfile->bgCodeLen; + + v[4].iov_base = colorProfile->resetCode; + v[4].iov_len = colorProfile->resetCodeLen; + } + else + { + v[0].iov_base = ""; + v[0].iov_len = 0; + + v[1].iov_base = ""; + v[1].iov_len = 0; + + v[4].iov_base = ""; + v[4].iov_len = 0; + } + + v[2].iov_base = (char *)msg; + v[2].iov_len = msgLen; + + v[3].iov_base = "\n"; + v[3].iov_len = (msg[msgLen] == '\n') ? 0 : 1; + + writev(STDERR_FILENO, v, 5); + } + else + { + // The log message is unformatted, so apply standard NSLog style formatting. + + int len; + + // Calculate timestamp. + // The technique below is faster than using NSDateFormatter. + + NSDateComponents *components = [calendar components:calendarUnitFlags fromDate:logMessage->timestamp]; + + NSTimeInterval epoch = [logMessage->timestamp timeIntervalSinceReferenceDate]; + int milliseconds = (int)((epoch - floor(epoch)) * 1000); + + char ts[24]; + len = snprintf(ts, 24, "%04ld-%02ld-%02ld %02ld:%02ld:%02ld:%03d", // yyyy-MM-dd HH:mm:ss:SSS + (long)components.year, + (long)components.month, + (long)components.day, + (long)components.hour, + (long)components.minute, + (long)components.second, milliseconds); + + size_t tsLen = MIN(24-1, len); + + // Calculate thread ID + // + // How many characters do we need for the thread id? + // logMessage->machThreadID is of type mach_port_t, which is an unsigned int. + // + // 1 hex char = 4 bits + // 8 hex chars for 32 bit, plus ending '\0' = 9 + + char tid[9]; + len = snprintf(tid, 9, "%x", logMessage->machThreadID); + + size_t tidLen = MIN(9-1, len); + + // Here is our format: "%s %s[%i:%s] %s", timestamp, appName, processID, threadID, logMsg + + struct iovec v[13]; + + if (colorProfile) + { + v[0].iov_base = colorProfile->fgCode; + v[0].iov_len = colorProfile->fgCodeLen; + + v[1].iov_base = colorProfile->bgCode; + v[1].iov_len = colorProfile->bgCodeLen; + + v[12].iov_base = colorProfile->resetCode; + v[12].iov_len = colorProfile->resetCodeLen; + } + else + { + v[0].iov_base = ""; + v[0].iov_len = 0; + + v[1].iov_base = ""; + v[1].iov_len = 0; + + v[12].iov_base = ""; + v[12].iov_len = 0; + } + + v[2].iov_base = ts; + v[2].iov_len = tsLen; + + v[3].iov_base = " "; + v[3].iov_len = 1; + + v[4].iov_base = app; + v[4].iov_len = appLen; + + v[5].iov_base = "["; + v[5].iov_len = 1; + + v[6].iov_base = pid; + v[6].iov_len = pidLen; + + v[7].iov_base = ":"; + v[7].iov_len = 1; + + v[8].iov_base = tid; + v[8].iov_len = MIN((size_t)8, tidLen); // snprintf doesn't return what you might think + + v[9].iov_base = "] "; + v[9].iov_len = 2; + + v[10].iov_base = (char *)msg; + v[10].iov_len = msgLen; + + v[11].iov_base = "\n"; + v[11].iov_len = (msg[msgLen] == '\n') ? 0 : 1; + + writev(STDERR_FILENO, v, 13); + } + + if (!useStack) { + free(msg); + } + } +} + +- (NSString *)loggerName +{ + return @"cocoa.lumberjack.ttyLogger"; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation DDTTYLoggerColorProfile + +- (id)initWithForegroundColor:(OSColor *)fgColor backgroundColor:(OSColor *)bgColor flag:(int)aMask context:(int)ctxt +{ + if ((self = [super init])) + { + mask = aMask; + context = ctxt; + + CGFloat r, g, b; + + if (fgColor) + { + [DDTTYLogger getRed:&r green:&g blue:&b fromColor:fgColor]; + + fg_r = (uint8_t)(r * 255.0f); + fg_g = (uint8_t)(g * 255.0f); + fg_b = (uint8_t)(b * 255.0f); + } + if (bgColor) + { + [DDTTYLogger getRed:&r green:&g blue:&b fromColor:bgColor]; + + bg_r = (uint8_t)(r * 255.0f); + bg_g = (uint8_t)(g * 255.0f); + bg_b = (uint8_t)(b * 255.0f); + } + + if (fgColor && isaColorTTY) + { + // Map foreground color to closest available shell color + + fgCodeIndex = [DDTTYLogger codeIndexForColor:fgColor]; + fgCodeRaw = [codes_fg objectAtIndex:fgCodeIndex]; + + NSString *escapeSeq = @"\033["; + + NSUInteger len1 = [escapeSeq lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + NSUInteger len2 = [fgCodeRaw lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + + [escapeSeq getCString:(fgCode) maxLength:(len1+1) encoding:NSUTF8StringEncoding]; + [fgCodeRaw getCString:(fgCode+len1) maxLength:(len2+1) encoding:NSUTF8StringEncoding]; + + fgCodeLen = len1+len2; + } + else if (fgColor && isaXcodeColorTTY) + { + // Convert foreground color to color code sequence + + const char *escapeSeq = XCODE_COLORS_ESCAPE_SEQ; + + int result = snprintf(fgCode, 24, "%sfg%u,%u,%u;", escapeSeq, fg_r, fg_g, fg_b); + fgCodeLen = MIN(result, (24-1)); + } + else + { + // No foreground color or no color support + + fgCode[0] = '\0'; + fgCodeLen = 0; + } + + if (bgColor && isaColorTTY) + { + // Map background color to closest available shell color + + bgCodeIndex = [DDTTYLogger codeIndexForColor:bgColor]; + bgCodeRaw = [codes_bg objectAtIndex:bgCodeIndex]; + + NSString *escapeSeq = @"\033["; + + NSUInteger len1 = [escapeSeq lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + NSUInteger len2 = [bgCodeRaw lengthOfBytesUsingEncoding:NSUTF8StringEncoding]; + + [escapeSeq getCString:(bgCode) maxLength:(len1+1) encoding:NSUTF8StringEncoding]; + [bgCodeRaw getCString:(bgCode+len1) maxLength:(len2+1) encoding:NSUTF8StringEncoding]; + + bgCodeLen = len1+len2; + } + else if (bgColor && isaXcodeColorTTY) + { + // Convert background color to color code sequence + + const char *escapeSeq = XCODE_COLORS_ESCAPE_SEQ; + + int result = snprintf(bgCode, 24, "%sbg%u,%u,%u;", escapeSeq, bg_r, bg_g, bg_b); + bgCodeLen = MIN(result, (24-1)); + } + else + { + // No background color or no color support + + bgCode[0] = '\0'; + bgCodeLen = 0; + } + + if (isaColorTTY) + { + resetCodeLen = snprintf(resetCode, 8, "\033[0m"); + } + else if (isaXcodeColorTTY) + { + resetCodeLen = snprintf(resetCode, 8, XCODE_COLORS_RESET); + } + else + { + resetCode[0] = '\0'; + resetCodeLen = 0; + } + } + return self; +} + +- (NSString *)description +{ + return [NSString stringWithFormat: + @"", + self, mask, context, fg_r, fg_g, fg_b, bg_r, bg_g, bg_b, fgCodeRaw, bgCodeRaw]; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.h new file mode 100644 index 00000000000..dffc8657e6e --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.h @@ -0,0 +1,65 @@ +#import +#import "DDLog.h" + +@class ContextFilterLogFormatter; + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" page. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * + * This class provides a log formatter that filters log statements from a logging context not on the whitelist. + * + * A log formatter can be added to any logger to format and/or filter its output. + * You can learn more about log formatters here: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomFormatters + * + * You can learn more about logging context's here: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomContext + * + * But here's a quick overview / refresher: + * + * Every log statement has a logging context. + * These come from the underlying logging macros defined in DDLog.h. + * The default logging context is zero. + * You can define multiple logging context's for use in your application. + * For example, logically separate parts of your app each have a different logging context. + * Also 3rd party frameworks that make use of Lumberjack generally use their own dedicated logging context. +**/ +@interface ContextWhitelistFilterLogFormatter : NSObject + +- (id)init; + +- (void)addToWhitelist:(int)loggingContext; +- (void)removeFromWhitelist:(int)loggingContext; + +- (NSArray *)whitelist; + +- (BOOL)isOnWhitelist:(int)loggingContext; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +/** + * This class provides a log formatter that filters log statements from a logging context on the blacklist. +**/ +@interface ContextBlacklistFilterLogFormatter : NSObject + +- (id)init; + +- (void)addToBlacklist:(int)loggingContext; +- (void)removeFromBlacklist:(int)loggingContext; + +- (NSArray *)blacklist; + +- (BOOL)isOnBlacklist:(int)loggingContext; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.m new file mode 100644 index 00000000000..9c024acc1d6 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.m @@ -0,0 +1,191 @@ +#import "ContextFilterLogFormatter.h" +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + +@interface LoggingContextSet : NSObject + +- (void)addToSet:(int)loggingContext; +- (void)removeFromSet:(int)loggingContext; + +- (NSArray *)currentSet; + +- (BOOL)isInSet:(int)loggingContext; + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation ContextWhitelistFilterLogFormatter +{ + LoggingContextSet *contextSet; +} + +- (id)init +{ + if ((self = [super init])) + { + contextSet = [[LoggingContextSet alloc] init]; + } + return self; +} + + +- (void)addToWhitelist:(int)loggingContext +{ + [contextSet addToSet:loggingContext]; +} + +- (void)removeFromWhitelist:(int)loggingContext +{ + [contextSet removeFromSet:loggingContext]; +} + +- (NSArray *)whitelist +{ + return [contextSet currentSet]; +} + +- (BOOL)isOnWhitelist:(int)loggingContext +{ + return [contextSet isInSet:loggingContext]; +} + +- (NSString *)formatLogMessage:(DDLogMessage *)logMessage +{ + if ([self isOnWhitelist:logMessage->logContext]) + return logMessage->logMsg; + else + return nil; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation ContextBlacklistFilterLogFormatter +{ + LoggingContextSet *contextSet; +} + +- (id)init +{ + if ((self = [super init])) + { + contextSet = [[LoggingContextSet alloc] init]; + } + return self; +} + + +- (void)addToBlacklist:(int)loggingContext +{ + [contextSet addToSet:loggingContext]; +} + +- (void)removeFromBlacklist:(int)loggingContext +{ + [contextSet removeFromSet:loggingContext]; +} + +- (NSArray *)blacklist +{ + return [contextSet currentSet]; +} + +- (BOOL)isOnBlacklist:(int)loggingContext +{ + return [contextSet isInSet:loggingContext]; +} + +- (NSString *)formatLogMessage:(DDLogMessage *)logMessage +{ + if ([self isOnBlacklist:logMessage->logContext]) + return nil; + else + return logMessage->logMsg; +} + +@end + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark - +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@implementation LoggingContextSet +{ + OSSpinLock lock; + NSMutableSet *set; +} + +- (id)init +{ + if ((self = [super init])) + { + set = [[NSMutableSet alloc] init]; + } + return self; +} + + +- (void)addToSet:(int)loggingContext +{ + OSSpinLockLock(&lock); + { + [set addObject:@(loggingContext)]; + } + OSSpinLockUnlock(&lock); +} + +- (void)removeFromSet:(int)loggingContext +{ + OSSpinLockLock(&lock); + { + [set removeObject:@(loggingContext)]; + } + OSSpinLockUnlock(&lock); +} + +- (NSArray *)currentSet +{ + NSArray *result = nil; + + OSSpinLockLock(&lock); + { + result = [set allObjects]; + } + OSSpinLockUnlock(&lock); + + return result; +} + +- (BOOL)isInSet:(int)loggingContext +{ + BOOL result = NO; + + OSSpinLockLock(&lock); + { + result = [set containsObject:@(loggingContext)]; + } + OSSpinLockUnlock(&lock); + + return result; +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.h b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.h new file mode 100644 index 00000000000..9ad8d3f4182 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.h @@ -0,0 +1,116 @@ +#import +#import +#import "DDLog.h" + + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" page. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted + * + * + * This class provides a log formatter that prints the dispatch_queue label instead of the mach_thread_id. + * + * A log formatter can be added to any logger to format and/or filter its output. + * You can learn more about log formatters here: + * https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomFormatters + * + * A typical NSLog (or DDTTYLogger) prints detailed info as [:]. + * For example: + * + * 2011-10-17 20:21:45.435 AppName[19928:5207] Your log message here + * + * Where: + * - 19928 = process id + * - 5207 = thread id (mach_thread_id printed in hex) + * + * When using grand central dispatch (GCD), this information is less useful. + * This is because a single serial dispatch queue may be run on any thread from an internally managed thread pool. + * For example: + * + * 2011-10-17 20:32:31.111 AppName[19954:4d07] Message from my_serial_dispatch_queue + * 2011-10-17 20:32:31.112 AppName[19954:5207] Message from my_serial_dispatch_queue + * 2011-10-17 20:32:31.113 AppName[19954:2c55] Message from my_serial_dispatch_queue + * + * This formatter allows you to replace the standard [box:info] with the dispatch_queue name. + * For example: + * + * 2011-10-17 20:32:31.111 AppName[img-scaling] Message from my_serial_dispatch_queue + * 2011-10-17 20:32:31.112 AppName[img-scaling] Message from my_serial_dispatch_queue + * 2011-10-17 20:32:31.113 AppName[img-scaling] Message from my_serial_dispatch_queue + * + * If the dispatch_queue doesn't have a set name, then it falls back to the thread name. + * If the current thread doesn't have a set name, then it falls back to the mach_thread_id in hex (like normal). + * + * Note: If manually creating your own background threads (via NSThread/alloc/init or NSThread/detachNeThread), + * you can use [[NSThread currentThread] setName:(NSString *)]. +**/ +@interface DispatchQueueLogFormatter : NSObject { +@protected + + NSString *dateFormatString; +} + +/** + * Standard init method. + * Configure using properties as desired. +**/ +- (id)init; + +/** + * The minQueueLength restricts the minimum size of the [detail box]. + * If the minQueueLength is set to 0, there is no restriction. + * + * For example, say a dispatch_queue has a label of "diskIO": + * + * If the minQueueLength is 0: [diskIO] + * If the minQueueLength is 4: [diskIO] + * If the minQueueLength is 5: [diskIO] + * If the minQueueLength is 6: [diskIO] + * If the minQueueLength is 7: [diskIO ] + * If the minQueueLength is 8: [diskIO ] + * + * The default minQueueLength is 0 (no minimum, so [detail box] won't be padded). + * + * If you want every [detail box] to have the exact same width, + * set both minQueueLength and maxQueueLength to the same value. +**/ +@property (assign) NSUInteger minQueueLength; + +/** + * The maxQueueLength restricts the number of characters that will be inside the [detail box]. + * If the maxQueueLength is 0, there is no restriction. + * + * For example, say a dispatch_queue has a label of "diskIO": + * + * If the maxQueueLength is 0: [diskIO] + * If the maxQueueLength is 4: [disk] + * If the maxQueueLength is 5: [diskI] + * If the maxQueueLength is 6: [diskIO] + * If the maxQueueLength is 7: [diskIO] + * If the maxQueueLength is 8: [diskIO] + * + * The default maxQueueLength is 0 (no maximum, so [detail box] won't be truncated). + * + * If you want every [detail box] to have the exact same width, + * set both minQueueLength and maxQueueLength to the same value. +**/ +@property (assign) NSUInteger maxQueueLength; + +/** + * Sometimes queue labels have long names like "com.apple.main-queue", + * but you'd prefer something shorter like simply "main". + * + * This method allows you to set such preferred replacements. + * The above example is set by default. + * + * To remove/undo a previous replacement, invoke this method with nil for the 'shortLabel' parameter. +**/ +- (NSString *)replacementStringForQueueLabel:(NSString *)longLabel; +- (void)setReplacementString:(NSString *)shortLabel forQueueLabel:(NSString *)longLabel; + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.m b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.m new file mode 100644 index 00000000000..d348f3dc778 --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.m @@ -0,0 +1,251 @@ +#import "DispatchQueueLogFormatter.h" +#import + +/** + * Welcome to Cocoa Lumberjack! + * + * The project page has a wealth of documentation if you have any questions. + * https://github.com/robbiehanson/CocoaLumberjack + * + * If you're new to the project you may wish to read the "Getting Started" wiki. + * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted +**/ + +#if ! __has_feature(objc_arc) +#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC). +#endif + + +@implementation DispatchQueueLogFormatter +{ + int32_t atomicLoggerCount; + NSDateFormatter *threadUnsafeDateFormatter; // Use [self stringFromDate] + + OSSpinLock lock; + + NSUInteger _minQueueLength; // _prefix == Only access via atomic property + NSUInteger _maxQueueLength; // _prefix == Only access via atomic property + NSMutableDictionary *_replacements; // _prefix == Only access from within spinlock +} + +- (id)init +{ + if ((self = [super init])) + { + dateFormatString = @"yyyy-MM-dd HH:mm:ss:SSS"; + + atomicLoggerCount = 0; + threadUnsafeDateFormatter = nil; + + _minQueueLength = 0; + _maxQueueLength = 0; + _replacements = [[NSMutableDictionary alloc] init]; + + // Set default replacements: + + [_replacements setObject:@"main" forKey:@"com.apple.main-thread"]; + } + return self; +} + + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark Configuration +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +@synthesize minQueueLength = _minQueueLength; +@synthesize maxQueueLength = _maxQueueLength; + +- (NSString *)replacementStringForQueueLabel:(NSString *)longLabel +{ + NSString *result = nil; + + OSSpinLockLock(&lock); + { + result = [_replacements objectForKey:longLabel]; + } + OSSpinLockUnlock(&lock); + + return result; +} + +- (void)setReplacementString:(NSString *)shortLabel forQueueLabel:(NSString *)longLabel +{ + OSSpinLockLock(&lock); + { + if (shortLabel) + [_replacements setObject:shortLabel forKey:longLabel]; + else + [_replacements removeObjectForKey:longLabel]; + } + OSSpinLockUnlock(&lock); +} + +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +#pragma mark DDLogFormatter +//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + +- (NSString *)stringFromDate:(NSDate *)date +{ + int32_t loggerCount = OSAtomicAdd32(0, &atomicLoggerCount); + + if (loggerCount <= 1) + { + // Single-threaded mode. + + if (threadUnsafeDateFormatter == nil) + { + threadUnsafeDateFormatter = [[NSDateFormatter alloc] init]; + [threadUnsafeDateFormatter setFormatterBehavior:NSDateFormatterBehavior10_4]; + [threadUnsafeDateFormatter setDateFormat:dateFormatString]; + } + + return [threadUnsafeDateFormatter stringFromDate:date]; + } + else + { + // Multi-threaded mode. + // NSDateFormatter is NOT thread-safe. + + NSString *key = @"DispatchQueueLogFormatter_NSDateFormatter"; + + NSMutableDictionary *threadDictionary = [[NSThread currentThread] threadDictionary]; + NSDateFormatter *dateFormatter = [threadDictionary objectForKey:key]; + + if (dateFormatter == nil) + { + dateFormatter = [[NSDateFormatter alloc] init]; + [dateFormatter setFormatterBehavior:NSDateFormatterBehavior10_4]; + [dateFormatter setDateFormat:dateFormatString]; + + [threadDictionary setObject:dateFormatter forKey:key]; + } + + return [dateFormatter stringFromDate:date]; + } +} + +- (NSString *)queueThreadLabelForLogMessage:(DDLogMessage *)logMessage +{ + // As per the DDLogFormatter contract, this method is always invoked on the same thread/dispatch_queue + + NSUInteger minQueueLength = self.minQueueLength; + NSUInteger maxQueueLength = self.maxQueueLength; + + // Get the name of the queue, thread, or machID (whichever we are to use). + + NSString *queueThreadLabel = nil; + + BOOL useQueueLabel = YES; + BOOL useThreadName = NO; + + if (logMessage->queueLabel) + { + // If you manually create a thread, it's dispatch_queue will have one of the thread names below. + // Since all such threads have the same name, we'd prefer to use the threadName or the machThreadID. + + char *names[] = { "com.apple.root.low-priority", + "com.apple.root.default-priority", + "com.apple.root.high-priority", + "com.apple.root.low-overcommit-priority", + "com.apple.root.default-overcommit-priority", + "com.apple.root.high-overcommit-priority" }; + + int length = sizeof(names) / sizeof(char *); + + int i; + for (i = 0; i < length; i++) + { + if (strcmp(logMessage->queueLabel, names[i]) == 0) + { + useQueueLabel = NO; + useThreadName = [logMessage->threadName length] > 0; + break; + } + } + } + else + { + useQueueLabel = NO; + useThreadName = [logMessage->threadName length] > 0; + } + + if (useQueueLabel || useThreadName) + { + NSString *fullLabel; + NSString *abrvLabel; + + if (useQueueLabel) + fullLabel = @(logMessage->queueLabel); + else + fullLabel = logMessage->threadName; + + OSSpinLockLock(&lock); + { + abrvLabel = [_replacements objectForKey:fullLabel]; + } + OSSpinLockUnlock(&lock); + + if (abrvLabel) + queueThreadLabel = abrvLabel; + else + queueThreadLabel = fullLabel; + } + else + { + queueThreadLabel = [NSString stringWithFormat:@"%x", logMessage->machThreadID]; + } + + // Now use the thread label in the output + + NSUInteger labelLength = [queueThreadLabel length]; + + // labelLength > maxQueueLength : truncate + // labelLength < minQueueLength : padding + // : exact + + if ((maxQueueLength > 0) && (labelLength > maxQueueLength)) + { + // Truncate + + return [queueThreadLabel substringToIndex:maxQueueLength]; + } + else if (labelLength < minQueueLength) + { + // Padding + + NSUInteger numSpaces = minQueueLength - labelLength; + + char spaces[numSpaces + 1]; + memset(spaces, ' ', numSpaces); + spaces[numSpaces] = '\0'; + + return [NSString stringWithFormat:@"%@%s", queueThreadLabel, spaces]; + } + else + { + // Exact + + return queueThreadLabel; + } +} + +- (NSString *)formatLogMessage:(DDLogMessage *)logMessage +{ + NSString *timestamp = [self stringFromDate:(logMessage->timestamp)]; + NSString *queueThreadLabel = [self queueThreadLabelForLogMessage:logMessage]; + + return [NSString stringWithFormat:@"%@ [%@] %@", timestamp, queueThreadLabel, logMessage->logMsg]; +} + +- (void)didAddToLogger:(id )logger +{ + OSAtomicIncrement32(&atomicLoggerCount); +} + +- (void)willRemoveFromLogger:(id )logger +{ + OSAtomicDecrement32(&atomicLoggerCount); +} + +@end diff --git a/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/README.txt b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/README.txt new file mode 100644 index 00000000000..eb20e50138e --- /dev/null +++ b/platform/iphone/CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/README.txt @@ -0,0 +1,7 @@ +This folder contains some sample formatters that may be helpful. + +Feel free to change them, extend them, or use them as the basis for your own custom formatter(s). + +More information about creating your own custom formatters can be found on the wiki: +https://github.com/robbiehanson/CocoaLumberjack/wiki/CustomFormatters + diff --git a/platform/iphone/RhoAppBaseLib/RhoAppBaseLib.xcodeproj/project.pbxproj b/platform/iphone/RhoAppBaseLib/RhoAppBaseLib.xcodeproj/project.pbxproj index 6bca91b8a0c..186f53f7dd0 100644 --- a/platform/iphone/RhoAppBaseLib/RhoAppBaseLib.xcodeproj/project.pbxproj +++ b/platform/iphone/RhoAppBaseLib/RhoAppBaseLib.xcodeproj/project.pbxproj @@ -142,6 +142,106 @@ FAA714991DDCAB6D00E5E7AD /* RhoWKWebView.mm in Sources */ = {isa = PBXBuildFile; fileRef = FAA714951DDCAB6D00E5E7AD /* RhoWKWebView.mm */; }; FAA7149F1DDCAE2B00E5E7AD /* RhoWebViewFabrique.h in Headers */ = {isa = PBXBuildFile; fileRef = FAA7149D1DDCAE2B00E5E7AD /* RhoWebViewFabrique.h */; }; FAA714A01DDCAE2B00E5E7AD /* RhoWebViewFabrique.m in Sources */ = {isa = PBXBuildFile; fileRef = FAA7149E1DDCAE2B00E5E7AD /* RhoWebViewFabrique.m */; }; + FAE2F03527EC187F000DC2DA /* DDLog.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F02B27EC187E000DC2DA /* DDLog.m */; }; + FAE2F03627EC187F000DC2DA /* DDTTYLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F02C27EC187E000DC2DA /* DDTTYLogger.h */; }; + FAE2F03727EC187F000DC2DA /* DDFileLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F02D27EC187E000DC2DA /* DDFileLogger.h */; }; + FAE2F03827EC187F000DC2DA /* DDLog.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F02E27EC187E000DC2DA /* DDLog.h */; }; + FAE2F03927EC187F000DC2DA /* DDASLLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F02F27EC187F000DC2DA /* DDASLLogger.m */; }; + FAE2F03A27EC187F000DC2DA /* DDTTYLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F03027EC187F000DC2DA /* DDTTYLogger.m */; }; + FAE2F03B27EC187F000DC2DA /* DDASLLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F03127EC187F000DC2DA /* DDASLLogger.h */; }; + FAE2F03C27EC187F000DC2DA /* DDAbstractDatabaseLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F03227EC187F000DC2DA /* DDAbstractDatabaseLogger.m */; }; + FAE2F03D27EC187F000DC2DA /* DDAbstractDatabaseLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F03327EC187F000DC2DA /* DDAbstractDatabaseLogger.h */; }; + FAE2F03E27EC187F000DC2DA /* DDFileLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F03427EC187F000DC2DA /* DDFileLogger.m */; }; + FAE2F04027EC1897000DC2DA /* DDASLLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F02F27EC187F000DC2DA /* DDASLLogger.m */; }; + FAE2F04127EC1897000DC2DA /* DDASLLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F03127EC187F000DC2DA /* DDASLLogger.h */; }; + FAE2F04227EC1897000DC2DA /* DDLog.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F02E27EC187E000DC2DA /* DDLog.h */; }; + FAE2F04327EC1897000DC2DA /* DDFileLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F03427EC187F000DC2DA /* DDFileLogger.m */; }; + FAE2F04427EC1897000DC2DA /* DDFileLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F02D27EC187E000DC2DA /* DDFileLogger.h */; }; + FAE2F04527EC1897000DC2DA /* DDLog.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F02B27EC187E000DC2DA /* DDLog.m */; }; + FAE2F04627EC1897000DC2DA /* DDTTYLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F03027EC187F000DC2DA /* DDTTYLogger.m */; }; + FAE2F04727EC1897000DC2DA /* DDAbstractDatabaseLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F03327EC187F000DC2DA /* DDAbstractDatabaseLogger.h */; }; + FAE2F04827EC1897000DC2DA /* DDAbstractDatabaseLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F03227EC187F000DC2DA /* DDAbstractDatabaseLogger.m */; }; + FAE2F04927EC1897000DC2DA /* DDTTYLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F02C27EC187E000DC2DA /* DDTTYLogger.h */; }; + FAE2F04E27EC18AB000DC2DA /* DispatchQueueLogFormatter.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F04A27EC18AB000DC2DA /* DispatchQueueLogFormatter.m */; }; + FAE2F04F27EC18AB000DC2DA /* DispatchQueueLogFormatter.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F04A27EC18AB000DC2DA /* DispatchQueueLogFormatter.m */; }; + FAE2F05027EC18AB000DC2DA /* ContextFilterLogFormatter.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F04B27EC18AB000DC2DA /* ContextFilterLogFormatter.h */; }; + FAE2F05127EC18AB000DC2DA /* ContextFilterLogFormatter.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F04B27EC18AB000DC2DA /* ContextFilterLogFormatter.h */; }; + FAE2F05227EC18AB000DC2DA /* ContextFilterLogFormatter.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F04C27EC18AB000DC2DA /* ContextFilterLogFormatter.m */; }; + FAE2F05327EC18AB000DC2DA /* ContextFilterLogFormatter.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F04C27EC18AB000DC2DA /* ContextFilterLogFormatter.m */; }; + FAE2F05427EC18AB000DC2DA /* DispatchQueueLogFormatter.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F04D27EC18AB000DC2DA /* DispatchQueueLogFormatter.h */; }; + FAE2F05527EC18AB000DC2DA /* DispatchQueueLogFormatter.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F04D27EC18AB000DC2DA /* DispatchQueueLogFormatter.h */; }; + FAE2F05827EC18C4000DC2DA /* GCDAsyncSocket.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F05627EC18C4000DC2DA /* GCDAsyncSocket.m */; }; + FAE2F05927EC18C4000DC2DA /* GCDAsyncSocket.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F05627EC18C4000DC2DA /* GCDAsyncSocket.m */; }; + FAE2F05A27EC18C4000DC2DA /* GCDAsyncSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F05727EC18C4000DC2DA /* GCDAsyncSocket.h */; }; + FAE2F05B27EC18C4000DC2DA /* GCDAsyncSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F05727EC18C4000DC2DA /* GCDAsyncSocket.h */; }; + FAE2F06827EC1907000DC2DA /* HTTPConnection.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F05C27EC1906000DC2DA /* HTTPConnection.m */; }; + FAE2F06927EC1907000DC2DA /* HTTPConnection.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F05C27EC1906000DC2DA /* HTTPConnection.m */; }; + FAE2F06A27EC1907000DC2DA /* HTTPResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F05D27EC1906000DC2DA /* HTTPResponse.h */; }; + FAE2F06B27EC1907000DC2DA /* HTTPResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F05D27EC1906000DC2DA /* HTTPResponse.h */; }; + FAE2F06C27EC1907000DC2DA /* HTTPServer.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F05E27EC1907000DC2DA /* HTTPServer.m */; }; + FAE2F06D27EC1907000DC2DA /* HTTPServer.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F05E27EC1907000DC2DA /* HTTPServer.m */; }; + FAE2F06E27EC1907000DC2DA /* HTTPLogging.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F05F27EC1907000DC2DA /* HTTPLogging.h */; }; + FAE2F06F27EC1907000DC2DA /* HTTPLogging.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F05F27EC1907000DC2DA /* HTTPLogging.h */; }; + FAE2F07027EC1907000DC2DA /* WebSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06027EC1907000DC2DA /* WebSocket.h */; }; + FAE2F07127EC1907000DC2DA /* WebSocket.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06027EC1907000DC2DA /* WebSocket.h */; }; + FAE2F07227EC1907000DC2DA /* HTTPMessage.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F06127EC1907000DC2DA /* HTTPMessage.m */; }; + FAE2F07327EC1907000DC2DA /* HTTPMessage.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F06127EC1907000DC2DA /* HTTPMessage.m */; }; + FAE2F07427EC1907000DC2DA /* HTTPConnection.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06227EC1907000DC2DA /* HTTPConnection.h */; }; + FAE2F07527EC1907000DC2DA /* HTTPConnection.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06227EC1907000DC2DA /* HTTPConnection.h */; }; + FAE2F07627EC1907000DC2DA /* HTTPMessage.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06327EC1907000DC2DA /* HTTPMessage.h */; }; + FAE2F07727EC1907000DC2DA /* HTTPMessage.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06327EC1907000DC2DA /* HTTPMessage.h */; }; + FAE2F07827EC1907000DC2DA /* HTTPAuthenticationRequest.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F06427EC1907000DC2DA /* HTTPAuthenticationRequest.m */; }; + FAE2F07927EC1907000DC2DA /* HTTPAuthenticationRequest.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F06427EC1907000DC2DA /* HTTPAuthenticationRequest.m */; }; + FAE2F07A27EC1907000DC2DA /* HTTPAuthenticationRequest.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06527EC1907000DC2DA /* HTTPAuthenticationRequest.h */; }; + FAE2F07B27EC1907000DC2DA /* HTTPAuthenticationRequest.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06527EC1907000DC2DA /* HTTPAuthenticationRequest.h */; }; + FAE2F07C27EC1907000DC2DA /* WebSocket.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F06627EC1907000DC2DA /* WebSocket.m */; }; + FAE2F07D27EC1907000DC2DA /* WebSocket.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F06627EC1907000DC2DA /* WebSocket.m */; }; + FAE2F07E27EC1907000DC2DA /* HTTPServer.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06727EC1907000DC2DA /* HTTPServer.h */; }; + FAE2F07F27EC1907000DC2DA /* HTTPServer.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F06727EC1907000DC2DA /* HTTPServer.h */; }; + FAE2F08E27EC1935000DC2DA /* HTTPDynamicFileResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08227EC1935000DC2DA /* HTTPDynamicFileResponse.m */; }; + FAE2F08F27EC1935000DC2DA /* HTTPDynamicFileResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08227EC1935000DC2DA /* HTTPDynamicFileResponse.m */; }; + FAE2F09027EC1935000DC2DA /* HTTPDynamicFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08327EC1935000DC2DA /* HTTPDynamicFileResponse.h */; }; + FAE2F09127EC1935000DC2DA /* HTTPDynamicFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08327EC1935000DC2DA /* HTTPDynamicFileResponse.h */; }; + FAE2F09227EC1935000DC2DA /* HTTPDataResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08427EC1935000DC2DA /* HTTPDataResponse.h */; }; + FAE2F09327EC1935000DC2DA /* HTTPDataResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08427EC1935000DC2DA /* HTTPDataResponse.h */; }; + FAE2F09427EC1935000DC2DA /* HTTPFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08527EC1935000DC2DA /* HTTPFileResponse.h */; }; + FAE2F09527EC1935000DC2DA /* HTTPFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08527EC1935000DC2DA /* HTTPFileResponse.h */; }; + FAE2F09627EC1936000DC2DA /* HTTPFileResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08627EC1935000DC2DA /* HTTPFileResponse.m */; }; + FAE2F09727EC1936000DC2DA /* HTTPFileResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08627EC1935000DC2DA /* HTTPFileResponse.m */; }; + FAE2F09827EC1936000DC2DA /* HTTPRedirectResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08727EC1935000DC2DA /* HTTPRedirectResponse.h */; }; + FAE2F09927EC1936000DC2DA /* HTTPRedirectResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08727EC1935000DC2DA /* HTTPRedirectResponse.h */; }; + FAE2F09A27EC1936000DC2DA /* HTTPErrorResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08827EC1935000DC2DA /* HTTPErrorResponse.m */; }; + FAE2F09B27EC1936000DC2DA /* HTTPErrorResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08827EC1935000DC2DA /* HTTPErrorResponse.m */; }; + FAE2F09C27EC1936000DC2DA /* HTTPAsyncFileResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08927EC1935000DC2DA /* HTTPAsyncFileResponse.m */; }; + FAE2F09D27EC1936000DC2DA /* HTTPAsyncFileResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08927EC1935000DC2DA /* HTTPAsyncFileResponse.m */; }; + FAE2F09E27EC1936000DC2DA /* HTTPRedirectResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08A27EC1935000DC2DA /* HTTPRedirectResponse.m */; }; + FAE2F09F27EC1936000DC2DA /* HTTPRedirectResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08A27EC1935000DC2DA /* HTTPRedirectResponse.m */; }; + FAE2F0A027EC1936000DC2DA /* HTTPDataResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08B27EC1935000DC2DA /* HTTPDataResponse.m */; }; + FAE2F0A127EC1936000DC2DA /* HTTPDataResponse.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F08B27EC1935000DC2DA /* HTTPDataResponse.m */; }; + FAE2F0A227EC1936000DC2DA /* HTTPErrorResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08C27EC1935000DC2DA /* HTTPErrorResponse.h */; }; + FAE2F0A327EC1936000DC2DA /* HTTPErrorResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08C27EC1935000DC2DA /* HTTPErrorResponse.h */; }; + FAE2F0A427EC1936000DC2DA /* HTTPAsyncFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08D27EC1935000DC2DA /* HTTPAsyncFileResponse.h */; }; + FAE2F0A527EC1936000DC2DA /* HTTPAsyncFileResponse.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F08D27EC1935000DC2DA /* HTTPAsyncFileResponse.h */; }; + FAE2F0AC27EC1955000DC2DA /* DDData.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0A627EC1955000DC2DA /* DDData.h */; }; + FAE2F0AD27EC1955000DC2DA /* DDData.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0A627EC1955000DC2DA /* DDData.h */; }; + FAE2F0AE27EC1955000DC2DA /* DDRange.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0A727EC1955000DC2DA /* DDRange.h */; }; + FAE2F0AF27EC1955000DC2DA /* DDRange.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0A727EC1955000DC2DA /* DDRange.h */; }; + FAE2F0B027EC1955000DC2DA /* DDNumber.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0A827EC1955000DC2DA /* DDNumber.m */; }; + FAE2F0B127EC1955000DC2DA /* DDNumber.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0A827EC1955000DC2DA /* DDNumber.m */; }; + FAE2F0B227EC1955000DC2DA /* DDRange.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0A927EC1955000DC2DA /* DDRange.m */; }; + FAE2F0B327EC1955000DC2DA /* DDRange.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0A927EC1955000DC2DA /* DDRange.m */; }; + FAE2F0B427EC1955000DC2DA /* DDNumber.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0AA27EC1955000DC2DA /* DDNumber.h */; }; + FAE2F0B527EC1955000DC2DA /* DDNumber.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0AA27EC1955000DC2DA /* DDNumber.h */; }; + FAE2F0B627EC1955000DC2DA /* DDData.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0AB27EC1955000DC2DA /* DDData.m */; }; + FAE2F0B727EC1955000DC2DA /* DDData.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0AB27EC1955000DC2DA /* DDData.m */; }; + FAE2F0BA27EC20AE000DC2DA /* CCocoaServer.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0B827EC20AE000DC2DA /* CCocoaServer.h */; }; + FAE2F0BB27EC20AE000DC2DA /* CCocoaServer.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0B827EC20AE000DC2DA /* CCocoaServer.h */; }; + FAE2F0BC27EC20AE000DC2DA /* CCocoaServer.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0B927EC20AE000DC2DA /* CCocoaServer.m */; }; + FAE2F0BD27EC20AE000DC2DA /* CCocoaServer.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0B927EC20AE000DC2DA /* CCocoaServer.m */; }; + FAE2F0C027EC26D9000DC2DA /* RhoHTTPConnection.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0BE27EC26D9000DC2DA /* RhoHTTPConnection.m */; }; + FAE2F0C127EC26D9000DC2DA /* RhoHTTPConnection.m in Sources */ = {isa = PBXBuildFile; fileRef = FAE2F0BE27EC26D9000DC2DA /* RhoHTTPConnection.m */; }; + FAE2F0C227EC26D9000DC2DA /* RhoHTTPConnection.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0BF27EC26D9000DC2DA /* RhoHTTPConnection.h */; }; + FAE2F0C327EC26D9000DC2DA /* RhoHTTPConnection.h in Headers */ = {isa = PBXBuildFile; fileRef = FAE2F0BF27EC26D9000DC2DA /* RhoHTTPConnection.h */; }; FAE78BE122583F6C001A1150 /* RightViewController.h in Headers */ = {isa = PBXBuildFile; fileRef = FA20C248182B04140036D304 /* RightViewController.h */; }; FAE78BE222583F6C001A1150 /* SignatureViewController.h in Headers */ = {isa = PBXBuildFile; fileRef = FA20C285182B04140036D304 /* SignatureViewController.h */; }; FAE78BE322583F6C001A1150 /* DateTimePickerViewController.h in Headers */ = {isa = PBXBuildFile; fileRef = FA20C236182B04140036D304 /* DateTimePickerViewController.h */; }; @@ -396,6 +496,56 @@ FAA7149B1DDCADC100E5E7AD /* WebKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = WebKit.framework; path = Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS10.1.sdk/System/Library/Frameworks/WebKit.framework; sourceTree = DEVELOPER_DIR; }; FAA7149D1DDCAE2B00E5E7AD /* RhoWebViewFabrique.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RhoWebViewFabrique.h; sourceTree = ""; }; FAA7149E1DDCAE2B00E5E7AD /* RhoWebViewFabrique.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RhoWebViewFabrique.m; sourceTree = ""; }; + FAE2F02B27EC187E000DC2DA /* DDLog.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDLog.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.m; sourceTree = ""; }; + FAE2F02C27EC187E000DC2DA /* DDTTYLogger.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDTTYLogger.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.h; sourceTree = ""; }; + FAE2F02D27EC187E000DC2DA /* DDFileLogger.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDFileLogger.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.h; sourceTree = ""; }; + FAE2F02E27EC187E000DC2DA /* DDLog.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDLog.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDLog.h; sourceTree = ""; }; + FAE2F02F27EC187F000DC2DA /* DDASLLogger.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDASLLogger.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.m; sourceTree = ""; }; + FAE2F03027EC187F000DC2DA /* DDTTYLogger.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDTTYLogger.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDTTYLogger.m; sourceTree = ""; }; + FAE2F03127EC187F000DC2DA /* DDASLLogger.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDASLLogger.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDASLLogger.h; sourceTree = ""; }; + FAE2F03227EC187F000DC2DA /* DDAbstractDatabaseLogger.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDAbstractDatabaseLogger.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.m; sourceTree = ""; }; + FAE2F03327EC187F000DC2DA /* DDAbstractDatabaseLogger.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDAbstractDatabaseLogger.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDAbstractDatabaseLogger.h; sourceTree = ""; }; + FAE2F03427EC187F000DC2DA /* DDFileLogger.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDFileLogger.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/DDFileLogger.m; sourceTree = ""; }; + FAE2F04A27EC18AB000DC2DA /* DispatchQueueLogFormatter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DispatchQueueLogFormatter.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.m; sourceTree = ""; }; + FAE2F04B27EC18AB000DC2DA /* ContextFilterLogFormatter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = ContextFilterLogFormatter.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.h; sourceTree = ""; }; + FAE2F04C27EC18AB000DC2DA /* ContextFilterLogFormatter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = ContextFilterLogFormatter.m; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/ContextFilterLogFormatter.m; sourceTree = ""; }; + FAE2F04D27EC18AB000DC2DA /* DispatchQueueLogFormatter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DispatchQueueLogFormatter.h; path = ../CocoaHTTPServer/Vendor/CocoaLumberjack/Extensions/DispatchQueueLogFormatter.h; sourceTree = ""; }; + FAE2F05627EC18C4000DC2DA /* GCDAsyncSocket.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = GCDAsyncSocket.m; path = ../CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.m; sourceTree = ""; }; + FAE2F05727EC18C4000DC2DA /* GCDAsyncSocket.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = GCDAsyncSocket.h; path = ../CocoaHTTPServer/Vendor/CocoaAsyncSocket/GCDAsyncSocket.h; sourceTree = ""; }; + FAE2F05C27EC1906000DC2DA /* HTTPConnection.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPConnection.m; path = ../CocoaHTTPServer/Core/HTTPConnection.m; sourceTree = ""; }; + FAE2F05D27EC1906000DC2DA /* HTTPResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPResponse.h; path = ../CocoaHTTPServer/Core/HTTPResponse.h; sourceTree = ""; }; + FAE2F05E27EC1907000DC2DA /* HTTPServer.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPServer.m; path = ../CocoaHTTPServer/Core/HTTPServer.m; sourceTree = ""; }; + FAE2F05F27EC1907000DC2DA /* HTTPLogging.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPLogging.h; path = ../CocoaHTTPServer/Core/HTTPLogging.h; sourceTree = ""; }; + FAE2F06027EC1907000DC2DA /* WebSocket.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = WebSocket.h; path = ../CocoaHTTPServer/Core/WebSocket.h; sourceTree = ""; }; + FAE2F06127EC1907000DC2DA /* HTTPMessage.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPMessage.m; path = ../CocoaHTTPServer/Core/HTTPMessage.m; sourceTree = ""; }; + FAE2F06227EC1907000DC2DA /* HTTPConnection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPConnection.h; path = ../CocoaHTTPServer/Core/HTTPConnection.h; sourceTree = ""; }; + FAE2F06327EC1907000DC2DA /* HTTPMessage.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPMessage.h; path = ../CocoaHTTPServer/Core/HTTPMessage.h; sourceTree = ""; }; + FAE2F06427EC1907000DC2DA /* HTTPAuthenticationRequest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPAuthenticationRequest.m; path = ../CocoaHTTPServer/Core/HTTPAuthenticationRequest.m; sourceTree = ""; }; + FAE2F06527EC1907000DC2DA /* HTTPAuthenticationRequest.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPAuthenticationRequest.h; path = ../CocoaHTTPServer/Core/HTTPAuthenticationRequest.h; sourceTree = ""; }; + FAE2F06627EC1907000DC2DA /* WebSocket.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = WebSocket.m; path = ../CocoaHTTPServer/Core/WebSocket.m; sourceTree = ""; }; + FAE2F06727EC1907000DC2DA /* HTTPServer.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPServer.h; path = ../CocoaHTTPServer/Core/HTTPServer.h; sourceTree = ""; }; + FAE2F08227EC1935000DC2DA /* HTTPDynamicFileResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPDynamicFileResponse.m; path = ../CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.m; sourceTree = ""; }; + FAE2F08327EC1935000DC2DA /* HTTPDynamicFileResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPDynamicFileResponse.h; path = ../CocoaHTTPServer/Core/Responses/HTTPDynamicFileResponse.h; sourceTree = ""; }; + FAE2F08427EC1935000DC2DA /* HTTPDataResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPDataResponse.h; path = ../CocoaHTTPServer/Core/Responses/HTTPDataResponse.h; sourceTree = ""; }; + FAE2F08527EC1935000DC2DA /* HTTPFileResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPFileResponse.h; path = ../CocoaHTTPServer/Core/Responses/HTTPFileResponse.h; sourceTree = ""; }; + FAE2F08627EC1935000DC2DA /* HTTPFileResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPFileResponse.m; path = ../CocoaHTTPServer/Core/Responses/HTTPFileResponse.m; sourceTree = ""; }; + FAE2F08727EC1935000DC2DA /* HTTPRedirectResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPRedirectResponse.h; path = ../CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.h; sourceTree = ""; }; + FAE2F08827EC1935000DC2DA /* HTTPErrorResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPErrorResponse.m; path = ../CocoaHTTPServer/Core/Responses/HTTPErrorResponse.m; sourceTree = ""; }; + FAE2F08927EC1935000DC2DA /* HTTPAsyncFileResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPAsyncFileResponse.m; path = ../CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.m; sourceTree = ""; }; + FAE2F08A27EC1935000DC2DA /* HTTPRedirectResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPRedirectResponse.m; path = ../CocoaHTTPServer/Core/Responses/HTTPRedirectResponse.m; sourceTree = ""; }; + FAE2F08B27EC1935000DC2DA /* HTTPDataResponse.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = HTTPDataResponse.m; path = ../CocoaHTTPServer/Core/Responses/HTTPDataResponse.m; sourceTree = ""; }; + FAE2F08C27EC1935000DC2DA /* HTTPErrorResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPErrorResponse.h; path = ../CocoaHTTPServer/Core/Responses/HTTPErrorResponse.h; sourceTree = ""; }; + FAE2F08D27EC1935000DC2DA /* HTTPAsyncFileResponse.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTTPAsyncFileResponse.h; path = ../CocoaHTTPServer/Core/Responses/HTTPAsyncFileResponse.h; sourceTree = ""; }; + FAE2F0A627EC1955000DC2DA /* DDData.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDData.h; path = ../CocoaHTTPServer/Core/Categories/DDData.h; sourceTree = ""; }; + FAE2F0A727EC1955000DC2DA /* DDRange.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDRange.h; path = ../CocoaHTTPServer/Core/Categories/DDRange.h; sourceTree = ""; }; + FAE2F0A827EC1955000DC2DA /* DDNumber.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDNumber.m; path = ../CocoaHTTPServer/Core/Categories/DDNumber.m; sourceTree = ""; }; + FAE2F0A927EC1955000DC2DA /* DDRange.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDRange.m; path = ../CocoaHTTPServer/Core/Categories/DDRange.m; sourceTree = ""; }; + FAE2F0AA27EC1955000DC2DA /* DDNumber.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = DDNumber.h; path = ../CocoaHTTPServer/Core/Categories/DDNumber.h; sourceTree = ""; }; + FAE2F0AB27EC1955000DC2DA /* DDData.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = DDData.m; path = ../CocoaHTTPServer/Core/Categories/DDData.m; sourceTree = ""; }; + FAE2F0B827EC20AE000DC2DA /* CCocoaServer.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CCocoaServer.h; path = CocoaServer/CCocoaServer.h; sourceTree = ""; }; + FAE2F0B927EC20AE000DC2DA /* CCocoaServer.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CCocoaServer.m; path = CocoaServer/CCocoaServer.m; sourceTree = ""; }; + FAE2F0BE27EC26D9000DC2DA /* RhoHTTPConnection.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = RhoHTTPConnection.m; path = CocoaServer/RhoHTTPConnection.m; sourceTree = ""; }; + FAE2F0BF27EC26D9000DC2DA /* RhoHTTPConnection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = RhoHTTPConnection.h; path = CocoaServer/RhoHTTPConnection.h; sourceTree = ""; }; FAE78C5C22583F6C001A1150 /* libRhoAppBaseStandaloneLib.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libRhoAppBaseStandaloneLib.a; sourceTree = BUILT_PRODUCTS_DIR; }; FAE78CE0225D0EC5001A1150 /* RhoMainViewStubImpl.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RhoMainViewStubImpl.h; sourceTree = ""; }; FAE78CE1225D0EC5001A1150 /* RhoMainViewStubImpl.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RhoMainViewStubImpl.m; sourceTree = ""; }; @@ -758,6 +908,7 @@ FA20C29B182B04140036D304 /* Classes */ = { isa = PBXGroup; children = ( + FAE2F02627EC1785000DC2DA /* CocoaServer */, FA11F2471921214A00FB1301 /* RhoExtManager */, C5DFBB30185B6FB400DB6BDB /* IAppMessageReceiver.h */, FA20C21B182B04140036D304 /* Signature.old */, @@ -810,6 +961,119 @@ name = Frameworks; sourceTree = ""; }; + FAE2F02627EC1785000DC2DA /* CocoaServer */ = { + isa = PBXGroup; + children = ( + FAE2F0BF27EC26D9000DC2DA /* RhoHTTPConnection.h */, + FAE2F0BE27EC26D9000DC2DA /* RhoHTTPConnection.m */, + FAE2F0B827EC20AE000DC2DA /* CCocoaServer.h */, + FAE2F0B927EC20AE000DC2DA /* CCocoaServer.m */, + FAE2F02727EC1793000DC2DA /* CocoaHTTPServer */, + ); + name = CocoaServer; + sourceTree = ""; + }; + FAE2F02727EC1793000DC2DA /* CocoaHTTPServer */ = { + isa = PBXGroup; + children = ( + FAE2F02A27EC17D6000DC2DA /* HTTP */, + FAE2F02927EC17D0000DC2DA /* TCP */, + FAE2F02827EC17C9000DC2DA /* Logging */, + ); + name = CocoaHTTPServer; + sourceTree = ""; + }; + FAE2F02827EC17C9000DC2DA /* Logging */ = { + isa = PBXGroup; + children = ( + FAE2F03F27EC1883000DC2DA /* Extensions */, + FAE2F03327EC187F000DC2DA /* DDAbstractDatabaseLogger.h */, + FAE2F03227EC187F000DC2DA /* DDAbstractDatabaseLogger.m */, + FAE2F03127EC187F000DC2DA /* DDASLLogger.h */, + FAE2F02F27EC187F000DC2DA /* DDASLLogger.m */, + FAE2F02D27EC187E000DC2DA /* DDFileLogger.h */, + FAE2F03427EC187F000DC2DA /* DDFileLogger.m */, + FAE2F02E27EC187E000DC2DA /* DDLog.h */, + FAE2F02B27EC187E000DC2DA /* DDLog.m */, + FAE2F02C27EC187E000DC2DA /* DDTTYLogger.h */, + FAE2F03027EC187F000DC2DA /* DDTTYLogger.m */, + ); + name = Logging; + sourceTree = ""; + }; + FAE2F02927EC17D0000DC2DA /* TCP */ = { + isa = PBXGroup; + children = ( + FAE2F05727EC18C4000DC2DA /* GCDAsyncSocket.h */, + FAE2F05627EC18C4000DC2DA /* GCDAsyncSocket.m */, + ); + name = TCP; + sourceTree = ""; + }; + FAE2F02A27EC17D6000DC2DA /* HTTP */ = { + isa = PBXGroup; + children = ( + FAE2F08127EC191D000DC2DA /* Categories */, + FAE2F08027EC190F000DC2DA /* Responses */, + FAE2F06527EC1907000DC2DA /* HTTPAuthenticationRequest.h */, + FAE2F06427EC1907000DC2DA /* HTTPAuthenticationRequest.m */, + FAE2F06227EC1907000DC2DA /* HTTPConnection.h */, + FAE2F05C27EC1906000DC2DA /* HTTPConnection.m */, + FAE2F05F27EC1907000DC2DA /* HTTPLogging.h */, + FAE2F06327EC1907000DC2DA /* HTTPMessage.h */, + FAE2F06127EC1907000DC2DA /* HTTPMessage.m */, + FAE2F05D27EC1906000DC2DA /* HTTPResponse.h */, + FAE2F06727EC1907000DC2DA /* HTTPServer.h */, + FAE2F05E27EC1907000DC2DA /* HTTPServer.m */, + FAE2F06027EC1907000DC2DA /* WebSocket.h */, + FAE2F06627EC1907000DC2DA /* WebSocket.m */, + ); + name = HTTP; + sourceTree = ""; + }; + FAE2F03F27EC1883000DC2DA /* Extensions */ = { + isa = PBXGroup; + children = ( + FAE2F04B27EC18AB000DC2DA /* ContextFilterLogFormatter.h */, + FAE2F04C27EC18AB000DC2DA /* ContextFilterLogFormatter.m */, + FAE2F04D27EC18AB000DC2DA /* DispatchQueueLogFormatter.h */, + FAE2F04A27EC18AB000DC2DA /* DispatchQueueLogFormatter.m */, + ); + name = Extensions; + sourceTree = ""; + }; + FAE2F08027EC190F000DC2DA /* Responses */ = { + isa = PBXGroup; + children = ( + FAE2F08D27EC1935000DC2DA /* HTTPAsyncFileResponse.h */, + FAE2F08927EC1935000DC2DA /* HTTPAsyncFileResponse.m */, + FAE2F08427EC1935000DC2DA /* HTTPDataResponse.h */, + FAE2F08B27EC1935000DC2DA /* HTTPDataResponse.m */, + FAE2F08327EC1935000DC2DA /* HTTPDynamicFileResponse.h */, + FAE2F08227EC1935000DC2DA /* HTTPDynamicFileResponse.m */, + FAE2F08C27EC1935000DC2DA /* HTTPErrorResponse.h */, + FAE2F08827EC1935000DC2DA /* HTTPErrorResponse.m */, + FAE2F08527EC1935000DC2DA /* HTTPFileResponse.h */, + FAE2F08627EC1935000DC2DA /* HTTPFileResponse.m */, + FAE2F08727EC1935000DC2DA /* HTTPRedirectResponse.h */, + FAE2F08A27EC1935000DC2DA /* HTTPRedirectResponse.m */, + ); + name = Responses; + sourceTree = ""; + }; + FAE2F08127EC191D000DC2DA /* Categories */ = { + isa = PBXGroup; + children = ( + FAE2F0A627EC1955000DC2DA /* DDData.h */, + FAE2F0AB27EC1955000DC2DA /* DDData.m */, + FAE2F0AA27EC1955000DC2DA /* DDNumber.h */, + FAE2F0A827EC1955000DC2DA /* DDNumber.m */, + FAE2F0A727EC1955000DC2DA /* DDRange.h */, + FAE2F0A927EC1955000DC2DA /* DDRange.m */, + ); + name = Categories; + sourceTree = ""; + }; /* End PBXGroup section */ /* Begin PBXHeadersBuildPhase section */ @@ -819,38 +1083,59 @@ files = ( FA20C2D6182B07CB0036D304 /* RightViewController.h in Headers */, FA89817C18917EB400AF5E39 /* SignatureViewController.h in Headers */, + FAE2F07427EC1907000DC2DA /* HTTPConnection.h in Headers */, FA20C2C8182B07B60036D304 /* DateTimePickerViewController.h in Headers */, C04F28E019CAF3CA003E34BD /* RunnableWrapper.h in Headers */, + FAE2F07E27EC1907000DC2DA /* HTTPServer.h in Headers */, + FAE2F05427EC18AB000DC2DA /* DispatchQueueLogFormatter.h in Headers */, FA20C2DA182B07CB0036D304 /* SplitViewDelegate.h in Headers */, FA20C2E7182B07D10036D304 /* MapViewController.h in Headers */, FA87B5DC1A82A1AD0073EE44 /* PickImageDelegate.h in Headers */, + FAE2F03827EC187F000DC2DA /* DDLog.h in Headers */, FA20C2D4182B07CB0036D304 /* LeftViewController.h in Headers */, FA20C2EE182B07DA0036D304 /* RhoNativeViewManagerOC.h in Headers */, + FAE2F09827EC1936000DC2DA /* HTTPRedirectResponse.h in Headers */, FA20C2E1182B07D10036D304 /* RhoMapViewController.h in Headers */, FA20C2BA182B07A50036D304 /* RhoAlert.h in Headers */, FA20C300182B07EE0036D304 /* sslimpl.h in Headers */, FAA714911DDCA89E00E5E7AD /* RhoWebView.h in Headers */, FA20C2CA182B07BA0036D304 /* Event.h in Headers */, + FAE2F06E27EC1907000DC2DA /* HTTPLogging.h in Headers */, + FAE2F03627EC187F000DC2DA /* DDTTYLogger.h in Headers */, FA11F2521921224400FB1301 /* RhoExtManagerSingletone.h in Headers */, + FAE2F0A227EC1936000DC2DA /* HTTPErrorResponse.h in Headers */, FA20C307182B08080036D304 /* NetworkStatusMonitor.h in Headers */, FAA714981DDCAB6D00E5E7AD /* RhoWKWebView.h in Headers */, + FAE2F03D27EC187F000DC2DA /* DDAbstractDatabaseLogger.h in Headers */, FA20C2ED182B07DA0036D304 /* NVViewController.h in Headers */, + FAE2F09027EC1935000DC2DA /* HTTPDynamicFileResponse.h in Headers */, FA20C2EF182B07DA0036D304 /* NVDelegate.h in Headers */, FA20C2F7182B07EB0036D304 /* RhoCryptImpl.h in Headers */, FA20C309182B08080036D304 /* Reachability.h in Headers */, + FAE2F06A27EC1907000DC2DA /* HTTPResponse.h in Headers */, + FAE2F07627EC1907000DC2DA /* HTTPMessage.h in Headers */, + FAE2F0BA27EC20AE000DC2DA /* CCocoaServer.h in Headers */, C5DFBB31185B6FB400DB6BDB /* IAppMessageReceiver.h in Headers */, + FAE2F07A27EC1907000DC2DA /* HTTPAuthenticationRequest.h in Headers */, FA20C30B182B08080036D304 /* RhoDelegate.h in Headers */, FA20C2C0182B07AA0036D304 /* AppManagerI.h in Headers */, FA20C2DF182B07CB0036D304 /* TabbedMainView.h in Headers */, + FAE2F0B427EC1955000DC2DA /* DDNumber.h in Headers */, FAA7149F1DDCAE2B00E5E7AD /* RhoWebViewFabrique.h in Headers */, + FAE2F07027EC1907000DC2DA /* WebSocket.h in Headers */, + FAE2F03727EC187F000DC2DA /* DDFileLogger.h in Headers */, FA20C2FD182B07EB0036D304 /* SplashScreenImpl.h in Headers */, + FAE2F05A27EC18C4000DC2DA /* GCDAsyncSocket.h in Headers */, FA62ACFA23425F50005E552C /* CRhoWKURLProtocol.h in Headers */, FA20C311182B08080036D304 /* SplashViewController.h in Headers */, FA20C30F182B08080036D304 /* RhoViewController.h in Headers */, FA20C2C5182B07B60036D304 /* DateTime.h in Headers */, + FAE2F03B27EC187F000DC2DA /* DDASLLogger.h in Headers */, + FAE2F0AE27EC1955000DC2DA /* DDRange.h in Headers */, FA20C2E9182B07D10036D304 /* MapAnnotation.h in Headers */, FA89817818917EA900AF5E39 /* SignatureView.h in Headers */, FA20C2E3182B07D10036D304 /* MapViewManager.h in Headers */, + FAE2F09227EC1935000DC2DA /* HTTPDataResponse.h in Headers */, FA20C2D8182B07CB0036D304 /* SplittedMainView.h in Headers */, FA11F249192121BF00FB1301 /* IRhoExtension.h in Headers */, FA20C2E5182B07D10036D304 /* GoogleGeocoder.h in Headers */, @@ -860,6 +1145,7 @@ FA20C2D1182B07C50036D304 /* LogViewController.h in Headers */, FA20C2F3182B07DE0036D304 /* NavBar.h in Headers */, FA20C2F5182B07E20036D304 /* phonebook.h in Headers */, + FAE2F05027EC18AB000DC2DA /* ContextFilterLogFormatter.h in Headers */, FA11F24B192121F200FB1301 /* IRhoExtManager.h in Headers */, FA89817E18917EBA00AF5E39 /* SignatureParam.h in Headers */, FA20C30D182B08080036D304 /* Rhodes.h in Headers */, @@ -872,11 +1158,15 @@ FA20C2FB182B07EB0036D304 /* RhoClassFactory.h in Headers */, FA20C2EB182B07D50036D304 /* NativeBar.h in Headers */, FA20C313182B08080036D304 /* IPushNotificationsReceiver.h in Headers */, + FAE2F0C227EC26D9000DC2DA /* RhoHTTPConnection.h in Headers */, FA20C2BE182B07AA0036D304 /* AppManager.h in Headers */, FAA714961DDCAB6D00E5E7AD /* RhoUIWebView.h in Headers */, + FAE2F09427EC1935000DC2DA /* HTTPFileResponse.h in Headers */, FA20C2B8182B07A10036D304 /* CRhoURLProtocol.h in Headers */, FA20C2D2182B07C50036D304 /* LogOptionsController.h in Headers */, + FAE2F0AC27EC1955000DC2DA /* DDData.h in Headers */, FA20C2CF182B07C50036D304 /* InitMemoryInfoCollector.h in Headers */, + FAE2F0A427EC1936000DC2DA /* HTTPAsyncFileResponse.h in Headers */, FA20C302182B07F20036D304 /* RingtoneManager.h in Headers */, ); runOnlyForDeploymentPostprocessing = 0; @@ -892,8 +1182,13 @@ FAE78BE522583F6C001A1150 /* SplitViewDelegate.h in Headers */, FAE78BE622583F6C001A1150 /* MapViewController.h in Headers */, FAE78BE722583F6C001A1150 /* PickImageDelegate.h in Headers */, + FAE2F07727EC1907000DC2DA /* HTTPMessage.h in Headers */, + FAE2F05527EC18AB000DC2DA /* DispatchQueueLogFormatter.h in Headers */, + FAE2F04227EC1897000DC2DA /* DDLog.h in Headers */, + FAE2F0C327EC26D9000DC2DA /* RhoHTTPConnection.h in Headers */, FAE78BE822583F6C001A1150 /* LeftViewController.h in Headers */, FAE78BE922583F6C001A1150 /* RhoNativeViewManagerOC.h in Headers */, + FAE2F05B27EC18C4000DC2DA /* GCDAsyncSocket.h in Headers */, FAE78BEA22583F6C001A1150 /* RhoMapViewController.h in Headers */, FAE78BEB22583F6C001A1150 /* RhoAlert.h in Headers */, FAE78BEC22583F6C001A1150 /* sslimpl.h in Headers */, @@ -903,11 +1198,18 @@ FAE78BF022583F6C001A1150 /* NetworkStatusMonitor.h in Headers */, FAE78CE2225D0EC5001A1150 /* RhoMainViewStubImpl.h in Headers */, FAE78BF122583F6C001A1150 /* RhoWKWebView.h in Headers */, + FAE2F0A327EC1936000DC2DA /* HTTPErrorResponse.h in Headers */, + FAE2F04727EC1897000DC2DA /* DDAbstractDatabaseLogger.h in Headers */, + FAE2F09527EC1935000DC2DA /* HTTPFileResponse.h in Headers */, + FAE2F07F27EC1907000DC2DA /* HTTPServer.h in Headers */, FAE78BF222583F6C001A1150 /* NVViewController.h in Headers */, + FAE2F0A527EC1936000DC2DA /* HTTPAsyncFileResponse.h in Headers */, FAE78BF322583F6C001A1150 /* NVDelegate.h in Headers */, FAE78BF422583F6C001A1150 /* RhoCryptImpl.h in Headers */, FAE78BF522583F6C001A1150 /* Reachability.h in Headers */, + FAE2F04927EC1897000DC2DA /* DDTTYLogger.h in Headers */, FAE78BF622583F6C001A1150 /* IAppMessageReceiver.h in Headers */, + FAE2F09927EC1936000DC2DA /* HTTPRedirectResponse.h in Headers */, FAE78BF722583F6C001A1150 /* RhoDelegate.h in Headers */, FAE78BF822583F6C001A1150 /* AppManagerI.h in Headers */, FAE78BF922583F6C001A1150 /* TabbedMainView.h in Headers */, @@ -919,7 +1221,9 @@ FAE78BFE22583F6C001A1150 /* DateTime.h in Headers */, FAE78BFF22583F6C001A1150 /* MapAnnotation.h in Headers */, FAE78C0022583F6C001A1150 /* SignatureView.h in Headers */, + FAE2F09127EC1935000DC2DA /* HTTPDynamicFileResponse.h in Headers */, FAE78C0122583F6C001A1150 /* MapViewManager.h in Headers */, + FAE2F0BB27EC20AE000DC2DA /* CCocoaServer.h in Headers */, FAE78C0222583F6C001A1150 /* SplittedMainView.h in Headers */, FAE78C0322583F6C001A1150 /* IRhoExtension.h in Headers */, FAE78C0422583F6C001A1150 /* GoogleGeocoder.h in Headers */, @@ -928,16 +1232,28 @@ FAE78C0722583F6C001A1150 /* SignatureDelegate.h in Headers */, FAE78C0822583F6C001A1150 /* LogViewController.h in Headers */, FAE78C0922583F6C001A1150 /* NavBar.h in Headers */, + FAE2F0AF27EC1955000DC2DA /* DDRange.h in Headers */, FAE78C0A22583F6C001A1150 /* phonebook.h in Headers */, FAE78C0B22583F6C001A1150 /* IRhoExtManager.h in Headers */, FAE78C0C22583F6C001A1150 /* SignatureParam.h in Headers */, FAE78C0D22583F6C001A1150 /* Rhodes.h in Headers */, + FAE2F05127EC18AB000DC2DA /* ContextFilterLogFormatter.h in Headers */, + FAE2F07B27EC1907000DC2DA /* HTTPAuthenticationRequest.h in Headers */, + FAE2F06B27EC1907000DC2DA /* HTTPResponse.h in Headers */, FAE78C0E22583F6C001A1150 /* RhoExtManagerImpl.h in Headers */, FAE78C0F22583F6C001A1150 /* ParamsWrapper.h in Headers */, FAE78C1022583F6C001A1150 /* SimpleMainView.h in Headers */, + FAE2F09327EC1935000DC2DA /* HTTPDataResponse.h in Headers */, FAE78C1122583F6C001A1150 /* RhoMainView.h in Headers */, + FAE2F06F27EC1907000DC2DA /* HTTPLogging.h in Headers */, + FAE2F0AD27EC1955000DC2DA /* DDData.h in Headers */, FAE78C1222583F6C001A1150 /* AppLoader.h in Headers */, + FAE2F07127EC1907000DC2DA /* WebSocket.h in Headers */, FAE78C1322583F6C001A1150 /* DateTimePickerDelegate.h in Headers */, + FAE2F07527EC1907000DC2DA /* HTTPConnection.h in Headers */, + FAE2F04427EC1897000DC2DA /* DDFileLogger.h in Headers */, + FAE2F0B527EC1955000DC2DA /* DDNumber.h in Headers */, + FAE2F04127EC1897000DC2DA /* DDASLLogger.h in Headers */, FAE78C1422583F6C001A1150 /* RhoClassFactory.h in Headers */, FAE78C1522583F6C001A1150 /* NativeBar.h in Headers */, FAE78C1622583F6C001A1150 /* IPushNotificationsReceiver.h in Headers */, @@ -1049,16 +1365,23 @@ buildActionMask = 2147483647; files = ( FA20C2C9182B07B60036D304 /* DateTimePickerViewController.m in Sources */, + FAE2F04E27EC18AB000DC2DA /* DispatchQueueLogFormatter.m in Sources */, FA11F2531921224400FB1301 /* RhoExtManagerSingletone.m in Sources */, FAA714991DDCAB6D00E5E7AD /* RhoWKWebView.mm in Sources */, FA11F24F1921221E00FB1301 /* RhoExtManagerImpl.m in Sources */, + FAE2F09C27EC1936000DC2DA /* HTTPAsyncFileResponse.m in Sources */, FA87B5DD1A82A1B00073EE44 /* PickImageDelegate.m in Sources */, + FAE2F07C27EC1907000DC2DA /* WebSocket.m in Sources */, FA20C303182B07F20036D304 /* RingtoneManager.m in Sources */, + FAE2F08E27EC1935000DC2DA /* HTTPDynamicFileResponse.m in Sources */, + FAE2F09627EC1936000DC2DA /* HTTPFileResponse.m in Sources */, + FAE2F03527EC187F000DC2DA /* DDLog.m in Sources */, FA20C2EC182B07D50036D304 /* NativeBar.m in Sources */, FA20C2CE182B07C40036D304 /* InitMemoryInfoCollector.mm in Sources */, C04F28E119CAF3CA003E34BD /* RunnableWrapper.mm in Sources */, FA20C308182B08080036D304 /* NetworkStatusMonitor.mm in Sources */, FA20C2DE182B07CB0036D304 /* SimpleMainView.m in Sources */, + FAE2F03A27EC187F000DC2DA /* DDTTYLogger.m in Sources */, FA20C2F0182B07DA0036D304 /* NVDelegate.m in Sources */, FA20C305182B08000036D304 /* ParamsWrapper.m in Sources */, FA20C30A182B08080036D304 /* Reachability.m in Sources */, @@ -1074,35 +1397,52 @@ FA62ACF823425F4A005E552C /* CRhoWKURLProtocol.m in Sources */, FA20C2FF182B07EE0036D304 /* sslimpl.cpp in Sources */, FA20C2F6182B07E20036D304 /* phonebook.m in Sources */, + FAE2F0B227EC1955000DC2DA /* DDRange.m in Sources */, FA20C2D0182B07C50036D304 /* LogViewController.m in Sources */, FA20C2C6182B07B60036D304 /* DateTime.m in Sources */, FAA714971DDCAB6D00E5E7AD /* RhoUIWebView.m in Sources */, FA20C2CD182B07BE0036D304 /* LocationController.m in Sources */, FA20C2EA182B07D10036D304 /* MapAnnotation.m in Sources */, + FAE2F09E27EC1936000DC2DA /* HTTPRedirectResponse.m in Sources */, + FAE2F09A27EC1936000DC2DA /* HTTPErrorResponse.m in Sources */, FA20C2E4182B07D10036D304 /* MapViewManager.m in Sources */, + FAE2F03C27EC187F000DC2DA /* DDAbstractDatabaseLogger.m in Sources */, FA20C2D5182B07CB0036D304 /* LeftViewController.m in Sources */, FA20C2F2182B07DA0036D304 /* RhoNativeViewManager.mm in Sources */, + FAE2F0C027EC26D9000DC2DA /* RhoHTTPConnection.m in Sources */, FA20C2F1182B07DA0036D304 /* NVViewController.m in Sources */, + FAE2F06827EC1907000DC2DA /* HTTPConnection.m in Sources */, FA20C2E2182B07D10036D304 /* RhoMapViewController.m in Sources */, FA89817B18917EB200AF5E39 /* SignatureDelegate.m in Sources */, + FAE2F06C27EC1907000DC2DA /* HTTPServer.m in Sources */, + FAE2F07227EC1907000DC2DA /* HTTPMessage.m in Sources */, FA20C2F4182B07DE0036D304 /* NavBar.m in Sources */, + FAE2F07827EC1907000DC2DA /* HTTPAuthenticationRequest.m in Sources */, + FAE2F0B627EC1955000DC2DA /* DDData.m in Sources */, + FAE2F0BC27EC20AE000DC2DA /* CCocoaServer.m in Sources */, + FAE2F05827EC18C4000DC2DA /* GCDAsyncSocket.m in Sources */, FA20C2BD182B07AA0036D304 /* AppLoader.m in Sources */, FA20C306182B08040036D304 /* WebView.m in Sources */, FA20C2CB182B07BA0036D304 /* Event.m in Sources */, FA20C310182B08080036D304 /* RhoViewController.m in Sources */, FA20C2E6182B07D10036D304 /* GoogleGeocoder.m in Sources */, + FAE2F03927EC187F000DC2DA /* DDASLLogger.m in Sources */, + FAE2F05227EC18AB000DC2DA /* ContextFilterLogFormatter.m in Sources */, FA20C301182B07EE0036D304 /* NetRequestImpl.m in Sources */, FA20C312182B08080036D304 /* SplashViewController.m in Sources */, FA20C2BF182B07AA0036D304 /* AppManager.m in Sources */, FA20C2D3182B07C50036D304 /* LogOptionsController.m in Sources */, FA20C2FA182B07EB0036D304 /* RhoClassFactory.cpp in Sources */, + FAE2F03E27EC187F000DC2DA /* DDFileLogger.m in Sources */, FA20C30E182B08080036D304 /* Rhodes.m in Sources */, FA20C2C4182B07B60036D304 /* DateTimePickerDelegate.m in Sources */, + FAE2F0A027EC1936000DC2DA /* HTTPDataResponse.m in Sources */, FA20C2DB182B07CB0036D304 /* SplitViewDelegate.m in Sources */, FA20C2FC182B07EB0036D304 /* RhoFileImpl.m in Sources */, C5BA525F1A93ADF90095DE4A /* IPhoneNetRequest.mm in Sources */, FA20C2BB182B07A50036D304 /* RhoAlert.m in Sources */, FA20C2B9182B07A10036D304 /* CRhoURLProtocol.m in Sources */, + FAE2F0B027EC1955000DC2DA /* DDNumber.m in Sources */, FA20C2F9182B07EB0036D304 /* RhoThreadImpl.m in Sources */, FA20C2D9182B07CB0036D304 /* SplittedMainView.m in Sources */, FA20C2E8182B07D10036D304 /* MapViewController.m in Sources */, @@ -1114,6 +1454,7 @@ buildActionMask = 2147483647; files = ( FAE78C1E22583F6C001A1150 /* DateTimePickerViewController.m in Sources */, + FAE2F0B127EC1955000DC2DA /* DDNumber.m in Sources */, FAE78C1F22583F6C001A1150 /* RhoExtManagerSingletone.m in Sources */, FAE78C2022583F6C001A1150 /* RhoWKWebView.mm in Sources */, FAE78C2122583F6C001A1150 /* RhoExtManagerImpl.m in Sources */, @@ -1122,42 +1463,64 @@ FAE78C2422583F6C001A1150 /* NativeBar.m in Sources */, FAE78C2522583F6C001A1150 /* InitMemoryInfoCollector.mm in Sources */, FAE78C2622583F6C001A1150 /* RunnableWrapper.mm in Sources */, + FAE2F0BD27EC20AE000DC2DA /* CCocoaServer.m in Sources */, FAE78C2722583F6C001A1150 /* NetworkStatusMonitor.mm in Sources */, FAE78C2822583F6C001A1150 /* SimpleMainView.m in Sources */, + FAE2F09D27EC1936000DC2DA /* HTTPAsyncFileResponse.m in Sources */, FAE78CE3225D0EC5001A1150 /* RhoMainViewStubImpl.m in Sources */, + FAE2F04627EC1897000DC2DA /* DDTTYLogger.m in Sources */, FAE78C2922583F6C001A1150 /* NVDelegate.m in Sources */, FAE78C2A22583F6C001A1150 /* ParamsWrapper.m in Sources */, FAE78C2B22583F6C001A1150 /* Reachability.m in Sources */, FAE78C2C22583F6C001A1150 /* TabbedMainView.m in Sources */, + FAE2F05327EC18AB000DC2DA /* ContextFilterLogFormatter.m in Sources */, + FAE2F05927EC18C4000DC2DA /* GCDAsyncSocket.m in Sources */, FAE78C2D22583F6C001A1150 /* RhoDelegate.m in Sources */, FAE78C2E22583F6C001A1150 /* RhoCryptImpl.mm in Sources */, + FAE2F06D27EC1907000DC2DA /* HTTPServer.m in Sources */, + FAE2F04527EC1897000DC2DA /* DDLog.m in Sources */, + FAE2F0B327EC1955000DC2DA /* DDRange.m in Sources */, + FAE2F07927EC1907000DC2DA /* HTTPAuthenticationRequest.m in Sources */, FAE78C2F22583F6C001A1150 /* DateTimePicker.m in Sources */, FAE78C3022583F6C001A1150 /* RhoWebViewFabrique.m in Sources */, FA62ACF923425F4D005E552C /* CRhoWKURLProtocol.m in Sources */, FAE78C3122583F6C001A1150 /* SplashScreenImpl.cpp in Sources */, + FAE2F07327EC1907000DC2DA /* HTTPMessage.m in Sources */, FAE78C3222583F6C001A1150 /* SignatureView.m in Sources */, FAE78C3322583F6C001A1150 /* RightViewController.m in Sources */, FAE78C3422583F6C001A1150 /* SignatureViewController.m in Sources */, FAE78C3522583F6C001A1150 /* sslimpl.cpp in Sources */, FAE78C3622583F6C001A1150 /* phonebook.m in Sources */, FAE78C3722583F6C001A1150 /* LogViewController.m in Sources */, + FAE2F04F27EC18AB000DC2DA /* DispatchQueueLogFormatter.m in Sources */, FAE78C3822583F6C001A1150 /* DateTime.m in Sources */, FAE78C3922583F6C001A1150 /* RhoUIWebView.m in Sources */, + FAE2F06927EC1907000DC2DA /* HTTPConnection.m in Sources */, + FAE2F09F27EC1936000DC2DA /* HTTPRedirectResponse.m in Sources */, FAE78C3A22583F6C001A1150 /* LocationController.m in Sources */, + FAE2F09B27EC1936000DC2DA /* HTTPErrorResponse.m in Sources */, FAE78C3B22583F6C001A1150 /* MapAnnotation.m in Sources */, FAE78C3C22583F6C001A1150 /* MapViewManager.m in Sources */, + FAE2F0C127EC26D9000DC2DA /* RhoHTTPConnection.m in Sources */, FAE78C3D22583F6C001A1150 /* LeftViewController.m in Sources */, FAE78C3E22583F6C001A1150 /* RhoNativeViewManager.mm in Sources */, + FAE2F09727EC1936000DC2DA /* HTTPFileResponse.m in Sources */, FAE78C3F22583F6C001A1150 /* NVViewController.m in Sources */, + FAE2F04827EC1897000DC2DA /* DDAbstractDatabaseLogger.m in Sources */, FAE78C4022583F6C001A1150 /* RhoMapViewController.m in Sources */, FAE78C4122583F6C001A1150 /* SignatureDelegate.m in Sources */, FAE78C4222583F6C001A1150 /* NavBar.m in Sources */, FAE78C4322583F6C001A1150 /* AppLoader.m in Sources */, FAE78C4422583F6C001A1150 /* WebView.m in Sources */, + FAE2F0B727EC1955000DC2DA /* DDData.m in Sources */, FAE78C4522583F6C001A1150 /* Event.m in Sources */, FAE78C4622583F6C001A1150 /* RhoViewController.m in Sources */, + FAE2F07D27EC1907000DC2DA /* WebSocket.m in Sources */, FAE78C4722583F6C001A1150 /* GoogleGeocoder.m in Sources */, + FAE2F04027EC1897000DC2DA /* DDASLLogger.m in Sources */, FAE78C4822583F6C001A1150 /* NetRequestImpl.m in Sources */, + FAE2F04327EC1897000DC2DA /* DDFileLogger.m in Sources */, + FAE2F0A127EC1936000DC2DA /* HTTPDataResponse.m in Sources */, FAE78C4922583F6C001A1150 /* SplashViewController.m in Sources */, FAE78C4A22583F6C001A1150 /* AppManager.m in Sources */, FAE78C4B22583F6C001A1150 /* LogOptionsController.m in Sources */, @@ -1168,6 +1531,7 @@ FAE78C5022583F6C001A1150 /* RhoFileImpl.m in Sources */, FAE78C5122583F6C001A1150 /* IPhoneNetRequest.mm in Sources */, FAE78C5222583F6C001A1150 /* RhoAlert.m in Sources */, + FAE2F08F27EC1935000DC2DA /* HTTPDynamicFileResponse.m in Sources */, FAE78C5322583F6C001A1150 /* CRhoURLProtocol.m in Sources */, FAE78C5422583F6C001A1150 /* RhoThreadImpl.m in Sources */, FAE78C5522583F6C001A1150 /* SplittedMainView.m in Sources */, diff --git a/platform/shared/common/RhodesApp.cpp b/platform/shared/common/RhodesApp.cpp index 1ed24b8b775..1a0ff57f0d2 100755 --- a/platform/shared/common/RhodesApp.cpp +++ b/platform/shared/common/RhodesApp.cpp @@ -73,6 +73,11 @@ bool rho_wmimpl_is_browser_ieforwm(); void rho_file_set_fs_mode(int mode); #endif +#ifdef OS_MACOSX +void rho_cocoa_server_init(); +void rho_cocoa_server_start(); +#endif + } // Copy-paste from ApplicationBase.cpp @@ -561,14 +566,25 @@ void CRhodesApp::run() #ifdef OS_MACOSX bool shouldRunDirectQueue = false; + bool shouldUseCocoaServer = true; + net::CDirectHttpRequestQueue directQueue(*m_httpServer, *this ); if (RHOCONF().isExist("ios_direct_local_requests")) { shouldRunDirectQueue = RHOCONF().getBool("ios_direct_local_requests"); } + if (RHOCONF().isExist("ios_use_old_legacy_socket")) { + shouldUseCocoaServer = !RHOCONF().getBool("ios_use_old_legacy_socket"); + } #ifdef RHODES_EMULATOR shouldRunDirectQueue = false; + shouldUseCocoaServer = false; #endif + + if ((shouldUseCocoaServer) && (!shouldRunDirectQueue)) { + rho_cocoa_server_init(); + } + #endif @@ -576,8 +592,11 @@ void CRhodesApp::run() if(!m_isJSFSApp) { #ifdef OS_MACOSX - if ( shouldRunDirectQueue ) + if ( shouldRunDirectQueue || shouldUseCocoaServer) { + if ((shouldUseCocoaServer) && (!shouldRunDirectQueue)) { + rho_cocoa_server_start(); + } directQueue.run(); } else diff --git a/platform/shared/net/HttpServer.cpp b/platform/shared/net/HttpServer.cpp index ccbe0981e80..7172f90f9e5 100755 --- a/platform/shared/net/HttpServer.cpp +++ b/platform/shared/net/HttpServer.cpp @@ -95,6 +95,15 @@ typedef unsigned __int16 uint16_t; #endif + +#ifdef OS_MACOSX +extern "C" { +void rho_cocoa_server_stop(); +} +#endif + + + #undef DEFAULT_LOGCATEGORY #define DEFAULT_LOGCATEGORY "HttpServer" @@ -511,6 +520,11 @@ void CHttpServer::close_listener() void CHttpServer::stop() { + +#ifdef OS_MACOSX + rho_cocoa_server_stop(); +#endif + // WARNING!!! It is not enough to just close listener on Android // to stop server. By unknown reason accept does not unblock if // it was closed in another thread. However, on iPhone it works diff --git a/res/generators/templates/application/rhoconfig.txt b/res/generators/templates/application/rhoconfig.txt index 1024d038229..3dd6e9375cf 100644 --- a/res/generators/templates/application/rhoconfig.txt +++ b/res/generators/templates/application/rhoconfig.txt @@ -99,6 +99,10 @@ sync_poll_interval=0 # With this capability some additional code will be added to project. That code provide unofficiall direct work with http/https requests from WKWebView and you will be able set # ios_direct_local_requests = 1 +#ios_use_old_legacy_socket = 0 +# Use old legacy socket based http server instead of CocoaServer. +# Default value is FALSE + #ios_https_local_server = 0 #ATTENTION !!! this option works only with ios_net_curl = 0 AND ios_direct_local_requests = 1 !!! #default value is FALSE