iCuke 0.4.5

data/ext/iCuke/iCukeHTTPServer.m

@@ -0,0 +1,365 @@
+//
+//  HTTPServer.m
+//  TextTransfer
+//
+//  Created by Matt Gallagher on 2009/07/13.
+//  Copyright 2009 Matt Gallagher. All rights reserved.
+//
+//  Permission is given to use this source code file, free of charge, in any
+//  project, commercial or otherwise, entirely at your risk, with the condition
+//  that any redistribution (in part or whole) of source code must retain
+//  this copyright and permission notice. Attribution in compiled projects is
+//  appreciated but not required.
+//
+
+#import "iCukeHTTPServer.h"
+#import "SynthesizeSingleton.h"
+#import <sys/socket.h>
+#import <netinet/in.h>
+#if TARGET_OS_IPHONE
+#import <CFNetwork/CFNetwork.h>
+#endif
+#import "iCukeHTTPResponseHandler.h"
+
+#define HTTP_SERVER_PORT 50000
+
+NSString * const iCukeHTTPServerNotificationStateChanged = @"ServerNotificationStateChanged";
+
+//
+// Internal methods and properties:
+//	The "lastError" and "state" are only writable by the server itself.
+//
+@interface iCukeHTTPServer ()
+@property (nonatomic, readwrite, retain) NSError *lastError;
+@property (readwrite, assign) iCukeHTTPServerState state;
+@end
+
+@implementation iCukeHTTPServer
+
+@synthesize lastError;
+@synthesize state;
+
+SYNTHESIZE_SINGLETON_FOR_CLASS(iCukeHTTPServer);
+
+//
+// init
+//
+// Set the initial state and allocate the responseHandlers and incomingRequests
+// collections.
+//
+// returns the initialized server object.
+//
+- (id)init
+{
+	self = [super init];
+	if (self != nil)
+	{
+		self.state = SERVER_STATE_IDLE;
+		responseHandlers = [[NSMutableSet alloc] init];
+		incomingRequests =
+			CFDictionaryCreateMutable(
+				kCFAllocatorDefault,
+				0,
+				&kCFTypeDictionaryKeyCallBacks,
+				&kCFTypeDictionaryValueCallBacks);
+	}
+	return self;
+}
+
+//
+// setLastError:
+//
+// Custom setter method. Stops the server and 
+//
+// Parameters:
+//    anError - the new error value (nil to clear)
+//
+- (void)setLastError:(NSError *)anError
+{
+	[anError retain];
+	[lastError release];
+	lastError = anError;
+	
+	if (lastError == nil)
+	{
+		return;
+	}
+	
+	[self stop];
+	
+	self.state = SERVER_STATE_IDLE;
+	NSLog(@"HTTPServer error: %@", self.lastError);
+}
+
+//
+// errorWithName:
+//
+// Stops the server and sets the last error to "errorName", localized using the
+// HTTPServerErrors.strings file (if present).
+//
+// Parameters:
+//    errorName - the description used for the error
+//
+- (void)errorWithName:(NSString *)errorName
+{
+	self.lastError = [NSError
+		errorWithDomain:@"HTTPServerError"
+		code:0
+		userInfo:
+			[NSDictionary dictionaryWithObject:
+				NSLocalizedStringFromTable(
+					errorName,
+					@"",
+					@"HTTPServerErrors")
+				forKey:NSLocalizedDescriptionKey]];	
+}
+
+//
+// setState:
+//
+// Changes the server state and posts a notification (if the state changes).
+//
+// Parameters:
+//    newState - the new state for the server
+//
+- (void)setState:(iCukeHTTPServerState)newState
+{
+	if (state == newState)
+	{
+		return;
+	}
+
+	state = newState;
+	
+	[[NSNotificationCenter defaultCenter]
+		postNotificationName:iCukeHTTPServerNotificationStateChanged
+		object:self];
+}
+
+//
+// start
+//
+// Creates the socket and starts listening for connections on it.
+//
+- (void)start
+{
+	self.lastError = nil;
+	self.state = SERVER_STATE_STARTING;
+
+	socket = CFSocketCreate(kCFAllocatorDefault, PF_INET, SOCK_STREAM,
+		IPPROTO_TCP, 0, NULL, NULL);
+	if (!socket)
+	{
+		[self errorWithName:@"Unable to create socket."];
+		return;
+	}
+
+	int reuse = true;
+	int fileDescriptor = CFSocketGetNative(socket);
+	if (setsockopt(fileDescriptor, SOL_SOCKET, SO_REUSEADDR,
+		(void *)&reuse, sizeof(int)) != 0)
+	{
+		[self errorWithName:@"Unable to set socket options."];
+		return;
+	}
+	
+	struct sockaddr_in address;
+	memset(&address, 0, sizeof(address));
+	address.sin_len = sizeof(address);
+	address.sin_family = AF_INET;
+	address.sin_addr.s_addr = htonl(INADDR_ANY);
+	address.sin_port = htons(HTTP_SERVER_PORT);
+	CFDataRef addressData =
+		CFDataCreate(NULL, (const UInt8 *)&address, sizeof(address));
+	[(id)addressData autorelease];
+	
+	if (CFSocketSetAddress(socket, addressData) != kCFSocketSuccess)
+	{
+		[self errorWithName:@"Unable to bind socket to address."];
+		return;
+	}
+
+	listeningHandle = [[NSFileHandle alloc]
+		initWithFileDescriptor:fileDescriptor
+		closeOnDealloc:YES];
+
+	[[NSNotificationCenter defaultCenter]
+		addObserver:self
+		selector:@selector(receiveIncomingConnectionNotification:)
+		name:NSFileHandleConnectionAcceptedNotification
+		object:nil];
+	[listeningHandle acceptConnectionInBackgroundAndNotify];
+	
+	self.state = SERVER_STATE_RUNNING;
+}
+
+//
+// stopReceivingForFileHandle:close:
+//
+// If a file handle is accumulating the header for a new connection, this
+// method will close the handle, stop listening to it and release the
+// accumulated memory.
+//
+// Parameters:
+//    incomingFileHandle - the file handle for the incoming request
+//    closeFileHandle - if YES, the file handle will be closed, if no it is
+//		assumed that an HTTPResponseHandler will close it when done.
+//
+- (void)stopReceivingForFileHandle:(NSFileHandle *)incomingFileHandle
+	close:(BOOL)closeFileHandle
+{
+	if (closeFileHandle)
+	{
+		[incomingFileHandle closeFile];
+	}
+	
+	[[NSNotificationCenter defaultCenter]
+		removeObserver:self
+		name:NSFileHandleDataAvailableNotification
+		object:incomingFileHandle];
+	CFDictionaryRemoveValue(incomingRequests, incomingFileHandle);
+}
+
+//
+// stop
+//
+// Stops the server.
+//
+- (void)stop
+{
+	self.state = SERVER_STATE_STOPPING;
+
+	[[NSNotificationCenter defaultCenter]
+		removeObserver:self
+		name:NSFileHandleConnectionAcceptedNotification
+		object:nil];
+
+	[responseHandlers removeAllObjects];
+
+	[listeningHandle closeFile];
+	[listeningHandle release];
+	listeningHandle = nil;
+	
+	for (NSFileHandle *incomingFileHandle in
+		[[(NSDictionary *)incomingRequests copy] autorelease])
+	{
+		[self stopReceivingForFileHandle:incomingFileHandle close:YES];
+	}
+	
+	if (socket)
+	{
+		CFSocketInvalidate(socket);
+		CFRelease(socket);
+		socket = nil;
+	}
+
+	self.state = SERVER_STATE_IDLE;
+}
+
+//
+// receiveIncomingConnectionNotification:
+//
+// Receive the notification for a new incoming request. This method starts
+// receiving data from the incoming request's file handle and creates a
+// new CFHTTPMessageRef to store the incoming data..
+//
+// Parameters:
+//    notification - the new connection notification
+//
+- (void)receiveIncomingConnectionNotification:(NSNotification *)notification
+{
+	NSDictionary *userInfo = [notification userInfo];
+	NSFileHandle *incomingFileHandle =
+		[userInfo objectForKey:NSFileHandleNotificationFileHandleItem];
+
+    if(incomingFileHandle)
+	{
+		CFDictionaryAddValue(
+			incomingRequests,
+			incomingFileHandle,
+			[(id)CFHTTPMessageCreateEmpty(kCFAllocatorDefault, TRUE) autorelease]);
+		
+		[[NSNotificationCenter defaultCenter]
+			addObserver:self
+			selector:@selector(receiveIncomingDataNotification:)
+			name:NSFileHandleDataAvailableNotification
+			object:incomingFileHandle];
+		
+        [incomingFileHandle waitForDataInBackgroundAndNotify];
+    }
+
+	[listeningHandle acceptConnectionInBackgroundAndNotify];
+}
+
+//
+// receiveIncomingDataNotification:
+//
+// Receive new data for an incoming connection.
+//
+// Once enough data is received to fully parse the HTTP headers,
+// a HTTPResponseHandler will be spawned to generate a response.
+//
+// Parameters:
+//    notification - data received notification
+//
+- (void)receiveIncomingDataNotification:(NSNotification *)notification
+{
+	NSFileHandle *incomingFileHandle = [notification object];
+	NSData *data = [incomingFileHandle availableData];
+	
+	if ([data length] == 0)
+	{
+		[self stopReceivingForFileHandle:incomingFileHandle close:NO];
+		return;
+	}
+
+	CFHTTPMessageRef incomingRequest =
+		(CFHTTPMessageRef)CFDictionaryGetValue(incomingRequests, incomingFileHandle);
+	if (!incomingRequest)
+	{
+		[self stopReceivingForFileHandle:incomingFileHandle close:YES];
+		return;
+	}
+	
+	if (!CFHTTPMessageAppendBytes(
+		incomingRequest,
+		[data bytes],
+		[data length]))
+	{
+		[self stopReceivingForFileHandle:incomingFileHandle close:YES];
+		return;
+	}
+
+	if(CFHTTPMessageIsHeaderComplete(incomingRequest))
+	{
+		iCukeHTTPResponseHandler *handler =
+			[iCukeHTTPResponseHandler
+				handlerForRequest:incomingRequest
+				fileHandle:incomingFileHandle
+				server:self];
+		
+		[responseHandlers addObject:handler];
+		[self stopReceivingForFileHandle:incomingFileHandle close:NO];
+
+		[handler startResponse];	
+		return;
+	}
+
+	[incomingFileHandle waitForDataInBackgroundAndNotify];
+}
+
+//
+// closeHandler:
+//
+// Shuts down a response handler and removes it from the set of handlers.
+//
+// Parameters:
+//    aHandler - the handler to shut down.
+//
+- (void)closeHandler:(iCukeHTTPResponseHandler *)aHandler
+{
+	[aHandler endResponse];
+	[responseHandlers removeObject:aHandler];
+}
+
+@end

