Merge in the SPMySQL Framework. This new framework should provide much of the functionality required from MCPKit and is based around its interface for relatively easy integration.

Externally visible changes as a result of this merge:
 - Speed improvements, particularly when loading large data sets
 - Stability improvements, particularly related to connection state after the connection is dropped (eg Issue #1256)
 - Improved support for new MySQL data types, which should address Issue #1052.
 - Database structure retrieval and query cancellation now use a single persistent helper connection instead of lots of connections on-demand.  This should help Issue  #1097.
 - More internal commands now use queries instead of MySQL functions; for example USE queries are now used to trigger database selection, improving transcripts.  This addresses Issue #1247.
 - Improved internal encoding work; while this needs support within the UI, it lays the foundation for issues like Issue #1280.

Code improvements:
 - Much improved class layouts including extensive category usage
 - Improved documentation across framework methods
 - Support for fast enumeration across result objects
 - Rewrite fixes use of a number of deprecate functions
 - Much less code duplication across result set types
 - Improved encapsultation within the framework, limiting the number of methods exposed, and also not exposing all the MySQL headers

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, 42 insertions, 31 deletions

diff --git a/Source/SPConnectionController.m b/Source/SPConnectionController.m
index 94af9056..acec49de 100644
--- a/Source/SPConnectionController.m
+++ b/Source/SPConnectionController.m
@@ -25,6 +25,7 @@
 
 #import "SPConnectionController.h"
 #import "SPDatabaseDocument.h"
+#import "SPMySQL.h"
 
 #ifndef SP_REFACTOR /* headers */
 #import "SPAppController.h"
@@ -437,7 +438,7 @@
 		return;
 	}
 
