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, 26 insertions, 24 deletions

diff --git a/Source/SPDataImport.m b/Source/SPDataImport.m
index 7f90eea7..58d132ce 100644
--- a/Source/SPDataImport.m
+++ b/Source/SPDataImport.m
@@ -39,8 +39,8 @@
 #import "SPFieldMapperController.h"
 #import "SPFileHandle.h"
 #import "SPEncodingPopupAccessory.h"
+#import "SPMySQL.h"
 
-#import <MCPKit/MCPKit.h>
 #import <UniversalDetector/UniversalDetector.h>
 
 #define SP_FILE_READ_ERROR_STRING NSLocalizedString(@"File read error", @"File read error title (Import Dialog)")
@@ -424,9 +424,9 @@
 			[fileEncodingDetector analyzeData:[detectorFileHandle readDataOfLength:2500000]];
 			sqlEncoding = [fileEncodingDetector encoding];
 			[fileEncodingDetector release];
-			if ([MCPConnection mySQLEncodingForStringEncoding:sqlEncoding]) {
+			if ([SPMySQLConnection mySQLCharsetForStringEncoding:sqlEncoding]) {
 				connectionEncodingToRestore = [mySQLConnection encoding];
-				[mySQLConnection queryString:[NSString stringWithFormat:@"SET NAMES '%@'", [MCPConnection mySQLEncodingForStringEncoding:sqlEncoding]]];
+				[mySQLConnection queryString:[NSString stringWithFormat:@"SET NAMES '%@'", [SPMySQLConnection mySQLCharsetForStringEncoding:sqlEncoding]]];
 			}
 		}
 
@@ -564,11 +564,11 @@
 			if (![query length]) continue;
 			
 			// Run the query
-			[mySQLConnection queryString:query usingEncoding:sqlEncoding streamingResult:NO];
+			[mySQLConnection queryString:query usingEncoding:sqlEncoding withResultType:SPMySQLResultAsResult];
 
 			// Check for any errors