data/ext/iCuke/iCukeServer.h

@@ -0,0 +1,16 @@
+//
+//  iCukeServer.h
+//  iCuke
+//
+//  Created by Rob Holland on 01/03/2010.
+//  Copyright 2010 The IT Refinery. All rights reserved.
+//
+
+#import "iCukeHTTPServer.h"
+
+@interface iCukeServer : iCukeHTTPServer {
+}
+
++ (void) start;
+
+@end

data/ext/iCuke/iCukeServer.m

@@ -0,0 +1,46 @@
+//
+//  iCukeServer.m
+//  iCuke
+//
+//  Created by Rob Holland on 01/03/2010.
+//  Copyright 2010 The IT Refinery. All rights reserved.
+//
+
+#import "iCukeServer.h"
+#include <unistd.h>
+
+@implementation iCukeServer
+
++ (void)start {
+	[[iCukeHTTPServer sharediCukeHTTPServer] start];
+
+	NSFileManager *fileManager= [[NSFileManager alloc] init];
+	NSArray *paths;
+
+	NSString *preferences = [NSHomeDirectory() stringByAppendingPathComponent: @"Library/Preferences"];
+
+	paths = [fileManager contentsOfDirectoryAtPath: preferences error: NULL];
+	for (NSString *path in paths) {
+		if (![path hasPrefix: @"."]) {
+			NSLog(@"Removing: %@", path);
+			unlink([[preferences stringByAppendingPathComponent: path] cStringUsingEncoding: [NSString defaultCStringEncoding]]);
+		}
+	}
+
+	NSString *documents = [NSHomeDirectory() stringByAppendingPathComponent: @"Documents"];
+	paths = [fileManager contentsOfDirectoryAtPath: documents error: NULL];
+	for (NSString *path in paths) {
+		if (![path hasPrefix: @"."]) {
+			NSLog(@"Removing: %@", path);
+			unlink([[documents stringByAppendingPathComponent: path] cStringUsingEncoding: [NSString defaultCStringEncoding]]);
+		}
+	}
+}
+
+@end
+
+void start_server(void) __attribute__((constructor));
+void start_server(void)
+{
+  [iCukeServer start];
+}

