GCDWebServer.m

/*
 Copyright (c) 2012-2013, Pierre-Olivier Latour
 All rights reserved.
 
 Redistribution and use 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.
 * Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 * Neither the name of the <organization> nor the
 names of its contributors may be used to endorse or promote products
 derived from this software without specific prior written permission.
 
 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 <COPYRIGHT HOLDER> 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.
 */

#import <TargetConditionals.h>
#if TARGET_OS_IPHONE
#import <MobileCoreServices/MobileCoreServices.h>
#endif

#import <netinet/in.h>

#import "GCDWebServerPrivate.h"

#define kMaxPendingConnections 16

static BOOL _run;

NSString* GCDWebServerGetMimeTypeForExtension(NSString* extension) {
	static NSDictionary* _overrides = nil;
	if (_overrides == nil) {
		_overrides = [[NSDictionary alloc] initWithObjectsAndKeys:
					  @"text/css", @"css",
					  nil];
	}
	NSString* mimeType = nil;
	extension = [extension lowercaseString];
	if (extension.length) {
		mimeType = [_overrides objectForKey:extension];
		if (mimeType == nil) {
			CFStringRef uti = UTTypeCreatePreferredIdentifierForTag(kUTTagClassFilenameExtension, (__bridge CFStringRef)extension, NULL);
			if (uti) {
				mimeType = (__bridge id)UTTypeCopyPreferredTagWithClass(uti, kUTTagClassMIMEType);
				CFRelease(uti);
			}
		}
	}
	return mimeType;
}

NSString* GCDWebServerUnescapeURLString(NSString* string) {
	return (__bridge_transfer NSString*)CFURLCreateStringByReplacingPercentEscapesUsingEncoding(kCFAllocatorDefault, (CFStringRef)string, CFSTR(""),
																		kCFStringEncodingUTF8);
}

NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form) {
	NSMutableDictionary* parameters = [NSMutableDictionary dictionary];
	NSScanner* scanner = [[NSScanner alloc] initWithString:form];
	[scanner setCharactersToBeSkipped:nil];
	while (1) {
		NSString* key = nil;
		if (![scanner scanUpToString:@"=" intoString:&key] || [scanner isAtEnd]) {
			break;
		}
		[scanner setScanLocation:([scanner scanLocation] + 1)];
		
		NSString* value = nil;
		if (![scanner scanUpToString:@"&" intoString:&value]) {
			break;
		}
		
		key = [key stringByReplacingOccurrencesOfString:@"+" withString:@" "];
		value = [value stringByReplacingOccurrencesOfString:@"+" withString:@" "];
		[parameters setObject:GCDWebServerUnescapeURLString(value) forKey:GCDWebServerUnescapeURLString(key)];
		
		if ([scanner isAtEnd]) {
			break;
		}
		[scanner setScanLocation:([scanner scanLocation] + 1)];
	}
	return parameters;
}

static void _SignalHandler(int signal) {
	_run = NO;
	printf("\n");
}

@implementation GCDWebServerHandler

@synthesize matchBlock=_matchBlock, processBlock=_processBlock;

- (id)initWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)processBlock {
	if ((self = [super init])) {
		_matchBlock = [matchBlock copy]; //Block_copy(matchBlock);
		_processBlock = [processBlock copy]; //Block_copy(processBlock);
	}
	return self;
}

- (void)dealloc {
}

@end

@implementation GCDWebServer

+ (void)initialize {
	[GCDWebServerConnection class];  // Initialize class immediately to make sure it happens on the main thread
}

- (id)init {
	if ((self = [super init])) {
		self.handlers = [NSMutableArray array];
	}
	return self;
}

- (void)dealloc {
    if (_source)
        [self stop];
    self.handlers = nil;
}

- (void)addHandlerWithMatchBlock:(GCDWebServerMatchBlock)matchBlock processBlock:(GCDWebServerProcessBlock)handlerBlock {
  DCHECK(_source == NULL);
  GCDWebServerHandler* handler = [[GCDWebServerHandler alloc] initWithMatchBlock:matchBlock processBlock:handlerBlock];
  [self.handlers insertObject:handler atIndex:0];
}

