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, 181 insertions, 0 deletions

diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.h
new file mode 100644
index 00000000..8f3b7f9f
--- /dev/null
+++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.h
@@ -0,0 +1,181 @@
+//
+//  $Id$
+//
+//  SPMySQLConnection.h
+//  SPMySQLFramework
+//
+//  Created by Rowan Beentje (rowan.beent.je) on January 8, 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/>
+
+@class SPMySQLKeepAliveTimer;
+
+@interface SPMySQLConnection : NSObject {
+
+	// Delegate
+	NSObject <SPMySQLConnectionDelegate> *delegate;
+	BOOL delegateSupportsWillQueryString;
+	BOOL delegateSupportsConnectionLost;
+	BOOL delegateQueryLogging; // Defaults to YES if protocol implemented
+
+	// Basic connection details
+	NSString *host;
+	NSString *username;
+	NSString *password;
+	NSUInteger port;
+	BOOL useSocket;
+	NSString *socketPath;
+
+	// SSL connection details
+	BOOL useSSL;
+	NSString *sslKeyFilePath;
+	NSString *sslCertificatePath;
+	NSString *sslCACertificatePath;
+
+	// MySQL connection details and state
+	struct st_mysql *mySQLConnection;
+	SPMySQLConnectionState state;
+	BOOL connectedWithSSL;
+	BOOL userTriggeredDisconnect;
+	BOOL isReconnecting;
+	uint64_t initialConnectTime;
+	unsigned long mysqlConnectionThreadId;
+
+	// Connection proxy
+	NSObject <SPMySQLConnectionProxy> *proxy;
+	SPMySQLConnectionProxyState previousProxyState;
+	BOOL proxyStateChangeNotificationsIgnored;
+
+	// Connection lock to prevent non-thread-safe query misuse
+	NSConditionLock *connectionLock;
+
+	// Currently selected database
+	NSString *database;
+
+	// Delegate connection lost decisions
+	NSUInteger reconnectionRetryAttempts;
+	SPMySQLConnectionLostDecision lastDelegateDecisionForLostConnection;
+	NSLock *delegateDecisionLock;
+
+	// Timeout and keep-alive
+	NSUInteger timeout;
+	BOOL useKeepAlive;
+	SPMySQLKeepAliveTimer *keepAliveTimer;
+	CGFloat keepAliveInterval;
+	uint64_t lastKeepAliveTime;
+	NSUInteger keepAlivePingFailures;
+	pthread_t keepAlivePingThread;
+	BOOL keepAlivePingThreadActive;
+	BOOL keepAliveLastPingSuccess;
+	BOOL keepAliveLastPingBlocked;
+
+	// Encoding details - and also a record of any previous encoding to allow
+	// switching back and forth
+	NSString *encoding;
+	NSStringEncoding stringEncoding;
+	BOOL encodingUsesLatin1Transport;
+	NSString *previousEncoding;
+	BOOL previousEncodingUsesLatin1Transport;
+
+	// Server details
+	NSString *serverVersionString;
+
+	// Error state for the last query or connection state
+	NSUInteger queryErrorID;
+	NSString *queryErrorMessage;
+
+	// Query details
+	unsigned long long lastQueryAffectedRowCount;
+	unsigned long long lastQueryInsertID;
+
+	// Query cancellation details
+	BOOL lastQueryWasCancelled;
+	BOOL lastQueryWasCancelledUsingReconnect;
+
+	// Timing details
+	uint64_t lastConnectionUsedTime;
+	double lastQueryExecutionTime;
+
+	// Maximum query size
+	NSUInteger maxQuerySize;
+	BOOL maxQuerySizeIsEditable;
+	BOOL maxQuerySizeEditabilityChecked;
+	NSUInteger queryActionShouldRestoreMaxQuerySize;
+
+	// Queries
+	BOOL retryQueriesOnConnectionFailure;
+}
+
+#pragma mark -
+#pragma mark Synthesized properties
+
+@property (readwrite, assign, nonatomic) NSObject <SPMySQLConnectionDelegate> *delegate;
+@property (readwrite, assign, nonatomic) NSObject <SPMySQLConnectionProxy> *proxy;
+
+@property (readwrite, retain) NSString *host;
+@property (readwrite, retain) NSString *username;
+@property (readwrite, retain) NSString *password;
+@property (readwrite, assign) NSUInteger port;
+@property (readwrite, assign) BOOL useSocket;
+@property (readwrite, retain) NSString *socketPath;
+
+@property (readwrite, assign) BOOL useSSL;
+@property (readwrite, retain) NSString *sslKeyFilePath;
+@property (readwrite, retain) NSString *sslCertificatePath;
+@property (readwrite, retain) NSString *sslCACertificatePath;
+
+@property (readwrite, assign) NSUInteger timeout;
+@property (readwrite, assign) BOOL useKeepAlive;
+@property (readwrite, assign) CGFloat keepAliveInterval;
+
+@property (readonly) unsigned long mysqlConnectionThreadId;
+@property (readwrite, assign) BOOL retryQueriesOnConnectionFailure;
+
+@property (readwrite, assign) BOOL delegateQueryLogging;
+
+@property (readwrite, assign) BOOL lastQueryWasCancelled;
+
+#pragma mark -
+#pragma mark Connection and disconnection
+
+- (BOOL)connect;
+- (BOOL)reconnect;
+- (void)disconnect;
+
+#pragma mark -
+#pragma mark Connection state
+
+- (BOOL)isConnected;
+- (BOOL)isConnectedViaSSL;
+- (BOOL)checkConnection;
+- (double)timeConnected;
+- (BOOL)userTriggeredDisconnect;
+
+#pragma mark -
+#pragma mark Connection utility
+
++ (NSString *)findSocketPath;
+
+@end