data/ext/iCuke/json/JSON.h

@@ -0,0 +1,50 @@
+/*
+ Copyright (C) 2009 Stig Brautaset. 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 author 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 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.
+ */
+
+/**
+ @mainpage A strict JSON parser and generator for Objective-C
+
+ JSON (JavaScript Object Notation) is a lightweight data-interchange
+ format. This framework provides two apis for parsing and generating
+ JSON. One standard object-based and a higher level api consisting of
+ categories added to existing Objective-C classes.
+
+ Learn more on the http://code.google.com/p/json-framework project site.
+ 
+ This framework does its best to be as strict as possible, both in what it
+ accepts and what it generates. For example, it does not support trailing commas
+ in arrays or objects. Nor does it support embedded comments, or
+ anything else not in the JSON specification. This is considered a feature. 
+ 
+*/
+
+#import "SBJSON.h"
+#import "NSObject+SBJSON.h"
+#import "NSString+SBJSON.h"
+

data/ext/iCuke/json/NSObject+SBJSON.h

@@ -0,0 +1,68 @@
+/*
+ Copyright (C) 2009 Stig Brautaset. 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 author 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 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+
+/**
+ @brief Adds JSON generation to Foundation classes
+ 
+ This is a category on NSObject that adds methods for returning JSON representations
+ of standard objects to the objects themselves. This means you can call the
+ -JSONRepresentation method on an NSArray object and it'll do what you want.
+ */
+@interface NSObject (NSObject_SBJSON)
+
+/**
+ @brief Returns a string containing the receiver encoded as a JSON fragment.
+ 
+ This method is added as a category on NSObject but is only actually
+ supported for the following objects:
+ @li NSDictionary
+ @li NSArray
+ @li NSString
+ @li NSNumber (also used for booleans)
+ @li NSNull 
+ 
+ @deprecated Given we bill ourselves as a "strict" JSON library, this method should be removed.
+ */
+- (NSString *)JSONFragment;
+
+/**
+ @brief Returns a string containing the receiver encoded in JSON.
+
+ This method is added as a category on NSObject but is only actually
+ supported for the following objects:
+ @li NSDictionary
+ @li NSArray
+ */
+- (NSString *)JSONRepresentation;
+
+@end
+