-	if (newState == PROXY_STATE_IDLE) {
+	if (newState == SPMySQLProxyIdle) {
 #ifndef SP_REFACTOR
 		[tableDocument setTitlebarStatus:NSLocalizedString(@"SSH Disconnected", @"SSH disconnected titlebar marker")];
 #endif
@@ -445,7 +446,7 @@
 		[self failConnectionWithTitle:NSLocalizedString(@"SSH connection failed!", @"SSH connection failed title") errorMessage:[theTunnel lastError] detail:[sshTunnel debugMessages]];
 		[self _restoreConnectionInterface];
 	} 
-	else if (newState == PROXY_STATE_CONNECTED) {
+	else if (newState == SPMySQLProxyConnected) {
 #ifndef SP_REFACTOR
 		[tableDocument setTitlebarStatus:NSLocalizedString(@"SSH Connected", @"SSH connected titlebar marker")];
 #endif
@@ -600,7 +601,7 @@
 /**
  * Opens the SSH/SSL key selection window, ready to select a key file.
  */
-- (IBAction)chooseKeyLocation:(id)sender
+- (IBAction)chooseKeyLocation:(NSButton *)sender
 {
 #ifndef SP_REFACTOR /* favorites */
 	[favoritesTable deselectAll:self];
@@ -930,7 +931,7 @@
 /**
  * Reverses the favorites table view sorting based on the selected criteria.
  */
-- (void)reverseSortFavorites:(id)sender
+- (void)reverseSortFavorites:(NSMenuItem *)sender
 {
     reverseFavoritesSort = (![sender state]);
 
@@ -1388,22 +1389,26 @@
 - (void)_initiateMySQLConnectionInBackground
 {
 	NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+	mySQLConnection = [[SPMySQLConnection alloc] init];
+
+	// Set up shared details
+	[mySQLConnection setUsername:[self user]];
 
 	// Initialise to socket if appropriate.
 	if ([self type] == SPSocketConnection) {
-		mySQLConnection = [[MCPConnection alloc] initToSocket:[self socket] withLogin:[self user]];
+		[mySQLConnection setUseSocket:YES];
+		[mySQLConnection setSocketPath:[self socket]];
 
-		// Otherwise, initialise to host, using tunnel if appropriate
+	// Otherwise, initialise to host, using tunnel if appropriate
 	} else {
+		[mySQLConnection setUseSocket:NO];
 		if ([self type] == SPSSHTunnelConnection) {
-			mySQLConnection = [[MCPConnection alloc] initToHost:@"127.0.0.1"
-													  withLogin:[self user]
-													  usingPort:[sshTunnel localPort]];
-			[mySQLConnection setConnectionProxy:sshTunnel];
+			[mySQLConnection setHost:@"127.0.0.1"];
+			[mySQLConnection setPort:[sshTunnel localPort]];
+			[mySQLConnection setProxy:sshTunnel];
 		} else {
-			mySQLConnection = [[MCPConnection alloc] initToHost:[self host]
-													  withLogin:[self user]
-													  usingPort:([[self port] length]?[[self port] integerValue]:3306)];
+			[mySQLConnection setHost:[self host]];
+			if ([[self port] length]) [mySQLConnection setPort:[[self port] integerValue]];
 		}
 	}
 
@@ -1414,24 +1419,30 @@
 
 	// Enable SSL if set
 	if ([self useSSL]) {
-		[mySQLConnection setSSL:YES
-			usingKeyFilePath:[self sslKeyFileLocationEnabled] ? [self sslKeyFileLocation] : nil
-			certificatePath:[self sslCertificateFileLocationEnabled] ? [self sslCertificateFileLocation] : nil
-			certificateAuthorityCertificatePath:[self sslCACertFileLocationEnabled] ? [self sslCACertFileLocation] : nil];
+		[mySQLConnection setUseSSL:YES];
+		if ([self sslKeyFileLocationEnabled]) {
+			[mySQLConnection setSslKeyFilePath:[self sslKeyFileLocation]];
+		}
+		if ([self sslCertificateFileLocationEnabled]) {
+			[mySQLConnection setSslCertificatePath:[self sslCertificateFileLocation]];
+		}
+		if ([self sslCACertFileLocationEnabled]) {
+			[mySQLConnection setSslCACertificatePath:[self sslCACertFileLocation]];
+		}
 	}
 
-
 	// Connection delegate must be set before actual connection attempt is made
 	[mySQLConnection setDelegate:tableDocument];
+
 #ifndef SP_REFACTOR /* set mysql connection settings from prefs */
 	// Set whether or not we should enable delegate logging according to the prefs
 	[mySQLConnection setDelegateQueryLogging:[prefs boolForKey:SPConsoleEnableLogging]];
 #endif
 
 	// Set options from preferences
-	[mySQLConnection setConnectionTimeout:[[prefs objectForKey:SPConnectionTimeoutValue] integerValue]];
+	[mySQLConnection setTimeout:[[prefs objectForKey:SPConnectionTimeoutValue] integerValue]];
 	[mySQLConnection setUseKeepAlive:[[prefs objectForKey:SPUseKeepAlive] boolValue]];
-	[mySQLConnection setKeepAliveInterval:[[prefs objectForKey:SPKeepAliveInterval] doubleValue]];
+	[mySQLConnection setKeepAliveInterval:[[prefs objectForKey:SPKeepAliveInterval] floatValue]];
 
 	// Connect
 	[mySQLConnection connect];
@@ -1443,7 +1454,7 @@
 			[[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.2]];
 
 			// If the state is connection refused, attempt the MySQL connection again with the host using the hostfield value.
-			if ([sshTunnel state] == PROXY_STATE_FORWARDING_FAILED) {
+			if ([sshTunnel state] == SPMySQLProxyForwardingFailed) {
 				if ([sshTunnel localPortFallback]) {
 					[mySQLConnection setPort:[sshTunnel localPortFallback]];
 					[mySQLConnection connect];
@@ -1456,20 +1467,20 @@
 
 		if (![mySQLConnection isConnected]) {
 			NSString *errorMessage = @"";
-			if (sshTunnel && [sshTunnel state] == PROXY_STATE_FORWARDING_FAILED) {
-				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@ because the port connection via SSH was refused.\n\nPlease ensure that your MySQL host is set up to allow TCP/IP connections (no --skip-networking) and is configured to allow connections from the host you are tunnelling via.\n\nYou may also want to check the port is correct and that you have the necessary privileges.\n\nChecking the error detail will show the SSH debug log which may provide more details.\n\nMySQL said: %@", @"message of panel when SSH port forwarding failed"), [self host], [mySQLConnection getLastErrorMessage]];
+			if (sshTunnel && [sshTunnel state] == SPMySQLProxyForwardingFailed) {
+				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@ because the port connection via SSH was refused.\n\nPlease ensure that your MySQL host is set up to allow TCP/IP connections (no --skip-networking) and is configured to allow connections from the host you are tunnelling via.\n\nYou may also want to check the port is correct and that you have the necessary privileges.\n\nChecking the error detail will show the SSH debug log which may provide more details.\n\nMySQL said: %@", @"message of panel when SSH port forwarding failed"), [self host], [mySQLConnection lastErrorMessage]];
 				[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"SSH port forwarding failed", @"title when ssh tunnel port forwarding failed") errorMessage:errorMessage detail:[sshTunnel debugMessages]];
-			} else if ([mySQLConnection getLastErrorID] == 1045) { // "Access denied" error
-				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@ because access was denied.\n\nDouble-check your username and password and ensure that access from your current location is permitted.\n\nMySQL said: %@", @"message of panel when connection to host failed due to access denied error"), [self host], [mySQLConnection getLastErrorMessage]];
+			} else if ([mySQLConnection lastErrorID] == 1045) { // "Access denied" error
+				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@ because access was denied.\n\nDouble-check your username and password and ensure that access from your current location is permitted.\n\nMySQL said: %@", @"message of panel when connection to host failed due to access denied error"), [self host], [mySQLConnection lastErrorMessage]];
 				[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Access denied!", @"connection failed due to access denied title") errorMessage:errorMessage detail:nil];
-			} else if ([self type] == SPSocketConnection && (![self socket] || ![[self socket] length]) && ![mySQLConnection findSocketPath]) {
-				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"The socket file could not be found in any common location. Please supply the correct socket location.\n\nMySQL said: %@", @"message of panel when connection to socket failed because optional socket could not be found"), [mySQLConnection getLastErrorMessage]];
+			} else if ([self type] == SPSocketConnection && (![self socket] || ![[self socket] length]) && ![SPMySQLConnection findSocketPath]) {
+				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"The socket file could not be found in any common location. Please supply the correct socket location.\n\nMySQL said: %@", @"message of panel when connection to socket failed because optional socket could not be found"), [mySQLConnection lastErrorMessage]];
 				[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Socket not found!", @"socket not found title") errorMessage:errorMessage detail:nil];
 			} else if ([self type] == SPSocketConnection) {
-				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect via the socket, or the request timed out.\n\nDouble-check that the socket path is correct and that you have the necessary privileges, and that the server is running.\n\nMySQL said: %@", @"message of panel when connection to host failed"), [mySQLConnection getLastErrorMessage]];
+				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect via the socket, or the request timed out.\n\nDouble-check that the socket path is correct and that you have the necessary privileges, and that the server is running.\n\nMySQL said: %@", @"message of panel when connection to host failed"), [mySQLConnection lastErrorMessage]];
 				[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Socket connection failed!", @"socket connection failed title") errorMessage:errorMessage detail:nil];
 			} else {
-				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@, or the request timed out.\n\nBe sure that the address is correct and that you have the necessary privileges, or try increasing the connection timeout (currently %ld seconds).\n\nMySQL said: %@", @"message of panel when connection to host failed"), [self host], (long)[[prefs objectForKey:SPConnectionTimeoutValue] integerValue], [mySQLConnection getLastErrorMessage]];
+				errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@, or the request timed out.\n\nBe sure that the address is correct and that you have the necessary privileges, or try increasing the connection timeout (currently %ld seconds).\n\nMySQL said: %@", @"message of panel when connection to host failed"), [self host], (long)[[prefs objectForKey:SPConnectionTimeoutValue] integerValue], [mySQLConnection lastErrorMessage]];
 				[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Connection failed!", @"connection failed title") errorMessage:errorMessage detail:nil];
 			}
 
@@ -1489,8 +1500,8 @@
 	}
 
 	if ([self database] && ![[self database] isEqualToString:@""]) {
-		if (![mySQLConnection selectDB:[self database]]) {
-			[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Could not select database", @"message when database selection failed") errorMessage:[NSString stringWithFormat:NSLocalizedString(@"Connected to host, but unable to connect to database %@.\n\nBe sure that the database exists and that you have the necessary privileges.\n\nMySQL said: %@", @"message of panel when connection to db failed"), [self database], [mySQLConnection getLastErrorMessage]] detail:nil];
+		if (![mySQLConnection selectDatabase:[self database]]) {
+			[[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Could not select database", @"message when database selection failed") errorMessage:[NSString stringWithFormat:NSLocalizedString(@"Connected to host, but unable to connect to database %@.\n\nBe sure that the database exists and that you have the necessary privileges.\n\nMySQL said: %@", @"message of panel when connection to db failed"), [self database], [mySQLConnection lastErrorMessage]] detail:nil];
 
 			// Tidy up
 			isConnecting = NO;