- (void)removeAllHandlers {
  DCHECK(_source == NULL);
  [self.handlers removeAllObjects];
}

- (BOOL)start {
  return [self startWithPort:8080 bonjourName:@""];
}

static void _NetServiceClientCallBack(CFNetServiceRef service, CFStreamError* error, void* info) {
  @autoreleasepool {
    if (error->error) {
      LOG_ERROR(@"Bonjour error %i (domain %i)", error->error, (int)error->domain);
    } else {
      LOG_VERBOSE(@"Registered Bonjour service \"%@\" with type '%@' on port %i", CFNetServiceGetName(service), CFNetServiceGetType(service), CFNetServiceGetPortNumber(service));
    }
  }
}

- (BOOL)startWithPort:(NSUInteger)port bonjourName:(NSString*)name {
  DCHECK(_source == NULL);
  int listeningSocket = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
  if (listeningSocket > 0) {
    int yes = 1;
    setsockopt(listeningSocket, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof(yes));
    setsockopt(listeningSocket, SOL_SOCKET, SO_REUSEPORT, &yes, sizeof(yes));
    
    struct sockaddr_in addr4;
    bzero(&addr4, sizeof(addr4));
    addr4.sin_len = sizeof(addr4);
    addr4.sin_family = AF_INET;
    addr4.sin_port = htons(port);
    addr4.sin_addr.s_addr = htonl(INADDR_ANY);
    if (bind(listeningSocket, (void*)&addr4, sizeof(addr4)) == 0) {
      if (listen(listeningSocket, kMaxPendingConnections) == 0) {
        _source = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ, listeningSocket, 0, kGCDWebServerGCDQueue);
        dispatch_source_set_cancel_handler(_source, ^{
          
          @autoreleasepool {
            int result = close(listeningSocket);
            if (result != 0) {
              LOG_ERROR(@"Failed closing socket (%i): %s", errno, strerror(errno));
            } else {
              LOG_DEBUG(@"Closed listening socket");
            }
          }
          
        });
        dispatch_source_set_event_handler(_source, ^{
          
          @autoreleasepool {
            struct sockaddr addr;
            socklen_t addrlen = sizeof(addr);
            int socket = accept(listeningSocket, &addr, &addrlen);
            if (socket > 0) {
              int localYes = 1;
              setsockopt(socket, SOL_SOCKET, SO_NOSIGPIPE, &localYes, sizeof(localYes));  // Make sure this socket cannot generate SIG_PIPE
              
              NSData* data = [NSData dataWithBytes:&addr length:addrlen];
              Class connectionClass = [[self class] connectionClass];
              GCDWebServerConnection* connection = [[connectionClass alloc] initWithServer:self address:data socket:socket];
              DCHECK(connection); // Connection will automatically retain itself while opened
            } else {
              LOG_ERROR(@"Failed accepting socket (%i): %s", errno, strerror(errno));
            }
          }
          
        });
        
        if (port == 0) {  // Determine the actual port we are listening on
          struct sockaddr addr;
          socklen_t addrlen = sizeof(addr);
          if (getsockname(listeningSocket, &addr, &addrlen) == 0) {
            struct sockaddr_in* sockaddr = (struct sockaddr_in*)&addr;
            _port = ntohs(sockaddr->sin_port);
          } else {
            LOG_ERROR(@"Failed retrieving socket address (%i): %s", errno, strerror(errno));
          }
        } else {
          _port = port;
        }
      
        if (name) {
          _service = CFNetServiceCreate(kCFAllocatorDefault, CFSTR("local."), CFSTR("_http._tcp"), (__bridge CFStringRef)name, _port);
          if (_service) {
            CFNetServiceClientContext context = {0, (__bridge void*)self, NULL, NULL, NULL};
            CFNetServiceSetClient(_service, _NetServiceClientCallBack, &context);
            CFNetServiceScheduleWithRunLoop(_service, CFRunLoopGetMain(), kCFRunLoopCommonModes);
            CFStreamError error = {0};
            CFNetServiceRegisterWithOptions(_service, 0, &error);
          } else {
            LOG_ERROR(@"Failed creating CFNetService");
          }
        }
      
        dispatch_resume(_source);
        LOG_VERBOSE(@"%@ started on port %i", [self class], (int)_port);
      } else {
        LOG_ERROR(@"Failed binding socket");
        close(listeningSocket);
      }
    } else {
      LOG_ERROR(@"Failed binding socket (%i): %s", errno, strerror(errno));
    }
  }
  return (_source ? YES : NO);
}