data/ext/iCuke/json/NSObject+SBJSON.m

@@ -0,0 +1,53 @@
+/*
+ Copyright (C) 2009 Stig Brautaset. 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 author 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 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.
+ */
+
+#import "NSObject+SBJSON.h"
+#import "SBJsonWriter.h"
+
+@implementation NSObject (NSObject_SBJSON)
+
+- (NSString *)JSONFragment {
+    SBJsonWriter *jsonWriter = [SBJsonWriter new];
+    NSString *json = [jsonWriter stringWithFragment:self];    
+    if (!json)
+        NSLog(@"-JSONFragment failed. Error trace is: %@", [jsonWriter errorTrace]);
+    [jsonWriter release];
+    return json;
+}
+
+- (NSString *)JSONRepresentation {
+    SBJsonWriter *jsonWriter = [SBJsonWriter new];    
+    NSString *json = [jsonWriter stringWithObject:self];
+    if (!json)
+        NSLog(@"-JSONRepresentation failed. Error trace is: %@", [jsonWriter errorTrace]);
+    [jsonWriter release];
+    return json;
+}
+
+@end

data/ext/iCuke/json/NSString+SBJSON.h

@@ -0,0 +1,58 @@
+/*
+ Copyright (C) 2009 Stig Brautaset. 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 author 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 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+/**
+ @brief Adds JSON parsing methods to NSString
+ 
+This is a category on NSString that adds methods for parsing the target string.
+*/
+@interface NSString (NSString_SBJSON)
+
+
+/**
+ @brief Returns the object represented in the receiver, or nil on error. 
+ 
+ Returns a a scalar object represented by the string's JSON fragment representation.
+ 
+ @deprecated Given we bill ourselves as a "strict" JSON library, this method should be removed.
+ */
+- (id)JSONFragmentValue;
+
+/**
+ @brief Returns the NSDictionary or NSArray represented by the current string's JSON representation.
+ 
+ Returns the dictionary or array represented in the receiver, or nil on error.
+
+ Returns the NSDictionary or NSArray represented by the current string's JSON representation.
+ */
+- (id)JSONValue;
+
+@end