-			if ([mySQLConnection queryErrored] && ![[mySQLConnection getLastErrorMessage] isEqualToString:@"Query was empty"]) {
-				[errors appendFormat:NSLocalizedString(@"[ERROR in query %ld] %@\n", @"error text when multiple custom query failed"), (long)(queriesPerformed+1), [mySQLConnection getLastErrorMessage]];
+			if ([mySQLConnection queryErrored] && ![[mySQLConnection lastErrorMessage] isEqualToString:@"Query was empty"]) {
+				[errors appendFormat:NSLocalizedString(@"[ERROR in query %ld] %@\n", @"error text when multiple custom query failed"), (long)(queriesPerformed+1), [mySQLConnection lastErrorMessage]];
 
 				// If not set to ignore errors, ask what to do.  Use NSAlert rather than
 				// SPBeginWaitingAlertSheet as there is already a modal sheet in progress.
@@ -580,7 +580,7 @@
 								   defaultButton:NSLocalizedString(@"Continue", @"continue button")
 								 alternateButton:NSLocalizedString(@"Ignore All Errors", @"ignore errors button")
 									 otherButton:NSLocalizedString(@"Stop", @"stop button")
-					   informativeTextWithFormat:NSLocalizedString(@"[ERROR in query %ld] %@\n", @"error text when multiple custom query failed"), (long)(queriesPerformed+1), [mySQLConnection getLastErrorMessage]
+					   informativeTextWithFormat:NSLocalizedString(@"[ERROR in query %ld] %@\n", @"error text when multiple custom query failed"), (long)(queriesPerformed+1), [mySQLConnection lastErrorMessage]
 					];
 					[sqlErrorAlert setAlertStyle:NSWarningAlertStyle];
 					sqlImportErrorSheetReturnCode = [sqlErrorAlert runModal];
@@ -632,11 +632,11 @@
 	if ([query length] && !progressCancelled) {
 
 		// Run the query
-		[mySQLConnection queryString:query usingEncoding:sqlEncoding streamingResult:NO];
+		[mySQLConnection queryString:query usingEncoding:sqlEncoding withResultType:SPMySQLResultAsResult];
 
 		// Check for any errors
-		if ([mySQLConnection queryErrored] && ![[mySQLConnection getLastErrorMessage] isEqualToString:@"Query was empty"]) {
-			[errors appendFormat:NSLocalizedString(@"[ERROR in query %ld] %@\n", @"error text when multiple custom query failed"), (long)(queriesPerformed+1), [mySQLConnection getLastErrorMessage]];
+		if ([mySQLConnection queryErrored] && ![[mySQLConnection lastErrorMessage] isEqualToString:@"Query was empty"]) {
+			[errors appendFormat:NSLocalizedString(@"[ERROR in query %ld] %@\n", @"error text when multiple custom query failed"), (long)(queriesPerformed+1), [mySQLConnection lastErrorMessage]];
 		}
 
 		// Increment the processed queries count
@@ -672,7 +672,7 @@
 	[tablesListInstance updateTables:self];
 	
 	// Re-query the structure of all databases in the background
-	[NSThread detachNewThreadSelector:@selector(queryDbStructureWithUserInfo:) toTarget:mySQLConnection withObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:YES], @"forceUpdate", nil]];
+	[NSThread detachNewThreadSelector:@selector(queryDbStructureWithUserInfo:) toTarget:[tableDocumentInstance databaseStructureRetrieval] withObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:YES], @"forceUpdate", nil]];
 	
     // Import finished Growl notification
     [[SPGrowlController sharedGrowlController] notifyWithTitle:@"Import Finished" 
@@ -1067,10 +1067,10 @@
 							[tableDocumentInstance showConsole:nil];
 							[errors appendFormat:
 								NSLocalizedString(@"[ERROR in row %ld] %@\n", @"error text when reading of csv file gave errors"),
-								(long)(rowsImported+1),[mySQLConnection getLastErrorMessage]];
+								(long)(rowsImported+1),[mySQLConnection lastErrorMessage]];
 						}
 
-						if ( insertRemainingRowsAfterUpdate && ![mySQLConnection affectedRows]) {
+						if ( insertRemainingRowsAfterUpdate && ![mySQLConnection rowsAffectedByLastQuery]) {
 							query = [[NSMutableString alloc] initWithString:insertRemainingBaseString];
 							[query appendString:[self mappedValueStringForRowArray:[parsedRows objectAtIndex:i]]];
 
@@ -1084,7 +1084,7 @@
 							if ([mySQLConnection queryErrored]) {
 								[errors appendFormat:
 									NSLocalizedString(@"[ERROR in row %ld] %@\n", @"error text when reading of csv file gave errors"),
-									(long)(rowsImported+1),[mySQLConnection getLastErrorMessage]];
+									(long)(rowsImported+1),[mySQLConnection lastErrorMessage]];
 							}
 						}
 
@@ -1120,7 +1120,7 @@
 						if ([mySQLConnection queryErrored]) {
 							[errors appendFormat:
 								NSLocalizedString(@"[ERROR in row %ld] %@\n", @"error text when reading of csv file gave errors"),
-								(long)(rowsImported+1),[mySQLConnection getLastErrorMessage]];
+								(long)(rowsImported+1),[mySQLConnection lastErrorMessage]];
 						}
 						rowsImported++;
 						if (fileIsCompressed) {
@@ -1194,7 +1194,7 @@
 		[tablesListInstance performSelectorOnMainThread:@selector(updateTables:) withObject:self waitUntilDone:YES];
 	
 		// Re-query the structure of all databases in the background
-		[NSThread detachNewThreadSelector:@selector(queryDbStructureWithUserInfo:) toTarget:mySQLConnection withObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:YES], @"forceUpdate", nil]];
+		[NSThread detachNewThreadSelector:@selector(queryDbStructureWithUserInfo:) toTarget:[tableDocumentInstance databaseStructureRetrieval] withObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:YES], @"forceUpdate", nil]];
 
 		// Select the new table
 		[tablesListInstance selectItemWithName:selectedTableTarget];