- (BOOL)isRunning {
  return (_source ? YES : NO);
}

- (void)stop {
  DCHECK(_source != NULL);
  if (_source) {
    if (_service) {
      CFNetServiceUnscheduleFromRunLoop(_service, CFRunLoopGetMain(), kCFRunLoopCommonModes);
      CFNetServiceSetClient(_service, NULL, NULL);
      CFRelease(_service);
      _service = NULL;
    }
    
    dispatch_source_cancel(_source);  // This will close the socket
    dispatch_release(_source);
    _source = NULL;
    
    LOG_VERBOSE(@"%@ stopped", [self class]);
  }
  _port = 0;
}

@end

@implementation GCDWebServer (Subclassing)

+ (Class)connectionClass {
	return [GCDWebServerConnection class];
}

+ (NSString*)serverName {
	return NSStringFromClass(self);
}

@end

@implementation GCDWebServer (Extensions)

- (BOOL)runWithPort:(NSUInteger)port {
  BOOL success = NO;
  _run = YES;
  void* handler = signal(SIGINT, _SignalHandler);
  if (handler != SIG_ERR) {
    if ([self startWithPort:port bonjourName:@""]) {
      while (_run) {
        CFRunLoopRunInMode(kCFRunLoopDefaultMode, 1.0, true);
      }
      [self stop];
      success = YES;
    }
    signal(SIGINT, handler);
  }
  return success;
}

@end

@implementation GCDWebServer (Handlers)

