Initial commit of the new SPMySQL Framework, which is added to the project and ready for use but not yet integrated. This new framework should provide much of the functionality required from MCPKit and is based around its interface for relatively easy integration. The largest missing component is Hans' structure code which I believe is better placed outside the framework.

From the Readme file:

The SPMySQL Framework is intended to provide a stable MySQL connection framework, with the ability to run text-based queries and rapidly retrieve result sets with conversion from MySQL data types to Cocoa objects.

SPMySQL.framework has an interface loosely based around that provided by MCPKit by Serge Cohen and Bertrand Mansion (http://mysql-cocoa.sourceforge.net/), and in particular the heavily modified Sequel Pro version (http://www.sequelpro.com/).  It is a full rewrite of the original framework, although it includes code from patches implementing the following Sequel Pro functionality, largely contributed by Hans-Jörg Bibiko, Stuart Connolly, Jakob Egger, and Rowan Beentje:
	- Connection locking (Jakob et al)
	- Ping & keepalive (Rowan et al)
	- Query cancellation (Rowan et al)
	- Delegate setup (Stuart et al)
	- SSL support (Rowan et al)
	- Connection checking (Rowan et al)
	- Version state (Stuart et al)
	- Maximum packet size control (Hans et al)
	- Result multithreading and streaming (Rowan et al)
	- Improved encoding support & switching (Rowan et al)
	- Database structure; moved to inside the app (Hans et al)
	- Query reattempts and error-handling approach (Rowan et al)
	- Geometry result class (Hans et al)
	- Connection proxy (Stuart et al)

1 files changed, 133 insertions, 0 deletions

diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.m
new file mode 100644
index 00000000..3ac013cc
--- /dev/null
+++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.m
@@ -0,0 +1,133 @@
+//
+//  $Id$
+//
+//  Delegate & Proxy.m
+//  SPMySQLFramework
+//
+//  Created by Rowan Beentje (rowan.beent.je) on February 9, 2012
+//  Copyright (c) 2012 Rowan Beentje. All rights reserved.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "Delegate & Proxy.h"
+#import "SPMySQL Private APIs.h"
+
+@implementation SPMySQLConnection (Delegate_and_Proxy)
+
+#pragma mark -
+#pragma mark Connection delegate
+
+/**
+ * Override the synthesized delegate setter, to allow optimisations to oft-made
+ * checks by precacheing availability.
+ */
+- (void)setDelegate:(NSObject <SPMySQLConnectionDelegate> *)aDelegate
+{
+	delegate = aDelegate;
+
+	// Cache whether the delegate implements certain delegate methods
+	delegateSupportsWillQueryString = [delegate respondsToSelector:@selector(willQueryString:connection:)];
+	delegateSupportsConnectionLost = [delegate respondsToSelector:@selector(connectionLost:)];
+}
+
+#pragma mark -
+#pragma mark Connection proxy
+
+/**
+ * Override the synthesized proxy setter, to record the initial state and to
+ * set the state change selector.
+ */
+- (void)setProxy:(NSObject <SPMySQLConnectionProxy> *)aProxy
+{
+	proxy = [aProxy retain];
+	previousProxyState = [aProxy state];
+
+	[proxy setConnectionStateChangeSelector:@selector(_proxyStateChange:) delegate:self];
+}	
+
+@end
+
+#pragma mark -
+
+@implementation SPMySQLConnection (Delegate_and_Proxy_Private_API)
+
+/**
+ * Handle any state changes in the associated connection proxy.
+ */
+- (void)_proxyStateChange:(NSObject <SPMySQLConnectionProxy> *)aProxy
+{
+
+	// Perform no actions if this isn't the current connection proxy, or if notifications
+	// are currently set to be ignored
+	if (aProxy != proxy || proxyStateChangeNotificationsIgnored) return;
+
+	SPMySQLConnectionProxyState newState = [aProxy state];
+	
+	// If the connection proxy disconnects, trigger a reconnect; use a new thread to allow the
+	// main thread to process events as required.
+	if (state == SPMySQLConnected && newState == SPMySQLProxyIdle && previousProxyState == SPMySQLProxyConnected) {
+
+		// Clear the state change selector on the proxy until a connection is re-established
+		proxyStateChangeNotificationsIgnored = YES;
+
+		// Trigger a reconnect
+		[NSThread detachNewThreadSelector:@selector(reconnect) toTarget:self withObject:nil];
+	}
+
+	// Update the state record
+	previousProxyState = newState;
+}
+
+/**
+ * Ask the delegate for the connection lost decision.  This can be called from
+ * any thread, and will call itself on the main thread if necessary, updating a global
+ * variable which is then returned on the child thread.
+ */
+- (SPMySQLConnectionLostDecision)_delegateDecisionForLostConnection
+{
+	SPMySQLConnectionLostDecision theDecision = SPMySQLConnectionLostDisconnect;
+
+	// If on the main thread, ask the delegate directly.
+	if ([NSThread isMainThread]) {
+		[delegateDecisionLock lock];
+		lastDelegateDecisionForLostConnection = [delegate connectionLost:self];
+		theDecision = lastDelegateDecisionForLostConnection;
+		[delegateDecisionLock unlock];
+
+	// Otherwise call ourself on the main thread, waiting until the reply is received.
+	} else {
+
+		// First check whether the application is in a modal state; if so, wait
+		while ([NSApp modalWindow]) usleep(100000);
+
+		[self performSelectorOnMainThread:@selector(_delegateDecisionForLostConnection) withObject:nil waitUntilDone:YES];
+		[delegateDecisionLock lock];
+		theDecision = lastDelegateDecisionForLostConnection;
+		[delegateDecisionLock unlock];
+	}
+
+	return theDecision;
+}
+
+@end