@@ -1379,7 +1379,7 @@
 			if(fieldMappingArrayHasGlobalVariables && mapColumn >= numberOfImportDataColumns) {
 				NSMutableString *globalVar = [NSMutableString string];
 				id insertItem = NSArrayObjectAtIndex(fieldMappingGlobalValueArray, mapColumn);
-				if([insertItem isKindOfClass:[NSNull class]]) {
+				if([insertItem isNSNull]) {
 					[globalVar setString:@"NULL"];
 				} else if([insertItem isSPNotLoaded]) {
 					[globalVar setString:@"NULL"];
@@ -1417,7 +1417,7 @@
 				if (cellData == [NSNull null]) {
 					[setString appendString:@"NULL"];
 				} else {
-					[setString appendFormat:@"'%@'", [mySQLConnection prepareString:cellData]];
+					[setString appendString:[mySQLConnection escapeAndQuoteString:cellData]];
 				}
 			}
 		}
@@ -1431,7 +1431,7 @@
 			if(fieldMappingArrayHasGlobalVariables && mapColumn >= numberOfImportDataColumns) {
 				NSMutableString *globalVar = [NSMutableString string];
 				id insertItem = NSArrayObjectAtIndex(fieldMappingGlobalValueArray, mapColumn);
-				if([insertItem isKindOfClass:[NSNull class]]) {
+				if([insertItem isNSNull]) {
 					[globalVar setString:@"NULL"];
 				} else if([insertItem isSPNotLoaded]) {
 					[globalVar setString:@"NULL"];
@@ -1469,7 +1469,8 @@
 				if (cellData == [NSNull null]) {
 					[whereString appendString:@" IS NULL"];
 				} else {
-					[whereString appendFormat:@"='%@'", [mySQLConnection prepareString:cellData]];
+					[whereString appendString:@"="];
+					[whereString appendString:[mySQLConnection escapeAndQuoteString:cellData]];
 				}
 			}
 		}
@@ -1505,7 +1506,7 @@
 		if(fieldMappingArrayHasGlobalVariables && mapColumn >= numberOfImportDataColumns) {
 			NSMutableString *globalVar = [NSMutableString string];
 			id insertItem = NSArrayObjectAtIndex(fieldMappingGlobalValueArray, mapColumn);
-			if([insertItem isKindOfClass:[NSNull class]]) {
+			if([insertItem isNSNull]) {
 				[globalVar setString:@"NULL"];
 			} else if([insertItem isSPNotLoaded]) {
 				[globalVar setString:@"NULL"];
@@ -1549,9 +1550,10 @@
 				if([geometryFields count] && [geometryFieldsMapIndex containsIndex:i]) {
 					[valueString appendString:[(NSString*)cellData getGeomFromTextString]];
 				} else if([bitFields count] && [bitFieldsMapIndex containsIndex:i]) {
-					[valueString appendFormat:@"b'%@'", [mySQLConnection prepareString:cellData]];
+					[valueString appendString:@"b"];
+					[valueString appendString:[mySQLConnection escapeAndQuoteString:cellData]];
 				} else {
-					[valueString appendFormat:@"'%@'", [mySQLConnection prepareString:cellData]];
+					[valueString appendString:[mySQLConnection escapeAndQuoteString:cellData]];
 				}
 			}
 		}
@@ -1636,7 +1638,7 @@
 /**
  * Sets the connection (received from SPDatabaseDocument) and makes things that have to be done only once.
  */
-- (void)setConnection:(MCPConnection *)theConnection
+- (void)setConnection:(SPMySQLConnection *)theConnection
 {
 	NSButtonCell *switchButton = [[NSButtonCell alloc] init];