- (void)addDefaultHandlerForMethod:(NSString*)method requestClass:(Class)class processBlock:(GCDWebServerProcessBlock)block {
	[self addHandlerWithMatchBlock:^GCDWebServerRequest *(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) {
		
		return [[class alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery];
		
	} processBlock:block];
}

- (GCDWebServerResponse*)_responseWithContentsOfFile:(NSString*)path {
	return [GCDWebServerFileResponse responseWithFile:path];
}

- (GCDWebServerResponse*)_responseWithContentsOfDirectory:(NSString*)path {
	NSDirectoryEnumerator* enumerator = [[NSFileManager defaultManager] enumeratorAtPath:path];
	if (enumerator == nil) {
		return nil;
	}
	NSMutableString* html = [NSMutableString string];
	[html appendString:@"<html><body>\n"];
	[html appendString:@"<ul>\n"];
	for (NSString* file in enumerator) {
		if (![file hasPrefix:@"."]) {
			NSString* type = [[enumerator fileAttributes] objectForKey:NSFileType];
			NSString* escapedFile = [file stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
			DCHECK(escapedFile);
			if ([type isEqualToString:NSFileTypeRegular]) {
				[html appendFormat:@"<li><a href=\"%@\">%@</a></li>\n", escapedFile, file];
			} else if ([type isEqualToString:NSFileTypeDirectory]) {
				[html appendFormat:@"<li><a href=\"%@/\">%@/</a></li>\n", escapedFile, file];
			}
		}
		[enumerator skipDescendents];
	}
	[html appendString:@"</ul>\n"];
	[html appendString:@"</body></html>\n"];
	return [GCDWebServerDataResponse responseWithHTML:html];
}

- (void)addHandlerForBasePath:(NSString*)basePath localPath:(NSString*)localPath indexFilename:(NSString*)indexFilename cacheAge:(NSUInteger)cacheAge {
	if ([basePath hasPrefix:@"/"] && [basePath hasSuffix:@"/"]) {
		[self addHandlerWithMatchBlock:^GCDWebServerRequest *(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) {
			
			if (![requestMethod isEqualToString:@"GET"]) {
				return nil;
			}
			if (![urlPath hasPrefix:basePath]) {
				return nil;
			}
			return [[GCDWebServerRequest alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery];
			
		} processBlock:^GCDWebServerResponse *(GCDWebServerRequest* request) {
			
			GCDWebServerResponse* response = nil;
			NSString* filePath = [localPath stringByAppendingPathComponent:[request.path substringFromIndex:basePath.length]];
			BOOL isDirectory;
			if ([[NSFileManager defaultManager] fileExistsAtPath:filePath isDirectory:&isDirectory]) {
				if (isDirectory) {
					if (indexFilename) {
						NSString* indexPath = [filePath stringByAppendingPathComponent:indexFilename];
						if ([[NSFileManager defaultManager] fileExistsAtPath:indexPath isDirectory:&isDirectory] && !isDirectory) {
							return [GCDWebServerFileResponse responseWithFile:indexPath];//[self _responseWithContentsOfFile:indexPath];
						}
					}
					{
						NSDirectoryEnumerator* enumerator = [[NSFileManager defaultManager] enumeratorAtPath:filePath];
						if (enumerator == nil) {
							return nil;
						}
						NSMutableString* html = [NSMutableString string];
						[html appendString:@"<html><body>\n"];
						[html appendString:@"<ul>\n"];
						for (NSString* file in enumerator) {
							if (![file hasPrefix:@"."]) {
								NSString* type = [[enumerator fileAttributes] objectForKey:NSFileType];
								NSString* escapedFile = [file stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
								DCHECK(escapedFile);
								if ([type isEqualToString:NSFileTypeRegular]) {
									[html appendFormat:@"<li><a href=\"%@\">%@</a></li>\n", escapedFile, file];
								} else if ([type isEqualToString:NSFileTypeDirectory]) {
									[html appendFormat:@"<li><a href=\"%@/\">%@/</a></li>\n", escapedFile, file];
								}
							}
							[enumerator skipDescendents];
						}
						[html appendString:@"</ul>\n"];
							[html appendString:@"</body></html>\n"];
							response = [GCDWebServerDataResponse responseWithHTML:html];
					}
				} else {
					response = [GCDWebServerFileResponse responseWithFile:filePath];
				}
			}
			if (response) {
				response.cacheControlMaxAge = cacheAge;
			} else {
				response = [GCDWebServerResponse responseWithStatusCode:404];
			}
			return response;
			
		}];
	} else {
		DNOT_REACHED();
	}
}

- (void)addHandlerForMethod:(NSString*)method path:(NSString*)path requestClass:(Class)class processBlock:(GCDWebServerProcessBlock)block {
	if ([path hasPrefix:@"/"] && [class isSubclassOfClass:[GCDWebServerRequest class]]) {
		[self addHandlerWithMatchBlock:^GCDWebServerRequest *(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) {
			
			if (![requestMethod isEqualToString:method]) {
				return nil;
			}
			if ([urlPath caseInsensitiveCompare:path] != NSOrderedSame) {
				return nil;
			}
			return [[class alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery];
			
		} processBlock:block];
	} else {
		DNOT_REACHED();
	}
}

- (void)addHandlerForMethod:(NSString*)method pathRegex:(NSString*)regex requestClass:(Class)class processBlock:(GCDWebServerProcessBlock)block {
	NSRegularExpression* expression = [NSRegularExpression regularExpressionWithPattern:regex options:NSRegularExpressionCaseInsensitive error:NULL];
	if (expression && [class isSubclassOfClass:[GCDWebServerRequest class]]) {
		[self addHandlerWithMatchBlock:^GCDWebServerRequest *(NSString* requestMethod, NSURL* requestURL, NSDictionary* requestHeaders, NSString* urlPath, NSDictionary* urlQuery) {
			
			if (![requestMethod isEqualToString:method]) {
				return nil;
			}
			if ([expression firstMatchInString:urlPath options:0 range:NSMakeRange(0, urlPath.length)] == nil) {
				return nil;
			}
			return [[class alloc] initWithMethod:requestMethod url:requestURL headers:requestHeaders path:urlPath query:urlQuery];
			
		} processBlock:block];
	} else {
		DNOT_REACHED();
	}
}

@end