diff options
Diffstat (limited to 'Frameworks/MCPKit/MCPFoundationKit')
22 files changed, 0 insertions, 7838 deletions
diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPConnection.h b/Frameworks/MCPKit/MCPFoundationKit/MCPConnection.h deleted file mode 100644 index 0b3f932b..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPConnection.h +++ /dev/null @@ -1,282 +0,0 @@ -// -// $Id$ -// -// MCPConnection.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2001. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> -#import <pthread.h> - -#import "MCPConstants.h" -#import "mysql.h" - -typedef struct { - MYSQL *mySQLConnection; - BOOL *pingActivePointer; - BOOL *lastPingSuccessPointer; -} MCPConnectionPingDetails; - -@class MCPResult, MCPStreamingResult; -@protocol MCPConnectionProxy, MCPConnectionDelegate; - -@interface MCPConnection : NSObject -{ - MYSQL *mConnection; - BOOL mConnected; - NSStringEncoding mEncoding; - NSTimeZone *mTimeZone; - NSUInteger mConnectionFlags; - - id <MCPConnectionDelegate> delegate; - - // Anything that performs a mysql_net_read is not thread-safe: mysql queries, pings - // Always lock the connection first. Don't use this lock directly, use the lockConnection method! - NSConditionLock *connectionLock; - - BOOL useKeepAlive; - BOOL isDisconnecting; - BOOL isReconnecting; - BOOL userTriggeredDisconnect; - NSInteger connectionTimeout; - CGFloat keepAliveInterval; - - NSObject <MCPConnectionProxy> *connectionProxy; - NSString *connectionLogin; - NSString *connectionPassword; - NSString *connectionHost; - NSUInteger connectionPort; - NSString *connectionSocket; - NSUInteger maxAllowedPacketSize; - unsigned long connectionThreadId; - - BOOL useSSL; - NSString *sslKeyFilePath; - NSString *sslCertificatePath; - NSString *sslCACertificatePath; - - NSString *encoding, *previousEncoding; - NSStringEncoding stringEncoding; - BOOL encodingUsesLatin1Transport, previousEncodingUsesLatin1Transport; - - NSInteger currentProxyState; - - double lastQueryExecutionTime; - double lastQueryExecutedAtTime; - NSString *lastQueryErrorMessage; - NSUInteger lastQueryErrorId; - my_ulonglong lastQueryAffectedRows; - MCPConnectionCheck lastDelegateDecisionForLostConnection; - - BOOL isMaxAllowedPacketEditable; - - NSString *serverVersionString; - NSMutableDictionary *structure; - NSMutableArray *allKeysofDbStructure; - - pthread_t pingThread; - NSInteger pingFailureCount; - BOOL pingThreadActive; - BOOL lastPingSuccess; - BOOL lastPingBlocked; - NSTimer *keepAliveTimer; - double lastKeepAliveTime; - uint64_t connectionStartTime; - - BOOL retryAllowed; - BOOL queryCancelled; - BOOL queryCancelUsedReconnect; - BOOL delegateQueryLogging; - BOOL delegateResponseToWillQueryString; - BOOL delegateSupportsConnectionLostDecisions; - NSInteger isQueryingDbStructure; - BOOL cancelQueryingDbStructure; - BOOL lockQuerying; - NSInteger automaticReconnectAttempts; - - // Pointers - IMP cStringPtr; - IMP willQueryStringPtr; - IMP timeConnectedPtr; - - // Selectors - SEL cStringSEL; - SEL willQueryStringSEL; - SEL timeConnectedSEL; -} - -// Readonly properties -@property (readonly) double lastQueryExecutionTime; - -// Read/write properties -@property (readwrite, assign) BOOL useKeepAlive; -@property (readwrite, assign) BOOL delegateQueryLogging; -@property (readwrite, assign) NSInteger connectionTimeout; -@property (readwrite, assign) CGFloat keepAliveInterval; - -// Initialisation -- (id)initToHost:(NSString *)host withLogin:(NSString *)login usingPort:(NSUInteger)port; -- (id)initToSocket:(NSString *)socket withLogin:(NSString *)login; - -// Delegate -- (id)delegate; -- (void)setDelegate:(id)connectionDelegate; -- (MCPConnectionCheck)delegateDecisionForLostConnection; - -// Connection details -- (BOOL)setPort:(NSUInteger)thePort; -- (BOOL)setPassword:(NSString *)thePassword; -- (void) setSSL:(BOOL)shouldUseSSL usingKeyFilePath:(NSString *)keyFilePath certificatePath:(NSString *)certificatePath certificateAuthorityCertificatePath:(NSString *)caCertificatePath; - -// Proxy -- (BOOL)setConnectionProxy:(id <MCPConnectionProxy>)proxy; -- (void)connectionProxyStateChange:(id <MCPConnectionProxy>)proxy; - -// Connection -- (BOOL)connect; -- (void)disconnect; -- (BOOL)reconnect; -- (BOOL)isConnected; -- (BOOL)isConnectedViaSSL; -- (BOOL)userTriggeredDisconnect; -- (BOOL)checkConnection; -- (void)restoreConnectionDetails; -- (void)setAllowQueryRetries:(BOOL)allow; -- (double)timeConnected; - -// Pinging and keepalive -- (BOOL)pingConnectionUsingLoopDelay:(NSUInteger)loopDelay; -void backgroundPingTask(void *ptr); -void forceThreadExit(int signalNumber); -void pingThreadCleanup(void *pingDetails); -- (void)keepAlive:(NSTimer *)theTimer; -- (void)threadedKeepAlive; - -// Server versions -- (NSString *)serverVersionString; -- (NSInteger)serverMajorVersion; -- (NSInteger)serverMinorVersion; -- (NSInteger)serverReleaseVersion; - -// MySQL defaults -+ (NSDictionary *)getMySQLLocales; -+ (NSStringEncoding)encodingForMySQLEncoding:(const char *)mysqlEncoding; -+ (NSString *) mySQLEncodingForStringEncoding:(NSStringEncoding)stringEncoding; -+ (NSStringEncoding)defaultMySQLEncoding; -+ (BOOL)isErrorNumberConnectionError:(NSInteger)theErrorNumber; - -// Class maintenance -+ (void)setTruncateLongFieldInLogs:(BOOL)iTruncFlag; -+ (BOOL)truncateLongField; -- (BOOL)setConnectionOption:(NSInteger)option toValue:(BOOL)value; -- (BOOL)connectWithLogin:(NSString *)login password:(NSString *)pass host:(NSString *)host port:(NSUInteger)port socket:(NSString *)socket; - -- (BOOL)selectDB:(NSString *)dbName; - -// Error information -- (BOOL)queryErrored; -- (NSString *)getLastErrorMessage; -- (void)setLastErrorMessage:(NSString *)theErrorMessage; -- (NSUInteger)getLastErrorID; -+ (BOOL)isErrorNumberConnectionError:(NSInteger)theErrorNumber; -- (void)updateErrorStatuses; - -// Queries -- (NSString *)prepareBinaryData:(NSData *)theData; -- (NSString *)prepareString:(NSString *)theString; -- (NSString *)quoteObject:(id)theObject; -- (MCPResult *)queryString:(NSString *)query; -- (MCPStreamingResult *)streamingQueryString:(NSString *)query; -- (MCPStreamingResult *)streamingQueryString:(NSString *)query useLowMemoryBlockingStreaming:(BOOL)fullStream; -- (id)queryString:(NSString *)query usingEncoding:(NSStringEncoding)encoding streamingResult:(NSInteger)streamResult; -- (my_ulonglong)affectedRows; -- (my_ulonglong)insertId; -- (void)cancelCurrentQuery; -- (BOOL)queryCancelled; -- (BOOL)queryCancellationUsedReconnect; -- (void)flushMultiResults; - -// Locking -- (void)lockConnection; -- (BOOL)tryLockConnection; -- (void)unlockConnection; - -// Database structure -- (MCPResult *)listDBs; -- (MCPResult *)listDBsLike:(NSString *)dbsName; -- (MCPResult *)listTables; -- (MCPResult *)listTablesLike:(NSString *)tablesName; -- (NSArray *)listTablesFromDB:(NSString *)dbName; -- (NSArray *)listTablesFromDB:(NSString *)dbName like:(NSString *)tablesName; -- (MCPResult *)listFieldsFromTable:(NSString *)tableName; -- (MCPResult *)listFieldsFromTable:(NSString *)tableName like:(NSString *)fieldsName; - -// Structure querying -- (void)queryDbStructureWithUserInfo:(NSDictionary*)userInfo; -- (NSDictionary *)getDbStructure; -- (NSArray *)getAllKeysOfDbStructure; -- (BOOL)isQueryingDatabaseStructure; -- (void)incrementQueryingDbStructure; -- (void)decrementQueryingDbStructure; -- (void)lockQuerying; -- (void)unlockQuerying; -- (void)updateGlobalVariablesWith:(NSDictionary*)object; - -// Server information -- (NSString *)clientInfo; -- (NSString *)hostInfo; -- (NSString *)serverInfo; -- (NSNumber *)protoInfo; -- (MCPResult *)listProcesses; -- (BOOL)killProcess:(unsigned long)pid; -- (NSString *)findSocketPath; - -// Encoding -- (BOOL)setEncoding:(NSString *)theEncoding; -- (NSString *)encoding; -- (NSStringEncoding)stringEncoding; -- (BOOL)setEncodingUsesLatin1Transport:(BOOL)useLatin1; -- (BOOL)encodingUsesLatin1Transport; -- (void)storeEncodingForRestoration; -- (void)restoreStoredEncoding; - -// Time zone -- (void)setTimeZone:(NSTimeZone *)iTimeZone; -- (NSTimeZone *)timeZone; - -// Packet size -- (BOOL)fetchMaxAllowedPacket; -- (NSUInteger)getMaxAllowedPacket; -- (BOOL)isMaxAllowedPacketEditable; -- (NSUInteger)setMaxAllowedPacketTo:(NSUInteger)newSize resetSize:(BOOL)reset; - -// Data conversion -- (const char *)cStringFromString:(NSString *)theString; -- (const char *)cStringFromString:(NSString *)theString usingEncoding:(NSStringEncoding)encoding; -- (NSString *)stringWithCString:(const char *)theCString; -- (NSString *)stringWithCString:(const char *)theCString usingEncoding:(NSStringEncoding)encoding; -- (NSString *)stringWithText:(NSData *)theTextData; -- (NSString *)stringWithUTF8CString:(const char *)theCString; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPConnection.m b/Frameworks/MCPKit/MCPFoundationKit/MCPConnection.m deleted file mode 100644 index 04dcf50d..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPConnection.m +++ /dev/null @@ -1,3402 +0,0 @@ -// -// $Id$ -// -// MCPConnection.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2001. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPConnection.h" -#import "MCPResult.h" -#import "MCPNumber.h" -#import "MCPNull.h" -#import "MCPStreamingResult.h" -#import "MCPConnectionProxy.h" -#import "MCPConnectionDelegate.h" -#import "MCPStringAdditions.h" -#import "RegexKitLite.h" // TODO: Remove along with queryDbStructureWithUserInfo -#import "NSNotificationAdditions.h" - -#include <unistd.h> -#include <mach/mach_time.h> -#include <SystemConfiguration/SystemConfiguration.h> - -const NSUInteger kMCPConnectionDefaultOption = CLIENT_COMPRESS | CLIENT_REMEMBER_OPTIONS | CLIENT_MULTI_RESULTS | CLIENT_INTERACTIVE; -const char *kMCPConnectionDefaultSocket = MYSQL_UNIX_ADDR; -const char *kMCPSSLCipherList = "DHE-RSA-AES256-SHA:AES256-SHA:DHE-RSA-AES128-SHA:AES128-SHA:AES256-RMD:AES128-RMD:DES-CBC3-RMD:DHE-RSA-AES256-RMD:DHE-RSA-AES128-RMD:DHE-RSA-DES-CBC3-RMD:RC4-SHA:RC4-MD5:DES-CBC3-SHA:DES-CBC-SHA:EDH-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC-SHA"; -const NSUInteger kMCPConnection_Not_Inited = 1000; -const NSUInteger kLengthOfTruncationForLog = 100; - -static BOOL sTruncateLongFieldInLogs = YES; - -/** - * Privte API - */ -@interface MCPConnection (PrivateAPI) - -- (void)_updateConnectionVariables; -- (BOOL)_isCurrentHostReachable; -- (void)_setupKeepalivePingTimer; - -@end - -/** - * Note that these aren't actually delegate methods, but are defined because queryDbStructureWithUserInfo needs - * them. We define them here to supress compiler warnings. - * - * TODO: Remove along with queryDbStructureWithUserInfo - */ -@interface MCPConnection (MCPConnectionDelegate) - -- (NSString *)database; -- (NSString *)connectionID; - -- (NSArray *)allDatabaseNames; -- (NSArray *)allSystemDatabaseNames; -- (NSArray *)allTableNames; -- (NSArray *)allViewNames; -- (NSArray *)allSchemaKeys; - -@end - -@implementation MCPConnection - -// Synthesize ivars -@synthesize useKeepAlive; -@synthesize delegateQueryLogging; -@synthesize connectionTimeout; -@synthesize keepAliveInterval; -@synthesize lastQueryExecutionTime; - -#pragma mark - -#pragma mark Initialisation - -/** - * Initialise a MySQLConnection without making a connection, most likely useless, except with !{setConnectionOption:withArgument:}. - * - * Because this method is not making a connection to any MySQL server, it can not know already what the DB server encoding will be, - * hence the encoding is set to some default (at present this is NSISOLatin1StringEncoding). Obviously this is reset to a proper - * value as soon as a DB connection is performed. - */ -- (id)init -{ - if ((self = [super init])) { - mConnection = mysql_init(NULL); - mConnected = NO; - - if (mConnection == NULL) { - [self autorelease]; - - return nil; - } - - encoding = [[NSString alloc] initWithString:@"utf8"]; - previousEncoding = nil; - stringEncoding = NSUTF8StringEncoding; - encodingUsesLatin1Transport = NO; - previousEncodingUsesLatin1Transport = NO; - mConnectionFlags = kMCPConnectionDefaultOption; - - // Anything that performs a mysql_net_read is not thread-safe: mysql queries, pings - // Always lock the connection first. Don't use this lock directly, use the lockConnection method! - connectionLock = [[NSConditionLock alloc] initWithCondition:MCPConnectionIdle]; - [connectionLock setName:@"MCPConnection connectionLock"]; - - connectionHost = nil; - connectionLogin = nil; - connectionSocket = nil; - connectionPassword = nil; - useSSL = NO; - sslKeyFilePath = nil; - sslCertificatePath = nil; - sslCACertificatePath = nil; - lastKeepAliveTime = 0; - pingThread = NULL; - connectionProxy = nil; - connectionStartTime = 0; - lastQueryExecutedAtTime = CGFLOAT_MAX; - lastDelegateDecisionForLostConnection = NSNotFound; - queryCancelled = NO; - queryCancelUsedReconnect = NO; - serverVersionString = nil; - mTimeZone = nil; - isDisconnecting = NO; - isReconnecting = NO; - userTriggeredDisconnect = NO; - automaticReconnectAttempts = 0; - lastPingSuccess = NO; - lastPingBlocked = NO; - pingThreadActive = NO; - pingFailureCount = 0; - - // Initialize ivar defaults - connectionTimeout = 10; - useKeepAlive = YES; - keepAliveInterval = 60; - - structure = [[NSMutableDictionary alloc] initWithCapacity:1]; - allKeysofDbStructure = [[NSMutableArray alloc] initWithCapacity:20]; - isQueryingDbStructure = 0; - lockQuerying = NO; - - connectionThreadId = 0; - maxAllowedPacketSize = 1048576; - lastQueryExecutionTime = 0; - lastQueryErrorId = 0; - lastQueryErrorMessage = nil; - lastQueryAffectedRows = 0; - lastPingSuccess = NO; - delegate = nil; - delegateSupportsConnectionLostDecisions = NO; - delegateResponseToWillQueryString = NO; - - // Enable delegate query logging by default - delegateQueryLogging = YES; - - // Default to allowing queries to be reattempted if they fail due to connection issues - retryAllowed = YES; - - // Obtain SEL references - willQueryStringSEL = @selector(willQueryString:connection:); - cStringSEL = @selector(cStringFromString:); - - // Obtain pointers - cStringPtr = [self methodForSelector:cStringSEL]; - - // Start the keepalive timer - if ([NSThread isMainThread]) - [self _setupKeepalivePingTimer]; - else - [self performSelectorOnMainThread:@selector(_setupKeepalivePingTimer) withObject:nil waitUntilDone:YES]; - } - - return self; -} - -/** - * Inialize connection using the supplied host details. - */ -- (id)initToHost:(NSString *)host withLogin:(NSString *)login usingPort:(NSUInteger)port -{ - if ((self = [self init])) { - if (!host) host = @""; - if (!login) login = @""; - - connectionHost = [[NSString alloc] initWithString:host]; - connectionLogin = [[NSString alloc] initWithString:login]; - connectionPort = port; - connectionSocket = nil; - } - - return self; -} - -/** - * Inialize connection using the supplied socket details. - */ -- (id)initToSocket:(NSString *)aSocket withLogin:(NSString *)login -{ - if ((self = [self init])) { - if (!aSocket || ![aSocket length]) { - aSocket = [self findSocketPath]; - if (!aSocket) aSocket = @""; - } - - if (!login) login = @""; - - connectionHost = nil; - connectionLogin = [[NSString alloc] initWithString:login]; - connectionSocket = [[NSString alloc] initWithString:aSocket]; - connectionPort = 0; - } - - return self; -} - -#pragma mark - -#pragma mark Delegate - -/** - * Get the connection's current delegate. - */ -- (id)delegate -{ - return delegate; -} - -/** - * Set the connection's delegate to the supplied object. - */ -- (void)setDelegate:(id)connectionDelegate -{ - delegate = connectionDelegate; - - // Check that the delegate implements willQueryString:connection: and cache the result as its used very frequently. - delegateResponseToWillQueryString = [delegate respondsToSelector:@selector(willQueryString:connection:)]; - - // Check whether the delegate supports returning a connection lost action decision - delegateSupportsConnectionLostDecisions = [delegate respondsToSelector:@selector(connectionLost:)]; -} - -/** - * 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. - */ -- (MCPConnectionCheck)delegateDecisionForLostConnection -{ - - // Return the "Disconnect" decision if the delegate doesn't support connectionLost: checks - if (!delegateSupportsConnectionLostDecisions) return MCPConnectionCheckDisconnect; - - lastDelegateDecisionForLostConnection = NSNotFound; - - // If on the main thread, ask the delegate directly. - // This is wrapped in a NSLock to ensure variables are completely committed for - // thread-safe access, even though the lock is constrained to this code block. - if ([NSThread isMainThread]) { - NSLock *delegateDecisionLock = [[NSLock alloc] init]; - [delegateDecisionLock lock]; - lastDelegateDecisionForLostConnection = [delegate connectionLost:self]; - [delegateDecisionLock unlock]; - [delegateDecisionLock release]; - - // 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]; - } - - return lastDelegateDecisionForLostConnection; -} - -#pragma mark - -#pragma mark Connection details - -/** - * Sets or updates the connection port - for use with tunnels. - */ -- (BOOL)setPort:(NSUInteger)thePort -{ - connectionPort = thePort; - - return YES; -} - -/** - * Sets the password to be stored locally. - * Providing a keychain name is much more secure. - */ -- (BOOL)setPassword:(NSString *)thePassword -{ - if (connectionPassword) [connectionPassword release], connectionPassword = nil; - - if (!thePassword) thePassword = @""; - - connectionPassword = [[NSString alloc] initWithString:thePassword]; - - return YES; -} - -/** - * Set the connection to establish secure connections using SSL; must be - * called before connect:. - * This will always attempt to activate SSL if set, but depending on server - * setup connection may sometimes proceed without SSL enabled even if requested; - * it is suggested that after connection, -[MCPConnection isConnectedViaSSL] - * is checked to determine whether SSL is actually active. - */ -- (void) setSSL:(BOOL)shouldUseSSL usingKeyFilePath:(NSString *)keyFilePath certificatePath:(NSString *)certificatePath certificateAuthorityCertificatePath:(NSString *)caCertificatePath -{ - useSSL = shouldUseSSL; - - // Reset the old SSL details - if (sslKeyFilePath) [sslKeyFilePath release], sslKeyFilePath = nil; - if (sslCertificatePath) [sslCertificatePath release], sslCertificatePath = nil; - if (sslCACertificatePath) [sslCACertificatePath release], sslCACertificatePath = nil; - - // Set new details if provided - if (keyFilePath) sslKeyFilePath = [[NSString alloc] initWithString:[keyFilePath stringByExpandingTildeInPath]]; - if (certificatePath) sslCertificatePath = [[NSString alloc] initWithString:[certificatePath stringByExpandingTildeInPath]]; - if (caCertificatePath) sslCACertificatePath = [[NSString alloc] initWithString:[caCertificatePath stringByExpandingTildeInPath]]; -} - -#pragma mark - -#pragma mark Connection proxy - -/* - * Set a connection proxy object to connect through. This object will be retained locally, - * and will be automatically connected/connection checked/reconnected/disconnected - * together with the main connection. - */ -- (BOOL)setConnectionProxy:(id <MCPConnectionProxy>)proxy -{ - connectionProxy = proxy; - [connectionProxy retain]; - - currentProxyState = [connectionProxy state]; - [connectionProxy setConnectionStateChangeSelector:@selector(connectionProxyStateChange:) delegate:self]; - - return YES; -} - -/** - * Handle any state changes in the associated connection proxy. - */ -- (void)connectionProxyStateChange:(id <MCPConnectionProxy>)proxy -{ - NSInteger newState = [proxy state]; - - // Restart the tunnel if it dies - use a new thread to allow the main thread to process - // events as required. - if (mConnected && newState == PROXY_STATE_IDLE && currentProxyState == PROXY_STATE_CONNECTED) { - currentProxyState = newState; - [connectionProxy setConnectionStateChangeSelector:nil delegate:nil]; - - // Trigger a reconnect - if (!isDisconnecting) [NSThread detachNewThreadSelector:@selector(reconnect) toTarget:self withObject:nil]; - - return; - } - - currentProxyState = newState; -} - -#pragma mark - -#pragma mark Connection - -/** - * Add a new connection method, intended for use with the init methods above. - * Uses the stored details to instantiate a connection to the specified server, - * including custom timeouts - used for pings, not for long-running commands. - */ -- (BOOL)connect -{ - const char *theLogin = [self cStringFromString:connectionLogin]; - const char *theHost; - const char *thePass = NULL; - const char *theSocket; - void *theRet; - - // Disconnect if a connection is already active - if (mConnected) { - [self disconnect]; - mConnection = mysql_init(NULL); - if (mConnection == NULL) return NO; - } - - [self lockConnection]; - - if (mConnection != NULL) { - - // Ensure the custom timeout option is set - mysql_options(mConnection, MYSQL_OPT_CONNECT_TIMEOUT, (const void *)&connectionTimeout); - - // ensure that automatic reconnection is explicitly disabled - now handled manually. - my_bool falseBool = FALSE; - mysql_options(mConnection, MYSQL_OPT_RECONNECT, &falseBool); - - // Set the connection encoding to utf8 - mysql_options(mConnection, MYSQL_SET_CHARSET_NAME, [encoding UTF8String]); - } - - // Set the host as appropriate - if (!connectionHost || ![connectionHost length]) { - theHost = NULL; - } else { - theHost = [self cStringFromString:connectionHost]; - } - - // Use the default socket if none is set, or set appropriately - if (connectionSocket == nil || ![connectionSocket length]) { - theSocket = kMCPConnectionDefaultSocket; - } else { - theSocket = [self cStringFromString:connectionSocket]; - } - - // Apply SSL if appropriate - if (useSSL) { - mysql_ssl_set(mConnection, - sslKeyFilePath ? [sslKeyFilePath UTF8String] : NULL, - sslCertificatePath ? [sslCertificatePath UTF8String] : NULL, - sslCACertificatePath ? [sslCACertificatePath UTF8String] : NULL, - NULL, - kMCPSSLCipherList); - } - - // Select the password from the provided method - if (!connectionPassword) { - if (delegate && [delegate respondsToSelector:@selector(keychainPasswordForConnection:)]) { - thePass = [self cStringFromString:[delegate keychainPasswordForConnection:self]]; - } - } else { - thePass = [self cStringFromString:connectionPassword]; - } - - // Connect - theRet = mysql_real_connect(mConnection, theHost, theLogin, thePass, NULL, (unsigned int)connectionPort, theSocket, mConnectionFlags); - thePass = NULL; - - // If the connection failed, record the error state and return - if (theRet != mConnection) { - [self unlockConnection]; - [self setLastErrorMessage:nil]; - - lastQueryErrorId = mysql_errno(mConnection); - - return mConnected = NO; - } - - // Set and reset connection flags - mConnected = YES; - userTriggeredDisconnect = NO; - connectionStartTime = mach_absolute_time(); - lastKeepAliveTime = 0; - automaticReconnectAttempts = 0; - pingFailureCount = 0; - connectionThreadId = mConnection->thread_id; - [self setLastErrorMessage:nil]; - - [self unlockConnection]; - - // Update connection variables - server version, time zone, and connection encoding - [self _updateConnectionVariables]; - - // Only attempt to set the max allowed packet if we have a connection - // The fetches may fail, in which case the class default (which should match - // the MySQL default) will be used. - if (mConnection != NULL) { - isMaxAllowedPacketEditable = [self isMaxAllowedPacketEditable]; - [self fetchMaxAllowedPacket]; - } - else { - mConnected = NO; - isMaxAllowedPacketEditable = NO; - } - - return mConnected; -} - -/** - * Disconnect the current connection. - */ -- (void)disconnect -{ - if (isDisconnecting) return; - isDisconnecting = YES; - - if (mConnected) { - [self cancelCurrentQuery]; - mConnected = NO; - - // Allow any pings or query cleanups to complete - within a time limit. - uint64_t startTime_t, currentTime_t; - Nanoseconds elapsedNanoseconds; - startTime_t = mach_absolute_time(); - do { - usleep(100000); - - currentTime_t = mach_absolute_time() - startTime_t ; - elapsedNanoseconds = AbsoluteToNanoseconds(*(AbsoluteTime *)&(currentTime_t)); - if (((double)UnsignedWideToUInt64(elapsedNanoseconds)) * 1e-9 > 10) break; - } while (![self tryLockConnection]); - [self unlockConnection]; - - // Only close the connection if it appears to still be active, and not reading or - // writing. This may result in a leak, but minimises crashes. - if (!mConnection->net.reading_or_writing && mConnection->net.vio && mConnection->net.buff) mysql_close(mConnection); - mConnection = NULL; - } - - isDisconnecting = NO; - - if (connectionProxy) { - [connectionProxy performSelectorOnMainThread:@selector(disconnect) withObject:nil waitUntilDone:YES]; - } - - if (serverVersionString) [serverVersionString release], serverVersionString = nil; - if (structure) [structure release], structure = nil; - if (allKeysofDbStructure) [allKeysofDbStructure release], allKeysofDbStructure = nil; - if (pingThread != NULL) pthread_cancel(pingThread), pingThread = NULL; -} - -/** - * Reconnect to the currently "active" - but possibly disconnected - connection, using the - * stored details. - * Error checks extensively - if this method fails, it will ask how to proceed and loop depending - * on the status, not returning control until either a connection has been established or - * the connection and document have been closed. - * Runs its own autorelease pool as sometimes called in a thread following proxy changes - * (where the return code doesn't matter). - */ -- (BOOL)reconnect -{ - NSAutoreleasePool *reconnectionPool = [[NSAutoreleasePool alloc] init]; - NSString *currentEncoding = [NSString stringWithString:encoding]; - BOOL currentEncodingUsesLatin1Transport = encodingUsesLatin1Transport; - NSString *currentDatabase = nil; - - // Check whether a reconnection attempt is already being made - if so, wait and return the status of that reconnection attempt. - if (isReconnecting) { - NSDate *eventLoopStartDate; - while (isReconnecting) { - eventLoopStartDate = [NSDate date]; - [[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.1]]; - if ([[NSDate date] timeIntervalSinceDate:eventLoopStartDate] < 0.1) { - usleep((useconds_t)(100000 - (1000000 * [[NSDate date] timeIntervalSinceDate:eventLoopStartDate]))); - } - } - [reconnectionPool drain]; - return mConnected; - } - - isReconnecting = YES; - - // Store the currently selected database so it can be re-set if reconnection was successful - if (delegate && [delegate respondsToSelector:@selector(onReconnectShouldSelectDatabase:)] && [delegate onReconnectShouldSelectDatabase:self]) { - currentDatabase = [NSString stringWithString:[delegate onReconnectShouldSelectDatabase:self]]; - } - - // Close the connection if it exists. - if (mConnected) { - mConnected = NO; - - // Allow any pings or query cleanups to complete - within a time limit. - uint64_t startTime_t, currentTime_t; - Nanoseconds elapsedNanoseconds; - startTime_t = mach_absolute_time(); - do { - usleep(100000); - - currentTime_t = mach_absolute_time() - startTime_t ; - elapsedNanoseconds = AbsoluteToNanoseconds(*(AbsoluteTime *)&(currentTime_t)); - if (((double)UnsignedWideToUInt64(elapsedNanoseconds)) * 1e-9 > 10) break; - } while (![self tryLockConnection]); - [self unlockConnection]; - - // Only close the connection if it's not reading or writing - this may result - // in leaks, but minimises crashes. - if (!mConnection->net.reading_or_writing) mysql_close(mConnection); - mConnection = NULL; - } - - isDisconnecting = NO; - [self lockConnection]; - - // If no network is present, loop for a short period waiting for one to become available - uint64_t elapsedTime_t, networkWaitStartTime_t = mach_absolute_time(); - Nanoseconds elapsedTime; - while (![self _isCurrentHostReachable]) { - elapsedTime_t = mach_absolute_time() - networkWaitStartTime_t; - elapsedTime = AbsoluteToNanoseconds(*(AbsoluteTime *)&(elapsedTime_t)); - if (((double)UnsignedWideToUInt64(elapsedTime)) * 1e-9 > 5) break; - usleep(250000); - } - - // If there is a proxy, ensure it's disconnected and attempt to reconnect it in blocking fashion - if (connectionProxy) { - [connectionProxy setConnectionStateChangeSelector:nil delegate:nil]; - if ([connectionProxy state] != PROXY_STATE_IDLE) [connectionProxy disconnect]; - - // Loop until the proxy has disconnected or the connection timeout has passed - NSDate *proxyDisconnectStartDate = [NSDate date], *eventLoopStartDate; - while ([connectionProxy state] != PROXY_STATE_IDLE - && [[NSDate date] timeIntervalSinceDate:proxyDisconnectStartDate] < connectionTimeout) - { - eventLoopStartDate = [NSDate date]; - [[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.25]]; - if ([[NSDate date] timeIntervalSinceDate:eventLoopStartDate] < 0.25) { - usleep((useconds_t)(250000 - (1000000 * [[NSDate date] timeIntervalSinceDate:eventLoopStartDate]))); - } - } - - // Reconnect the proxy, looping up to the connection timeout - [connectionProxy connect]; - - NSDate *proxyStartDate = [NSDate date], *interfaceInteractionTimer; - while (1) { - - // If the proxy has connected, break out of the loop - if ([connectionProxy state] == PROXY_STATE_CONNECTED) { - connectionPort = [connectionProxy localPort]; - break; - } - - // If the proxy connection attempt time has exceeded the timeout, abort. - if ([[NSDate date] timeIntervalSinceDate:proxyStartDate] > (connectionTimeout + 1)) { - [connectionProxy disconnect]; - break; - } - - // Process events for a short time, allowing dialogs to be shown but waiting for - // the proxy. Capture how long this interface action took, standardising the - // overall time and extending the connection timeout by any interface time. - interfaceInteractionTimer = [NSDate date]; - [[NSRunLoop mainRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.25]]; - //[[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.25]]; - if ([[NSDate date] timeIntervalSinceDate:interfaceInteractionTimer] < 0.25) { - usleep((useconds_t)(250000 - (1000000 * [[NSDate date] timeIntervalSinceDate:interfaceInteractionTimer]))); - } - if ([connectionProxy state] == PROXY_STATE_WAITING_FOR_AUTH) { - proxyStartDate = [proxyStartDate addTimeInterval:[[NSDate date] timeIntervalSinceDate:interfaceInteractionTimer]]; - } - } - - currentProxyState = [connectionProxy state]; - [connectionProxy setConnectionStateChangeSelector:@selector(connectionProxyStateChange:) delegate:self]; - } - - [self unlockConnection]; - if (!connectionProxy || [connectionProxy state] == PROXY_STATE_CONNECTED) { - - // Attempt to reinitialise the connection - if this fails, it will still be set to NULL. - if (mConnection == NULL) { - mConnection = mysql_init(NULL); - } - - if (mConnection != NULL) { - - // Attempt to reestablish the connection - [self connect]; - } - } - - // If the connection was successfully established, reselect the old database and encoding if appropriate. - if (mConnected) { - if (currentDatabase) { - [self selectDB:currentDatabase]; - } - - if (currentEncoding) { - [self setEncoding:currentEncoding]; - [self setEncodingUsesLatin1Transport:currentEncodingUsesLatin1Transport]; - } - } - else { - [self setLastErrorMessage:nil]; - - // Default to retry - MCPConnectionCheck failureDecision = MCPConnectionCheckReconnect; - - // Ask delegate what to do - if (delegateSupportsConnectionLostDecisions) { - failureDecision = [self delegateDecisionForLostConnection]; - } - - switch (failureDecision) { - case MCPConnectionCheckDisconnect: - [self setLastErrorMessage:NSLocalizedString(@"User triggered disconnection", @"User triggered disconnection")]; - userTriggeredDisconnect = YES; - [reconnectionPool release]; - isReconnecting = NO; - return NO; - default: - [reconnectionPool release]; - isReconnecting = NO; - return [self reconnect]; - } - } - - [reconnectionPool release]; - isReconnecting = NO; - return mConnected; -} - -/** - * Returns YES if the MCPConnection is connected to a DB, NO otherwise. - */ -- (BOOL)isConnected -{ - return mConnected; -} - -/** - * Returns YES if the MCPConnection is connected to a server via SSL, NO otherwise. - */ -- (BOOL)isConnectedViaSSL -{ - if (![self isConnected]) return NO; - return (mysql_get_ssl_cipher(mConnection))?YES:NO; -} - -/** - * Returns YES if the user chose to disconnect at the last "connection failure" - * prompt, NO otherwise. - */ -- (BOOL)userTriggeredDisconnect -{ - return userTriggeredDisconnect; -} - -/** - * Checks if the connection to the server is still on. - * If not, tries to reconnect (changing no parameters from the MYSQL pointer). - * This method just uses mysql_ping(). - */ -- (BOOL)checkConnection -{ - if (!mConnected) return NO; - - BOOL connectionVerified = FALSE; - - // If the connection is currently locked, it's probably in use - no need to check - // the connection. - if ([connectionLock condition] == MCPConnectionBusy) { - - // However if a ping thread is active, might be a background ping - wait for it - // to complete, then check the connection. - if (pingThreadActive) { - while (pingThreadActive) { - usleep(10000); - } - return [self checkConnection]; - } - - return YES; - } - - // Check whether the connection is still operational via a wrapped version of MySQL ping. - connectionVerified = [self pingConnectionUsingLoopDelay:400]; - - // If the connection doesn't appear to be responding, and we can still attempt an automatic - // reconnect (only once each connection - eg an automatic reconnect failure prevents loops, - // but an automatic reconnect success resets the flag for another attempt in future) - if (!connectionVerified && automaticReconnectAttempts < 1) { - automaticReconnectAttempts++; - - // Note that a return of "NO" here has already asked the user, so if reconnect fails, - // return failure. - if ([self reconnect]) { - return YES; - } - return NO; - } - - // If automatic reconnect cannot be used, show a dialog asking how to proceed - if (!connectionVerified) { - - // Ask delegate what to do, defaulting to "disconnect". - MCPConnectionCheck failureDecision = MCPConnectionCheckDisconnect; - if (delegateSupportsConnectionLostDecisions) { - failureDecision = [self delegateDecisionForLostConnection]; - } - - switch (failureDecision) { - - // 'Reconnect' has been selected. Request a reconnect, and retry. - case MCPConnectionCheckReconnect: - [self reconnect]; - - return [self checkConnection]; - - // 'Disconnect' has been selected. The parent window should already have - // triggered UI-specific actions, and may have disconnected already; if - // not, disconnect, and clean up. - case MCPConnectionCheckDisconnect: - if (mConnected) [self disconnect]; - [self setLastErrorMessage:NSLocalizedString(@"User triggered disconnection", @"User triggered disconnection")]; - userTriggeredDisconnect = YES; - return NO; - - // 'Retry' has been selected - return a recursive call. - case MCPConnectionCheckRetry: - return [self checkConnection]; - } - - // If a connection exists, check whether the thread id differs; if so, the connection has - // probably been reestablished and we need to reset the connection encoding - } else if (connectionThreadId != mConnection->thread_id) [self restoreConnectionDetails]; - - return connectionVerified; -} - -/** - * Restore the connection encoding details as necessary based on the delegate-provided - * details. - */ -- (void)restoreConnectionDetails -{ - connectionThreadId = mConnection->thread_id; - connectionStartTime = mach_absolute_time(); - [self fetchMaxAllowedPacket]; - - [self setEncoding:encoding]; - [self setEncodingUsesLatin1Transport:encodingUsesLatin1Transport]; -} - -/** - * Allow controlling over whether queries are allowed to retry after a connection failure. - * This defaults to YES on init, and is intended to allow temporary disabling in situations - * where the query result is checked and displayed to the user without any repurcussions on - * failure. - */ -- (void)setAllowQueryRetries:(BOOL)allow -{ - retryAllowed = allow; -} - -/** - * Retrieve the time elapsed since the connection was established, in seconds. - * This time is retrieved in a monotonically increasing fashion and is high - * precision; it is used internally for query timing, and is reset on reconnections. - */ -- (double)timeConnected -{ - if (connectionStartTime == 0) return -1; - - uint64_t currentTime_t = mach_absolute_time() - connectionStartTime; - Nanoseconds elapsedTime = AbsoluteToNanoseconds(*(AbsoluteTime *)&(currentTime_t)); - - return (((double)UnsignedWideToUInt64(elapsedTime)) * 1e-9); -} - -#pragma mark - -#pragma mark Pinging and keepalive - -/** - * This function provides a method of pinging the remote server while also enforcing - * the specified connection time. This is required because low-level net reads can - * block indefinitely if the remote server disappears or on network issues - setting - * the MYSQL_OPT_READ_TIMEOUT (and the WRITE equivalent) would "fix" ping, but cause - * long queries to be terminated. - * The supplied loop delay number controls how tight the thread checking loop is, in - * microseconds, to allow differentiating foreground and background pings. - * Unlike mysql_ping, this function returns FALSE on failure and TRUE on success. - */ -- (BOOL)pingConnectionUsingLoopDelay:(NSUInteger)loopDelay -{ - if (!mConnected) return NO; - - uint64_t pingStartTime_t, currentTime_t; - Nanoseconds elapsedNanoseconds; - BOOL threadCancelled = NO; - - // Set up a query lock - [self lockConnection]; - - lastPingSuccess = NO; - lastPingBlocked = NO; - pingThreadActive = YES; - - // Use a ping timeout defaulting to thirty seconds, but using the connection timeout if set - NSInteger pingTimeout = 30; - if (connectionTimeout > 0) pingTimeout = connectionTimeout; - - // Set up a struct containing details the ping task will need - MCPConnectionPingDetails pingDetails; - pingDetails.mySQLConnection = mConnection; - pingDetails.lastPingSuccessPointer = &lastPingSuccess; - pingDetails.pingActivePointer = &pingThreadActive; - - // Create a pthread for the ping - pthread_attr_t attr; - pthread_attr_init(&attr); - pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED); - pthread_create(&pingThread, &attr, (void *)&backgroundPingTask, &pingDetails); - - // Record the ping start time - pingStartTime_t = mach_absolute_time(); - - // Loop until the ping completes - do { - usleep((useconds_t)loopDelay); - - // If the ping timeout has been exceeded, force a timeout; double-check that the - // thread is still active. - currentTime_t = mach_absolute_time() - pingStartTime_t ; - elapsedNanoseconds = AbsoluteToNanoseconds(*(AbsoluteTime *)&(currentTime_t)); - if (((double)UnsignedWideToUInt64(elapsedNanoseconds)) * 1e-9 > pingTimeout && pingThreadActive && !threadCancelled) { - pthread_cancel(pingThread); - threadCancelled = YES; - - // If the timeout has been exceeded by an additional two seconds, and the thread is - // still active, kill the thread. This can occur in certain network conditions causing - // a blocking read. - } else if (((double)UnsignedWideToUInt64(elapsedNanoseconds)) * 1e-9 > (pingTimeout + 2) && pingThreadActive) { - pthread_kill(pingThread, SIGUSR1); - pingThreadActive = NO; - lastPingBlocked = YES; - } - } while (pingThreadActive); - - // Clean up - pingThread = NULL; - pthread_attr_destroy(&attr); - - // Unlock the connection - [self unlockConnection]; - - return lastPingSuccess; -} - -/** - * Actually perform a keepalive ping - intended for use within a pthread. - */ -void backgroundPingTask(void *ptr) -{ - MCPConnectionPingDetails *pingDetails = (MCPConnectionPingDetails *)ptr; - - // Set up a cleanup routine - pthread_cleanup_push(pingThreadCleanup, pingDetails); - - // Set up a signal handler for SIGUSR1, to handle forced timeouts. - signal(SIGUSR1, forceThreadExit); - - // Perform a ping - *(pingDetails->lastPingSuccessPointer) = (BOOL)(!mysql_ping(pingDetails->mySQLConnection)); - - // Call the cleanup routine - pthread_cleanup_pop(1); -} - -/** - * Support forcing a thread to exit as a result of a signal. - */ -void forceThreadExit(int signalNumber) -{ - pthread_exit(NULL); -} - -void pingThreadCleanup(void *pingDetails) -{ - MCPConnectionPingDetails *pingDetailsStruct = pingDetails; - *(pingDetailsStruct->pingActivePointer) = NO; -} - -/** - * Keeps a connection alive by running a ping. - * This method is called every ten seconds and spawns a thread which determines - * whether or not it should perform a ping. - */ -- (void)keepAlive:(NSTimer *)theTimer -{ - - // Do nothing if not connected or if keepalive is disabled - if (!mConnected || !useKeepAlive) return; - - // Check to see whether a ping is required. First, compare the last query - // and keepalive times against the keepalive interval. - // Compare against interval-1 to allow default keepalive intervals to repeat - // at the correct intervals (eg no timer interval delay). - double timeConnected = [self timeConnected]; - if (timeConnected - lastQueryExecutedAtTime < keepAliveInterval - 1 - || timeConnected - lastKeepAliveTime < keepAliveInterval - 1) - { - return; - } - - // Attempt to lock the connection. If the connection is currently busy, - // we don't need a ping. - if (![self tryLockConnection]) return; - [self unlockConnection]; - - // Store the ping time - lastKeepAliveTime = timeConnected; - - [NSThread detachNewThreadSelector:@selector(threadedKeepAlive) toTarget:self withObject:nil]; -} - -/** - * A threaded keepalive to avoid blocking the interface. Performs safety - * checks, and then creates a child pthread to actually ping the connection, - * forcing the thread to close after the timeout if it hasn't closed already. - */ -- (void)threadedKeepAlive -{ - - // If the maximum number of ping failures has been reached, trigger a reconnect - if (lastPingBlocked || pingFailureCount >= 3) { - NSAutoreleasePool *connectionPool = [[NSAutoreleasePool alloc] init]; - [self reconnect]; - [connectionPool drain]; - return; - } - - // Otherwise, perform a background ping. - BOOL pingResult = [self pingConnectionUsingLoopDelay:10000]; - if (pingResult) { - pingFailureCount = 0; - } else { - pingFailureCount++; - } -} - -#pragma mark - -#pragma mark Server versions - -/** - * Return the server version string, or nil on failure. - */ -- (NSString *)serverVersionString -{ - if (serverVersionString) { - return [NSString stringWithString:serverVersionString]; - } - - return nil; -} - -/** - * rReturn the server major version or -1 on fail - */ -- (NSInteger)serverMajorVersion -{ - - if (serverVersionString != nil) { - return [[[serverVersionString componentsSeparatedByString:@"."] objectAtIndex:0] integerValue]; - } - - return -1; -} - -/** - * Return the server minor version or -1 on fail - */ -- (NSInteger)serverMinorVersion -{ - if (serverVersionString != nil) { - return [[[serverVersionString componentsSeparatedByString:@"."] objectAtIndex:1] integerValue]; - } - - return -1; -} - -/** - * Return the server release version or -1 on fail - */ -- (NSInteger)serverReleaseVersion -{ - if (serverVersionString != nil) { - NSString *s = [[serverVersionString componentsSeparatedByString:@"."] objectAtIndex:2]; - return [[[s componentsSeparatedByString:@"-"] objectAtIndex:0] integerValue]; - } - - return -1; -} - -#pragma mark - -#pragma mark MySQL defaults - -/** - * This class is used to keep a connection with a MySQL server, it correspond to the MYSQL structure of the C API, or the database handle of the PERL DBI/DBD interface. - * - * You have to start any work on a MySQL server by getting a working MCPConnection object. - * - * Most likely you will use this kind of code: - * - * - * MCPConnection *theConnec = [MCPConnection alloc]; - * MCPResult *theRes; - * - * theConnec = [theConnec initToHost:@"albert.com" withLogin:@"toto" password:@"albert" usingPort:0]; - * [theConnec selectDB:@"db1"]; - * theRes = [theConnec queryString:@"select * from table1"]; - * ... - * - * Failing to properly release your MCPConnection(s) object might cause a MySQL crash!!! (recovered if the server was started using mysqld_safe). - * - * Gets a proper Locale dictionary to use formater to parse strings from MySQL. - * For example strings representing dates should give a proper Locales for use with methods such as NSDate::dateWithNaturalLanguageString: locales: - */ -+ (NSDictionary *)getMySQLLocales -{ - NSMutableDictionary *theLocalDict = [NSMutableDictionary dictionaryWithCapacity:12]; - - [theLocalDict setObject:@"." forKey:@"NSDecimalSeparator"]; - - return [NSDictionary dictionaryWithDictionary:theLocalDict]; -} - -/** - * Gets a proper NSStringEncoding according to the given MySQL charset. - */ -+ (NSStringEncoding) encodingForMySQLEncoding:(const char *)mysqlEncoding -{ - // Unicode encodings: - if (!strncmp(mysqlEncoding, "utf8", 4)) { - return NSUTF8StringEncoding; - } - if (!strncmp(mysqlEncoding, "ucs2", 4)) { - return NSUnicodeStringEncoding; - } - - // Roman alphabet encodings: - if (!strncmp(mysqlEncoding, "ascii", 5)) { - return NSASCIIStringEncoding; - } - if (!strncmp(mysqlEncoding, "latin1", 6)) { - return NSISOLatin1StringEncoding; - } - if (!strncmp(mysqlEncoding, "macroman", 8)) { - return NSMacOSRomanStringEncoding; - } - - // Roman alphabet with central/east european additions: - if (!strncmp(mysqlEncoding, "latin2", 6)) { - return NSISOLatin2StringEncoding; - } - if (!strncmp(mysqlEncoding, "cp1250", 6)) { - return NSWindowsCP1250StringEncoding; - } - if (!strncmp(mysqlEncoding, "win1250", 7)) { - return NSWindowsCP1250StringEncoding; - } - if (!strncmp(mysqlEncoding, "cp1257", 6)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingWindowsBalticRim); - } - - // Additions for Turkish: - if (!strncmp(mysqlEncoding, "latin5", 6)) { - return NSWindowsCP1254StringEncoding; - } - - // Greek: - if (!strncmp(mysqlEncoding, "greek", 5)) { - return NSWindowsCP1253StringEncoding; - } - - // Cyrillic: - if (!strncmp(mysqlEncoding, "win1251ukr", 6)) { - return NSWindowsCP1251StringEncoding; - } - if (!strncmp(mysqlEncoding, "cp1251", 6)) { - return NSWindowsCP1251StringEncoding; - } - if (!strncmp(mysqlEncoding, "koi8_ru", 6)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingKOI8_R); - } - if (!strncmp(mysqlEncoding, "koi8_ukr", 6)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingKOI8_R); - } - - // Arabic: - if (!strncmp(mysqlEncoding, "cp1256", 6)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingWindowsArabic); - } - - // Hebrew: - if (!strncmp(mysqlEncoding, "hebrew", 6)) { - CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingISOLatinHebrew); - } - - // Asian: - if (!strncmp(mysqlEncoding, "ujis", 4)) { - return NSJapaneseEUCStringEncoding; - } - if (!strncmp(mysqlEncoding, "sjis", 4)) { - return NSShiftJISStringEncoding; - } - if (!strncmp(mysqlEncoding, "big5", 4)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingBig5); - } - if (!strncmp(mysqlEncoding, "euc_kr", 6)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingEUC_KR); - } - if (!strncmp(mysqlEncoding, "euckr", 5)) { - return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingEUC_KR); - } - - // Default to iso latin 1, even if it is not exact (throw an exception?) - NSLog(@"WARNING: unknown name for MySQL encoding '%s'!\n\t\tFalling back to iso-latin1.", mysqlEncoding); - - return NSISOLatin1StringEncoding; -} - -/** - * Gets a MySQL charset for the given NSStringEncoding. - * If the NSStringEncoding was not matched, nil is returned. - */ -+ (NSString *) mySQLEncodingForStringEncoding:(NSStringEncoding)stringEncoding -{ - switch (stringEncoding) { - - // Unicode encodings: - case NSUTF8StringEncoding: - return @"utf8"; - case NSUnicodeStringEncoding: - return @"ucs2"; - - // Roman alphabet encodings: - case NSASCIIStringEncoding: - return @"ascii"; - case NSISOLatin1StringEncoding: - case NSWindowsCP1252StringEncoding: - return @"latin1"; - case NSMacOSRomanStringEncoding: - return @"macroman"; - - // Roman alphabet with central/east european additions: - case NSISOLatin2StringEncoding: - return @"latin2"; - case NSWindowsCP1250StringEncoding: - return @"cp1250"; - - // Turkish - case NSWindowsCP1254StringEncoding: - return @"latin5"; - - // Greek: - case NSWindowsCP1253StringEncoding: - return @"greek"; - - // Cyrillic: - case NSWindowsCP1251StringEncoding: - return @"cp1251"; - - // Asian: - case NSJapaneseEUCStringEncoding: - return @"ujis"; - case NSShiftJISStringEncoding: - return @"sjis"; - - default: - return nil; - } -} - -/** - * Returns the default charset of the library mysqlclient used. - */ -+ (NSStringEncoding)defaultMySQLEncoding -{ - return [MCPConnection encodingForMySQLEncoding:"utf8_general_ci"]; -} - -#pragma mark - -#pragma mark Class maintenance - -/** - * - */ -+ (void)setTruncateLongFieldInLogs:(BOOL)iTruncFlag -{ - sTruncateLongFieldInLogs = iTruncFlag; -} - -/** - * - */ -+ (BOOL)truncateLongField -{ - return sTruncateLongFieldInLogs; -} - -/** - * This method is to be used for getting special option for a connection, in which case the MCPConnection - * has to be inited with the init method, then option are selected, finally connection is done using one - * of the connect methods: - * - * MCPConnection *theConnect = [[MCPConnection alloc] init]; - * - * [theConnect setConnectionOption: option toValue: value]; - * [theConnect connectToHost:albert.com withLogin:@"toto" password:@"albert" port:0]; - * - */ -- (BOOL)setConnectionOption:(NSInteger)option toValue:(BOOL)value -{ - // So far do nothing except for testing if it's proper time for setting option - // What about if some option where setted and a connection is made again with connectTo... - if ((mConnected) || (! mConnection)) { - return FALSE; - } - - if (value) { //Set this option to true - mConnectionFlags |= option; - } - else { //Set this option to false - mConnectionFlags &= (! option); - } - - return YES; -} - -/** - * Trigger a connection to a server using the supplied details. Any details supplied are - * stored for automatic reconnection attempts. - * - * - login is the user name - * - pass is the password corresponding to the user name - * - host is the hostname or IP adress - * - port is the TCP port to use to connect. If port = 0, uses the default port from mysql.h - * - socket is the path to the socket (for the localhost) - * - * The socket is used if the host is set to !{@"localhost"}, to an empty or a !{nil} string - */ -- (BOOL)connectWithLogin:(NSString *)login password:(NSString *)pass host:(NSString *)host port:(NSUInteger)port socket:(NSString *)aSocket -{ - - // Reset any stored connection settings - if (connectionHost) [connectionHost release], connectionHost = nil; - if (connectionLogin) [connectionLogin release], connectionLogin = nil; - if (connectionPassword) [connectionPassword release], connectionPassword = nil; - if (connectionSocket) [connectionSocket release], connectionSocket = nil; - - // Determine whether a socket connection should be made - if (!host || ![host length] || [host isEqualToString:@"localhost"]) { - if (!aSocket || ![aSocket length]) { - aSocket = [self findSocketPath]; - if (!aSocket) aSocket = @""; - } - connectionSocket = [[NSString alloc] initWithString:aSocket]; - connectionPort = 0; - - // Otherwise, use host and port details - } else { - connectionHost = [[NSString alloc] initWithString:host]; - connectionPort = port; - } - - // Store the username - connectionLogin = [[NSString alloc] initWithString:(login?login:@"")]; - - // Store the password if supplied. It is more secure to allow MCPConnection to ask the - // delegate to retrieve details - see delegate method keychainPasswordForConnection:) - if (pass) connectionPassword = [[NSString alloc] initWithString:pass]; - - // Trigger a connection and return the resulting status - return [self connect]; -} - -/** - * Selects a database to work with. - * - * The MCPConnection object needs to be properly inited and connected to a server. - * If a connection is not yet set or the selection of the database didn't work, returns NO. Returns YES in normal cases where the database is properly selected. - * - * So far, if dbName is a nil pointer it will return NO (as if it cannot connect), most likely this will throw an exception in the future. - */ -- (BOOL)selectDB:(NSString *) dbName -{ - if (!mConnected) return NO; - - if (![self checkConnection]) return NO; - - // Here we should throw an exception, impossible to select a databse if the string is indeed a nil pointer - if (dbName == nil) return NO; - - if (mConnected) { - - // Ensure the change is made in UTF8 to avoid encoding problems - BOOL changeEncoding = ![[self encoding] isEqualToString:@"utf8"]; - if (changeEncoding) { - [self storeEncodingForRestoration]; - [self setEncoding:@"utf8"]; - } - - const char *theDBName = [self cStringFromString:dbName]; - [self lockConnection]; - if (0 == mysql_select_db(mConnection, theDBName)) { - [self unlockConnection]; - return YES; - } - [self unlockConnection]; - - if (changeEncoding) [self restoreStoredEncoding]; - } - - [self setLastErrorMessage:nil]; - - lastQueryErrorId = mysql_errno(mConnection); - - if (connectionProxy) { - [connectionProxy disconnect]; - } - - return NO; -} - -#pragma mark - -#pragma mark Error information - -/** - * Returns whether the last query errored or not. - */ -- (BOOL)queryErrored -{ - return (lastQueryErrorMessage)?YES:NO; -} - -/** - * Returns a string with the last MySQL error message on the connection. - */ -- (NSString *)getLastErrorMessage -{ - return lastQueryErrorMessage; -} - -/** - * Sets the string for the last MySQL error message on the connection, - * managing memory as appropriate. Supply a nil string to store the - * last error on the connection. - */ -- (void)setLastErrorMessage:(NSString *)theErrorMessage -{ - if (!theErrorMessage) theErrorMessage = [self stringWithCString:mysql_error(mConnection)]; - - if (lastQueryErrorMessage) [lastQueryErrorMessage release], lastQueryErrorMessage = nil; - if (theErrorMessage && [theErrorMessage length]) lastQueryErrorMessage = [[NSString alloc] initWithString:theErrorMessage]; -} - -/** - * Returns the ErrorID of the last MySQL error on the connection. - */ -- (NSUInteger)getLastErrorID -{ - return lastQueryErrorId; -} - -/** - * Determines whether a supplied error number can be classed as a connection error. - */ -+ (BOOL)isErrorNumberConnectionError:(NSInteger)theErrorNumber -{ - switch (theErrorNumber) { - case 2001: // CR_SOCKET_CREATE_ERROR - case 2002: // CR_CONNECTION_ERROR - case 2003: // CR_CONN_HOST_ERROR - case 2004: // CR_IPSOCK_ERROR - case 2005: // CR_UNKNOWN_HOST - case 2006: // CR_SERVER_GONE_ERROR - case 2007: // CR_VERSION_ERROR - case 2009: // CR_WRONG_HOST_INFO - case 2012: // CR_SERVER_HANDSHAKE_ERR - case 2013: // CR_SERVER_LOST - case 2027: // CR_MALFORMED_PACKET - case 2032: // CR_DATA_TRUNCATED - case 2047: // CR_CONN_UNKNOW_PROTOCOL - case 2048: // CR_INVALID_CONN_HANDLE - case 2050: // CR_FETCH_CANCELED - case 2055: // CR_SERVER_LOST_EXTENDED - return YES; - } - - return NO; -} - -/** - * Update error messages - for example after a streaming result has finished processing. - */ -- (void)updateErrorStatuses -{ - [self setLastErrorMessage:nil]; - lastQueryErrorId = mysql_errno(mConnection); -} - -#pragma mark - -#pragma mark Queries - -/** - * Takes a NSData object and transform it in a proper string for sending to the server in between quotes. - */ -- (NSString *)prepareBinaryData:(NSData *)theData -{ - const char *theCDataBuffer = [theData bytes]; - unsigned long theLength = [theData length]; - char *theCEscBuffer = (char *)calloc(sizeof(char),(theLength*2) + 1); - NSString *theReturn; - - // mysql_hex_string requires an active connection. - // If no connection is present, and no automatic reconnections can be made, return nil. - if (!mConnected && ![self checkConnection]) { - - // Inform the delegate that there is no connection available - if (delegate && [delegate respondsToSelector:@selector(noConnectionAvailable:)]) { - [delegate noConnectionAvailable:self]; - } - - return nil; - } - - // If thirty seconds have elapsed since the last query, check the connection. - // This minimises the impact of continuous additional connection checks, but handles - // most network issues and keeps high read/write timeouts for long queries. - if ([self timeConnected] - lastQueryExecutedAtTime > 30) { - if (![self checkConnection]) return nil; - lastQueryExecutedAtTime = [self timeConnected]; - } - - // Using the mysql_hex_string function : (NO other solution found to be able to support blobs while using UTF-8 charset). - mysql_hex_string(theCEscBuffer, theCDataBuffer, theLength); - theReturn = [NSString stringWithFormat:@"%s", theCEscBuffer]; - free (theCEscBuffer); - return theReturn; -} - -/** - * Takes a string and escape any special character (like single quote : ') so that the string can be used directly in a query. - */ -- (NSString *)prepareString:(NSString *)theString -{ - NSData *theCData = [theString dataUsingEncoding:stringEncoding allowLossyConversion:YES]; - unsigned long theLength = [theCData length]; - char *theCEscBuffer; - NSString *theReturn; - unsigned long theEscapedLength; - - if (theString == nil) { - // In the mean time, no one should call this method on a nil string, the test should be done before by the user of this method. - return @""; - } - - // mysql_real_escape_string requires an active connection. - // If no connection is present, and no automatic reconnections can be made, return nil. - if (!mConnected && ![self checkConnection]) { - - // Inform the delegate that there is no connection available - if (delegate && [delegate respondsToSelector:@selector(noConnectionAvailable:)]) { - [delegate noConnectionAvailable:self]; - } - - return nil; - } - - // If thirty seconds have elapsed since the last query, check the connection. - // This minimises the impact of continuous additional connection checks, but handles - // most network issues and keeps high read/write timeouts for long queries. - if ([self timeConnected] - lastQueryExecutedAtTime > 30) { - if (![self checkConnection]) return nil; - lastQueryExecutedAtTime = [self timeConnected]; - } - - theCEscBuffer = (char *)calloc(sizeof(char),(theLength * 2) + 1); - theEscapedLength = mysql_real_escape_string(mConnection, theCEscBuffer, [theCData bytes], theLength); - theReturn = [[NSString alloc] initWithData:[NSData dataWithBytes:theCEscBuffer length:theEscapedLength] encoding:stringEncoding]; - free(theCEscBuffer); - - return [theReturn autorelease]; -} - -/** - * Use the class of the theObject to know how it should be prepared for usage with the database. - * If theObject is a string, this method will put single quotes to both its side and escape any necessary - * character using prepareString: method. If theObject is NSData, the prepareBinaryData: method will be - * used instead. - * - * For NSNumber object, the number is just quoted, for calendar dates, the calendar date is formatted in - * the preferred format for the database. - */ -- (NSString *)quoteObject:(id)theObject -{ - if ((! theObject) || ([theObject isNSNull])) { - return @"NULL"; - } - - if ([theObject isKindOfClass:[NSData class]]) { - return [NSString stringWithFormat:@"X'%@'", [self prepareBinaryData:(NSData *) theObject]]; - } - - if ([theObject isKindOfClass:[NSString class]]) { - return [NSString stringWithFormat:@"'%@'", [self prepareString:(NSString *) theObject]]; - } - - if ([theObject isKindOfClass:[NSNumber class]]) { - return [NSString stringWithFormat:@"%@", theObject]; - } - - if ([theObject isKindOfClass:[NSCalendarDate class]]) { - return [NSString stringWithFormat:@"'%@'", [(NSCalendarDate *)theObject descriptionWithCalendarFormat:@"%Y-%m-%d %H:%M:%S"]]; - } - - return [NSString stringWithFormat:@"'%@'", [self prepareString:[theObject description]]]; -} - -/** - * Takes a query string and return an MCPResult object holding the result of the query. - * The returned MCPResult is not retained, the client is responsible for that (it's autoreleased before being returned). If no field are present in the result (like in an insert query), will return nil (#{difference from previous version implementation}). Though, if their is at least one field the result will be non nil (even if no row are selected). - * - * Note that if you want to use this method with binary data (in the query), you should use !{prepareBinaryData:} to include the binary data in the query string. Also if you want to include in your query a string containing any special character (\, ', " ...) then you should use !{prepareString}. - */ -- (MCPResult *)queryString:(NSString *)query -{ - return [self queryString:query usingEncoding:stringEncoding streamingResult:MCPStreamingNone]; -} - -/** - * Takes a query string and returns an MCPStreamingResult representing the result of the query. - * If no fields are present in the result, nil will be returned. - * Uses safe/fast mode, which may use more memory as results are downloaded. - */ -- (MCPStreamingResult *)streamingQueryString:(NSString *)query -{ - return [self queryString:query usingEncoding:stringEncoding streamingResult:MCPStreamingFast]; -} - -/** - * Takes a query string and returns an MCPStreamingResult representing the result of the query. - * If no fields are present in the result, nil will be returned. - * Can be used in either fast/safe mode, where data is downloaded as fast as possible to avoid - * blocking the server, or in full streaming mode for lowest memory usage but potentially blocking - * the table. - */ -- (MCPStreamingResult *)streamingQueryString:(NSString *)query useLowMemoryBlockingStreaming:(BOOL)fullStream -{ - return [self queryString:query usingEncoding:stringEncoding streamingResult:(fullStream?MCPStreamingLowMem:MCPStreamingFast)]; -} - -/** - * Error checks connection extensively - if this method fails due to a connection error, it will ask how to - * proceed and loop depending on the status, not returning control until either the query has been executed - * and the result can be returned or the connection and document have been closed. - */ -- (id)queryString:(NSString *) query usingEncoding:(NSStringEncoding)aStringEncoding streamingResult:(NSInteger) streamResultType -{ - MCPResult *theResult = nil; - double queryStartTime, queryExecutionTime; - const char *theCQuery; - unsigned long theCQueryLength; - NSInteger queryResultCode; - NSInteger queryErrorId = 0; - my_ulonglong queryAffectedRows = 0; - NSInteger currentMaxAllowedPacket = -1; - BOOL isQueryRetry = NO; - NSString *queryErrorMessage = nil; - - // Reset the query cancelled boolean - queryCancelled = NO; - - // If no connection is present, and no automatic reconnections can be made, return nil. - if (!mConnected && ![self checkConnection]) { - // Write a log entry - if ([delegate respondsToSelector:@selector(queryGaveError:connection:)]) [delegate queryGaveError:@"No connection available!" connection:self]; - - // Notify that the query has been performed - [[NSNotificationCenter defaultCenter] postNotificationOnMainThreadWithName:@"SMySQLQueryHasBeenPerformed" object:delegate]; - - // Inform the delegate that there is no connection available - if (delegate && [delegate respondsToSelector:@selector(noConnectionAvailable:)]) { - [delegate noConnectionAvailable:self]; - } - - return nil; - } - - // Inform the delegate about the query if logging is enabled and delegate responds to willQueryString:connection: - if (delegateQueryLogging && delegateResponseToWillQueryString) { - [delegate willQueryString:query connection:self]; - } - - // If thirty seconds have elapsed since the last query, check the connection. - // This minimises the impact of continuous additional connection checks, but handles - // most network issues and keeps high read/write timeouts for long queries. - if ([self timeConnected] - lastQueryExecutedAtTime > 30 - && ![self checkConnection]) - { - return nil; - } - - // Derive the query string in the correct encoding - NSData *d = NSStringDataUsingLossyEncoding(query, aStringEncoding, 1); - theCQuery = [d bytes]; - // Set the length of the current query - theCQueryLength = [d length]; - - // Check query length against max_allowed_packet; if it is larger, the - // query would error, so if max_allowed_packet is editable for the user - // increase it for the current session and reconnect. - if (maxAllowedPacketSize < theCQueryLength) { - - if (isMaxAllowedPacketEditable) { - - currentMaxAllowedPacket = maxAllowedPacketSize; - [self setMaxAllowedPacketTo:strlen(theCQuery)+1024 resetSize:NO]; - [self reconnect]; - - } - else { - NSString *errorMessage = [NSString stringWithFormat:NSLocalizedString(@"The query length of %lu bytes is larger than max_allowed_packet size (%lu).", - @"error message if max_allowed_packet < query size"), - (unsigned long)theCQueryLength, maxAllowedPacketSize]; - - // Write a log entry and update the connection error messages for those uses that check it - if ([delegate respondsToSelector:@selector(queryGaveError:connection:)]) [delegate queryGaveError:errorMessage connection:self]; - [self setLastErrorMessage:errorMessage]; - - // Notify that the query has been performed - [[NSNotificationCenter defaultCenter] postNotificationOnMainThreadWithName:@"SMySQLQueryHasBeenPerformed" object:delegate]; - - // Show an error alert while resetting - if ([delegate respondsToSelector:@selector(showErrorWithTitle:message:)]) - [delegate showErrorWithTitle:NSLocalizedString(@"Error", @"error") message:errorMessage]; - else - NSRunAlertPanel(NSLocalizedString(@"Error", @"error"), errorMessage, @"OK", nil, nil); - - return nil; - } - } - - // In a loop to allow one reattempt, perform the query. - while (1) { - - // If this query has failed once already, check the connection - if (isQueryRetry) { - if (![self checkConnection]) { - if (queryErrorMessage) [queryErrorMessage release], queryErrorMessage = nil; - - // Notify that the query has been performed - [[NSNotificationCenter defaultCenter] postNotificationOnMainThreadWithName:@"SMySQLQueryHasBeenPerformed" object:delegate]; - return nil; - } - } - - [self lockConnection]; - - // Run (or re-run) the query, timing the execution time of the query - note - // that this time will include network lag. - queryStartTime = [self timeConnected]; - queryResultCode = mysql_real_query(mConnection, theCQuery, theCQueryLength); - lastQueryExecutedAtTime = [self timeConnected]; - queryExecutionTime = lastQueryExecutedAtTime - queryStartTime; - - // On success, capture the results - if (0 == queryResultCode) { - - queryAffectedRows = mysql_affected_rows(mConnection); - - if (mysql_field_count(mConnection) != 0) { - - // For normal result sets, fetch the results and unlock the connection - if (streamResultType == MCPStreamingNone) { - theResult = [[MCPResult alloc] initWithMySQLPtr:mConnection encoding:stringEncoding timeZone:mTimeZone]; - if (!queryCancelled || !queryCancelUsedReconnect) { - [self unlockConnection]; - } - - // For streaming result sets, fetch the result pointer and leave the connection locked - } else if (streamResultType == MCPStreamingFast) { - theResult = [[MCPStreamingResult alloc] initWithMySQLPtr:mConnection encoding:stringEncoding timeZone:mTimeZone connection:self withFullStreaming:NO]; - } else if (streamResultType == MCPStreamingLowMem) { - theResult = [[MCPStreamingResult alloc] initWithMySQLPtr:mConnection encoding:stringEncoding timeZone:mTimeZone connection:self withFullStreaming:YES]; - } - - // Ensure no problem occurred during the result fetch - if (mysql_errno(mConnection) != 0) { - queryErrorMessage = [self stringWithCString:mysql_error(mConnection)]; - if (queryErrorMessage) [queryErrorMessage retain]; - queryErrorId = mysql_errno(mConnection); - break; - } - } else { - [self unlockConnection]; - } - - queryErrorMessage = [[NSString alloc] initWithString:@""]; - queryErrorId = 0; - if (streamResultType == MCPStreamingNone && queryAffectedRows == (my_ulonglong)~0) { - queryAffectedRows = mysql_affected_rows(mConnection); - } - - // On failure, set the error messages and IDs - } else { - if (!queryCancelled || !queryCancelUsedReconnect) { - [self unlockConnection]; - } - - if (queryCancelled) { - if (queryErrorMessage) [queryErrorMessage release], queryErrorMessage = nil; - queryErrorMessage = [[NSString alloc] initWithString:NSLocalizedString(@"Query cancelled.", @"Query cancelled error")]; - queryErrorId = 1317; - } else { - if (queryErrorMessage) [queryErrorMessage release], queryErrorMessage = nil; - queryErrorMessage = [self stringWithCString:mysql_error(mConnection)]; - if (queryErrorMessage) [queryErrorMessage retain]; - queryErrorId = mysql_errno(mConnection); - - // If the error was a connection error, retry once - if (!isQueryRetry && retryAllowed && [MCPConnection isErrorNumberConnectionError:queryErrorId]) { - isQueryRetry = YES; - continue; - } - } - } - - break; - } - - if (streamResultType == MCPStreamingNone) { - - // If the mysql thread id has changed as a result of a connection error, - // ensure connection details are still correct - if (connectionThreadId != mConnection->thread_id) [self restoreConnectionDetails]; - - // If max_allowed_packet was changed, reset it to default - if(currentMaxAllowedPacket > -1) - [self setMaxAllowedPacketTo:currentMaxAllowedPacket resetSize:YES]; - } - - // Update error strings and IDs - lastQueryErrorId = queryErrorId; - - if (queryErrorMessage) { - [self setLastErrorMessage:queryErrorMessage]; - - [queryErrorMessage release]; - } - - lastQueryAffectedRows = queryAffectedRows; - lastQueryExecutionTime = queryExecutionTime; - - // If an error occurred, inform the delegate - if (queryResultCode & delegateResponseToWillQueryString) - [delegate queryGaveError:lastQueryErrorMessage connection:self]; - - if (!theResult) return nil; - return [theResult autorelease]; -} - -/** - * Returns the number of affected rows by the last query. Only actual queries - * supplied via queryString:, streamingQueryString:, streamingQueryString:useLowMemoryBlockingStreaming: - * or queryString:usingEncoding:streamingResult: will have their affected rows - * returned, not any "meta" type queries. - */ -- (my_ulonglong)affectedRows -{ - if (mConnected) return lastQueryAffectedRows; - - return 0; -} - -/** - * If the last query was an insert in a table having a autoindex column, returns the ID - * (autoindexed field) of the last row inserted. - */ -- (my_ulonglong)insertId -{ - if (mConnected) { - return mysql_insert_id(mConnection); - } - - return 0; -} - -/** - * Cancel the currently running query. This tries to kill the current query, and if that - * isn't possible, resets the connection. - */ -- (void) cancelCurrentQuery -{ - - // If not connected, return. - if (![self isConnected]) return; - - // Check whether a query is actually being performed - if not, also return. - if ([self tryLockConnection]) { - [self unlockConnection]; - return; - } - - // Set queryCancelled to prevent query retries - queryCancelled = YES; - - // Set up a new connection, and running a KILL QUERY via it. - MYSQL *killerConnection = mysql_init(NULL); - if (killerConnection) { - const char *theLogin = [self cStringFromString:connectionLogin]; - const char *theHost; - const char *thePass = NULL; - const char *theSocket; - void *connectionSetupStatus; - - mysql_options(killerConnection, MYSQL_OPT_CONNECT_TIMEOUT, (const void *)&connectionTimeout); - mysql_options(killerConnection, MYSQL_SET_CHARSET_NAME, "utf8"); - - // Set up the host, socket and password as per the connect method - if (!connectionHost || ![connectionHost length]) { - theHost = NULL; - } else { - theHost = [connectionHost UTF8String]; - } - if (connectionSocket == nil || ![connectionSocket length]) { - theSocket = kMCPConnectionDefaultSocket; - } else { - theSocket = [connectionSocket UTF8String]; - } - if (!connectionPassword) { - if (delegate && [delegate respondsToSelector:@selector(keychainPasswordForConnection:)]) { - thePass = [[delegate keychainPasswordForConnection:self] UTF8String]; - } - } else { - thePass = [connectionPassword UTF8String]; - } - if (useSSL) { - mysql_ssl_set(mConnection, - sslKeyFilePath ? [sslKeyFilePath UTF8String] : NULL, - sslCertificatePath ? [sslCertificatePath UTF8String] : NULL, - sslCACertificatePath ? [sslCACertificatePath UTF8String] : NULL, - NULL, - kMCPSSLCipherList); - } - - // Connect - connectionSetupStatus = mysql_real_connect(killerConnection, theHost, theLogin, thePass, NULL, (unsigned int)connectionPort, theSocket, mConnectionFlags); - thePass = NULL; - if (connectionSetupStatus) { - - // Set up a KILL query. For MySQL 5+, kill just the query; otherwise, kill the thread. - NSStringEncoding killerConnectionEncoding = [MCPConnection encodingForMySQLEncoding:mysql_character_set_name(killerConnection)]; - NSString *killQueryString; - if ([self serverMajorVersion] >= 5) { - killQueryString = [NSString stringWithFormat:@"KILL QUERY %lu", mConnection->thread_id]; - } else { - killQueryString = [NSString stringWithFormat:@"KILL %lu", mConnection->thread_id]; - } - NSData *encodedKillQueryData = NSStringDataUsingLossyEncoding(killQueryString, killerConnectionEncoding, 1); - const char *killQueryCString = [encodedKillQueryData bytes]; - unsigned long killQueryCStringLength = [encodedKillQueryData length]; - int killerReturnError = mysql_real_query(killerConnection, killQueryCString, killQueryCStringLength); - mysql_close(killerConnection); - if (killerReturnError == 0) { - queryCancelUsedReconnect = NO; - return; - } - NSLog(@"Task cancellation: kill query failed (Returned status %d)", killerReturnError); - } else { - NSLog(@"Task cancellation connection failed (error %u)", mysql_errno(killerConnection)); - } - } else { - NSLog(@"Task cancelletion MySQL init failed."); - } - - // As the attempt may have taken up to the connection timeout, check lock status - // again, returning if nothing is required. - if ([self tryLockConnection]) { - [self unlockConnection]; - return; - } - - // Reset the connection - [self unlockConnection]; - if (!isDisconnecting) [self reconnect]; - - // Set queryCancelled again to handle requery cleanups, and return. - queryCancelled = YES; - queryCancelUsedReconnect = YES; -} - -/** - * Return whether the last query was cancelled - */ -- (BOOL)queryCancelled -{ - return queryCancelled; -} - -/** - * If the last query was cancelled, returns whether that cancellation - * required a connection reset. If the last query was not cancelled - * the behaviour is undefined. - */ -- (BOOL)queryCancellationUsedReconnect -{ - return queryCancelUsedReconnect; -} - -/** - * Retrieves all remaining results and discards them. - * Necessary if we only retrieve one result, and want to discard all the others. - */ -- (void)flushMultiResults -{ - // repeat as long as there are results - while(!mysql_next_result(mConnection)) - { - MYSQL_RES *result = mysql_use_result(mConnection); - // check if the result is really a result - if (result) { - // retrieve all rows - while (mysql_fetch_row(result)); - mysql_free_result(result); - } - } -} - -#pragma mark - -#pragma mark Connection locking - -/** - * Lock the connection. This must be done before performing any operation - * that is not thread safe, eg. performing queries or pinging. - */ -- (void)lockConnection -{ - // We can only start a query as soon as the condition is MCPConnectionIdle - [connectionLock lockWhenCondition:MCPConnectionIdle]; - - // We now set the condition to MCPConnectionBusy - [connectionLock unlockWithCondition:MCPConnectionBusy]; -} - -/** - * Try locking the connection. If the connection is idle (unlocked), this method - * locks the connection and returns YES. The connection must afterwards be unlocked - * using unlockConnection. If the connection is currently busy (locked), this - * method immediately returns NO and doesn't lock the connection. - */ -- (BOOL)tryLockConnection -{ - // check if the condition is MCPConnectionIdle - if ([connectionLock tryLockWhenCondition:MCPConnectionIdle]) { - // We're allowed to use the connection! - [connectionLock unlockWithCondition:MCPConnectionBusy]; - return YES; - } else { - // Someone else is using the connection right now - return NO; - } -} - - -/** - * Unlock the connection. - */ -- (void)unlockConnection -{ - // We don't care if the connection is busy or not - [connectionLock lock]; - - // We check if the connection actually was busy. If it wasn't busy, - // it means we probably tried to unlock the connection twice. This is - // potentially dangerous, therefore we log this to the console - if ([connectionLock condition] != MCPConnectionBusy) { - NSLog(@"Tried to unlock the connection, but it wasn't locked."); - } - - // Since we connected with CLIENT_MULTI_RESULT, we must make sure there are nor more results! - // This is still a bit of a dirty hack - if (mConnected && mConnection && mConnection->net.vio && mConnection->net.buff && mysql_more_results(mConnection)) { - NSLog(@"Discarding unretrieved results. This is currently normal when using CALL."); - [self flushMultiResults]; - } - - // We tell everyone that the connection is available again! - [connectionLock unlockWithCondition:MCPConnectionIdle]; -} - -#pragma mark - -#pragma mark Database structure - -/** - * Just a fast wrapper for the more complex !{listDBsWithPattern:} method. - */ -- (MCPResult *)listDBs -{ - return [self listDBsLike:nil]; -} - -/** - * Returns a list of database which name correspond to the SQL regular expression in 'pattern'. - * The comparison is done with wild card extension : % and _. - * The result should correspond to the queryString:@"SHOW databases [LIKE wild]"; but implemented with mysql_list_dbs. - * If an empty string or nil is passed as pattern, all databases will be shown. - */ -- (MCPResult *)listDBsLike:(NSString *)dbsName -{ - if (!mConnected) return NO; - - MCPResult *theResult = nil; - MYSQL_RES *theResPtr; - - if (![self checkConnection]) return [[[MCPResult alloc] init] autorelease]; - - // Ensure UTF8 - where supported - when getting database list. - NSString *currentEncoding = [NSString stringWithString:encoding]; - BOOL currentEncodingUsesLatin1Transport = encodingUsesLatin1Transport; - [self setEncoding:@"utf8"]; - - [self lockConnection]; - if ((dbsName == nil) || ([dbsName isEqualToString:@""])) { - if ((theResPtr = mysql_list_dbs(mConnection, NULL))) { - theResult = [[MCPResult alloc] initWithResPtr: theResPtr encoding:stringEncoding timeZone:mTimeZone]; - } - else { - theResult = [[MCPResult alloc] init]; - } - } - else { - const char *theCDBsName = (const char *)[self cStringFromString:dbsName]; - - if ((theResPtr = mysql_list_dbs(mConnection, theCDBsName))) { - theResult = [[MCPResult alloc] initWithResPtr:theResPtr encoding:stringEncoding timeZone:mTimeZone]; - } - else { - theResult = [[MCPResult alloc] init]; - } - } - [self unlockConnection]; - - // Restore the connection encoding if necessary - [self setEncoding:currentEncoding]; - [self setEncodingUsesLatin1Transport:currentEncodingUsesLatin1Transport]; - - if (theResult) { - [theResult autorelease]; - } - - return theResult; -} - -/** - * Make sure a DB is selected (with !{selectDB:} method) first. - */ -- (MCPResult *)listTables -{ - return [self listTablesLike:nil]; -} - -/** - * From within a database, give back the list of table which name correspond to tablesName - * (with wild card %, _ extension). Correspond to queryString:@"SHOW tables [LIKE wild]"; uses mysql_list_tables function. - * - * If an empty string or nil is passed as tablesName, all tables will be shown. - * - * WARNING: #{produce an error if no databases are selected} (with !{selectDB:} for example). - */ -- (MCPResult *)listTablesLike:(NSString *)tablesName -{ - if (!mConnected) return NO; - - MCPResult *theResult = nil; - MYSQL_RES *theResPtr; - - if (![self checkConnection]) return [[[MCPResult alloc] init] autorelease]; - - [self lockConnection]; - if ((tablesName == nil) || ([tablesName isEqualToString:@""])) { - if ((theResPtr = mysql_list_tables(mConnection, NULL))) { - theResult = [[MCPResult alloc] initWithResPtr: theResPtr encoding:stringEncoding timeZone:mTimeZone]; - } - else { - theResult = [[MCPResult alloc] init]; - } - } - else { - const char *theCTablesName = (const char *)[self cStringFromString:tablesName]; - if ((theResPtr = mysql_list_tables(mConnection, theCTablesName))) { - theResult = [[MCPResult alloc] initWithResPtr: theResPtr encoding:stringEncoding timeZone:mTimeZone]; - } - else { - theResult = [[MCPResult alloc] init]; - } - } - - [self unlockConnection]; - - if (theResult) { - [theResult autorelease]; - } - - return theResult; -} - -- (NSArray *)listTablesFromDB:(NSString *)dbName { - return [self listTablesFromDB:dbName like:nil]; -} - -/** - * List tables in DB specified by dbName and corresponding to pattern. - * This method indeed issues a !{SHOW TABLES FROM dbName LIKE ...} query to the server. - * This is done this way to make sure the selected DB is not changed by this method. - */ -- (NSArray *)listTablesFromDB:(NSString *)dbName like:(NSString *)tablesName { - MCPResult *theResult; - if ((tablesName == nil) || ([tablesName isEqualToString:@""])) { - NSString *theQuery = [NSString stringWithFormat:@"SHOW TABLES FROM %@", - [dbName backtickQuotedString]]; - theResult = [self queryString:theQuery]; - } else { - NSString *theQuery = [NSString stringWithFormat:@"SHOW TABLES FROM %@ LIKE '%@'", - [dbName backtickQuotedString], - [tablesName backtickQuotedString]]; - theResult = [self queryString:theQuery]; - } - [theResult setReturnDataAsStrings:YES]; - NSString *theTableName; - NSMutableArray *theDBTables = [NSMutableArray array]; - - // NSLog(@"num of fields: %@; num of rows: %@", [theResult numOfFields], [theResult numOfRows]); - if ([theResult numOfRows] > 0) { - my_ulonglong i; - for ( i = 0 ; i < [theResult numOfRows] ; i++ ) { - theTableName = [[theResult fetchRowAsArray] objectAtIndex:0]; - [theDBTables addObject:theTableName]; - } - } - - return theDBTables; -} - -/** - * Just a fast wrapper for the more complex list !{listFieldsWithPattern:forTable:} method. - */ -- (MCPResult *)listFieldsFromTable:(NSString *)tableName -{ - return [self listFieldsFromTable:tableName like:nil]; -} - -/** - * Show all the fields of the table tableName which name correspond to pattern (with wild card expansion : %,_). - * Indeed, and as recommanded from mysql reference, this method is NOT using mysql_list_fields but the !{queryString:} method. - * If an empty string or nil is passed as fieldsName, all fields (of tableName) will be returned. - */ -- (MCPResult *)listFieldsFromTable:(NSString *)tableName like:(NSString *)fieldsName -{ - MCPResult *theResult; - - if ((fieldsName == nil) || ([fieldsName isEqualToString:@""])) { - NSString *theQuery = [NSString stringWithFormat:@"SHOW COLUMNS FROM %@", - [tableName backtickQuotedString]]; - theResult = [self queryString:theQuery]; - } - else { - NSString *theQuery = [NSString stringWithFormat:@"SHOW COLUMNS FROM %@ LIKE '%@'", - [tableName backtickQuotedString], - [fieldsName backtickQuotedString]]; - theResult = [self queryString:theQuery]; - } - [theResult setReturnDataAsStrings:YES]; - - return theResult; -} - -/** - * Updates the dict containing the structure of all available databases (mainly for completion/navigator) - * executed on a new connection. - * - * TODO: Split this entire method out of MCPKit if possible - */ -- (void)queryDbStructureWithUserInfo:(NSDictionary*)userInfo -{ - NSAutoreleasePool *queryPool = [[NSAutoreleasePool alloc] init]; - BOOL structureWasUpdated = NO; - - // if 'cancelQuerying' is set try to interrupt any current querying - if(userInfo && [userInfo objectForKey:@"cancelQuerying"]) - cancelQueryingDbStructure = YES; - - // Requests are queued - while(isQueryingDbStructure > 0) { usleep(1000000); } - - cancelQueryingDbStructure = NO; - - [[NSNotificationCenter defaultCenter] postNotificationName:@"SPDBStructureIsUpdating" object:delegate]; - - NSString *SPUniqueSchemaDelimiter = @""; - - NSString *connectionID; - if([delegate respondsToSelector:@selector(connectionID)]) - connectionID = [NSString stringWithString:[[self delegate] connectionID]]; - else - connectionID = @"_"; - - // Re-init with already cached data from navigator controller - NSMutableDictionary *queriedStructure = [NSMutableDictionary dictionary]; - NSDictionary *dbstructure = [[self delegate] getDbStructure]; - if (dbstructure) [queriedStructure setDictionary:[NSMutableDictionary dictionaryWithDictionary:dbstructure]]; - - NSMutableArray *queriedStructureKeys = [NSMutableArray array]; - NSArray *dbStructureKeys = [[self delegate] allSchemaKeys]; - if (dbStructureKeys) [queriedStructureKeys setArray:dbStructureKeys]; - - // Retrieve all the databases known of by the delegate - NSMutableArray *connectionDatabases = [NSMutableArray array]; - [connectionDatabases addObjectsFromArray:[[self delegate] allSystemDatabaseNames]]; - [connectionDatabases addObjectsFromArray:[[self delegate] allDatabaseNames]]; - - // Add all known databases coming from connection if they aren't parsed yet - for (id db in connectionDatabases) { - NSString *dbid = [NSString stringWithFormat:@"%@%@%@", connectionID, SPUniqueSchemaDelimiter, db]; - if(![queriedStructure objectForKey:dbid]) { - structureWasUpdated = YES; - [queriedStructure setObject:db forKey:dbid]; - [queriedStructureKeys addObject:dbid]; - } - } - - // Check the existing databases in the 'structure' and 'allKeysOfDbStructure' stores, - // and remove any that are no longer found in the connectionDatabases list (indicating deletion). - // Iterate through extracted keys to avoid <NSCFDictionary> mutation while being enumerated. - NSArray *keys = [queriedStructure allKeys]; - for(id key in keys) { - NSString *db = [[key componentsSeparatedByString:SPUniqueSchemaDelimiter] objectAtIndex:1]; - if(![connectionDatabases containsObject:db]) { - structureWasUpdated = YES; - [queriedStructure removeObjectForKey:key]; - NSPredicate *predicate = [NSPredicate predicateWithFormat:@"NOT SELF BEGINSWITH %@", [NSString stringWithFormat:@"%@%@", key, SPUniqueSchemaDelimiter]]; - [queriedStructureKeys filterUsingPredicate:predicate]; - [queriedStructureKeys removeObject:key]; - } - } - - NSString *currentDatabase = nil; - if([delegate respondsToSelector:@selector(database)]) - currentDatabase = [[self delegate] database]; - - // Determine whether the database details need to be queried. - BOOL shouldQueryStructure = YES; - NSString *db_id = nil; - - // If no database is selected, no need to check further - if(!currentDatabase || (currentDatabase && ![currentDatabase length])) { - shouldQueryStructure = NO; - - // Otherwise, build up the schema key for the database to be retrieved. - } else { - db_id = [NSString stringWithFormat:@"%@%@%@", connectionID, SPUniqueSchemaDelimiter, currentDatabase]; - - // Check to see if a cache already exists for the database. - if ([queriedStructure objectForKey:db_id] && [[queriedStructure objectForKey:db_id] isKindOfClass:[NSDictionary class]]) { - - // The cache is available. If the `mysql` or `information_schema` databases are being queried, - // never requery as their structure will never change. - // 5.5.3+ also has performance_schema meta database - if ([currentDatabase isEqualToString:@"mysql"] || [currentDatabase isEqualToString:@"information_schema"] || [currentDatabase isEqualToString:@"performance_schema"]) { - shouldQueryStructure = NO; - - // Otherwise, if the forceUpdate flag wasn't supplied or evaluates to false, also don't update. - } else if (userInfo == nil || ![userInfo objectForKey:@"forceUpdate"] || ![[userInfo objectForKey:@"forceUpdate"] boolValue]) { - shouldQueryStructure = NO; - } - } - } - - // If it has been determined that no new structure needs to be retrieved, clean up and return. - if (!shouldQueryStructure) { - - // Update the global variables and make sure that no request reads these global variables - // while updating - [self performSelectorOnMainThread:@selector(lockQuerying) withObject:nil waitUntilDone:YES]; - [self performSelectorOnMainThread:@selector(updateGlobalVariablesWith:) withObject:[NSDictionary dictionaryWithObjectsAndKeys:queriedStructure, @"structure", queriedStructureKeys, @"keys", nil] waitUntilDone:YES]; - [self performSelectorOnMainThread:@selector(unlockQuerying) withObject:nil waitUntilDone:YES]; - if (structureWasUpdated) - [[NSNotificationCenter defaultCenter] postNotificationName:@"SPDBStructureWasUpdated" object:delegate]; - [queryPool release]; - return; - } - - // Retrieve the tables and views for this database from SPTablesList - NSMutableArray *tablesAndViews = [NSMutableArray array]; - for (id aTable in [[[self delegate] valueForKeyPath:@"tablesListInstance"] allTableNames]) { - NSDictionary *aTableDict = [NSDictionary dictionaryWithObjectsAndKeys: - aTable, @"name", - @"0", @"type", - nil]; - [tablesAndViews addObject:aTableDict]; - } - for (id aView in [[[self delegate] valueForKeyPath:@"tablesListInstance"] allViewNames]) { - NSDictionary *aViewDict = [NSDictionary dictionaryWithObjectsAndKeys: - aView, @"name", - @"1", @"type", - nil]; - [tablesAndViews addObject:aViewDict]; - } - - // Do not parse more than 2000 tables/views per db - if([tablesAndViews count] > 2000) { - NSLog(@"%lu items in database %@. Only 2000 items can be parsed. Stopped parsing.", (unsigned long)[tablesAndViews count], currentDatabase); - [queryPool release]; - return; - } - - // For future usage - currently unused - // If the affected item name and type - for example, table type and table name - were supplied, extract it. - NSString *affectedItem = nil; - NSInteger affectedItemType = -1; - if(userInfo && [userInfo objectForKey:@"affectedItem"]) { - affectedItem = [userInfo objectForKey:@"affectedItem"]; - if([userInfo objectForKey:@"affectedItemType"]) - affectedItemType = [[userInfo objectForKey:@"affectedItemType"] intValue]; - else - affectedItem = nil; - } - - // Delete all stored data for the database to be updated, leaving the structure key - [queriedStructure removeObjectForKey:db_id]; - NSPredicate *predicate = [NSPredicate predicateWithFormat:@"NOT SELF BEGINSWITH %@", [NSString stringWithFormat:@"%@%@", db_id, SPUniqueSchemaDelimiter]]; - [queriedStructureKeys filterUsingPredicate:predicate]; - - // Set up the database as an empty mutable dictionary ready for tables, and store a reference - [queriedStructure setObject:[NSMutableDictionary dictionary] forKey:db_id]; - NSMutableDictionary *databaseStructure = [queriedStructure objectForKey:db_id]; - - NSString *currentDatabaseEscaped = [currentDatabase stringByReplacingOccurrencesOfString:@"`" withString:@"``"]; - - MYSQL *structConnection = mysql_init(NULL); - if (structConnection) { - const char *theLogin = [connectionLogin UTF8String]; - const char *theHost; - const char *thePass = NULL; - const char *theSocket; - void *connectionSetupStatus; - - mysql_options(structConnection, MYSQL_OPT_CONNECT_TIMEOUT, (const void *)&connectionTimeout); - mysql_options(structConnection, MYSQL_SET_CHARSET_NAME, "utf8"); - - // Set up the host, socket and password as per the connect method - if (!connectionHost || ![connectionHost length]) { - theHost = NULL; - } else { - theHost = [connectionHost UTF8String]; - } - if (connectionSocket == nil || ![connectionSocket length]) { - theSocket = kMCPConnectionDefaultSocket; - } else { - theSocket = [connectionSocket UTF8String]; - } - if (useSSL) { - mysql_ssl_set(mConnection, - sslKeyFilePath ? [sslKeyFilePath UTF8String] : NULL, - sslCertificatePath ? [sslCertificatePath UTF8String] : NULL, - sslCACertificatePath ? [sslCACertificatePath UTF8String] : NULL, - NULL, - kMCPSSLCipherList); - } - if (!connectionPassword) { - if (delegate && [delegate respondsToSelector:@selector(keychainPasswordForConnection:)]) { - thePass = [[delegate keychainPasswordForConnection:self] UTF8String]; - } - } else { - thePass = [connectionPassword UTF8String]; - } - - // Connect - connectionSetupStatus = mysql_real_connect(structConnection, theHost, theLogin, thePass, NULL, (unsigned int)connectionPort, theSocket, mConnectionFlags); - thePass = NULL; - if (connectionSetupStatus) { - MYSQL_RES *theResult; - MYSQL_ROW row; - NSString *charset; - NSUInteger uniqueCounter = 0; // used to make field data unique - NSString *query; - NSData *encodedQueryData; - const char *queryCString; - unsigned long queryCStringLength; - - // Get the doc encoding due to pref settings etc, defaulting to UTF8 - NSString *docEncoding = [self encoding]; - if (!docEncoding) docEncoding = @"utf8"; - NSStringEncoding theConnectionEncoding = [MCPConnection encodingForMySQLEncoding:[self cStringFromString:docEncoding]]; - - // Try to set connection encoding for MySQL >= 4.1 - if ([self serverMajorVersion] > 4 || ([self serverMajorVersion] >= 4 && [self serverMinorVersion] >= 1)) { - query = [NSString stringWithFormat:@"SET NAMES '%@'", docEncoding]; - encodedQueryData = NSStringDataUsingLossyEncoding(query, theConnectionEncoding, 1); - queryCString = [encodedQueryData bytes]; - queryCStringLength = [encodedQueryData length]; - if (mysql_real_query(structConnection, queryCString, queryCStringLength) != 0) { - NSLog(@"Error while querying the database structure. Could not set encoding to %@", docEncoding); - [queryPool release]; - return; - } - } - - // Increase global query-db-counter - [self performSelectorOnMainThread:@selector(incrementQueryingDbStructure) withObject:nil waitUntilDone:YES]; - - // Loop through the known tables and views, retrieving details for each - for (NSDictionary *aTableDict in tablesAndViews) { - - // If cancelled, abort without saving - if (cancelQueryingDbStructure) { - [self performSelectorOnMainThread:@selector(decrementQueryingDbStructure) withObject:nil waitUntilDone:YES]; - [queryPool release]; - return; - } - - if(![aTableDict objectForKey:@"name"]) continue; - // Extract the name - NSString *aTableName = [aTableDict objectForKey:@"name"]; - - if(!aTableName) continue; - if(![aTableName isKindOfClass:[NSString class]]) continue; - if(![aTableName length]) continue; - // Retrieve the column details - query = [NSString stringWithFormat:@"SHOW FULL COLUMNS FROM `%@` FROM `%@`", - [aTableName stringByReplacingOccurrencesOfString:@"`" withString:@"``"], - currentDatabaseEscaped]; - encodedQueryData = NSStringDataUsingLossyEncoding(query, theConnectionEncoding, 1); - queryCString = [encodedQueryData bytes]; - queryCStringLength = [encodedQueryData length]; - if (mysql_real_query(structConnection, queryCString, queryCStringLength) != 0) { - // NSLog(@"error %@", aTableName); - continue; - } - theResult = mysql_use_result(structConnection); - - // Add a structure key for this table - NSString *table_id = [NSString stringWithFormat:@"%@%@%@", db_id, SPUniqueSchemaDelimiter, aTableName]; - [queriedStructureKeys addObject:table_id]; - - // Add a mutable dictionary to the structure and store a reference - [databaseStructure setObject:[NSMutableDictionary dictionary] forKey:table_id]; - NSMutableDictionary *tableStructure = [databaseStructure objectForKey:table_id]; - - // Loop through the fields, extracting details for each - while ((row = mysql_fetch_row(theResult))) { - NSString *field = [self stringWithCString:row[0] usingEncoding:theConnectionEncoding] ; - NSString *type = [self stringWithCString:row[1] usingEncoding:theConnectionEncoding] ; - NSString *type_display = [type stringByReplacingOccurrencesOfRegex:@"\\(.*?,.*?\\)" withString:@"(…)"]; - NSString *coll = [self stringWithCString:row[2] usingEncoding:theConnectionEncoding] ; - NSString *isnull = [self stringWithCString:row[3] usingEncoding:theConnectionEncoding] ; - NSString *key = [self stringWithCString:row[4] usingEncoding:theConnectionEncoding] ; - NSString *def = [self stringWithCString:row[5] usingEncoding:theConnectionEncoding] ; - NSString *extra = [self stringWithCString:row[6] usingEncoding:theConnectionEncoding] ; - NSString *priv = [self stringWithCString:row[7] usingEncoding:theConnectionEncoding] ; - NSString *comment; - if (sizeof(row) > 8) { - comment = [self stringWithCString:row[8] usingEncoding:theConnectionEncoding] ; - } else { - comment = @""; - } - NSArray *a = [coll componentsSeparatedByString:@"_"]; - charset = ([a count]) ? [a objectAtIndex:0] : @""; - - // Add a structure key for this field - NSString *field_id = [NSString stringWithFormat:@"%@%@%@", table_id, SPUniqueSchemaDelimiter, field]; - [queriedStructureKeys addObject:field_id]; - - [tableStructure setObject:[NSArray arrayWithObjects:type, def, isnull, charset, coll, key, extra, priv, comment, type_display, [NSNumber numberWithUnsignedLongLong:uniqueCounter], nil] forKey:field_id]; - [tableStructure setObject:[aTableDict objectForKey:@"type"] forKey:@" struct_type "]; - uniqueCounter++; - } - mysql_free_result(theResult); - usleep(10); - } - - // If the MySQL version is higher than 5, also retrieve function/procedure details via the information_schema table - if([self serverMajorVersion] >= 5) { - - // The information_schema table is UTF-8 encoded - alter the connection - query = @"SET NAMES 'utf8'"; - encodedQueryData = NSStringDataUsingLossyEncoding(query, theConnectionEncoding, 1); - queryCString = [encodedQueryData bytes]; - queryCStringLength = [encodedQueryData length]; - if (mysql_real_query(structConnection, queryCString, queryCStringLength) == 0) { - - // Query for procedures and functions - query = [NSString stringWithFormat:@"SELECT * FROM `information_schema`.`ROUTINES` WHERE `information_schema`.`ROUTINES`.`ROUTINE_SCHEMA` = '%@'", [currentDatabase stringByReplacingOccurrencesOfString:@"'" withString:@"\\'"]]; - encodedQueryData = NSStringDataUsingLossyEncoding(query, theConnectionEncoding, 1); - queryCString = [encodedQueryData bytes]; - queryCStringLength = [encodedQueryData length]; - if (mysql_real_query(structConnection, queryCString, queryCStringLength) == 0) { - theResult = mysql_use_result(structConnection); - - // Loop through the rows and extract the function details - while ((row = mysql_fetch_row(theResult))) { - - // If cancelled, abort without saving the new structure - if(cancelQueryingDbStructure) { - [self performSelectorOnMainThread:@selector(decrementQueryingDbStructure) withObject:nil waitUntilDone:YES]; - [queryPool release]; - return; - } - - NSString *fname = [self stringWithUTF8CString:row[0]]; - NSString *type = ([[self stringWithUTF8CString:row[4]] isEqualToString:@"FUNCTION"]) ? @"3" : @"2"; - NSString *dtd = [self stringWithUTF8CString:row[5]]; - NSString *det = [self stringWithUTF8CString:row[11]]; - NSString *dataaccess = [self stringWithUTF8CString:row[12]]; - NSString *security_type = [self stringWithUTF8CString:row[14]]; - NSString *definer = [self stringWithUTF8CString:row[19]]; - - // Generate "table" and "field" names and add to structure key store - NSString *table_id = [NSString stringWithFormat:@"%@%@%@", db_id, SPUniqueSchemaDelimiter, fname]; - NSString *field_id = [NSString stringWithFormat:@"%@%@%@", table_id, SPUniqueSchemaDelimiter, fname]; - [queriedStructureKeys addObject:table_id]; - [queriedStructureKeys addObject:field_id]; - - // Ensure that a dictionary exists for this "table" name - if(![[queriedStructure valueForKey:db_id] valueForKey:table_id]) - [[queriedStructure valueForKey:db_id] setObject:[NSMutableDictionary dictionary] forKey:table_id]; - - // Add the "field" details - [[[queriedStructure valueForKey:db_id] valueForKey:table_id] setObject: - [NSArray arrayWithObjects:dtd, dataaccess, det, security_type, definer, [NSNumber numberWithUnsignedLongLong:uniqueCounter], nil] forKey:field_id]; - [[[queriedStructure valueForKey:db_id] valueForKey:table_id] setObject:type forKey:@" struct_type "]; - uniqueCounter++; - } - mysql_free_result(theResult); - } else { - NSLog(@"Error while querying the database structure for procedures and functions. Could not set encoding to utf8"); - } - } - } - - // Update the global variables and make sure that no request reads these global variables - // while updating - [self performSelectorOnMainThread:@selector(lockQuerying) withObject:nil waitUntilDone:YES]; - [self performSelectorOnMainThread:@selector(updateGlobalVariablesWith:) withObject:[NSDictionary dictionaryWithObjectsAndKeys:queriedStructure, @"structure", queriedStructureKeys, @"keys", nil] waitUntilDone:YES]; - [self performSelectorOnMainThread:@selector(unlockQuerying) withObject:nil waitUntilDone:YES]; - - - mysql_close(structConnection); - - // Notify that the structure querying has been performed - [[NSNotificationCenter defaultCenter] postNotificationName:@"SPDBStructureWasUpdated" object:delegate]; - - [self performSelectorOnMainThread:@selector(decrementQueryingDbStructure) withObject:nil waitUntilDone:YES]; - } - } - - [queryPool release]; -} - -/* - * Update global variables on main thread to avoid accessing from different threads - */ -- (void)updateGlobalVariablesWith:(NSDictionary*)object -{ - NSString *connectionID = [[self delegate] connectionID]; - - // Return if the delegate indicates disconnection - if([connectionID length] < 2) return; - - if(![structure valueForKey:connectionID]) - [structure setObject:[NSMutableDictionary dictionary] forKey:connectionID]; - [structure setObject:[object objectForKey:@"structure"] forKey:connectionID]; - [allKeysofDbStructure setArray:[object objectForKey:@"keys"]]; - usleep(100); -} - -- (void)incrementQueryingDbStructure -{ - isQueryingDbStructure++; -} - -- (void)decrementQueryingDbStructure -{ - isQueryingDbStructure--; - if(isQueryingDbStructure < 0) isQueryingDbStructure = 0; -} - -- (BOOL)isQueryingDatabaseStructure -{ - return (isQueryingDbStructure > 0) ? YES : NO; -} - -- (void)lockQuerying -{ - lockQuerying = YES; -} - -- (void)unlockQuerying -{ - lockQuerying = NO; - usleep(50000); -} -/** - * Returns a dict containing the structure of all available databases - */ -- (NSDictionary *)getDbStructure -{ - if(lockQuerying) return nil; - NSDictionary *d = [NSDictionary dictionaryWithDictionary:structure]; - return d; -} - -/** - * Returns all keys of the db structure - */ -- (NSArray *)getAllKeysOfDbStructure -{ - if(lockQuerying) return nil; - NSArray *r = [NSArray arrayWithArray:allKeysofDbStructure]; - return r; -} - -#pragma mark - -#pragma mark Server information - -/** - * Returns a string giving the client library version. - */ -- (NSString *)clientInfo -{ - return [self stringWithCString:mysql_get_client_info()]; -} - -/** - * Returns a string giving information on the host of the DB server. - */ -- (NSString *)hostInfo -{ - return [self stringWithCString:mysql_get_host_info(mConnection)]; -} - -/** - * Returns a string giving the server version. - */ -- (NSString *)serverInfo -{ - if (mConnected) { - return [self stringWithCString: mysql_get_server_info(mConnection)]; - } - - return @""; -} - -/** - * Returns the number of the protocole used to transfer info from server to client - */ -- (NSNumber *)protoInfo -{ - return [MCPNumber numberWithUnsignedInteger:mysql_get_proto_info(mConnection)]; -} - -/** - * Lists active process - */ -- (MCPResult *)listProcesses -{ - MCPResult *result = nil; - MYSQL_RES *theResPtr; - - [self lockConnection]; - - if (mConnected && (mConnection != NULL)) { - if ((theResPtr = mysql_list_processes(mConnection))) { - result = [[MCPResult alloc] initWithResPtr:theResPtr encoding:stringEncoding timeZone:mTimeZone]; - } - else { - result = [[MCPResult alloc] init]; - } - } - - [self unlockConnection]; - - if (result) [result autorelease]; - - return result; -} - -/** - * Kills the process with the given pid. - * The users needs the !{Process_priv} privilege. - */ -- (BOOL)killProcess:(unsigned long)pid -{ - NSInteger theErrorCode = mysql_kill(mConnection, pid); - - return (theErrorCode) ? NO : YES; -} - -/* - * Check some common locations for the presence of a MySQL socket file, returning - * it if successful. - */ -- (NSString *)findSocketPath -{ - NSFileManager *fileManager = [NSFileManager defaultManager]; - - NSArray *possibleSocketLocations = [NSArray arrayWithObjects: - @"/tmp/mysql.sock", // Default - @"/Applications/MAMP/tmp/mysql/mysql.sock", // MAMP default location - @"/Applications/xampp/xamppfiles/var/mysql/mysql.sock", // XAMPP default location - @"/var/mysql/mysql.sock", // Mac OS X Server default - @"/opt/local/var/run/mysqld/mysqld.sock", // Darwinports MySQL - @"/opt/local/var/run/mysql4/mysqld.sock", // Darwinports MySQL 4 - @"/opt/local/var/run/mysql5/mysqld.sock", // Darwinports MySQL 5 - @"/usr/local/zend/mysql/tmp/mysql.sock", // Zend Server CE (see Issue #1251) - @"/var/run/mysqld/mysqld.sock", // As used on Debian/Gentoo - @"/var/tmp/mysql.sock", // As used on FreeBSD - @"/var/lib/mysql/mysql.sock", // As used by Fedora - @"/opt/local/lib/mysql/mysql.sock", // Alternate fedora - nil]; - - for (NSUInteger i = 0; i < [possibleSocketLocations count]; i++) - { - if ([fileManager fileExistsAtPath:[possibleSocketLocations objectAtIndex:i]]) - return [possibleSocketLocations objectAtIndex:i]; - } - - return nil; -} - -#pragma mark - -#pragma mark Encoding - -/** - * Sets the encoding for the database connection. - * This sends a "SET NAMES" command to the server, as appropriate, and - * also updates the class to decode the returned strings correctly. - * If an encoding name unsupported by MySQL is encountered, a FALSE - * status will be returned, and errors will be updated. - * If an encoding name not supported by this class is encountered, a - * warning will be logged to console but the MySQL connection will still - * be updated. - * This resets any setting to use Latin1 transport for the connection. - */ -- (BOOL)setEncoding:(NSString *)theEncoding -{ - if ([theEncoding isEqualToString:encoding] && !encodingUsesLatin1Transport) return YES; - - // MySQL < 4.1 will fail - if ([self serverMajorVersion] < 4 - || ([self serverMinorVersion] == 4 && [self serverMinorVersion] < 1)) - { - return NO; - } - - // Attempt to set the encoding of the connection, restoring the connection on failure - [self queryString:[NSString stringWithFormat:@"SET NAMES %@", [theEncoding tickQuotedString]]]; - if ([self queryErrored]) { - [self queryString:[NSString stringWithFormat:@"SET NAMES %@", [encoding tickQuotedString]]]; - if (encodingUsesLatin1Transport) [self queryString:@"SET CHARACTER_SET_RESULTS=latin1"]; - return NO; - } - - // The connection set was successful - update stored details - [encoding release]; - encoding = [[NSString alloc] initWithString:theEncoding]; - stringEncoding = [MCPConnection encodingForMySQLEncoding:[encoding UTF8String]]; - encodingUsesLatin1Transport = NO; - return YES; -} - -/** - * Returns the currently active encoding. - */ -- (NSString *)encoding -{ - return [NSString stringWithString:encoding]; -} - -/** - * Gets the string encoding for the connection - */ -- (NSStringEncoding)stringEncoding -{ - return stringEncoding; -} - -/** - * Sets whether the connection encoding should be transmitted via Latin1. - * This is a method purely for backwards compatibility: old codebases or - * applications often believed they stored UTF8 data in UTF8 tables, but - * for the purposes of storing and reading the data, the MySQL connecttion - * was never changed from the default Latin1. UTF8 data was therefore - * altered during transit and stored as UTF8 encoding Latin1 pairs which - * together make up extended UTF8 characters. Reading these characters back - * over Latin1 makes the data editable in a compatible fashion. - */ -- (BOOL)setEncodingUsesLatin1Transport:(BOOL)useLatin1 -{ - if (encodingUsesLatin1Transport == useLatin1) return YES; - - // If disabling Latin1 transport, restore the connection encoding - if (!useLatin1) return [self setEncoding:encoding]; - - // Otherwise attempt to set Latin1 transport - [self queryString:@"SET CHARACTER_SET_RESULTS=latin1"]; - if ([self queryErrored]) return NO; - [self queryString:@"SET CHARACTER_SET_CLIENT=latin1"]; - if ([self queryErrored]) { - [self setEncoding:encoding]; - return NO; - } - encodingUsesLatin1Transport = YES; - return YES; -} - -/** - * Return whether the current connection is set to use Latin1 tranport. - */ -- (BOOL)encodingUsesLatin1Transport -{ - return encodingUsesLatin1Transport; -} - -/** - * Store a previous encoding setting. This allows easy restoration - * later - useful if certain tasks require the encoding to be - * temporarily changed. - */ -- (void)storeEncodingForRestoration -{ - if (previousEncoding) [previousEncoding release]; - previousEncoding = [[NSString alloc] initWithString:encoding]; - previousEncodingUsesLatin1Transport = encodingUsesLatin1Transport; -} - -/** - * Restore a previously stored encoding setting, if one is stored. - * Useful if certain tasks required the encoding to be temporarily changed. - */ -- (void)restoreStoredEncoding -{ - if (!previousEncoding || !mConnected) return; - - [self setEncoding:previousEncoding]; - [self setEncodingUsesLatin1Transport:previousEncodingUsesLatin1Transport]; -} - -#pragma mark - -#pragma mark Time Zone - -/** - * Setting the time zone to be used with the server. - */ -- (void)setTimeZone:(NSTimeZone *)iTimeZone -{ - if (iTimeZone != mTimeZone) { - [mTimeZone release]; - mTimeZone = [iTimeZone retain]; - } - - if ([self checkConnection]) { - if (mTimeZone) { - [self queryString:[NSString stringWithFormat:@"SET time_zone = '%@'", [mTimeZone name]]]; - } - else { - [self queryString:@"SET time_zone = 'SYSTEM'"]; - } - } -} - -/** - * Getting the currently used time zone (in communication with the DB server). - */ -- (NSTimeZone *)timeZone -{ - if ([self checkConnection]) { - MCPResult *theSessionTZ = [self queryString:@"SHOW VARIABLES LIKE '%time_zone'"]; - NSArray *theRow; - id theTZName; - NSTimeZone *theTZ; - - [theSessionTZ setReturnDataAsStrings:YES]; - [theSessionTZ dataSeek:1ULL]; - theRow = [theSessionTZ fetchRowAsArray]; - theTZName = [theRow objectAtIndex:1]; - - if ([theTZName isEqualToString:@"SYSTEM"]) { - [theSessionTZ dataSeek:0ULL]; - theRow = [theSessionTZ fetchRowAsArray]; - theTZName = [theRow objectAtIndex:1]; - } - - if (theTZName) { // Old versions of the server does not support there own time zone ? - theTZ = [NSTimeZone timeZoneWithName:theTZName]; - if (!theTZ) theTZ = [NSTimeZone timeZoneWithAbbreviation:theTZName]; - if (!theTZ) theTZ = [NSTimeZone defaultTimeZone]; - } else { - // By default set the time zone to the local one.. - // Try to get the name using the previously available variable: - theSessionTZ = [self queryString:@"SHOW VARIABLES LIKE 'timezone'"]; - [theSessionTZ setReturnDataAsStrings:YES]; - [theSessionTZ dataSeek:0ULL]; - theRow = [theSessionTZ fetchRowAsArray]; - theTZName = [theRow objectAtIndex:1]; - if (theTZName) { - // Finally we found one ... - theTZ = [NSTimeZone timeZoneWithName:theTZName]; - if (!theTZ) theTZ = [NSTimeZone timeZoneWithAbbreviation:theTZName]; - if (!theTZ) theTZ = [NSTimeZone defaultTimeZone]; - } else { - theTZ = [NSTimeZone defaultTimeZone]; - //theTZ = [NSTimeZone systemTimeZone]; - NSLog(@"The time zone is not defined on the server, set it to the default one : %@", theTZ); - } - } - - if (theTZ != mTimeZone) { - [mTimeZone release]; - mTimeZone = [theTZ retain]; - } - } - - return mTimeZone; -} - -#pragma mark - -#pragma mark Packet size - -/** - * Retrieve the max_allowed_packet size from the server; returns - * false if the query fails. - */ -- (BOOL)fetchMaxAllowedPacket -{ - char *queryString; - - if ([self serverMajorVersion] == 3) queryString = "SHOW VARIABLES LIKE 'max_allowed_packet'"; - else queryString = "SELECT @@global.max_allowed_packet"; - - [self lockConnection]; - if (0 == mysql_query(mConnection, queryString)) { - if (mysql_field_count(mConnection) != 0) { - MCPResult *r = [[MCPResult alloc] initWithMySQLPtr:mConnection encoding:stringEncoding timeZone:mTimeZone]; - [r setReturnDataAsStrings:YES]; - NSArray *a = [r fetchRowAsArray]; - [r autorelease]; - if([a count]) { - [self unlockConnection]; - maxAllowedPacketSize = [[a objectAtIndex:([self serverMajorVersion] == 3)?1:0] integerValue]; - return true; - } - } - } - [self unlockConnection]; - - return false; -} - -/** - * Retrieves max_allowed_packet size set as global variable. - * It returns NSNotFound if it fails. - */ -- (NSUInteger)getMaxAllowedPacket -{ - MCPResult *r; - r = [self queryString:@"SELECT @@global.max_allowed_packet" usingEncoding:stringEncoding streamingResult:NO]; - if (![[self getLastErrorMessage] isEqualToString:@""]) { - if ([self isConnected]) { - NSString *errorMessage = [NSString stringWithFormat:@"An error occured while retrieving max_allowed_packet size:\n\n%@", [self getLastErrorMessage]]; - if ([delegate respondsToSelector:@selector(showErrorWithTitle:message:)]) - [delegate showErrorWithTitle:NSLocalizedString(@"Error", @"error") message:errorMessage]; - else - NSRunAlertPanel(@"Error", errorMessage, @"OK", nil, nil); - } - return NSNotFound; - } - NSArray *a = [r fetchRowAsArray]; - if([a count]) - return [[a objectAtIndex:0] integerValue]; - - return NSNotFound; -} - -/* - * It sets max_allowed_packet size to newSize and it returns - * max_allowed_packet after setting it to newSize for cross-checking - * if the maximal size was reached (e.g. set it to 4GB it'll return 1GB up to now). - * If something failed it return -1; - */ -- (NSUInteger)setMaxAllowedPacketTo:(NSUInteger)newSize resetSize:(BOOL)reset -{ - if(![self isMaxAllowedPacketEditable] || newSize < 1024) return maxAllowedPacketSize; - - [self lockConnection]; - mysql_query(mConnection, [[NSString stringWithFormat:@"SET GLOBAL max_allowed_packet = %lu", newSize] UTF8String]); - [self unlockConnection]; - - // Inform the user via a log entry about that change according to reset value - if(delegate && [delegate respondsToSelector:@selector(queryGaveError:connection:)]) { - if(reset) - [delegate queryGaveError:[NSString stringWithFormat:@"max_allowed_packet was reset to %lu for new session", newSize] connection:self]; - else - [delegate queryGaveError:[NSString stringWithFormat:@"Query too large; max_allowed_packet temporarily set to %lu for the current session to allow query to succeed", newSize] connection:self]; - } - - return maxAllowedPacketSize; -} - -/** - * It returns whether max_allowed_packet is setable for the user. - */ -- (BOOL)isMaxAllowedPacketEditable -{ - BOOL isEditable; - - [self lockConnection]; - isEditable = !mysql_query(mConnection, "SET GLOBAL max_allowed_packet = @@global.max_allowed_packet"); - [self unlockConnection]; - - return isEditable; -} - -#pragma mark - -#pragma mark Data conversion - -/** - * For internal use only. Transforms a NSString to a C type string (ending with \0) using the character set from the MCPConnection. - * Lossy conversions are enabled. - */ -- (const char *)cStringFromString:(NSString *)theString -{ - NSMutableData *theData; - - if (! theString) { - return (const char *)NULL; - } - - theData = [NSMutableData dataWithData:[theString dataUsingEncoding:stringEncoding allowLossyConversion:YES]]; - [theData increaseLengthBy:1]; - - return (const char *)[theData bytes]; -} - -/** - * Modified version of the original to support a supplied encoding. - * For internal use only. Transforms a NSString to a C type string (ending with \0). - * Lossy conversions are enabled. - */ -- (const char *)cStringFromString:(NSString *)theString usingEncoding:(NSStringEncoding)aStringEncoding -{ - NSMutableData *theData; - - if (! theString) { - return (const char *)NULL; - } - - theData = [NSMutableData dataWithData:[theString dataUsingEncoding:aStringEncoding allowLossyConversion:YES]]; - [theData increaseLengthBy:1]; - - return (const char *)[theData bytes]; -} - -/** - * Returns a NSString from a C style string encoded with the character set of theMCPConnection. - */ -- (NSString *)stringWithCString:(const char *)theCString -{ - NSData *theData; - NSString *theString; - - if (theCString == NULL) return @""; - - theData = [NSData dataWithBytes:theCString length:(strlen(theCString))]; - theString = [[NSString alloc] initWithData:theData encoding:stringEncoding]; - - if (theString) { - [theString autorelease]; - } - - return theString; -} - -/** - * Returns a NSString from a C style string. - */ -- (NSString *)stringWithCString:(const char *)theCString usingEncoding:(NSStringEncoding)aStringEncoding -{ - NSData *theData; - NSString *theString; - - if (theCString == NULL) return @""; - - theData = [NSData dataWithBytes:theCString length:(strlen(theCString))]; - theString = [[NSString alloc] initWithData:theData encoding:aStringEncoding]; - - if (theString) { - [theString autorelease]; - } - - return theString; -} - -/** - * Returns a NSString from a C style string encoded with the character set of theMCPConnection. - */ -- (NSString *)stringWithUTF8CString:(const char *)theCString -{ - NSData *theData; - NSString *theString; - - if (theCString == NULL) return @""; - - theData = [NSData dataWithBytes:theCString length:(strlen(theCString))]; - theString = [[NSString alloc] initWithData:theData encoding:NSUTF8StringEncoding]; - - if (theString) { - [theString autorelease]; - } - - return theString; -} - -/** - * Use the string encoding to convert the returned NSData to a string (for a Text field). - */ -- (NSString *)stringWithText:(NSData *)theTextData -{ - NSString *theString; - - if (theTextData == nil) return nil; - - theString = [[NSString alloc] initWithData:theTextData encoding:stringEncoding]; - - if (theString) { - [theString autorelease]; - } - - return theString; -} - -#pragma mark - - -/** - * Object deallocation. - */ -- (void) dealloc -{ - delegate = nil; - - // Ensure the query lock is unlocked, thereafter setting to nil in case of pending calls - if ([connectionLock condition] != MCPConnectionIdle) [self unlockConnection]; - [connectionLock release], connectionLock = nil; - - // Clean up connections if necessary - if (mConnected) [self disconnect]; - if (connectionProxy) { - [connectionProxy setConnectionStateChangeSelector:NULL delegate:nil]; - [connectionProxy disconnect]; - } - - [encoding release]; - if (previousEncoding) [previousEncoding release]; - [keepAliveTimer invalidate]; - [keepAliveTimer release]; - [NSObject cancelPreviousPerformRequestsWithTarget:self]; - if (lastQueryErrorMessage) [lastQueryErrorMessage release]; - if (connectionHost) [connectionHost release]; - if (connectionLogin) [connectionLogin release]; - if (connectionSocket) [connectionSocket release]; - if (connectionPassword) [connectionPassword release]; - if (sslKeyFilePath) [sslKeyFilePath release]; - if (sslCertificatePath) [sslCertificatePath release]; - if (sslCACertificatePath) [sslCACertificatePath release]; - if (serverVersionString) [serverVersionString release], serverVersionString = nil; - if (structure) [structure release], structure = nil; - if (allKeysofDbStructure) [allKeysofDbStructure release], allKeysofDbStructure = nil; - - [super dealloc]; -} - -@end - -@implementation MCPConnection (PrivateAPI) - -/** - * Retrieve connection variables and use them to update local variables - incuding - * server version string, server time zone, and the current connection encoding. - */ -- (void)_updateConnectionVariables -{ - if (!mConnected) return; - - // Retrieve all the variables from the server - MCPResult *theResult = [self queryString:@"SHOW VARIABLES"]; - [theResult setReturnDataAsStrings:YES]; - if (![theResult numOfRows]) return; - - // Step through the rows, converting into an NSDictionary - NSMutableDictionary *variables = [NSMutableDictionary new]; - NSArray *variableRow = nil; - while ((variableRow = [theResult fetchRowAsArray])) { - [variables setObject:[variableRow objectAtIndex:1] forKey:[variableRow objectAtIndex:0]]; - } - - // Get the version string - if (serverVersionString) [serverVersionString release], serverVersionString = nil; - if ([variables objectForKey:@"version"]) { - serverVersionString = [[NSString alloc] initWithString:[variables objectForKey:@"version"]]; - } - - // Get the timezone - NSString *serverTimeZoneName = nil; - NSTimeZone *serverTimeZone = nil; - if ([variables objectForKey:@"time_zone"] && ![[variables objectForKey:@"time_zone"] isNSNull]) { - if ([[variables objectForKey:@"time_zone"] isEqualToString:@"SYSTEM"]) { - if ([variables objectForKey:@"system_time_zone"]) { - serverTimeZoneName = [variables objectForKey:@"system_time_zone"]; - } - } else { - serverTimeZoneName = [variables objectForKey:@"time_zone"]; - } - } else if ([variables objectForKey:@"timezone"] && ![[variables objectForKey:@"timezone"] isNSNull]) { - serverTimeZoneName = [variables objectForKey:@"timezone"]; - } - if (!serverTimeZoneName) { - serverTimeZone = [NSTimeZone defaultTimeZone]; - NSLog(@"The time zone was not defined on the server, fallen back to default time zone: %@", serverTimeZone); - } else { - serverTimeZone = [NSTimeZone timeZoneWithName:serverTimeZoneName]; - if (!serverTimeZone) - serverTimeZone = [NSTimeZone timeZoneWithAbbreviation:serverTimeZoneName]; - if (!serverTimeZone) { - serverTimeZone = [NSTimeZone defaultTimeZone]; - NSLog(@"The time zone defined on the server (%@) was not recognised, fallen back to default time zone: %@", serverTimeZoneName, serverTimeZone); - } - } - - if (mTimeZone) [mTimeZone release], mTimeZone = nil; - mTimeZone = [serverTimeZone retain]; - - // Get the connection encoding - NSString *serverEncoding = @"latin1"; - if ([variables objectForKey:@"character_set_results"]) { - serverEncoding = [variables objectForKey:@"character_set_results"]; - } else if ([variables objectForKey:@"character_set"]) { - serverEncoding = [variables objectForKey:@"character_set"]; - } - if (encoding) [encoding release]; - encoding = [[NSString alloc] initWithString:serverEncoding]; - stringEncoding = [MCPConnection encodingForMySQLEncoding:[self cStringFromString:encoding]]; - encodingUsesLatin1Transport = NO; - - // Check the interactive timeout - if it's below five minutes, increase it to ten to imprive timeout/keepalive behaviour - if ([variables objectForKey:@"interactive_timeout"]) { - if ([[variables objectForKey:@"interactive_timeout"] integerValue] < 300) { - [self queryString:@"SET interactive_timeout=600"]; - } - } - - [variables release]; -} - -/** - * Determine whether the current host is reachable; essentially - * whether a connection is available (no packets should be sent) - */ -- (BOOL)_isCurrentHostReachable -{ - BOOL hostReachable; - SCNetworkConnectionFlags reachabilityStatus; - hostReachable = SCNetworkCheckReachabilityByName("dev.mysql.com", &reachabilityStatus); - - // If the function returned failure, also return failure. - if (!hostReachable) return NO; - - // Ensure that the network is reachable - if (!(reachabilityStatus & kSCNetworkFlagsReachable)) return NO; - - // Ensure that Airport is up/connected if present - if (reachabilityStatus & kSCNetworkFlagsConnectionRequired) return NO; - - // Return success - return YES; -} - -/** - * Set up the keepalive timer; this should be called on the main - * thread, to ensure the timer isn't descheduled when child threads - * terminate. - */ -- (void)_setupKeepalivePingTimer -{ - keepAliveTimer = [[NSTimer scheduledTimerWithTimeInterval:10 target:self selector:@selector(keepAlive:) userInfo:nil repeats:YES] retain]; -} -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPConnectionDelegate.h b/Frameworks/MCPKit/MCPFoundationKit/MCPConnectionDelegate.h deleted file mode 100644 index 0e162875..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPConnectionDelegate.h +++ /dev/null @@ -1,81 +0,0 @@ -// -// $Id$ -// -// MCPConnectionDelegate.h -// MCPKit -// -// Created by Stuart Connolly (stuconnolly.com) on October 20, 2010. -// Copyright (c) 2010 Stuart Connolly. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -@protocol MCPConnectionDelegate <NSObject> - -/** - * - * @param query - * @param connection - */ -- (void)willQueryString:(NSString *)query connection:(id)connection; - -/** - * - * @param error - * @param connection - */ -- (void)queryGaveError:(NSString *)error connection:(id)connection; - -/** - * - * - * @param error - * @param message - */ -- (void)showErrorWithTitle:(NSString *)error message:(NSString *)message; - -/** - * - * - * @param connection - */ -- (NSString *)keychainPasswordForConnection:(id)connection; - -/** - * - * - * @param connection - */ -- (NSString *)onReconnectShouldSelectDatabase:(id)connection; - -/** - * - * - * @param connection - */ -- (void)noConnectionAvailable:(id)connection; - -/** - * - * - * @param connection - */ -- (MCPConnectionCheck)connectionLost:(id)connection; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPConnectionProxy.h b/Frameworks/MCPKit/MCPFoundationKit/MCPConnectionProxy.h deleted file mode 100644 index f4edbfd8..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPConnectionProxy.h +++ /dev/null @@ -1,70 +0,0 @@ -// -// $Id$ -// -// MCPConnectionProxy.h -// MCPKit -// -// Created by Stuart Connolly (stuconnolly.com) on July 2, 2009. -// Copyright (c) 2009 Stuart Connolly. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -/** - * Connection proxy state constants. - */ -enum PROXY_TUNNEL_STATES -{ - PROXY_STATE_IDLE = 0, - PROXY_STATE_CONNECTING = 1, - PROXY_STATE_WAITING_FOR_AUTH = 2, - PROXY_STATE_CONNECTED = 3, - PROXY_STATE_FORWARDING_FAILED = 4 -}; - -@protocol MCPConnectionProxy <NSObject> - -/** - * Connect the proxy. - */ -- (void)connect; - -/** - * Disconnect the proxy. - */ -- (void)disconnect; - -/** - * Get the current state of the proxy. - */ -- (NSInteger)state; - -/** - * Get the local port being used by the proxy. - */ -- (NSUInteger)localPort; - -/** - * Sets the method the proxy should call whenever the state of the connection changes. - */ -- (BOOL)setConnectionStateChangeSelector:(SEL)theStateChangeSelector delegate:(id)theDelegate; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPConstants.h b/Frameworks/MCPKit/MCPFoundationKit/MCPConstants.h deleted file mode 100644 index fba7d651..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPConstants.h +++ /dev/null @@ -1,82 +0,0 @@ -// -// $Id$ -// -// MCPConstants.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 03/06/2001. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -// Result type constants -enum { - MCPTypeArray = 1, - MCPTypeDictionary = 2, - MCPTypeFlippedArray = 3, - MCPTypeFlippedDictionary = 4 -}; -typedef NSUInteger MCPReturnType; - -// Connection check constants -enum { - MCPConnectionCheckRetry = 0, - MCPConnectionCheckReconnect = 1, - MCPConnectionCheckDisconnect = 2 -}; -typedef NSUInteger MCPConnectionCheck; - -// Streaming result set constants -enum -{ - MCPStreamingNone = 0, - MCPStreamingFast = 1, - MCPStreamingLowMem = 2 -}; -typedef NSUInteger MCPQueryStreamingType; - -// Connection state -// This is used internally by MCPConnection to prevent simultaneous execution of different queries -enum { - MCPConnectionIdle = 0, - MCPConnectionBusy = 1 -}; - -// Charcater set mapping constants -typedef struct _OUR_CHARSET -{ - NSUInteger nr; - const char *name; - const char *collation; - NSUInteger char_minlen; - NSUInteger char_maxlen; -} OUR_CHARSET; - -// Deafult connection option -extern const NSUInteger kMCPConnectionDefaultOption; - -// Default socket (from the mysql.h used at compile time) -extern const char *kMCPConnectionDefaultSocket; - -// Added to MySQL error code -extern const NSUInteger kMCPConnectionNotInited; - -// The length of the truncation if required -extern const NSUInteger kLengthOfTruncationForLog; diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPFastQueries.h b/Frameworks/MCPKit/MCPFoundationKit/MCPFastQueries.h deleted file mode 100644 index e9ced5a0..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPFastQueries.h +++ /dev/null @@ -1,46 +0,0 @@ -// -// $Id$ -// -// MCPFastQueries.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 03/06/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -#import "MCPConnection.h" - -@interface MCPConnection (MCPFastQueries) - -// For insert queries, get directly the Id of the newly inserted row. -- (my_ulonglong)insertQuery:(NSString *)query; -- (my_ulonglong)updateQuery:(NSString *)query; - -// Returns directly a proper NS object, or a collection (NSArray, NSDictionary...). -- (id)getFirstFieldFromQuery:(NSString *)query; -- (id)getFirstRowFromQuery:(NSString *)query asType:(MCPReturnType)type; -- (id)getAllRowsFromQuery:(NSString *)query asType:(MCPReturnType)type; -- (NSArray *)getQuery:(NSString *)query colWithIndex:(NSUInteger)col; -- (NSArray *)getQuery:(NSString *)query colWithName:(NSString *)colName; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPFastQueries.m b/Frameworks/MCPKit/MCPFoundationKit/MCPFastQueries.m deleted file mode 100644 index c5f4d361..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPFastQueries.m +++ /dev/null @@ -1,113 +0,0 @@ -// -// $Id$ -// -// MCPFastQueries.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 03/06/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPFastQueries.h" -#import "MCPResultPlus.h" - -/** - * This actegory is made up to keep the extra methods out or the core of the framework. - * - * Basicly this is the place to add methods which are useful, but are just wrappers to the methods of the - * core (MCPConnection, MCPResult). The purpous being to have a single line call available for current tasks - * which otherwise would need a couple of lines and object defined. - */ -@implementation MCPConnection (MCPFastQueries) - -/** - * Send the query aQuery to the server and retrieve the row id if the table have a autoincrement column. - * Returns 0 if nothing have been inserted. - */ -- (my_ulonglong)insertQuery:(NSString *)query -{ - [self queryString:query]; - - return [self insertId]; -} - -/** - * Send the query aQuery to the server and retrieve the number of affected rows (should work with !{update}, - * !{delete}, !{insert} and !{select} type of queries). - * - * NB: This can also be used with a !{select} query if you are only interested in the number of row complying - * with the query; you'll get no chance to get the result from the query, except by sending the query - * again (with !{queryString:}) - */ -- (my_ulonglong)updateQuery:(NSString *)query -{ - [self queryString:query]; - - return [self affectedRows]; -} - -/** - * Get the first field of the first row of the result from the query (aQuery). Should return nil if no object - * at all are selected. - */ -- (id)getFirstFieldFromQuery:(NSString *)query -{ - return [[[self queryString:query] fetchRowAsType:MCPTypeArray] objectAtIndex:0]; -} - -/** - * Get the firdst row of the result from the query aQuery, in a collection of type determined by aType - * (MCPTypeArray or MCPTypeDictionary) - */ -- (id) getFirstRowFromQuery:(NSString *)query asType:(MCPReturnType)type -{ - return [[self queryString:query] fetchRowAsType:type]; -} - -/** - * Get a bidimensional table of the whole rows of the result from the query aQuery. The type of the result is - * choosen by aType, it can be (MCPTypeArray, MCPTypeDictionary, MCPTypeFlippedArray & MCPTypeFlippedDictionary). - * Description of the types can be found in method !{fetch2DResultAsType:}. - */ -- (id)getAllRowsFromQuery:(NSString *)query asType:(MCPReturnType)type - -{ - return [[self queryString:query] fetch2DResultAsType:type]; -} - -/** - * Get a column (as an NSArray) of the result from the query aQuery. The column is choosen from it's index, - * starting from 0. - */ -- (NSArray *)getQuery:(NSString *)query colWithIndex:(NSUInteger)col -{ - return [[self queryString:query] fetchColAtIndex:col]; -} - -/** - * Get a column (as an NSArray) of the result from the query aQuery. The column is choosen from it's name. - */ -- (NSArray *)getQuery:(NSString *)query colWithName:(NSString *)colName -{ - return [[self queryString:query] fetchColWithName:colName]; -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPGeometryData.h b/Frameworks/MCPKit/MCPFoundationKit/MCPGeometryData.h deleted file mode 100644 index 9af3fcfe..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPGeometryData.h +++ /dev/null @@ -1,65 +0,0 @@ -// -// $Id$ -// -// MCPGeometryData.h -// sequel-pro -// -// Created by Hans-Jörg Bibiko on October 07, 2010 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Cocoa/Cocoa.h> -#import <Foundation/Foundation.h> - -enum wkbType -{ - wkb_point = 1, - wkb_linestring = 2, - wkb_polygon = 3, - wkb_multipoint = 4, - wkb_multilinestring = 5, - wkb_multipolygon = 6, - wkb_geometrycollection = 7 -}; - -typedef struct st_point_2d_ -{ - double x; - double y; -} st_point_2d; - -@interface MCPGeometryData : NSObject -{ - // Holds the WKB bytes coming from SQL server - Byte *geoBuffer; - - // Holds the buffer length - NSUInteger bufferLength; - -} - -- (id)initWithBytes:(const void *)geoData length:(NSUInteger)length; -+ (id)dataWithBytes:(const void *)geoData length:(NSUInteger)length; -- (NSString*)description; -- (NSUInteger)length; -- (NSData*)data; -- (NSString*)wktString; -- (NSDictionary*)coordinates; -- (NSInteger)wkbType; -- (NSString*)wktType; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPGeometryData.m b/Frameworks/MCPKit/MCPFoundationKit/MCPGeometryData.m deleted file mode 100644 index b7a3fd09..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPGeometryData.m +++ /dev/null @@ -1,785 +0,0 @@ -// -// $Id$ -// -// MCPGeometryData.m -// sequel-pro -// -// Created by Hans-Jörg Bibiko on October 07, 2010 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPGeometryData.h" - -#define SIZEOF_STORED_UINT32 4 -#define SIZEOF_STORED_DOUBLE 8 -#define POINT_DATA_SIZE (SIZEOF_STORED_DOUBLE*2) -#define WKB_HEADER_SIZE (1+SIZEOF_STORED_UINT32) -#define BUFFER_START 0 - -@implementation MCPGeometryData - -/** - * Initialize the MCPGeometryData object - */ -- (id)init -{ - if ((self = [super init])) { - geoBuffer = nil; - bufferLength = 0; - } - return self; -} - -/** - * Initialize the MCPGeometryData object with the WKB data - */ -- (id)initWithBytes:(const void *)geoData length:(NSUInteger)length -{ - if ((self = [self init])) { - bufferLength = length; - geoBuffer = malloc(bufferLength); - memcpy(geoBuffer, geoData, bufferLength); - } - return self; -} - -/** - * Return an autorelease MCPGeometryData object - */ -+ (id)dataWithBytes:(const void *)geoData length:(NSUInteger)length -{ - return [[[MCPGeometryData alloc] initWithBytes:geoData length:length] autorelease]; -} - -/** - * copyWithZone - */ -- (id)copyWithZone:(NSZone *)zone -{ - return [self retain]; -} - -/** - * Return the hex representation of the WKB buffer (only for convenience) - */ -- (NSString*)description -{ - return [[NSData dataWithBytes:geoBuffer length:bufferLength] description]; -} - -/** - * Return the length of the WKB buffer - */ -- (NSUInteger)length -{ - return bufferLength; -} - -/** - * Return NSData pointer of the WKB buffer - */ -- (NSData*)data -{ - return [NSData dataWithBytes:geoBuffer length:bufferLength]; -} - -/** - * Return a human readable WKT string of the internal format (it imitate the SQL function AsText()). - */ -- (NSString*)wktString -{ - char byteOrder; - uint32_t geoType, numberOfItems, numberOfSubItems, numberOfSubSubItems, numberOfCollectionItems; - int32_t srid; - st_point_2d aPoint; - - uint32_t i, j, k, n; // Loop counter for numberOf...Items - uint32_t ptr = BUFFER_START; // pointer to geoBuffer while parsing - - NSMutableString *wkt = [NSMutableString string]; - - if (bufferLength < WKB_HEADER_SIZE) - return @""; - - memcpy(&srid, &geoBuffer[0], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - - byteOrder = geoBuffer[ptr]; - - if(byteOrder != 0x1) - return @"Byte order not yet supported"; - - ptr++; - geoType = geoBuffer[ptr]; - ptr += SIZEOF_STORED_UINT32; - - switch(geoType) { - - case wkb_point: - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - return [NSString stringWithFormat:@"POINT(%.16g %.16g)%@", aPoint.x, aPoint.y, (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - break; - - case wkb_linestring: - [wkt setString:@"LINESTRING("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (i < numberOfItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - [wkt appendFormat:@")%@", (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - return wkt; - break; - - case wkb_polygon: - [wkt setString:@"POLYGON("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (j < numberOfSubItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - [wkt appendFormat:@")%@", (i < numberOfItems-1) ? @"," : @""]; - } - [wkt appendFormat:@")%@", (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - return wkt; - break; - - case wkb_multipoint: - [wkt setString:@"MULTIPOINT("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (i < numberOfItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE+WKB_HEADER_SIZE; - } - [wkt appendFormat:@")%@", (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - return wkt; - break; - - case wkb_multilinestring: - [wkt setString:@"MULTILINESTRING("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (j < numberOfSubItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - ptr += WKB_HEADER_SIZE; - [wkt appendFormat:@")%@", (i < numberOfItems-1) ? @"," : @""]; - } - [wkt appendFormat:@")%@", (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - return wkt; - break; - - case wkb_multipolygon: - [wkt setString:@"MULTIPOLYGON("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&numberOfSubSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(k=0; k < numberOfSubSubItems; k++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (k < numberOfSubSubItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - [wkt appendFormat:@")%@", (j < numberOfSubItems-1) ? @"," : @""]; - } - ptr += WKB_HEADER_SIZE; - [wkt appendFormat:@")%@", (i < numberOfItems-1) ? @"," : @""]; - } - [wkt appendFormat:@")%@", (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - return wkt; - break; - - case wkb_geometrycollection: - [wkt setString:@"GEOMETRYCOLLECTION("]; - numberOfCollectionItems = geoBuffer[ptr]; - ptr += SIZEOF_STORED_UINT32; - - for(n=0; n < numberOfCollectionItems; n++) { - - byteOrder = geoBuffer[ptr]; - - if(byteOrder != 0x1) - return @"Byte order not yet supported"; - - ptr++; - geoType = geoBuffer[ptr]; - ptr += SIZEOF_STORED_UINT32; - - switch(geoType) { - - case wkb_point: - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"POINT(%.16g %.16g)", aPoint.x, aPoint.y]; - ptr += POINT_DATA_SIZE; - break; - - case wkb_linestring: - [wkt appendString:@"LINESTRING("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (i < numberOfItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - [wkt appendString:@")"]; - break; - - case wkb_polygon: - [wkt appendString:@"POLYGON("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (j < numberOfSubItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - [wkt appendFormat:@")%@", (i < numberOfItems-1) ? @"," : @""]; - } - [wkt appendString:@")"]; - break; - - case wkb_multipoint: - [wkt appendString:@"MULTIPOINT("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (i < numberOfItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE+WKB_HEADER_SIZE; - } - ptr -= WKB_HEADER_SIZE; - [wkt appendString:@")"]; - break; - - case wkb_multilinestring: - [wkt appendString:@"MULTILINESTRING("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (j < numberOfSubItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - ptr += WKB_HEADER_SIZE; - [wkt appendFormat:@")%@", (i < numberOfItems-1) ? @"," : @""]; - } - ptr -= WKB_HEADER_SIZE; - [wkt appendString:@")"]; - break; - - case wkb_multipolygon: - [wkt appendString:@"MULTIPOLYGON("]; - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&numberOfSubSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - [wkt appendString:@"("]; - for(k=0; k < numberOfSubSubItems; k++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - [wkt appendFormat:@"%.16g %.16g%@", aPoint.x, aPoint.y, (k < numberOfSubSubItems-1) ? @"," : @""]; - ptr += POINT_DATA_SIZE; - } - [wkt appendFormat:@")%@", (j < numberOfSubItems-1) ? @"," : @""]; - } - ptr += WKB_HEADER_SIZE; - [wkt appendFormat:@")%@", (i < numberOfItems-1) ? @"," : @""]; - } - ptr -= WKB_HEADER_SIZE; - [wkt appendString:@")"]; - break; - - default: - return @"Error geometrycollection type parsing"; - } - [wkt appendString:(n < numberOfCollectionItems-1) ? @"," : @""]; - } - [wkt appendFormat:@")%@", (srid) ? [NSString stringWithFormat:@",%d",srid]: @""]; - return wkt; - break; - - default: - return @"Error geometry type parsing"; - } - return @"Error while parsing"; -} - -/** - * Return a dictionary of coordinates, bbox, etc. to be able to draw the given geometry. - * - * @return A dictionary having the following keys: "bbox" as NSArray of NSNumbers of x_min x_max y_min y_max, "coordinates" as NSArray containing the - * the to be drawn points as NSPoint strings, "type" as NSString - */ -- (NSDictionary*)coordinates -{ - - char byteOrder; - uint32_t geoType, numberOfItems, numberOfSubItems, numberOfSubSubItems, numberOfCollectionItems; - int32_t srid; - st_point_2d aPoint; - - uint32_t i, j, k, n; // Loop counter for numberOf...Items - uint32_t ptr = BUFFER_START; // pointer to geoBuffer while parsing - - double x_min = DBL_MAX; - double x_max = -DBL_MAX; - double y_min = DBL_MAX; - double y_max = -DBL_MAX; - - NSMutableArray *coordinates = [NSMutableArray array]; - NSMutableArray *subcoordinates = [NSMutableArray array]; - NSMutableArray *pointcoordinates = [NSMutableArray array]; - NSMutableArray *linecoordinates = [NSMutableArray array]; - NSMutableArray *linesubcoordinates = [NSMutableArray array]; - NSMutableArray *polygoncoordinates = [NSMutableArray array]; - NSMutableArray *polygonsubcoordinates = [NSMutableArray array]; - - if (bufferLength < WKB_HEADER_SIZE) - return nil; - - memcpy(&srid, &geoBuffer[0], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - - byteOrder = geoBuffer[ptr]; - - if(byteOrder != 0x1) - return nil; - - ptr++; - geoType = geoBuffer[ptr]; - ptr += SIZEOF_STORED_UINT32; - - switch(geoType) { - - case wkb_point: - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = aPoint.x; - x_max = aPoint.x; - y_min = aPoint.y; - y_max = aPoint.y; - [coordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - coordinates, @"coordinates", - [NSNumber numberWithInt:srid], @"srid", - @"POINT", @"type", - nil]; - break; - - case wkb_linestring: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [coordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - [NSArray arrayWithObjects:coordinates,nil], @"coordinates", - @"LINESTRING", @"type", - nil]; - break; - - case wkb_polygon: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [subcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - [coordinates addObject:[[subcoordinates copy] autorelease]]; - [subcoordinates removeAllObjects]; - } - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - coordinates, @"coordinates", - [NSNumber numberWithInt:srid], @"srid", - @"POLYGON", @"type", - nil]; - break; - - case wkb_multipoint: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [coordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE+WKB_HEADER_SIZE; - } - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - coordinates, @"coordinates", - [NSNumber numberWithInt:srid], @"srid", - @"MULTIPOINT", @"type", - nil]; - break; - - case wkb_multilinestring: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [subcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - ptr += WKB_HEADER_SIZE; - [coordinates addObject:[[subcoordinates copy] autorelease]]; - [subcoordinates removeAllObjects]; - } - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - coordinates, @"coordinates", - [NSNumber numberWithInt:srid], @"srid", - @"MULTILINESTRING", @"type", - nil]; - break; - - case wkb_multipolygon: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&numberOfSubSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(k=0; k < numberOfSubSubItems; k++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [subcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - [coordinates addObject:[[subcoordinates copy] autorelease]]; - [subcoordinates removeAllObjects]; - } - ptr += WKB_HEADER_SIZE; - } - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - coordinates, @"coordinates", - [NSNumber numberWithInt:srid], @"srid", - @"MULTIPOLYGON", @"type", - nil]; - break; - - case wkb_geometrycollection: - numberOfCollectionItems = geoBuffer[ptr]; - ptr += SIZEOF_STORED_UINT32; - - for(n=0; n < numberOfCollectionItems; n++) { - - byteOrder = geoBuffer[ptr]; - - if(byteOrder != 0x1) - return nil; - - ptr++; - geoType = geoBuffer[ptr]; - ptr += SIZEOF_STORED_UINT32; - - switch(geoType) { - - case wkb_point: - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [pointcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - break; - - case wkb_linestring: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [linesubcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - [linecoordinates addObject:[[linesubcoordinates copy] autorelease]]; - [linesubcoordinates removeAllObjects]; - break; - - case wkb_polygon: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [polygonsubcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - [polygoncoordinates addObject:[[polygonsubcoordinates copy] autorelease]]; - [polygonsubcoordinates removeAllObjects]; - } - break; - - case wkb_multipoint: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [pointcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE+WKB_HEADER_SIZE; - } - ptr -= WKB_HEADER_SIZE; - break; - - case wkb_multilinestring: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [linesubcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - [linecoordinates addObject:[[linesubcoordinates copy] autorelease]]; - [linesubcoordinates removeAllObjects]; - ptr += WKB_HEADER_SIZE; - } - ptr -= WKB_HEADER_SIZE; - break; - - case wkb_multipolygon: - memcpy(&numberOfItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32+WKB_HEADER_SIZE; - for(i=0; i < numberOfItems; i++) { - memcpy(&numberOfSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(j=0; j < numberOfSubItems; j++) { - memcpy(&numberOfSubSubItems, &geoBuffer[ptr], SIZEOF_STORED_UINT32); - ptr += SIZEOF_STORED_UINT32; - for(k=0; k < numberOfSubSubItems; k++) { - memcpy(&aPoint, &geoBuffer[ptr], POINT_DATA_SIZE); - x_min = (aPoint.x < x_min) ? aPoint.x : x_min; - x_max = (aPoint.x > x_max) ? aPoint.x : x_max; - y_min = (aPoint.y < y_min) ? aPoint.y : y_min; - y_max = (aPoint.y > y_max) ? aPoint.y : y_max; - [polygonsubcoordinates addObject:NSStringFromPoint(NSMakePoint((CGFloat)aPoint.x, (CGFloat)aPoint.y))]; - ptr += POINT_DATA_SIZE; - } - [polygoncoordinates addObject:[[polygonsubcoordinates copy] autorelease]]; - [polygonsubcoordinates removeAllObjects]; - } - ptr += WKB_HEADER_SIZE; - } - ptr -= WKB_HEADER_SIZE; - break; - - default: - return nil; - } - } - return [NSDictionary dictionaryWithObjectsAndKeys: - [NSArray arrayWithObjects: - [NSNumber numberWithDouble:x_min], - [NSNumber numberWithDouble:x_max], - [NSNumber numberWithDouble:y_min], - [NSNumber numberWithDouble:y_max], - nil], @"bbox", - [NSArray arrayWithObjects:pointcoordinates, linecoordinates, polygoncoordinates, nil], @"coordinates", - @"GEOMETRYCOLLECTION", @"type", - nil]; - break; - - default: - return nil; - } - return nil; -} - -/** - * Return the WKB type of the geoBuffer ie if buffer represents a POINT, LINESTRING, etc. - * according to stored wkbType in header file. It returns -1 if an error occurred. - */ -- (NSInteger)wkbType -{ - char byteOrder; - UInt32 geoType; - - NSUInteger ptr = BUFFER_START; // pointer to geoBuffer while parsing - - if (bufferLength < WKB_HEADER_SIZE) - return -1; - - byteOrder = geoBuffer[ptr]; - - if(byteOrder != 0x1) - return -1; - - ptr++; - geoType = geoBuffer[ptr]; - - if(geoType > 0 && geoType < 8) - return geoType; - else - return -1; - -} - -/** - * Return the WKT type of the geoBuffer ie if buffer represents a POINT, LINESTRING, etc. - * according to stored wkbType in header file. It returns nil if an error occurred. - */ -- (NSString*)wktType -{ - switch([self wkbType]) - { - case wkb_point: - return @"POINT"; - case wkb_linestring: - return @"LINESTRING"; - case wkb_polygon: - return @"POLYGON"; - case wkb_multipoint: - return @"MULTIPOINT"; - case wkb_multilinestring: - return @"MULTILINESTRING"; - case wkb_multipolygon: - return @"MULTIPOLYGON"; - case wkb_geometrycollection: - return @"GEOMETRYCOLLECTION"; - default: - return nil; - } - return nil; -} - -/** - * dealloc - */ -- (void)dealloc -{ - if(geoBuffer && bufferLength) free(geoBuffer); - [super dealloc]; -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPKit.h b/Frameworks/MCPKit/MCPFoundationKit/MCPKit.h deleted file mode 100644 index 57e6d62d..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPKit.h +++ /dev/null @@ -1,44 +0,0 @@ -// -// $Id$ -// -// MCPKit.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2001. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -#import <MCPKit/MCPConstants.h> -#import <MCPKit/MCPNull.h> -#import <MCPKit/MCPResult.h> -#import <MCPKit/MCPStreamingResult.h> -#import <MCPKit/MCPConnection.h> -#import <MCPKit/MCPNumber.h> -#import <MCPKit/MCPResultPlus.h> -#import <MCPKit/MCPFastQueries.h> -#import <MCPKit/MCPGeometryData.h> - -#import <MCPKit/MCPConnectionProxy.h> -#import <MCPKit/MCPConnectionDelegate.h> - -#import "mysql.h" diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPNull.h b/Frameworks/MCPKit/MCPFoundationKit/MCPNull.h deleted file mode 100644 index 500e0cf8..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPNull.h +++ /dev/null @@ -1,35 +0,0 @@ -// -// $Id$ -// -// MCPNull.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 02/06/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -@interface NSObject (MCPNSNullTest) - -- (BOOL)isNSNull; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPNull.m b/Frameworks/MCPKit/MCPFoundationKit/MCPNull.m deleted file mode 100644 index 4232fb2a..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPNull.m +++ /dev/null @@ -1,43 +0,0 @@ -// -// $Id$ -// -// MCPNull.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 02/06/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPNull.h" - -@implementation NSObject (MCPNSNullTest) - -/** - * This Category is meant to make any kind of object the possible target to the test (isNSNull). - */ -- (BOOL) isNSNull -{ - static id NSNullForComparison; - if (!NSNullForComparison) NSNullForComparison = [NSNull null]; - return (self == NSNullForComparison); -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPNumber.h b/Frameworks/MCPKit/MCPFoundationKit/MCPNumber.h deleted file mode 100644 index 8be1dd8b..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPNumber.h +++ /dev/null @@ -1,83 +0,0 @@ -// -// $Id$ -// -// MCPNumber.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -@interface MCPNumber : NSNumber -{ - const char *typeCode; - NSNumber *number; -} - -+ (MCPNumber *)numberWithChar:(char)value; -+ (MCPNumber *)numberWithUnsignedChar:(unsigned char)value; -+ (MCPNumber *)numberWithShort:(short)value; -+ (MCPNumber *)numberWithUnsignedShort:(unsigned short)value; -+ (MCPNumber *)numberWithInt:(int)value; -+ (MCPNumber *)numberWithUnsignedInt:(unsigned int)value; -+ (MCPNumber *)numberWithLong:(long)value; -+ (MCPNumber *)numberWithUnsignedLong:(unsigned long)value; -+ (MCPNumber *)numberWithLongLong:(long long)value; -+ (MCPNumber *)numberWithUnsignedLongLong:(unsigned long long)value; -+ (MCPNumber *)numberWithFloat:(float)value; -+ (MCPNumber *)numberWithDouble:(double)value; -+ (MCPNumber *)numberWithBool:(BOOL)value; - -- (id)initWithChar:(char)value; -- (id)initWithUnsignedChar:(unsigned char)value; -- (id)initWithShort:(short)value; -- (id)initWithUnsignedShort:(unsigned short)value; -- (id)initWithInt:(int)value; -- (id)initWithUnsignedInt:(unsigned int)value; -- (id)initWithLong:(long)value; -- (id)initWithUnsignedLong:(unsigned long)value; -- (id)initWithLongLong:(long long)value; -- (id)initWithUnsignedLongLong:(unsigned long long)value; -- (id)initWithFloat:(float)value; -- (id)initWithDouble:(double)value; -- (id)initWithBool:(BOOL)value; - -// Important NSNumber primitive methods -- (const char *)objCType; -- (void)getValue:(void *)buffer; - -- (char)charValue; -- (unsigned char)unsignedCharValue; -- (short)shortValue; -- (unsigned short)unsignedShortValue; -- (int)intValue; -- (unsigned int)unsignedIntValue; -- (long)longValue; -- (unsigned long)unsignedLongValue; -- (long long)longLongValue; -- (unsigned long long)unsignedLongLongValue; -- (float)floatValue; -- (double)doubleValue; -- (BOOL)boolValue; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPNumber.m b/Frameworks/MCPKit/MCPFoundationKit/MCPNumber.m deleted file mode 100644 index de035ee8..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPNumber.m +++ /dev/null @@ -1,301 +0,0 @@ -// -// $Id$ -// -// MCPNumber.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPNumber.h" - -@implementation MCPNumber - -#pragma mark - -#pragma mark 'Creator' class methods - -+ (MCPNumber *)numberWithChar:(char)value -{ - return [[[MCPNumber alloc] initWithChar:value] autorelease]; -} - -+ (MCPNumber *)numberWithUnsignedChar:(unsigned char)value -{ - return [[[MCPNumber alloc] initWithUnsignedChar:value] autorelease]; -} - -+ (MCPNumber *)numberWithShort:(short)value -{ - return [[[MCPNumber alloc] initWithShort:value] autorelease]; -} - -+ (MCPNumber *)numberWithUnsignedShort:(unsigned short)value -{ - return [[[MCPNumber alloc] initWithUnsignedShort:value] autorelease]; -} - -+ (MCPNumber *)numberWithInt:(int)value -{ - return [[[MCPNumber alloc] initWithInteger:value] autorelease]; -} - -+ (MCPNumber *)numberWithUnsignedInt:(unsigned int)value -{ - return [[[MCPNumber alloc] initWithUnsignedInteger:value] autorelease]; -} - -+ (MCPNumber *)numberWithLong:(long)value -{ - return [[[MCPNumber alloc] initWithLong:value] autorelease]; -} - -+ (MCPNumber *)numberWithUnsignedLong:(unsigned long)value -{ - return [[[MCPNumber alloc] initWithUnsignedLong:value] autorelease]; -} - -+ (MCPNumber *)numberWithLongLong:(long long)value -{ - return [[[MCPNumber alloc] initWithLongLong:value] autorelease]; -} - -+ (MCPNumber *)numberWithUnsignedLongLong:(unsigned long long)value -{ - return [[[MCPNumber alloc] initWithUnsignedLongLong:value] autorelease]; -} - -+ (MCPNumber *)numberWithFloat:(float)value -{ - return [[[MCPNumber alloc] initWithDouble:value] autorelease]; -} - -+ (MCPNumber *)numberWithDouble:(double)value -{ - return [[[MCPNumber alloc] initWithDouble:value] autorelease]; -} - -+ (MCPNumber *)numberWithBool:(BOOL)value -{ - return [[[MCPNumber alloc] initWithBool:value] autorelease]; -} - -#pragma mark - -#pragma mark Initialilzers - -- (id)initWithChar:(char)value -{ - typeCode = @encode(char); - number = [[NSNumber alloc] initWithChar:value]; - - return self; -} - -- (id)initWithUnsignedChar:(unsigned char)value -{ - typeCode = @encode(unsigned char); - number = [[NSNumber alloc] initWithUnsignedChar:value]; - - return self; -} - -- (id)initWithShort:(short)value -{ - typeCode = @encode(short); - number = [[NSNumber alloc] initWithShort:value]; - - return self; -} - -- (id)initWithUnsignedShort:(unsigned short)value -{ - typeCode = @encode(unsigned short); - number = [[NSNumber alloc] initWithUnsignedShort:value]; - - return self; -} - -- (id)initWithInt:(int)value -{ - typeCode = @encode(NSInteger); - number = [[NSNumber alloc] initWithInteger:value]; - - return self; -} - -- (id)initWithUnsignedInt:(unsigned int)value -{ - typeCode = @encode(NSUInteger); - number = [[NSNumber alloc] initWithUnsignedInteger:value]; - - return self; -} - -- (id)initWithLong:(long) value -{ - typeCode = @encode(long); - number = [[NSNumber alloc] initWithLong:value]; - - return self; -} - -- (id)initWithUnsignedLong:(unsigned long)value -{ - typeCode = @encode(unsigned long); - number = [[NSNumber alloc] initWithUnsignedLong:value]; - - return self; -} - -- (id)initWithLongLong:(long long)value -{ - typeCode = @encode(long long); - number = [[NSNumber alloc] initWithLongLong:value]; - - return self; -} - -- (id)initWithUnsignedLongLong:(unsigned long long)value -{ - typeCode = @encode(unsigned long long); - number = [[NSNumber alloc] initWithUnsignedLongLong:value]; - - return self; -} - -- (id)initWithFloat:(float)value -{ - typeCode = @encode(CGFloat); - number = [[NSNumber alloc] initWithDouble:value]; - - return self; -} - -- (id)initWithDouble:(double)value -{ - typeCode = @encode(double); - number = [[NSNumber alloc] initWithDouble:value]; - - return self; -} - -- (id)initWithBool:(BOOL)value -{ - typeCode = @encode(BOOL); - number = [[NSNumber alloc] initWithBool:value]; - - return self; -} - -#pragma mark - -#pragma mark NSValue primitive methods - -- (const char *)objCType -{ - return typeCode; -} - -- (void)getValue:(void *)buffer -{ - [number getValue:buffer]; -} - -#pragma mark - -#pragma mark NSNumber primitive methods - -/** - * Reparing the absence of primitive methodes in NSNumber - */ -- (char)charValue -{ - return [number charValue]; -} - -- (unsigned char)unsignedCharValue -{ - return [number unsignedCharValue]; -} - -- (short)shortValue -{ - return [number shortValue]; -} - -- (unsigned short)unsignedShortValue -{ - return [number unsignedShortValue]; -} - -- (int)intValue -{ - return [number intValue]; -} - -- (unsigned int)unsignedIntValue -{ - return [number unsignedIntValue]; -} - -- (long)longValue -{ - return [number longValue]; -} - -- (unsigned long)unsignedLongValue -{ - return [number unsignedLongValue]; -} - -- (long long)longLongValue -{ - return [number longLongValue]; -} - -- (unsigned long long)unsignedLongLongValue -{ - return [number unsignedLongLongValue]; -} - -- (float)floatValue -{ - return [number floatValue]; -} - -- (double)doubleValue -{ - return [number doubleValue]; -} - -- (BOOL)boolValue -{ - return [number boolValue]; -} - -#pragma mark - - -- (void)dealloc -{ - [number release]; - - [super dealloc]; -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPResult.h b/Frameworks/MCPKit/MCPFoundationKit/MCPResult.h deleted file mode 100644 index ad50af75..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPResult.h +++ /dev/null @@ -1,86 +0,0 @@ -// -// $Id$ -// -// MCPResult.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -#import "MCPConstants.h" -#import "mysql.h" - -#define MAGIC_BINARY_CHARSET_NR 63 - -@interface MCPResult : NSObject -{ - MYSQL_RES *mResult; /* The MYSQL_RES structure of the C API. */ - NSArray *mNames; /* An NSArray holding the name of the columns. */ - NSStringEncoding mEncoding; /* The encoding used by MySQL server, to ISO-1 default. */ - NSUInteger mNumOfFields; /* The number of fields in the result. */ - NSTimeZone *mTimeZone; /* The time zone of the connection when the query was made. */ - BOOL mReturnDataAsStrings; /* Whether to return data types as strings */ -} - -// Initialization -- (id)initWithMySQLPtr:(MYSQL *)mySQLPtr encoding:(NSStringEncoding)theEncoding timeZone:(NSTimeZone *)iTimeZone; -- (id)initWithResPtr:(MYSQL_RES *)mySQLResPtr encoding:(NSStringEncoding)theEncoding timeZone:(NSTimeZone *)iTimeZone; - -// Result info -- (my_ulonglong)numOfRows; -- (NSUInteger)numOfFields; - -// Rows -- (void)dataSeek:(my_ulonglong)row; -- (id)fetchRowAsType:(MCPReturnType) aType; -- (NSArray *)fetchRowAsArray; -- (NSDictionary *)fetchRowAsDictionary; - -// Columns -- (NSArray *)fetchFieldNames; -- (id)fetchTypesAsType:(MCPReturnType)aType; -- (NSArray *)fetchTypesAsArray; -- (NSDictionary *)fetchTypesAsDictionary; -- (NSArray *)fetchResultFieldsStructure; - -- (NSUInteger)fetchFlagsAtIndex:(NSUInteger)index; -- (NSUInteger)fetchFlagsForKey:(NSString *)key; - -- (BOOL)isBlobAtIndex:(NSUInteger)index; -- (BOOL)isBlobForKey:(NSString *)key; - -// Conversion -- (void) setReturnDataAsStrings:(BOOL)alwaysConvertData; -- (NSString *)stringWithText:(NSData *)theTextData; -- (const char *)cStringFromString:(NSString *)theString; -- (NSString *)stringWithCString:(const char *)theCString; - -// Other -- (NSString *)mysqlTypeToStringForType:(NSUInteger)type withCharsetNr:(NSUInteger)charsetnr withFlags:(NSUInteger)flags withLength:(unsigned long long)length; -- (NSString *)mysqlTypeToGroupForType:(NSUInteger)type withCharsetNr:(NSUInteger)charsetnr withFlags:(NSUInteger)flags; -- (NSString *)findCharsetName:(NSUInteger)charsetnr; -- (NSString *)findCharsetCollation:(NSUInteger)charsetnr; -- (NSUInteger)findCharsetMaxByteLengthPerChar:(NSUInteger)charsetnr; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPResult.m b/Frameworks/MCPKit/MCPFoundationKit/MCPResult.m deleted file mode 100644 index f112a02d..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPResult.m +++ /dev/null @@ -1,1354 +0,0 @@ -// -// $Id$ -// -// MCPResult.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 08/12/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPConnection.h" -#import "MCPNull.h" -#import "MCPNumber.h" -#import "MCPResult.h" -#import "MCPGeometryData.h" - -NSCalendarDate *MCPYear0000; - -const OUR_CHARSET our_charsets60[] = -{ - {1, "big5","big5_chinese_ci", 1, 2}, - {3, "dec8", "dec8_swedisch_ci", 1, 1}, - {4, "cp850", "cp850_general_ci", 1, 1}, - {6, "hp8", "hp8_english_ci", 1, 1}, - {7, "koi8r", "koi8r_general_ci", 1, 1}, - {8, "latin1", "latin1_swedish_ci", 1, 1}, - {9, "latin2", "latin2_general_ci", 1, 1}, - {10, "swe7", "swe7_swedish_ci", 1, 1}, - {11, "ascii", "ascii_general_ci", 1, 1}, - {12, "ujis", "ujis_japanese_ci", 1, 3}, - {13, "sjis", "sjis_japanese_ci", 1, 2}, - {16, "hebrew", "hebrew_general_ci", 1, 1}, - {18, "tis620", "tis620_thai_ci", 1, 1}, - {19, "euckr", "euckr_korean_ci", 1, 2}, - {22, "koi8u", "koi8u_general_ci", 1, 1}, - {24, "gb2312", "gb2312_chinese_ci", 1, 2}, - {25, "greek", "greek_general_ci", 1, 1}, - {26, "cp1250", "cp1250_general_ci", 1, 1}, - {28, "gbk", "gbk_chinese_ci", 1, 2}, - {30, "latin5", "latin5_turkish_ci", 1, 1}, - {32, "armscii8", "armscii8_general_ci", 1, 1}, - {33, "utf8", "utf8_general_ci", 1, 3}, - {35, "ucs2", "ucs2_general_ci", 2, 2}, - {36, "cp866", "cp866_general_ci", 1, 1}, - {37, "keybcs2", "keybcs2_general_ci", 1, 1}, - {38, "macce", "macce_general_ci", 1, 1}, - {39, "macroman", "macroman_general_ci", 1, 1}, - {40, "cp852", "cp852_general_ci", 1, 1}, - {41, "latin7", "latin7_general_ci", 1, 1}, - {51, "cp1251", "cp1251_general_ci", 1, 1}, - {57, "cp1256", "cp1256_general_ci", 1, 1}, - {59, "cp1257", "cp1257_general_ci", 1, 1}, - {63, "binary", "binary", 1, 1}, - {92, "geostd8", "geostd8_general_ci", 1, 1}, - {95, "cp932", "cp932_japanese_ci", 1, 2}, - {97, "eucjpms", "eucjpms_japanese_ci", 1, 3}, - {2, "latin2", "latin2_czech_cs", 1, 1}, - {5, "latin1", "latin1_german_ci", 1, 1}, - {14, "cp1251", "cp1251_bulgarian_ci", 1, 1}, - {15, "latin1", "latin1_danish_ci", 1, 1}, - {17, "filename", "filename", 1, 5}, - {20, "latin7", "latin7_estonian_cs", 1, 1}, - {21, "latin2", "latin2_hungarian_ci", 1, 1}, - {23, "cp1251", "cp1251_ukrainian_ci", 1, 1}, - {27, "latin2", "latin2_croatian_ci", 1, 1}, - {29, "cp1257", "cp1257_lithunian_ci", 1, 1}, - {31, "latin1", "latin1_german2_ci", 1, 1}, - {34, "cp1250", "cp1250_czech_cs", 1, 1}, - {42, "latin7", "latin7_general_cs", 1, 1}, - {43, "macce", "macce_bin", 1, 1}, - {44, "cp1250", "cp1250_croatian_ci", 1, 1}, - {45, "utf8", "utf8_general_ci", 1, 1}, - {46, "utf8", "utf8_bin", 1, 1}, - {47, "latin1", "latin1_bin", 1, 1}, - {48, "latin1", "latin1_general_ci", 1, 1}, - {49, "latin1", "latin1_general_cs", 1, 1}, - {50, "cp1251", "cp1251_bin", 1, 1}, - {52, "cp1251", "cp1251_general_cs", 1, 1}, - {53, "macroman", "macroman_bin", 1, 1}, - {58, "cp1257", "cp1257_bin", 1, 1}, - {60, "armascii8", "armascii8_bin", 1, 1}, - {65, "ascii", "ascii_bin", 1, 1}, - {66, "cp1250", "cp1250_bin", 1, 1}, - {67, "cp1256", "cp1256_bin", 1, 1}, - {68, "cp866", "cp866_bin", 1, 1}, - {69, "dec8", "dec8_bin", 1, 1}, - {70, "greek", "greek_bin", 1, 1}, - {71, "hebew", "hebrew_bin", 1, 1}, - {72, "hp8", "hp8_bin", 1, 1}, - {73, "keybcs2", "keybcs2_bin", 1, 1}, - {74, "koi8r", "koi8r_bin", 1, 1}, - {75, "koi8u", "koi8u_bin", 1, 1}, - {77, "latin2", "latin2_bin", 1, 1}, - {78, "latin5", "latin5_bin", 1, 1}, - {79, "latin7", "latin7_bin", 1, 1}, - {80, "cp850", "cp850_bin", 1, 1}, - {81, "cp852", "cp852_bin", 1, 1}, - {82, "swe7", "swe7_bin", 1, 1}, - {93, "geostd8", "geostd8_bin", 1, 1}, - {83, "utf8", "utf8_bin", 1, 3}, - {84, "big5", "big5_bin", 1, 2}, - {85, "euckr", "euckr_bin", 1, 2}, - {86, "gb2312", "gb2312_bin", 1, 2}, - {87, "gbk", "gbk_bin", 1, 2}, - {88, "sjis", "sjis_bin", 1, 2}, - {89, "tis620", "tis620_bin", 1, 1}, - {90, "ucs2", "ucs2_bin", 2, 2}, - {91, "ujis", "ujis_bin", 1, 3}, - {94, "latin1", "latin1_spanish_ci", 1, 1}, - {96, "cp932", "cp932_bin", 1, 2}, - {99, "cp1250", "cp1250_polish_ci", 1, 1}, - {98, "eucjpms", "eucjpms_bin", 1, 3}, - {128, "ucs2", "ucs2_unicode_ci", 2, 2}, - {129, "ucs2", "ucs2_icelandic_ci", 2, 2}, - {130, "ucs2", "ucs2_latvian_ci", 2, 2}, - {131, "ucs2", "ucs2_romanian_ci", 2, 2}, - {132, "ucs2", "ucs2_slovenian_ci", 2, 2}, - {133, "ucs2", "ucs2_polish_ci", 2, 2}, - {134, "ucs2", "ucs2_estonian_ci", 2, 2}, - {135, "ucs2", "ucs2_spanish_ci", 2, 2}, - {136, "ucs2", "ucs2_swedish_ci", 2, 2}, - {137, "ucs2", "ucs2_turkish_ci", 2, 2}, - {138, "ucs2", "ucs2_czech_ci", 2, 2}, - {139, "ucs2", "ucs2_danish_ci", 2, 2}, - {140, "ucs2", "ucs2_lithunian_ci", 2, 2}, - {141, "ucs2", "ucs2_slovak_ci", 2, 2}, - {142, "ucs2", "ucs2_spanish2_ci", 2, 2}, - {143, "ucs2", "ucs2_roman_ci", 2, 2}, - {144, "ucs2", "ucs2_persian_ci", 2, 2}, - {145, "ucs2", "ucs2_esperanto_ci", 2, 2}, - {146, "ucs2", "ucs2_hungarian_ci", 2, 2}, - {147, "ucs2", "ucs2_sinhala_ci", 2, 2}, - {192, "utf8mb3", "utf8mb3_general_ci", 1, 3}, - {193, "utf8mb3", "utf8mb3_icelandic_ci", 1, 3}, - {194, "utf8mb3", "utf8mb3_latvian_ci", 1, 3}, - {195, "utf8mb3", "utf8mb3_romanian_ci", 1, 3}, - {196, "utf8mb3", "utf8mb3_slovenian_ci", 1, 3}, - {197, "utf8mb3", "utf8mb3_polish_ci", 1, 3}, - {198, "utf8mb3", "utf8mb3_estonian_ci", 1, 3}, - {119, "utf8mb3", "utf8mb3_spanish_ci", 1, 3}, - {200, "utf8mb3", "utf8mb3_swedish_ci", 1, 3}, - {201, "utf8mb3", "utf8mb3_turkish_ci", 1, 3}, - {202, "utf8mb3", "utf8mb3_czech_ci", 1, 3}, - {203, "utf8mb3", "utf8mb3_danish_ci", 1, 3}, - {204, "utf8mb3", "utf8mb3_lithunian_ci", 1, 3}, - {205, "utf8mb3", "utf8mb3_slovak_ci", 1, 3}, - {206, "utf8mb3", "utf8mb3_spanish2_ci", 1, 3}, - {207, "utf8mb3", "utf8mb3_roman_ci", 1, 3}, - {208, "utf8mb3", "utf8mb3_persian_ci", 1, 3}, - {209, "utf8mb3", "utf8mb3_esperanto_ci", 1, 3}, - {210, "utf8mb3", "utf8mb3_hungarian_ci", 1, 3}, - {211, "utf8mb3", "utf8mb3_sinhala_ci", 1, 3}, - {224, "utf8", "utf8_unicode_ci", 1, 3}, - {225, "utf8", "utf8_icelandic_ci", 1, 3}, - {226, "utf8", "utf8_latvian_ci", 1, 3}, - {227, "utf8", "utf8_romanian_ci", 1, 3}, - {228, "utf8", "utf8_slovenian_ci", 1, 3}, - {229, "utf8", "utf8_polish_ci", 1, 3}, - {230, "utf8", "utf8_estonian_ci", 1, 3}, - {231, "utf8", "utf8_spanish_ci", 1, 3}, - {232, "utf8", "utf8_swedish_ci", 1, 3}, - {233, "utf8", "utf8_turkish_ci", 1, 3}, - {234, "utf8", "utf8_czech_ci", 1, 3}, - {235, "utf8", "utf8_danish_ci", 1, 3}, - {236, "utf8", "utf8_lithuanian_ci", 1, 3}, - {237, "utf8", "utf8_slovak_ci", 1, 3}, - {238, "utf8", "utf8_spanish2_ci", 1, 3}, - {239, "utf8", "utf8_roman_ci", 1, 3}, - {240, "utf8", "utf8_persian_ci", 1, 3}, - {241, "utf8", "utf8_esperanto_ci", 1, 3}, - {242, "utf8", "utf8_hungarian_ci", 1, 3}, - {243, "utf8", "utf8_sinhala_ci", 1, 3}, - {254, "utf8mb3", "utf8mb3_general_cs", 1, 3}, - {0, NULL, NULL, 0, 0} -}; - -@implementation MCPResult - -/** - * Hold the results of a query to a MySQL database server. It correspond to the MYSQL_RES structure of the C API, and to the statement handle of the PERL DBI/DBD. - * - * Uses the !{mysql_store_result()} function from the C API. - * - * This object is generated only by a MCPConnection object, in this way (see #{MCPConnection} documentation): - * - * MCPConnection *theConnec = [MCPConnection alloc]; - * MCPResult *theRes; - * NSDictionary *theDict; - * NSArray *theColNames; - * int i, j; - * - * theConnec = [theConnec initToHost:@"albert.com" withLogin:@"toto" password:@"albert" usingPort:0]; - * [theConnec selectDB:@"db1"]; - * theRes = [theConnec queryString:@"select * from table1"]; - * theColNames = [theRes fetchFiedlsName]; - * i = 0; - * - * while (theDict = [theRes fetchRowAsDictionary]) { - * NSLog(@"Row : %d\n", i); - * for (j=0; j<[theColNames count]; j++) { - * NSLog(@" Field : %@, contain : %@\n", [theColNames objectAtIndex:j], [theDict objectForKey:[theColNames objectAtIndex:j]]); - * } - * i++; - * } - */ - -/** - * Initialize the class version to 3.0.1 - */ -+ (void)initialize -{ - if ((self = [MCPResult class])) { - [self setVersion:030001]; // Ma.Mi.Re -> MaMiRe - MCPYear0000 = [NSCalendarDate dateWithTimeIntervalSinceReferenceDate:-63146822400.0]; - [MCPYear0000 setCalendarFormat:@"%Y"]; - } -} - -#pragma mark - -#pragma mark Initialisation - -/** - * Empty init, normaly of NO use to the user, again, MCPResult should be made through calls to MCPConnection - */ -- (id)init -{ - if ((self = [super init])) { - mEncoding = [MCPConnection defaultMySQLEncoding]; - mReturnDataAsStrings = NO; - mTimeZone = nil; - - if (mResult) { - mysql_free_result(mResult); - mResult = NULL; - } - - if (mNames) { - [mNames release]; - mNames = nil; - } - - mNumOfFields = 0; - } - - return self; -} - -/** - * Initialise a MCPResult, it is used internally by MCPConnection !{queryString:} method: the only proper - * way to get a running MCPResult object. - */ -- (id)initWithMySQLPtr:(MYSQL *)mySQLPtr encoding:(NSStringEncoding)iEncoding timeZone:(NSTimeZone *)iTimeZone -{ - if ((self = [super init])) { - mEncoding = iEncoding; - mTimeZone = [iTimeZone retain]; - mReturnDataAsStrings = NO; - - if (mResult) { - mysql_free_result(mResult); - mResult = NULL; - } - - if (mNames) { - [mNames release]; - mNames = nil; - } - - mResult = mysql_store_result(mySQLPtr); - - if (mResult) { - mNumOfFields = mysql_num_fields(mResult); - } - else { - mNumOfFields = 0; - } - } - - return self; -} - -/** - * This metod is used internally by MCPConnection object when it have already a MYSQL_RES object to initialise - * MCPResult object. Initialise a MCPResult with the MYSQL_RES pointer (returned by such a function as mysql_list_dbs). - * NB: MCPResult should be made by using one of the method of MCPConnection. - */ -- (id)initWithResPtr:(MYSQL_RES *)mySQLResPtr encoding:(NSStringEncoding)iEncoding timeZone:(NSTimeZone *)iTimeZone -{ - if ((self = [super init])) { - mEncoding = iEncoding; - mTimeZone = [iTimeZone retain]; - mReturnDataAsStrings = NO; - - if (mResult) { - mysql_free_result(mResult); - mResult = NULL; - } - - if (mNames) { - [mNames release]; - mNames = nil; - } - - mResult = mySQLResPtr; - - if (mResult) { - mNumOfFields = mysql_num_fields(mResult); - } - else { - mNumOfFields = 0; - } - } - - return self; -} - -#pragma mark - -#pragma mark Result info - -/** - * Return the number of rows selected by the query. - */ -- (my_ulonglong)numOfRows -{ - if (mResult) { - return mysql_num_rows(mResult); - } - - return 0; -} - -/** - * Return the number of fields selected by the query. As a side effect it forces an update of the number of fields. - */ -- (NSUInteger)numOfFields -{ - if (mResult) { - return mNumOfFields = mysql_num_fields(mResult); - } - - return mNumOfFields = 0; -} - -#pragma mark - -#pragma mark Rows - -/** - * Go to a precise row in the selected result. 0 is the very first row. - */ -- (void)dataSeek:(my_ulonglong)row -{ - my_ulonglong theRow = (row < 1)? 0 : row; - theRow = (theRow < [self numOfRows]) ? theRow : ([self numOfRows] - 1); - mysql_data_seek(mResult,theRow); -} - -/** - * - */ -- (id)fetchRowAsType:(MCPReturnType)aType -{ - MYSQL_ROW theRow; - unsigned long *theLengths; - MYSQL_FIELD *theField; - NSUInteger i; - id theReturn; - - if (mResult == NULL) { - // If there is no results, returns nil, as after the last row... - return nil; - } - - theRow = mysql_fetch_row(mResult); - - if (theRow == NULL) { - return nil; - } - - switch (aType) { - case MCPTypeArray: - theReturn = [NSMutableArray arrayWithCapacity:mNumOfFields]; - break; - case MCPTypeDictionary: - if (mNames == nil) { - [self fetchFieldNames]; - } - theReturn = [NSMutableDictionary dictionaryWithCapacity:mNumOfFields]; - break; - default : - NSLog (@"Unknown type : %d, will return an Array!\n", (int)aType); - theReturn = [NSMutableArray arrayWithCapacity:mNumOfFields]; - break; - } - - theLengths = mysql_fetch_lengths(mResult); - theField = mysql_fetch_fields(mResult); - - for (i=0; i<mNumOfFields; i++) { - id theCurrentObj; - - if (theRow[i] == NULL) { - theCurrentObj = [NSNull null]; - } else { - char *theData = theRow[i]; - - switch (theField[i].type) { - case FIELD_TYPE_TINY: - case FIELD_TYPE_SHORT: - case FIELD_TYPE_INT24: - case FIELD_TYPE_LONG: - case FIELD_TYPE_LONGLONG: - case FIELD_TYPE_DECIMAL: - case FIELD_TYPE_NEWDECIMAL: - case FIELD_TYPE_FLOAT: - case FIELD_TYPE_DOUBLE: - case FIELD_TYPE_TIMESTAMP: - case FIELD_TYPE_DATE: - case FIELD_TYPE_TIME: - case FIELD_TYPE_DATETIME: - case FIELD_TYPE_YEAR: - case FIELD_TYPE_VAR_STRING: - case FIELD_TYPE_STRING: - case FIELD_TYPE_SET: - case FIELD_TYPE_ENUM: - case FIELD_TYPE_NEWDATE: // Don't know what the format for this type is... - theCurrentObj = [[[NSString alloc] initWithBytes:theData length:theLengths[i] encoding:mEncoding] autorelease]; - break; - - case FIELD_TYPE_BIT: - theCurrentObj = [NSString stringWithFormat:@"%u", theData[0]]; - break; - - case FIELD_TYPE_TINY_BLOB: - case FIELD_TYPE_BLOB: - case FIELD_TYPE_MEDIUM_BLOB: - case FIELD_TYPE_LONG_BLOB: - theCurrentObj = [NSData dataWithBytes:theData length:theLengths[i]]; - - // If the field is TEXT and NOT BLOB, or if force-return-as-string is - // enabled, return a NSString instead of NSData - if (mReturnDataAsStrings || !(theField[i].flags & BINARY_FLAG)) { - theCurrentObj = [self stringWithText:theCurrentObj]; - } - - break; - - case FIELD_TYPE_NULL: - theCurrentObj = [NSNull null]; - break; - - case FIELD_TYPE_GEOMETRY: - theCurrentObj = [MCPGeometryData dataWithBytes:theData length:theLengths[i]]; - break; - - default: - NSLog (@"in fetchRowAsType : Unknown type : %d for column %lu, send back a NSData object", (int)theField[i].type, (unsigned long)i); - theCurrentObj = [NSData dataWithBytes:theData length:theLengths[i]]; - break; - } - - // Some of the creators return nil object... - if (theCurrentObj == nil) { - theCurrentObj = [NSNull null]; - } - } - - switch (aType) { - case MCPTypeDictionary : - [theReturn setObject:theCurrentObj forKey:[mNames objectAtIndex:i]]; - break; - - case MCPTypeArray : - default : - [theReturn addObject:theCurrentObj]; - break; - } - } - - return theReturn; -} - -/** - * Return the next row of the result as an array, the index in select field order, the object a proper object - * for handling the information in the field (NSString, NSNumber ...). - * - * Just a #{typed} wrapper for method !{fetchRosAsType:} (with arg MCPTypeArray). - * - * NB: Returned object is immutable. - */ -- (NSArray *)fetchRowAsArray -{ - NSMutableArray *theArray = [self fetchRowAsType:MCPTypeArray]; - - return (theArray) ? [NSArray arrayWithArray:theArray] : nil; -} - -/** - * Return the next row of the result as a dictionary, the key being the field name, the object a proper object - * for handling the information in the field (NSString, NSNumber ...). - * - * Just a #{typed} wrapper for method !{fetchRosAsType:} (with arg MCPTypeDictionary). - * - * NB: Returned object is immutable. - */ -- (NSDictionary *)fetchRowAsDictionary -{ - NSMutableDictionary *theDict = [self fetchRowAsType:MCPTypeDictionary]; - - return (theDict) ? [NSDictionary dictionaryWithDictionary:theDict] : nil; -} - -#pragma mark - -#pragma mark Columns - -/** - * Generate the mNames if not already generated, and return it. - * - * mNames is a NSArray holding the names of the fields(columns) of the results. - */ -- (NSArray *)fetchFieldNames -{ - NSUInteger i; - NSUInteger theNumFields; - NSMutableArray *theNamesArray; - MYSQL_FIELD *theField; - - if (mNames) { - return mNames; - } - - if (mResult == NULL) { - // If no results, give an empty array. Maybe it's better to give a nil pointer? - return (mNames = [[NSArray array] retain]); - } - - theNumFields = [self numOfFields]; - theNamesArray = [NSMutableArray arrayWithCapacity: theNumFields]; - theField = mysql_fetch_fields(mResult); - - for (i=0; i<theNumFields; i++) { - NSString *theName = [self stringWithCString:theField[i].name]; - if ((theName) && (![theName isEqualToString:@""])) { - [theNamesArray addObject:theName]; - } - else { - [theNamesArray addObject:[NSString stringWithFormat:@"Column %ld", i]]; - } - } - - return (mNames = [[NSArray arrayWithArray:theNamesArray] retain]); -} - -/** - * Return a collection of the fields's type. The type of collection is choosen by the aType variable - * (MCPTypeArray or MCPTypeDictionary). - * - * This method returned directly the #{mutable} object generated while going through all the columns - */ -- (id)fetchTypesAsType:(MCPReturnType)aType -{ - NSUInteger i; - id theTypes; - MYSQL_FIELD *theField; - - if (mResult == NULL) { - // If no results, give an empty array. Maybe it's better to give a nil pointer? - return nil; - } - - switch (aType) { - case MCPTypeArray: - theTypes = [NSMutableArray arrayWithCapacity:mNumOfFields]; - break; - case MCPTypeDictionary: - if (mNames == nil) { - [self fetchFieldNames]; - } - theTypes = [NSMutableDictionary dictionaryWithCapacity:mNumOfFields]; - break; - default : - NSLog (@"Unknown type : %d, will return an Array!\n", (int)aType); - theTypes = [NSMutableArray arrayWithCapacity:mNumOfFields]; - break; - } - - theField = mysql_fetch_fields(mResult); - - for (i=0; i<mNumOfFields; i++) { - NSString *theType; - switch (theField[i].type) { - case FIELD_TYPE_TINY: - theType = @"tiny"; - break; - case FIELD_TYPE_SHORT: - theType = @"short"; - break; - case FIELD_TYPE_LONG: - theType = @"long"; - break; - case FIELD_TYPE_INT24: - theType = @"int24"; - break; - case FIELD_TYPE_LONGLONG: - theType = @"longlong"; - break; - case FIELD_TYPE_DECIMAL: - case FIELD_TYPE_NEWDECIMAL: - theType = @"decimal"; - break; - case FIELD_TYPE_FLOAT: - theType = @"float"; - break; - case FIELD_TYPE_DOUBLE: - theType = @"double"; - break; - case FIELD_TYPE_TIMESTAMP: - theType = @"timestamp"; - break; - case FIELD_TYPE_DATE: - theType = @"date"; - break; - case FIELD_TYPE_TIME: - theType = @"time"; - break; - case FIELD_TYPE_DATETIME: - theType = @"datetime"; - break; - case FIELD_TYPE_YEAR: - theType = @"year"; - break; - case FIELD_TYPE_VAR_STRING: - theType = @"varstring"; - break; - case FIELD_TYPE_STRING: - theType = @"string"; - break; - case FIELD_TYPE_TINY_BLOB: - theType = @"tinyblob"; - break; - case FIELD_TYPE_BLOB: - theType = @"blob"; - break; - case FIELD_TYPE_MEDIUM_BLOB: - theType = @"mediumblob"; - break; - case FIELD_TYPE_LONG_BLOB: - theType = @"longblob"; - break; - case FIELD_TYPE_SET: - theType = @"set"; - break; - case FIELD_TYPE_ENUM: - theType = @"enum"; - break; - case FIELD_TYPE_NULL: - theType = @"null"; - break; - case FIELD_TYPE_NEWDATE: - theType = @"newdate"; - break; - case FIELD_TYPE_GEOMETRY: - theType = @"geometry"; - break; - default: - theType = @"unknown"; - NSLog (@"in fetchTypesAsArray : Unknown type for column %lu of the MCPResult, type = %d", (unsigned long)i, (int)theField[i].type); - break; - } - - switch (aType) { - case MCPTypeArray : - [theTypes addObject:theType]; - break; - case MCPTypeDictionary : - [theTypes setObject:theType forKey:[mNames objectAtIndex:i]]; - break; - default : - [theTypes addObject:theType]; - break; - } - } - - return theTypes; -} - -/** - * Return an array of the fields' types. - * - * NB: Returned object is immutable. - */ -- (NSArray *)fetchTypesAsArray -{ - NSMutableArray *theArray = [self fetchTypesAsType:MCPTypeArray]; - - return (theArray) ? [NSArray arrayWithArray:theArray] : nil; -} - -/** - * Return a dictionnary of the fields' types (keys are the fields' names). - * - * NB: Returned object is immutable. - */ -- (NSDictionary*) fetchTypesAsDictionary -{ - NSMutableDictionary *theDict = [self fetchTypesAsType:MCPTypeDictionary]; - - return (theDict) ? [NSDictionary dictionaryWithDictionary:theDict] : nil; -} - -/** - * Return an array of dicts containg column data of the last executed query - */ -- (NSArray *)fetchResultFieldsStructure -{ - MYSQL_FIELD *theField; - - NSMutableArray *structureResult = [NSMutableArray array]; - - NSUInteger i; - NSUInteger numFields = mysql_num_fields(mResult); - - if (mResult == NULL) return nil; - - theField = mysql_fetch_fields(mResult); - - for (i=0; i < numFields; i++) - { - NSMutableDictionary *fieldStructure = [NSMutableDictionary dictionaryWithCapacity:39]; - - /* Original column position */ - [fieldStructure setObject:[NSString stringWithFormat:@"%llu", (unsigned long long)i] forKey:@"datacolumnindex"]; - - /* Name of column */ - [fieldStructure setObject:[self stringWithCString:theField[i].name] forKey:@"name"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].name_length] forKey:@"name_length"]; - - /* Original column name, if an alias */ - [fieldStructure setObject:[self stringWithCString:theField[i].org_name] forKey:@"org_name"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].org_name_length] forKey:@"org_name_length"]; - - /* Table of column if column was a field */ - [fieldStructure setObject:[self stringWithCString:theField[i].table] forKey:@"table"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].table_length] forKey:@"table_length"]; - - /* Org table name, if table was an alias */ - [fieldStructure setObject:[self stringWithCString:theField[i].org_table] forKey:@"org_table"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].org_table_length] forKey:@"org_table_length"]; - - /* Database for table */ - [fieldStructure setObject:[self stringWithCString:theField[i].db] forKey:@"db"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].db_length] forKey:@"db_length"]; - - /* Catalog for table */ - // [fieldStructure setObject:[self stringWithCString:theField[i].catalog] forKey:@"catalog"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].catalog_length] forKey:@"catalog_length"]; - - /* Default value (set by mysql_list_fields) */ - // [fieldStructure setObject:[self stringWithCString:theField[i].def] forKey:@"def"]; - // [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].def_length] forKey:@"def_length"]; - - /* Width of column (real length in bytes) */ - [fieldStructure setObject:[NSNumber numberWithUnsignedLongLong:theField[i].length] forKey:@"byte_length"]; - /* Width of column (as in create)*/ - [fieldStructure setObject:[NSNumber numberWithUnsignedLongLong:theField[i].length/[self findCharsetMaxByteLengthPerChar:theField[i].charsetnr]] - forKey:@"char_length"]; - /* Max width (bytes) for selected set */ - [fieldStructure setObject:[NSNumber numberWithUnsignedLongLong:theField[i].max_length] forKey:@"max_byte_length"]; - /* Max width (chars) for selected set */ - // [fieldStructure setObject:[NSNumber numberWithUnsignedLongLong:theField[i].max_length/[self find_charsetMaxByteLengthPerChar:theField[i].charsetnr]] - // forKey:@"max_char_length"]; - - /* Div flags */ - [fieldStructure setObject:[NSNumber numberWithUnsignedInt:theField[i].flags] forKey:@"flags"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & NOT_NULL_FLAG) ? YES : NO] forKey:@"null"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & PRI_KEY_FLAG) ? YES : NO] forKey:@"PRI_KEY_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & UNIQUE_KEY_FLAG) ? YES : NO] forKey:@"UNIQUE_KEY_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & MULTIPLE_KEY_FLAG) ? YES : NO] forKey:@"MULTIPLE_KEY_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & BLOB_FLAG) ? YES : NO] forKey:@"BLOB_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & UNSIGNED_FLAG) ? YES : NO] forKey:@"UNSIGNED_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & ZEROFILL_FLAG) ? YES : NO] forKey:@"ZEROFILL_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & BINARY_FLAG) ? YES : NO] forKey:@"BINARY_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & ENUM_FLAG) ? YES : NO] forKey:@"ENUM_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & AUTO_INCREMENT_FLAG) ? YES : NO] forKey:@"AUTO_INCREMENT_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & SET_FLAG) ? YES : NO] forKey:@"SET_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & NUM_FLAG) ? YES : NO] forKey:@"NUM_FLAG"]; - [fieldStructure setObject:[NSNumber numberWithBool:(theField[i].flags & PART_KEY_FLAG) ? YES : NO] forKey:@"PART_KEY_FLAG"]; - // [fieldStructure setObject:[NSNumber numberWithInt:(theField[i].flags & GROUP_FLAG) ? 1 : 0] forKey:@"GROUP_FLAG"]; - // [fieldStructure setObject:[NSNumber numberWithInt:(theField[i].flags & UNIQUE_FLAG) ? 1 : 0] forKey:@"UNIQUE_FLAG"]; - // [fieldStructure setObject:[NSNumber numberWithInt:(theField[i].flags & BINCMP_FLAG) ? 1 : 0] forKey:@"BINCMP_FLAG"]; - - /* Number of decimals in field */ - [fieldStructure setObject:[NSNumber numberWithUnsignedInteger:theField[i].decimals] forKey:@"decimals"]; - - /* Character set */ - [fieldStructure setObject:[NSNumber numberWithUnsignedInteger:theField[i].charsetnr] forKey:@"charsetnr"]; - [fieldStructure setObject:[self findCharsetName:theField[i].charsetnr] forKey:@"charset_name"]; - [fieldStructure setObject:[self findCharsetCollation:theField[i].charsetnr] forKey:@"charset_collation"]; - - /* Table type */ - [fieldStructure setObject:[self mysqlTypeToStringForType:theField[i].type - withCharsetNr:theField[i].charsetnr - withFlags:theField[i].flags - withLength:theField[i].length - ] forKey:@"type"]; - - /* Table type group*/ - [fieldStructure setObject:[self mysqlTypeToGroupForType:theField[i].type - withCharsetNr:theField[i].charsetnr - withFlags:theField[i].flags - ] forKey:@"typegrouping"]; - - [structureResult addObject:fieldStructure]; - - } - - return structureResult; - -} - -/** - * Return the MySQL flags of the column at the given index... Can be used to check if a number is signed or not... - */ -- (NSUInteger)fetchFlagsAtIndex:(NSUInteger)anIndex -{ - NSUInteger theRet; - NSUInteger theNumFields; - MYSQL_FIELD *theField; - - if (mResult == NULL) { - // If no results, give an empty array. Maybe it's better to give a nil pointer? - return (0); - } - - theNumFields = [self numOfFields]; - theField = mysql_fetch_fields(mResult); - - if (anIndex >= theNumFields) { - // Out of range... should raise an exception - theRet = 0; - } - else { - theRet = theField[anIndex].flags; - } - - return theRet; -} - -/** - * - */ -- (NSUInteger)fetchFlagsForKey:(NSString *)key -{ - NSUInteger theRet; - NSUInteger anIndex; - MYSQL_FIELD *theField; - - if (mResult == NULL) { - // If no results, give an empty array. Maybe it's better to give a nil pointer? - return (0); - } - - if (mNames == nil) { - [self fetchFieldNames]; - } - - theField = mysql_fetch_fields(mResult); - - if ([mNames indexOfObject:key] == NSNotFound) { - // Non existent key... should raise an exception - theRet = 0; - } - else { - anIndex = [mNames indexOfObject:key]; - - theRet = theField[anIndex].flags; - } - - return theRet; -} - -/** - * Return YES if the field with the given index is a BLOB. It should be used to discriminates between BLOBs - * and TEXTs. - * - * #{DEPRECATED}, This method is not consistent with the C API which is supposed to return YES for BOTH - * text and blob (and BTW is also deprecated)... - * - * #{NOTE} That the current version handles properly TEXT, and returns those as NSString (and not NSData as - * it used to be). - */ -- (BOOL)isBlobAtIndex:(NSUInteger)anIndex -{ - BOOL theRet; - NSUInteger theNumFields; - MYSQL_FIELD *theField; - - if (mResult == NULL) { - // If no results, give an empty array. Maybe it's better to give a nil pointer? - return (NO); - } - - theNumFields = [self numOfFields]; - theField = mysql_fetch_fields(mResult); - - if (anIndex >= theNumFields) { - // Out of range... should raise an exception - theRet = NO; - } - else { - switch(theField[anIndex].type) { - case FIELD_TYPE_TINY_BLOB: - case FIELD_TYPE_BLOB: - case FIELD_TYPE_MEDIUM_BLOB: - case FIELD_TYPE_LONG_BLOB: - theRet = (theField[anIndex].flags & BINARY_FLAG); - break; - default: - theRet = NO; - break; - } - } - - return theRet; -} - -/** - * Return YES if the field (by name) with the given index is a BLOB. It should be used to discriminates - * between BLOBs and TEXTs. - * - * #{DEPRECATED}, This method is not consistent with the C API which is supposed to return YES for BOTH - * text and blob (and BTW is also deprecated)... - * - * #{NOTE} That the current version handles properly TEXT, and returns those as NSString (and not NSData - * as it used to be). - */ -- (BOOL)isBlobForKey:(NSString *)key -{ - BOOL theRet; - NSUInteger anIndex; - MYSQL_FIELD *theField; - - if (mResult == NULL) { - // If no results, give an empty array. Maybe it's better to give a nil pointer? - return (NO); - } - - if (mNames == nil) { - [self fetchFieldNames]; - } - - theField = mysql_fetch_fields(mResult); - - if ([mNames indexOfObject:key] == NSNotFound) { - // Non existent key... should raise an exception - theRet = NO; - } - else { - anIndex = [mNames indexOfObject:key]; - - switch(theField[anIndex].type) { - case FIELD_TYPE_TINY_BLOB: - case FIELD_TYPE_BLOB: - case FIELD_TYPE_MEDIUM_BLOB: - case FIELD_TYPE_LONG_BLOB: - theRet = (theField[anIndex].flags & BINARY_FLAG); - break; - default: - theRet = NO; - break; - } - } - - return theRet; -} - -#pragma mark - -#pragma mark Conversion - -/** - * Set whether the result should return data types as strings. This may be useful - * for queries where the result may be returned in either string or data form, but - * will be converted to string for display and use anyway. - * Note that certain MySQL versions also return data types for strings - eg SHOW - * commands like SHOW CREATE TABLE or SHOW VARIABLES, and this conversion can be - * necessary there. - */ -- (void) setReturnDataAsStrings:(BOOL)alwaysConvertData -{ - mReturnDataAsStrings = alwaysConvertData; -} - -/** - * Use the string encoding to convert the returned NSData to a string (for a TEXT field). - */ -- (NSString *)stringWithText:(NSData *)theTextData -{ - NSString *theString; - - if (theTextData == nil) { - return nil; - } - - theString = [[NSString alloc] initWithData:theTextData encoding:mEncoding]; - - if (theString) { - [theString autorelease]; - } - - return theString; -} - -/** - * Return a (long) string containing the table of results, first line being the fields name, next line(s) - * the row(s). Useful to have NSLog logging a MCPResult (example). - */ -- (NSString *)description -{ - if (mResult == NULL) { - return @"This is an empty MCPResult\n"; - } - else { - NSMutableString *theString = [NSMutableString stringWithCapacity:0]; - NSUInteger i; - NSArray *theRow; - MYSQL_ROW_OFFSET thePosition; - BOOL shouldTruncateFields = [MCPConnection truncateLongField]; - - // First line, saying we are displaying a MCPResult - [theString appendFormat:@"MCPResult: (encoding : %ld, dim %ld x %ld)\n", (long)mEncoding, (long)mNumOfFields, (long)[self numOfRows]]; - - // Second line: the field names, tab separated - [self fetchFieldNames]; - - for (i=0; i<(mNumOfFields-1); i++) { - [theString appendFormat:@"%@\t", [mNames objectAtIndex:i]]; - } - - [theString appendFormat:@"%@\n", [mNames objectAtIndex:i]]; - // Next lines, the records (saving current position to put it back after the full display) - thePosition = mysql_row_tell(mResult); - [self dataSeek:0]; - - while ((theRow = [self fetchRowAsArray])) - { - id theField = [theRow objectAtIndex:i]; - - if (shouldTruncateFields) { - if (([theField isKindOfClass:[NSString class]]) && (kLengthOfTruncationForLog < [(NSString *)theField length])) { - theField = [theField substringToIndex:kLengthOfTruncationForLog]; - } - else if (([theField isKindOfClass:[NSData class]]) && (kLengthOfTruncationForLog < [(NSData *)theField length])) { - theField = [NSData dataWithBytes:[theField bytes] length:kLengthOfTruncationForLog]; - } - } - - for (i=0; i<(mNumOfFields - 1); i++) - { - [theString appendFormat:@"%@\t", theField]; - } - - [theString appendFormat:@"%@\n", theField]; - } - - // Returning to the proper row - mysql_row_seek(mResult, thePosition); - - return theString; - } -} - -/** - * For internal use only. Transform a NSString to a C type string (ended with \0) using ethe character set - * from the MCPConnection. Lossy conversions are enabled. - */ -- (const char *)cStringFromString:(NSString *)theString -{ - NSMutableData *theData; - - if (!theString) { - return (const char *)NULL; - } - - theData = [NSMutableData dataWithData:[theString dataUsingEncoding:mEncoding allowLossyConversion:YES]]; - [theData increaseLengthBy:1]; - - return (const char *)[theData bytes]; -} - -/** - * Return a NSString from a C style string encoded with the character set of theMCPConnection. - */ -- (NSString *)stringWithCString:(const char *)theCString -{ - if (theCString == NULL) return @""; - - return [NSString stringWithCString:theCString encoding:mEncoding]; -} - -#pragma mark - -#pragma mark Other - -/** - * Convert a mysql_type to a string - */ -- (NSString *)mysqlTypeToStringForType:(NSUInteger)type withCharsetNr:(NSUInteger)charsetnr withFlags:(NSUInteger)flags withLength:(unsigned long long)length -{ - // BOOL isUnsigned = (flags & UNSIGNED_FLAG) != 0; - // BOOL isZerofill = (flags & ZEROFILL_FLAG) != 0; - - switch (type) { - case FIELD_TYPE_BIT: - return @"BIT"; - case MYSQL_TYPE_DECIMAL: - case MYSQL_TYPE_NEWDECIMAL: - //return isUnsigned ? (isZerofill? @"DECIMAL UNSIGNED ZEROFILL" : @"DECIMAL UNSIGNED"): - return @"DECIMAL"; - case MYSQL_TYPE_TINY: - // return isUnsigned ? (isZerofill? @"TINYINT UNSIGNED ZEROFILL" : @"TINYINT UNSIGNED"): - return @"TINYINT"; - case MYSQL_TYPE_SHORT: - // return isUnsigned ? (isZerofill? @"SMALLINT UNSIGNED ZEROFILL" : @"SMALLINT UNSIGNED"): - return @"SMALLINT"; - case MYSQL_TYPE_LONG: - // return isUnsigned ? (isZerofill? @"INT UNSIGNED ZEROFILL" : @"INT UNSIGNED"): - return @"INT"; - case MYSQL_TYPE_FLOAT: - // return isUnsigned ? (isZerofill? @"FLOAT UNSIGNED ZEROFILL" : @"FLOAT UNSIGNED"): - return @"FLOAT"; - case MYSQL_TYPE_DOUBLE: - // return isUnsigned ? (isZerofill? @"DOUBLE UNSIGNED ZEROFILL" : @"DOUBLE UNSIGNED"): - return @"DOUBLE"; - case MYSQL_TYPE_NULL: - return @"NULL"; - case MYSQL_TYPE_TIMESTAMP: - return @"TIMESTAMP"; - case MYSQL_TYPE_LONGLONG: - // return isUnsigned ? (isZerofill? @"BIGINT UNSIGNED ZEROFILL" : @"BIGINT UNSIGNED") : - return @"BIGINT"; - case MYSQL_TYPE_INT24: - // return isUnsigned ? (isZerofill? @"MEDIUMINT UNSIGNED ZEROFILL" : @"MEDIUMINT UNSIGNED") : - return @"MEDIUMINT"; - case MYSQL_TYPE_DATE: - return @"DATE"; - case MYSQL_TYPE_TIME: - return @"TIME"; - case MYSQL_TYPE_DATETIME: - return @"DATETIME"; - case MYSQL_TYPE_TINY_BLOB:// should no appear over the wire - case MYSQL_TYPE_MEDIUM_BLOB:// should no appear over the wire - case MYSQL_TYPE_LONG_BLOB:// should no appear over the wire - case MYSQL_TYPE_BLOB: - { - BOOL isBlob = (charsetnr == MAGIC_BINARY_CHARSET_NR); - switch ((NSInteger)length/[self findCharsetMaxByteLengthPerChar:charsetnr]) { - case 255: return isBlob? @"TINYBLOB":@"TINYTEXT"; - case 65535: return isBlob? @"BLOB":@"TEXT"; - case 16777215: return isBlob? @"MEDIUMBLOB":@"MEDIUMTEXT"; - case 4294967295: return isBlob? @"LONGBLOB":@"LONGTEXT"; - default: - switch (length) { - case 255: return isBlob? @"TINYBLOB":@"TINYTEXT"; - case 65535: return isBlob? @"BLOB":@"TEXT"; - case 16777215: return isBlob? @"MEDIUMBLOB":@"MEDIUMTEXT"; - case 4294967295: return isBlob? @"LONGBLOB":@"LONGTEXT"; - default: - return @"UNKNOWN"; - } - } - } - case MYSQL_TYPE_VAR_STRING: - if (flags & ENUM_FLAG) { - return @"ENUM"; - } - if (flags & SET_FLAG) { - return @"SET"; - } - if (charsetnr == MAGIC_BINARY_CHARSET_NR) { - return @"VARBINARY"; - } - return @"VARCHAR"; - case MYSQL_TYPE_STRING: - if (flags & ENUM_FLAG) { - return @"ENUM"; - } - if (flags & SET_FLAG) { - return @"SET"; - } - if ((flags & BINARY_FLAG) && charsetnr == MAGIC_BINARY_CHARSET_NR) { - return @"BINARY"; - } - return @"CHAR"; - case MYSQL_TYPE_ENUM: - /* This should never happen */ - return @"ENUM"; - case MYSQL_TYPE_YEAR: - return @"YEAR"; - case MYSQL_TYPE_SET: - /* This should never happen */ - return @"SET"; - case MYSQL_TYPE_GEOMETRY: - return @"GEOMETRY"; - default: - return @"UNKNOWN"; - } -} - -/** - * Merge mysql_types into type groups - */ -- (NSString *)mysqlTypeToGroupForType:(NSUInteger)type withCharsetNr:(NSUInteger)charsetnr withFlags:(NSUInteger)flags -{ - switch(type){ - case FIELD_TYPE_BIT: - return @"bit"; - case MYSQL_TYPE_TINY: - case MYSQL_TYPE_SHORT: - case MYSQL_TYPE_LONG: - case MYSQL_TYPE_LONGLONG: - case MYSQL_TYPE_INT24: - return @"integer"; - case MYSQL_TYPE_FLOAT: - case MYSQL_TYPE_DOUBLE: - case MYSQL_TYPE_DECIMAL: - case MYSQL_TYPE_NEWDECIMAL: - return @"float"; - case MYSQL_TYPE_YEAR: - case MYSQL_TYPE_DATETIME: - case MYSQL_TYPE_TIME: - case MYSQL_TYPE_DATE: - case MYSQL_TYPE_TIMESTAMP: - return @"date"; - case MYSQL_TYPE_VAR_STRING: - if (flags & ENUM_FLAG) { - return @"enum"; - } - if (flags & SET_FLAG) { - return @"enum"; - } - if (charsetnr == MAGIC_BINARY_CHARSET_NR) { - return @"binary"; - } - return @"string"; - case MYSQL_TYPE_STRING: - if (flags & ENUM_FLAG) { - return @"enum"; - } - if (flags & SET_FLAG) { - return @"enum"; - } - if ((flags & BINARY_FLAG) && charsetnr == MAGIC_BINARY_CHARSET_NR) { - return @"binary"; - } - return @"string"; - case MYSQL_TYPE_TINY_BLOB: // should no appear over the wire - case MYSQL_TYPE_MEDIUM_BLOB: // should no appear over the wire - case MYSQL_TYPE_LONG_BLOB: // should no appear over the wire - case MYSQL_TYPE_BLOB: - { - if (charsetnr == MAGIC_BINARY_CHARSET_NR) { - return @"blobdata"; - } else { - return @"textdata"; - } - } - case MYSQL_TYPE_GEOMETRY: - return @"geometry"; - default: - return @"blobdata"; - - } -} - -/** - * Convert a mysql_charsetnr into a charset name as string - */ -- (NSString *)findCharsetName:(NSUInteger)charsetnr -{ - const OUR_CHARSET * c = our_charsets60; - - do { - if (c->nr == charsetnr) - return [self stringWithCString:c->name]; - ++c; - } while (c[0].nr != 0); - - return @"UNKNOWN"; -} - -/** - * Convert a mysql_charsetnr into a collation name as string - */ -- (NSString *)findCharsetCollation:(NSUInteger)charsetnr -{ - const OUR_CHARSET * c = our_charsets60; - - do { - if (c->nr == charsetnr) - return [self stringWithCString:c->collation]; - ++c; - } while (c[0].nr != 0); - - return @"UNKNOWN"; -} - -/** - * Return the max byte length to store a char by using - * a specific mysql_charsetnr - */ -- (NSUInteger)findCharsetMaxByteLengthPerChar:(NSUInteger)charsetnr -{ - const OUR_CHARSET * c = our_charsets60; - - do { - if (c->nr == charsetnr) - return c->char_maxlen; - ++c; - } while (c[0].nr != 0); - - return 1; -} - -#pragma mark - - -/** - * Do one really needs an explanation for this method? Which by the way you should not use... - */ -- (void) dealloc -{ - if (mResult) mysql_free_result(mResult); - if (mNames) [mNames release]; - if (mTimeZone) [mTimeZone release]; - - [super dealloc]; -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPResultPlus.h b/Frameworks/MCPKit/MCPFoundationKit/MCPResultPlus.h deleted file mode 100644 index f161bd0c..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPResultPlus.h +++ /dev/null @@ -1,42 +0,0 @@ -// -// $Id$ -// -// MCPResultPlus.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 03/06/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -#import "MCPResult.h" - -@interface MCPResult (MCPResultPlus) - -// Getting a complete column as an array -- (NSArray *)fetchColAtIndex:(NSUInteger)col; -- (NSArray *)fetchColWithName:(NSString *)colName; - -// Getting the complete result as 2D array -- (id)fetch2DResultAsType:(MCPReturnType)type; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPResultPlus.m b/Frameworks/MCPKit/MCPFoundationKit/MCPResultPlus.m deleted file mode 100644 index dbf9d070..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPResultPlus.m +++ /dev/null @@ -1,188 +0,0 @@ -// -// $Id$ -// -// MCPResultPlus.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 03/06/2002. -// Copyright (c) 2001 Serge Cohen. All rights reserved. -// -// Forked by the Sequel Pro team (sequelpro.com), April 2009 -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://mysql-cocoa.sourceforge.net/> -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPResultPlus.h" - -/** - * This Category is provided to get shortcuts reformat the table obtained by a MCPResult - * (fetching a column, a 2D array...). - */ -@implementation MCPResult (MCPResultPlus) - -/** - * Getting a complete column into a NSArray (1D). The index starts from 0 (first column). - * - * The index 0 of the returned array always correspond to the first row (ie: returned NSArray is indexed - * by row number), the read position is restored after to it's initial position after the read. - */ -- (NSArray *)fetchColAtIndex:(NSUInteger)col -{ - NSMutableArray *theCol = [NSMutableArray arrayWithCapacity:(NSUInteger)[self numOfRows]]; - MYSQL_ROW_OFFSET thePosition; - NSArray *theRow; - - if ((mResult == NULL) || ([self numOfRows] == 0)) { - // If there is no results, returns nil. - return nil; - } - if (col >= mNumOfFields) { - // Bad column number - NSLog (@"The index : %ld is not within the range 0 - %ld\n", (long)col, (long)mNumOfFields); - return nil; - } - - thePosition = mysql_row_tell(mResult); - - [self dataSeek:0]; - - // One might want to have optimized code here. Maybe in later versions - while ((theRow = [self fetchRowAsType:MCPTypeArray])) - { - [theCol addObject:[theRow objectAtIndex:col]]; - } - - // Returning to the proper row - mysql_row_seek(mResult, thePosition); - - return [NSArray arrayWithArray:theCol]; -} - -/** - * The same as !{fetchColAtIndex:}, but the choice of the column is done by it's field name. Indeed it is just - * a wrapper to !{fetchColAtIndex}. - */ -- (NSArray *)fetchColWithName:(NSString *)colName -{ - NSUInteger theCol; - - if (mResult == NULL) { - // If there is no results, returns nil. - return nil; - } - - if (mNames == nil) { - [self fetchFieldNames]; - } - - if ([mNames indexOfObject:colName] == NSNotFound) { - NSLog(@"No column have been found with name : %@\n", colName); - return nil; - } - - theCol = [mNames indexOfObject:colName]; - - return [self fetchColAtIndex:theCol]; -} - -/** - * Returns the complete result table in a 2D object, which type depends on aType: - * - * - !{MCPTypeArray} : a NSArray of rows as NSArray, - * - * - !{MCPTypeDictionary} : a NSArray of rows as NSDictionary, - * - * - !{MCPTypeFlippedArray} : a NSArray of columns (as NSArray), - * - * - !{MCPTypeFlippedDictionary} : a NSDictionary of columns (as NSArray) - * - * In any case the read position is restored at the end of the call (hence a fetchRow will get the same row - * wether this method is called before it or not). - */ -- (id) fetch2DResultAsType:(MCPReturnType)type; -{ - id theTable, theVect; - MYSQL_ROW_OFFSET thePosition; - NSUInteger i; - - if (mResult == NULL) { - // If there is no results, returns nil. - return nil; - } - - thePosition = mysql_row_tell(mResult); - - [self dataSeek:0]; - - switch (type) - { - case MCPTypeArray : - theTable = [NSMutableArray arrayWithCapacity:(NSUInteger)[self numOfRows]]; - - while ((theVect = [self fetchRowAsArray])) - { - [theTable addObject:theVect]; - } - - theTable = [NSArray arrayWithArray:theTable]; - break; - case MCPTypeDictionary : - theTable = [NSMutableArray arrayWithCapacity:(NSUInteger)[self numOfRows]]; - - while ((theVect = [self fetchRowAsDictionary])) - { - [theTable addObject:theVect]; - } - - theTable = [NSArray arrayWithArray:theTable]; - break; - case MCPTypeFlippedArray : - theTable = [NSMutableArray arrayWithCapacity:mNumOfFields]; - - for (i=0; i<mNumOfFields; i++) - { - [theTable addObject:[self fetchColAtIndex:i]]; - } - - theTable = [NSArray arrayWithArray:theTable]; - break; - case MCPTypeFlippedDictionary : - theTable = [NSMutableDictionary dictionaryWithCapacity:mNumOfFields]; - - if (mNames == nil) { - [self fetchFieldNames]; - } - - for (i=0; i<mNumOfFields; i++) - { - [theTable setObject:[self fetchColAtIndex:i] forKey:[mNames objectAtIndex:i]]; - } - - theTable = [NSDictionary dictionaryWithDictionary:theTable]; - break; - default : - NSLog (@"Unknown MCPReturnType : %d; return nil\n", (int)type); - theTable = nil; - break; - } - - mysql_row_seek(mResult, thePosition); - - return theTable; -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPStreamingResult.h b/Frameworks/MCPKit/MCPFoundationKit/MCPStreamingResult.h deleted file mode 100644 index e8230fff..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPStreamingResult.h +++ /dev/null @@ -1,74 +0,0 @@ -// -// $Id$ -// -// MCPStreamingResult.h -// sequel-pro -// -// Created by Rowan Beentje on Aug 16, 2009 -// Copyright 2009 Rowan Beentje. All rights reserved. -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -#import "MCPResult.h" -#import "mysql.h" - -@class MCPConnection; - -typedef struct SP_MYSQL_ROWS { - char *data; - unsigned long *dataLengths; - struct SP_MYSQL_ROWS *nextRow; -} LOCAL_ROW_DATA; - -@interface MCPStreamingResult : MCPResult -{ - MCPConnection *parentConnection; - - MYSQL_FIELD *fieldDefinitions; - - BOOL fullyStreaming; - BOOL connectionUnlocked; - BOOL dataDownloaded; - BOOL dataFreed; - - LOCAL_ROW_DATA *localDataStore; - LOCAL_ROW_DATA *currentDataStoreEntry; - LOCAL_ROW_DATA *localDataStoreLastEntry; - - unsigned long localDataRows; - unsigned long localDataAllocated; - unsigned long downloadedRowCount; - unsigned long processedRowCount; - unsigned long freedRowCount; - - pthread_mutex_t dataCreationLock; - pthread_mutex_t dataFreeLock; - - IMP isConnectedPtr; - SEL isConnectedSEL; -} - -- (id)initWithMySQLPtr:(MYSQL *)mySQLPtr encoding:(NSStringEncoding)theEncoding timeZone:(NSTimeZone *)theTimeZone connection:(MCPConnection *)theConnection; -- (id)initWithMySQLPtr:(MYSQL *)mySQLPtr encoding:(NSStringEncoding)theEncoding timeZone:(NSTimeZone *)theTimeZone connection:(MCPConnection *)theConnection withFullStreaming:(BOOL)useFullStreaming; - -// Results fetching -- (NSArray *)fetchNextRowAsArray; -- (void) cancelResultLoad; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPStreamingResult.m b/Frameworks/MCPKit/MCPFoundationKit/MCPStreamingResult.m deleted file mode 100644 index bdb271fe..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPStreamingResult.m +++ /dev/null @@ -1,566 +0,0 @@ -// -// $Id$ -// -// MCPStreamingResult.m -// sequel-pro -// -// Created by Rowan Beentje on Aug 16, 2009 -// Copyright 2009 Rowan Beentje. All rights reserved. -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://code.google.com/p/sequel-pro/> - -#import "MCPStreamingResult.h" -#import "MCPConnection.h" -#import "MCPNull.h" -#import "MCPNumber.h" -#import "MCPGeometryData.h" - -/** - * IMPORTANT NOTE - * - * MCPStreamingResult can operate in two modes. The default mode is a safe implementation, - * which operates in a multithreaded fashion - a worker thread is set up to download the results as - * fast as possible in the background, while the results are made available via a blocking (and so - * single-thread-compatible) fetchNextRowAsArray call. This provides the benefit of allowing a progress - * bar to be shown during downloads, and threaded processing, but still has reasonable memory usage for - * the downloaded result - and won't block the server. - * Alternatively, withFullStreaming: can be set to YES, in which case each row will be accessed on-demand; - * this can be dangerous as it means a SELECT will tie up the server for longer, as for MyISAM tables - * updates (and subsequent reads) must block while a SELECT is still running. However this can be useful - * for certain processes such as working with very large tables to keep memory usage low. - */ - - -@interface MCPStreamingResult (PrivateAPI) - -void _bytes2bin(Byte *n, NSUInteger nbytes, NSUInteger len, char *buf); - -- (void) _downloadAllData; -- (void) _freeAllDataWhenDone; - -@end - -@implementation MCPStreamingResult : MCPResult - -#pragma mark - -#pragma mark Setup and teardown - -/** - * Initialise a MCPStreamingResult in the same way as MCPResult - as used - * internally by the MCPConnection !{queryString:} method. - */ -- (id)initWithMySQLPtr:(MYSQL *)mySQLPtr encoding:(NSStringEncoding)theEncoding timeZone:(NSTimeZone *)theTimeZone connection:(MCPConnection *)theConnection -{ - return [self initWithMySQLPtr:mySQLPtr encoding:theEncoding timeZone:theTimeZone connection:theConnection withFullStreaming:NO]; -} - -/** - * Master initialisation method, allowing selection of either full streaming or safe streaming - * (see "important note" above) - */ -- (id)initWithMySQLPtr:(MYSQL *)mySQLPtr encoding:(NSStringEncoding)theEncoding timeZone:(NSTimeZone *)theTimeZone connection:(MCPConnection *)theConnection withFullStreaming:(BOOL)useFullStreaming -{ - if ((self = [super init])) { - mEncoding = theEncoding; - mTimeZone = [theTimeZone retain]; - parentConnection = theConnection; - fullyStreaming = useFullStreaming; - connectionUnlocked = NO; - - if (mResult) { - mysql_free_result(mResult); - mResult = NULL; - } - - if (mNames) { - [mNames release]; - mNames = nil; - } - - mResult = mysql_use_result(mySQLPtr); - - if (mResult) { - mNumOfFields = mysql_num_fields(mResult); - fieldDefinitions = mysql_fetch_fields(mResult); - } else { - mNumOfFields = 0; - } - - // Obtain SEL references and pointer - isConnectedSEL = @selector(isConnected); - isConnectedPtr = [parentConnection methodForSelector:isConnectedSEL]; - - // If the result is opened in download-data-fast safe mode, set up the additional variables - // and threads required. - if (!fullyStreaming) { - dataDownloaded = NO; - dataFreed = NO; - localDataStore = NULL; - currentDataStoreEntry = NULL; - localDataStoreLastEntry = NULL; - localDataRows = 0; - localDataAllocated = 0; - downloadedRowCount = 0; - processedRowCount = 0; - freedRowCount = 0; - pthread_mutex_init(&dataCreationLock, NULL); - pthread_mutex_init(&dataFreeLock, NULL); - - // Start the data download thread - [NSThread detachNewThreadSelector:@selector(_downloadAllData) toTarget:self withObject:nil]; - - // Start the data freeing thread - [NSThread detachNewThreadSelector:@selector(_freeAllDataWhenDone) toTarget:self withObject:nil]; - } - } - - return self; -} - -/** - * Deallocate the result and unlock the parent connection for further use - */ -- (void) dealloc -{ - [self cancelResultLoad]; //this should close the connection if it is still open - - if (!connectionUnlocked) { - //this should NEVER happen - NSLog(@"MCPStreamingResult: The connection has not been unlocked."); - [parentConnection unlockConnection]; - } - - if (!fullyStreaming) { - pthread_mutex_destroy(&dataFreeLock); - pthread_mutex_destroy(&dataCreationLock); - } - - [super dealloc]; -} - -#pragma mark - -#pragma mark Results fetching - -/** - * Retrieve the next row of the result as an array. Should be called in a loop - * until nil is returned to ensure all the results have been retrieved. - */ -- (NSArray *)fetchNextRowAsArray -{ - MYSQL_ROW theRow; - char *theRowData, *buf; - unsigned long *fieldLengths; - NSUInteger i, copiedDataLength; - NSMutableArray *returnArray; - - // Retrieve the next row according to the mode this result set is in. - // If fully streaming, retrieve the MYSQL_ROW - if (fullyStreaming) { - theRow = mysql_fetch_row(mResult); - - // If no data was returned, we're at the end of the result set - unlock the connection and return nil - if (theRow == NULL) { - if (!connectionUnlocked) { - [parentConnection unlockConnection]; - connectionUnlocked = YES; - } - return nil; - } - - // Retrieve the lengths of the returned data - fieldLengths = mysql_fetch_lengths(mResult); - - // If in cached-streaming/fast download mode, get a reference to the data for the current row - } else { - copiedDataLength = 0; - - // Lock the data mutex - pthread_mutex_lock(&dataCreationLock); - - // Check to see whether we need to wait for the data to be availabe - // - if so, wait 1ms before checking again. - while (!dataDownloaded && processedRowCount == downloadedRowCount) { - pthread_mutex_unlock(&dataCreationLock); - usleep(1000); - pthread_mutex_lock(&dataCreationLock); - } - - // If all rows have been processed, we're at the end of the result set - return nil - // once all memory has been freed - if (processedRowCount == downloadedRowCount) { - pthread_mutex_unlock(&dataCreationLock); - - while (!dataFreed) usleep(1000); - - // Update the connection's error statuses in case of error during content download - [parentConnection updateErrorStatuses]; - - return nil; - } - - // Retrieve a reference to the data and the associated lengths - theRowData = currentDataStoreEntry->data; - fieldLengths = currentDataStoreEntry->dataLengths; - - // Unlock the data mutex - pthread_mutex_unlock(&dataCreationLock); - } - - // Initialise the array to return - returnArray = [NSMutableArray arrayWithCapacity:mNumOfFields]; - for (i = 0; i < mNumOfFields; i++) { - id cellData = nil; - char *theData = NULL; - - // In fully streaming mode, get a reference to the data for the MYSQL_ROW - if (fullyStreaming) { - if (theRow[i] == NULL) { - cellData = [NSNull null]; - } else { - theData = theRow[i]; - } - - // In cached-streaming mode, use a reference to the downloaded data - } else { - if (fieldLengths[i] == NSNotFound) { - cellData = [NSNull null]; - } else { - theData = theRowData+copiedDataLength; - copiedDataLength += fieldLengths[i] + 1; - } - } - - // If the data hasn't already been detected as NULL - in which case it will have been - // set to NSNull - process the data by type - - if (cellData == nil) { - switch (fieldDefinitions[i].type) { - case FIELD_TYPE_TINY: - case FIELD_TYPE_SHORT: - case FIELD_TYPE_INT24: - case FIELD_TYPE_LONG: - case FIELD_TYPE_LONGLONG: - case FIELD_TYPE_DECIMAL: - case FIELD_TYPE_NEWDECIMAL: - case FIELD_TYPE_FLOAT: - case FIELD_TYPE_DOUBLE: - case FIELD_TYPE_TIMESTAMP: - case FIELD_TYPE_DATE: - case FIELD_TYPE_TIME: - case FIELD_TYPE_DATETIME: - case FIELD_TYPE_YEAR: - case FIELD_TYPE_VAR_STRING: - case FIELD_TYPE_STRING: - case FIELD_TYPE_SET: - case FIELD_TYPE_ENUM: - case FIELD_TYPE_NEWDATE: // Don't know what the format for this type is... - - // For fields of type BINARY/VARBINARY, return the data. Also add an extra check to make - // sure it's binary data (seems that it's returned as type STRING) to get around a MySQL - // bug (#28214) returning DATE fields with the binary flag set. - if ((fieldDefinitions[i].flags & BINARY_FLAG) && - (fieldDefinitions[i].type == FIELD_TYPE_STRING || fieldDefinitions[i].type == FIELD_TYPE_VAR_STRING)) - { - cellData = [NSData dataWithBytes:theData length:fieldLengths[i]]; - } - // For string data, convert to text - else { - cellData = [[[NSString alloc] initWithBytes:theData length:fieldLengths[i] encoding:mEncoding] autorelease]; - } - - break; - - case FIELD_TYPE_BIT: - // Get a binary representation of the data - - buf = malloc(fieldDefinitions[i].length + 1); - _bytes2bin((Byte *)theData, fieldLengths[i], fieldDefinitions[i].length, buf); - - cellData = (theData != NULL) ? [NSString stringWithUTF8String:buf] : @""; - - free(buf); - break; - - case FIELD_TYPE_TINY_BLOB: - case FIELD_TYPE_BLOB: - case FIELD_TYPE_MEDIUM_BLOB: - case FIELD_TYPE_LONG_BLOB: - - // For binary data, return the data if force-return-as-string is not enabled - if ((fieldDefinitions[i].flags & BINARY_FLAG) && !mReturnDataAsStrings) { - cellData = [NSData dataWithBytes:theData length:fieldLengths[i]]; - } - else { - cellData = [[NSString alloc] initWithBytes:theData length:fieldLengths[i] encoding:mEncoding]; - - if (cellData) [cellData autorelease]; - } - - break; - - case FIELD_TYPE_NULL: - cellData = [NSNull null]; - break; - - case FIELD_TYPE_GEOMETRY: - cellData = [MCPGeometryData dataWithBytes:theData length:fieldLengths[i]]; - break; - - default: - NSLog(@"in fetchNextRowAsArray : Unknown type : %d for column %lu, sending back a NSData object", (int)fieldDefinitions[i].type, (unsigned long)i); - cellData = [NSData dataWithBytes:theData length:fieldLengths[i]]; - break; - } - - // If a creator returned a nil object, replace with NSNull - if (cellData == nil) cellData = [NSNull null]; - } - - [returnArray insertObject:cellData atIndex:i]; - } - - // If in cached-streaming mode, update the current entry processed count - if (!fullyStreaming) { - - // Lock both mutexes - pthread_mutex_lock(&dataCreationLock); - pthread_mutex_lock(&dataFreeLock); - - // Update the active-data pointer to the next item in the list, or set to NULL if no more items - currentDataStoreEntry = currentDataStoreEntry->nextRow; - - // Increment counter - processedRowCount++; - - // Unlock both mutexes - pthread_mutex_unlock(&dataCreationLock); - pthread_mutex_unlock(&dataFreeLock); - } - - return returnArray; -} - -/* - * Ensure the result set is fully processed and freed without any processing - * This method ensures that the connection is unlocked. - */ -- (void) cancelResultLoad -{ - MYSQL_ROW theRow; - - // Loop through all the rows and ensure the rows are fetched. - // If fully streaming, loop through the rows directly - if (fullyStreaming) { - while (1) { - theRow = mysql_fetch_row(mResult); - - // If no data was returned, we're at the end of the result set - return. - if (theRow == NULL) { - if (!connectionUnlocked) { - [parentConnection unlockConnection]; - connectionUnlocked = YES; - } - return; - } - } - - // If in cached-streaming/fast download mode, loop until all data is fetched and freed - } else { - - while (1) { - - // Check to see whether we need to wait for the data to be available - // - if so, wait 1ms before checking again - while (!dataDownloaded && processedRowCount == downloadedRowCount) usleep(1000); - - // If all rows have been processed, we're at the end of the result set - return - // once all memory has been freed - if (processedRowCount == downloadedRowCount) { - while (!dataFreed) usleep(1000); - // we don't need to unlock the connection because - // the data loading thread already did that - return; - } - processedRowCount++; - } - } -} - -#pragma mark - -#pragma mark Overrides for safety - -/** - * If numOfRows is used before the data is fully downloaded, -1 will be returned; - * otherwise the number of rows is returned. - */ -- (my_ulonglong)numOfRows -{ - if (!dataDownloaded) return -1; - - return downloadedRowCount; -} - -- (void)dataSeek:(my_ulonglong) row -{ - NSLog(@"dataSeek cannot be used with streaming results"); -} - -@end - -@implementation MCPStreamingResult (PrivateAPI) - -/** - * Provides a binary representation of the supplied chars (n) in the supplied buffer (buf). The resulting - * binary representation will be zero-padded according to the supplied field length (len). - */ -void _bytes2bin(Byte *n, NSUInteger nbytes, NSUInteger len, char *buf) -{ - - // NSUInteger i = 0; - // nbytes--; - // while (++i <= len) - // buf[len - i] = ( (n[nbytes - (i >> 3)] >> (i & 0x7)) & 1 ) ? '1' : '0'; - // - // buf[len] = '\0'; - // ↑ why does this code not working anymore? - - NSUInteger i = 0; - nbytes--; - len--; - while (i <= len) - buf[len - i++] = ( (n[nbytes - (i >> 3)] >> (i & 0x7)) & 1 ) ? '1' : '0'; - - buf[len+1] = '\0'; - -} - -/** - * Used internally to download results in a background thread - */ -- (void)_downloadAllData -{ - NSAutoreleasePool *downloadPool = [[NSAutoreleasePool alloc] init]; - MYSQL_ROW theRow; - unsigned long *fieldLengths; - NSUInteger i, dataCopiedLength, rowDataLength; - LOCAL_ROW_DATA *newRowStore; - - size_t sizeOfLocalRowData = sizeof(LOCAL_ROW_DATA); - size_t sizeOfDataLengths = (size_t)(sizeof(unsigned long) * mNumOfFields); - - // Loop through the rows until the end of the data is reached - indicated via a NULL - while ((*isConnectedPtr)(parentConnection, isConnectedSEL) && (theRow = mysql_fetch_row(mResult))) { - - // Retrieve the lengths of the returned data - fieldLengths = mysql_fetch_lengths(mResult); - rowDataLength = 0; - dataCopiedLength = 0; - for (i = 0; i < mNumOfFields; i++) - rowDataLength += fieldLengths[i]; - - // Initialise memory for the row and set a NULL pointer for the next item - newRowStore = malloc(sizeOfLocalRowData); - newRowStore->nextRow = NULL; - - // Set up the row data store - a char* - and copy in the data if there is any, - // using a null terminator for each field boundary for easier data processing later - newRowStore->data = malloc(sizeof(char) * (rowDataLength + mNumOfFields)); - for (i = 0; i < mNumOfFields; i++) { - if (theRow[i] != NULL) { - memcpy(newRowStore->data+dataCopiedLength, theRow[i], fieldLengths[i]); - newRowStore->data[dataCopiedLength+fieldLengths[i]] = '\0'; - dataCopiedLength += fieldLengths[i] + 1; - } else { - fieldLengths[i] = NSNotFound; - } - } - - // Set up and copy in the field lengths - newRowStore->dataLengths = memcpy(malloc(sizeOfDataLengths), fieldLengths, sizeOfDataLengths); - - // Lock both mutexes - pthread_mutex_lock(&dataCreationLock); - pthread_mutex_lock(&dataFreeLock); - - // Add the newly allocated row to end of the storage linked list - if (localDataStore) { - localDataStoreLastEntry->nextRow = newRowStore; - } else { - localDataStore = newRowStore; - } - localDataStoreLastEntry = newRowStore; - if (!currentDataStoreEntry) currentDataStoreEntry = newRowStore; - - // Update the downloaded row count - downloadedRowCount++; - - // Unlock both mutexes - pthread_mutex_unlock(&dataCreationLock); - pthread_mutex_unlock(&dataFreeLock); - } - - // Unlock the parent connection now data has been retrieved - [parentConnection unlockConnection]; - connectionUnlocked = YES; - - dataDownloaded = YES; - [downloadPool drain]; -} - -/** - * Used internally to free data which has been fully processed; done in a thread to allow - * fetchNextRowAsArray to be faster. - */ -- (void) _freeAllDataWhenDone -{ - NSAutoreleasePool *dataFreeingPool = [[NSAutoreleasePool alloc] init]; - - while (!dataDownloaded || freedRowCount != downloadedRowCount) { - - // Lock the data free mutex - pthread_mutex_lock(&dataFreeLock); - - // If the freed row count matches the processed row count, wait before retrying - if (freedRowCount == processedRowCount) { - pthread_mutex_unlock(&dataFreeLock); - usleep(1000); - continue; - } - - // Free a single item off the bottom of the list - // Update the data pointer to the next item in the list, or set to NULL if no more items - LOCAL_ROW_DATA *rowToRemove = localDataStore; - localDataStore = localDataStore->nextRow; - - // Free memory for the first row - rowToRemove->nextRow = NULL; - free(rowToRemove->dataLengths); - if (rowToRemove->data != NULL) free(rowToRemove->data); - free(rowToRemove); - - // Increment the counter - freedRowCount++; - - // Unlock the data free mutex - pthread_mutex_unlock(&dataFreeLock); - } - - dataFreed = YES; - [dataFreeingPool drain]; -} - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPStringAdditions.h b/Frameworks/MCPKit/MCPFoundationKit/MCPStringAdditions.h deleted file mode 100644 index bf57b789..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPStringAdditions.h +++ /dev/null @@ -1,46 +0,0 @@ -// -// $Id$ -// -// MCPStringAdditions.h -// sequel-pro -// -// Created by Stuart Connolly (stuconnolly.com) on March 25, 2010 -// Copyright (c) 2010 Stuart Connolly. All rights reserved. -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://code.google.com/p/sequel-pro/> - -#import <Foundation/Foundation.h> - -/** - * NSStringDataUsingLossyEncoding(aStr, enc, lossy) := [aStr dataUsingEncoding:enc allowLossyConversion:lossy] - */ -static inline NSData *NSStringDataUsingLossyEncoding(NSString *self, NSInteger encoding, NSInteger lossy) -{ - typedef NSData *(*SPStringDataUsingLossyEncodingMethodPtr)(NSString*, SEL, NSInteger, NSInteger); - static SPStringDataUsingLossyEncodingMethodPtr SPNSStringDataUsingLossyEncoding; - - if (!SPNSStringDataUsingLossyEncoding) SPNSStringDataUsingLossyEncoding = (SPStringDataUsingLossyEncodingMethodPtr)[self methodForSelector:@selector(dataUsingEncoding:allowLossyConversion:)]; - - return SPNSStringDataUsingLossyEncoding(self, @selector(dataUsingEncoding:allowLossyConversion:), encoding, lossy); -} - -@interface NSString (MCPStringAdditions) - -- (NSString *)backtickQuotedString; -- (NSString *)tickQuotedString; - -@end diff --git a/Frameworks/MCPKit/MCPFoundationKit/MCPStringAdditions.m b/Frameworks/MCPKit/MCPFoundationKit/MCPStringAdditions.m deleted file mode 100644 index bd5b06cd..00000000 --- a/Frameworks/MCPKit/MCPFoundationKit/MCPStringAdditions.m +++ /dev/null @@ -1,50 +0,0 @@ -// -// $Id$ -// -// MCPStringAdditions.m -// sequel-pro -// -// Created by Stuart Connolly (stuconnolly.com) on March 25, 2010 -// Copyright (c) 2010 Stuart Connolly. All rights reserved. -// -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; either version 2 of the License, or -// (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// More info at <http://code.google.com/p/sequel-pro/> - - - -@implementation NSString (MCPStringAdditions) - -/** - * Returns the string quoted with backticks as required for MySQL identifiers - * eg.: tablename => `tablename` - * my`table => `my``table` - */ -- (NSString *)backtickQuotedString -{ - return [NSString stringWithFormat: @"`%@`", [self stringByReplacingOccurrencesOfString:@"`" withString:@"``"]]; -} - -/** - * Returns the string quoted with ticks as required for MySQL identifiers - * eg.: tablename => 'tablename' - * my'table => 'my''table' - */ -- (NSString *)tickQuotedString -{ - return [NSString stringWithFormat: @"'%@'", [self stringByReplacingOccurrencesOfString:@"'" withString:@"''"]]; -} - -@end |