diff options
Diffstat (limited to 'Frameworks')
125 files changed, 9579 insertions, 12151 deletions
diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPAttribute.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPAttribute.h deleted file mode 100644 index 469d0808..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPAttribute.h +++ /dev/null @@ -1,106 +0,0 @@ -// -// $Id$ -// -// MCPAttribute.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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> - -@class MCPModel; -@class MCPClassDescription; -@class MCPRelation; -@class MCPJoin; - -@interface MCPAttribute : NSObject < NSCoding > -{ -@protected - MCPClassDescription *classDescription; // ClassDescription of which the attribute is attribute - NSString *name; // Name of the attribute (Obj-C side) - Class valueClass; // Class used by the attribute (or NULL if the internal type is not an object) - NSString *internalType; // Name of the class, or type used for the class definition - NSString *externalName; // Name of the corresponding column in the DB - NSString *externalType; // Type used to store the attribute (in the DB) - NSUInteger width; // Width (for storing by the DB) - BOOL allowsNull; // Attribute can be null - BOOL autoGenerated; // Attribute is auto generated by the DB - BOOL isPartOfKey; // Attribute is part of theprimary key of the class description - BOOL isPartOfIdentity; // Attribute is part of the idclass description of the class description - BOOL hasAccessor; // Does this attribute have an accessor - id defaultValue; // Default value of the attribute - NSMutableArray *joins; // An array of the joins using this attribute -} - -#pragma mark Class methods -+ (void) initialize; - -#pragma mark Life cycle -- (id) initForClassDescription:(MCPClassDescription *) iClassDescription withName:(NSString *) iName; -- (void) dealloc; - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder; -- (void) encodeWithCoder:(NSCoder *) encoder; - -#pragma mark Setters -- (void) setName:(NSString *) iName; -- (void) setValueClass:(Class) iValueClass; -- (void) setInternalType:(NSString *) iInternalType; -- (void) setExternalType:(NSString *) iExternalType; -- (void) setExternalName:(NSString *) iExternalName; -- (void) setWidth:(NSUInteger) iWidth; -- (void) setAllowsNull:(BOOL) iAllowsNull; -- (void) setAutoGenerated:(BOOL) iAutoGenerated; -- (void) setIsPartOfKey:(BOOL) iIsPartOfKey; -- (void) setIsPartOfIdentity:(BOOL) iIsPartOfIdentity; -- (void) setHasAccessor:(BOOL) iHasAccessor; -- (void) setDefaultValue:(id) iDefaultValue; -- (void) insertObject:(MCPJoin *) iJoin inJoinsAtIndex:(NSUInteger) index; -- (void) removeObjectFromJoinsAtIndex:(NSUInteger) index; -//- (void) addRelation:(MCPRelation *) iRelation; -//- (void) removeRelation:(MCPRelation *) iRelation; - -#pragma mark Getters -- (MCPClassDescription *) classDescription; -- (NSString *) name; -- (Class) valueClass; -- (NSString *) valueClassName; -- (NSString *) internalType; -- (NSString *) externalName; -- (NSString *) externalType; -- (NSUInteger) width; -- (BOOL) allowsNull; -- (BOOL) autoGenerated; -- (BOOL) isPartOfKey; -- (BOOL) isPartOfIdentity; -- (BOOL) hasAccessor; -- (id) defaultValue; -- (NSUInteger) countOfJoins; -- (MCPJoin *) objectInJoinsAtIndex:(NSUInteger) index; -- (NSUInteger) indexOfJoinIdenticalTo:(id) iJoin; - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPAttribute.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPAttribute.m deleted file mode 100644 index 085c1114..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPAttribute.m +++ /dev/null @@ -1,466 +0,0 @@ -// -// $Id$ -// -// MCPAttribute.m -// MCPkit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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 "MCPAttribute.h" - -#import "MCPEntrepriseNotifications.h" - -#import "MCPModel.h" -#import "MCPClassDescription.h" -#import "MCPRelation.h" -#import "MCPJoin.h" - -static NSArray *MCPRecognisedInternalType; - -@interface MCPAttribute (Private) - -- (void)setValueClassName:(NSString *) iClassName; - -@end - -@implementation MCPAttribute - -#pragma mark Class methods -+ (void) initialize -{ - if (self == [MCPAttribute class]) { - [self setVersion:010101]; // Ma.Mi.Re -> MaMiRe - MCPRecognisedInternalType = [[NSArray alloc] initWithObjects:@"NSCalendarDate", @"NSData", @"NSNumber", @"NSString", nil]; - [self setKeys:[NSArray arrayWithObject:@"internalType"] triggerChangeNotificationsForDependentKey:@"valueClassName"]; - [self setKeys:[NSArray arrayWithObject:@"valueClassName"] triggerChangeNotificationsForDependentKey:@"internalType"]; - } - return; -} - - -#pragma mark Life cycle -- (id) initForClassDescription:(MCPClassDescription *) iClassDescription withName:(NSString *) iName -{ - self = [super init]; - { - classDescription = iClassDescription; - [self setName:iName]; -// relations = (NSMutableArray *)(CFArrayCreateMutable (kCFAllocatorDefault, 0, NULL)); - joins = [[NSMutableArray alloc] init]; - } - return self; -} - -- (void) dealloc -{ -// NSArray *theRelations; -// unsigned int i; - - [name release]; - [internalType release]; - [externalName release]; - [externalType release]; - [defaultValue release]; -/* - while ([relations count]) { - [(MCPRelation *)[relations objectAtIndex:0] unjoinAttribute:self]; - } -// By now relation should be empty anyway... - [relations release]; - */ - while ([joins count]) { - [[self objectInJoinsAtIndex:0] invalidate]; - } - // By now the joins array should be empty - [joins release]; - [super dealloc]; -} - - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder -{ - self = [super init]; - if ((self) && ([decoder allowsKeyedCoding])) { - NSString *theClassName = [decoder decodeObjectForKey:@"MCPvalueClassName"]; - - classDescription = [decoder decodeObjectForKey:@"MCPclassDescription"]; - [self setName:[decoder decodeObjectForKey:@"MCPname"]]; - if (theClassName) { - [self setValueClass:NSClassFromString(theClassName)]; - } - [self setInternalType:[decoder decodeObjectForKey:@"MCPinternalType"]]; - [self setExternalName:[decoder decodeObjectForKey:@"MCPexternalName"]]; - [self setExternalType:[decoder decodeObjectForKey:@"MCPexternalType"]]; - [self setWidth:(NSUInteger)[decoder decodeInt32ForKey:@"MCPwidth"]]; - [self setAllowsNull:[decoder decodeBoolForKey:@"MCPallowsNull"]]; - [self setAutoGenerated:[decoder decodeBoolForKey:@"MCPautoGenerated"]]; - [self setIsPartOfKey:[decoder decodeBoolForKey:@"MCPisPartOfKey"]]; - [self setIsPartOfIdentity:[decoder decodeBoolForKey:@"MCPisPartOfIdentity"]]; - [self setHasAccessor:[decoder decodeBoolForKey:@"MCPhasAccessor"]]; - [self setDefaultValue:[decoder decodeObjectForKey:@"MCPdefaultValue"]]; -// Not sure that the next line is working (getting an array holding weak references), hence doing the thing expelcitly: -// relations = [[decoder decodeObjectForKey:@"MCPrelations"] retain]; -// relations = (NSMutableArray *)(CFArrayCreateMutable (kCFAllocatorDefault, 0, NULL)); -// [relations addObjectsFromArray:[decoder decodeObjectForKey:@"MCPrelations"]]; - joins = [[NSMutableArray alloc] init]; // Will be filled in when the relations are read in. - } - else { - NSLog(@"For some reason, unable to decode MCPAttribute from the coder!!!"); - } -// NSLog(@"MAKING a new object : %@", self); - return self; -} - -- (void) encodeWithCoder:(NSCoder *) encoder -{ - NSString *theValueClassName; - - if (! [encoder allowsKeyedCoding]) { - NSLog(@"In MCPAttribute -encodeWithCoder : Unable to encode to a non-keyed encoder!!, will not perform encoding!!"); - return; - } -// theValueClassName = (valueClass) ? [valueClass className] : nil; - theValueClassName = (valueClass) ? NSStringFromClass(valueClass) : nil; - [encoder encodeObject:[self classDescription] forKey:@"MCPclassDescription"]; - [encoder encodeObject:[self name] forKey:@"MCPname"]; - if (theValueClassName) { - [encoder encodeObject:theValueClassName forKey:@"MCPvalueClassName"]; - } - [encoder encodeObject:[self internalType] forKey:@"MCPinternalType"]; - [encoder encodeObject:[self externalName] forKey:@"MCPexternalName"]; - [encoder encodeObject:[self externalType] forKey:@"MCPexternalType"]; - [encoder encodeInt32:(int32_t)[self width] forKey:@"MCPwidth"]; - [encoder encodeBool:[self allowsNull] forKey:@"MCPallowsNull"]; - [encoder encodeBool:[self autoGenerated] forKey:@"MCPautoGenerated"]; - [encoder encodeBool:[self isPartOfKey] forKey:@"MCPisPartOfKey"]; - [encoder encodeBool:[self isPartOfIdentity] forKey:@"MCPisPartOfIdentity"]; - [encoder encodeBool:[self hasAccessor] forKey:@"MCPhasAccessor"]; - [encoder encodeObject:[self defaultValue] forKey:@"MCPdefaultValue"]; -// [encoder encodeObject:relations forKey:@"MCPrelation"]; - // We don't have to save the joins here ... the joins are saving there attributes. - // The links are recreated when the joins are decoded. -} - -#pragma mark Setters -- (void) setName:(NSString *) iName -{ - if (iName != name) { - [name release]; - name = [iName retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setValueClass:(Class) iValueClass -{ - if (iValueClass != valueClass) { - valueClass = iValueClass; - if (valueClass) { // Not nil : set the internalType accrodingly. - // [internalType release]; - // internalType = [[valueClass className] copy]; -// [self setValue:[NSString stringWithString:[valueClass className]] forKey:@"internalType"]; - [self setValue:[NSString stringWithString:NSStringFromClass(valueClass)] forKey:@"internalType"]; - } - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setInternalType:(NSString *) iInternalType -{ - if (iInternalType != internalType) { - [internalType release]; - internalType = [iInternalType retain]; - if ([MCPRecognisedInternalType containsObject:internalType]) { - [self setValueClass:NSClassFromString(internalType)]; -// By itself does NOT provide observers the update. -// but see setKeys:triggerChangeNotificationsForDependentKey... (in +initialize). - } - else { - [self setValueClass:nil]; - } - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setExternalType:(NSString *) iExternalType -{ - if (iExternalType != externalType) { - [externalType release]; - externalType = [iExternalType retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setExternalName:(NSString *) iExternalName -{ - if (iExternalName != externalName) { - [externalName release]; - externalName = [iExternalName retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setWidth:(NSUInteger) iWidth -{ - if (iWidth != width) { - width = iWidth; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setAllowsNull:(BOOL) iAllowsNull -{ - if (iAllowsNull != allowsNull) { - allowsNull = iAllowsNull; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setAutoGenerated:(BOOL) iAutoGenerated -{ - if (iAutoGenerated != autoGenerated) { - autoGenerated = iAutoGenerated; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setIsPartOfKey:(BOOL) iIsPartOfKey -{ - if (iIsPartOfKey != isPartOfKey) { - isPartOfKey = iIsPartOfKey; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setIsPartOfIdentity:(BOOL) iIsPartOfIdentity -{ - if (iIsPartOfIdentity != isPartOfIdentity) { - isPartOfIdentity = iIsPartOfIdentity; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setHasAccessor:(BOOL) iHasAccessor -{ - if (iHasAccessor != hasAccessor) { - hasAccessor = iHasAccessor; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) setDefaultValue:(id) iDefaultValue -{ - if (iDefaultValue != defaultValue) { - [defaultValue release]; - defaultValue = [iDefaultValue retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[classDescription model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:classDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPAttributeChangedNotification object:self]; - } -} - -- (void) insertObject:(MCPJoin *) iJoin inJoinsAtIndex:(NSUInteger) index -{ - [joins insertObject:iJoin atIndex:index]; -} - -- (void) removeObjectFromJoinsAtIndex:(NSUInteger) index -{ - [joins removeObjectAtIndex:index]; -} - -/* -- (void) addRelation:(MCPRelation *) iRelation -{ -// Following implementation make sure that a given relation is only added once... but I don't see the reason for that to be true. - /* if (NSNotFound == [relations indexOfObjectIdenticalTo:iRelation]) { - [relations addObject:iRelation]; - } - *//* - [relations addObject:iRelation]; -} - -- (void) removeRelation:(MCPRelation *) iRelation -{ -// Following implementation needs only one reference to a given relation to be working properly (not true) -// [relations removeObjectIdenticalTo:iRelation]; - unsigned int i; - - i = [relations indexOfObjectIdenticalTo:iRelation]; - if (NSNotFound != i) { - [relations removeObjectAtIndex:i]; - } -// If the relation is there more than once, remove it only once. -} -*/ - -#pragma mark Getters -- (MCPClassDescription *) classDescription -{ - return classDescription; -} - -- (NSString *) name -{ - return name; -} - -- (Class) valueClass -{ - return valueClass; -} - -- (NSString *) valueClassName -{ - return NSStringFromClass(valueClass); -} - -- (NSString *) internalType -{ - return internalType; -} - -- (NSString *) externalName -{ - return externalName; -} - -- (NSString *) externalType -{ - return externalType; -} - -- (NSUInteger) width -{ - return width; -} - -- (BOOL) allowsNull -{ - return allowsNull; -} - -- (BOOL) autoGenerated -{ - return autoGenerated; -} - -- (BOOL) isPartOfKey -{ - return isPartOfKey; -} - -- (BOOL) isPartOfIdentity -{ - return isPartOfIdentity; -} - -- (BOOL) hasAccessor -{ - return hasAccessor; -} - -- (id) defaultValue -{ - return defaultValue; -} - -- (NSUInteger) countOfJoins -{ - return [joins count]; -} - -- (MCPJoin *) objectInJoinsAtIndex:(NSUInteger) index -{ - return (MCPJoin *)((NSNotFound != index) ? [joins objectAtIndex:index] : nil); -} - -- (NSUInteger) indexOfJoinIdenticalTo:(id) iJoin -{ - return [joins indexOfObjectIdenticalTo:iJoin]; -} - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject -// Equal to another attribute, if they have the same name and same class description. -// Equal to a string (NSString), if the name of the attribute is equal to the string. -{ - if ([iObject isKindOfClass:[MCPAttribute class]]) { - MCPAttribute *theAttribute = (MCPAttribute *) iObject; - - return ([name isEqualToString:[theAttribute name]]) && ([classDescription isEqual:[theAttribute classDescription]]); - } - if ([iObject isKindOfClass:[NSString class]]) { - return [name isEqualToString:(NSString *)iObject]; - } - return NO; -} - -#pragma mark For debugging the retain counting -- (id) retain -{ - [super retain]; - return self; -} - -- (void) release -{ - [super release]; - return; -} - -@end - -@implementation MCPAttribute (Private) - -- (void)setValueClassName:(NSString *) iClassName -{ - if (NSClassFromString(iClassName) != valueClass) { - [self setValueClass:NSClassFromString(iClassName)]; - } -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+MCPEntreprise.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+MCPEntreprise.h deleted file mode 100644 index 052eeadb..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+MCPEntreprise.h +++ /dev/null @@ -1,47 +0,0 @@ -// -// $Id$ -// -// MCPClassDescription+MCPEntreprise.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 01/11/04. -// Copyright (c) 2004 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 "MCPClassDescription.h" - -@interface MCPClassDescription (MCPEntreprise) - -#pragma mark Pseudo getters (for NSClassDescription overload) -- (NSArray *) attributeKeys; -- (NSString *) inverseRelationshipKey:(NSString *) relationshipKey; -- (NSArray *) toManyRelationshipKeys; -- (NSArray *) toOneRelationshipKeys; - -#pragma mark Specifics for MCPObject -- (NSArray *) primaryKeyAttributes; -- (NSArray *) identityAttributes; -- (MCPAttribute *) attributeWithName: (NSString *) iName; -- (MCPRelation *) relationWithName:(NSString *) iRelationName; -- (BOOL) singleIntAutoGenKey; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+MCPEntreprise.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+MCPEntreprise.m deleted file mode 100644 index 71a25911..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+MCPEntreprise.m +++ /dev/null @@ -1,186 +0,0 @@ -// -// $Id$ -// -// MCPClassDescription+MCPEntreprise.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 01/11/04. -// Copyright (c) 2004 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 "MCPClassDescription+MCPEntreprise.h" - -#import "MCPAttribute.h" -#import "MCPRelation.h" - -@implementation MCPClassDescription (MCPEntreprise) - -#pragma mark Pseudo getters (for NSClassDescription overload) -- (NSArray *) attributeKeys -{ - NSArray *theRet; - NSMutableArray *theKeys =[[NSMutableArray alloc] init]; - NSUInteger i; - - for (i=0; i != [self countOfAttributes]; ++i) { - [theKeys insertObject:[(MCPAttribute *)[self objectInAttributesAtIndex:i] name] atIndex:i]; - } - theRet = [NSArray arrayWithArray:theKeys]; - [theKeys release]; - return theRet; -} - -- (NSString *) inverseRelationshipKey:(NSString *) relationshipKey -{ - NSUInteger index = [self indexOfRelation:relationshipKey]; - - if (NSNotFound != index) { - MCPRelation *theRelation; - - theRelation = (MCPRelation *)[self objectInRelationsAtIndex:index]; - return [[theRelation inverseRelation] name]; - } - return nil; -} - -- (NSArray *) toManyRelationshipKeys -{ - NSArray *theRet; - NSMutableArray *theToManyRel = [[NSMutableArray alloc] init]; - NSUInteger i, j; - - j=0; - for (i=0; i != [self countOfRelations]; ++i) { - MCPRelation *theRelation = (MCPRelation *)[self objectInRelationsAtIndex:i]; - - if ([theRelation isToMany]) { - [theToManyRel insertObject:[theRelation name] atIndex:j]; - ++j; - } - } - theRet = [NSArray arrayWithArray:theToManyRel]; - [theToManyRel release]; - return theRet; -} - -- (NSArray *) toOneRelationshipKeys; -{ - NSArray *theRet; - NSMutableArray *theToOneRel = [[NSMutableArray alloc] init]; - NSUInteger i, j; - - j=0; - for (i=0; i != [self countOfRelations]; ++i) { - MCPRelation *theRelation = (MCPRelation *)[self objectInRelationsAtIndex:i]; - - if (! [theRelation isToMany]) { - [theToOneRel insertObject:[theRelation name] atIndex:j]; - ++j; - } - } - theRet = [NSArray arrayWithArray:theToOneRel]; - [theToOneRel release]; - return theRet; -} - -#pragma mark Specifics for MCPObject -- (NSArray *) primaryKeyAttributes -{ - NSMutableArray *theRet = [NSMutableArray array]; - NSUInteger i, j; - - j = 0; - for (i=0; i != [self countOfAttributes]; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *)[self objectInAttributesAtIndex:i]; - - if ([theAttribute isPartOfKey]) { - [theRet insertObject:theAttribute atIndex:j]; - ++j; - } - } - return (NSArray *)theRet; -} - -- (NSArray *) identityAttributes -{ - NSMutableArray *theRet = [NSMutableArray array]; - NSUInteger i, j; - - j = 0; - for (i=0; i != [self countOfAttributes]; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *)[self objectInAttributesAtIndex:i]; - - if ([theAttribute isPartOfIdentity]) { - [theRet insertObject:theAttribute atIndex:j]; - ++j; - } - } - return (NSArray *)theRet; -} - -- (MCPAttribute *) attributeWithName: (NSString *) iName -{ -// This type of implementation is NOT working : most likely the isEqual method is called on iName rather than on the objects of the array -/* - unsigned int index = [self indexOfAttribute:iName]; - - return (NSNotFound != index) ? (MCPAttribute *)[self objectInAttributesAtIndex:index] : nil ; -*/ - NSUInteger i; - - for (i = 0; [attributes count] != i; ++i) { - if ([[(MCPAttribute *)[attributes objectAtIndex:i] name] isEqualToString:iName]) { - return (MCPAttribute *)[attributes objectAtIndex:i]; - } - } - return nil; -} - -- (MCPRelation *) relationWithName:(NSString *) iRelationName -{ -// This type of implementation is NOT working : most likely the isEqual method is called on iName rather than on the objects of the array -/* unsigned int index = [relations indexOfObject:iRelationName]; - - return (NSNotFound != index) ? (MCPRelation *)[relations objectAtIndex:index] : nil; -*/ - NSUInteger i; - - for (i = 0; [relations count] != i; ++i) { - if ([[(MCPRelation *)[relations objectAtIndex:i] name] isEqualToString:iRelationName]) { - return (MCPRelation *)[relations objectAtIndex:i]; - } - } - return nil; -} - -- (BOOL) singleIntAutoGenKey -{ - NSArray *theKeys = [self primaryKeyAttributes]; - - if (1 == [theKeys count]) { - MCPAttribute *theSingleKey = (MCPAttribute *)[theKeys objectAtIndex:0]; - - return [theSingleKey autoGenerated] && [[theSingleKey externalType] isEqualToString:@"INT"]; - } - return NO; -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+Private.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+Private.h deleted file mode 100644 index df86b763..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription+Private.h +++ /dev/null @@ -1,45 +0,0 @@ -// -// $Id$ -// -// MCPClassDescription+Private.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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 "MCPClassDescription.h" - -@interface MCPClassDescription (Private) - -#pragma mark Setters -- (void) setAttributes:(NSArray *) iAttributes; -- (void) setRelations:(NSArray *) iRelations; -- (void) insertObject:(MCPRelation *) iRelation inIncomingsAtIndex:(NSUInteger) index; -- (void) removeObjectFromIncomingsAtIndex:(NSUInteger) index; - -#pragma mark Getters -- (NSArray *) incomings; -- (NSUInteger) countOfIncomings; -- (MCPRelation *) objectInIncomingsAtIndex:(NSUInteger) index; -- (NSUInteger) indexOfIncoming:(id) iRelation; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription.h deleted file mode 100644 index cff3cf17..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription.h +++ /dev/null @@ -1,93 +0,0 @@ -// -// $Id$ -// -// MCPClassDescription.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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> - -@class MCPModel; -@class MCPAttribute; -@class MCPRelation; -@class MCPRelation; - -@interface MCPClassDescription : NSClassDescription <NSCoding> -{ -@protected - MCPModel *model; // The model where we stand - NSString *name; // Name of the class (can not use className, as it is already used by NSObject). - NSString *externalName; // Name of the table for storage - NSMutableArray *attributes; // array of the attributes of the class description - NSMutableArray *relations; // array of the relations of the class description (both origin and destination) - NSMutableArray *incomings; // array if the INCOMMING relation (just to be sure we are able to invalidate those if necessary) - Class representedClass; // the class object that the description represents. -} - -// This correspond to the method singleIntAutoGenKey in the category MCPEntreprise... which name should I change... - -#pragma mark Class methods -+ (void) initialize; - -#pragma mark Life cycle -- (id) initInModel:(MCPModel *) iModel withName:(NSString *) iName; -- (void) dealloc; - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder; -- (void) encodeWithCoder:(NSCoder *) encoder; - -#pragma mark Making new attributes and relations -- (MCPAttribute *) addNewAttributeWithName:(NSString *) iName inPosition:(NSInteger) index; -- (MCPRelation *) addNewRelationTo:(MCPClassDescription *) iTo name:(NSString *) iName inPostion:(NSInteger) index; - -#pragma mark Setters -- (void) setName:(NSString *) iName; -- (void) setExternalName:(NSString *) iExternalName; -- (void) insertObject:(MCPAttribute *) iAttribute inAttributesAtIndex:(NSUInteger) index; -- (void) removeObjectFromAttributesAtIndex:(NSUInteger) index; -- (void) insertObject:(MCPRelation *) iRelation inRelationsAtIndex:(NSUInteger) index; -- (void) removeObjectFromRelationsAtIndex:(NSUInteger) index; - -#pragma mark Getters -- (MCPModel *) model; -- (NSString *) name; -- (NSString *) externalName; -- (NSArray *) attributes; -- (NSUInteger) countOfAttributes; -- (MCPAttribute *) objectInAttributesAtIndex:(NSUInteger) index; -- (NSUInteger) indexOfAttribute:(id) iAttribute; -- (NSArray *) relations; -- (NSUInteger) countOfRelations; -- (MCPRelation *) objectInRelationsAtIndex:(NSUInteger) index; -- (NSUInteger) indexOfRelation:(id) iRelation; -- (Class) representedClass; - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject; - -#pragma mark Output for logging -- (NSString *) descriptionWithLocale:(NSDictionary *) locale; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription.m deleted file mode 100644 index 9f2ad18d..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPClassDescription.m +++ /dev/null @@ -1,373 +0,0 @@ -// -// $Id$ -// -// MCPClassDescription.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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 "MCPClassDescription.h" -#import "MCPClassDescription+Private.h" - -#import "MCPEntrepriseNotifications.h" - -#import "MCPModel.h" -#import "MCPAttribute.h" -#import "MCPRelation.h" - -@implementation MCPClassDescription - -#pragma mark Class methods -+ (void) initialize -{ - if (self = [MCPClassDescription class]) { - [self setVersion:010101]; // Major.Minor.Revision -> MaMiRe - } - return; -} - -#pragma mark Life cycle -- (id) initInModel:(MCPModel *) iModel withName:(NSString *) iName -{ - self = [super init]; - if (self) { - model = iModel; - [self setName:iName]; - attributes = [[NSMutableArray alloc] init]; - relations = [[NSMutableArray alloc] init]; - incomings = [[NSMutableArray alloc] init]; - representedClass = nil; - // NSLog(@"MAKING a new object : %@", self); - } - return self; -} - -- (void) dealloc -{ -// NSArray *theRelations; -// unsigned int i; - - [name release]; - [externalName release]; - [attributes release]; - while ([relations count]) { - [(MCPRelation *)[relations objectAtIndex:0] invalidateRelation]; - } - [relations release]; - while ([incomings count]) { - [(MCPRelation *)[incomings objectAtIndex:0] invalidateRelation]; - } - [incomings release]; - [super dealloc]; -} - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder -{ - self = [super init]; - if ((self) && ([decoder allowsKeyedCoding])) { - model = [decoder decodeObjectForKey:@"MCPmodel"]; -// NSLog(@"in MCPClassDescription initWithCoder, model = %@ (pointer = %p)", model, model); - [self setName:[decoder decodeObjectForKey:@"MCPname"]]; - [self setExternalName:[decoder decodeObjectForKey:@"MCPexternalName"]]; - [self setAttributes:[decoder decodeObjectForKey:@"MCPattributes"]]; -// [self setRelations:[decoder decodeObjectForKey:@"MCPrelations"]]; - relations = [[NSMutableArray alloc] init]; - incomings = [[NSMutableArray alloc] init]; - representedClass = nil; - [decoder decodeObjectForKey:@"MCPrelations"]; // The relation get linked properly while initted. - } - else { - NSLog(@"For some reason, unable to decode MCPClassDescription from the coder!!!"); - } - - return self; -} - -- (void) encodeWithCoder:(NSCoder *) encoder -{ - if (! [encoder allowsKeyedCoding]) { - NSLog(@"In MCPClassDescription -encodeWithCoder : Unable to encode to a non-keyed encoder!!, will not perform encoding!!"); - return; - } -// [encoder encodeObject:[self model] forKey:@"MCPmodel"]; - [encoder encodeConditionalObject:[self model] forKey:@"MCPmodel"]; - [encoder encodeObject:[self name] forKey:@"MCPname"]; - [encoder encodeObject:[self externalName] forKey:@"MCPexternalName"]; - [encoder encodeObject:[self attributes] forKey:@"MCPattributes"]; - [encoder encodeObject:[self relations] forKey:@"MCPrelations"]; - [encoder encodeObject:@"1.1.1" forKey:@"MCPversion"]; - return; -} - -#pragma mark Making new attributes and relations -- (MCPAttribute *) addNewAttributeWithName:(NSString *) iName inPosition:(NSInteger) index -{ - MCPAttribute *theAttribute = [[MCPAttribute alloc] initForClassDescription:self withName:iName]; - -// [self addAttribute:theAttribute]; - [self insertObject:theAttribute inAttributesAtIndex:(index < 0) ? ([self countOfAttributes] + index + 1) : index]; - [theAttribute release]; - return theAttribute; -} - -- (MCPRelation *) addNewRelationTo:(MCPClassDescription *) iTo name:(NSString *) iName inPostion:(NSInteger) index -{ - MCPRelation *theRelation = [[MCPRelation alloc] initWithName:iName from:self to:iTo]; - - [theRelation release]; - return theRelation; -} - -#pragma mark Setters -- (void) setName:(NSString *) iName -{ - if (iName != name) { - [name release]; - name = [iName retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; - representedClass = nil; - } -} - -- (void) setExternalName:(NSString *) iExternalName -{ - if (iExternalName != externalName) { - [externalName release]; - externalName = [iExternalName retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; - } -} - -- (void) insertObject:(MCPAttribute *) iAttribute inAttributesAtIndex:(NSUInteger) index -{ - [attributes insertObject:iAttribute atIndex:index]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; -} - -- (void) removeObjectFromAttributesAtIndex:(NSUInteger) index -{ - [attributes removeObjectAtIndex:index]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; -} - -- (void) insertObject:(MCPRelation *) iRelation inRelationsAtIndex:(NSUInteger) index -{ - [relations insertObject:iRelation atIndex:index]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; -} - -- (void) removeObjectFromRelationsAtIndex:(NSUInteger) index -{ - [relations removeObjectAtIndex:index]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; -} - -#pragma mark Getters -- (MCPModel *) model -{ - return model; -} - -- (NSString *) name -{ - return name; -} - -- (NSString *) externalName -{ - return externalName; -} - -- (NSArray *) attributes -{ - return [NSArray arrayWithArray:attributes]; -} - -- (NSUInteger) countOfAttributes -{ - return [attributes count]; -} - -- (MCPAttribute *) objectInAttributesAtIndex:(NSUInteger) index -{ - return (MCPAttribute *)((NSNotFound != index) ? [attributes objectAtIndex:index] : nil); -} - -- (NSUInteger) indexOfAttribute:(id) iAttribute -{ - return [attributes indexOfObject:iAttribute]; -} - -- (NSArray *) relations -{ - return [NSArray arrayWithArray:relations]; -} - -- (NSUInteger) countOfRelations -{ - return [relations count]; -} - -- (MCPRelation *) objectInRelationsAtIndex:(NSUInteger) index -{ - return (MCPRelation *)((NSNotFound != index) ? [relations objectAtIndex:index] : nil); -} - -- (NSUInteger) indexOfRelation:(id) iRelation -{ - return [relations indexOfObject:iRelation]; -} - -- (Class) representedClass -{ - if (representedClass) { - return representedClass; - } - representedClass = NSClassFromString(name); - return representedClass; -} - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject -// Equal to another class description if they have the same name. -// Equal to a string if the string is equal to the className of the class description. -{ - if ([iObject isKindOfClass:[MCPClassDescription class]]) { - return [name isEqualToString:[(MCPClassDescription *)iObject name]]; - } - if ([iObject isKindOfClass:[NSString class]]) { - return [name isEqualToString:(NSString *)iObject]; - } - return NO; -} - -/* -- (NSString *) description -{ - return [NSString stringWithFormat:@"<MCPClassDescription for class named %@ : %p>", [self name], self]; -} - -- (NSString *) descriptionWithLocale:(NSDictionary *) locale -{ - return [self description]; -} -*/ - -#pragma mark Output for logging - -- (NSString *)descriptionWithLocale:(NSDictionary *) locale -{ - NSUInteger i; - NSMutableString *theOutput = [NSMutableString string]; - - [theOutput appendFormat:@"MCPClassDescription for class : %@ (table : %@)\n", [self name], [self externalName]]; - for (i=0; [attributes count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *) [attributes objectAtIndex:i]; - - [theOutput appendFormat:@"attribute %u, name = %@, column = %@. Allows null : %c\n", i, [theAttribute name], [theAttribute externalName], ([theAttribute allowsNull] ? 'Y' : 'N')]; - } - return theOutput; -} - -#pragma mark For debugging the retain counting -- (id) retain -{ - [super retain]; - return self; -} - -- (void) release -{ - [super release]; - return; -} - -@end - -@implementation MCPClassDescription (Private) - -#pragma mark Setters -- (void) setAttributes:(NSArray *) iAttributes -{ - if (iAttributes != attributes) { - [attributes release]; - attributes = [[NSMutableArray alloc] initWithArray:iAttributes]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; - } -} - -- (void) setRelations:(NSArray *) iRelations -{ - if (iRelations != relations) { - [relations release]; - relations = [[NSMutableArray alloc] initWithArray:iRelations]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:model]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:self]; - } -} - -- (void) insertObject:(MCPRelation *) iRelation inIncomingsAtIndex:(NSUInteger) index -{ - if ([iRelation destination] == self) { - [incomings insertObject:iRelation atIndex:index]; - } - else { - NSLog(@"in -[MCPClassDescription+Private insertObject:inIncomingsAtIndex:]. ERRROR : self is NOT the destination of the relation"); - } -} - -- (void) removeObjectFromIncomingsAtIndex:(NSUInteger) index -{ - [incomings removeObjectAtIndex:index]; -} - -#pragma mark Getters -- (NSArray *) incomings -{ - return [NSArray arrayWithArray:incomings]; -} - -- (NSUInteger) countOfIncomings -{ - return [incomings count]; -} - -- (MCPRelation *) objectInIncomingsAtIndex:(NSUInteger) index -{ - return (MCPRelation *)[incomings objectAtIndex:index]; -} - -- (NSUInteger) indexOfIncoming:(id) iRelation -{ - return [incomings indexOfObject:iRelation]; -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPEntrepriseNotifications.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPEntrepriseNotifications.h deleted file mode 100644 index 1bb903c4..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPEntrepriseNotifications.h +++ /dev/null @@ -1,36 +0,0 @@ -// -// $Id$ -// -// MCPEnterpriseNotifications.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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> - -#pragma mark Name for notification - -extern NSString *MCPModelChangedNotification; -extern NSString *MCPClassDescriptionChangedNotification; -extern NSString *MCPAttributeChangedNotification; -extern NSString *MCPRelationChangedNotification; diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPEntrepriseNotifications.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPEntrepriseNotifications.m deleted file mode 100644 index ec4f3793..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPEntrepriseNotifications.m +++ /dev/null @@ -1,34 +0,0 @@ -// -// $Id$ -// -// MCPEnterpriseNotifications.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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> - -NSString *MCPModelChangedNotification = @"Model has changed"; -NSString *MCPClassDescriptionChangedNotification = @"ClassDescription has changed"; -NSString *MCPAttributeChangedNotification = @"Attribute has changed"; -NSString *MCPRelationChangedNotification = @"Relation has changed"; diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPJoin.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPJoin.h deleted file mode 100644 index 05e99f8d..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPJoin.h +++ /dev/null @@ -1,74 +0,0 @@ -// -// $Id$ -// -// MCPJoin.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 18/08/04. -// Copyright (c) 2004 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> - -@class MCPModel; -@class MCPClassDescription; -@class MCPAttribute; -@class MCPRelation; -@class MCPRelation; - -@interface MCPJoin : NSObject <NSCoding> -{ -@protected - // Note that NONE of these attributes are retained!!! - // Instead all these objects are notified of the existence of the join - // and are responsible to invalidate/delete it if necessary. - MCPRelation *relation; - MCPAttribute *origin; - MCPAttribute *destination; -} - -#pragma mark Class methods -+ (void) initialize; - -#pragma mark Life cycle -- (id) initForRelation:(MCPRelation *) iRelation from:(MCPAttribute *) iOrigin to:(MCPAttribute *) iDestination; -- (void) invalidate; -- (void) dealloc; - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder; -- (void) encodeWithCoder:(NSCoder *) encoder; - -#pragma mark Setters -// No setter for relation : should be set at init time! -- (void) setOrigin:(MCPAttribute *) iOrigin; -- (void) setDestination:(MCPAttribute *) iDestination; - -#pragma mark Getters -- (MCPRelation *) relation; -- (MCPAttribute *) origin; -- (MCPAttribute *) destination; -- (NSUInteger) index; - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPJoin.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPJoin.m deleted file mode 100644 index 576b1e10..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPJoin.m +++ /dev/null @@ -1,183 +0,0 @@ -// -// $Id$ -// -// MCPJoin.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 18/08/04. -// Copyright (c) 2004 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 "MCPJoin.h" - -#import "MCPModel.h" -#import "MCPClassDescription.h" -#import "MCPAttribute.h" -#import "MCPRelation.h" -#import "MCPRelation.h" - -@implementation MCPJoin - -#pragma mark Class methods -+ (void) initialize -{ - if (self = [MCPJoin class]) { - [self setVersion:010101]; // Ma.Mi.Re -> MaMiRe - } - return; -} - -#pragma mark Life cycle -- (id) initForRelation:(MCPRelation *) iRelation from:(MCPAttribute *) iOrigin to:(MCPAttribute *) iDestination; -{ - self = [super init]; - if (self) { - relation = iRelation; - [self setOrigin:iOrigin]; - [self setDestination:iDestination]; - } - return self; -} - -- (void) invalidate -{ - [self retain]; - NSLog(@"Enterring -[MCPJoin invalidate], retain count is %ld (after retaining : should be 4)", [self retainCount]); - [origin removeObjectFromJoinsAtIndex:[origin indexOfJoinIdenticalTo:self]]; - [destination removeObjectFromJoinsAtIndex:[destination indexOfJoinIdenticalTo:self]]; - [relation removeObjectFromJoinsAtIndex:[relation indexOfJoinIdenticalTo:self]]; - NSLog(@"Enterring -[MCPJoin invalidate], retain count is %ld (before releasing : should be 1)", [self retainCount]); - [self release]; - return; -} - -- (void) dealloc -{ - // Nothing to release, because the attributes are NOT retained. - [super dealloc]; -} - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder -{ - self = [super init]; - if ((self) && ([decoder allowsKeyedCoding])) { - relation = [decoder decodeObjectForKey:@"MCPrelation"]; - [self setOrigin:[decoder decodeObjectForKey:@"MCPorigin"]]; - [self setDestination:[decoder decodeObjectForKey:@"MCPdestination"]]; - } - else { - NSLog(@"For some reason, unable to decode MCPJoin from the coder!!!"); - } - return self; -} - -- (void) encodeWithCoder:(NSCoder *) encoder -{ - if (! [encoder allowsKeyedCoding]) { - NSLog(@"In MCPJoin -encodeWithCoder : Unable to encode to a non-keyed encoder!!, will not perform encoding!!"); - return; - } - [encoder encodeObject:[self relation] forKey:@"MCPrelation"]; - [encoder encodeObject:[self origin] forKey:@"MCPorigin"]; - [encoder encodeObject:[self destination] forKey:@"MCPdestination"]; -} - -#pragma mark Setters -- (void) setOrigin:(MCPAttribute *) iOrigin -{ - if (origin != iOrigin) { - if (origin) { - [origin removeObjectFromJoinsAtIndex:[origin indexOfJoinIdenticalTo:self]]; - } - origin = iOrigin; - if (origin) { - [origin insertObject:self inJoinsAtIndex:[origin countOfJoins]]; - } - } -} - -- (void) setDestination:(MCPAttribute *) iDestination -{ - if (destination != iDestination) { - if (destination) { - [destination removeObjectFromJoinsAtIndex:[destination indexOfJoinIdenticalTo:self]]; - } - destination = iDestination; - if (destination) { - [destination insertObject:self inJoinsAtIndex:[destination countOfJoins]]; - } - } -} - -#pragma mark Getters -- (MCPRelation *) relation -{ - return relation; -} - -- (MCPAttribute *) origin -{ - return origin; -} - -- (MCPAttribute *) destination -{ - return destination; -} - -- (NSUInteger) index -{ - return [relation indexOfJoinIdenticalTo:self]; -} - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject -{ - if ([iObject isKindOfClass:[MCPJoin class]]) { - MCPJoin *theJoin = (MCPJoin *)iObject; - - return ([relation isEqual:[theJoin relation]]) && ([origin isEqual:[theJoin origin]]) && ([destination isEqual:[theJoin destination]]); - } - if ([iObject isKindOfClass:[NSDictionary class]]) { - NSDictionary *theDict = (NSDictionary *)iObject; - - return ([relation isEqual:[theDict valueForKey:@"relation"]]) && ([origin isEqual:[theDict valueForKey:@"origin"]]) && ([destination isEqual:[theDict valueForKey:@"destination"]]); - } - return NO; -} - -#pragma mark For debugging the retain counting -- (id) retain -{ - [super retain]; - - return self; -} - -- (void) release -{ - [super release]; - - return; -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel+MCPEntreprise.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel+MCPEntreprise.h deleted file mode 100644 index 15aa9ed3..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel+MCPEntreprise.h +++ /dev/null @@ -1,35 +0,0 @@ -// -// $Id$ -// -// MCPModel+MCPEntreprise.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 01/11/04. -// Copyright (c) 2004 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://code.google.com/p/sequel-pro/> - -#import "MCPModel.h" - -@interface MCPModel (MCPEntreprise) - -- (void) registerAsClassDescriptionServer; -- (void) registerDescriptionForClass:(NSNotification *) notification; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel+MCPEntreprise.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel+MCPEntreprise.m deleted file mode 100644 index 2652f0dc..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel+MCPEntreprise.m +++ /dev/null @@ -1,57 +0,0 @@ -// -// $Id$ -// -// MCPModel+MCPEntreprise.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 01/11/04. -// Copyright (c) 2004 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 "MCPModel+MCPEntreprise.h" - -#import "MCPObject.h" - -@implementation MCPModel (MCPEntreprise) - -#pragma mark Work as a class description server - -- (void) registerAsClassDescriptionServer -{ - [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(registerDescriptionForClass:) name:NSClassDescriptionNeededForClassNotification object:nil]; -} - -- (void) registerDescriptionForClass:(NSNotification *) notification -{ - Class theClass = [notification object]; - - if ([theClass isSubclassOfClass:[MCPObject class]]) { - - NSString *theClassName = NSStringFromClass(theClass); - NSUInteger index = [self indexOfClassDescription:theClassName]; - - if (NSNotFound != index) { - [NSClassDescription registerClassDescription:(NSClassDescription *)[self objectInClassDescriptionsAtIndex:index] forClass:theClass]; - } - } -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel.h deleted file mode 100644 index 0a6c6afd..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel.h +++ /dev/null @@ -1,84 +0,0 @@ -// -// $Id$ -// -// MCPModel.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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> - -@class MCPClassDescription; -@class MCPAttribute; -@class MCPRelation; - -@interface MCPModel : NSObject <NSCoding> -{ -@protected - NSString *name; // Name of the model ... useless. - NSMutableArray *classDescriptions; // Order of the class descriptions in the model. - BOOL usesInnoDBTables; // The database should use InnoDB tables. - // Might add a string holding définition of tables. - // Might also add some sort of template for generated files (at least the header). -} - -#pragma mark Class methods -+ (void) initialize; - -#pragma mark Life cycle -- (id) initWithName:(NSString *) iName; -- (void) dealloc; - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder; -- (void) encodeWithCoder:(NSCoder *) encoder; - -#pragma mark Making new class description -- (MCPClassDescription *) addNewClassDescriptionWithName:(NSString *) iName inPosition:(NSInteger) index; - -#pragma mark Setters -- (void) setName:(NSString *) iName; -- (void) setClassDescriptions:(NSArray *) iClassDescriptions; -- (void) insertObject:(MCPClassDescription *) iClassDescription inClassDescriptionsAtIndex:(NSUInteger) index; -- (void) removeObjectFromClassDescriptionsAtIndex:(NSUInteger) index; -- (void) setUsesInnoDBTables:(BOOL) iUsesInnoDB; - -// Deprecated : non KVC -//- (void) removeClassDescription:(MCPClassDescription *) iClassDescription; -//- (void) addClassDescription:(MCPClassDescription *) iClassDescription; - -#pragma mark Getters -- (NSString *) name; -- (NSArray *) classDescriptions; -- (NSUInteger) countOfClassDescriptions; -- (MCPClassDescription *) objectInClassDescriptionsAtIndex:(NSUInteger) index; -- (NSUInteger) indexOfClassDescription:(id) iClassDescription; -- (BOOL) usesInnoDBTables; - -// Deprecated : non KVC -//- (MCPClassDescription *) classDescriptionWithClassName:(NSString *) iClassDescriptionClassName; - -#pragma mark Output for logging -- (NSString *) descriptionWithLocale:(NSDictionary *) locale; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel.m deleted file mode 100644 index 7c73eff1..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPModel.m +++ /dev/null @@ -1,230 +0,0 @@ -// -// $Id$ -// -// MCPModel.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 09/08/04. -// Copyright (c) 2004 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 "MCPModel.h" - -#import "MCPEntrepriseNotifications.h" - -#import "MCPClassDescription.h" -#import "MCPAttribute.h" -#import "MCPRelation.h" - -@implementation MCPModel - -#pragma mark Class methods -+ (void) initialize -{ - if (self = [MCPModel class]) { - [self setVersion:010101]; // Ma.Mi.Re -> MaMiRe - } - return; -} - -#pragma mark Life cycle -- (id) initWithName:(NSString *) iName -{ - self = [super init]; - if (self) { - [self setName:iName]; - classDescriptions = [[NSMutableArray alloc] init]; - } - - return self; -} - -- (void) dealloc -{ - [[NSNotificationCenter defaultCenter] removeObserver:self]; - [name release]; - [classDescriptions release]; - [super dealloc]; -} - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder -{ - self = [super init]; - if ((self) && ([decoder allowsKeyedCoding])) { - [self setName:[decoder decodeObjectForKey:@"MCPname"]]; - [self setClassDescriptions:[decoder decodeObjectForKey:@"MCPclassDescriptions"]]; - [self setUsesInnoDBTables:[decoder decodeBoolForKey:@"MCPusesInnoDBTables"]]; - } - else { - NSLog(@"For some reason, unable to decode MCPModel from the coder!!!"); - } - - return self; -} - -- (void) encodeWithCoder:(NSCoder *) encoder -{ - if (! [encoder allowsKeyedCoding]) { - NSLog(@"In MCPModel -encodeWithCoder : Unable to encode to a non-keyed encoder!!, will not perform encoding!!"); - return; - } -// [super encodeWithCoder:encoder]; - [encoder encodeObject:[self name] forKey:@"MCPname"]; - [encoder encodeObject:[self classDescriptions] forKey:@"MCPclassDescriptions"]; - [encoder encodeBool:[self usesInnoDBTables] forKey:@"MCPusesInnoDBTables"]; - [encoder encodeObject:@"1.1.1" forKey:@"MCPversion"]; - return; -} - -#pragma mark Making new class description -- (MCPClassDescription *) addNewClassDescriptionWithName:(NSString *) iName inPosition:(NSInteger) index; -{ - MCPClassDescription *theClassDescription = [[MCPClassDescription alloc] initInModel:self withName:iName]; - -// [self addClassDescription:theClassDescription]; - [self insertObject:theClassDescription inClassDescriptionsAtIndex:(index < 0) ? ([self countOfClassDescriptions] + index + 1) : index]; - [theClassDescription release]; - return theClassDescription; -} - -#pragma mark Setters -- (void) setName:(NSString *) iName -{ - if (iName != name) { - [name release]; - name = [iName retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; - } -} - -- (void) setClassDescriptions:(NSArray *) iClassDescriptions -{ - if (iClassDescriptions != classDescriptions) { - [classDescriptions release]; - classDescriptions = [[NSMutableArray alloc] initWithArray:iClassDescriptions]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; - } -} - -- (void) insertObject:(MCPClassDescription *) iClassDescription inClassDescriptionsAtIndex:(NSUInteger) index -{ - [classDescriptions insertObject:iClassDescription atIndex:index]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; -} - -- (void) removeObjectFromClassDescriptionsAtIndex:(NSUInteger) index -{ - [classDescriptions removeObjectAtIndex:index]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; -} - -- (void) setUsesInnoDBTables:(BOOL) iUsesInnoDB -{ - usesInnoDBTables = iUsesInnoDB; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; -} - -// Deprecated : non KVC -/* -- (void) removeClassDescription:(MCPClassDescription *) iClassDescription -{ - [classDescriptions removeObject:iClassDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; -} - - - (void) addClassDescription:(MCPClassDescription *) iClassDescription - { - [classDescriptions addObject:iClassDescription]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:self]; - } - - */ - -#pragma mark Getters -- (NSString *) name -{ - return name; -// return [NSString stringWithString:name]; -} - -- (NSArray *) classDescriptions -{ - return [NSArray arrayWithArray:classDescriptions]; -} - -- (NSUInteger) countOfClassDescriptions -{ - return [classDescriptions count]; -} - -- (MCPClassDescription *) objectInClassDescriptionsAtIndex:(NSUInteger) index -{ - return (MCPClassDescription *)((NSNotFound != index) ? [classDescriptions objectAtIndex:index] : nil); -} - -- (MCPClassDescription *) classDescriptionWithClassName:(NSString *) iClassDescriptionClassName -{ -// Given the implementation of isEqual: for the MCPClassDescription, one should be able to use NSArray method directly: - /* unsigned int i; - - for (i=0; ([classDescriptions count] != i) && (! [iClassDescriptionClassName isEqualToString:[(MCPClassDescription *) [classDescriptions objectAtIndex:i] className]]); ++i ) { - } - return (i == [classDescriptions count]) ? nil : (MCPClassDescription *)[classDescriptions objectAtIndex:i]; - */ - NSUInteger theIndex = [classDescriptions indexOfObject:iClassDescriptionClassName]; - return (NSNotFound == theIndex) ? nil : [classDescriptions objectAtIndex:theIndex]; -} - -- (NSUInteger) indexOfClassDescription:(id) iClassDescription -{ - return [classDescriptions indexOfObject:iClassDescription]; -} - -- (BOOL) usesInnoDBTables -{ - return usesInnoDBTables; -} - -// Deprecated : non KVC - -#pragma mark Output for logging -- (NSString *) descriptionWithLocale:(NSDictionary *) locale -{ - return [NSString stringWithFormat:@"<MCPModel with name %@ : %p>", [self name], self]; -} - -#pragma mark For debugging the retain counting -- (id) retain -{ - [super retain]; - - return self; -} - -- (void) release -{ - [super release]; - - return; -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPObject.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPObject.h deleted file mode 100644 index 4f126928..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPObject.h +++ /dev/null @@ -1,127 +0,0 @@ -// -// $Id$ -// -// MCPObject.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 19/05/04. -// Copyright (c) 2004 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> - -/*" Possible return code on some operations of the database interaction. "*/ -enum { - MCPDBReturnUnknown = 0, /*"Unknown state, should not happen."*/ - MCPDBReturnDeleted = 1, /*"The entry have been successfuly deleted from DB."*/ - MCPDBReturnUsed = 2, /*"The entry can not be removed, because some entries are still connected to it (some delete restrict/inhibit delete)."*/ - MCPDBReturnNone = 3, /*"No entry exist with this Id."*/ - MCPDBReturnNew = 4, /*"The entry was indeed new and inserted in the database."*/ - MCPDBReturnUpdated = 5, /*"The entry was updated in the DB."*/ - MCPDBReturnIncompleteKey = 6, /*"Part of the primary key is missing, action not taken."*/ - MCPDBReturnMultiple = 7, /*"Multiple rows are found with a query supposed to return at most one row."*/ - MCPDBReturnNoIdentity = 8, /*"The object does not have attributes that defines identity."*/ - MCPDBReturnNoKey = 9, /*"There is no primary key defined for this entity."*/ - MCPDBReturnNoConnection = 10, /*"The MCPObject is not having a connection."*/ - MCPDBReturnWrongRelationOrigin = 11, /*"Looking for a relation not which origin is not of the specified class."*/ - MCPDBReturnWrongRelationCardinality = 12, /*"Using a method assuming a cardinality of the relation while the relation as the other one."*/ - MCPDBReturnNoSuchRelation = 13, /*"There is no relation with such a name starting from this class."*/ - MCPDBReturnNotTarget = 14, /*"Tried to remove an object from a relation, while the objects does NOT belong to the relation."*/ - MCPDBReturnOK = 100 /*"Everything went OK."*/ -}; -typedef NSUInteger MCPDBReturnCode; - -@class MCPConnection; -@class MCPClassDescription; -@class MCPRelation; - -@interface MCPObject : NSObject { - MCPClassDescription *classDescription; - MCPConnection *connection; -} - -#pragma mark Life of the Object -/*" Life of the object "*/ -- (id) init; -- (id) initWithDictionary:(NSDictionary *) dictionary; - -- (void) dealloc; - -- (void) setAttributesToDefault; - -#pragma mark Accessors -/*" Accessor(s) "*/ -- (MCPClassDescription *) classDescription; -- (MCPConnection *) connection; - -- (void) setConnection:(MCPConnection *) iConnection; - -#pragma mark Database interface -/*" Database interface "*/ -- (id) readFromDBRow:(NSDictionary *) iDictionary withTableName:(NSString *) iTableName; -- (MCPDBReturnCode) setPrimaryKey:(id) iDictionary andFetchFromDB:(MCPConnection *) iConnection; -//- (MCPDBReturnCode) setPrimaryKey:(NSDictionary *) iDictionary andFetchFromDB:(MCPConnection *) iConnection; -- (NSDictionary *) checkDBId; // the returned dictionary contains a MCPDBReturnCode key with the return code. -- (NSDictionary *) saveInDB; // the returned dictionary contains a MCPDBReturnCode key with the return code. -- (MCPDBReturnCode) getAutoGenerated; -- (MCPDBReturnCode) updateInDB; -- (MCPDBReturnCode) deleteInDB; -+ (MCPDBReturnCode) deleteInDBUsingConnection:(MCPConnection *) iConnection withId:(id) iId; - -#pragma mark Handling relations -/*" Handling realtions "*/ -- (id) getTargetOfRelation:(MCPRelation *) iRelation; -- (id) getTargetOfRelationNamed:(NSString *) iRelationName; -- (MCPDBReturnCode) setTarget:(id) iTarget forRelation:(MCPRelation *) iRelation; -- (MCPDBReturnCode) setTarget:(id) iTarget forRelationNamed:(NSString *) iRelationName; -- (NSUInteger) countTargetForRelation:(MCPRelation *) iRelation; -- (NSUInteger) countTargetForRelationNamed:(NSString *) iRelationName; -- (MCPObject *) getTargetOfRelation:(MCPRelation *) iRelation atIndex:(NSUInteger) iIndex; -- (MCPObject *) getTargetOfRelationNamed:(NSString *) iRelationName atIndex:(NSUInteger) iIndex; -- (MCPDBReturnCode) addTarget:(MCPObject *) iTarget toRelation:(MCPRelation *) iRelation; -- (MCPDBReturnCode) addTarget:(MCPObject *) iTarget toRelationNamed:(NSString *) iRelationName; -- (MCPDBReturnCode) removeTarget:(MCPObject *) iTarget toRelation:(MCPRelation *) iRelation; -- (MCPDBReturnCode) removeTarget:(MCPObject *) iTarget toRelationNamed:(NSString *) iRelationName; -- (MCPDBReturnCode) removeTargetToRelation:(MCPRelation *) iRelation atIndex:(NSUInteger) iIndex; -- (MCPDBReturnCode) removeTargetToRelationNamed:(NSString *) iRelationName atIndex:(NSUInteger) iIndex; -- (NSUInteger) indexOfTarget:(MCPObject *) iTarget inRelation:(MCPRelation *) iRelation; -- (NSUInteger) indexOfTarget:(MCPObject *) iTarget inRelationNamed:(NSString *) iRelationName; - -#pragma mark Utilities -/*" Utility methods "*/ -- (id) defaultValueForKey:(NSString *) iKey; -- (NSDictionary *) primaryKey; - -/*" Testing equality (VERY important for relation management)"*/ -- (BOOL) isEqual:(id) iObject; - -#pragma mark Output -/*" Output : "*/ -- (NSString *) description; -- (NSString *) descriptionWithLocale:(NSDictionary *) locale; - -#pragma mark Ordering the array for relations -- (NSString *) orderSQLForClassDescription:(MCPClassDescription *) iClassDescription; - -/*" Anti-crash method... "*/ -- (void) setNilValueForKey:(NSString *) iKey; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPObject.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPObject.m deleted file mode 100644 index dba963c6..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPObject.m +++ /dev/null @@ -1,1342 +0,0 @@ -// -// $Id$ -// -// MCPObject.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 19/05/04. -// Copyright (c) 2004 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 "MCPObject.h" - -#import <MCPKit/MCPKit.h> - -#import "MCPClassDescription.h" -#import "MCPClassDescription+MCPEntreprise.h" -#import "MCPAttribute.h" -#import "MCPRelation.h" -#import "MCPJoin.h" - -@implementation MCPObject - -#pragma mark Life of the object -- (id) init -/*" Taking care of getting the class description for self (after passing the message up). "*/ -{ -// NSArray theAttributes; -// unsigned int i; - - if (self = [super init]) { - classDescription = [[NSClassDescription classDescriptionForClass:[self class]] retain]; - [self setAttributesToDefault]; -/* - theAttributes = [classDescription attributeKeys]; - for (i=0; [theAttributes count] != i; ++i) { // setting the attributtes with proper defaults. - NSString *theKey = (NSString *) [theAttributes objectAtIndex:i]; - - [self setValue:[self defaultValueForKey:theKey] forKey:theKey]; - } - */ - } - return self; -} - -- (id) initWithDictionary:(NSDictionary *) dictionary -/*" This method will use the class description to fetch in the dictionary the values of the attributes of the object.... - Should try to get this description a bit clearer."*/ -{ - self = [super init]; - if (self) { - NSUInteger i; - NSArray *attrArray; - - classDescription = [[NSClassDescription classDescriptionForClass:[self class]] retain]; - [self setAttributesToDefault]; - attrArray = [classDescription attributes]; - for (i=0; [attrArray count] != i; ++i) { - MCPAttribute *currentAttribute = (MCPAttribute *)[attrArray objectAtIndex:i]; - id currentValue = [dictionary objectForKey:[currentAttribute name]]; - - if (! currentValue) { - currentValue = [dictionary objectForKey:[currentAttribute externalName]]; - } - if (currentValue) { - [self setValue:currentValue forKey:[currentAttribute name]]; - } - } - } - return self; -} - -- (void) dealloc -/*" Deallocating the class description, then passes the message to super. "*/ -{ -// unsigned int i; -// NSArray *tmpAttributes = [classDescription attributes]; - -/* for (i=0; [tmpAttributes count] != i; ++i) { - MCPAttribute *tmpAttr = [tmpAttributes objectAtIndex:i]; - if ([tmpAttr valueClass]) { - [self setValue:nil forKey:[tmpAttr name]]; - } - } -*/ - [classDescription release]; - [connection release]; - [super dealloc]; -} - -- (void) setAttributesToDefault -/*" Set all the attributes to default values, except for auto-generated and primary key attributes, which are set to NULL. - - NOTE : !! In the current version the auto-generated and key are ALSO set to default values!!. - "*/ -{ - NSArray *theAttributes = [classDescription attributes]; -// NSArray *thePrimKeys = [classDescription primaryKeyAttributes]; - NSUInteger i; - - for (i=0; [theAttributes count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *) [theAttributes objectAtIndex:i]; - NSString *theKey = [theAttribute name]; - - if (! [theAttribute autoGenerated]) { - [self setValue:[self defaultValueForKey:theKey] forKey:theKey]; - } - else { // Auto-generated attribute ... set it to NULL: - [self setValue:[self defaultValueForKey:theKey] forKey:theKey]; - } - } -/* - for (i=0; [thePrimKeys count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *) [thePrimKeys objectAtIndex:i]; - if (! [theAttribute autoGenerated]) { - NSString *theKey = [theAttribute name]; - - [[self valueForKey:theKey] release]; - [self setValue:NULL forKey:theKey]; - } - } - */ - return; -} - -#pragma mark Accessor(s) -- (MCPClassDescription *) classDescription -{ - return classDescription; -} - -- (MCPConnection *) connection -{ - if ((! connection) || (! [connection checkConnection])) { - [self setConnection:nil]; - } - return connection; -} - -- (void) setConnection:(MCPConnection *) iConnection -{ - if (iConnection != connection) { - [connection release]; - connection = [iConnection retain]; - } -} - - - -#pragma mark Database interface -- (id) readFromDBRow:(NSDictionary *) iDictionary withTableName:(NSString *) iTableName -/*" Uses a query result row (described as a NSDictionary) to set the instance variables of self. If - the result contains columns from multiple tables, the iTableName can be used to specify the alias - used for the table name corresponding to the class. - -If iTableName == nil, the columns will be searched first without table name (column_name) and if - not found then with the table name in front (from the class description : table_name.column_name). - -Otherwise, the search will be performed in the following order : iTableName.column_name, column_name, - table_name.column_name. - "*/ -{ - NSArray *theAttributeKeys = [classDescription attributeKeys]; - NSArray *thePrefixArray; - NSUInteger i; - -// Depending on the value of iTableName, get the search order. - if ((nil == iTableName) || ([@"" isEqualToString:iTableName])) { - thePrefixArray = [NSArray arrayWithObjects:@"", [NSMutableString stringWithFormat:@"%@.", [classDescription externalName]], nil]; - } - else { - thePrefixArray = [NSArray arrayWithObjects:[NSString stringWithFormat:@"%@.", iTableName], [NSMutableString stringWithFormat:@"%@.", [classDescription externalName]], @"", nil]; - } - for (i=0; [theAttributeKeys count] != i; ++i) { - id theValue = nil; - MCPAttribute *theAttribute = [classDescription attributeWithName:[theAttributeKeys objectAtIndex:i]]; - NSUInteger j; - - for (j=0; [thePrefixArray count] != j; ++j) { - if (theValue = [iDictionary objectForKey:[NSString stringWithFormat:@"%@%@", [thePrefixArray objectAtIndex:j], [theAttribute externalName]]]) { - break; - } - } - if (theValue) { - [self takeValue:theValue forKey:[theAttribute name]]; - } - } - return self; -} - - -//- (MCPDBReturnCode) setPrimaryKey:(NSDictionary *) iDictionary andFetchFromDB:(MCPConnection *) iConnection -- (MCPDBReturnCode) setPrimaryKey:(id) iDictionary andFetchFromDB:(MCPConnection *) iConnection -/*" This method is used to retrieve an object from the DB given its precise primary key. It will return self. - If the object is not found in the DB, then all instance variable are set to the default - (and autogenerated/primary-key attributes are set to null)."*/ -{ - BOOL missingKey = NO; - NSArray *theKeyAttr = [classDescription primaryKeyAttributes]; - NSUInteger i; - NSMutableString *query = [NSMutableString stringWithFormat:@"SELECT * FROM %@ WHERE ", [classDescription externalName]]; - MCPResult *result; - NSDictionary *row; - - [self setConnection:iConnection]; - if (! iConnection) { - return MCPDBReturnNoConnection; - } - for (i=0; [theKeyAttr count] != i; ++i) { - MCPAttribute *theAttr = [classDescription attributeWithName:[(MCPAttribute *)[theKeyAttr objectAtIndex:i] name]]; - id theKeyValue; - -// if (theKeyValue = [iDictionary objectForKey:[theAttr name]]) { - if (theKeyValue = [iDictionary valueForKey:[theAttr name]]) { - if (i != 0) { - [query appendString:@" and "]; - } -// Implies the iDictionary IS a dictionary: -// [query appendFormat:@"(%@ = %@)", [theAttr externalName], [iConnection quoteObject:[iDictionary objectForKey:[theAttr name]]]]; -// If the iDictionary is just an object complying with NSValueCodeing: - [query appendFormat:@"(%@ = %@)", [theAttr externalName], [iConnection quoteObject:theKeyValue]]; - } - else { // Part of the primary key is missing... look for the DB name of the attribute - if (theKeyValue = [iDictionary valueForKey:[theAttr externalName]]) { - if (i != 0) { - [query appendString:@" and "]; - } - [query appendFormat:@"(%@ = %@)", [theAttr externalName], [iConnection quoteObject:theKeyValue]]; - } - else { // Not able to find the value for this attribute !!! - missingKey = YES; - NSLog(@"Unable to find the value for attribute %@ of object of class %@, will make it default", [theAttr name], [self className]); - break; - } - } - } // Now the query is prepared... or a key part is missing: - if (missingKey) { - [self setAttributesToDefault]; - return MCPDBReturnIncompleteKey; - } - result = [iConnection queryString:query]; - if ([result numOfRows] == 0) { - [self setAttributesToDefault]; - return MCPDBReturnNone; - } - row = [result fetchRowAsDictionary]; - [self readFromDBRow:row withTableName:@""]; - if ([result numOfRows] != 1) { - NSLog(@"Got more than one row when querying : %@.... will take only the first one!!! that an IMPORTANT flaw in your data model!!!", query); - return MCPDBReturnMultiple; - } - return MCPDBReturnOK; -} - - -- (NSDictionary *) checkDBId -/*" Using the identity properties of the class, this method will check if self already exists in the DB, - in which case it will set the primary key attributes to match the DB entry. If the object is not present - in the DB, the primary key attributes are set to null if they are declared as aut-generated (untouched otherwise). - -The returned dictionary contains the values of the primary key attributes. It also contains one entry with - key MCPDBReturnCode, which contains the result of the operation (was the object in DB?). - -If the identityAttributes of the class description is empty, the entry will always be considered not to be - in the DB, AND the primary key attributes of the object will be left unchnaged and returned as they are at - call time."*/ -{ - NSArray *theIdAttr = [classDescription identityAttributes]; - NSMutableDictionary *theKeys = [NSMutableDictionary dictionary]; - NSArray *theKeyAttr = [classDescription primaryKeyAttributes]; - MCPConnection *theConnection = [self connection]; - MCPResult *theResult; - NSUInteger i; - - if (! theConnection) { - return [NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithInteger:MCPDBReturnNoConnection], @"MCPDBReturnCode", nil]; - } - if (! [theKeyAttr count]) { // There is no primary key for this object. - [theKeys setObject:[NSNumber numberWithInteger:MCPDBReturnNoKey] forKey:@"MCPDBReturnCode"]; - return [NSDictionary dictionaryWithDictionary:theKeys]; - } - if (! [theIdAttr count]) { // Identity is not defined for this object. - [theKeys setObject:[NSNumber numberWithInteger:MCPDBReturnNoIdentity] forKey:@"MCPDBReturnCode"]; - for (i=0; [theKeyAttr count] != i; ++i) { - NSString *theKey = [(MCPAttribute*)[theKeyAttr objectAtIndex:i] name]; - [theKeys setObject:[self valueForKey:theKey] forKey:theKey]; - } - return [NSDictionary dictionaryWithDictionary:theKeys]; - } -// Do the fetch in the DB. - NSMutableString *theQuery = [NSMutableString stringWithString:@"SELECT "]; - - for (i = 0; [theKeyAttr count] != i; ++i) { - if (i) { - [theQuery appendString:@", "]; - } - [theQuery appendString:[(MCPAttribute *)[theKeyAttr objectAtIndex:i] externalName]]; - } - [theQuery appendFormat:@" FROM %@ WHERE ", [classDescription externalName]]; - for (i = 0; [theIdAttr count] != i; ++i) { - if (i) { - [theQuery appendString:@" AND "]; - } -/* - if ([[(MCPAttribute *)[theIdAttr objectAtIndex:i] valueClass] isSubclassOfClass:[NSString class]]) { - if ([(MCPAttribute *)[theIdAttr objectAtIndex:i] width] != 0) { - [theQuery appendFormat:@"(BINARY %@ = SUBSTRING(%@ FROM 1 FOR %u)", [(MCPAttribute *)[theIdAttr objectAtIndex:i] externalName], [theConnection quoteObject:[self valueForKey:[(MCPAttribute *)[theIdAttr objectAtIndex:i] name]]], [(MCPAttribute *)[theIdAttr objectAtIndex:i] width]]; - } - else { - [theQuery appendFormat:@"(BINARY %@ = %@)", [(MCPAttribute *)[theIdAttr objectAtIndex:i] externalName], [theConnection quoteObject:[self valueForKey:[(MCPAttribute *)[theIdAttr objectAtIndex:i] name]]]]; - } - } - */ - if (([[(MCPAttribute *)[theIdAttr objectAtIndex:i] valueClass] isSubclassOfClass:[NSString class]]) && ([(MCPAttribute *)[theIdAttr objectAtIndex:i] width] != 0)) { - [theQuery appendFormat:@"(%@ = SUBSTRING(%@ FROM 1 FOR %ld))", [(MCPAttribute *)[theIdAttr objectAtIndex:i] externalName], [theConnection quoteObject:[self valueForKey:[(MCPAttribute *)[theIdAttr objectAtIndex:i] name]]], [(MCPAttribute *)[theIdAttr objectAtIndex:i] width]]; - } - else { - [theQuery appendFormat:@"(%@ = %@)", [(MCPAttribute *)[theIdAttr objectAtIndex:i] externalName], [theConnection quoteObject:[self valueForKey:[(MCPAttribute *)[theIdAttr objectAtIndex:i] name]]]]; - } - } - [theQuery appendString:@" ORDER BY "]; - for (i = 0; [theKeyAttr count] != i; ++i) { - if (i) { - [theQuery appendString:@", "]; - } - [theQuery appendString:[(MCPAttribute *)[theKeyAttr objectAtIndex:i] externalName]]; - } - theResult = [theConnection queryString:theQuery]; - if ([theResult numOfRows]) { // the object was found. - NSDictionary *theFirstRow = [theResult fetchRowAsDictionary]; - if ([theResult numOfRows] != 1) { - NSLog(@"in MCPObject -checkDBIdWithConnection: method.... not only one (as expected) but %ld results were found, will take the first one."); - [theKeys setObject:[NSNumber numberWithInteger:MCPDBReturnMultiple] forKey:@"MCPDBReturnCode"]; - } - else { - [theKeys setObject:[NSNumber numberWithInteger:MCPDBReturnOK] forKey:@"MCPDBReturnCode"]; - } - [theKeys addEntriesFromDictionary:theFirstRow]; -// Setting the value of self for the primary key to the one just found. - for (i=0; [theKeyAttr count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *) [theKeyAttr objectAtIndex:i]; - - [self setValue:[theFirstRow objectForKey:[theAttribute externalName]] forKey:[theAttribute name]]; - } - } - else { // Object not found in the DB. - for (i = 0; [theKeyAttr count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *)[theKeyAttr objectAtIndex:i]; - - if ([theAttribute autoGenerated]) { - [self setValue:[self defaultValueForKey:[theAttribute name]] forKey:[theAttribute name]]; - } - [theKeys setObject:[self valueForKey:[theAttribute name]] forKey:[theAttribute name]]; - } - [theKeys setObject:[NSNumber numberWithInteger:MCPDBReturnNone] forKey:@"MCPDBReturnCode"]; -// Setting the value of self for the primary key to the default values. -/* - for (i=0; [theKeyAttr count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *) [theKeyAttr objectAtIndex:i]; - - [self setValue:[self defaultValueForKey:[theAttribute name]] forKey:[theAttribute name]]; - } -*/ - } - return [NSDictionary dictionaryWithDictionary:theKeys]; -} - - -- (NSDictionary *) saveInDB -/*" First will use the checkDBIdWithConnection method to check if the entry is already in the database. If this is the case, - it will use the updateInDB... method to update the current DB instance. Otherwise it will make an insert into the database - to save the entry, than it makes a select to get the value of autogenerated column, and use them (if necessary) to return - the primary key (as NSDictionary). - - As for checkDBId... the returned dictionary also have a MCPDBReturnCode key with a NSNumber as value containing the - return code of the operation."*/ -{ - MCPConnection *theConnection = [self connection]; - NSDictionary *theCheckReturn = [self checkDBId]; - NSMutableDictionary *theRet; - NSInteger theCheckCode = [(NSNumber *)[theCheckReturn objectForKey:@"MCPDBReturnCode"] integerValue]; - NSUInteger i; - NSUInteger j; - NSMutableString *theQuery = [NSMutableString string]; - NSArray *theAttr = [classDescription attributes]; - - switch (theCheckCode) { - case MCPDBReturnNoIdentity : // For this object the identity is not set... so we try to save. - break; - - case MCPDBReturnOK : // Object already in the DB (found using checkDBId... method). - // NSLog(@"in saveUsingConnection: the entry already existed so will update the one with key : %@", theCheckReturn); - theCheckCode = [self updateInDB]; - theRet = [NSMutableDictionary dictionaryWithDictionary:[self primaryKey]]; - [theRet setObject:[NSNumber numberWithInteger:theCheckCode] forKey:@"MCPDBReturnCode"]; - return [NSDictionary dictionaryWithDictionary:theRet]; - break; - - case MCPDBReturnMultiple : // Multiple were found, the first one will be updated. - NSLog(@"Multiple entries found with the same identity ... will update the first one."); - theCheckCode = [self updateInDB]; - theRet = [NSMutableDictionary dictionaryWithDictionary:[self primaryKey]]; - [theRet setObject:[NSNumber numberWithInteger:theCheckCode] forKey:@"MCPDBReturnCode"]; - return [NSDictionary dictionaryWithDictionary:theRet]; - break; - - case MCPDBReturnNone : // The entry is not already in the DB, save it... - break; - - case MCPDBReturnNoConnection : // Self does not have a connection. - NSLog(@"Can not save when the connection is not working..."); - break; - - default : // We should not arrive here anyway. - NSLog(@"For some resons we got a unexpected result from checkDBId : %ld", theCheckCode); - break; - } - -// Generate the INSERT query: - [theQuery appendFormat:@"INSERT INTO %@ (", [classDescription externalName]]; - j = 0; - for (i=0; [theAttr count] != i; ++i) { - if (! [(MCPAttribute *)[theAttr objectAtIndex:i] autoGenerated]) { - if (j) { - [theQuery appendString:@", "]; - } - [theQuery appendString:[(MCPAttribute *)[theAttr objectAtIndex:i] externalName]]; - ++j; - } - } - [theQuery appendString:@") VALUES ("]; - j = 0; - for (i=0; [theAttr count] != i; ++i) { - if (! [(MCPAttribute *)[theAttr objectAtIndex:i] autoGenerated]) { - if (j) { - [theQuery appendString:@", "]; - } - [theQuery appendString:[theConnection quoteObject:[self valueForKey:[(MCPAttribute *)[theAttr objectAtIndex:i] name]]]]; - ++j; - } - } - [theQuery appendString:@")"]; -// Finished preparing the query. - -// Now we perform the query... - [theConnection queryString:theQuery]; - if (1 != (i = [theConnection affectedRows])) { // More than one row affected ... Should NEVER occure. - NSLog(@"Problem while saving a MCPObject to the database : number of inserted rows is : %ld !!!", i); - NSLog(@"Maybe there is an error : %@ ", [theConnection getLastErrorMessage]); - NSLog(@"The class of the object is : %@, and it's description is :\n%@", [self className], [self descriptionWithLocale:nil]); - theCheckCode = (i == 0) ? MCPDBReturnNone : MCPDBReturnMultiple; - } - else { - theCheckCode = MCPDBReturnOK; - } - -// Finally we get the primary key of the inserted object: - if ([classDescription singleIntAutoGenKey]) { - NSString *thePrimKey = [(MCPAttribute *) [[classDescription primaryKeyAttributes] objectAtIndex:0] name]; - - [self setValue:[NSNumber numberWithLongLong:[theConnection insertId]] forKey:thePrimKey]; - } - [self getAutoGenerated]; - theRet = [NSMutableDictionary dictionaryWithDictionary:[self primaryKey]]; - [theRet setObject:[NSNumber numberWithInteger:theCheckCode] forKey:@"MCPDBReturnCode"]; - - return [NSDictionary dictionaryWithDictionary:theRet]; -} - - - -- (MCPDBReturnCode) getAutoGenerated -/*" This method will use the Identity attributes of the object to retrieve the autogenerated -attributes from the database. - -If the identity is not defined for this class/entity, then it will try to use the primary key -to get the auto-generated values. - -Obviously this might generate a bug if one of the Identity attributes is autogenerated. -This will create a trouble if some object does not have an identity defined but still contains -some auto-generated attributes. -"*/ -{ - NSMutableArray *theAutoAttr = [NSMutableArray array]; - NSArray *theAttr = [classDescription attributes]; - NSArray *theKeyAttr = [classDescription primaryKeyAttributes]; - NSUInteger i,j; - NSMutableString *theQuery; - NSInteger theCheckCode; - MCPResult *theResult; - NSDictionary *theRow; - MCPConnection *theConnection = [self connection]; - - if (! theConnection) { - return MCPDBReturnNoConnection; - } - - if (0 != [[classDescription identityAttributes] count]) { - theCheckCode = [(NSNumber *)[[self checkDBId] objectForKey:@"MCPDBReturnCode"] integerValue]; - if ((MCPDBReturnOK != theCheckCode) && (MCPDBReturnMultiple != theCheckCode)) { - NSLog(@"Unable to get the primary key for the object, will abort now the fetch of autoGenerated attributes (left unchanged)!"); - return theCheckCode; - } - if (MCPDBReturnMultiple == theCheckCode) { - NSLog(@"Will get the autoGenerated values for the first entry...."); - } - } - j = 0; - for (i=0; [theAttr count] != i; ++i) { // generate the array with autoGenerated attributes. - if ([(MCPAttribute *)[theAttr objectAtIndex:i] autoGenerated]) { - [theAutoAttr insertObject:[theAttr objectAtIndex:i] atIndex:j]; - ++j; - } - } - if (0 == [theAutoAttr count]) { - return MCPDBReturnOK; - } - -// Make the query: - theQuery = [NSMutableString stringWithString:@"SELECT "]; - for (i=0; [theAutoAttr count] != i; ++i) { - if (i) { - [theQuery appendString:@", "]; - } - [theQuery appendString:[(MCPAttribute *)[theAutoAttr objectAtIndex:i] externalName]]; - } - [theQuery appendFormat:@" FROM %@ WHERE ", [classDescription externalName]]; -// Preparing the Where Clause: - for (i=0; [theKeyAttr count] != i; ++i) { - if (i) { - [theQuery appendString:@" AND "]; - } - [theQuery appendFormat:@"( %@ = %@ )", [(MCPAttribute*)[theKeyAttr objectAtIndex:i] externalName], [theConnection quoteObject:[self valueForKey:[(MCPAttribute*)[theKeyAttr objectAtIndex:i] name]]]]; - } -// Query is ready: - theResult = [theConnection queryString:theQuery]; - if (! theResult) { - NSLog(@"While fetching the auto-generated part of the object, got an error -a nil MCPResult-. Will report that as a MCPDBReturnNone."); - return MCPDBReturnNone; - } - if (0 == [theResult numOfRows]) { // The entry was not found in the DB. - if (0 == [[classDescription identityAttributes] count]) { - NSLog(@"It seems that the object is not in the DB... but the identity is not defined so there might be a trouble with having the proper ID."); - } - return MCPDBReturnNone; - } -// Getting the values from the DB select: - theRow = [theResult fetchRowAsDictionary]; - for (i=0; [theAutoAttr count] != i; ++i) { - [self setValue:[theRow objectForKey:[(MCPAttribute*)[theAutoAttr objectAtIndex:i] externalName]] forKey:[(MCPAttribute*)[theAutoAttr objectAtIndex:i] name]]; - } -// Returning the proper value: - if (1 != [theResult numOfRows]) { - NSLog(@"Multiple entries (or none : %llu), got the values for the first one...", [theResult numOfRows]); - return MCPDBReturnMultiple; - } - return MCPDBReturnOK; -} - - -- (MCPDBReturnCode) updateInDB -/*"This method will use the primary key value held by the object to modify the object that is saved in the DB. - - (NO YET IMPLEMENTED) If the primary key is not complete (some of the attributes are to null or 0) and the identityAttributes - (from class description) is not an empty list then it will perform a checkDBId... to try to retrieve the - missing part of the primary key. - "*/ -{ - NSArray *theAttributes = [classDescription attributes]; - NSArray *thePrimKeyAttributes = [classDescription primaryKeyAttributes]; - NSMutableString *theQuery = [NSMutableString string]; - NSInteger theCheckCode; - NSUInteger i, j; - MCPConnection *theConnection = [self connection]; - - if (! theConnection) { - return MCPDBReturnNoConnection; - } -// Generate the query - [theQuery appendFormat:@"UPDATE %@ SET ", [classDescription externalName]]; - // Prepare the value key pairs: - j=0; - for (i=0 ; [theAttributes count] != i; ++i) { - id theValue = [self valueForKey:[(MCPAttribute *)[theAttributes objectAtIndex:i] name]]; - - if ((theValue) && (! [(MCPAttribute *)[theAttributes objectAtIndex:i] autoGenerated])) { - if (j) { - [theQuery appendString:@", "]; - } - [theQuery appendFormat:@"%@ = %@ ", [(MCPAttribute *)[theAttributes objectAtIndex:i] externalName], [theConnection quoteObject:theValue]]; - ++j; - } - } - if (0 == j) { // Nothing has to be updated in this entry.... - NSLog(@"Tried to update a row from an object that does NOT contain any information!!"); - return MCPDBReturnNone; - } - // Prepare the WHERE clause: - [theQuery appendFormat:@" WHERE "]; - j = 0; - for (i=0; [thePrimKeyAttributes count] != i; ++i) { - id theValue = [self valueForKey:[(MCPAttribute *)[thePrimKeyAttributes objectAtIndex:i] name]]; - - if (j) { - [theQuery appendString:@" AND "]; - } - if (theValue) { - [theQuery appendFormat:@"%@ = %@", [(MCPAttribute *)[thePrimKeyAttributes objectAtIndex:i] externalName], [theConnection quoteObject:theValue]]; - ++j; - } - } -// Perform the update: - if (j == [thePrimKeyAttributes count]) { - [theConnection queryString:theQuery]; - i = [theConnection affectedRows]; - switch (i) { - case 0 : - theCheckCode = MCPDBReturnNone; - break; - case 1 : - theCheckCode = MCPDBReturnOK; - break; - default : - theCheckCode = MCPDBReturnMultiple; - break; - } - } - else { - NSDictionary *theKeyCheck = [self checkDBId]; - NSInteger theIdCheckCode = [(NSNumber *) [theKeyCheck objectForKey:@"MCPDBReturnCode"] integerValue]; - - if (MCPDBReturnOK == theIdCheckCode) { - theCheckCode = [self updateInDB]; - } - else { - theCheckCode = MCPDBReturnNoKey; - } - } -// Return proper code: - return theCheckCode; -} - - -- (MCPDBReturnCode) deleteInDB -/*" Uses the connection to delete the object from the DB. In this process the autoGenerated attributes are set to null. - If the primary key is not completely set, this method calls checkDBId... method to try to complete it - (if the identityAttributes of the class description is not empty)."*/ -{ - NSArray *theKeyAttributes = [classDescription primaryKeyAttributes]; - NSArray *theAttributes = [classDescription attributes]; - NSUInteger i; -// NSMutableDictionary *theKeyValue = [NSMutableDictionary dictionary]; - NSInteger theCheckCode = MCPDBReturnOK; - MCPConnection *theConnection = [self connection]; - - if (! theConnection) { - return MCPDBReturnNoConnection; - } -// Get the value of the primary key: - for (i=0; [theKeyAttributes count] != i; ++i) { - id theValue = [self valueForKey:[(MCPAttribute*) [theKeyAttributes objectAtIndex:i] name]]; - if ((! theValue) || ([theValue isKindOfClass:[NSNumber class]] && (0 == [theValue integerValue]))) { - theCheckCode = MCPDBReturnIncompleteKey; - break; - } - } -// If incomplete, try to find the rest, and perform again: - if (MCPDBReturnIncompleteKey == theCheckCode) { - if (MCPDBReturnOK == [(NSNumber *)[[self checkDBId] objectForKey:@"MCPDBReturnCode"] integerValue]) { - return [self deleteInDB]; - } - else { - return MCPDBReturnIncompleteKey; - } - } - -// Perform the deletion from the DB: - theCheckCode = [[self class] deleteInDBUsingConnection:theConnection withId:self]; - -// set the auto-generated attributes to proper values: - for (i=0 ; [theAttributes count] != i; ++i) { - MCPAttribute *theAttribute = (MCPAttribute *) [theAttributes objectAtIndex:i]; - if ([theAttribute autoGenerated]) { -// [self setValue:NULL forKey:[theAttribute name]]; - [self setValue:[self defaultValueForKey:[theAttribute name]] forKey:[theAttribute name]]; - } - } - -// Finished... just have to return the proper value: - return theCheckCode; -} - - -+ (MCPDBReturnCode) deleteInDBUsingConnection:(MCPConnection *) iConnection withId:(id) iId -/*" Uses the connection to remove from the DB the entry corresponding to the primary key id given by iId. - If any part of the primary key is missing, nothing is done."*/ -{ - NSMutableString *theQuery = [NSMutableString string]; - MCPClassDescription *theClassDescription = (MCPClassDescription *) [NSClassDescription classDescriptionForClass:[self class]]; - NSArray *theKeyAttributes = [theClassDescription primaryKeyAttributes]; - NSUInteger i; - - if (! [iConnection checkConnection]) { - return MCPDBReturnNoConnection; - } -// Generate the query: - [theQuery appendFormat:@"DELETE FROM %@ WHERE ", [theClassDescription externalName]]; -// Prepare the WHERE STATEMENT: - for (i=0; [theKeyAttributes count] != i; ++i) { - if (i) { - [theQuery appendString:@" AND "]; - } -// [theQuery appendFormat:@"( %@ = %@ )", [(MCPAttribute*)[theKeyAttributes objectAtIndex:i] externalName], [iConnection quoteObject:[iId objectForKey:[(MCPAttribute*)[theKeyAttributes objectAtIndex:i] name]]]]; - [theQuery appendFormat:@"( %@ = %@ )", [(MCPAttribute*)[theKeyAttributes objectAtIndex:i] externalName], [iConnection quoteObject:[iId valueForKey:[(MCPAttribute*)[theKeyAttributes objectAtIndex:i] name]]]]; - } -// Perform the query: - [iConnection queryString:theQuery]; -// Return the proper code: - i = [iConnection affectedRows]; - - if (1 < i) { - return MCPDBReturnMultiple; - } - if (0 == i) { - return MCPDBReturnNone; - } - return MCPDBReturnOK; -} - - -#pragma mark Handling realtions -- (id) getTargetOfRelation:(MCPRelation *) iRelation -/*" This method is using the information from iRelation to fetch the targe of the relation in the DB. - -If iRelation is flagged as a to-one, then the return type is the type of the target object (value might be nil, if the target was not found). -If iRelation is flagged as a to-many, then the return type is NSArray (and might be empty if no target were found). - -In any case this method is first checking that iRelation is starting from the class of self, and that self is connected to the DB. -Also the returned object is ALWAYS autoreleased before being returned. -"*/ -{ - NSMutableString *query; - MCPClassDescription *destinationDesc; - NSArray *joins; - NSArray *keys; - NSArray *ids; - MCPResult *result; - NSUInteger i; - NSDictionary *theRow; - id theRet; - - if (! iRelation) { - NSLog(@"Tried to get the target of a relation... but the relation object is nil"); - } - else { -// NSLog(@"Trying to get the target of the realtion : %@", [iRelation descriptionWithLocale:nil]); - } - if ((! [connection isConnected]) || (! [classDescription isEqual:[iRelation origin]])) { // Error condition. - return nil; - } -// Generating the query: - destinationDesc = [iRelation destination]; - keys = [destinationDesc primaryKeyAttributes]; - joins = [iRelation joins]; - ids = [destinationDesc identityAttributes]; - query = [[NSMutableString alloc] initWithString:@"SELECT "]; - for (i=0; [keys count] != i; ++i) { - if (i) { - [query appendString:@", "]; - } - [query appendString:[(MCPAttribute *)[keys objectAtIndex:i] externalName]]; - } - [query appendFormat:@" FROM %@ WHERE ", [destinationDesc externalName]]; - for (i=0; [joins count] != i; ++i) { - MCPJoin *theJoin = (MCPJoin *)[joins objectAtIndex:i]; - - if (i) { - [query appendString:@" and "]; - } - [query appendFormat:@"(%@ = %@)", [[theJoin destination] externalName], [connection quoteObject:[self valueForKey:[[theJoin origin] name]]]]; - } -// NSLog(@"in -[MCPObject getTargetOfRelation:%@]; query is %@...", [iRelation descriptionWithLocale:nil], query); - [query appendString:[self orderSQLForClassDescription:destinationDesc]]; -// NSLog(@"in -[MCPObject getTargetOfRelation:%@]; query is %@...", [iRelation descriptionWithLocale:nil], query); -/* - [query appendString:@" ORDER BY "]; - for (i=0; [ids count] != i; ++i) { // Generating the order : - if (i) { - [query appendString:@", "]; - } - [query appendString:[(MCPAttribute *)[ids objectAtIndex:i] externalName]]; - } -*/ - result = [connection queryString:query]; - [query release]; - -// Getting the results in proper objects: - if ([iRelation isToMany]) { // To-Many relation - NSMutableArray *theArrayRet = [[NSMutableArray alloc] init]; - - theRet = theArrayRet; - while (theRow = [result fetchRowAsDictionary]) { - MCPObject *theTarget = [[[destinationDesc representedClass] alloc] init]; - - [theTarget setPrimaryKey:theRow andFetchFromDB:connection]; - [theArrayRet insertObject:theTarget atIndex:[theArrayRet count]]; - [theTarget release]; - } - } - else { // To-One relation - theRow = [result fetchRowAsDictionary]; - if (theRow) { - theRet = [[[destinationDesc representedClass] alloc] init]; - [theRet setPrimaryKey:theRow andFetchFromDB:connection]; - } - else { - theRet = nil; - } - } - [theRet autorelease]; - return theRet; -} - -- (id) getTargetOfRelationNamed:(NSString *) iRelationName -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self getTargetOfRelation:theRelation] : nil; -} - -- (MCPDBReturnCode) setTarget:(id) iTarget forRelation:(MCPRelation *) iRelation -/*" This method will modify the DB content so that the corresponding relation is deleted. - If any value corresping to an attribute of self is modified in the DB, then it will update all attributes of self to reflect DB status. - -Obviuosly this method is taking care of only to-one relation. It will hence check that iRelation is a to-one relation starting from self. -Finally, you can use setTarget:nil forRelation:... to 'delete' a previously establlished relation (if the model and DB permit it)."*/ -{ - NSUInteger i; - MCPObject *oldTarget; - - if (! [connection isConnected]) { - return MCPDBReturnNoConnection; - } - if (! [classDescription isEqual:[iRelation origin]]) { - return MCPDBReturnWrongRelationOrigin; - } - if ([iRelation isToMany]) { - return MCPDBReturnWrongRelationCardinality; - } - - oldTarget = [self getTargetOfRelation:iRelation]; - if ((oldTarget) && ([iTarget isEqual:oldTarget])) { // No need to change the relation's target. - return MCPDBReturnOK; - } - for (i=0; [iRelation countOfJoins] != i; ++i) { - MCPJoin *theJoin = [iRelation objectInJoinsAtIndex:i]; - - if (([[theJoin origin] isPartOfKey]) && (![[theJoin destination] isPartOfKey])) { // Will change the destination... - [iTarget setValue:[self valueForKey:[[theJoin origin] name]] forKey:[[theJoin destination] name]]; - [oldTarget setValue:[oldTarget defaultValueForKey:[[theJoin destination] name]] forKey:[[theJoin destination] name]]; - } - else { // Will change the origin - [self setValue:[iTarget valueForKey:[[theJoin destination] name]] forKey:[[theJoin origin] name]]; - } - } - if ([iRelation ownsDestination]) { - [oldTarget deleteInDB]; - } - return MCPDBReturnOK; -} - -- (MCPDBReturnCode) setTarget:(id) iTarget forRelationNamed:(NSString *) iRelationName -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self setTarget:iTarget forRelation:theRelation] : MCPDBReturnNoSuchRelation; -} - -- (NSUInteger) countTargetForRelation:(MCPRelation *) iRelation -{ - NSMutableString *theQuery; - NSUInteger i; - NSArray *theJoinArray; - MCPResult *theResult; - NSDictionary *theRow; - - if ((! [connection isConnected]) || (! [classDescription isEqual:[iRelation origin]])){ - return 0; - } - theJoinArray = [iRelation joins]; - theQuery = [[NSMutableString alloc] initWithFormat:@"SELECT COUNT(1) FROM %@ WHERE ", [[iRelation destination] externalName]]; - for (i=0; [theJoinArray count] != i; ++i) { - MCPJoin *theJoin = (MCPJoin *)[theJoinArray objectAtIndex:i]; - if (i) { - [theQuery appendString:@" AND "]; - } - [theQuery appendFormat:@"( %@ = %@ )", [[theJoin destination] externalName], [connection quoteObject:[self valueForKey:[[theJoin origin] name]]]]; - } - theResult = [connection queryString:theQuery]; - [theQuery release]; - theRow = [theResult fetchRowAsDictionary]; - return [(NSNumber *)[theRow objectForKey:@"COUNT(1)"] unsignedIntegerValue]; -} - -- (NSUInteger) countTargetForRelationNamed:(NSString *) iRelationName -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self countTargetForRelation:theRelation] : 0; -} - - -- (MCPObject *) getTargetOfRelation:(MCPRelation *) iRelation atIndex:(NSUInteger) iIndex -/*" This method will return the specific object which is the iIndex'th object of th relation (after ordering the object using the destination identity). - -This method (like other assuming order in the relation targets) will be doubtfull if the class does NOT have a single identity attribute."*/ -{ - NSMutableString *query; - MCPClassDescription *destinationDesc; - NSArray *joins; - NSArray *keys; - NSArray *ids; - MCPResult *result; - NSUInteger i; - NSDictionary *theRow; - MCPObject *theRet; - - if (! iRelation) { - NSLog(@"Tried to get the target of a relation... but the relation object is nil"); - } - else { -// NSLog(@"Trying to get the target of the realtion : %@", [iRelation descriptionWithLocale:nil]); - } - if ((! [connection isConnected]) || (! [classDescription isEqual:[iRelation origin]])) { // Error condition. - return nil; - } - if (! [iRelation isToMany]) { - NSLog(@"Tried to use the -[MCPObject getTargetOfRelation:atIndex:] on a to-one relation... this does NOT works!!! You should use -[MCPObject getTargetOfRelation:] instead!!!"); - return [self getTargetOfRelation:iRelation]; - } -// Generating the query: - destinationDesc = [iRelation destination]; - keys = [destinationDesc primaryKeyAttributes]; - joins = [iRelation joins]; - ids = [destinationDesc identityAttributes]; - query = [[NSMutableString alloc] initWithString:@"SELECT "]; - for (i=0; [keys count] != i; ++i) { - if (i) { - [query appendString:@", "]; - } - [query appendString:[(MCPAttribute *)[keys objectAtIndex:i] externalName]]; - } - [query appendFormat:@" FROM %@ WHERE ", [destinationDesc externalName]]; - for (i=0; [joins count] != i; ++i) { - MCPJoin *theJoin = (MCPJoin *)[joins objectAtIndex:i]; - - if (i) { - [query appendString:@" and "]; - } - [query appendFormat:@"(%@ = %@)", [[theJoin destination] externalName], [connection quoteObject:[self valueForKey:[[theJoin origin] name]]]]; - } - [query appendString:[self orderSQLForClassDescription:destinationDesc]]; -/* - [query appendString:@" ORDER BY "]; - for (i=0; [ids count] != i; ++i) { // Generating the order : - if (i) { - [query appendString:@", "]; - } - [query appendString:[(MCPAttribute *)[ids objectAtIndex:i] externalName]]; - } -*/ - [query appendFormat:@" LIMIT 1 OFFSET %ld", iIndex]; - result = [connection queryString:query]; - [query release]; - -// Getting the results in proper objects: - theRow = [result fetchRowAsDictionary]; - if (theRow) { - theRet = (MCPObject *)[[[destinationDesc representedClass] alloc] init]; - [theRet setPrimaryKey:theRow andFetchFromDB:connection]; - [theRet autorelease]; - } - else { - theRet = nil; - } - return theRet; -} - -- (MCPObject *) getTargetOfRelationNamed:(NSString *) iRelationName atIndex:(NSUInteger) iIndex -/*"This is the equivalent of the getTargetOfRelation:atIndex:, but giving a relation name instead of the MCPRelation object itself."*/ -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self getTargetOfRelation:theRelation atIndex:iIndex]: nil; -} - -- (MCPDBReturnCode) addTarget:(MCPObject *) iTarget toRelation:(MCPRelation *) iRelation -/*" This method will modify the DB content so that the corresponding relation is added. -If any value corresping to an attribute of self i modified in the DB, then it will update all attributes of self to reflect DB status. - -Obviuosly this method is taking care of only to-many relation. It will hence check that iRelation is a to-many relation starting from self."*/ -{ - NSArray *joins; - NSUInteger i; - NSDictionary *saveReturn; - - if (! [connection isConnected]) { - return MCPDBReturnNoConnection; - } - if (! [classDescription isEqual:[iRelation origin]]) { - return MCPDBReturnWrongRelationOrigin; - } - if (! [iRelation isToMany]) { - return MCPDBReturnWrongRelationCardinality; - } - joins = [iRelation joins]; - for (i=0; [joins count] != i; ++i) { // Will change only values of iTarget, because it is a to-many relation. - MCPJoin *join = (MCPJoin *)[joins objectAtIndex:i]; - - [iTarget setValue:[self valueForKey:[[join origin] name]] forKey:[[join destination] name]]; - } - if (! [[iTarget connection] isConnected]) { - [iTarget setConnection:connection]; - } - saveReturn = [iTarget saveInDB]; - return (MCPDBReturnCode)[(NSNumber *)[saveReturn objectForKey:@"MCPDBReturnCode"] unsignedIntegerValue]; -} - -- (MCPDBReturnCode) addTarget:(MCPObject *) iTarget toRelationNamed:(NSString *) iRelationName -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self addTarget:iTarget toRelation:theRelation] : MCPDBReturnNoSuchRelation; -} - -- (MCPDBReturnCode) removeTarget:(MCPObject *) iTarget toRelation:(MCPRelation *) iRelation -/*" This method will modify the DB content so that the corresponding relation is removed. -If any value corresping to an attribute of self i modified in the DB, then it will update all attributes of self to reflect DB status. - -Obviuosly this method is taking care of only to-many relation. It will hence check that iRelation is a to-many relation starting from self."*/ -{ - NSArray *joins; - NSUInteger i; -// NSDictionary *saveReturn; - BOOL targetIsTarget = YES; - MCPDBReturnCode returnCode; - - if (! [connection isConnected]) { - return MCPDBReturnNoConnection; - } - if (! [classDescription isEqual:[iRelation origin]]) { - return MCPDBReturnWrongRelationOrigin; - } - if (! [iRelation isToMany]) { - return MCPDBReturnWrongRelationCardinality; - } - joins = [iRelation joins]; - for (i=0; [joins count] != i; ++i) { - MCPJoin *join = (MCPJoin *)[joins objectAtIndex:i]; - targetIsTarget = targetIsTarget && [[iTarget valueForKey:[[join destination] name]] isEqual:[self valueForKey:[[join origin] name]]]; - } - if (! targetIsTarget) { - return MCPDBReturnNotTarget; - } - if ([iRelation ownsDestination]) { // just delete the target from the DB. - returnCode = [iTarget deleteInDB]; - } - for (i=0; [joins count] != i; ++i) { // Put all the destination to default... - MCPJoin *join = (MCPJoin *)[joins objectAtIndex:i]; - - [iTarget setValue:[[join destination] defaultValue] forKey:[[join destination] name]]; - } - if (! [iRelation ownsDestination]) { - returnCode = [(NSNumber *)[[iTarget saveInDB] objectForKey:@"MCPDBReturnCode"] unsignedIntegerValue]; - } - return returnCode; -} - -- (MCPDBReturnCode) removeTarget:(MCPObject *) iTarget toRelationNamed:(NSString *) iRelationName -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self removeTarget:iTarget toRelation:theRelation] : MCPDBReturnNoSuchRelation; -} - -- (MCPDBReturnCode) removeTargetToRelation:(MCPRelation *) iRelation atIndex:(NSUInteger) iIndex -/*" This method will use an index t first query the object that it should remove from the relation, then uses the -[MCPObject removeTarget:toRelation:] - method to remove the object from the relation. If the index is out of bound (the returned object is nil), it will return MCPDBReturnNone, to signal - there was no object with this index in the relation."*/ -{ - MCPObject *target; - - if (! [connection isConnected]) { - return MCPDBReturnNoConnection; - } - if (! [classDescription isEqual:[iRelation origin]]) { - return MCPDBReturnWrongRelationOrigin; - } - if (! [iRelation isToMany]) { - return MCPDBReturnWrongRelationCardinality; - } - target = [self getTargetOfRelation:iRelation atIndex:iIndex]; - if (target) { - return [self removeTarget:target toRelation:iRelation]; - } - else { - return MCPDBReturnNone; - } -} - -- (MCPDBReturnCode) removeTargetToRelationNamed:(NSString *) iRelationName atIndex:(NSUInteger) iIndex -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self removeTargetToRelation:theRelation atIndex:iIndex] : MCPDBReturnNoSuchRelation; -} - -- (NSUInteger) indexOfTarget:(MCPObject *) iTarget inRelation:(MCPRelation *) iRelation -/*" Returns the index of the target object within the relation. Return NSNotFound if the objkect is NOT in the relation!!"*/ -{ - NSMutableString *query; - NSArray *joins; - NSArray *keys; - NSArray *ids; - NSUInteger i; - MCPResult *result; - NSDictionary *row; - NSMutableDictionary *targetKey; - BOOL targetIsTarget = YES; - - if ((! [connection isConnected]) || (! [classDescription isEqual:[iRelation origin]]) || (! [iRelation isToMany])) { // Checking the realtion object. - return NSNotFound; - } - query = [[NSMutableString alloc] initWithString:@"SELECT "]; - joins = [iRelation joins]; -// keys = [[iRelation destination] attributeKeys]; - keys = [[iRelation destination] primaryKeyAttributes]; - ids = [[iRelation destination] identityAttributes]; - for (i=0; [keys count] != i; ++i) { - if (i) { - [query appendString:@", "]; - } - [query appendString:[(MCPAttribute *)[keys objectAtIndex:i] externalName]]; - } - [query appendFormat:@"FROM %@ WHERE ", [[iRelation destination] externalName]]; - for (i=0; [joins count] != i; ++i) { - MCPJoin *join = (MCPJoin *)[joins objectAtIndex:i]; - - targetIsTarget = targetIsTarget && [[iTarget valueForKey:[[join destination] name]] isEqual:[self valueForKey:[[join origin] name]]]; - if (i) { - [query appendString:@" AND "]; - } - [query appendFormat:@"( %@ = %@ )", [[join destination] externalName], [connection quoteObject:[self valueForKey:[[join origin] name]]]]; - } - if (! targetIsTarget) { // Checking that iTarget belongs to the relation. - [query release]; - return NSNotFound; - } - [query appendString:[self orderSQLForClassDescription:[iRelation destination]]]; -/* - [query appendString:@" ORDER BY "]; - for (i=0; [ids count] != i; ++i) { - if (i) { - [query appendString:@", "]; - } - [query appendString:[(MCPAttribute *)[ids objectAtIndex:i] externalName]]; - } -*/ - targetKey = [[NSMutableDictionary alloc] init]; - for (i=0; [keys count] != i; ++i) { // Setting the targetKey to the row that should gives the target. - MCPAttribute *attribute = (MCPAttribute *)[keys objectAtIndex:i]; - - [targetKey setObject:[iTarget valueForKey:[attribute name]] forKey:[attribute externalName]]; - } - result = [connection queryString:query]; - [query release]; - i = 0; - while (row = [result fetchRowAsDictionary]) { - if ([targetKey isEqualToDictionary:row]) { // We have found the proper object return i (after cleaning up); - [targetKey release]; - return i; - } - ++i; - } - return NSNotFound; -} - -- (NSUInteger) indexOfTarget:(MCPObject *) iTarget inRelationNamed:(NSString *) iRelationName -/*" The equivalent of -[MCPObject indexOfTarget:inRelation:] but using relation name instead of a MCPRelation -object. Indeed after getting the MCPRelation object corresponding to the name, this method will only return -the result of the corresponding call to -[MCPObject indexOfTarget:inRelation:]."*/ -{ - MCPRelation *theRelation = [classDescription relationWithName:iRelationName]; - return (theRelation) ? [self indexOfTarget:iTarget inRelation:theRelation] : NSNotFound; -} - -#pragma mark Utility methods -- (id) defaultValueForKey:(NSString *) iKey -/*" This method will return the default value (object) for the given key."*/ -{ - MCPAttribute *theAttribute = [classDescription attributeWithName:iKey]; - - if ([theAttribute allowsNull]) { -// return [NSNull null]; - return nil; - } - else { - Class theAttrClass = [theAttribute valueClass]; - id theRet; - - if ([theAttrClass isSubclassOfClass:[NSNumber class]]) { - return [NSNumber numberWithInteger:0]; - } - theRet = [[[theAttrClass alloc] init] autorelease]; - if (nil == theRet) { - NSLog(@"in MCPObject defaultValueForKey:%@ , for object of class %@, (attribute of class %@) the return value will be nil!!!", iKey, [self className], theAttrClass); - } - return theRet; - } -} - - -- (NSDictionary *) primaryKey -/*" Returns a dictionary with the values of the primary key. "*/ -{ - NSMutableDictionary *theRet = [NSMutableDictionary dictionary]; - NSArray *theIdAttr = [classDescription primaryKeyAttributes]; - NSUInteger i; - - for (i=0; [theIdAttr count] != i; ++i) { - NSString *theKey = [(MCPAttribute *)[theIdAttr objectAtIndex:i] name]; - - if ([self valueForKey:theKey]) { - [theRet setObject:[self valueForKey:theKey] forKey:theKey]; - } - else { - [theRet setObject:[NSNull null] forKey:theKey]; - } - } - return [NSDictionary dictionaryWithDictionary:theRet]; -} - -#pragma mark Testing equality (VERY important for relation management) -- (BOOL) isEqual:(id) iObject -{ - NSArray *theIdAttr; - NSUInteger i; - BOOL theRet; - - if (self == iObject) { - return YES; - } - if ([self class] != [iObject class]) { - return NO; - } - theIdAttr = [classDescription identityAttributes]; - for (i = 0; [theIdAttr count] != i; ++i) { - MCPAttribute *theAttr = [theIdAttr objectAtIndex:i]; - - theRet = theRet && [[self valueForKey:[theAttr name]] isEqual:[iObject valueForKey:[theAttr name]]]; - } - return theRet; -} - - -#pragma mark Output -- (NSString *) description -{ - return [self descriptionWithLocale:nil]; -} - -- (NSString *) descriptionWithLocale:(NSDictionary *) locale -{ - NSMutableString *theOutput = [NSMutableString string]; - NSUInteger i; - NSArray *theAttributes = [classDescription attributes]; - BOOL trunc = [MCPConnection truncateLongField]; - - [theOutput appendFormat:@"MCPObject subclass : %@\n", [self className]]; - - for (i = 0; [theAttributes count] != i; ++i) - { - MCPAttribute *theAttribute = (MCPAttribute *) [theAttributes objectAtIndex:i]; - id theValue = [self valueForKey:[theAttribute name]]; - - if (trunc) { - if (([theValue isKindOfClass:[NSString class]]) && (kLengthOfTruncationForLog < [(NSString *)theValue length])) { - theValue = [theValue substringToIndex:kLengthOfTruncationForLog]; - } - else if (([theValue isKindOfClass:[NSData class]]) && (kLengthOfTruncationForLog < [(NSData *)theValue length])) { - theValue = [NSData dataWithBytes:[theValue bytes] length:kLengthOfTruncationForLog]; - } - } - - [theOutput appendFormat:@"\tAttribute %ld : name = %@, value = %@\n", i, [theAttribute name], theValue]; - } - - [theOutput appendString:@"\n"]; - - return theOutput; -} - -#pragma mark Ordering the array for relations -- (NSString *) orderSQLForClassDescription:(MCPClassDescription *) iClassDescription -{ - NSMutableArray *theAttributes = [[NSMutableArray alloc] initWithArray:[iClassDescription identityAttributes]]; - NSMutableString *theReturn = [NSMutableString string]; - NSUInteger i; - - for (i = 0; [[iClassDescription primaryKeyAttributes] count] != i; ++i) { - [theAttributes insertObject:[[iClassDescription primaryKeyAttributes] objectAtIndex:i] atIndex:[theAttributes count]]; - } - for (i = 0; [theAttributes count] != i; ++i) { - if (i) { - [theReturn appendString:@", "]; - } - else { - [theReturn appendString:@" ORDER BY "]; - } - [theReturn appendString:[(MCPAttribute *)[theAttributes objectAtIndex:i] externalName]]; - } - return theReturn; -} - -#pragma mark Anti-crash method... -- (void) setNilValueForKey:(NSString *) iKey -{ - NSLog(@"Try to set %@ to nil .... not possible, will set it to zero instead...", iKey); - [self setValue:[NSNumber numberWithInteger:0] forKey:iKey]; -} - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation+Private.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation+Private.h deleted file mode 100644 index 2d3a7d8d..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation+Private.h +++ /dev/null @@ -1,46 +0,0 @@ -// -// $Id$ -// -// MCPRelation+Private.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 11/08/04. -// Copyright (c) 2004 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 "MCPRelation.h" - -@interface MCPRelation (Private) - -#pragma mark Making some work -- (void) invalidateJoins; // Check that the joins are realistics. - -#pragma mark Setters -- (void) setOrigin:(MCPClassDescription *) iOrigin; -//- (void) setJoins:(NSArray *) iJoins; - -#pragma mark Getters -- (MCPModel *) model; - -#pragma mark Fro the controller layer and the UI -- (void) addNewDefaultJoin; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation.h b/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation.h deleted file mode 100644 index 118734eb..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation.h +++ /dev/null @@ -1,112 +0,0 @@ -// -// $Id$ -// -// MCPRelation.h -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 11/08/04. -// Copyright (c) 2004 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> - -@class MCPModel; -@class MCPClassDescription; -@class MCPAttribute; -@class MCPJoin; - -typedef enum { - OnDeleteNullify = 1, - OnDeleteDeny = 2, - OnDeleteCascade = 3, - OnDeleteDefault = 4, - OnDeleteNoAction = 5 -} MCPRelationDeleteRule; - -@interface MCPRelation : NSObject <NSCoding> -{ -@protected - NSString *name; // Name of the relation - MCPRelationDeleteRule deleteRule; // Delete rule : what to do of the destination when origin is deleted - MCPRelation *inverseRelation; // The inverse relation (or nil if no inverse present) - MCPClassDescription *origin; // The class description from which the relation originate - MCPClassDescription *destination; // The class description to which the relation arrives - NSMutableArray *joins; // Joining attributes (array of MCPJoin) - BOOL isToMany; // Is the relation to many (or to one) - BOOL isMandatory; // Is the relation mandatory for the class description (origin) - BOOL ownsDestination; // The origin class description owns the destination class description(ies) -} - -#pragma mark Class methods -+ (void) initialize; - -+ (NSArray *) existingDeleteRules; -- (NSArray *) existingDeleteRules; - -#pragma mark Life cycle -- (id) initWithName:(NSString *) iName from:(MCPClassDescription *) iFrom to:(MCPClassDescription *) iTo; -- (void) invalidateRelation; -- (void) dealloc; - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder; -- (void) encodeWithCoder:(NSCoder *) encoder; - -#pragma mark Managing joins -//- (MCPJoin *) addNewJoin; -- (MCPJoin *) addJoinFrom:(MCPAttribute *) iFrom to:(MCPAttribute *) iTo; -- (void) removeJoinFrom:(MCPAttribute *) iFrom to:(MCPAttribute *) iTo; -//- (void) unjoinAttribute:(MCPAttribute *) iAttribute; - -#pragma mark Setters -- (void) setDestination:(MCPClassDescription *) iDestination; -- (void) setName:(NSString *) iName; -- (void) setDeleteRule:(MCPRelationDeleteRule) iDeleteRule; -- (void) setInverseRelation:(MCPRelation *) iInverseRelation; -- (void) insertObject:(MCPJoin *) iJoin inJoinsAtIndex:(NSUInteger) index; -- (void) removeObjectFromJoinsAtIndex:(NSUInteger) index; -- (void) setIsToMany:(BOOL) iIsToMany; -- (void) setIsMandatory:(BOOL) iIsMandatory; -- (void) setOwnsDestintation:(BOOL) iOwnsDestination; - -#pragma mark Getters -- (NSString *) name; -- (MCPRelationDeleteRule) deleteRule; -- (MCPRelation *) inverseRelation; -- (MCPClassDescription *) origin; -- (MCPClassDescription *) destination; -- (NSArray *) joins; -- (NSUInteger) countOfJoins; -- (MCPJoin *) objectInJoinsAtIndex:(NSUInteger) index; -- (NSUInteger) indexOfJoinIdenticalTo:(id) iJoin; -- (BOOL) isToMany; -- (BOOL) isMandatory; -- (BOOL) ownsDestination; - -#pragma mark Some Usefull methods -- (MCPAttribute *) destinationAttributeForOrigin:(MCPAttribute *) iFrom; -- (MCPAttribute *) originAttributeForDestination:(MCPAttribute *) iTo; - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject; -- (NSString *) descriptionWithLocale:(NSDictionary *) locale; - -@end diff --git a/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation.m b/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation.m deleted file mode 100644 index 6d1e58f4..00000000 --- a/Frameworks/MCPKit/MCPEntrepriseKit/MCPRelation.m +++ /dev/null @@ -1,486 +0,0 @@ -// -// $Id$ -// -// MCPRelation.m -// MCPKit -// -// Created by Serge Cohen (serge.cohen@m4x.org) on 11/08/04. -// Copyright (c) 2004 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 "MCPRelation.h" -#import "MCPRelation+Private.h" - -#import "MCPEntrepriseNotifications.h" - -#import "MCPModel.h" -#import "MCPClassDescription.h" -#import "MCPClassDescription+Private.h" -#import "MCPAttribute.h" - -#import "MCPJoin.h" - -static NSArray *MCPexistingDeleteRules; - -@implementation MCPRelation - -#pragma mark Class methods -+ (void) initialize -{ - if (self = [MCPRelation class]) { - NSMutableArray *theExistingDeleteRules = [[NSMutableArray alloc] init]; - - [self setVersion:010101]; // Ma.Mi.Re -> MaMiRe - - [theExistingDeleteRules addObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithUnsignedInteger:OnDeleteNullify], @"tag", @"Nullify", @"name", nil]]; - [theExistingDeleteRules addObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithUnsignedInteger:OnDeleteDeny], @"tag", @"Deny", @"name", nil]]; - [theExistingDeleteRules addObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithUnsignedInteger:OnDeleteCascade], @"tag", @"Cascade", @"name", nil]]; - [theExistingDeleteRules addObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithUnsignedInteger:OnDeleteDefault], @"tag", @"Default", @"name", nil]]; - [theExistingDeleteRules addObject:[NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithUnsignedInteger:OnDeleteNoAction], @"tag", @"No Action", @"name", nil]]; - MCPexistingDeleteRules = [[NSArray alloc] initWithArray:theExistingDeleteRules]; - [theExistingDeleteRules release]; - } - return; -} - -+ (NSArray *) existingDeleteRules -{ - return MCPexistingDeleteRules; -} - -- (NSArray *) existingDeleteRules -{ - return [MCPRelation existingDeleteRules]; -} - - -#pragma mark Life cycle -- (id) initWithName:(NSString *) iName from:(MCPClassDescription *) iFrom to:(MCPClassDescription *) iTo -{ - self = [super init]; - if (self) { - [self setName:iName]; - [self setOrigin:iFrom]; - [self setDestination:iTo]; - joins = [[NSMutableArray alloc] init]; - } - return self; -} - -- (void) invalidateRelation -{ - [self retain]; // To be sure not to be released before the end of the method - [self invalidateJoins]; // Remove each of the joins (so that attributes get notified) -/* - [origin removeObjectFromRelationsAtIndex:[[origin relations] indexOfObjectIdenticalTo:self]]; - origin = nil; - [destination removeObjectFromIncomingsAtIndex:[[destination incomings] indexOfObjectIdenticalTo:self]]; - destination = nil; -*/ - [self setOrigin:nil]; - [self setDestination:nil]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - [self release]; -} - -- (void) dealloc -{ - [joins release]; // Should be empty by now... - [name release]; -// The inverse relation don't have an inverse relation any more... -// [inverseRelation setInverseRelation:nil]; - [self setInverseRelation:nil]; -// Other are weak references. - [super dealloc]; -} - -#pragma mark NSCoding protocol -- (id) initWithCoder:(NSCoder *) decoder -{ - self = [super init]; - if ((self) && ([decoder allowsKeyedCoding])) { - [self setName:[decoder decodeObjectForKey:@"MCPname"]]; - [self setDeleteRule:(MCPRelationDeleteRule)[decoder decodeInt32ForKey:@"MCPdeleteRule"]]; - if ([decoder containsValueForKey:@"MCPinverseRelation"]) { - [self setInverseRelation:[decoder decodeObjectForKey:@"MCPinverseRelation"]]; - } - else { - [self setInverseRelation:nil]; - } - [self setOrigin:[decoder decodeObjectForKey:@"MCPorigin"]]; - [self setDestination:[decoder decodeObjectForKey:@"MCPdestination"]]; -// [self setJoins:[decoder decodeObjectForKey:@"MCPjoins"]]; - joins = [[NSMutableArray alloc] initWithArray:[decoder decodeObjectForKey:@"MCPjoins"]]; - [self setIsToMany:[decoder decodeBoolForKey:@"MCPisToMany"]]; - [self setIsMandatory:[decoder decodeBoolForKey:@"MCPisMandatory"]]; - [self setOwnsDestintation:[decoder decodeBoolForKey:@"MCPownsDestination"]]; - } - - return self; -} - -- (void) encodeWithCoder:(NSCoder *) encoder -{ - if (! [encoder allowsKeyedCoding]) { - NSLog(@"In MCPRelation -encodeWithCoder : Unable to encode to a non-keyed encoder!!, will not perform encoding!!"); - return; - } - [encoder encodeObject:[self name] forKey:@"MCPname"]; - [encoder encodeInt32:(int32_t)[self deleteRule] forKey:@"MCPdeleteRule"]; - if ([self inverseRelation]) { - [encoder encodeObject:[self inverseRelation] forKey:@"MCPinverseRelation"]; - } - [encoder encodeObject:[self origin] forKey:@"MCPorigin"]; - [encoder encodeObject:[self destination] forKey:@"MCPdestination"]; - [encoder encodeObject:[self joins] forKey:@"MCPjoins"]; - [encoder encodeBool:[self isToMany] forKey:@"MCPisToMany"]; - [encoder encodeBool:[self isMandatory] forKey:@"MCPisMandatory"]; - [encoder encodeBool:[self ownsDestination] forKey:@"MCPownsDestination"]; -} - -#pragma mark Making new joins -/* -- (MCPJoin *) addNewJoin // Usefull for the interface, to be able to create a new join by just using a binding. -{ - [self addJoinFrom:[origin objectInAttributesAtIndex:0] to:[destination objectInAttributesAtIndex:0]]; -} -*/ - -- (MCPJoin *) addJoinFrom:(MCPAttribute *) iFrom to:(MCPAttribute *) iTo -{ - MCPJoin *theJoin; - - if ([iFrom classDescription] != [self origin]) { - NSLog(@"Tried to make a join starting from an attribute (%@) that does NOT belong to the origin class description (%@)! Will not perform the link", iFrom, [self origin]); - return nil; - } - if ([iTo classDescription] != [self destination]) { - NSLog(@"Tried to make a join arriving to an attribute (%@) that does NOT belong to the destination class description (%@)! Will not perform the link", iTo, [self destination]); - return nil; - } - theJoin = [[MCPJoin alloc] initForRelation:self from:iFrom to:iTo]; -// theJoin = [[MCPJoin alloc] initFrom:iFrom to:iTo]; -// [joins addObject:theJoin]; - [joins insertObject:theJoin atIndex:[joins count]]; - [theJoin release]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - return theJoin; -} - -- (void) removeJoinFrom:(MCPAttribute *) iFrom to:(MCPAttribute *) iTo -{ - NSDictionary *theJoinDict = [[NSDictionary alloc] initWithObjectsAndKeys:self, @"relation", iFrom, @"origin", iTo, @"destination", nil]; - NSUInteger i = [joins indexOfObject:theJoinDict]; - - if (NSNotFound != i) { - [[self objectInJoinsAtIndex:i] invalidate]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } - [theJoinDict release]; -} - -/* -- (void) unjoinAttribute:(MCPAttribute *) iAttribute -{ - unsigned int i = 0; - -#warning HAVE to rewrite this code!!! - if ([[iAttribute classDescription] isEqual:origin]) { - for (i=0; ([joins count] != i) && ([iAttribute isEqual:[(MCPJoin *)[joins objectAtIndex:i] origin]]); ++i) { - } - } - if ([[iAttribute classDescription] isEqual:destination]) { - for (i=0; ([joins count] != i) && ([iAttribute isEqual:[(MCPJoin *)[joins objectAtIndex:i] destination]]); ++i) { - } - } - if ((0 == i) || ([joins count] == i)) { // No joins found using this attribute. - return; - } - [self removeJoinFrom:[(MCPJoin *)[joins objectAtIndex:i] origin] to:[(MCPJoin *)[joins objectAtIndex:i] destination]]; -} -*/ - -#pragma mark Setters -- (void) setDestination:(MCPClassDescription *) iDestination -{ - if (iDestination != destination) { - [destination removeObjectFromIncomingsAtIndex:[[destination incomings] indexOfObjectIdenticalTo:self]]; - destination = iDestination; - [destination insertObject:self inIncomingsAtIndex:0]; - [self invalidateJoins]; - } -} - - -- (void) setName:(NSString *) iName -{ - if (iName != name) { - [name release]; - name = [iName retain]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[origin model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:origin]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} - -- (void) setDeleteRule:(MCPRelationDeleteRule) iDeleteRule -{ - if (iDeleteRule != deleteRule) { // Don't do the notification for nothing!!! - deleteRule = iDeleteRule; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[origin model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:origin]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} - -- (void) setInverseRelation:(MCPRelation *) iInverseRelation -{ - if (iInverseRelation != inverseRelation) { - [inverseRelation release]; - inverseRelation = [iInverseRelation retain]; - [inverseRelation setInverseRelation:self]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[origin model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:origin]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} - -- (void) insertObject:(MCPJoin *) iJoin inJoinsAtIndex:(NSUInteger) index -{ - [joins insertObject:iJoin atIndex:index]; -} - -- (void) removeObjectFromJoinsAtIndex:(NSUInteger) index -{ - [joins removeObjectAtIndex:index]; -} - -- (void) setIsToMany:(BOOL) iIsToMany -{ - if (iIsToMany != isToMany) { // Don't do the notification for nothing!!! - isToMany = iIsToMany; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[origin model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:origin]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} - -- (void) setIsMandatory:(BOOL) iIsMandatory -{ - if (iIsMandatory != isMandatory) { // Don't do the notification for nothing!!! - isMandatory = iIsMandatory; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[origin model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:origin]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} - -- (void) setOwnsDestintation:(BOOL) iOwnsDestination -{ - if (iOwnsDestination != ownsDestination) { // Don't do the notification for nothing!!! - ownsDestination = iOwnsDestination; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPModelChangedNotification object:[origin model]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPClassDescriptionChangedNotification object:origin]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} - -#pragma mark Getters -- (NSString *) name -{ - return name; -} - -- (MCPRelationDeleteRule) deleteRule -{ - return deleteRule; -} - -- (MCPRelation *) inverseRelation -{ - return inverseRelation; -} - -- (MCPClassDescription *) origin -{ - return origin; -} - -- (MCPClassDescription *) destination -{ - return destination; -} - -- (NSArray *) joins -{ - return [NSArray arrayWithArray:joins]; -} - -- (NSUInteger) countOfJoins -{ - return [joins count]; -} - -- (MCPJoin *) objectInJoinsAtIndex:(NSUInteger) index -{ - return (MCPJoin *)((NSNotFound != index) ? [joins objectAtIndex:index] : nil); -} - -- (NSUInteger) indexOfJoinIdenticalTo:(id) iJoin -{ - return [joins indexOfObjectIdenticalTo:iJoin]; -} - -- (BOOL) isToMany -{ - return isToMany; -} - -- (BOOL) isMandatory -{ - return isMandatory; -} - -- (BOOL) ownsDestination -{ - return ownsDestination; -} - -#pragma mark Some Usefull methods - -- (MCPAttribute *) destinationAttributeForOrigin:(MCPAttribute *) iFrom -{ - NSUInteger i; - - for (i=0; ([joins count] != i) && ([[(MCPJoin *)[joins objectAtIndex:i] origin] isEqual:iFrom]); ++i) { - } - return ([joins count] == i) ? nil : [(MCPJoin *)[joins objectAtIndex:i] destination]; -} - -- (MCPAttribute *) originAttributeForDestination:(MCPAttribute *) iTo -{ - NSUInteger i; - - for (i=0; ([joins count] != i) && ([[(MCPJoin *)[joins objectAtIndex:i] destination] isEqual:iTo]); ++i) { - } - return ([joins count] == i) ? nil : [(MCPJoin *)[joins objectAtIndex:i] origin]; -} - - -#pragma mark Some general methods: -- (BOOL) isEqual:(id) iObject -// Equal to another relation, if they have the same name and same origin and destination class descriptions (they have the same names). -// Equal to a string (NSString), if the name of the relation is equal to the string. -{ - if ([iObject isKindOfClass:[MCPRelation class]]) { - MCPRelation *theRelation = (MCPRelation *) iObject; - - return ([name isEqualToString:[theRelation name]]) && ([[self origin] isEqual:[theRelation origin]]) && ([[self destination] isEqual:[theRelation destination]]); - } - if ([iObject isKindOfClass:[NSString class]]) { - return [name isEqualToString:(NSString *)iObject]; - } - return NO; -} - -- (NSString *) descriptionWithLocale:(NSDictionary *) locale -{ - NSMutableString *theRet = [NSMutableString stringWithFormat:@"MCPRelation named %@, going from %@ to %@. Joins :\n", name, [origin name], [destination name]]; - NSUInteger i; - - for (i = 0; [joins count] != i; ++i) { - MCPJoin *tmpJoin = (MCPJoin *)[joins objectAtIndex:i]; - [theRet appendFormat:@"\t\t%@ == %@\n", [[tmpJoin origin] name], [[tmpJoin destination] name]]; - } - return theRet; -} - - -#pragma mark For debugging the retain counting -- (id) retain -{ - [super retain]; - return self; -} - -- (void) release -{ - [super release]; - return; -} - -@end - -@implementation MCPRelation (Private) - -#pragma mark Making some work -- (void) invalidateJoins -{ - while ([joins count]) { - [[self objectInJoinsAtIndex:0] invalidate]; - } - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; -} - -#pragma mark Setters -- (void) setOrigin:(MCPClassDescription *) iOrigin -{ - if (iOrigin != origin) { - [origin removeObjectFromRelationsAtIndex:[[origin relations] indexOfObjectIdenticalTo:self]]; - origin = iOrigin; - [origin insertObject:self inRelationsAtIndex:[origin countOfRelations]]; - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - [self invalidateJoins]; - } -} - -/* -- (void) setJoins:(NSArray *) iJoins -{ - if (iJoins != joins) { - unsigned int i; - if (joins) { - [self invalidateJoins]; - } - else { - joins = [[NSMutableArray alloc] init]; - } - for (i=0; [iJoins count] != i; ++i) { - [self addJoinFrom:[(MCPJoin *)[iJoins objectAtIndex:i] origin] to:[(MCPJoin *)[iJoins objectAtIndex:i] destination]]; - } - [[NSNotificationCenter defaultCenter] postNotificationName:MCPRelationChangedNotification object:self]; - } -} -*/ - -#pragma mark Getters -- (MCPModel *) model -{ - return [origin model]; -} - -#pragma mark Fro the controller layer and the UI -- (void) addNewDefaultJoin // Usefull for the interface, to be able to create a new join by just using a binding. -{ - [self addJoinFrom:[origin objectInAttributesAtIndex:0] to:[destination objectInAttributesAtIndex:0]]; -} - -@end 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 diff --git a/Frameworks/MCPKit/MySQL/lib/libmysqlclient.a b/Frameworks/MCPKit/MySQL/lib/libmysqlclient.a Binary files differdeleted file mode 100644 index 969697fb..00000000 --- a/Frameworks/MCPKit/MySQL/lib/libmysqlclient.a +++ /dev/null diff --git a/Frameworks/MCPKit/MySQL/lib/libmysqlclient_r.a b/Frameworks/MCPKit/MySQL/lib/libmysqlclient_r.a Binary files differdeleted file mode 100644 index 3c8d05fd..00000000 --- a/Frameworks/MCPKit/MySQL/lib/libmysqlclient_r.a +++ /dev/null diff --git a/Frameworks/MCPKit/Support files/NSNotificationAdditions.h b/Frameworks/MCPKit/Support files/NSNotificationAdditions.h deleted file mode 100644 index 82777ebb..00000000 --- a/Frameworks/MCPKit/Support files/NSNotificationAdditions.h +++ /dev/null @@ -1,35 +0,0 @@ -// -// $Id: NSNotificationAdditions.h 2045 2010-03-31 18:01:50Z stuart02 $ -// -// NSNotificationAdditions.h -// sequel-pro -// -// Copied from the Colloquy project; original code available from Trac at -// http://colloquy.info/project/browser/trunk/Additions/NSNotificationAdditions.h -// -// 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/> - -@interface NSNotificationCenter (NSNotificationCenterAdditions) - -- (void)postNotificationOnMainThread:(NSNotification *)aNotification; -- (void)postNotificationOnMainThread:(NSNotification *)aNotification waitUntilDone:(BOOL)shouldWaitUntilDone; - -- (void)postNotificationOnMainThreadWithName:(NSString *)aName object:(id)anObject; -- (void)postNotificationOnMainThreadWithName:(NSString *)aName object:(id)anObject userInfo:(NSDictionary *)aUserInfo; -- (void)postNotificationOnMainThreadWithName:(NSString *)aName object:(id)anObject userInfo:(NSDictionary *)aUserInfo waitUntilDone:(BOOL)shouldWaitUntilDone; - -@end diff --git a/Frameworks/MCPKit/Support files/NSNotificationAdditions.m b/Frameworks/MCPKit/Support files/NSNotificationAdditions.m deleted file mode 100644 index 91b8134d..00000000 --- a/Frameworks/MCPKit/Support files/NSNotificationAdditions.m +++ /dev/null @@ -1,97 +0,0 @@ -// -// $Id: NSNotificationAdditions.m 2045 2010-03-31 18:01:50Z stuart02 $ -// -// NSNotificationAdditions.m -// sequel-pro -// -// Copied from the Colloquy project; original code available from Trac at -// http://colloquy.info/project/browser/trunk/Additions/NSNotificationAdditions.m -// -// 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 "NSNotificationAdditions.h" -#import "pthread.h" - -@interface NSNotificationCenter (NSNotificationCenterAdditions_PrivateAPI) -+ (void)_postNotification:(NSNotification *)aNotification; -+ (void)_postNotificationWithDetails:(NSDictionary *)anInfoDictionary; -@end - -@implementation NSNotificationCenter (NSNotificationCenterAdditions) - -- (void)postNotificationOnMainThread:(NSNotification *)aNotification -{ - if (pthread_main_np()) return [self postNotification:aNotification]; - - [self performSelectorOnMainThread:@selector(_postNotification:) withObject:aNotification waitUntilDone:NO]; -} - -- (void)postNotificationOnMainThread:(NSNotification *)aNotification waitUntilDone:(BOOL)shouldWaitUntilDone -{ - if (pthread_main_np()) return [self postNotification:aNotification]; - - [self performSelectorOnMainThread:@selector(_postNotification:) withObject:aNotification waitUntilDone:shouldWaitUntilDone]; -} - -- (void)postNotificationOnMainThreadWithName:(NSString *)aName object:(id)anObject -{ - if (pthread_main_np()) return [self postNotificationName:aName object:anObject userInfo:nil]; - - [self postNotificationOnMainThreadWithName:aName object:anObject userInfo:nil waitUntilDone:NO]; -} - -- (void)postNotificationOnMainThreadWithName:(NSString *)aName object:(id)anObject userInfo:(NSDictionary *)aUserInfo -{ - if(pthread_main_np()) return [self postNotificationName:aName object:anObject userInfo:aUserInfo]; - - [self postNotificationOnMainThreadWithName:aName object:anObject userInfo:aUserInfo waitUntilDone:NO]; -} - -- (void)postNotificationOnMainThreadWithName:(NSString *)aName object:(id)anObject userInfo:(NSDictionary *)aUserInfo waitUntilDone:(BOOL)shouldWaitUntilDone -{ - if (pthread_main_np()) return [self postNotificationName:aName object:anObject userInfo:aUserInfo]; - - NSMutableDictionary *info = [[NSMutableDictionary allocWithZone:nil] initWithCapacity:3]; - - if (aName) [info setObject:aName forKey:@"name"]; - if (anObject) [info setObject:anObject forKey:@"object"]; - if (aUserInfo) [info setObject:aUserInfo forKey:@"userInfo"]; - - [[self class] performSelectorOnMainThread:@selector(_postNotificationWithDetails:) withObject:info waitUntilDone:shouldWaitUntilDone]; -} - -@end - -@implementation NSNotificationCenter (NSNotificationCenterAdditions_PrivateAPI) - -+ (void)_postNotification:(NSNotification *)aNotification -{ - [[self defaultCenter] postNotification:aNotification]; -} - -+ (void)_postNotificationWithDetails:(NSDictionary *)anInfoDictionary -{ - NSString *name = [anInfoDictionary objectForKey:@"name"]; - id object = [anInfoDictionary objectForKey:@"object"]; - NSDictionary *userInfo = [anInfoDictionary objectForKey:@"userInfo"]; - - [[self defaultCenter] postNotificationName:name object:object userInfo:userInfo]; - - [anInfoDictionary release]; -} - -@end diff --git a/Frameworks/QueryKit/QueryKit.xcodeproj/project.pbxproj b/Frameworks/QueryKit/QueryKit.xcodeproj/project.pbxproj new file mode 100644 index 00000000..89c50725 --- /dev/null +++ b/Frameworks/QueryKit/QueryKit.xcodeproj/project.pbxproj @@ -0,0 +1,637 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 45; + objects = { + +/* Begin PBXBuildFile section */ + 1713ECB014F96A5C0013C4F0 /* QKSelectQueryOrderByTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 1713ECAF14F96A5C0013C4F0 /* QKSelectQueryOrderByTests.m */; }; + 1713ECD814F970BB0013C4F0 /* QKSelectQueryGroupByTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 1713ECD714F970BB0013C4F0 /* QKSelectQueryGroupByTests.m */; }; + 17E5951F14F301DF0054EE08 /* QKQuery.h in Headers */ = {isa = PBXBuildFile; fileRef = 17E5951614F301DF0054EE08 /* QKQuery.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 17E5952014F301DF0054EE08 /* QKQuery.m in Sources */ = {isa = PBXBuildFile; fileRef = 17E5951714F301DF0054EE08 /* QKQuery.m */; }; + 17E5952114F301DF0054EE08 /* QKQueryOperators.h in Headers */ = {isa = PBXBuildFile; fileRef = 17E5951814F301DF0054EE08 /* QKQueryOperators.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 17E5952214F301DF0054EE08 /* QKQueryParameter.h in Headers */ = {isa = PBXBuildFile; fileRef = 17E5951914F301DF0054EE08 /* QKQueryParameter.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 17E5952314F301DF0054EE08 /* QKQueryParameter.m in Sources */ = {isa = PBXBuildFile; fileRef = 17E5951A14F301DF0054EE08 /* QKQueryParameter.m */; }; + 17E5952414F301DF0054EE08 /* QKQueryTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = 17E5951B14F301DF0054EE08 /* QKQueryTypes.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 17E5952514F301DF0054EE08 /* QKQueryUtilities.h in Headers */ = {isa = PBXBuildFile; fileRef = 17E5951C14F301DF0054EE08 /* QKQueryUtilities.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 17E5952614F301DF0054EE08 /* QKQueryUtilities.m in Sources */ = {isa = PBXBuildFile; fileRef = 17E5951D14F301DF0054EE08 /* QKQueryUtilities.m */; }; + 17E5952714F301DF0054EE08 /* QueryKit.h in Headers */ = {isa = PBXBuildFile; fileRef = 17E5951E14F301DF0054EE08 /* QueryKit.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 17E595F214F3058F0054EE08 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 17E595F114F3058F0054EE08 /* Foundation.framework */; }; + 17E596A814F308160054EE08 /* QKSelectQueryTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 17E5969814F307B70054EE08 /* QKSelectQueryTests.m */; }; + 17E596A914F308250054EE08 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 17E595F114F3058F0054EE08 /* Foundation.framework */; }; + 17F620BE14F961C1003E7290 /* QueryKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8DC2EF5B0486A6940098B216 /* QueryKit.framework */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 17E596BE14F916B40054EE08 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 0867D690FE84028FC02AAC07 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 8DC2EF4F0486A6940098B216; + remoteInfo = QueryKit; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXFileReference section */ + 1713ECAE14F96A5C0013C4F0 /* QKSelectQueryOrderByTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKSelectQueryOrderByTests.h; sourceTree = "<group>"; }; + 1713ECAF14F96A5C0013C4F0 /* QKSelectQueryOrderByTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QKSelectQueryOrderByTests.m; sourceTree = "<group>"; }; + 1713ECD614F970BB0013C4F0 /* QKSelectQueryGroupByTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKSelectQueryGroupByTests.h; sourceTree = "<group>"; }; + 1713ECD714F970BB0013C4F0 /* QKSelectQueryGroupByTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QKSelectQueryGroupByTests.m; sourceTree = "<group>"; }; + 17E5951614F301DF0054EE08 /* QKQuery.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKQuery.h; sourceTree = "<group>"; }; + 17E5951714F301DF0054EE08 /* QKQuery.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QKQuery.m; sourceTree = "<group>"; }; + 17E5951814F301DF0054EE08 /* QKQueryOperators.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKQueryOperators.h; sourceTree = "<group>"; }; + 17E5951914F301DF0054EE08 /* QKQueryParameter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKQueryParameter.h; sourceTree = "<group>"; }; + 17E5951A14F301DF0054EE08 /* QKQueryParameter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QKQueryParameter.m; sourceTree = "<group>"; }; + 17E5951B14F301DF0054EE08 /* QKQueryTypes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKQueryTypes.h; sourceTree = "<group>"; }; + 17E5951C14F301DF0054EE08 /* QKQueryUtilities.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKQueryUtilities.h; sourceTree = "<group>"; }; + 17E5951D14F301DF0054EE08 /* QKQueryUtilities.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QKQueryUtilities.m; sourceTree = "<group>"; }; + 17E5951E14F301DF0054EE08 /* QueryKit.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QueryKit.h; sourceTree = "<group>"; }; + 17E595F114F3058F0054EE08 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = System/Library/Frameworks/Foundation.framework; sourceTree = SDKROOT; }; + 17E5969714F307B70054EE08 /* QKSelectQueryTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = QKSelectQueryTests.h; sourceTree = "<group>"; }; + 17E5969814F307B70054EE08 /* QKSelectQueryTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = QKSelectQueryTests.m; sourceTree = "<group>"; }; + 17E5969E14F307CE0054EE08 /* Tests.octest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = Tests.octest; sourceTree = BUILT_PRODUCTS_DIR; }; + 17E5969F14F307CE0054EE08 /* Tests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = "Tests-Info.plist"; path = "Resources/Tests-Info.plist"; sourceTree = "<group>"; }; + 32DBCF5E0370ADEE00C91783 /* QueryKit-Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "QueryKit-Prefix.pch"; path = "Source/QueryKit-Prefix.pch"; sourceTree = "<group>"; }; + 8DC2EF5A0486A6940098B216 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = Resources/Info.plist; sourceTree = "<group>"; }; + 8DC2EF5B0486A6940098B216 /* QueryKit.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = QueryKit.framework; sourceTree = BUILT_PRODUCTS_DIR; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 17E5969B14F307CE0054EE08 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 17E596A914F308250054EE08 /* Foundation.framework in Frameworks */, + 17F620BE14F961C1003E7290 /* QueryKit.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8DC2EF560486A6940098B216 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 17E595F214F3058F0054EE08 /* Foundation.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 034768DFFF38A50411DB9C8B /* Products */ = { + isa = PBXGroup; + children = ( + 8DC2EF5B0486A6940098B216 /* QueryKit.framework */, + 17E5969E14F307CE0054EE08 /* Tests.octest */, + ); + name = Products; + sourceTree = "<group>"; + }; + 0867D691FE84028FC02AAC07 /* QueryKit */ = { + isa = PBXGroup; + children = ( + 32DBCF5E0370ADEE00C91783 /* QueryKit-Prefix.pch */, + 08FB77AEFE84172EC02AAC07 /* Source */, + 17E5969614F3079E0054EE08 /* Tests */, + 089C1665FE841158C02AAC07 /* Resources */, + 0867D69AFE84028FC02AAC07 /* Frameworks */, + 034768DFFF38A50411DB9C8B /* Products */, + ); + name = QueryKit; + sourceTree = "<group>"; + }; + 0867D69AFE84028FC02AAC07 /* Frameworks */ = { + isa = PBXGroup; + children = ( + 17E595F114F3058F0054EE08 /* Foundation.framework */, + ); + name = Frameworks; + sourceTree = "<group>"; + }; + 089C1665FE841158C02AAC07 /* Resources */ = { + isa = PBXGroup; + children = ( + 8DC2EF5A0486A6940098B216 /* Info.plist */, + 17E5969F14F307CE0054EE08 /* Tests-Info.plist */, + ); + name = Resources; + sourceTree = "<group>"; + }; + 08FB77AEFE84172EC02AAC07 /* Source */ = { + isa = PBXGroup; + children = ( + 17E5951E14F301DF0054EE08 /* QueryKit.h */, + 17E5951614F301DF0054EE08 /* QKQuery.h */, + 17E5951714F301DF0054EE08 /* QKQuery.m */, + 17E5951914F301DF0054EE08 /* QKQueryParameter.h */, + 17E5951A14F301DF0054EE08 /* QKQueryParameter.m */, + 17E5951C14F301DF0054EE08 /* QKQueryUtilities.h */, + 17E5951D14F301DF0054EE08 /* QKQueryUtilities.m */, + 17E5952814F301F40054EE08 /* Constants */, + ); + path = Source; + sourceTree = "<group>"; + }; + 17322A7214FA645300F0CF9B /* SELECT Tests */ = { + isa = PBXGroup; + children = ( + 17E5969714F307B70054EE08 /* QKSelectQueryTests.h */, + 17E5969814F307B70054EE08 /* QKSelectQueryTests.m */, + 1713ECAE14F96A5C0013C4F0 /* QKSelectQueryOrderByTests.h */, + 1713ECAF14F96A5C0013C4F0 /* QKSelectQueryOrderByTests.m */, + 1713ECD614F970BB0013C4F0 /* QKSelectQueryGroupByTests.h */, + 1713ECD714F970BB0013C4F0 /* QKSelectQueryGroupByTests.m */, + ); + name = "SELECT Tests"; + sourceTree = "<group>"; + }; + 17322A7414FA646000F0CF9B /* UPDATE Tests */ = { + isa = PBXGroup; + children = ( + ); + name = "UPDATE Tests"; + sourceTree = "<group>"; + }; + 17322A7514FA647200F0CF9B /* DELETE Tests */ = { + isa = PBXGroup; + children = ( + ); + name = "DELETE Tests"; + sourceTree = "<group>"; + }; + 17322A7614FA648100F0CF9B /* INSERT Tests */ = { + isa = PBXGroup; + children = ( + ); + name = "INSERT Tests"; + sourceTree = "<group>"; + }; + 17E5952814F301F40054EE08 /* Constants */ = { + isa = PBXGroup; + children = ( + 17E5951B14F301DF0054EE08 /* QKQueryTypes.h */, + 17E5951814F301DF0054EE08 /* QKQueryOperators.h */, + ); + name = Constants; + sourceTree = "<group>"; + }; + 17E5969614F3079E0054EE08 /* Tests */ = { + isa = PBXGroup; + children = ( + 17322A7614FA648100F0CF9B /* INSERT Tests */, + 17322A7514FA647200F0CF9B /* DELETE Tests */, + 17322A7414FA646000F0CF9B /* UPDATE Tests */, + 17322A7214FA645300F0CF9B /* SELECT Tests */, + ); + path = Tests; + sourceTree = "<group>"; + }; +/* End PBXGroup section */ + +/* Begin PBXHeadersBuildPhase section */ + 8DC2EF500486A6940098B216 /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + 17E5951F14F301DF0054EE08 /* QKQuery.h in Headers */, + 17E5952114F301DF0054EE08 /* QKQueryOperators.h in Headers */, + 17E5952214F301DF0054EE08 /* QKQueryParameter.h in Headers */, + 17E5952414F301DF0054EE08 /* QKQueryTypes.h in Headers */, + 17E5952514F301DF0054EE08 /* QKQueryUtilities.h in Headers */, + 17E5952714F301DF0054EE08 /* QueryKit.h in Headers */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXHeadersBuildPhase section */ + +/* Begin PBXNativeTarget section */ + 17E5969D14F307CE0054EE08 /* Tests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 17E596A614F307CE0054EE08 /* Build configuration list for PBXNativeTarget "Tests" */; + buildPhases = ( + 17E5969914F307CE0054EE08 /* Resources */, + 17E5969A14F307CE0054EE08 /* Sources */, + 17E5969B14F307CE0054EE08 /* Frameworks */, + 17E5969C14F307CE0054EE08 /* ShellScript */, + ); + buildRules = ( + ); + dependencies = ( + 17E596BF14F916B40054EE08 /* PBXTargetDependency */, + ); + name = Tests; + productName = Tests; + productReference = 17E5969E14F307CE0054EE08 /* Tests.octest */; + productType = "com.apple.product-type.bundle"; + }; + 8DC2EF4F0486A6940098B216 /* QueryKit */ = { + isa = PBXNativeTarget; + buildConfigurationList = 1DEB91AD08733DA50010E9CD /* Build configuration list for PBXNativeTarget "QueryKit" */; + buildPhases = ( + 8DC2EF500486A6940098B216 /* Headers */, + 8DC2EF520486A6940098B216 /* Resources */, + 8DC2EF540486A6940098B216 /* Sources */, + 8DC2EF560486A6940098B216 /* Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = QueryKit; + productInstallPath = "$(HOME)/Library/Frameworks"; + productName = QueryKit; + productReference = 8DC2EF5B0486A6940098B216 /* QueryKit.framework */; + productType = "com.apple.product-type.framework"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 0867D690FE84028FC02AAC07 /* Project object */ = { + isa = PBXProject; + buildConfigurationList = 1DEB91B108733DA50010E9CD /* Build configuration list for PBXProject "QueryKit" */; + compatibilityVersion = "Xcode 3.1"; + developmentRegion = English; + hasScannedForEncodings = 1; + knownRegions = ( + English, + Japanese, + French, + German, + ); + mainGroup = 0867D691FE84028FC02AAC07 /* QueryKit */; + productRefGroup = 034768DFFF38A50411DB9C8B /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 8DC2EF4F0486A6940098B216 /* QueryKit */, + 17E5969D14F307CE0054EE08 /* Tests */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 17E5969914F307CE0054EE08 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8DC2EF520486A6940098B216 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 17E5969C14F307CE0054EE08 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "# Run the unit tests in this test bundle.\n\"${SYSTEM_DEVELOPER_DIR}/Tools/RunUnitTests\"\n"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 17E5969A14F307CE0054EE08 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 17E596A814F308160054EE08 /* QKSelectQueryTests.m in Sources */, + 1713ECB014F96A5C0013C4F0 /* QKSelectQueryOrderByTests.m in Sources */, + 1713ECD814F970BB0013C4F0 /* QKSelectQueryGroupByTests.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8DC2EF540486A6940098B216 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 17E5952014F301DF0054EE08 /* QKQuery.m in Sources */, + 17E5952314F301DF0054EE08 /* QKQueryParameter.m in Sources */, + 17E5952614F301DF0054EE08 /* QKQueryUtilities.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 17E596BF14F916B40054EE08 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 8DC2EF4F0486A6940098B216 /* QueryKit */; + targetProxy = 17E596BE14F916B40054EE08 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin XCBuildConfiguration section */ + 17E5952D14F302740054EE08 /* Distribution */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = "$(ARCHS_STANDARD_32_64_BIT)"; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "Source/QueryKit-Prefix.pch"; + GCC_VERSION = com.apple.compilers.llvm.clang.1_0; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + INFOPLIST_FILE = Resources/Info.plist; + INFOPLIST_PREFIX_HEADER = ""; + PREBINDING = NO; + SDKROOT = macosx10.6; + VALID_ARCHS = "i386 x86_64"; + }; + name = Distribution; + }; + 17E5952E14F302740054EE08 /* Distribution */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + FRAMEWORK_VERSION = A; + GCC_GENERATE_DEBUGGING_SYMBOLS = NO; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "Source/QueryKit-Prefix.pch"; + GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_INVALID_OFFSETOF_MACRO = YES; + GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; + GCC_WARN_ABOUT_MISSING_NEWLINE = YES; + GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES; + GCC_WARN_CHECK_SWITCH_STATEMENTS = YES; + GCC_WARN_FOUR_CHARACTER_CONSTANTS = YES; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_MISSING_PARENTHESES = YES; + GCC_WARN_MULTIPLE_DEFINITION_TYPES_FOR_SELECTOR = YES; + GCC_WARN_NON_VIRTUAL_DESTRUCTOR = YES; + GCC_WARN_PROTOTYPE_CONVERSION = YES; + GCC_WARN_SHADOW = YES; + GCC_WARN_SIGN_COMPARE = YES; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES; + GCC_WARN_UNKNOWN_PRAGMAS = YES; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_LABEL = YES; + GCC_WARN_UNUSED_VALUE = YES; + INFOPLIST_FILE = Resources/Info.plist; + INSTALL_PATH = "@executable_path/../Frameworks"; + PRODUCT_NAME = QueryKit; + WRAPPER_EXTENSION = framework; + }; + name = Distribution; + }; + 17E596A314F307CE0054EE08 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + COPY_PHASE_STRIP = NO; + FRAMEWORK_SEARCH_PATHS = "$(DEVELOPER_LIBRARY_DIR)/Frameworks"; + GCC_DYNAMIC_NO_PIC = NO; + GCC_ENABLE_FIX_AND_CONTINUE = NO; + GCC_ENABLE_OBJC_EXCEPTIONS = YES; + GCC_MODEL_TUNING = G5; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "$(SYSTEM_LIBRARY_DIR)/Frameworks/Cocoa.framework/Headers/Cocoa.h"; + INFOPLIST_FILE = "Resources/Tests-Info.plist"; + INSTALL_PATH = "$(USER_LIBRARY_DIR)/Bundles"; + OTHER_LDFLAGS = ( + "-framework", + Cocoa, + "-framework", + SenTestingKit, + ); + PREBINDING = NO; + PRODUCT_NAME = Tests; + WRAPPER_EXTENSION = octest; + }; + name = Debug; + }; + 17E596A414F307CE0054EE08 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + COPY_PHASE_STRIP = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + FRAMEWORK_SEARCH_PATHS = "$(DEVELOPER_LIBRARY_DIR)/Frameworks"; + GCC_ENABLE_FIX_AND_CONTINUE = NO; + GCC_ENABLE_OBJC_EXCEPTIONS = YES; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "$(SYSTEM_LIBRARY_DIR)/Frameworks/Cocoa.framework/Headers/Cocoa.h"; + INFOPLIST_FILE = "Resources/Tests-Info.plist"; + INSTALL_PATH = "$(USER_LIBRARY_DIR)/Bundles"; + OTHER_LDFLAGS = ( + "-framework", + Cocoa, + "-framework", + SenTestingKit, + ); + PREBINDING = NO; + PRODUCT_NAME = Tests; + WRAPPER_EXTENSION = octest; + ZERO_LINK = NO; + }; + name = Release; + }; + 17E596A514F307CE0054EE08 /* Distribution */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + FRAMEWORK_SEARCH_PATHS = "$(DEVELOPER_LIBRARY_DIR)/Frameworks"; + GCC_ENABLE_FIX_AND_CONTINUE = NO; + GCC_ENABLE_OBJC_EXCEPTIONS = YES; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "$(SYSTEM_LIBRARY_DIR)/Frameworks/Cocoa.framework/Headers/Cocoa.h"; + INFOPLIST_FILE = "Resources/Tests-Info.plist"; + INSTALL_PATH = "$(USER_LIBRARY_DIR)/Bundles"; + OTHER_LDFLAGS = ( + "-framework", + Cocoa, + "-framework", + SenTestingKit, + ); + PREBINDING = NO; + PRODUCT_NAME = Tests; + WRAPPER_EXTENSION = octest; + }; + name = Distribution; + }; + 1DEB91AE08733DA50010E9CD /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + COPY_PHASE_STRIP = NO; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + FRAMEWORK_VERSION = A; + GCC_DYNAMIC_NO_PIC = NO; + GCC_ENABLE_FIX_AND_CONTINUE = YES; + GCC_MODEL_TUNING = G5; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "Source/QueryKit-Prefix.pch"; + GCC_SYMBOLS_PRIVATE_EXTERN = YES; + GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_INVALID_OFFSETOF_MACRO = YES; + GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; + GCC_WARN_ABOUT_MISSING_NEWLINE = YES; + GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES; + GCC_WARN_CHECK_SWITCH_STATEMENTS = YES; + GCC_WARN_FOUR_CHARACTER_CONSTANTS = YES; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_MISSING_PARENTHESES = YES; + GCC_WARN_MULTIPLE_DEFINITION_TYPES_FOR_SELECTOR = YES; + GCC_WARN_NON_VIRTUAL_DESTRUCTOR = YES; + GCC_WARN_PROTOTYPE_CONVERSION = YES; + GCC_WARN_SHADOW = YES; + GCC_WARN_SIGN_COMPARE = YES; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES; + GCC_WARN_UNKNOWN_PRAGMAS = YES; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_LABEL = YES; + GCC_WARN_UNUSED_VALUE = YES; + GENERATE_PKGINFO_FILE = YES; + INFOPLIST_FILE = Resources/Info.plist; + INSTALL_PATH = "@executable_path/../Frameworks"; + PRODUCT_NAME = QueryKit; + WARNING_CFLAGS = "-Wmost"; + WRAPPER_EXTENSION = framework; + }; + name = Debug; + }; + 1DEB91AF08733DA50010E9CD /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ARCHS = ( + i386, + x86_64, + ppc, + ); + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + FRAMEWORK_VERSION = A; + GCC_GENERATE_DEBUGGING_SYMBOLS = NO; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "Source/QueryKit-Prefix.pch"; + GCC_SYMBOLS_PRIVATE_EXTERN = YES; + GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_INVALID_OFFSETOF_MACRO = YES; + GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; + GCC_WARN_ABOUT_MISSING_NEWLINE = YES; + GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES; + GCC_WARN_CHECK_SWITCH_STATEMENTS = YES; + GCC_WARN_FOUR_CHARACTER_CONSTANTS = YES; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_MISSING_PARENTHESES = YES; + GCC_WARN_MULTIPLE_DEFINITION_TYPES_FOR_SELECTOR = YES; + GCC_WARN_NON_VIRTUAL_DESTRUCTOR = YES; + GCC_WARN_PROTOTYPE_CONVERSION = YES; + GCC_WARN_SHADOW = YES; + GCC_WARN_SIGN_COMPARE = YES; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES; + GCC_WARN_UNKNOWN_PRAGMAS = YES; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_LABEL = YES; + GCC_WARN_UNUSED_VALUE = YES; + INFOPLIST_FILE = Resources/Info.plist; + INSTALL_PATH = "@executable_path/../Frameworks"; + PRODUCT_NAME = QueryKit; + SDKROOT = macosx10.5; + VALID_ARCHS = "ppc i386 x86_64"; + WRAPPER_EXTENSION = framework; + }; + name = Release; + }; + 1DEB91B208733DA50010E9CD /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = "$(ARCHS_STANDARD_32_64_BIT)"; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "Source/QueryKit-Prefix.pch"; + GCC_VERSION = com.apple.compilers.llvm.clang.1_0; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + INFOPLIST_FILE = Resources/Info.plist; + INFOPLIST_PREFIX_HEADER = ""; + ONLY_ACTIVE_ARCH = YES; + PREBINDING = NO; + SDKROOT = macosx10.6; + VALID_ARCHS = "i386 x86_64"; + }; + name = Debug; + }; + 1DEB91B308733DA50010E9CD /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = "$(ARCHS_STANDARD_32_64_BIT)"; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = "Source/QueryKit-Prefix.pch"; + GCC_VERSION = com.apple.compilers.llvm.clang.1_0; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + INFOPLIST_FILE = Resources/Info.plist; + INFOPLIST_PREFIX_HEADER = ""; + PREBINDING = NO; + SDKROOT = macosx10.6; + VALID_ARCHS = "i386 x86_64"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 17E596A614F307CE0054EE08 /* Build configuration list for PBXNativeTarget "Tests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 17E596A314F307CE0054EE08 /* Debug */, + 17E596A414F307CE0054EE08 /* Release */, + 17E596A514F307CE0054EE08 /* Distribution */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 1DEB91AD08733DA50010E9CD /* Build configuration list for PBXNativeTarget "QueryKit" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 1DEB91AE08733DA50010E9CD /* Debug */, + 1DEB91AF08733DA50010E9CD /* Release */, + 17E5952E14F302740054EE08 /* Distribution */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 1DEB91B108733DA50010E9CD /* Build configuration list for PBXProject "QueryKit" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 1DEB91B208733DA50010E9CD /* Debug */, + 1DEB91B308733DA50010E9CD /* Release */, + 17E5952D14F302740054EE08 /* Distribution */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 0867D690FE84028FC02AAC07 /* Project object */; +} diff --git a/Frameworks/QueryKit/Resources/Info.plist b/Frameworks/QueryKit/Resources/Info.plist new file mode 100644 index 00000000..b76ed0eb --- /dev/null +++ b/Frameworks/QueryKit/Resources/Info.plist @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>CFBundleDevelopmentRegion</key> + <string>English</string> + <key>CFBundleExecutable</key> + <string>QueryKit</string> + <key>CFBundleIdentifier</key> + <string>com.google.code.sequel-pro.querykit</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>6.0</string> + <key>CFBundlePackageType</key> + <string>FMWK</string> + <key>CFBundleShortVersionString</key> + <string>1.0</string> + <key>CFBundleSignature</key> + <string>????</string> + <key>CFBundleVersion</key> + <string>1</string> +</dict> +</plist> diff --git a/Frameworks/QueryKit/Resources/Tests-Info.plist b/Frameworks/QueryKit/Resources/Tests-Info.plist new file mode 100644 index 00000000..607c2ef5 --- /dev/null +++ b/Frameworks/QueryKit/Resources/Tests-Info.plist @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>CFBundleDevelopmentRegion</key> + <string>English</string> + <key>CFBundleExecutable</key> + <string>Tests</string> + <key>CFBundleIdentifier</key> + <string>com.google.code.sequel-pro.querykit.tests</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>6.0</string> + <key>CFBundlePackageType</key> + <string>BNDL</string> + <key>CFBundleShortVersionString</key> + <string>1.0</string> + <key>CFBundleSignature</key> + <string>????</string> + <key>CFBundleVersion</key> + <string>1</string> +</dict> +</plist> diff --git a/Frameworks/QueryKit/QKQuery.h b/Frameworks/QueryKit/Source/QKQuery.h index b3670808..b45dc556 100644 --- a/Frameworks/QueryKit/QKQuery.h +++ b/Frameworks/QueryKit/Source/QKQuery.h @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQuery.h 3421 2011-09-10 22:58:45Z stuart02 $ // // QKQuery.h // sequel-pro diff --git a/Frameworks/QueryKit/QKQuery.m b/Frameworks/QueryKit/Source/QKQuery.m index 31755b6d..21053203 100644 --- a/Frameworks/QueryKit/QKQuery.m +++ b/Frameworks/QueryKit/Source/QKQuery.m @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQuery.m 3432 2011-09-27 00:21:35Z stuart02 $ // // QKQuery.h // sequel-pro @@ -81,7 +81,7 @@ static NSString *QKNoQueryTableException = @"QKNoQueryTable"; [self setTable:table]; [self setFields:[[NSMutableArray alloc] init]]; [self setParameters:[[NSMutableArray alloc] init]]; - [self setQueryType:-1]; + [self setQueryType:(QKQueryType)-1]; [self setQuoteFields:NO]; _orderDescending = NO; @@ -378,9 +378,7 @@ static NSString *QKNoQueryTableException = @"QKNoQueryTable"; [orderBy setString:[orderBy substringToIndex:([orderBy length] - 2)]]; } - if (_orderDescending) { - [orderBy appendString:@" DESC"]; - } + [orderBy appendString:_orderDescending ? @" DESC" : @" ASC"]; return orderBy; } diff --git a/Frameworks/QueryKit/QKQueryOperators.h b/Frameworks/QueryKit/Source/QKQueryOperators.h index 247496fd..32e64563 100644 --- a/Frameworks/QueryKit/QKQueryOperators.h +++ b/Frameworks/QueryKit/Source/QKQueryOperators.h @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQueryOperators.h 3423 2011-09-12 16:50:15Z stuart02 $ // // QKQueryOperators.h // sequel-pro diff --git a/Frameworks/QueryKit/QKQueryParameter.h b/Frameworks/QueryKit/Source/QKQueryParameter.h index 3a24eb8d..78c5739f 100644 --- a/Frameworks/QueryKit/QKQueryParameter.h +++ b/Frameworks/QueryKit/Source/QKQueryParameter.h @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQueryParameter.h 3421 2011-09-10 22:58:45Z stuart02 $ // // QKQueryParameter.h // sequel-pro diff --git a/Frameworks/QueryKit/QKQueryParameter.m b/Frameworks/QueryKit/Source/QKQueryParameter.m index bc9efa2f..7f6064e6 100644 --- a/Frameworks/QueryKit/QKQueryParameter.m +++ b/Frameworks/QueryKit/Source/QKQueryParameter.m @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQueryParameter.m 3432 2011-09-27 00:21:35Z stuart02 $ // // QKQueryParameter.m // sequel-pro diff --git a/Frameworks/QueryKit/QKQueryTypes.h b/Frameworks/QueryKit/Source/QKQueryTypes.h index 1e9e7403..4ab338ec 100644 --- a/Frameworks/QueryKit/QKQueryTypes.h +++ b/Frameworks/QueryKit/Source/QKQueryTypes.h @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQueryTypes.h 3423 2011-09-12 16:50:15Z stuart02 $ // // QKQueryTypes.h // sequel-pro diff --git a/Frameworks/QueryKit/QKQueryUtilities.h b/Frameworks/QueryKit/Source/QKQueryUtilities.h index 352c5533..9049b191 100644 --- a/Frameworks/QueryKit/QKQueryUtilities.h +++ b/Frameworks/QueryKit/Source/QKQueryUtilities.h @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQueryUtilities.h 3421 2011-09-10 22:58:45Z stuart02 $ // // QKQueryUtilities.h // sequel-pro diff --git a/Frameworks/QueryKit/QKQueryUtilities.m b/Frameworks/QueryKit/Source/QKQueryUtilities.m index 5e4eb4ab..dde1bd77 100644 --- a/Frameworks/QueryKit/QKQueryUtilities.m +++ b/Frameworks/QueryKit/Source/QKQueryUtilities.m @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QKQueryUtilities.m 3421 2011-09-10 22:58:45Z stuart02 $ // // QKQueryUtilities.m // sequel-pro diff --git a/Frameworks/QueryKit/Source/QueryKit-Prefix.pch b/Frameworks/QueryKit/Source/QueryKit-Prefix.pch new file mode 100644 index 00000000..60070a9c --- /dev/null +++ b/Frameworks/QueryKit/Source/QueryKit-Prefix.pch @@ -0,0 +1,3 @@ +#ifdef __OBJC__ + #import <Foundation/Foundation.h> +#endif diff --git a/Frameworks/QueryKit/QueryKit.h b/Frameworks/QueryKit/Source/QueryKit.h index 04c072de..f8570025 100644 --- a/Frameworks/QueryKit/QueryKit.h +++ b/Frameworks/QueryKit/Source/QueryKit.h @@ -1,5 +1,5 @@ // -// $Id$ +// $Id: QueryKit.h 3431 2011-09-26 22:26:24Z stuart02 $ // // QueryKit.h // sequel-pro diff --git a/Frameworks/QueryKit/Tests/QKSelectQueryGroupByTests.h b/Frameworks/QueryKit/Tests/QKSelectQueryGroupByTests.h new file mode 100644 index 00000000..56907b36 --- /dev/null +++ b/Frameworks/QueryKit/Tests/QKSelectQueryGroupByTests.h @@ -0,0 +1,41 @@ +// +// $Id$ +// +// QKSelectQueryGroupByTests.h +// sequel-pro +// +// Created by Stuart Connolly (stuconnolly.com) on February 25, 2012 +// Copyright (c) 2012 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import <QueryKit/QueryKit.h> +#import <SenTestingKit/SenTestingKit.h> + +@interface QKSelectQueryGroupByTests : SenTestCase +{ + QKQuery *_query; +} + +@end diff --git a/Frameworks/QueryKit/Tests/QKSelectQueryGroupByTests.m b/Frameworks/QueryKit/Tests/QKSelectQueryGroupByTests.m new file mode 100644 index 00000000..9bbe75a2 --- /dev/null +++ b/Frameworks/QueryKit/Tests/QKSelectQueryGroupByTests.m @@ -0,0 +1,80 @@ +// +// $Id$ +// +// QKSelectQueryGroupByTests.m +// sequel-pro +// +// Created by Stuart Connolly (stuconnolly.com) on February 25, 2012 +// Copyright (c) 2012 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "QKSelectQueryGroupByTests.h" + +static NSString *QKTestTableName = @"test_table"; + +static NSString *QKTestFieldOne = @"test_field1"; +static NSString *QKTestFieldTwo = @"test_field2"; + +@implementation QKSelectQueryGroupByTests + +#pragma mark - +#pragma mark Setup & tear down + +- (void)setUp +{ + _query = [QKQuery selectQueryFromTable:QKTestTableName]; + + [_query addField:QKTestFieldOne]; + [_query addField:QKTestFieldTwo]; +} + +#pragma mark - +#pragma mark Tests + +- (void)testSelectQueryTypeIsCorrect +{ + STAssertTrue([[_query query] hasPrefix:@"SELECT"], @"query type"); +} + +- (void)testSelectQueryGroupByIsCorrect +{ + [_query groupByField:QKTestFieldOne]; + + NSString *query = [NSString stringWithFormat:@"GROUP BY %@", QKTestFieldOne]; + + STAssertTrue([[_query query] hasSuffix:query], @"query group by"); +} + +- (void)testSelectQueryGroupByMultipleFieldsIsCorrect +{ + [_query groupByFields:[NSArray arrayWithObjects:QKTestFieldOne, QKTestFieldTwo, nil]]; + + NSString *query = [NSString stringWithFormat:@"GROUP BY %@, %@", QKTestFieldOne, QKTestFieldTwo]; + + STAssertTrue([[_query query] hasSuffix:query], @"query group by"); +} + + +@end diff --git a/Frameworks/QueryKit/Tests/QKSelectQueryOrderByTests.h b/Frameworks/QueryKit/Tests/QKSelectQueryOrderByTests.h new file mode 100644 index 00000000..c457491a --- /dev/null +++ b/Frameworks/QueryKit/Tests/QKSelectQueryOrderByTests.h @@ -0,0 +1,41 @@ +// +// $Id$ +// +// QKSelectQueryOrderByTests.h +// sequel-pro +// +// Created by Stuart Connolly (stuconnolly.com) on February 25, 2012 +// Copyright (c) 2012 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import <QueryKit/QueryKit.h> +#import <SenTestingKit/SenTestingKit.h> + +@interface QKSelectQueryOrderByTests : SenTestCase +{ + QKQuery *_query; +} + +@end diff --git a/Frameworks/QueryKit/Tests/QKSelectQueryOrderByTests.m b/Frameworks/QueryKit/Tests/QKSelectQueryOrderByTests.m new file mode 100644 index 00000000..84bd5ddb --- /dev/null +++ b/Frameworks/QueryKit/Tests/QKSelectQueryOrderByTests.m @@ -0,0 +1,97 @@ +// +// $Id$ +// +// QKSelectQueryOrderByTests.m +// sequel-pro +// +// Created by Stuart Connolly (stuconnolly.com) on February 25, 2012 +// Copyright (c) 2012 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "QKSelectQueryOrderByTests.h" + +static NSString *QKTestTableName = @"test_table"; + +static NSString *QKTestFieldOne = @"test_field1"; +static NSString *QKTestFieldTwo = @"test_field2"; + +@implementation QKSelectQueryOrderByTests + +#pragma mark - +#pragma mark Setup & tear down + +- (void)setUp +{ + _query = [QKQuery selectQueryFromTable:QKTestTableName]; + + [_query addField:QKTestFieldOne]; + [_query addField:QKTestFieldTwo]; +} + +#pragma mark - +#pragma mark Tests + +- (void)testSelectQueryTypeIsCorrect +{ + STAssertTrue([[_query query] hasPrefix:@"SELECT"], @"query type"); +} + +- (void)testSelectQueryOrderByAscendingIsCorrect +{ + [_query orderByField:QKTestFieldOne descending:NO]; + + NSString *query = [NSString stringWithFormat:@"ORDER BY %@ ASC", QKTestFieldOne]; + + STAssertTrue([[_query query] hasSuffix:query], @"query order by"); +} + +- (void)testSelectQueryOrderByMultipleFieldsAscendingIsCorrect +{ + [_query orderByFields:[NSArray arrayWithObjects:QKTestFieldOne, QKTestFieldTwo, nil] descending:NO]; + + NSString *query = [NSString stringWithFormat:@"ORDER BY %@, %@ ASC", QKTestFieldOne, QKTestFieldTwo]; + + STAssertTrue([[_query query] hasSuffix:query], @"query order by"); +} + +- (void)testSelectQueryOrderByDescendingIsCorrect +{ + [_query orderByField:QKTestFieldOne descending:YES]; + + NSString *query = [NSString stringWithFormat:@"ORDER BY %@ DESC", QKTestFieldOne]; + + STAssertTrue([[_query query] hasSuffix:query], @"query order by"); +} + +- (void)testSelectQueryOrderByMultipleFieldsDescendingIsCorrect +{ + [_query orderByFields:[NSArray arrayWithObjects:QKTestFieldOne, QKTestFieldTwo, nil] descending:YES]; + + NSString *query = [NSString stringWithFormat:@"ORDER BY %@, %@ DESC", QKTestFieldOne, QKTestFieldTwo]; + + STAssertTrue([[_query query] hasSuffix:query], @"query order by"); +} + +@end diff --git a/Frameworks/QueryKit/Tests/QKSelectQueryTests.h b/Frameworks/QueryKit/Tests/QKSelectQueryTests.h new file mode 100644 index 00000000..df9e3272 --- /dev/null +++ b/Frameworks/QueryKit/Tests/QKSelectQueryTests.h @@ -0,0 +1,41 @@ +// +// $Id$ +// +// QKSelectQueryTests.h +// sequel-pro +// +// Created by Stuart Connolly (stuconnolly.com) on September 4, 2011 +// Copyright (c) 2011 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import <QueryKit/QueryKit.h> +#import <SenTestingKit/SenTestingKit.h> + +@interface QKSelectQueryTests : SenTestCase +{ + QKQuery *_query; +} + +@end diff --git a/Frameworks/QueryKit/Tests/QKSelectQueryTests.m b/Frameworks/QueryKit/Tests/QKSelectQueryTests.m new file mode 100644 index 00000000..620dbadd --- /dev/null +++ b/Frameworks/QueryKit/Tests/QKSelectQueryTests.m @@ -0,0 +1,83 @@ +// +// $Id$ +// +// QKSelectQueryTests.m +// sequel-pro +// +// Created by Stuart Connolly (stuconnolly.com) on September 4, 2011 +// Copyright (c) 2011 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "QKSelectQueryTests.h" + +static NSString *QKTestTableName = @"test_table"; + +static NSString *QKTestFieldOne = @"test_field1"; +static NSString *QKTestFieldTwo = @"test_field2"; +static NSString *QKTestFieldThree = @"test_field3"; +static NSString *QKTestFieldFour = @"test_field4"; + +static NSUInteger QKTestParameterOne = 10; + +@implementation QKSelectQueryTests + +#pragma mark - +#pragma mark Setup & tear down + +- (void)setUp +{ + _query = [QKQuery selectQueryFromTable:QKTestTableName]; + + [_query addField:QKTestFieldOne]; + [_query addField:QKTestFieldTwo]; + [_query addField:QKTestFieldThree]; + [_query addField:QKTestFieldFour]; + + [_query addParameter:QKTestFieldOne operator:QKEqualityOperator value:[NSNumber numberWithUnsignedInteger:QKTestParameterOne]]; +} + +#pragma mark - +#pragma mark Tests + +- (void)testSelectQueryTypeIsCorrect +{ + STAssertTrue([[_query query] hasPrefix:@"SELECT"], @"query type"); +} + +- (void)testSelectQueryFieldsAreCorrect +{ + NSString *query = [NSString stringWithFormat:@"SELECT %@, %@, %@, %@", QKTestFieldOne, QKTestFieldTwo, QKTestFieldThree, QKTestFieldFour]; + + STAssertTrue([[_query query] hasPrefix:query], @"query fields"); +} + +- (void)testSelectQueryConstraintsAreCorrect +{ + NSString *query = [NSString stringWithFormat:@"WHERE %@ %@ %@", QKTestFieldOne, [QKQueryUtilities operatorRepresentationForType:QKEqualityOperator], [NSNumber numberWithUnsignedInteger:QKTestParameterOne]]; + + STAssertTrue(([[_query query] rangeOfString:query].location != NSNotFound), @"query constraints"); +} + +@end diff --git a/Frameworks/SPMySQLFramework/English.lproj/InfoPlist.strings b/Frameworks/SPMySQLFramework/English.lproj/InfoPlist.strings new file mode 100644 index 00000000..88f65cf6 --- /dev/null +++ b/Frameworks/SPMySQLFramework/English.lproj/InfoPlist.strings @@ -0,0 +1,2 @@ +/* Localized versions of Info.plist keys */ + diff --git a/Frameworks/MCPKit/MySQL/include/my_alloc.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/my_alloc.h index 93b7438a..93b7438a 100644 --- a/Frameworks/MCPKit/MySQL/include/my_alloc.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/my_alloc.h diff --git a/Frameworks/MCPKit/MySQL/include/my_list.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/my_list.h index 775b5658..775b5658 100644 --- a/Frameworks/MCPKit/MySQL/include/my_list.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/my_list.h diff --git a/Frameworks/MCPKit/MySQL/include/mysql.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql.h index 699bd1f1..da477278 100644 --- a/Frameworks/MCPKit/MySQL/include/mysql.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql.h @@ -1,4 +1,5 @@ -/* Copyright (C) 2000-2003 MySQL AB +/* + Copyright (c) 2000, 2010, Oracle and/or its affiliates. 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 @@ -11,7 +12,8 @@ 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 */ + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +*/ /* This file defines the client API to MySQL and also the ABI of the diff --git a/Frameworks/MCPKit/MySQL/include/mysql_com.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_com.h index 357519d5..357519d5 100644 --- a/Frameworks/MCPKit/MySQL/include/mysql_com.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_com.h diff --git a/Frameworks/MCPKit/MySQL/include/mysql_embed.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_embed.h index a7d6e610..e3318864 100644 --- a/Frameworks/MCPKit/MySQL/include/mysql_embed.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_embed.h @@ -1,4 +1,5 @@ -/* Copyright (C) 2000 MySQL AB +/* + Copyright (c) 2000, 2010, Oracle and/or its affiliates. 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 @@ -11,7 +12,8 @@ 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 */ + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +*/ /* Defines that are unique to the embedded version of MySQL */ diff --git a/Frameworks/MCPKit/MySQL/include/mysql_time.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_time.h index 0a3f17a8..0a3f17a8 100644 --- a/Frameworks/MCPKit/MySQL/include/mysql_time.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_time.h diff --git a/Frameworks/MCPKit/MySQL/include/mysql_version.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_version.h index 1eba2ede..dc8c5b3f 100644 --- a/Frameworks/MCPKit/MySQL/include/mysql_version.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/mysql_version.h @@ -9,11 +9,11 @@ #include <custom_conf.h> #else #define PROTOCOL_VERSION 10 -#define MYSQL_SERVER_VERSION "5.1.57" +#define MYSQL_SERVER_VERSION "5.1.61" #define MYSQL_BASE_VERSION "mysqld-5.1" #define MYSQL_SERVER_SUFFIX_DEF "" #define FRM_VER 6 -#define MYSQL_VERSION_ID 50157 +#define MYSQL_VERSION_ID 50161 #define MYSQL_PORT 3306 #define MYSQL_PORT_DEFAULT 0 #define MYSQL_UNIX_ADDR "/tmp/mysql.sock" diff --git a/Frameworks/MCPKit/MySQL/include/typelib.h b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/typelib.h index 46106d1b..46106d1b 100644 --- a/Frameworks/MCPKit/MySQL/include/typelib.h +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/include/typelib.h diff --git a/Frameworks/SPMySQLFramework/MySQL Client Libraries/lib/libmysqlclient.a b/Frameworks/SPMySQLFramework/MySQL Client Libraries/lib/libmysqlclient.a Binary files differnew file mode 100644 index 00000000..5b7d405a --- /dev/null +++ b/Frameworks/SPMySQLFramework/MySQL Client Libraries/lib/libmysqlclient.a diff --git a/Frameworks/SPMySQLFramework/Readme.txt b/Frameworks/SPMySQLFramework/Readme.txt new file mode 100644 index 00000000..de828890 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Readme.txt @@ -0,0 +1,44 @@ +The SPMySQL Framework is intended to provide a stable MySQL connection framework, with the ability to run text-based queries and rapidly retrieve result sets with conversion from MySQL data types to Cocoa objects. + +SPMySQL.framework has an interface loosely based around that provided by MCPKit by Serge Cohen and Bertrand Mansion (http://mysql-cocoa.sourceforge.net/), and in particular the heavily modified Sequel Pro version (http://www.sequelpro.com/). It is a full rewrite of the original framework, although it includes code from patches implementing the following Sequel Pro functionality, largely contributed by Hans-Jörg Bibiko, Stuart Connolly, Jakob Egger, and Rowan Beentje: + - Connection locking (Jakob et al) + - Ping & keepalive (Rowan et al) + - Query cancellation (Rowan et al) + - Delegate setup (Stuart et al) + - SSL support (Rowan et al) + - Connection checking (Rowan et al) + - Version state (Stuart et al) + - Maximum packet size control (Hans et al) + - Result multithreading and streaming (Rowan et al) + - Improved encoding support & switching (Rowan et al) + - Database structure; moved to inside the app (Hans et al) + - Query reattempts and error-handling approach (Rowan et al) + - Geometry result class (Hans et al) + - Connection proxy (Stuart et al) + + +INTEGRATION + +SPMySQL.framework can be added to your project as a standard Cocoa framework, or the entire project can be added as a subproject in Xcode. +To add as a subproject in Xcode: + 1) Add the SPMySQL framework's .xcodeproj to your current project + 2) Choose an existing target, Get Info, and under direct dependenies add a new dependency. Choose the SPMySQL.framework target from the sub-project + 3) Expand the subproject to see its child target - SPMySQL.framework. Drag this to the "Link Binary With Libraries" build phase of any targets using the framework. + 4) If you don't have a Copy Frameworks phase, add one; drag the SPMySQL.framework child target to this phase. + 5) In your build settings, add a User Header Search Path; make it a recursive path to the SPMySQL project folder location (for example ${PROJECT_DIR}/Frameworks/SPMySQLFramework). This should allow you to #include "SPMySQL.h" and have everything function. + +As a last resort jump onto IRC and join #sequel-pro on irc.freenode.net and any of the +developers will be more than happy to help you out. + + +LICENSE + +Copyright (c) 2012 Rowan Beentje (rowan.beent.je) and the Sequel Pro team. + +The SPMySQL framework is offered under the MIT license: + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Resources/Info.plist b/Frameworks/SPMySQLFramework/Resources/Info.plist new file mode 100644 index 00000000..392b428f --- /dev/null +++ b/Frameworks/SPMySQLFramework/Resources/Info.plist @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>CFBundleDevelopmentRegion</key> + <string>English</string> + <key>CFBundleExecutable</key> + <string>${EXECUTABLE_NAME}</string> + <key>CFBundleIconFile</key> + <string></string> + <key>CFBundleIdentifier</key> + <string>com.yourcompany.${PRODUCT_NAME:rfc1034Identifier}</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>6.0</string> + <key>CFBundleName</key> + <string>${PRODUCT_NAME}</string> + <key>CFBundlePackageType</key> + <string>FMWK</string> + <key>CFBundleShortVersionString</key> + <string>1.0</string> + <key>CFBundleSignature</key> + <string>SPDT</string> + <key>CFBundleVersion</key> + <string>1</string> + <key>NSPrincipalClass</key> + <string></string> +</dict> +</plist> diff --git a/Frameworks/SPMySQLFramework/SPMySQLFramework.xcodeproj/project.pbxproj b/Frameworks/SPMySQLFramework/SPMySQLFramework.xcodeproj/project.pbxproj new file mode 100644 index 00000000..2f8d300c --- /dev/null +++ b/Frameworks/SPMySQLFramework/SPMySQLFramework.xcodeproj/project.pbxproj @@ -0,0 +1,695 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 45; + objects = { + +/* Begin PBXBuildFile section */ + 580A331E14D75CF7000D6933 /* SPMySQLGeometryData.h in Headers */ = {isa = PBXBuildFile; fileRef = 580A331C14D75CF7000D6933 /* SPMySQLGeometryData.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 580A331F14D75CF7000D6933 /* SPMySQLGeometryData.m in Sources */ = {isa = PBXBuildFile; fileRef = 580A331D14D75CF7000D6933 /* SPMySQLGeometryData.m */; }; + 58428E0014BA5FAE000F8438 /* SPMySQLConnection.h in Headers */ = {isa = PBXBuildFile; fileRef = 58428DFE14BA5FAE000F8438 /* SPMySQLConnection.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58428E0114BA5FAE000F8438 /* SPMySQLConnection.m in Sources */ = {isa = PBXBuildFile; fileRef = 58428DFF14BA5FAE000F8438 /* SPMySQLConnection.m */; }; + 5842929F14C34B36000F8438 /* my_alloc.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929414C34B36000F8438 /* my_alloc.h */; settings = {ATTRIBUTES = (); }; }; + 584292A014C34B36000F8438 /* my_list.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929514C34B36000F8438 /* my_list.h */; settings = {ATTRIBUTES = (); }; }; + 584292A114C34B36000F8438 /* mysql.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929614C34B36000F8438 /* mysql.h */; }; + 584292A214C34B36000F8438 /* mysql_com.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929714C34B36000F8438 /* mysql_com.h */; }; + 584292A314C34B36000F8438 /* mysql_embed.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929814C34B36000F8438 /* mysql_embed.h */; }; + 584292A414C34B36000F8438 /* mysql_time.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929914C34B36000F8438 /* mysql_time.h */; }; + 584292A514C34B36000F8438 /* mysql_version.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929A14C34B36000F8438 /* mysql_version.h */; }; + 584292A614C34B36000F8438 /* typelib.h in Headers */ = {isa = PBXBuildFile; fileRef = 5842929B14C34B36000F8438 /* typelib.h */; }; + 584292A714C34B36000F8438 /* libmysqlclient.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 5842929D14C34B36000F8438 /* libmysqlclient.a */; }; + 584294E414CB8002000F8438 /* SPMySQLConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = 584294E314CB8002000F8438 /* SPMySQLConstants.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 584294F014CB8002000F8438 /* Ping & KeepAlive.h in Headers */ = {isa = PBXBuildFile; fileRef = 584294EE14CB8002000F8438 /* Ping & KeepAlive.h */; }; + 584294F114CB8002000F8438 /* Ping & KeepAlive.m in Sources */ = {isa = PBXBuildFile; fileRef = 584294EF14CB8002000F8438 /* Ping & KeepAlive.m */; }; + 584294F614CB8002000F8438 /* Querying & Preparation.h in Headers */ = {isa = PBXBuildFile; fileRef = 584294F414CB8002000F8438 /* Querying & Preparation.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 584294FA14CB8002000F8438 /* Encoding.h in Headers */ = {isa = PBXBuildFile; fileRef = 584294F814CB8002000F8438 /* Encoding.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 584294FB14CB8002000F8438 /* Encoding.m in Sources */ = {isa = PBXBuildFile; fileRef = 584294F914CB8002000F8438 /* Encoding.m */; }; + 584294FE14CB8002000F8438 /* Server Info.h in Headers */ = {isa = PBXBuildFile; fileRef = 584294FC14CB8002000F8438 /* Server Info.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 584294FF14CB8002000F8438 /* Server Info.m in Sources */ = {isa = PBXBuildFile; fileRef = 584294FD14CB8002000F8438 /* Server Info.m */; }; + 584D812E15057ECD00F24774 /* SPMySQLKeepAliveTimer.h in Headers */ = {isa = PBXBuildFile; fileRef = 584D812C15057ECD00F24774 /* SPMySQLKeepAliveTimer.h */; }; + 584D812F15057ECD00F24774 /* SPMySQLKeepAliveTimer.m in Sources */ = {isa = PBXBuildFile; fileRef = 584D812D15057ECD00F24774 /* SPMySQLKeepAliveTimer.m */; }; + 584D82551509775000F24774 /* Copying.h in Headers */ = {isa = PBXBuildFile; fileRef = 584D82531509775000F24774 /* Copying.h */; }; + 584D82561509775000F24774 /* Copying.m in Sources */ = {isa = PBXBuildFile; fileRef = 584D82541509775000F24774 /* Copying.m */; }; + 586A99FB14F02E21007F82BF /* SPMySQLStreamingResult.h in Headers */ = {isa = PBXBuildFile; fileRef = 586A99F914F02E21007F82BF /* SPMySQLStreamingResult.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 586A99FC14F02E21007F82BF /* SPMySQLStreamingResult.m in Sources */ = {isa = PBXBuildFile; fileRef = 586A99FA14F02E21007F82BF /* SPMySQLStreamingResult.m */; }; + 586AA16714F30C5F007F82BF /* Convenience Methods.h in Headers */ = {isa = PBXBuildFile; fileRef = 586AA16514F30C5F007F82BF /* Convenience Methods.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 586AA16814F30C5F007F82BF /* Convenience Methods.m in Sources */ = {isa = PBXBuildFile; fileRef = 586AA16614F30C5F007F82BF /* Convenience Methods.m */; }; + 586AA81414F6C648007F82BF /* SPMySQLArrayAdditions.h in Headers */ = {isa = PBXBuildFile; fileRef = 586AA81214F6C648007F82BF /* SPMySQLArrayAdditions.h */; }; + 5884127714CC63830078027F /* SPMySQL.h in Headers */ = {isa = PBXBuildFile; fileRef = 5884127614CC63830078027F /* SPMySQL.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 588412A814CC7A4D0078027F /* Locking.h in Headers */ = {isa = PBXBuildFile; fileRef = 588412A614CC7A4D0078027F /* Locking.h */; }; + 5884133C14CCEC6B0078027F /* libz.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = 5884133B14CCEC6B0078027F /* libz.dylib */; }; + 5884142714CCF5190078027F /* Conversion.h in Headers */ = {isa = PBXBuildFile; fileRef = 5884142514CCF5190078027F /* Conversion.h */; }; + 5884142814CCF5190078027F /* Conversion.m in Sources */ = {isa = PBXBuildFile; fileRef = 5884142614CCF5190078027F /* Conversion.m */; }; + 588414BD14CE3B110078027F /* SPMySQLConnectionDelegate.h in Headers */ = {isa = PBXBuildFile; fileRef = 588414BC14CE3B110078027F /* SPMySQLConnectionDelegate.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5884159414D1A6760078027F /* Locking.m in Sources */ = {isa = PBXBuildFile; fileRef = 588412A714CC7A4D0078027F /* Locking.m */; }; + 5884159514D1A6880078027F /* Querying & Preparation.m in Sources */ = {isa = PBXBuildFile; fileRef = 584294F514CB8002000F8438 /* Querying & Preparation.m */; }; + 5884165514D2306A0078027F /* SPMySQLResult.h in Headers */ = {isa = PBXBuildFile; fileRef = 5884165314D2306A0078027F /* SPMySQLResult.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 5884165614D2306A0078027F /* SPMySQLResult.m in Sources */ = {isa = PBXBuildFile; fileRef = 5884165414D2306A0078027F /* SPMySQLResult.m */; }; + 58C006C814E0B18A00AC489A /* SPMySQLUtilities.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C006C714E0B18A00AC489A /* SPMySQLUtilities.h */; }; + 58C008CD14E2AC7D00AC489A /* SPMySQLConnectionProxy.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C008CC14E2AC7D00AC489A /* SPMySQLConnectionProxy.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58C009D514E31D3800AC489A /* SPMySQLStringAdditions.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C009D314E31D3800AC489A /* SPMySQLStringAdditions.h */; }; + 58C009D614E31D3800AC489A /* SPMySQLStringAdditions.m in Sources */ = {isa = PBXBuildFile; fileRef = 58C009D414E31D3800AC489A /* SPMySQLStringAdditions.m */; }; + 58C00AA914E4869C00AC489A /* Max Packet Size.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C00AA714E4869C00AC489A /* Max Packet Size.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58C00AAA14E4869C00AC489A /* Max Packet Size.m in Sources */ = {isa = PBXBuildFile; fileRef = 58C00AA814E4869C00AC489A /* Max Packet Size.m */; }; + 58C00AB514E4892E00AC489A /* Delegate & Proxy.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C00AB314E4892E00AC489A /* Delegate & Proxy.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58C00AB614E4892E00AC489A /* Delegate & Proxy.m in Sources */ = {isa = PBXBuildFile; fileRef = 58C00AB414E4892E00AC489A /* Delegate & Proxy.m */; }; + 58C00ADA14E4959A00AC489A /* SystemConfiguration.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 58C00AD914E4959A00AC489A /* SystemConfiguration.framework */; }; + 58C00BD114E7459600AC489A /* Databases & Tables.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C00BCF14E7459600AC489A /* Databases & Tables.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58C00BD214E7459600AC489A /* Databases & Tables.m in Sources */ = {isa = PBXBuildFile; fileRef = 58C00BD014E7459600AC489A /* Databases & Tables.m */; }; + 58C00CA514E845D800AC489A /* SPMySQL Private APIs.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C00CA414E845D800AC489A /* SPMySQL Private APIs.h */; }; + 58C7C1E414DB6E4C00436315 /* SPMySQLFastStreamingResult.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C7C1E214DB6E4C00436315 /* SPMySQLFastStreamingResult.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58C7C1E514DB6E4C00436315 /* SPMySQLFastStreamingResult.m in Sources */ = {isa = PBXBuildFile; fileRef = 58C7C1E314DB6E4C00436315 /* SPMySQLFastStreamingResult.m */; }; + 58C7C1E814DB6E8600436315 /* Field Definitions.h in Headers */ = {isa = PBXBuildFile; fileRef = 58C7C1E614DB6E8600436315 /* Field Definitions.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 58C7C1E914DB6E8600436315 /* Field Definitions.m in Sources */ = {isa = PBXBuildFile; fileRef = 58C7C1E714DB6E8600436315 /* Field Definitions.m */; }; + 8DC2EF530486A6940098B216 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 089C1666FE841158C02AAC07 /* InfoPlist.strings */; }; + 8DC2EF570486A6940098B216 /* Cocoa.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 1058C7B1FEA5585E11CA2CBB /* Cocoa.framework */; }; +/* End PBXBuildFile section */ + +/* Begin PBXFileReference section */ + 0867D69BFE84028FC02AAC07 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = /System/Library/Frameworks/Foundation.framework; sourceTree = "<absolute>"; }; + 0867D6A5FE840307C02AAC07 /* AppKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = AppKit.framework; path = /System/Library/Frameworks/AppKit.framework; sourceTree = "<absolute>"; }; + 089C1667FE841158C02AAC07 /* English */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.strings; name = English; path = English.lproj/InfoPlist.strings; sourceTree = "<group>"; }; + 1058C7B1FEA5585E11CA2CBB /* Cocoa.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Cocoa.framework; path = /System/Library/Frameworks/Cocoa.framework; sourceTree = "<absolute>"; }; + 32DBCF5E0370ADEE00C91783 /* SPMySQLFramework_Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLFramework_Prefix.pch; path = Source/SPMySQLFramework_Prefix.pch; sourceTree = "<group>"; }; + 580A331C14D75CF7000D6933 /* SPMySQLGeometryData.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLGeometryData.h; path = Source/SPMySQLGeometryData.h; sourceTree = "<group>"; }; + 580A331D14D75CF7000D6933 /* SPMySQLGeometryData.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLGeometryData.m; path = Source/SPMySQLGeometryData.m; sourceTree = "<group>"; }; + 58428DF614BA5A13000F8438 /* build-mysql-client.sh */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.script.sh; path = "build-mysql-client.sh"; sourceTree = "<group>"; }; + 58428DFE14BA5FAE000F8438 /* SPMySQLConnection.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLConnection.h; path = Source/SPMySQLConnection.h; sourceTree = "<group>"; }; + 58428DFF14BA5FAE000F8438 /* SPMySQLConnection.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLConnection.m; path = Source/SPMySQLConnection.m; sourceTree = "<group>"; }; + 5842929414C34B36000F8438 /* my_alloc.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = my_alloc.h; sourceTree = "<group>"; }; + 5842929514C34B36000F8438 /* my_list.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = my_list.h; sourceTree = "<group>"; }; + 5842929614C34B36000F8438 /* mysql.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = mysql.h; sourceTree = "<group>"; }; + 5842929714C34B36000F8438 /* mysql_com.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = mysql_com.h; sourceTree = "<group>"; }; + 5842929814C34B36000F8438 /* mysql_embed.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = mysql_embed.h; sourceTree = "<group>"; }; + 5842929914C34B36000F8438 /* mysql_time.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = mysql_time.h; sourceTree = "<group>"; }; + 5842929A14C34B36000F8438 /* mysql_version.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = mysql_version.h; sourceTree = "<group>"; }; + 5842929B14C34B36000F8438 /* typelib.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = typelib.h; sourceTree = "<group>"; }; + 5842929D14C34B36000F8438 /* libmysqlclient.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; path = libmysqlclient.a; sourceTree = "<group>"; }; + 584294E314CB8002000F8438 /* SPMySQLConstants.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLConstants.h; path = Source/SPMySQLConstants.h; sourceTree = "<group>"; }; + 584294EE14CB8002000F8438 /* Ping & KeepAlive.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Ping & KeepAlive.h"; path = "Source/SPMySQLConnection Categories/Ping & KeepAlive.h"; sourceTree = "<group>"; }; + 584294EF14CB8002000F8438 /* Ping & KeepAlive.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Ping & KeepAlive.m"; path = "Source/SPMySQLConnection Categories/Ping & KeepAlive.m"; sourceTree = "<group>"; }; + 584294F414CB8002000F8438 /* Querying & Preparation.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Querying & Preparation.h"; path = "Source/SPMySQLConnection Categories/Querying & Preparation.h"; sourceTree = "<group>"; }; + 584294F514CB8002000F8438 /* Querying & Preparation.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Querying & Preparation.m"; path = "Source/SPMySQLConnection Categories/Querying & Preparation.m"; sourceTree = "<group>"; }; + 584294F814CB8002000F8438 /* Encoding.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = Encoding.h; path = "Source/SPMySQLConnection Categories/Encoding.h"; sourceTree = "<group>"; }; + 584294F914CB8002000F8438 /* Encoding.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = Encoding.m; path = "Source/SPMySQLConnection Categories/Encoding.m"; sourceTree = "<group>"; }; + 584294FC14CB8002000F8438 /* Server Info.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Server Info.h"; path = "Source/SPMySQLConnection Categories/Server Info.h"; sourceTree = "<group>"; }; + 584294FD14CB8002000F8438 /* Server Info.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Server Info.m"; path = "Source/SPMySQLConnection Categories/Server Info.m"; sourceTree = "<group>"; }; + 584D812C15057ECD00F24774 /* SPMySQLKeepAliveTimer.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLKeepAliveTimer.h; path = Source/SPMySQLKeepAliveTimer.h; sourceTree = "<group>"; }; + 584D812D15057ECD00F24774 /* SPMySQLKeepAliveTimer.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLKeepAliveTimer.m; path = Source/SPMySQLKeepAliveTimer.m; sourceTree = "<group>"; }; + 584D82531509775000F24774 /* Copying.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = Copying.h; path = "Source/SPMySQLConnection Categories/Copying.h"; sourceTree = "<group>"; }; + 584D82541509775000F24774 /* Copying.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = Copying.m; path = "Source/SPMySQLConnection Categories/Copying.m"; sourceTree = "<group>"; }; + 586A99F914F02E21007F82BF /* SPMySQLStreamingResult.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLStreamingResult.h; path = Source/SPMySQLStreamingResult.h; sourceTree = "<group>"; }; + 586A99FA14F02E21007F82BF /* SPMySQLStreamingResult.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLStreamingResult.m; path = Source/SPMySQLStreamingResult.m; sourceTree = "<group>"; }; + 586AA0E714F1CEC8007F82BF /* Readme.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = Readme.txt; sourceTree = "<group>"; }; + 586AA16514F30C5F007F82BF /* Convenience Methods.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Convenience Methods.h"; path = "Source/SPMySQLResult Categories/Convenience Methods.h"; sourceTree = "<group>"; }; + 586AA16614F30C5F007F82BF /* Convenience Methods.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Convenience Methods.m"; path = "Source/SPMySQLResult Categories/Convenience Methods.m"; sourceTree = "<group>"; }; + 586AA81214F6C648007F82BF /* SPMySQLArrayAdditions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLArrayAdditions.h; path = Source/SPMySQLArrayAdditions.h; sourceTree = "<group>"; }; + 5884127614CC63830078027F /* SPMySQL.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQL.h; path = Source/SPMySQL.h; sourceTree = "<group>"; }; + 588412A614CC7A4D0078027F /* Locking.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = Locking.h; path = "Source/SPMySQLConnection Categories/Locking.h"; sourceTree = "<group>"; }; + 588412A714CC7A4D0078027F /* Locking.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = Locking.m; path = "Source/SPMySQLConnection Categories/Locking.m"; sourceTree = "<group>"; }; + 5884133B14CCEC6B0078027F /* libz.dylib */ = {isa = PBXFileReference; lastKnownFileType = "compiled.mach-o.dylib"; name = libz.dylib; path = usr/lib/libz.dylib; sourceTree = SDKROOT; }; + 5884142514CCF5190078027F /* Conversion.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = Conversion.h; path = "Source/SPMySQLConnection Categories/Conversion.h"; sourceTree = "<group>"; }; + 5884142614CCF5190078027F /* Conversion.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = Conversion.m; path = "Source/SPMySQLConnection Categories/Conversion.m"; sourceTree = "<group>"; }; + 588414BC14CE3B110078027F /* SPMySQLConnectionDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLConnectionDelegate.h; path = Source/SPMySQLConnectionDelegate.h; sourceTree = "<group>"; }; + 5884165314D2306A0078027F /* SPMySQLResult.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLResult.h; path = Source/SPMySQLResult.h; sourceTree = "<group>"; }; + 5884165414D2306A0078027F /* SPMySQLResult.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLResult.m; path = Source/SPMySQLResult.m; sourceTree = "<group>"; }; + 58C006C714E0B18A00AC489A /* SPMySQLUtilities.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLUtilities.h; path = Source/SPMySQLUtilities.h; sourceTree = "<group>"; }; + 58C008CC14E2AC7D00AC489A /* SPMySQLConnectionProxy.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLConnectionProxy.h; path = Source/SPMySQLConnectionProxy.h; sourceTree = "<group>"; }; + 58C009D314E31D3800AC489A /* SPMySQLStringAdditions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLStringAdditions.h; path = Source/SPMySQLStringAdditions.h; sourceTree = "<group>"; }; + 58C009D414E31D3800AC489A /* SPMySQLStringAdditions.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLStringAdditions.m; path = Source/SPMySQLStringAdditions.m; sourceTree = "<group>"; }; + 58C00AA714E4869C00AC489A /* Max Packet Size.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Max Packet Size.h"; path = "Source/SPMySQLConnection Categories/Max Packet Size.h"; sourceTree = "<group>"; }; + 58C00AA814E4869C00AC489A /* Max Packet Size.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Max Packet Size.m"; path = "Source/SPMySQLConnection Categories/Max Packet Size.m"; sourceTree = "<group>"; }; + 58C00AB314E4892E00AC489A /* Delegate & Proxy.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Delegate & Proxy.h"; path = "Source/SPMySQLConnection Categories/Delegate & Proxy.h"; sourceTree = "<group>"; }; + 58C00AB414E4892E00AC489A /* Delegate & Proxy.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Delegate & Proxy.m"; path = "Source/SPMySQLConnection Categories/Delegate & Proxy.m"; sourceTree = "<group>"; }; + 58C00AD914E4959A00AC489A /* SystemConfiguration.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SystemConfiguration.framework; path = System/Library/Frameworks/SystemConfiguration.framework; sourceTree = SDKROOT; }; + 58C00BCF14E7459600AC489A /* Databases & Tables.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Databases & Tables.h"; path = "Source/SPMySQLConnection Categories/Databases & Tables.h"; sourceTree = "<group>"; }; + 58C00BD014E7459600AC489A /* Databases & Tables.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Databases & Tables.m"; path = "Source/SPMySQLConnection Categories/Databases & Tables.m"; sourceTree = "<group>"; }; + 58C00CA414E845D800AC489A /* SPMySQL Private APIs.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "SPMySQL Private APIs.h"; path = "Source/SPMySQL Private APIs.h"; sourceTree = "<group>"; }; + 58C7C1E214DB6E4C00436315 /* SPMySQLFastStreamingResult.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SPMySQLFastStreamingResult.h; path = Source/SPMySQLFastStreamingResult.h; sourceTree = "<group>"; }; + 58C7C1E314DB6E4C00436315 /* SPMySQLFastStreamingResult.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SPMySQLFastStreamingResult.m; path = Source/SPMySQLFastStreamingResult.m; sourceTree = "<group>"; }; + 58C7C1E614DB6E8600436315 /* Field Definitions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "Field Definitions.h"; path = "Source/SPMySQLResult Categories/Field Definitions.h"; sourceTree = "<group>"; }; + 58C7C1E714DB6E8600436315 /* Field Definitions.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "Field Definitions.m"; path = "Source/SPMySQLResult Categories/Field Definitions.m"; sourceTree = "<group>"; }; + 8DC2EF5A0486A6940098B216 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = Resources/Info.plist; sourceTree = "<group>"; }; + 8DC2EF5B0486A6940098B216 /* SPMySQL.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SPMySQL.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + D2F7E79907B2D74100F64583 /* CoreData.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreData.framework; path = /System/Library/Frameworks/CoreData.framework; sourceTree = "<absolute>"; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 8DC2EF560486A6940098B216 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 8DC2EF570486A6940098B216 /* Cocoa.framework in Frameworks */, + 584292A714C34B36000F8438 /* libmysqlclient.a in Frameworks */, + 5884133C14CCEC6B0078027F /* libz.dylib in Frameworks */, + 58C00ADA14E4959A00AC489A /* SystemConfiguration.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 034768DFFF38A50411DB9C8B /* Products */ = { + isa = PBXGroup; + children = ( + 8DC2EF5B0486A6940098B216 /* SPMySQL.framework */, + ); + name = Products; + sourceTree = "<group>"; + }; + 0867D691FE84028FC02AAC07 /* SPMySQLFramework */ = { + isa = PBXGroup; + children = ( + 586AA0E714F1CEC8007F82BF /* Readme.txt */, + 5884127614CC63830078027F /* SPMySQL.h */, + 58C0077714E1DFFF00AC489A /* Protocols */, + 08FB77AEFE84172EC02AAC07 /* Classes */, + 58C009D214E31D1300AC489A /* Category Additions */, + 32C88DFF0371C24200C91783 /* Other Sources */, + 089C1665FE841158C02AAC07 /* Resources */, + 58428DF514BA5A03000F8438 /* Scripts */, + 0867D69AFE84028FC02AAC07 /* External Frameworks and Libraries */, + 034768DFFF38A50411DB9C8B /* Products */, + ); + name = SPMySQLFramework; + sourceTree = "<group>"; + }; + 0867D69AFE84028FC02AAC07 /* External Frameworks and Libraries */ = { + isa = PBXGroup; + children = ( + 1058C7B0FEA5585E11CA2CBB /* Linked Frameworks */, + 1058C7B2FEA5585E11CA2CBB /* Other Frameworks */, + ); + name = "External Frameworks and Libraries"; + sourceTree = "<group>"; + }; + 089C1665FE841158C02AAC07 /* Resources */ = { + isa = PBXGroup; + children = ( + 5842929214C34B36000F8438 /* MySQL Client Libraries */, + 8DC2EF5A0486A6940098B216 /* Info.plist */, + 089C1666FE841158C02AAC07 /* InfoPlist.strings */, + ); + name = Resources; + sourceTree = "<group>"; + }; + 08FB77AEFE84172EC02AAC07 /* Classes */ = { + isa = PBXGroup; + children = ( + 58C00CA414E845D800AC489A /* SPMySQL Private APIs.h */, + 58428DFE14BA5FAE000F8438 /* SPMySQLConnection.h */, + 58428DFF14BA5FAE000F8438 /* SPMySQLConnection.m */, + 584294EB14CB8002000F8438 /* Connection Categories */, + 5884165314D2306A0078027F /* SPMySQLResult.h */, + 5884165414D2306A0078027F /* SPMySQLResult.m */, + 586A99F914F02E21007F82BF /* SPMySQLStreamingResult.h */, + 586A99FA14F02E21007F82BF /* SPMySQLStreamingResult.m */, + 58C7C1E214DB6E4C00436315 /* SPMySQLFastStreamingResult.h */, + 58C7C1E314DB6E4C00436315 /* SPMySQLFastStreamingResult.m */, + 58C7C1E114DB6E3000436315 /* Result Categories */, + 580A331B14D75CCF000D6933 /* Result types */, + 584D812C15057ECD00F24774 /* SPMySQLKeepAliveTimer.h */, + 584D812D15057ECD00F24774 /* SPMySQLKeepAliveTimer.m */, + ); + name = Classes; + sourceTree = "<group>"; + }; + 1058C7B0FEA5585E11CA2CBB /* Linked Frameworks */ = { + isa = PBXGroup; + children = ( + 1058C7B1FEA5585E11CA2CBB /* Cocoa.framework */, + 5884133B14CCEC6B0078027F /* libz.dylib */, + ); + name = "Linked Frameworks"; + sourceTree = "<group>"; + }; + 1058C7B2FEA5585E11CA2CBB /* Other Frameworks */ = { + isa = PBXGroup; + children = ( + 0867D6A5FE840307C02AAC07 /* AppKit.framework */, + D2F7E79907B2D74100F64583 /* CoreData.framework */, + 0867D69BFE84028FC02AAC07 /* Foundation.framework */, + 58C00AD914E4959A00AC489A /* SystemConfiguration.framework */, + ); + name = "Other Frameworks"; + sourceTree = "<group>"; + }; + 32C88DFF0371C24200C91783 /* Other Sources */ = { + isa = PBXGroup; + children = ( + 584294E314CB8002000F8438 /* SPMySQLConstants.h */, + 58C006C714E0B18A00AC489A /* SPMySQLUtilities.h */, + 32DBCF5E0370ADEE00C91783 /* SPMySQLFramework_Prefix.pch */, + ); + name = "Other Sources"; + sourceTree = "<group>"; + }; + 580A331B14D75CCF000D6933 /* Result types */ = { + isa = PBXGroup; + children = ( + 580A331C14D75CF7000D6933 /* SPMySQLGeometryData.h */, + 580A331D14D75CF7000D6933 /* SPMySQLGeometryData.m */, + ); + name = "Result types"; + sourceTree = "<group>"; + }; + 58428DF514BA5A03000F8438 /* Scripts */ = { + isa = PBXGroup; + children = ( + 58428DF614BA5A13000F8438 /* build-mysql-client.sh */, + ); + name = Scripts; + sourceTree = "<group>"; + }; + 5842929214C34B36000F8438 /* MySQL Client Libraries */ = { + isa = PBXGroup; + children = ( + 5842929314C34B36000F8438 /* include */, + 5842929C14C34B36000F8438 /* lib */, + ); + path = "MySQL Client Libraries"; + sourceTree = "<group>"; + }; + 5842929314C34B36000F8438 /* include */ = { + isa = PBXGroup; + children = ( + 5842929414C34B36000F8438 /* my_alloc.h */, + 5842929514C34B36000F8438 /* my_list.h */, + 5842929614C34B36000F8438 /* mysql.h */, + 5842929714C34B36000F8438 /* mysql_com.h */, + 5842929814C34B36000F8438 /* mysql_embed.h */, + 5842929914C34B36000F8438 /* mysql_time.h */, + 5842929A14C34B36000F8438 /* mysql_version.h */, + 5842929B14C34B36000F8438 /* typelib.h */, + ); + path = include; + sourceTree = "<group>"; + }; + 5842929C14C34B36000F8438 /* lib */ = { + isa = PBXGroup; + children = ( + 5842929D14C34B36000F8438 /* libmysqlclient.a */, + ); + path = lib; + sourceTree = "<group>"; + }; + 584294EB14CB8002000F8438 /* Connection Categories */ = { + isa = PBXGroup; + children = ( + 584D82531509775000F24774 /* Copying.h */, + 584D82541509775000F24774 /* Copying.m */, + 58C00AB314E4892E00AC489A /* Delegate & Proxy.h */, + 58C00AB414E4892E00AC489A /* Delegate & Proxy.m */, + 58C00BCF14E7459600AC489A /* Databases & Tables.h */, + 58C00BD014E7459600AC489A /* Databases & Tables.m */, + 584294F414CB8002000F8438 /* Querying & Preparation.h */, + 584294F514CB8002000F8438 /* Querying & Preparation.m */, + 584294F814CB8002000F8438 /* Encoding.h */, + 584294F914CB8002000F8438 /* Encoding.m */, + 584294FC14CB8002000F8438 /* Server Info.h */, + 584294FD14CB8002000F8438 /* Server Info.m */, + 58C00AA714E4869C00AC489A /* Max Packet Size.h */, + 58C00AA814E4869C00AC489A /* Max Packet Size.m */, + 5884142414CCF4E60078027F /* Private */, + ); + name = "Connection Categories"; + sourceTree = "<group>"; + }; + 5884142414CCF4E60078027F /* Private */ = { + isa = PBXGroup; + children = ( + 584294EE14CB8002000F8438 /* Ping & KeepAlive.h */, + 584294EF14CB8002000F8438 /* Ping & KeepAlive.m */, + 588412A614CC7A4D0078027F /* Locking.h */, + 588412A714CC7A4D0078027F /* Locking.m */, + 5884142514CCF5190078027F /* Conversion.h */, + 5884142614CCF5190078027F /* Conversion.m */, + ); + name = Private; + sourceTree = "<group>"; + }; + 58C0077714E1DFFF00AC489A /* Protocols */ = { + isa = PBXGroup; + children = ( + 588414BC14CE3B110078027F /* SPMySQLConnectionDelegate.h */, + 58C008CC14E2AC7D00AC489A /* SPMySQLConnectionProxy.h */, + ); + name = Protocols; + sourceTree = "<group>"; + }; + 58C009D214E31D1300AC489A /* Category Additions */ = { + isa = PBXGroup; + children = ( + 58C009D314E31D3800AC489A /* SPMySQLStringAdditions.h */, + 58C009D414E31D3800AC489A /* SPMySQLStringAdditions.m */, + 586AA81214F6C648007F82BF /* SPMySQLArrayAdditions.h */, + ); + name = "Category Additions"; + sourceTree = "<group>"; + }; + 58C7C1E114DB6E3000436315 /* Result Categories */ = { + isa = PBXGroup; + children = ( + 58C7C1E614DB6E8600436315 /* Field Definitions.h */, + 58C7C1E714DB6E8600436315 /* Field Definitions.m */, + 586AA16514F30C5F007F82BF /* Convenience Methods.h */, + 586AA16614F30C5F007F82BF /* Convenience Methods.m */, + ); + name = "Result Categories"; + sourceTree = "<group>"; + }; +/* End PBXGroup section */ + +/* Begin PBXHeadersBuildPhase section */ + 8DC2EF500486A6940098B216 /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + 58428E0014BA5FAE000F8438 /* SPMySQLConnection.h in Headers */, + 584294E414CB8002000F8438 /* SPMySQLConstants.h in Headers */, + 584294F614CB8002000F8438 /* Querying & Preparation.h in Headers */, + 584294F014CB8002000F8438 /* Ping & KeepAlive.h in Headers */, + 584294FA14CB8002000F8438 /* Encoding.h in Headers */, + 584294FE14CB8002000F8438 /* Server Info.h in Headers */, + 5842929F14C34B36000F8438 /* my_alloc.h in Headers */, + 584292A014C34B36000F8438 /* my_list.h in Headers */, + 584292A114C34B36000F8438 /* mysql.h in Headers */, + 584292A214C34B36000F8438 /* mysql_com.h in Headers */, + 584292A314C34B36000F8438 /* mysql_embed.h in Headers */, + 584292A414C34B36000F8438 /* mysql_time.h in Headers */, + 584292A514C34B36000F8438 /* mysql_version.h in Headers */, + 584292A614C34B36000F8438 /* typelib.h in Headers */, + 5884127714CC63830078027F /* SPMySQL.h in Headers */, + 588412A814CC7A4D0078027F /* Locking.h in Headers */, + 5884142714CCF5190078027F /* Conversion.h in Headers */, + 588414BD14CE3B110078027F /* SPMySQLConnectionDelegate.h in Headers */, + 5884165514D2306A0078027F /* SPMySQLResult.h in Headers */, + 580A331E14D75CF7000D6933 /* SPMySQLGeometryData.h in Headers */, + 58C7C1E414DB6E4C00436315 /* SPMySQLFastStreamingResult.h in Headers */, + 58C7C1E814DB6E8600436315 /* Field Definitions.h in Headers */, + 58C006C814E0B18A00AC489A /* SPMySQLUtilities.h in Headers */, + 58C008CD14E2AC7D00AC489A /* SPMySQLConnectionProxy.h in Headers */, + 58C009D514E31D3800AC489A /* SPMySQLStringAdditions.h in Headers */, + 58C00AA914E4869C00AC489A /* Max Packet Size.h in Headers */, + 58C00AB514E4892E00AC489A /* Delegate & Proxy.h in Headers */, + 58C00BD114E7459600AC489A /* Databases & Tables.h in Headers */, + 58C00CA514E845D800AC489A /* SPMySQL Private APIs.h in Headers */, + 586A99FB14F02E21007F82BF /* SPMySQLStreamingResult.h in Headers */, + 586AA16714F30C5F007F82BF /* Convenience Methods.h in Headers */, + 586AA81414F6C648007F82BF /* SPMySQLArrayAdditions.h in Headers */, + 584D812E15057ECD00F24774 /* SPMySQLKeepAliveTimer.h in Headers */, + 584D82551509775000F24774 /* Copying.h in Headers */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXHeadersBuildPhase section */ + +/* Begin PBXNativeTarget section */ + 8DC2EF4F0486A6940098B216 /* SPMySQL.framework */ = { + isa = PBXNativeTarget; + buildConfigurationList = 1DEB91AD08733DA50010E9CD /* Build configuration list for PBXNativeTarget "SPMySQL.framework" */; + buildPhases = ( + 8DC2EF500486A6940098B216 /* Headers */, + 8DC2EF520486A6940098B216 /* Resources */, + 8DC2EF540486A6940098B216 /* Sources */, + 8DC2EF560486A6940098B216 /* Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = SPMySQL.framework; + productInstallPath = "$(HOME)/Library/Frameworks"; + productName = SPMySQLFramework; + productReference = 8DC2EF5B0486A6940098B216 /* SPMySQL.framework */; + productType = "com.apple.product-type.framework"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 0867D690FE84028FC02AAC07 /* Project object */ = { + isa = PBXProject; + buildConfigurationList = 1DEB91B108733DA50010E9CD /* Build configuration list for PBXProject "SPMySQLFramework" */; + compatibilityVersion = "Xcode 3.1"; + developmentRegion = English; + hasScannedForEncodings = 1; + knownRegions = ( + English, + Japanese, + French, + German, + ); + mainGroup = 0867D691FE84028FC02AAC07 /* SPMySQLFramework */; + productRefGroup = 034768DFFF38A50411DB9C8B /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 8DC2EF4F0486A6940098B216 /* SPMySQL.framework */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 8DC2EF520486A6940098B216 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 8DC2EF530486A6940098B216 /* InfoPlist.strings in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 8DC2EF540486A6940098B216 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 58428E0114BA5FAE000F8438 /* SPMySQLConnection.m in Sources */, + 584294F114CB8002000F8438 /* Ping & KeepAlive.m in Sources */, + 584294FB14CB8002000F8438 /* Encoding.m in Sources */, + 584294FF14CB8002000F8438 /* Server Info.m in Sources */, + 5884142814CCF5190078027F /* Conversion.m in Sources */, + 5884159514D1A6880078027F /* Querying & Preparation.m in Sources */, + 5884159414D1A6760078027F /* Locking.m in Sources */, + 5884165614D2306A0078027F /* SPMySQLResult.m in Sources */, + 580A331F14D75CF7000D6933 /* SPMySQLGeometryData.m in Sources */, + 58C7C1E514DB6E4C00436315 /* SPMySQLFastStreamingResult.m in Sources */, + 58C7C1E914DB6E8600436315 /* Field Definitions.m in Sources */, + 58C009D614E31D3800AC489A /* SPMySQLStringAdditions.m in Sources */, + 58C00AAA14E4869C00AC489A /* Max Packet Size.m in Sources */, + 58C00AB614E4892E00AC489A /* Delegate & Proxy.m in Sources */, + 58C00BD214E7459600AC489A /* Databases & Tables.m in Sources */, + 586A99FC14F02E21007F82BF /* SPMySQLStreamingResult.m in Sources */, + 586AA16814F30C5F007F82BF /* Convenience Methods.m in Sources */, + 584D812F15057ECD00F24774 /* SPMySQLKeepAliveTimer.m in Sources */, + 584D82561509775000F24774 /* Copying.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXVariantGroup section */ + 089C1666FE841158C02AAC07 /* InfoPlist.strings */ = { + isa = PBXVariantGroup; + children = ( + 089C1667FE841158C02AAC07 /* English */, + ); + name = InfoPlist.strings; + sourceTree = "<group>"; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 1DEB91AE08733DA50010E9CD /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + DEAD_CODE_STRIPPING = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + FRAMEWORK_VERSION = A; + GCC_DYNAMIC_NO_PIC = NO; + GCC_ENABLE_FIX_AND_CONTINUE = YES; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = Source/SPMySQLFramework_Prefix.pch; + INFOPLIST_FILE = Resources/Info.plist; + INSTALL_PATH = "@executable_path/../Frameworks"; + LD_DYLIB_INSTALL_NAME = "$(DYLIB_INSTALL_NAME_BASE:standardizepath)/$(EXECUTABLE_PATH)"; + LIBRARY_SEARCH_PATHS = ( + "$(inherited)", + "\"$(SRCROOT)/MySQL Client Libraries/lib\"", + ); + PRODUCT_NAME = SPMySQL; + WRAPPER_EXTENSION = framework; + }; + name = Debug; + }; + 1DEB91AF08733DA50010E9CD /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + DEAD_CODE_STRIPPING = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + FRAMEWORK_VERSION = A; + GCC_GENERATE_DEBUGGING_SYMBOLS = YES; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = Source/SPMySQLFramework_Prefix.pch; + INFOPLIST_FILE = Resources/Info.plist; + INSTALL_PATH = "@executable_path/../Frameworks"; + LIBRARY_SEARCH_PATHS = ( + "$(inherited)", + "\"$(SRCROOT)/MySQL Client Libraries/lib\"", + ); + PRODUCT_NAME = SPMySQL; + WRAPPER_EXTENSION = framework; + }; + name = Release; + }; + 1DEB91B208733DA50010E9CD /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = ( + i386, + ppc, + x86_64, + ); + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_VERSION = com.apple.compilers.llvm.clang.1_0; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; + GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_CHECK_SWITCH_STATEMENTS = YES; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_MISSING_PARENTHESES = YES; + GCC_WARN_SHADOW = YES; + GCC_WARN_SIGN_COMPARE = YES; + GCC_WARN_STRICT_SELECTOR_MATCH = YES; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACH_O_TYPE = mh_dylib; + ONLY_ACTIVE_ARCH = YES; + PREBINDING = NO; + SDKROOT = macosx10.5; + VALID_ARCHS = "i386 ppc x86_64"; + }; + name = Debug; + }; + 1DEB91B308733DA50010E9CD /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = ( + i386, + ppc, + x86_64, + ); + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_VERSION = com.apple.compilers.llvm.clang.1_0; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; + GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_CHECK_SWITCH_STATEMENTS = YES; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_MISSING_PARENTHESES = YES; + GCC_WARN_SHADOW = YES; + GCC_WARN_SIGN_COMPARE = YES; + GCC_WARN_STRICT_SELECTOR_MATCH = YES; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACH_O_TYPE = mh_dylib; + PREBINDING = NO; + SDKROOT = macosx10.5; + VALID_ARCHS = "i386 ppc x86_64"; + }; + name = Release; + }; + 586AA55214F5D599007F82BF /* Distribution */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = ( + i386, + ppc, + x86_64, + ); + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_VERSION = com.apple.compilers.llvm.clang.1_0; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_MISSING_FIELD_INITIALIZERS = YES; + GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_CHECK_SWITCH_STATEMENTS = YES; + GCC_WARN_INITIALIZER_NOT_FULLY_BRACKETED = YES; + GCC_WARN_MISSING_PARENTHESES = YES; + GCC_WARN_SHADOW = YES; + GCC_WARN_SIGN_COMPARE = YES; + GCC_WARN_STRICT_SELECTOR_MATCH = YES; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACH_O_TYPE = mh_dylib; + PREBINDING = NO; + SDKROOT = macosx10.5; + VALID_ARCHS = "i386 ppc x86_64"; + }; + name = Distribution; + }; + 586AA55314F5D599007F82BF /* Distribution */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + DEAD_CODE_STRIPPING = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + FRAMEWORK_VERSION = A; + GCC_GENERATE_DEBUGGING_SYMBOLS = YES; + GCC_MODEL_TUNING = G5; + GCC_PRECOMPILE_PREFIX_HEADER = YES; + GCC_PREFIX_HEADER = Source/SPMySQLFramework_Prefix.pch; + INFOPLIST_FILE = Resources/Info.plist; + INSTALL_PATH = "@executable_path/../Frameworks"; + LIBRARY_SEARCH_PATHS = ( + "$(inherited)", + "\"$(SRCROOT)/MySQL Client Libraries/lib\"", + ); + PRODUCT_NAME = SPMySQL; + WRAPPER_EXTENSION = framework; + }; + name = Distribution; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 1DEB91AD08733DA50010E9CD /* Build configuration list for PBXNativeTarget "SPMySQL.framework" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 1DEB91AE08733DA50010E9CD /* Debug */, + 1DEB91AF08733DA50010E9CD /* Release */, + 586AA55314F5D599007F82BF /* Distribution */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 1DEB91B108733DA50010E9CD /* Build configuration list for PBXProject "SPMySQLFramework" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 1DEB91B208733DA50010E9CD /* Debug */, + 1DEB91B308733DA50010E9CD /* Release */, + 586AA55214F5D599007F82BF /* Distribution */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 0867D690FE84028FC02AAC07 /* Project object */; +} diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQL Private APIs.h b/Frameworks/SPMySQLFramework/Source/SPMySQL Private APIs.h new file mode 100644 index 00000000..5772eb72 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQL Private APIs.h @@ -0,0 +1,110 @@ +// +// $Id$ +// +// SPMySQLConnection_PrivateAPI.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 12, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +/** + * A collection of Private APIs from the various categories, to simplify + * inclusion across the categories. + */ + +#import "Ping & KeepAlive.h" +#import "Locking.h" +#import "Conversion.h" + + +@interface SPMySQLConnection (PrivateAPI) + +- (MYSQL *)_makeRawMySQLConnectionWithEncoding:(NSString *)encodingName isMasterConnection:(BOOL)isMaster; +- (BOOL)_waitForNetworkConnectionWithTimeout:(double)timeoutSeconds; +- (void)_updateConnectionVariables; +- (void)_restoreConnectionVariables; +- (BOOL)_checkConnectionIfNecessary; + +@end + + +@interface SPMySQLConnection (Delegate_and_Proxy_Private_API) + +- (void)_proxyStateChange:(NSObject <SPMySQLConnectionProxy> *)aProxy; +- (SPMySQLConnectionLostDecision)_delegateDecisionForLostConnection; + +@end + + +@interface SPMySQLConnection (Databases_and_Tables_Private_API) + +- (BOOL)_storeAndAlterEncodingToUTF8IfRequired; + +@end + + +@interface SPMySQLConnection (Max_Packet_Size_Private_API) + +- (void)_updateMaxQuerySize; +- (void)_updateMaxQuerySizeEditability; +- (BOOL)_attemptMaxQuerySizeIncreaseTo:(NSUInteger)targetSize; +- (void)_restoreMaximumQuerySizeAfterQuery; + +@end + + +@interface SPMySQLConnection (Querying_and_Preparation_Private_API) + +- (void)_flushMultipleResultSets; +- (void)_updateLastErrorMessage:(NSString *)theErrorMessage; +- (void)_updateLastErrorID:(NSUInteger)theErrorID; + +@end + + +// SPMySQLResult Private API +@interface SPMySQLResult (Private_API) + +- (NSString *)_stringWithBytes:(const void *)bytes length:(NSUInteger)length; +- (void)_setQueryExecutionTime:(double)theExecutionTime; +- (id)_getObjectFromBytes:(char *)bytes ofLength:(NSUInteger)length fieldType:(unsigned int)fieldType fieldDefinitionIndex:(NSUInteger)fieldIndex; + +@end + +/** + * Set up a static function to allow fast calling of SPMySQLResult data conversion with cached selectors + */ +static inline id SPMySQLResultGetObject(SPMySQLResult* self, char* bytes, NSUInteger length, unsigned int fieldType, NSUInteger fieldIndex) +{ + typedef id (*SPMySQLResultGetObjectMethodPtr)(SPMySQLResult*, SEL, char*, NSUInteger, unsigned int, NSUInteger); + static SPMySQLResultGetObjectMethodPtr cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedSelector) cachedSelector = @selector(_getObjectFromBytes:ofLength:fieldType:fieldDefinitionIndex:); + if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLResultGetObjectMethodPtr)[self methodForSelector:cachedSelector]; + + return cachedMethodPointer(self, cachedSelector, bytes, length, fieldType, fieldIndex); +}
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQL.h b/Frameworks/SPMySQLFramework/Source/SPMySQL.h new file mode 100644 index 00000000..3c4c78f8 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQL.h @@ -0,0 +1,63 @@ +// +// $Id$ +// +// SPMySQL.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 22, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +@class SPMySQLConnection, SPMySQLResult, SPMySQLStreamingResult, SPMySQLFastStreamingResult; + +// Global include file for the framework. +// Constants +#import "SPMySQLConstants.h" + +// Required category additions +#import "SPMySQLStringAdditions.h" + +// MySQL Connection Delegate and Proxy protocols +#import "SPMySQLConnectionDelegate.h" +#import "SPMySQLConnectionProxy.h" + +// MySQL Connection class and public categories +#import "SPMySQLConnection.h" +#import "Delegate & Proxy.h" +#import "Databases & Tables.h" +#import "Max Packet Size.h" +#import "Querying & Preparation.h" +#import "Encoding.h" +#import "Server Info.h" + +// MySQL result set, streaming subclasses of same, and associated categories +#import "SPMySQLResult.h" +#import "SPMySQLStreamingResult.h" +#import "SPMySQLFastStreamingResult.h" +#import "Field Definitions.h" +#import "Convenience Methods.h" + +// Result data objects +#import "SPMySQLGeometryData.h" diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLArrayAdditions.h b/Frameworks/SPMySQLFramework/Source/SPMySQLArrayAdditions.h new file mode 100644 index 00000000..46c6d8e0 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLArrayAdditions.h @@ -0,0 +1,50 @@ +// +// $Id$ +// +// SPMySQLArrayAdditions.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 23, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +/** + * Set up a static function to allow fast mutable array insertion using + * cached selectors. + * At least in 10.7, inserting items into an array at a known point + * using NSMutableArray methods appears to be the fastest way of adding + * items to a CF/NSMutableArray. + */ +static inline void SPMySQLMutableArrayInsertObject(NSMutableArray *self, id anObject, NSUInteger anIndex) +{ + typedef id (*SPMySQLMutableArrayInsertObjectPtr)(NSMutableArray*, SEL, id, NSUInteger); + static SPMySQLMutableArrayInsertObjectPtr cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedSelector) cachedSelector = @selector(insertObject:atIndex:); + if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLMutableArrayInsertObjectPtr)[self methodForSelector:cachedSelector]; + + cachedMethodPointer(self, cachedSelector, anObject, anIndex); +} diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Conversion.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Conversion.h new file mode 100644 index 00000000..0309ebdb --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Conversion.h @@ -0,0 +1,60 @@ +// +// $Id$ +// +// Encoding.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 22, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// More info at <http://code.google.com/p/sequel-pro/> + +// This class is private to the framework. + +@interface SPMySQLConnection (Conversion) + ++ (const char *)_cStringForString:(NSString *)aString usingEncoding:(NSStringEncoding)anEncoding returningLengthAs:(NSUInteger *)cStringLengthPointer; + +- (const char *)_cStringForString:(NSString *)aString; +- (NSString *)_stringForCString:(const char *)cString; + +@end + + +/** + * Set up a static function to allow fast calling with cached selectors + */ +static inline const char* _cStringForStringWithEncoding(NSString* aString, NSStringEncoding anEncoding, NSUInteger *cStringLengthPointer) +{ + static Class cachedClass; + static IMP cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedClass) cachedClass = [SPMySQLConnection class]; + if (!cachedSelector) cachedSelector = @selector(_cStringForString:usingEncoding:returningLengthAs:); + if (!cachedMethodPointer) cachedMethodPointer = [SPMySQLConnection methodForSelector:cachedSelector]; + + return (const char *)(*cachedMethodPointer)(cachedClass, cachedSelector, aString, anEncoding, cStringLengthPointer); +} diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Conversion.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Conversion.m new file mode 100644 index 00000000..0a3cf99b --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Conversion.m @@ -0,0 +1,97 @@ +// +// $Id$ +// +// Encoding.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 22, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +// This class is private to the framework. + +#import "Conversion.h" + +@implementation SPMySQLConnection (Conversion) + +/** + * Converts an NSString to a null-terminated C string, using the supplied encoding. + * Uses lossy conversion, so if a string cannot be entirely converted using + * the current encoding, a representation will be returned rather than null. + * The returned cString will correctly preserve any nul characters within the string, + * which prevents the use of faster functions like [NSString cStringUsingEncoding:]. + * Pass in the third parameter to receive the length of the converted string, or pass + * in NULL if you do not want this information. + */ ++ (const char *)_cStringForString:(NSString *)aString usingEncoding:(NSStringEncoding)anEncoding returningLengthAs:(NSUInteger *)cStringLengthPointer +{ + + // Don't try and convert nil strings + if (!aString) return NULL; + + // Perform a lossy conversion, using NSData to do the hard work + NSData *convertedData = [aString dataUsingEncoding:anEncoding allowLossyConversion:YES]; + NSUInteger convertedDataLength = [convertedData length]; + + // Take the converted data - not null-terminated - and copy it to a null-terminated buffer + char *cStringBytes = malloc(convertedDataLength + 1); + memcpy(cStringBytes, [convertedData bytes], convertedDataLength); + cStringBytes[convertedDataLength] = 0L; + + if (cStringLengthPointer) *cStringLengthPointer = convertedDataLength+1; + + // Ensure the memory is autoreleased when needed, and return. + [NSData dataWithBytesNoCopy:cStringBytes length:convertedDataLength+1 freeWhenDone:YES]; + return cStringBytes; +} + +/** + * Converts an NSString to a null-terminated C string, using the current + * connection encoding. + */ +- (const char *)_cStringForString:(NSString *)aString +{ + + // Use a cached reference to avoid dynamic method overhead + return _cStringForStringWithEncoding(aString, stringEncoding, NULL); +} + +/** + * Converts a C string to an NSString using the supplied encoding. + * This method *will not* correctly preserve nul characters within c strings; instead + * the first nul character within the string will be treated as the line ending. This + * is unavoidable without supplying a string length, so this method should not be widely + * used for actual data conversion. + */ +- (NSString *)_stringForCString:(const char *)cString +{ + + // Don't try and convert null strings + if (cString == NULL) return nil; + + return [NSString stringWithCString:cString encoding:stringEncoding]; +} + +@end
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Copying.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Copying.h new file mode 100644 index 00000000..83d055d5 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Copying.h @@ -0,0 +1,36 @@ +// +// $Id$ +// +// Copying.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on March 8, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLConnection (Copying) <NSCopying> + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Copying.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Copying.m new file mode 100644 index 00000000..c2df2a4b --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Copying.m @@ -0,0 +1,71 @@ +// +// $Id$ +// +// Copying.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on March 8, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "Copying.h" + +@implementation SPMySQLConnection (Copying) + +/** + * Provide a copy of the SPMySQLConnection instance. + * The copy should inherit the full setup, but will not inherit + * the connection state - it will not be connected, and any connection + * details such as the selected database/encoding will not be inherited. + * Note that any proxy will not be referenced in the new connection, and + * should also be set if desired. + */ +- (id)copyWithZone:(NSZone *)zone +{ + SPMySQLConnection *copy = [[[self class] allocWithZone:zone] init]; + + // Synthesized details + [copy setDelegate:delegate]; + [copy setHost:host]; + [copy setUsername:username]; + [copy setPassword:password]; + [copy setPort:port]; + [copy setUseSocket:useSocket]; + [copy setSocketPath:socketPath]; + [copy setUseSSL:useSSL]; + [copy setSslKeyFilePath:sslKeyFilePath]; + [copy setSslCertificatePath:sslCertificatePath]; + [copy setSslCACertificatePath:sslCACertificatePath]; + [copy setTimeout:timeout]; + [copy setUseKeepAlive:useKeepAlive]; + [copy setRetryQueriesOnConnectionFailure:retryQueriesOnConnectionFailure]; + [copy setDelegateQueryLogging:delegateQueryLogging]; + + // Active connection state details, like selected database and encoding, are *not* copied. + + return copy; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Databases & Tables.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Databases & Tables.h new file mode 100644 index 00000000..332b2680 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Databases & Tables.h @@ -0,0 +1,49 @@ +// +// $Id$ +// +// Databases & Tables.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 11, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLConnection (Databases_and_Tables) + +// Database selection +- (BOOL)selectDatabase:(NSString *)aDatabase; + +// Database lists +- (NSArray *)databases; +- (NSArray *)databasesLike:(NSString *)nameLikeString; + +// Table lists +- (NSArray *)tables; +- (NSArray *)tablesLike:(NSString *)nameLikeString; +- (NSArray *)tablesFromDatabase:(NSString *)aDatabase; +- (NSArray *)tablesLike:(NSString *)nameLikeString fromDatabase:(NSString *)aDatabase; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Databases & Tables.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Databases & Tables.m new file mode 100644 index 00000000..a95e060e --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Databases & Tables.m @@ -0,0 +1,258 @@ +// +// $Id$ +// +// Databases & Tables.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 11, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "Databases & Tables.h" +#import "SPMySQL Private APIs.h" + +@implementation SPMySQLConnection (Databases_and_Tables) + +#pragma mark - +#pragma mark Database selection + +/** + * Selects the database the connection should work with. Typically, a database should be + * set on a connection before any database-specific queries are run. + * Returns whether the database was correctly set or not. + * As MySQL does not support deselecting databases, a nil databaseName will return NO. + */ +- (BOOL)selectDatabase:(NSString *)aDatabase +{ + + // If no database was supplied, can't deselected - return NO. + if (!aDatabase) return NO; + + // Database selection should be made in UTF8 to avoid name encoding issues + BOOL encodingChangeRequired = [self _storeAndAlterEncodingToUTF8IfRequired]; + + // Attempt to select the supplied database + [self queryString:[NSString stringWithFormat:@"USE %@", [aDatabase mySQLBacktickQuotedString]]]; + + // If selecting the database failed, return failure. + if ([self queryErrored]) { + + // If the encoding needs to be restored, the error message and ID have to be stored so the + // actual error is still available to inspect on the class... + if (encodingChangeRequired) { + NSString *theErrorString = [self lastErrorMessage]; + NSUInteger theErrorID = [self lastErrorID]; + + [self restoreStoredEncoding]; + + [self _updateLastErrorMessage:theErrorString]; + [self _updateLastErrorID:theErrorID]; + } + + return NO; + } + + // Restore the connection encoding if necessary + if (encodingChangeRequired) [self restoreStoredEncoding]; + + // Store new database name and return success + if (database) [database release]; + database = [[NSString alloc] initWithString:aDatabase]; + + return YES; +} + +#pragma mark - +#pragma mark Database lists + +/** + * Retrieve an array of databases available to the current user, ordered as MySQL + * returns them. + * If an error occurred while retrieving the list of databases, nil will be returned; + * if no databases are available, an empty array will be returned. + */ +- (NSArray *)databases +{ + + // Wrap the related databasesLike: function to avoid code duplication + return [self databasesLike:nil]; +} + +/** + * Retrieve an array of databases whose names are matched against the supplied name + * using MySQL LIKE syntax (with wildcard support for % and _). If no name is supplied, + * all databases will be returned, in the order that MySQL returns them. + * If an error occurred while retrieving the list of databases, nil will be returned; + * if no matching databases are available, an empty array will be returned. + */ +- (NSArray *)databasesLike:(NSString *)nameLikeString +{ + NSMutableArray *databaseList = nil; + + // Database display should be made in UTF8 to avoid name encoding issues + BOOL encodingChangeRequired = [self _storeAndAlterEncodingToUTF8IfRequired]; + + // Build the query as appropriate + NSMutableString *databaseQuery = [NSMutableString stringWithString:@"SHOW DATABASES"]; + if ([nameLikeString length]) { + [databaseQuery appendFormat:@" LIKE %@", [nameLikeString mySQLTickQuotedString]]; + } + + // Perform the query and record state + SPMySQLResult *databaseResult = [self queryString:databaseQuery]; + [databaseResult setDefaultRowReturnType:SPMySQLResultRowAsArray]; + + // Retrieve the result into an array if the query was successful + if (![self queryErrored]) { + databaseList = [NSMutableArray arrayWithCapacity:(NSUInteger)[databaseResult numberOfRows]]; + for (NSArray *dbRow in databaseResult) { + [databaseList addObject:[dbRow objectAtIndex:0]]; + } + } + + // Restore the connection encoding if necessary + if (encodingChangeRequired) [self restoreStoredEncoding]; + + return databaseList; +} + +#pragma mark - +#pragma mark Table lists + +/** + * Retrieve an array of tables in the currently selected database, ordered as MySQL + * returns them. + * If an error occurred while retrieving the list of tables, nil will be returned; + * if no tables are present, an empty array will be returned. + */ +- (NSArray *)tables +{ + + // Wrap the related tablesLike:fromDatabase: function to avoid code duplication + return [self tablesLike:nil fromDatabase:nil]; +} + +/** + * Retrieve an array of tables in the currently selected database whose names are + * matched against the supplied name using MySQL LIKE syntax (with wildcard + * support for % and _). If no name is supplied, all tables in the selected + * database will be returned, in the order that MySQL returns them. + * If an error occurred while retrieving the list of tables, nil will be returned; + * if no matching tables are present, an empty array will be returned. + */ +- (NSArray *)tablesLike:(NSString *)nameLikeString +{ + + // Wrap the related tablesLike:fromDatabase: function to avoid code duplication + return [self tablesLike:nameLikeString fromDatabase:nil]; + +} + +/** + * Retrieve an array of tables in the specified database, ordered as MySQL returns them. + * If no database is specified, the current database will be used. + * If an error occurred while retrieving the list of tables, nil will be returned; + * if no tables are present in the specified database, an empty array will be returned. + */ +- (NSArray *)tablesFromDatabase:(NSString *)aDatabase +{ + + // Wrap the related tablesLike:fromDatabase: function to avoid code duplication + return [self tablesLike:nil fromDatabase:aDatabase]; + +} + +/** + * Retrieve an array of tables in the specified database whose names are matched + * against the supplied name using MySQL LIKE syntax (with wildcard support + * for % and _). If no name is supplied, all tables in the specified database + * will be returned, in the order that MySQL returns them. + * If no database is specified, the current database will be used. + * If an error occurred while retrieving the list of tables, nil will be returned; + * if no matching tables are present in the specified database, an empty array + * will be returned. + */ +- (NSArray *)tablesLike:(NSString *)nameLikeString fromDatabase:(NSString *)aDatabase +{ + NSMutableArray *tableList = nil; + + // Table display should be made in UTF8 to avoid name encoding issues + BOOL encodingChangeRequired = [self _storeAndAlterEncodingToUTF8IfRequired]; + + // Build up the table lookup query + NSMutableString *tableQuery = [NSMutableString stringWithString:@"SHOW TABLES"]; + if ([aDatabase length]) { + [tableQuery appendFormat:@" FROM %@", [aDatabase mySQLBacktickQuotedString]]; + } + if ([nameLikeString length]) { + [tableQuery appendFormat:@" LIKE %@", [nameLikeString mySQLTickQuotedString]]; + } + + // Perform the query and record state + SPMySQLResult *tableResult = [self queryString:tableQuery]; + [tableResult setDefaultRowReturnType:SPMySQLResultRowAsArray]; + + // Retrieve the result into an array if the query was successful + if (![self queryErrored]) { + tableList = [NSMutableArray arrayWithCapacity:(NSUInteger)[tableResult numberOfRows]]; + for (NSArray *tableRow in tableResult) { + [tableList addObject:[tableRow objectAtIndex:0]]; + } + } + + // Restore the connection encoding if necessary + if (encodingChangeRequired) [self restoreStoredEncoding]; + + return tableList; +} + +@end + +#pragma mark - +#pragma mark Private API + +@implementation SPMySQLConnection (Databases_and_Tables_Private_API) + +/** + * A number of queries regarding database or table information have to be made in UTF8, not + * in the connection encoding, so that names can be fully displayed and used even if they + * use a different encoding. This provides a convenience method to check whether a change + * is required; if so, the current encoding is stored, the encoding is changed, and YES is + * returned so the process can be reversed afterwards. + */ +- (BOOL)_storeAndAlterEncodingToUTF8IfRequired +{ + + // If the encoding is already UTF8, no change is required. + if ([encoding isEqualToString:@"utf8"] && !encodingUsesLatin1Transport) return NO; + + // Store the current encoding for restoration afterwards, and update encoding + [self storeEncodingForRestoration]; + [self setEncoding:@"utf8"]; + + return YES; +} + +@end
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.h new file mode 100644 index 00000000..cf132fcf --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.h @@ -0,0 +1,36 @@ +// +// $Id$ +// +// Delegate & Proxy.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 9, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLConnection (Delegate_and_Proxy) + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.m new file mode 100644 index 00000000..3ac013cc --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Delegate & Proxy.m @@ -0,0 +1,133 @@ +// +// $Id$ +// +// Delegate & Proxy.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 9, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "Delegate & Proxy.h" +#import "SPMySQL Private APIs.h" + +@implementation SPMySQLConnection (Delegate_and_Proxy) + +#pragma mark - +#pragma mark Connection delegate + +/** + * Override the synthesized delegate setter, to allow optimisations to oft-made + * checks by precacheing availability. + */ +- (void)setDelegate:(NSObject <SPMySQLConnectionDelegate> *)aDelegate +{ + delegate = aDelegate; + + // Cache whether the delegate implements certain delegate methods + delegateSupportsWillQueryString = [delegate respondsToSelector:@selector(willQueryString:connection:)]; + delegateSupportsConnectionLost = [delegate respondsToSelector:@selector(connectionLost:)]; +} + +#pragma mark - +#pragma mark Connection proxy + +/** + * Override the synthesized proxy setter, to record the initial state and to + * set the state change selector. + */ +- (void)setProxy:(NSObject <SPMySQLConnectionProxy> *)aProxy +{ + proxy = [aProxy retain]; + previousProxyState = [aProxy state]; + + [proxy setConnectionStateChangeSelector:@selector(_proxyStateChange:) delegate:self]; +} + +@end + +#pragma mark - + +@implementation SPMySQLConnection (Delegate_and_Proxy_Private_API) + +/** + * Handle any state changes in the associated connection proxy. + */ +- (void)_proxyStateChange:(NSObject <SPMySQLConnectionProxy> *)aProxy +{ + + // Perform no actions if this isn't the current connection proxy, or if notifications + // are currently set to be ignored + if (aProxy != proxy || proxyStateChangeNotificationsIgnored) return; + + SPMySQLConnectionProxyState newState = [aProxy state]; + + // If the connection proxy disconnects, trigger a reconnect; use a new thread to allow the + // main thread to process events as required. + if (state == SPMySQLConnected && newState == SPMySQLProxyIdle && previousProxyState == SPMySQLProxyConnected) { + + // Clear the state change selector on the proxy until a connection is re-established + proxyStateChangeNotificationsIgnored = YES; + + // Trigger a reconnect + [NSThread detachNewThreadSelector:@selector(reconnect) toTarget:self withObject:nil]; + } + + // Update the state record + previousProxyState = newState; +} + +/** + * Ask the delegate for the connection lost decision. This can be called from + * any thread, and will call itself on the main thread if necessary, updating a global + * variable which is then returned on the child thread. + */ +- (SPMySQLConnectionLostDecision)_delegateDecisionForLostConnection +{ + SPMySQLConnectionLostDecision theDecision = SPMySQLConnectionLostDisconnect; + + // If on the main thread, ask the delegate directly. + if ([NSThread isMainThread]) { + [delegateDecisionLock lock]; + lastDelegateDecisionForLostConnection = [delegate connectionLost:self]; + theDecision = lastDelegateDecisionForLostConnection; + [delegateDecisionLock unlock]; + + // Otherwise call ourself on the main thread, waiting until the reply is received. + } else { + + // First check whether the application is in a modal state; if so, wait + while ([NSApp modalWindow]) usleep(100000); + + [self performSelectorOnMainThread:@selector(_delegateDecisionForLostConnection) withObject:nil waitUntilDone:YES]; + [delegateDecisionLock lock]; + theDecision = lastDelegateDecisionForLostConnection; + [delegateDecisionLock unlock]; + } + + return theDecision; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Encoding.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Encoding.h new file mode 100644 index 00000000..bb5bf25d --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Encoding.h @@ -0,0 +1,53 @@ +// +// $Id$ +// +// Encoding.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLConnection (Encoding) + +// Current connection encoding information +- (NSString *)encoding; +- (NSStringEncoding)stringEncoding; +- (BOOL)encodingUsesLatin1Transport; + +// Setting connection encoding +- (BOOL)setEncoding:(NSString *)theEncoding; +- (BOOL)setEncodingUsesLatin1Transport:(BOOL)useLatin1; + +// Encoding storage and restoration +- (void)storeEncodingForRestoration; +- (void)restoreStoredEncoding; + +// Encoding conversion ++ (NSStringEncoding)stringEncodingForMySQLCharset:(const char *)mysqlCharset; ++ (NSString *)mySQLCharsetForStringEncoding:(NSStringEncoding)aStringEncoding; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Encoding.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Encoding.m new file mode 100644 index 00000000..8f684f29 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Encoding.m @@ -0,0 +1,414 @@ +// +// $Id$ +// +// Encoding.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +#import "Encoding.h" + +@implementation SPMySQLConnection (Encoding) + +#pragma mark - +#pragma mark Current connection encoding information + +/** + * Returns the name of the current encoding - the MySQL character set - in + * use by the connection. + */ +- (NSString *)encoding +{ + return [NSString stringWithString:encoding]; +} + +/** + * Returns the NSStringEncoding currently in use by the connection to process + * queries and results. + */ +- (NSStringEncoding)stringEncoding +{ + return stringEncoding; +} + +/** + * Returns whether the connection is set to use Latin1 transport for queries and + * results. + * Latin1 transport is a compatibility mode in place for compatibility with older + * incorrect setups, where databases and clients might both be set to use UTF8 (or + * other encodings) for storing and retrieving data, but the MySQL link was never + * set to UTF8 mode; as a result, multibyte characters where split by the connection + * into pairs of characters, resulting in malformed storage. The data works + * correctly if written and read in the same way, so this mode allows correct display + * of that data. + */ +- (BOOL)encodingUsesLatin1Transport +{ + return encodingUsesLatin1Transport; +} + +#pragma mark - +#pragma mark Setting connection encoding + +/** + * Set the name of the encoding - the MySQL character set - that the connection + * should use. If an encoding not recognised by the server is supplied, NO is + * returned. + * Calling this resets whether the connection should use Latin1 transport to NO. + */ +- (BOOL)setEncoding:(NSString *)theEncoding +{ + + // MySQL versions prior to 4.1 don't support encoding changes; return NO on those + // versions. + if (![self serverVersionIsGreaterThanOrEqualTo:4 minorVersion:1 releaseVersion:0]) { + return NO; + } + + // If the supplied encoding is already set, return success + if ([encoding isEqualToString:theEncoding] && !encodingUsesLatin1Transport) { + return YES; + } + + // Run a query to set the connection encoding + [self queryString:[NSString stringWithFormat:@"SET NAMES %@", [theEncoding mySQLTickQuotedString]]]; + + // If the query errored, no encoding change occurred - return failure. + if ([self queryErrored]) return NO; + + // Connection encoding was successfully set, update the instance settings, + // and return success. + [encoding release]; + encoding = [[NSString alloc] initWithString:theEncoding]; + stringEncoding = [SPMySQLConnection stringEncodingForMySQLCharset:[theEncoding UTF8String]]; + encodingUsesLatin1Transport = NO; + + return YES; +} + +/** + * Sets the connection to use Latin1 transport for queries and results or not. All + * encodings will default to not use Latin1 transport.. + * Latin1 transport is a compatibility mode in place for compatibility with older + * incorrect setups, where databases and clients might both be set to use UTF8 (or + * other encodings) for storing and retrieving data, but the MySQL link was never + * set to UTF8 mode; as a result, multibyte characters where split by the connection + * into pairs of characters, resulting in malformed storage. The data works + * correctly if written and read in the same way, so this mode allows correct display + * of that data. + */ +- (BOOL)setEncodingUsesLatin1Transport:(BOOL)useLatin1 +{ + + // MySQL versions prior to 4.1 don't support encoding changes; return NO on those + // versions. + if (![self serverVersionIsGreaterThanOrEqualTo:4 minorVersion:1 releaseVersion:0]) { + return NO; + } + + // If the Latin1 mode is already set, return success + if (encodingUsesLatin1Transport == useLatin1) { + return YES; + } + + // If disabling Latin1 transport, just restore the connection encoding + if (!useLatin1) { + return [self setEncoding:encoding]; + } + + // Otherwise attempt to set Latin1 transport. First, the result set encoding. + [self queryString:@"SET CHARACTER_SET_RESULTS=latin1"]; + + // If that failed, no encoding change occurred - return failure. + if ([self queryErrored]) return NO; + + // Next, change the client character set, to also amend queries sent. + [self queryString:@"SET CHARACTER_SET_CLIENT=latin1"]; + + // If that failed, encoding details are in a partial state - attempt to restore + // the original details before returning failure. + if ([self queryErrored]) { + [self setEncoding:encoding]; + return NO; + } + + // Connecting encoding transport was successfully set, update the instance settings, + // and return success. + encodingUsesLatin1Transport = YES; + return YES; +} + +#pragma mark - +#pragma mark Encoding storage and restoration + + +/** + * Store a previous encoding setting, to allow it to be easily restored + * later - used when the encoding needs to be temporarily changed. + */ +- (void)storeEncodingForRestoration +{ + if (previousEncoding) [previousEncoding release]; + previousEncoding = [[NSString alloc] initWithString:encoding]; + previousEncodingUsesLatin1Transport = encodingUsesLatin1Transport; +} + +/** + * Restore a previously stored encoding setting, if available. Used in + * conjunection with -storeEncodingForRestoration for when the encoding needs + * to be temporarily changed. + */ +- (void)restoreStoredEncoding +{ + if (!previousEncoding || state == SPMySQLDisconnected || state == SPMySQLDisconnecting) { + return; + } + + [self setEncoding:previousEncoding]; + [self setEncodingUsesLatin1Transport:previousEncodingUsesLatin1Transport]; +} + +#pragma mark - +#pragma mark Encoding conversion + +/** + * Map MySQL encodings to NSStringEncodings, using the list of encodings sourced + * from http://dev.mysql.com/doc/refman/5.6/en/charset-charsets.html and the same + * list on previous MySQL versions. Older versions also had less-standard lists, + * such as the charset options listed on + * http://dev.mysql.com/doc/refman/4.1/en/charset-map.html . + * For each, the equivalent NSStringEncoding, or conversion from CfStringEncoding, + * was found. + * If a supplied character set can not be matched, logs an error and falls back + * to UTF8 encoding. + */ ++ (NSStringEncoding)stringEncodingForMySQLCharset:(const char *)mysqlCharset +{ + + // Handle the most common cases first + if (!strcmp(mysqlCharset, "utf8")) { + return NSUTF8StringEncoding; + } else if (!strcmp(mysqlCharset, "latin1")) { + return NSISOLatin1StringEncoding; + } else if (!strcmp(mysqlCharset, "ascii")) { + return NSASCIIStringEncoding; + + // Work down the rest of the 4.1+ charsets + } else if (!strcmp(mysqlCharset, "big5")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingBig5); + } else if (!strcmp(mysqlCharset, "dec8")) { + return NSISOLatin1StringEncoding; // Not exact, but very close + } else if (!strcmp(mysqlCharset, "cp850")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingDOSLatin1); + } else if (!strcmp(mysqlCharset, "koi8r")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingKOI8_R); + } else if (!strcmp(mysqlCharset, "latin2")) { + return NSISOLatin2StringEncoding; + } else if (!strcmp(mysqlCharset, "ujis")) { + return NSJapaneseEUCStringEncoding; + } else if (!strcmp(mysqlCharset, "sjis")) { + return NSShiftJISStringEncoding; + } else if (!strcmp(mysqlCharset, "hebrew")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingISOLatinHebrew); + } else if (!strcmp(mysqlCharset, "tis620")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingISOLatinThai); + } else if (!strcmp(mysqlCharset, "euckr")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingEUC_KR); + } else if (!strcmp(mysqlCharset, "koi8u")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingKOI8_U); + } else if (!strcmp(mysqlCharset, "gb2312")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingGB_2312_80); + } else if (!strcmp(mysqlCharset, "greek")) { + return NSWindowsCP1253StringEncoding; + } else if (!strcmp(mysqlCharset, "cp1250")) { + return NSWindowsCP1250StringEncoding; + } else if (!strcmp(mysqlCharset, "gbk")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingGBK_95); + } else if (!strcmp(mysqlCharset, "latin5")) { + return NSWindowsCP1254StringEncoding; + } else if (!strcmp(mysqlCharset, "ucs2")) { + return NSUnicodeStringEncoding; + } else if (!strcmp(mysqlCharset, "cp866")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingDOSRussian); + } else if (!strcmp(mysqlCharset, "macce")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingMacCentralEurRoman); + } else if (!strcmp(mysqlCharset, "macroman")) { + return NSMacOSRomanStringEncoding; + } else if (!strcmp(mysqlCharset, "cp852")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingDOSLatin2); + } else if (!strcmp(mysqlCharset, "latin7")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingISOLatin7); + } else if (!strcmp(mysqlCharset, "utf8mb4")) { + return NSUnicodeStringEncoding; // Is this correct? + } else if (!strcmp(mysqlCharset, "cp1251")) { + return NSWindowsCP1251StringEncoding; + } else if (!strcmp(mysqlCharset, "utf16")) { + return NSUnicodeStringEncoding; + } else if (!strcmp(mysqlCharset, "utf16le")) { + return NSUTF16LittleEndianStringEncoding; + } else if (!strcmp(mysqlCharset, "cp1256")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingWindowsArabic); + } else if (!strcmp(mysqlCharset, "cp1257")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingWindowsBalticRim); + } else if (!strcmp(mysqlCharset, "utf32")) { + return NSUTF32StringEncoding; + } else if (!strcmp(mysqlCharset, "binary")) { + return NSUTF8StringEncoding; + } else if (!strcmp(mysqlCharset, "cp932")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingDOSJapanese); + } else if (!strcmp(mysqlCharset, "eucjpms")) { + return NSJapaneseEUCStringEncoding; + + // Continue with old < 4.1 mappings + } else if (!strcmp(mysqlCharset, "czech")) { + return NSISOLatin2StringEncoding; + } else if (!strcmp(mysqlCharset, "dos")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingDOSLatin1); + } else if (!strcmp(mysqlCharset, "german1")) { + return NSISOLatin1StringEncoding; + } else if (!strcmp(mysqlCharset, "usa7")) { + return NSASCIIStringEncoding; + } else if (!strcmp(mysqlCharset, "danish")) { + return NSISOLatin1StringEncoding; + } else if (!strcmp(mysqlCharset, "win1251")) { + return NSWindowsCP1251StringEncoding; + } else if (!strcmp(mysqlCharset, "euc_kr")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingEUC_KR); + } else if (!strcmp(mysqlCharset, "estonia")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingISOLatin7); + } else if (!strcmp(mysqlCharset, "hungarian")) { + return NSISOLatin2StringEncoding; + } else if (!strcmp(mysqlCharset, "koi8_ru")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingKOI8_R); + } else if (!strcmp(mysqlCharset, "koi8_ukr")) { + return CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingKOI8_U); + } else if (!strcmp(mysqlCharset, "win1251ukr")) { + return NSWindowsCP1251StringEncoding; + } else if (!strcmp(mysqlCharset, "win1250")) { + return NSWindowsCP1250StringEncoding; + } else if (!strcmp(mysqlCharset, "croat")) { + return NSISOLatin2StringEncoding; + } else if (!strcmp(mysqlCharset, "latin1_de")) { + return NSISOLatin1StringEncoding; + } + + /** + * Finally, certain other encodings, including the following: + * hp8 + * swe7 + * armscii8 + * keybcs2 + * geostd8 + * ...don't appear to have OS X equivalents; for these and unhandled, log and + * fall back to UTF8 handling. + */ + NSLog(@"SPMySQL Framework has encountered the MySQL encoding '%s' which it is unable to process correctly; falling back to UTF8 mapping.", mysqlCharset); + return NSUTF8StringEncoding; +} + +/** + * Match a supplied NSStringEncoding to a MySQL character set, returning the MySQL + * name of that character set as an NSString. + * If the supplied NSStringEncoding could not be matched, logs an error and returns nil. + */ ++ (NSString *)mySQLCharsetForStringEncoding:(NSStringEncoding)aStringEncoding +{ + + // Switch through the list of NSStringEncodings from NSString, returning the most + // appropriate encoding for each + switch (aStringEncoding) { + + case NSASCIIStringEncoding: + return @"ascii"; + + case NSJapaneseEUCStringEncoding: + return @"ujis"; + + case NSUTF8StringEncoding: + return @"utf8"; + + case NSISOLatin1StringEncoding: + return @"latin1"; + + case NSNonLossyASCIIStringEncoding: + return @"utf8"; + + case NSShiftJISStringEncoding: + return @"sjis"; + + case NSISOLatin2StringEncoding: + return @"latin2"; + + case NSUnicodeStringEncoding: + return @"ucs2"; + + case NSWindowsCP1251StringEncoding: + return @"cp1251"; + + case NSWindowsCP1252StringEncoding: + return @"latin1"; + + case NSWindowsCP1253StringEncoding: + return @"greek"; + + case NSWindowsCP1254StringEncoding: + return @"latin5"; + + case NSWindowsCP1250StringEncoding: + return @"cp1250"; + + case NSMacOSRomanStringEncoding: + return @"macroman"; + + case NSUTF16BigEndianStringEncoding: + return @"utf16"; + + case NSUTF16LittleEndianStringEncoding: + return @"utf16le"; + + case NSUTF32StringEncoding: + return @"utf32"; + + case NSUTF32BigEndianStringEncoding: + return @"utf32"; + } + + /** + * Certain string encodings, including the following: + * NSNEXTSTEPStringEncoding + * NSSymbolStringEncoding + * NSISO2022JPStringEncoding + * NSUTF32LittleEndianStringEncoding + * + * ...don't have equivalents; similarly, many CFStringEncodings aren't yet + * matched. For those, log and return nil. + */ + NSLog(@"SPMySQL Framework was asked for the MySQL charset for the string encoding '%llu', which is currently unhandled.", (unsigned long long)aStringEncoding); + return nil; +} +@end
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Locking.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Locking.h new file mode 100644 index 00000000..90e11179 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Locking.h @@ -0,0 +1,41 @@ +// +// $Id$ +// +// Locking.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 22, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +// This class is private to the framework. + +@interface SPMySQLConnection (Locking) + +- (void)_lockConnection; +- (BOOL)_tryLockConnection; +- (void)_unlockConnection; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Locking.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Locking.m new file mode 100644 index 00000000..d654066b --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Locking.m @@ -0,0 +1,104 @@ +// +// $Id$ +// +// Locking.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 22, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +// This class is private to the framework. + +#import "Locking.h" +#import "SPMySQL Private APIs.h" + +@implementation SPMySQLConnection (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 when the condition is SPMySQLConnectionIdle + [connectionLock lockWhenCondition:SPMySQLConnectionIdle]; + + // Set the condition to SPMySQLConnectionBusy + [connectionLock unlockWithCondition:SPMySQLConnectionBusy]; +} + +/** + * Attempt to lock the connection. If the connection is idle (unlocked), this method + * locks the connection and returns YES for success. The connection must afterward + * be unlocked using unlockConnection. If the connection is currently busy (locked), + * this method immediately returns NO and doesn't lock the connection. + */ +- (BOOL)_tryLockConnection +{ + + // If the connection is already is use, return failure + if (![connectionLock tryLockWhenCondition:SPMySQLConnectionIdle]) { + return NO; + } + + // We're allowed to use the connection; set it to busy, and return success + [connectionLock unlockWithCondition:SPMySQLConnectionBusy]; + return YES; +} + + +/** + * Unlock the connection. + */ +- (void)_unlockConnection +{ + + // Always lock the conditional lock before proceeding + [connectionLock lock]; + + // Check if the connection actually was busy. If it wasn't busy, + // it means the connection may have been unlocked twice. This is + // potentially dangerous, so we log this to the console + if ([connectionLock condition] != SPMySQLConnectionBusy) { + NSLog(@"SPMySQLConnection: Tried to unlock the connection, but it wasn't locked."); + } + + // Since we connected with CLIENT_MULTI_RESULT, we must make sure there are not more results! + // This is still a bit of a dirty hack + if (state == SPMySQLConnected + && mySQLConnection && mySQLConnection->net.vio && mySQLConnection->net.buff && mysql_more_results(mySQLConnection)) + { + NSLog(@"SPMySQLConnection: Discarding unretrieved results. This is currently normal when using CALL."); + [self _flushMultipleResultSets]; + } + + // Tell everyone that the connection is available again + [connectionLock unlockWithCondition:SPMySQLConnectionIdle]; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Max Packet Size.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Max Packet Size.h new file mode 100644 index 00000000..faa667d8 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Max Packet Size.h @@ -0,0 +1,40 @@ +// +// $Id$ +// +// Max Packet Size.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 9, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLConnection (Max_Packet_Size) + +- (NSUInteger)maxQuerySize; +- (BOOL)isMaxQuerySizeEditable; +- (NSUInteger)setGlobalMaxQuerySize:(NSUInteger)newMaxSize; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Max Packet Size.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Max Packet Size.m new file mode 100644 index 00000000..e0bfef52 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Max Packet Size.m @@ -0,0 +1,196 @@ +// +// $Id$ +// +// Max Packet Size.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 9, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +#import "Max Packet Size.h" +#import "SPMySQL Private APIs.h" + +@implementation SPMySQLConnection (Max_Packet_Size) + +/** + * Retrieve the current maximum query size (MySQL's max_allowed_packet), as cached + * by the class. If the connection has been unable to retrieve this value, the + * default of 1MB will be returned. + */ +- (NSUInteger)maxQuerySize +{ + return maxQuerySize; +} + +/** + * Retrieve whether the server's maximum query size (MySQL's max_allowed_packet) is + * editable by the current user. + */ +- (BOOL)isMaxQuerySizeEditable +{ + if (!maxQuerySizeEditabilityChecked) { + [self _updateMaxQuerySizeEditability]; + } + + return maxQuerySizeIsEditable; +} + +/** + * Set the servers's global maximum query size - MySQL's max_allowed_packed - to the + * supplied size. Note that this *does not* affect the current connection; a reconnection + * is required to pick up the new size setting. As a result it may be important to restore + * the connection size after use. + * Validates the supplied size (eg 1GB limit) and applies it if appropriate, returning + * the set query size or NSNotFound on error. + */ +- (NSUInteger)setGlobalMaxQuerySize:(NSUInteger)newMaxSize +{ + + // Perform basic validation. First, ensure the max query size is editable + if (![self isMaxQuerySizeEditable]) return NSNotFound; + + // Validate sizes + if (newMaxSize < 1024) return NSNotFound; + if (newMaxSize > (1024 * 1024 * 1024)) newMaxSize = 1024 * 1024 * 1024; + + // Perform a standard query to set the new size + [self queryString:[NSString stringWithFormat:@"SET GLOBAL max_allowed_packet = %lu", newMaxSize]]; + + // On failure, return NSNotFound - error state will have automatically been set + if ([self queryErrored]) return NSNotFound; + + // Otherwise, set the local instance variable and return success + maxQuerySize = newMaxSize; + return maxQuerySize; +} + +@end + +#pragma mark - + +@implementation SPMySQLConnection (Max_Packet_Size_Private_API) + +/** + * Update the max_allowed_packet size - the largest supported query size - from the server. + */ +- (void)_updateMaxQuerySize +{ + + // Determine which query to run based on server version + NSString *packetQueryString; + if ([self serverMajorVersion] == 3) { + packetQueryString = @"SHOW VARIABLES LIKE 'max_allowed_packet'"; + } else { + packetQueryString = @"SELECT @@global.max_allowed_packet"; + } + + // Make a standard query to the server to retrieve the information + SPMySQLResult *result = [self queryString:packetQueryString]; + [result setReturnDataAsStrings:YES]; + + // Get the maximum size string + NSString *maxQuerySizeString = nil; + if ([self serverMajorVersion] == 3) { + maxQuerySizeString = [[result getRowAsArray] objectAtIndex:1]; + } else { + maxQuerySizeString = [[result getRowAsArray] objectAtIndex:0]; + } + + // If a valid size was returned, update the instance variable + if (maxQuerySizeString) { + maxQuerySize = (NSUInteger)[maxQuerySizeString integerValue]; + } +} + +/** + * Perform a query to determine whether the current user has permission to edit the + * max_allowed_packet setting for their connection. + */ +- (void)_updateMaxQuerySizeEditability +{ + [self queryString:@"SET GLOBAL max_allowed_packet = @@global.max_allowed_packet"]; + maxQuerySizeIsEditable = ![self queryErrored]; + maxQuerySizeEditabilityChecked = YES; +} + +/** + * Attempts to change the maximum query size in order to allow a query to be performed. + * Returns whether the change was successfully made. + */ +- (BOOL)_attemptMaxQuerySizeIncreaseTo:(NSUInteger)targetSize +{ + + // If the query size is editable, attempt to increase the size + if ([self isMaxQuerySizeEditable]) { + NSUInteger newSize = [self setGlobalMaxQuerySize:targetSize]; + if (newSize != NSNotFound) { + + // Successfully increased the global size - reconnect to use it, and return success + [self reconnect]; + return YES; + } + } + + // Can not, or failed to, increase the max query size. Record an error message. + 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"), targetSize, maxQuerySize]; + [self _updateLastErrorMessage:errorMessage]; + + // Update delegate error if it supports the protocol + if ([delegate respondsToSelector:@selector(queryGaveError:connection:)]) { + [delegate queryGaveError:errorMessage connection:self]; + } + + // Display an alert as this is a special failure + if ([delegate respondsToSelector:@selector(showErrorWithTitle:message:)]) { + [delegate showErrorWithTitle:NSLocalizedString(@"Error", @"error") message:errorMessage]; + } else { + NSRunAlertPanel(NSLocalizedString(@"Error", @"error"), errorMessage, @"OK", nil, nil); + } + + return NO; +} + +/** + * Restore a maximum query size after temporarily increasing it for a query. This action + * may be called directly after a query, or may be before the next query if a streaming result + * had to be used. + */ +- (void)_restoreMaximumQuerySizeAfterQuery +{ + + // Return if no action needs to be performed + if (queryActionShouldRestoreMaxQuerySize == NSNotFound) return; + + // Move the target size to a local variable to prevent looping + NSUInteger targetMaxQuerySize = queryActionShouldRestoreMaxQuerySize; + queryActionShouldRestoreMaxQuerySize = NSNotFound; + + // Enact the change + [self setGlobalMaxQuerySize:targetMaxQuerySize]; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Ping & KeepAlive.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Ping & KeepAlive.h new file mode 100644 index 00000000..e84c4ca6 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Ping & KeepAlive.h @@ -0,0 +1,55 @@ +// +// $Id$ +// +// Ping & KeepAlive.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +// This class is private to the framework. + +typedef struct { + MYSQL *mySQLConnection; + BOOL *keepAlivePingActivePointer; + BOOL *keepAliveLastPingSuccessPointer; +} SPMySQLConnectionPingDetails; + +@interface SPMySQLConnection (Ping_and_KeepAlive) + +// Keepalive ping initialisation +- (void)_keepAlive; +- (void)_threadedKeepAlive; + +// Master ping method +- (BOOL)_pingConnectionUsingLoopDelay:(NSUInteger)loopDelay; + +// Ping thread internals +void _backgroundPingTask(void *ptr); +void _forceThreadExit(int signalNumber); +void _pingThreadCleanup(void *pingDetails); + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Ping & KeepAlive.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Ping & KeepAlive.m new file mode 100644 index 00000000..3ce0c0cd --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Ping & KeepAlive.m @@ -0,0 +1,214 @@ +// +// $Id$ +// +// Ping & KeepAlive.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +#import "Ping & KeepAlive.h" +#import "Locking.h" +#import <pthread.h> + +@implementation SPMySQLConnection (Ping_and_KeepAlive) + +#pragma mark - +#pragma mark Keepalive ping initialisation + +/** + * Keeps the 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 +{ + + // Do nothing if not connected or if keepalive is disabled + if (state != SPMySQLConnected || !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). + uint64_t currentTime = mach_absolute_time(); + if (_elapsedSecondsSinceAbsoluteTime(lastConnectionUsedTime) < keepAliveInterval - 1 + || _elapsedSecondsSinceAbsoluteTime(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 = currentTime; + + [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 (keepAliveLastPingBlocked || keepAlivePingFailures >= 3) { + [self reconnect]; + return; + } + + // Otherwise, perform a background ping. + BOOL pingResult = [self _pingConnectionUsingLoopDelay:10000]; + if (pingResult) { + keepAlivePingFailures = 0; + } else { + keepAlivePingFailures++; + } +} + +#pragma mark - +#pragma mark Master ping method + +/** + * 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 (state != SPMySQLConnected) return NO; + + uint64_t pingStartTime_t; + double pingElapsedTime; + BOOL threadCancelled = NO; + + // Set up a query lock + [self _lockConnection]; + + keepAliveLastPingSuccess = NO; + keepAliveLastPingBlocked = NO; + keepAlivePingThreadActive = YES; + + // Use a ping timeout defaulting to thirty seconds, but using the connection timeout if set + NSUInteger pingTimeout = 30; + if (timeout > 0) pingTimeout = timeout; + + // Set up a struct containing details the ping task will need + SPMySQLConnectionPingDetails pingDetails; + pingDetails.mySQLConnection = mySQLConnection; + pingDetails.keepAliveLastPingSuccessPointer = &keepAliveLastPingSuccess; + pingDetails.keepAlivePingActivePointer = &keepAlivePingThreadActive; + + // Create a pthread for the ping + pthread_attr_t attr; + pthread_attr_init(&attr); + pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED); + pthread_create(&keepAlivePingThread, &attr, (void *)&_backgroundPingTask, &pingDetails); + + // Record the ping start time + pingStartTime_t = mach_absolute_time(); + + // Loop until the ping completes + do { + usleep((useconds_t)loopDelay); + pingElapsedTime = _elapsedSecondsSinceAbsoluteTime(pingStartTime_t); + + // If the ping timeout has been exceeded, force a timeout; double-check that the + // thread is still active. + if (pingElapsedTime > pingTimeout && keepAlivePingThreadActive && !threadCancelled) { + pthread_cancel(keepAlivePingThread); + 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 (pingElapsedTime > (pingTimeout + 2) && keepAlivePingThreadActive) { + pthread_kill(keepAlivePingThread, SIGUSR1); + keepAlivePingThreadActive = NO; + keepAliveLastPingBlocked = YES; + } + } while (keepAlivePingThreadActive); + + // Clean up + keepAlivePingThread = NULL; + pthread_attr_destroy(&attr); + + // Unlock the connection + [self _unlockConnection]; + + return keepAliveLastPingSuccess; +} + +#pragma mark - +#pragma mark Ping thread internals + +/** + * Actually perform a keepalive ping - intended for use within a pthread. + */ +void _backgroundPingTask(void *ptr) +{ + SPMySQLConnectionPingDetails *pingDetails = (SPMySQLConnectionPingDetails *)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->keepAliveLastPingSuccessPointer) = (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) +{ + SPMySQLConnectionPingDetails *pingDetailsStruct = pingDetails; + *(pingDetailsStruct->keepAlivePingActivePointer) = NO; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Querying & Preparation.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Querying & Preparation.h new file mode 100644 index 00000000..0f086a89 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Querying & Preparation.h @@ -0,0 +1,106 @@ +// +// $Id$ +// +// Querying & Preparation.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLConnection (Querying_and_Preparation) + +// Data preparation +- (NSString *)escapeAndQuoteString:(NSString *)theString; +- (NSString *)escapeString:(NSString *)theString includingQuotes:(BOOL)includeQuotes; +- (NSString *)escapeAndQuoteData:(NSData *)theData; +- (NSString *)escapeData:(NSData *)theData includingQuotes:(BOOL)includeQuotes; + +// Queries +- (SPMySQLResult *)queryString:(NSString *)theQueryString; +- (SPMySQLFastStreamingResult *)streamingQueryString:(NSString *)theQueryString; +- (id)streamingQueryString:(NSString *)theQueryString useLowMemoryBlockingStreaming:(BOOL)fullStreaming; +- (id)queryString:(NSString *)theQueryString usingEncoding:(NSStringEncoding)theEncoding withResultType:(SPMySQLResultType)theReturnType; + +// Query convenience functions +- (NSArray *)getAllRowsFromQuery:(NSString *)theQueryString; +- (id)getFirstFieldFromQuery:(NSString *)theQueryString; + +// Query information +- (unsigned long long)rowsAffectedByLastQuery; +- (unsigned long long)lastInsertID; + +// Connection and query error state +- (BOOL)queryErrored; +- (NSString *)lastErrorMessage; +- (NSUInteger)lastErrorID; ++ (BOOL)isErrorIDConnectionError:(NSUInteger)theErrorID; + +// Query cancellation +- (void)cancelCurrentQuery; +- (BOOL)lastQueryWasCancelledUsingReconnect; + +@end + +/** + * Set up static functions to allow fast calling with cached selectors + */ + +static inline id SPMySQLConnectionEscapeString(SPMySQLConnection* self, NSString *theString, BOOL encloseInQuotes) +{ + typedef id (*SPMySQLConnectionEscapeStringMethodPtr)(SPMySQLConnection*, SEL, NSString *, BOOL); + static SPMySQLConnectionEscapeStringMethodPtr cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedSelector) cachedSelector = @selector(escapeString:includingQuotes:); + if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLConnectionEscapeStringMethodPtr)[self methodForSelector:cachedSelector]; + + return cachedMethodPointer(self, cachedSelector, theString, encloseInQuotes); +} + +static inline id SPMySQLConnectionEscapeData(SPMySQLConnection* self, NSData *theData, BOOL encloseInQuotes) +{ + typedef id (*SPMySQLConnectionEscapeDataMethodPtr)(SPMySQLConnection*, SEL, NSData *, BOOL); + static SPMySQLConnectionEscapeDataMethodPtr cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedSelector) cachedSelector = @selector(escapeData:includingQuotes:); + if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLConnectionEscapeDataMethodPtr)[self methodForSelector:cachedSelector]; + + return cachedMethodPointer(self, cachedSelector, theData, encloseInQuotes); +} + +static inline id SPMySQLConnectionQueryString(SPMySQLConnection* self, NSString *theQueryString, NSStringEncoding theEncoding, SPMySQLResultType theReturnType) +{ + typedef id (*SPMySQLConnectionQueryStringMethodPtr)(SPMySQLConnection*, SEL, NSString *, NSStringEncoding, SPMySQLResultType); + static SPMySQLConnectionQueryStringMethodPtr cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedSelector) cachedSelector = @selector(queryString:usingEncoding:withResultType:); + if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLConnectionQueryStringMethodPtr)[self methodForSelector:cachedSelector]; + + return cachedMethodPointer(self, cachedSelector, theQueryString, theEncoding, theReturnType); +} diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Querying & Preparation.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Querying & Preparation.m new file mode 100644 index 00000000..9b54029c --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Querying & Preparation.m @@ -0,0 +1,636 @@ +// +// $Id$ +// +// Querying & Preparation.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +#import "SPMySQLConnection.h" +#import "SPMySQL Private APIs.h" + +@implementation SPMySQLConnection (Querying_and_Preparation) + +#pragma mark - +#pragma mark Data preparation + +/** + * See also the NSString methods mySQLTickQuotedString and mySQLBacktickQuotedString, + * added via an NSString category; however these methods are safer and more complete + * as they use the current connection encoding to quote characters. + */ + + +/** + * Take a string, escapes any special character, and surrounds it with single quotes + * for safe use within a query; correctly escapes any characters within the string + * using the current connection encoding. + */ +- (NSString *)escapeAndQuoteString:(NSString *)theString +{ + return SPMySQLConnectionEscapeString(self, theString, YES); +} + +/** + * Take a string and escapes any special character for safe use within a query; correctly + * escapes any characters within the string using the current connection encoding. + * Allows control over whether to also wrap the string in single quotes. + */ +- (NSString *)escapeString:(NSString *)theString includingQuotes:(BOOL)includeQuotes +{ + + // Return nil strings untouched + if (!theString) return theString; + + // To correctly escape the string, an active connection is required, so verify. + if (state == SPMySQLDisconnected || state == SPMySQLConnecting) { + if ([delegate respondsToSelector:@selector(noConnectionAvailable:)]) { + [delegate noConnectionAvailable:self]; + } + return nil; + } + if (![self _checkConnectionIfNecessary]) return nil; + + // Perform a lossy conversion to bytes, using NSData to do the hard work. Preserves + // nul characters correctly. + NSData *cData = [theString dataUsingEncoding:stringEncoding allowLossyConversion:YES]; + NSUInteger cDataLength = [cData length]; + + // Create a buffer for mysql_real_escape_string to place the converted string into; + // the max length is 2*length (if every character was quoted) + 2 (quotes/terminator). + // Adding quotes in this way makes the logic below *slightly* harder to follow but + // makes the addition of the quotes almost free, which is much nicer when building + // lots of strings. + char *escBuffer = (char *)malloc((cDataLength * 2) + 2); + + // Use mysql_real_escape_string to perform the escape, starting one character in + NSUInteger escapedLength = mysql_real_escape_string(mySQLConnection, escBuffer+1, [cData bytes], cDataLength); + + // Set up an NSData object to allow conversion back to NSString while preserving + // any nul characters contained in the string. + NSData *escapedData; + if (includeQuotes) { + + // Add quotes if requested + escBuffer[0] = '\''; + escBuffer[escapedLength+1] = '\''; + + escapedData = [NSData dataWithBytesNoCopy:escBuffer length:escapedLength+2 freeWhenDone:NO]; + } else { + escapedData = [NSData dataWithBytesNoCopy:escBuffer+1 length:escapedLength freeWhenDone:NO]; + } + + // Convert to the string to return + NSString *escapedString = [[NSString alloc] initWithData:escapedData encoding:stringEncoding]; + + // Free up any memory and return + free(escBuffer); + return [escapedString autorelease]; +} + +/** + * Take NSData and hex-encodes the contents for safe transmission to a server, + * preserving all bytes whatever the encoding. Surrounds the hex-encoded resulting + * string with single quotes and precedes it with the hex-marker X for safe inclusion + * in a query. + */ +- (NSString *)escapeAndQuoteData:(NSData *)theData +{ + return SPMySQLConnectionEscapeData(self, theData, YES); +} + +/** + * Takes NSData and hex-encodes the contents for safe transmission to a server, + * preserving all bytes whatever the encoding. + * Allows control over whether to also wrap the string in single quotes and a + * preceding X (X'...') for safe use in queries. + */ +- (NSString *)escapeData:(NSData *)theData includingQuotes:(BOOL)includeQuotes +{ + + // Return nil datas as nil strings + if (!theData) return nil; + + NSUInteger dataLength = [theData length]; + + // Create a buffer for mysql_real_escape_string to place the converted string into; + // the max length is 2*length (if every character was quoted) + 3 (quotes/terminator). + // Adding quotes in this way makes the logic below *slightly* harder to follow but + // makes the addition of the quotes almost free, which is much nicer when building + // lots of strings. + char *hexBuffer = (char *)malloc((dataLength * 2) + 3); + + // Use mysql_hex_string to perform the escape, starting two characters in + NSUInteger hexLength = mysql_hex_string(hexBuffer+2, [theData bytes], dataLength); + + // Set up the return NSString + NSString *hexString; + if (includeQuotes) { + + // Add quotes if requested + hexBuffer[0] = 'X'; + hexBuffer[1] = '\''; + hexBuffer[hexLength+2] = '\''; + + hexString = [[NSString alloc] initWithBytes:hexBuffer length:hexLength+3 encoding:NSASCIIStringEncoding]; + } else { + hexString = [[NSString alloc] initWithBytes:hexBuffer+2 length:hexLength encoding:NSASCIIStringEncoding]; + } + + // Free up any memory and return + free(hexBuffer); + return [hexString autorelease]; +} + +#pragma mark - +#pragma mark Queries + +/** + * Run a query, provided as a string, on the active connection in the current connection + * encoding. Stores all the results before returning the complete result set. + */ +- (SPMySQLResult *)queryString:(NSString *)theQueryString +{ + return SPMySQLConnectionQueryString(self, theQueryString, stringEncoding, SPMySQLResultAsResult); +} + +/** + * Run a query, provided as a string, on the active connection in the current connection + * encoding. Returns the result as a fast streaming query set, where not all the results + * may be available at time of return. + */ +- (SPMySQLFastStreamingResult *)streamingQueryString:(NSString *)theQueryString +{ + return SPMySQLConnectionQueryString(self, theQueryString, stringEncoding, SPMySQLResultAsFastStreamingResult); +} + +/** + * Run a query, provided as a string, on the active connection in the current connection + * encoding. Returns the result as a streaming query set, where not all the results may + * be available at time of return. + * Supports a flag specifying whether streaming should be low-memory blocking (results are + * read from the server as the code retrives them, possibly blocking other queries on the + * server) or fast streaming (results are cached in the result object as fast as possible, + * freeing up the server even in the local rows are still being read from the result object). + * Will return a SPMySQLStreamingResult or SPMySQLFastStreamingResult as appropriate. + */ +- (id)streamingQueryString:(NSString *)theQueryString useLowMemoryBlockingStreaming:(BOOL)fullStreaming +{ + return SPMySQLConnectionQueryString(self, theQueryString, stringEncoding, fullStreaming?SPMySQLResultAsLowMemStreamingResult:SPMySQLResultAsFastStreamingResult); +} + +/** + * Run a query, provided as a string, on the active connection. The query and its result + * set are interpreted according to the supplied encoding, which should usually match + * the connection encoding. + * The result type desired can be specified, supporting either standard or streaming + * result sets. + */ +- (id)queryString:(NSString *)theQueryString usingEncoding:(NSStringEncoding)theEncoding withResultType:(SPMySQLResultType)theReturnType +{ + double queryExecutionTime; + lastQueryWasCancelled = NO; + lastQueryWasCancelledUsingReconnect = NO; + + // Check the connection state - if no connection is available, log an + // error and return. + if (state == SPMySQLDisconnected || state == SPMySQLConnecting) { + if ([delegate respondsToSelector:@selector(queryGaveError:connection:)]) { + [delegate queryGaveError:@"No connection available!" connection:self]; + } + if ([delegate respondsToSelector:@selector(noConnectionAvailable:)]) { + [delegate noConnectionAvailable:self]; + } + return nil; + } + + // Check the connection if necessary, returning nil if the query couldn't be validated + if (![self _checkConnectionIfNecessary]) return nil; + + // Determine whether a maximum query size needs to be restored from a previous query + if (queryActionShouldRestoreMaxQuerySize != NSNotFound) { + [self _restoreMaximumQuerySizeAfterQuery]; + } + + // If delegate logging is enabled, and the protocol is implemented, inform the delegate + if (delegateQueryLogging && delegateSupportsWillQueryString) { + [delegate willQueryString:theQueryString connection:self]; + } + + // Retrieve a C-style query string from the supplied NSString + NSUInteger cQueryStringLength; + const char *cQueryString = _cStringForStringWithEncoding(theQueryString, theEncoding, &cQueryStringLength); + + // Check the query length against the current maximum query length. If it is + // larger, the query would error (and probably cause a disconnect), so if + // the maximum size is editable, increase it and reconnect. + if (cQueryStringLength > maxQuerySize) { + queryActionShouldRestoreMaxQuerySize = maxQuerySize; + if (![self _attemptMaxQuerySizeIncreaseTo:(cQueryStringLength + 1024)]) { + queryActionShouldRestoreMaxQuerySize = NSNotFound; + return nil; + } + } + + // Prepare to enter a loop to run the query, allowing reattempts if appropriate + NSUInteger queryAttemptsAllowed = 1; + if (retryQueriesOnConnectionFailure) queryAttemptsAllowed++; + int queryStatus; + + // Lock the connection while it's actively in use + [self _lockConnection]; + + while (queryAttemptsAllowed > 0) { + + // While recording the overall execution time (including network lag!), run + // the raw query + uint64_t queryStartTime = mach_absolute_time(); + queryStatus = mysql_real_query(mySQLConnection, cQueryString, cQueryStringLength); + queryExecutionTime = _elapsedSecondsSinceAbsoluteTime(queryStartTime); + lastConnectionUsedTime = mach_absolute_time(); + + // If the query succeeded, no need to re-attempt. + if (!queryStatus) { + break; + + // If the query failed, determine whether to reattempt the query + } else { + + // Prevent retries if the query was cancelled or not a connection error + if (lastQueryWasCancelled || ![SPMySQLConnection isErrorIDConnectionError:mysql_errno(mySQLConnection)]) { + break; + } + } + + // Query has failed - check the connection + if (![self checkConnection]) { + [self _unlockConnection]; + return nil; + } + + queryAttemptsAllowed--; + } + + unsigned long long theAffectedRowCount = mysql_affected_rows(mySQLConnection); + id theResult = nil; + + // On success, if there is a query result, retrieve the result data type + if (!queryStatus && mysql_field_count(mySQLConnection)) { + MYSQL_RES *mysqlResult; + + switch (theReturnType) { + + // For standard result sets, retrieve all the results now, and afterwards + // update the affected row count. + case SPMySQLResultAsResult: + mysqlResult = mysql_store_result(mySQLConnection); + theResult = [[SPMySQLResult alloc] initWithMySQLResult:mysqlResult stringEncoding:theEncoding]; + theAffectedRowCount = mysql_affected_rows(mySQLConnection); + break; + + // For fast streaming and low memory streaming result sets, set up the result + case SPMySQLResultAsLowMemStreamingResult: + mysqlResult = mysql_use_result(mySQLConnection); + theResult = [[SPMySQLStreamingResult alloc] initWithMySQLResult:mysqlResult stringEncoding:theEncoding connection:self]; + break; + + case SPMySQLResultAsFastStreamingResult: + mysqlResult = mysql_use_result(mySQLConnection); + theResult = [[SPMySQLFastStreamingResult alloc] initWithMySQLResult:mysqlResult stringEncoding:theEncoding connection:self]; + break; + } + } + + // Record the error state now, as it may be affected by subsequent clean-up queries + NSString *theErrorMessage = [self _stringForCString:mysql_error(mySQLConnection)]; + NSUInteger theErrorID = mysql_errno(mySQLConnection); + + // If the query was cancelled, override the error state + if (lastQueryWasCancelled) { + theErrorMessage = NSLocalizedString(@"Query cancelled.", @"Query cancelled error"); + theErrorID = 1317; + } + + // Unlock the connection if appropriate - if not a streaming result type. + if (![theResult isKindOfClass:[SPMySQLStreamingResult class]]) { + [self _unlockConnection]; + + // Also perform restore if appropriate + if (queryActionShouldRestoreMaxQuerySize != NSNotFound) { + [self _restoreMaximumQuerySizeAfterQuery]; + } + } + + // Update error string and ID, and the rows affected + [self _updateLastErrorMessage:theErrorMessage]; + [self _updateLastErrorID:theErrorID]; + lastQueryAffectedRowCount = theAffectedRowCount; + + // Store the result time on the response object + [theResult _setQueryExecutionTime:queryExecutionTime]; + + return [theResult autorelease]; +} + +#pragma mark - +#pragma mark Query convenience functions + +/** + * Run a query and retrieve the entire result set as an array of dictionaries. + * Returns nil if there was a problem running the query or retrieving any results. + */ +- (NSArray *)getAllRowsFromQuery:(NSString *)theQueryString +{ + return [[self queryString:theQueryString] getAllRows]; +} + +/** + * Run a query and retrieve the first field of any response. Returns nil if there + * was a problem running the query or retrieving any results. + */ +- (id)getFirstFieldFromQuery:(NSString *)theQueryString +{ + return [[[self queryString:theQueryString] getRowAsArray] objectAtIndex:0]; +} + +#pragma mark - +#pragma mark Query information + +/** + * Returns the number of rows changed, deleted, inserted, or selected by + * the last query. + */ +- (unsigned long long)rowsAffectedByLastQuery +{ + return lastQueryAffectedRowCount; +} + +/** + * Returns the insert ID for the previous query which inserted a row. Note that + * this value persists through other SELECT/UPDATE etc queries. + */ +- (unsigned long long)lastInsertID +{ + return lastQueryInsertID; +} + +#pragma mark - +#pragma mark Retrieving connection and query error state + +/** + * Return whether the last query errored or not. + */ +- (BOOL)queryErrored +{ + return (queryErrorMessage)?YES:NO; +} + +/** + * If the last query (or connection) triggered an error, returns the error + * message as a string; if the last query did not error, nil is returned. + */ +- (NSString *)lastErrorMessage +{ + return queryErrorMessage; +} + +/** + * If the last query (or connection) triggered an error, returns the error + * ID; if the last query did not error, 0 is returned. + */ +- (NSUInteger)lastErrorID +{ + return queryErrorID; +} + +/** + * Determines whether a supplied error ID can be classed as a connection error. + */ ++ (BOOL)isErrorIDConnectionError:(NSUInteger)theErrorID +{ + switch (theErrorID) { + 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; +} + +#pragma mark - +#pragma mark Query cancellation + +/** + * Cancel the currently running query. This tries to kill the current query, + * and if that isn't possible - for example, on MySQL < 5 or if the current user + * does not have the relevant permissions - resets the connection. + */ +- (void)cancelCurrentQuery +{ + + // If not connected, no action is required + if (state != SPMySQLConnected && state != SPMySQLDisconnecting) return; + + // Check whether a query is actually being performed - if not, return + if ([self _tryLockConnection]) { + [self _unlockConnection]; + return; + } + + // Mark that the last query was cancelled to prevent query retries from occurring + lastQueryWasCancelled = YES; + + // The query cancellation cannot occur on the connection actively running a query + // so set up a new connection to run the KILL command. + MYSQL *killerConnection = [self _makeRawMySQLConnectionWithEncoding:@"utf8" isMasterConnection:NO]; + + + // If the new connection was successfully set up, use it to run a KILL command. + if (killerConnection) { + NSStringEncoding aStringEncoding = [SPMySQLConnection stringEncodingForMySQLCharset:mysql_character_set_name(killerConnection)]; + BOOL killQuerySupported = [self serverVersionIsGreaterThanOrEqualTo:5 minorVersion:0 releaseVersion:0]; + + // Build the kill query + NSMutableString *killQuery = [NSMutableString stringWithString:@"KILL"]; + if (killQuerySupported) [killQuery appendString:@" QUERY"]; + [killQuery appendFormat:@" %lu", mySQLConnection->thread_id]; + + // Convert to a C string + NSUInteger killQueryCStringLength; + const char *killQueryCString = [SPMySQLConnection _cStringForString:killQuery usingEncoding:aStringEncoding returningLengthAs:&killQueryCStringLength]; + + // Run the query + int killQueryStatus = mysql_real_query(killerConnection, killQueryCString, killQueryCStringLength); + + // Close the temporary connection + mysql_close(killerConnection); + + // If the kill query succeeded, the active query was cancelled. + if (killQueryStatus == 0) { + + // On MySQL < 5, the entire connection will have been reset. Ensure it's + // restored. + if (!killQuerySupported) { + [self checkConnection]; + lastQueryWasCancelledUsingReconnect = YES; + } else { + lastQueryWasCancelledUsingReconnect = NO; + } + + // Ensure the tracking bool is re-set to cover encompassed queries and return + lastQueryWasCancelled = YES; + return; + } else { + NSLog(@"SPMySQL Framework: query cancellation failed due to cancellation query error (status %d)", killQueryStatus); + } + } else { + NSLog(@"SPMySQL Framework: query cancellation failed because connection failed"); + } + + // A full reconnect is required at this point to force a cancellation. As the + // connection may have finished processing the query at this point (depending how + // long the connection attempt took), check whether we can skip the reconnect. + if ([self _tryLockConnection]) { + [self _unlockConnection]; + return; + } + + if (state == SPMySQLDisconnecting) return; + + // Reset the connection with a reconnect. Unlock the connection beforehand, + // to allow the reconnect, but lock it again afterwards to restore the expected + // state (query execution process should unlock as appropriate). + [self _unlockConnection]; + [self reconnect]; + [self _lockConnection]; + + // Reset tracking bools to cover encompassed queries + lastQueryWasCancelled = YES; + lastQueryWasCancelledUsingReconnect = YES; +} + +/** + * If the last query was cancelled, returns whether that query cancellation + * required the connection to be reset or whether the query was successfully + * cancelled leaving the connection intact. + * If the last query was not cancelled, this will return NO. + */ +- (BOOL)lastQueryWasCancelledUsingReconnect +{ + return lastQueryWasCancelledUsingReconnect; +} + +@end + +#pragma mark - +#pragma mark Private API + +@implementation SPMySQLConnection (Querying_and_Preparation_Private_API) + +/** + * Retrieves all remaining results and discards them. + * This is necessary to correctly process multiple result sets on the connection - as + * we currently don't fully support multiple result, this at least allows the connection + * to function after running statements with multiple result sets. + */ +- (void)_flushMultipleResultSets +{ + + // Repeat as long as there are results + while (!mysql_next_result(mySQLConnection)) { + MYSQL_RES *eachResult = mysql_use_result(mySQLConnection); + + // Ensure the result is really a result + if (eachResult) { + + // Retrieve and discard all rows + while (mysql_fetch_row(eachResult)); + + // Free the result set + mysql_free_result(eachResult); + } + } +} + +/** + * Update the MySQL error message for this connection. If an error is supplied + * it will be stored and returned to anything asking the instance for the last + * error; if no error is supplied, the connection will be used to derive (or clear) + * the error string. + */ +- (void)_updateLastErrorMessage:(NSString *)theErrorMessage +{ + + // If an error message wasn't supplied, select one from the connection + if (!theErrorMessage) { + theErrorMessage = [self _stringForCString:mysql_error(mySQLConnection)]; + } + + // Clear the last error message stored on the instance + if (queryErrorMessage) [queryErrorMessage release], queryErrorMessage = nil; + + // If we have an error message *with a length*, update the instance error message + if (theErrorMessage && [theErrorMessage length]) { + queryErrorMessage = [[NSString alloc] initWithString:theErrorMessage]; + } +} + +/** + * Update the MySQL error ID for this connection. If an error ID is supplied, + * it will be stored and returned to anything asking the instance for the last + * error; if an NSNotFound error ID is supplied, the connection will be used to + * set the error ID. Note that an error ID of 0 corresponds to no error. + */ +- (void)_updateLastErrorID:(NSUInteger)theErrorID +{ + + // If NSNotFound was supplied as the ID, ask the connection for the last error + if (theErrorID == NSNotFound) { + queryErrorID = mysql_errno(mySQLConnection); + + // Otherwise, update the error ID with the supplied ID + } else { + queryErrorID = theErrorID; + } +} + +@end
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Server Info.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Server Info.h new file mode 100644 index 00000000..d8f5f183 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Server Info.h @@ -0,0 +1,50 @@ +// +// $Id$ +// +// Server Info.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +@class SPMySQLResult; + +@interface SPMySQLConnection (Server_Info) + +// Server version information +- (NSString *)serverVersionString; +- (NSUInteger)serverMajorVersion; +- (NSUInteger)serverMinorVersion; +- (NSUInteger)serverReleaseVersion; + +// Server version comparisons +- (BOOL)serverVersionIsGreaterThanOrEqualTo:(NSUInteger)aMajorVersion minorVersion:(NSUInteger)aMinorVersion releaseVersion:(NSUInteger)aReleaseVersion; + +// Server tasks & processes +- (SPMySQLResult *)listProcesses; +- (BOOL)killQueryOnThreadID:(unsigned long)theThreadID; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Server Info.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Server Info.m new file mode 100644 index 00000000..f695d977 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection Categories/Server Info.m @@ -0,0 +1,175 @@ +// +// $Id$ +// +// Server Info.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +#import "Server Info.h" +#import "SPMySQL Private APIs.h" + +@implementation SPMySQLConnection (Server_Info) + +#pragma mark - +#pragma mark Server version information + +/** + * Return the server version string, or nil on failure. + */ +- (NSString *)serverVersionString +{ + if (serverVersionString) { + return [NSString stringWithString:serverVersionString]; + } + + return nil; +} + +/** + * Return the server major version or NSNotFound on failure + */ +- (NSUInteger)serverMajorVersion +{ + + if (serverVersionString != nil) { + NSString *s = [[serverVersionString componentsSeparatedByString:@"."] objectAtIndex:0]; + return (NSUInteger)[s integerValue]; + } + + return NSNotFound; +} + +/** + * Return the server minor version or NSNotFound on failure + */ +- (NSUInteger)serverMinorVersion +{ + if (serverVersionString != nil) { + NSString *s = [[serverVersionString componentsSeparatedByString:@"."] objectAtIndex:1]; + return (NSUInteger)[s integerValue]; + } + + return NSNotFound; +} + +/** + * Return the server release version or NSNotFound on failure + */ +- (NSUInteger)serverReleaseVersion +{ + if (serverVersionString != nil) { + NSString *s = [[serverVersionString componentsSeparatedByString:@"."] objectAtIndex:2]; + return (NSUInteger)[[[s componentsSeparatedByString:@"-"] objectAtIndex:0] integerValue]; + } + + return NSNotFound; +} + +#pragma mark - +#pragma mark Server version comparisons + +/** + * Returns whether the connected server version is greater than or equal to the + * supplied version number. Returns NO if no connection is active. + */ +- (BOOL)serverVersionIsGreaterThanOrEqualTo:(NSUInteger)aMajorVersion minorVersion:(NSUInteger)aMinorVersion releaseVersion:(NSUInteger)aReleaseVersion +{ + if (!serverVersionString) return NO; + + NSArray *serverVersionParts = [serverVersionString componentsSeparatedByString:@"."]; + + NSUInteger serverMajorVersion = (NSUInteger)[[serverVersionParts objectAtIndex:0] integerValue]; + if (serverMajorVersion < aMajorVersion) return NO; + if (serverMajorVersion > aMajorVersion) return YES; + + NSUInteger serverMinorVersion = (NSUInteger)[[serverVersionParts objectAtIndex:1] integerValue]; + if (serverMinorVersion < aMinorVersion) return NO; + if (serverMinorVersion > aMinorVersion) return YES; + + NSString *serverReleasePart = [serverVersionParts objectAtIndex:2]; + NSUInteger serverReleaseVersion = (NSUInteger)[[[serverReleasePart componentsSeparatedByString:@"-"] objectAtIndex:0] integerValue]; + if (serverReleaseVersion < aReleaseVersion) return NO; + return YES; +} + +#pragma mark - +#pragma mark Server tasks & processes + +/** + * Returns a result set describing the current server threads and their tasks. Note that + * the resulting process list defaults to the short form; run a manual SHOW FULL PROCESSLIST + * to retrieve tasks in non-truncated form. + * Returns nil on error. + */ +- (SPMySQLResult *)listProcesses +{ + if (state != SPMySQLConnected) return nil; + + // Check the connection if appropriate + if (![self _checkConnectionIfNecessary]) return nil; + + // Lock the connection before using it + [self _lockConnection]; + + // Get the process list + MYSQL_RES *mysqlResult = mysql_list_processes(mySQLConnection); + + // Convert to SPMySQLResult + SPMySQLResult *theResult = [[SPMySQLResult alloc] initWithMySQLResult:mysqlResult stringEncoding:stringEncoding]; + + // Unlock and return + [self _unlockConnection]; + return [theResult autorelease]; +} + +/** + * Kill the process with the supplied thread ID. On MySQL version 5 or later, this kills + * the query; on older servers this kills the entire connection. Note that the SUPER + * privilege is required to kill queries and processes not belonging to the currently + * connected user, while only PROCESS is required to see other user's processes. + * Returns a boolean indicating success or failure. + */ +- (BOOL)killQueryOnThreadID:(unsigned long)theThreadID +{ + + // Note that mysql_kill has been deprecated, so use a query to perform this task. + NSMutableString *killQuery = [NSMutableString stringWithString:@"KILL"]; + if ([self serverVersionIsGreaterThanOrEqualTo:5 minorVersion:0 releaseVersion:0]) { + [killQuery appendString:@" QUERY"]; + } + [killQuery appendFormat:@" %lu", theThreadID]; + + // Run the query + [self queryString:killQuery]; + + // Return a value based on whether the query errored or not + return ![self queryErrored]; +} + +@end
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.h new file mode 100644 index 00000000..8f3b7f9f --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.h @@ -0,0 +1,181 @@ +// +// $Id$ +// +// SPMySQLConnection.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 8, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +@class SPMySQLKeepAliveTimer; + +@interface SPMySQLConnection : NSObject { + + // Delegate + NSObject <SPMySQLConnectionDelegate> *delegate; + BOOL delegateSupportsWillQueryString; + BOOL delegateSupportsConnectionLost; + BOOL delegateQueryLogging; // Defaults to YES if protocol implemented + + // Basic connection details + NSString *host; + NSString *username; + NSString *password; + NSUInteger port; + BOOL useSocket; + NSString *socketPath; + + // SSL connection details + BOOL useSSL; + NSString *sslKeyFilePath; + NSString *sslCertificatePath; + NSString *sslCACertificatePath; + + // MySQL connection details and state + struct st_mysql *mySQLConnection; + SPMySQLConnectionState state; + BOOL connectedWithSSL; + BOOL userTriggeredDisconnect; + BOOL isReconnecting; + uint64_t initialConnectTime; + unsigned long mysqlConnectionThreadId; + + // Connection proxy + NSObject <SPMySQLConnectionProxy> *proxy; + SPMySQLConnectionProxyState previousProxyState; + BOOL proxyStateChangeNotificationsIgnored; + + // Connection lock to prevent non-thread-safe query misuse + NSConditionLock *connectionLock; + + // Currently selected database + NSString *database; + + // Delegate connection lost decisions + NSUInteger reconnectionRetryAttempts; + SPMySQLConnectionLostDecision lastDelegateDecisionForLostConnection; + NSLock *delegateDecisionLock; + + // Timeout and keep-alive + NSUInteger timeout; + BOOL useKeepAlive; + SPMySQLKeepAliveTimer *keepAliveTimer; + CGFloat keepAliveInterval; + uint64_t lastKeepAliveTime; + NSUInteger keepAlivePingFailures; + pthread_t keepAlivePingThread; + BOOL keepAlivePingThreadActive; + BOOL keepAliveLastPingSuccess; + BOOL keepAliveLastPingBlocked; + + // Encoding details - and also a record of any previous encoding to allow + // switching back and forth + NSString *encoding; + NSStringEncoding stringEncoding; + BOOL encodingUsesLatin1Transport; + NSString *previousEncoding; + BOOL previousEncodingUsesLatin1Transport; + + // Server details + NSString *serverVersionString; + + // Error state for the last query or connection state + NSUInteger queryErrorID; + NSString *queryErrorMessage; + + // Query details + unsigned long long lastQueryAffectedRowCount; + unsigned long long lastQueryInsertID; + + // Query cancellation details + BOOL lastQueryWasCancelled; + BOOL lastQueryWasCancelledUsingReconnect; + + // Timing details + uint64_t lastConnectionUsedTime; + double lastQueryExecutionTime; + + // Maximum query size + NSUInteger maxQuerySize; + BOOL maxQuerySizeIsEditable; + BOOL maxQuerySizeEditabilityChecked; + NSUInteger queryActionShouldRestoreMaxQuerySize; + + // Queries + BOOL retryQueriesOnConnectionFailure; +} + +#pragma mark - +#pragma mark Synthesized properties + +@property (readwrite, assign, nonatomic) NSObject <SPMySQLConnectionDelegate> *delegate; +@property (readwrite, assign, nonatomic) NSObject <SPMySQLConnectionProxy> *proxy; + +@property (readwrite, retain) NSString *host; +@property (readwrite, retain) NSString *username; +@property (readwrite, retain) NSString *password; +@property (readwrite, assign) NSUInteger port; +@property (readwrite, assign) BOOL useSocket; +@property (readwrite, retain) NSString *socketPath; + +@property (readwrite, assign) BOOL useSSL; +@property (readwrite, retain) NSString *sslKeyFilePath; +@property (readwrite, retain) NSString *sslCertificatePath; +@property (readwrite, retain) NSString *sslCACertificatePath; + +@property (readwrite, assign) NSUInteger timeout; +@property (readwrite, assign) BOOL useKeepAlive; +@property (readwrite, assign) CGFloat keepAliveInterval; + +@property (readonly) unsigned long mysqlConnectionThreadId; +@property (readwrite, assign) BOOL retryQueriesOnConnectionFailure; + +@property (readwrite, assign) BOOL delegateQueryLogging; + +@property (readwrite, assign) BOOL lastQueryWasCancelled; + +#pragma mark - +#pragma mark Connection and disconnection + +- (BOOL)connect; +- (BOOL)reconnect; +- (void)disconnect; + +#pragma mark - +#pragma mark Connection state + +- (BOOL)isConnected; +- (BOOL)isConnectedViaSSL; +- (BOOL)checkConnection; +- (double)timeConnected; +- (BOOL)userTriggeredDisconnect; + +#pragma mark - +#pragma mark Connection utility + ++ (NSString *)findSocketPath; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.m b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.m new file mode 100644 index 00000000..6308a3f5 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnection.m @@ -0,0 +1,834 @@ +// +// $Id$ +// +// SPMySQLConnection.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 8, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQL Private APIs.h" +#import "SPMySQLKeepAliveTimer.h" +#include <mach/mach_time.h> +#include <pthread.h> +#include <SystemConfiguration/SCNetworkReachability.h> + + +#pragma mark Class constants + +// The default connection options for MySQL connections +const NSUInteger SPMySQLConnectionOptions = + CLIENT_COMPRESS | // Enable protocol compression - almost always a win + CLIENT_INTERACTIVE | // Mark ourselves as an interactive client + CLIENT_MULTI_RESULTS; // Multiple result support (very basic, but present) + +// List of permissible ciphers to use for SSL connections +const char *SPMySQLSSLPermissibleCiphers = "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"; + + +@implementation SPMySQLConnection + +#pragma mark - +#pragma mark Synthesized properties + +@synthesize delegate; +@synthesize proxy; +@synthesize host; +@synthesize username; +@synthesize password; +@synthesize port; +@synthesize useSocket; +@synthesize socketPath; +@synthesize useSSL; +@synthesize sslKeyFilePath; +@synthesize sslCertificatePath; +@synthesize sslCACertificatePath; +@synthesize timeout; +@synthesize useKeepAlive; +@synthesize keepAliveInterval; +@synthesize mysqlConnectionThreadId; +@synthesize retryQueriesOnConnectionFailure; +@synthesize delegateQueryLogging; +@synthesize lastQueryWasCancelled; + +#pragma mark - +#pragma mark Initialisation and teardown + +/** + * Initialise the SPMySQLConnection object, setting up class defaults. + * + * Typically initialisation would be followed by setting the connection details + * and then calling -connect. + */ +- (id)init +{ + if ((self = [super init])) { + mySQLConnection = NULL; + state = SPMySQLDisconnected; + userTriggeredDisconnect = NO; + isReconnecting = NO; + mysqlConnectionThreadId = 0; + initialConnectTime = 0; + + port = 3306; + + // Default to socket connections if no other details have been provided + useSocket = YES; + + // Start with no proxy + proxy = nil; + proxyStateChangeNotificationsIgnored = NO; + + // Start with no selected database + database = nil; + + // Set a timeout of 30 seconds, with keepalive on and acting every sixty seconds + timeout = 30; + useKeepAlive = YES; + keepAliveInterval = 60; + keepAlivePingFailures = 0; + lastKeepAliveTime = 0; + keepAlivePingThread = NULL; + keepAlivePingThreadActive = NO; + keepAliveLastPingSuccess = NO; + keepAliveLastPingBlocked = NO; + + // Set up default encoding variables + encoding = [[NSString alloc] initWithString:@"utf8"]; + stringEncoding = NSUTF8StringEncoding; + encodingUsesLatin1Transport = NO; + previousEncoding = nil; + previousEncodingUsesLatin1Transport = NO; + + // Initialise default delegate settings + delegateSupportsWillQueryString = NO; + delegateSupportsConnectionLost = NO; + delegateQueryLogging = YES; + + // Delegate disconnection decisions + reconnectionRetryAttempts = 0; + lastDelegateDecisionForLostConnection = SPMySQLConnectionLostDisconnect; + delegateDecisionLock = [[NSLock alloc] init]; + + // Set up the connection lock + connectionLock = [[NSConditionLock alloc] initWithCondition:SPMySQLConnectionIdle]; + [connectionLock setName:@"SPMySQLConnection query lock"]; + + // Ensure the server detail records are initialised + serverVersionString = nil; + + // Start with a blank error state + queryErrorID = 0; + queryErrorMessage = nil; + + // Start with empty cancellation details + lastQueryWasCancelled = NO; + lastQueryWasCancelledUsingReconnect = NO; + + // Empty or reset the timing variables + lastConnectionUsedTime = 0; + lastQueryExecutionTime = 0; + + // Default to editable query size of 1MB + maxQuerySize = 1048576; + maxQuerySizeIsEditable = YES; + maxQuerySizeEditabilityChecked = NO; + queryActionShouldRestoreMaxQuerySize = NSNotFound; + + // Default to allowing queries to be automatically retried if the connection drops + // while running them + retryQueriesOnConnectionFailure = YES; + + // Start the ping keepalive timer + keepAliveTimer = [[SPMySQLKeepAliveTimer alloc] initWithInterval:10 target:self selector:@selector(_keepAlive)]; + } + + return self; +} + +/** + * Object deallocation. + */ +- (void) dealloc +{ + userTriggeredDisconnect = YES; + + // Unset the delegate + [self setDelegate:nil]; + + // Clear the keepalive timer + [keepAliveTimer invalidate]; + [keepAliveTimer release]; + + // Disconnect if appropriate (which should also disconnect any proxy) + [self disconnect]; + + // Clean up the connection proxy, if any + if (proxy) { + [proxy setConnectionStateChangeSelector:NULL delegate:nil]; + [proxy release]; + } + + // Ensure the query lock is unlocked, thereafter setting to nil in case of pending calls + if ([connectionLock condition] != SPMySQLConnectionIdle) { + [self _unlockConnection]; + } + [connectionLock release], connectionLock = nil; + + [encoding release]; + if (previousEncoding) [previousEncoding release], previousEncoding = nil; + + if (database) [database release], database = nil; + if (serverVersionString) [serverVersionString release], serverVersionString = nil; + if (queryErrorMessage) [queryErrorMessage release], queryErrorMessage = nil; + [delegateDecisionLock release]; + + [NSObject cancelPreviousPerformRequestsWithTarget:self]; + + [super dealloc]; +} + +#pragma mark - +#pragma mark Connection and disconnection + +/** + * Trigger a connection to the specified host, if any, using any connection details + * that have been set. + * Returns whether the connection was successful. + */ +- (BOOL)connect +{ + + // If a connection is already active in some form, throw an exception + if (state != SPMySQLDisconnected) { + [NSException raise:NSInternalInconsistencyException format:@"Attempted to connect a connection that is not disconnected."]; + return NO; + } + state = SPMySQLConnecting; + + // Lock the connection for safety + [self _lockConnection]; + + // Attempt the connection + mySQLConnection = [self _makeRawMySQLConnectionWithEncoding:encoding isMasterConnection:YES]; + + // If the connection failed, reset state and return + if (!mySQLConnection) { + [self _unlockConnection]; + state = SPMySQLDisconnected; + return NO; + } + + // Successfully connected - record connected state and reset tracking variables + state = SPMySQLConnected; + userTriggeredDisconnect = NO; + reconnectionRetryAttempts = 0; + initialConnectTime = mach_absolute_time(); + mysqlConnectionThreadId = mySQLConnection->thread_id; + lastConnectionUsedTime = 0; + + // Update SSL state + connectedWithSSL = NO; + if (useSSL) connectedWithSSL = (mysql_get_ssl_cipher(mySQLConnection))?YES:NO; + if (useSSL && !connectedWithSSL) { + if ([delegate respondsToSelector:@selector(connectionFellBackToNonSSL:)]) { + [delegate connectionFellBackToNonSSL:self]; + } + } + + // Reset keepalive variables + lastKeepAliveTime = 0; + keepAlivePingFailures = 0; + + // Clear the connection error record + [self _updateLastErrorID:NSNotFound]; + [self _updateLastErrorMessage:nil]; + + // Unlock the connection + [self _unlockConnection]; + + // Update connection variables to be in sync with the server state. As this performs + // a query, ensure the connection is still up afterwards (!) + [self _updateConnectionVariables]; + if (state != SPMySQLConnected) return NO; + + // Update the maximum query size + [self _updateMaxQuerySize]; + + return YES; +} + +/** + * 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 +{ + if (userTriggeredDisconnect) return NO; + + NSAutoreleasePool *reconnectionPool = [[NSAutoreleasePool alloc] init]; + + // Check whether a reconnection attempt is already being made - if so, wait + // and return the status of that reconnection attempt. This improves threaded + // use of the connection by preventing reconnect races. + if (isReconnecting) { + + // Loop in a panel runloop mode until the reconnection has processed; if an iteration + // takes less than the requested 0.1s, sleep instead. + while (isReconnecting) { + uint64_t loopIterationStart_t = mach_absolute_time(); + + [[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.1]]; + if (_elapsedSecondsSinceAbsoluteTime(loopIterationStart_t) < 0.1) { + usleep(100000 - (useconds_t)(1000000 * _elapsedSecondsSinceAbsoluteTime(loopIterationStart_t))); + } + } + + [reconnectionPool drain]; + return (state == SPMySQLConnected); + } + + isReconnecting = YES; + + // Store certain details about the connection, so that if the reconnection is successful + // they can be restored. This has to be treated separately from _restoreConnectionDetails + // as a full connection reinitialises certain values from the server. + NSString *preReconnectEncoding = [NSString stringWithString:encoding]; + BOOL preReconnectEncodingUsesLatin1 = encodingUsesLatin1Transport; + NSString *preReconnectDatabase = nil; + if (database) preReconnectDatabase = [NSString stringWithString:database]; + + // If there is a connection proxy, temporarily disassociate the state change action + if (proxy) proxyStateChangeNotificationsIgnored = YES; + + // Close the connection if it's active + [self disconnect]; + + // Lock the connection while waiting for network and proxy + [self _lockConnection]; + + // If no network is present, wait for a short time for one to become available + [self _waitForNetworkConnectionWithTimeout:10]; + + // If there is a proxy, attempt to reconnect it in blocking fashion + if (proxy) { + uint64_t loopIterationStart_t, proxyWaitStart_t; + + // If the proxy is not yet idle after requesting a disconnect, wait for a short time + // to allow it to disconnect. + if ([proxy state] != SPMySQLProxyIdle) { + + proxyWaitStart_t = mach_absolute_time(); + while ([proxy state] != SPMySQLProxyIdle) { + loopIterationStart_t = mach_absolute_time(); + + // If the connection timeout has passed, break out of the loop + if (_elapsedSecondsSinceAbsoluteTime(proxyWaitStart_t) > timeout) break; + + // Allow events to process for 0.25s, sleeping to completion on early return + [[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.25]]; + if (_elapsedSecondsSinceAbsoluteTime(loopIterationStart_t) < 0.25) { + usleep(250000 - (useconds_t)(1000000 * _elapsedSecondsSinceAbsoluteTime(loopIterationStart_t))); + } + } + } + + // Request that the proxy re-establishes its connection + [proxy connect]; + + // Wait while the proxy connects + proxyWaitStart_t = mach_absolute_time(); + while (1) { + loopIterationStart_t = mach_absolute_time(); + + // If the proxy has connected, record the new local port and break out of the loop + if ([proxy state] == SPMySQLProxyConnected) { + port = [proxy localPort]; + break; + } + + // If the proxy connection attempt time has exceeded the timeout, break of of the loop. + if (_elapsedSecondsSinceAbsoluteTime(proxyWaitStart_t) > (timeout + 1)) { + [proxy 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. + [[NSRunLoop mainRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.25]]; + if (_elapsedSecondsSinceAbsoluteTime(loopIterationStart_t) < 0.25) { + usleep((useconds_t)(250000 - (1000000 * _elapsedSecondsSinceAbsoluteTime(loopIterationStart_t)))); + } + + // Extend the connection timeout by any interface time + if ([proxy state] == SPMySQLProxyWaitingForAuth) { + proxyWaitStart_t += mach_absolute_time() - loopIterationStart_t; + } + } + + // Having in theory performed the proxy connect, update state + previousProxyState = [proxy state]; + proxyStateChangeNotificationsIgnored = NO; + } + + // Unlock the connection + [self _unlockConnection]; + + // If not using a proxy, or if the proxy successfully connected, trigger a connection + if (!proxy || [proxy state] == SPMySQLProxyConnected) { + [self connect]; + } + + // If the connection failed, retry the reconnection or cancel as appropriate. + if (state != SPMySQLConnected) { + + // Default to attempting another reconnect + SPMySQLConnectionLostDecision connectionLostDecision = SPMySQLConnectionLostReconnect; + + // If the delegate supports the decision process, ask it how to proceed + if (delegateSupportsConnectionLost) { + connectionLostDecision = [self _delegateDecisionForLostConnection]; + + // Otherwise default to reconnect, but only a set number of times to prevent a runaway loop + } else { + if (reconnectionRetryAttempts < 5) { + connectionLostDecision = SPMySQLConnectionLostReconnect; + } else { + connectionLostDecision = SPMySQLConnectionLostDisconnect; + } + reconnectionRetryAttempts++; + } + + switch (connectionLostDecision) { + case SPMySQLConnectionLostDisconnect: + [self _updateLastErrorMessage:NSLocalizedString(@"User triggered disconnection", @"User triggered disconnection")]; + userTriggeredDisconnect = YES; + isReconnecting = NO; + [reconnectionPool release]; + return NO; + default: + isReconnecting = NO; + [reconnectionPool release]; + return [self reconnect]; + } + } + + // If the connection was successfully established, restore the connection + // state if appropriate. + if (preReconnectDatabase) { + [self selectDatabase:preReconnectDatabase]; + } + [self setEncoding:preReconnectEncoding]; + [self setEncodingUsesLatin1Transport:preReconnectEncodingUsesLatin1]; + + isReconnecting = NO; + [reconnectionPool release]; + return YES; +} + +/** + * Trigger a disconnection if the connection is currently active. + */ +- (void)disconnect +{ + + // Only continue if a connection is active + if (state != SPMySQLConnected && state != SPMySQLConnecting) return; + state = SPMySQLDisconnecting; + + // If a query is active, cancel it + [self cancelCurrentQuery]; + + // Allow any pings or cancelled queries to complete, inside a time limit of ten seconds + uint64_t disconnectStartTime_t = mach_absolute_time(); + do { + usleep(100000); + if (_elapsedSecondsSinceAbsoluteTime(disconnectStartTime_t) > 10) break; + } while (![self _tryLockConnection]); + [self _unlockConnection]; + if (keepAlivePingThread != NULL) pthread_cancel(keepAlivePingThread), keepAlivePingThread = NULL; + + // Close the underlying MySQL connection if it still appears to be active, and not reading + // or writing. While this may result in a leak of the MySQL object, it prevents crashes + // due to attempts to close a blocked/stuck connection. + if (!mySQLConnection->net.reading_or_writing && mySQLConnection->net.vio && mySQLConnection->net.buff) { + mysql_close(mySQLConnection); + } + mySQLConnection = NULL; + + // If using a connection proxy, disconnect that too + if (proxy) { + [proxy performSelectorOnMainThread:@selector(disconnect) withObject:nil waitUntilDone:YES]; + } + + // Clear host-specific information + if (serverVersionString) [serverVersionString release], serverVersionString = nil; + if (database) [database release], database = nil; + + state = SPMySQLDisconnected; +} + +#pragma mark - +#pragma mark Connection state + +/** + * Retrieve whether the connection instance is connected to the remote host. + * Returns NO if the connection is still in process, YES if a disconnection is + * being actively performed. + */ +- (BOOL)isConnected +{ + return (state == SPMySQLConnected || state == SPMySQLDisconnecting); +} + +/** + * Returns YES if the MCPConnection is connected to a server via SSL, NO otherwise. + */ +- (BOOL)isConnectedViaSSL +{ + if (![self isConnected]) return NO; + return connectedWithSSL; +} + +/** + * Checks whether the connection to the server is still active. This verifies + * the connection using a ping, and if the connection is found to be down attempts + * to quickly restore it, including the previous state. + */ +- (BOOL)checkConnection +{ + + // If the connection is not seen as active, don't proceed + if (state != SPMySQLConnected) return NO; + + // Similarly, if the connection is currently locked, that indicates it's in use. This + // could be because queries are actively being run, or that a ping is running. + if ([connectionLock condition] == SPMySQLConnectionBusy) { + + // If a ping thread is not active queries are being performed - return success. + if (!keepAlivePingThreadActive) return YES; + + // If a ping thread is active, wait for it to complete before checking the connection + while (keepAlivePingThreadActive) { + usleep(10000); + } + } + + // Confirm whether the connection is still responding by using a ping + BOOL connectionVerified = [self _pingConnectionUsingLoopDelay:400]; + + // If the connection didn't respond, trigger a reconnect. This will automatically + // attempt to reconnect once, and if that fails will ask the user how to proceed - whether + // to keep reconnecting, or whether to disconnect. + if (!connectionVerified) { + connectionVerified = [self reconnect]; + } + + return connectionVerified; +} + +/** + * 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. + * If no connection is currently active, returns -1. + */ +- (double)timeConnected +{ + if (initialConnectTime == 0) return -1; + + return _elapsedSecondsSinceAbsoluteTime(initialConnectTime); +} + +/** + * Returns YES if the user chose to disconnect at the last "connection failure" + * prompt, NO otherwise. This can be used to alter behaviour in response to state + * changes. + */ +- (BOOL)userTriggeredDisconnect +{ + return userTriggeredDisconnect; +} + +#pragma mark - +#pragma mark General connection utilities + ++ (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; +} + +@end + +#pragma mark - +#pragma mark Private API + +@implementation SPMySQLConnection (PrivateAPI) + +/** + * Make a connection using the class connection settings, returning a MySQL + * connection object on success. + */ +- (MYSQL *)_makeRawMySQLConnectionWithEncoding:(NSString *)encodingName isMasterConnection:(BOOL)isMaster +{ + + // Set up the MySQL connection object + MYSQL *theConnection = mysql_init(NULL); + if (!theConnection) return NULL; + + // Disable automatic reconnection, as it's handled in-framework to preserve + // options, encodings and connection state. + my_bool falseMyBool = FALSE; + mysql_options(theConnection, MYSQL_OPT_RECONNECT, &falseMyBool); + + // Set the connection timeout + mysql_options(theConnection, MYSQL_OPT_CONNECT_TIMEOUT, (const void *)&timeout); + + // Set the connection encoding + mysql_options(theConnection, MYSQL_SET_CHARSET_NAME, [encodingName UTF8String]); + + // Set up the connection variables in the format MySQL needs, from the class-wide variables + const char *theHost = NULL; + const char *theUsername = ""; + const char *thePassword = NULL; + const char *theSocket = NULL; + + if (host) theHost = [self _cStringForString:host]; + if (username) theUsername = [self _cStringForString:username]; + + // If a password was supplied, use it; otherwise ask the delegate if appropriate + if (password) { + thePassword = [self _cStringForString:password]; + } else if ([delegate respondsToSelector:@selector(keychainPasswordForConnection:)]) { + thePassword = [self _cStringForString:[delegate keychainPasswordForConnection:self]]; + } + + // If set to use a socket and a socket was supplied, use it; otherwise, search for a socket to use + if (useSocket) { + if ([socketPath length]) { + theSocket = [self _cStringForString:socketPath]; + } else { + theSocket = [self _cStringForString:[SPMySQLConnection findSocketPath]]; + } + } + + // Apply SSL if appropriate + if (useSSL) { + const char *theSSLKeyFilePath = NULL; + const char *theSSLCertificatePath = NULL; + const char *theCACertificatePath = NULL; + + if (sslKeyFilePath) { + theSSLKeyFilePath = [[sslKeyFilePath stringByExpandingTildeInPath] UTF8String]; + } + if (sslCertificatePath) { + theSSLCertificatePath = [[sslCertificatePath stringByExpandingTildeInPath] UTF8String]; + } + if (sslCACertificatePath) { + theCACertificatePath = [[sslCACertificatePath stringByExpandingTildeInPath] UTF8String]; + } + + mysql_ssl_set(theConnection, theSSLKeyFilePath, theSSLCertificatePath, theCACertificatePath, NULL, SPMySQLSSLPermissibleCiphers); + } + + MYSQL *connectionStatus = mysql_real_connect(theConnection, theHost, theUsername, thePassword, NULL, (unsigned int)port, theSocket, SPMySQLConnectionOptions); + + // If the connection failed, return NULL + if (theConnection != connectionStatus) { + + // If the connection is the master connection, record the error state + if (isMaster) { + [self _updateLastErrorMessage:[self _stringForCString:mysql_error(theConnection)]]; + [self _updateLastErrorID:mysql_errno(theConnection)]; + } + + return NULL; + } + + // Ensure automatic reconnection is disabled for older versions + theConnection->reconnect = 0; + + // Successful connection - return the handle + return theConnection; +} + +/** + * Loop while a connection isn't available; allows blocking while the network is disconnected + * or still connecting (eg Airport still coming up after sleep). + */ +- (BOOL)_waitForNetworkConnectionWithTimeout:(double)timeoutSeconds +{ + BOOL hostReachable; + Boolean flagsValid; + SCNetworkReachabilityRef reachabilityTarget; + SCNetworkConnectionFlags reachabilityStatus; + + // Set up the reachability target - the host is not important, and is not connected to. + reachabilityTarget = SCNetworkReachabilityCreateWithName(NULL, "dev.mysql.com"); + + // In a loop until success or the timeout, test reachability + uint64_t loopStart_t = mach_absolute_time(); + while (1) { + + // Check reachability + flagsValid = SCNetworkReachabilityGetFlags(reachabilityTarget, &reachabilityStatus); + + hostReachable = flagsValid ? YES : NO; + + // Ensure that the network is reachable + if (hostReachable && !(reachabilityStatus & kSCNetworkFlagsReachable)) hostReachable = NO; + + // Ensure that Airport is up/connected if present + if (hostReachable && (reachabilityStatus & kSCNetworkFlagsConnectionRequired)) hostReachable = NO; + + // If the host *is* reachable, return success + if (hostReachable) return YES; + + // If the timeout has been exceeded, break out of the loop + if (_elapsedSecondsSinceAbsoluteTime(loopStart_t) >= timeoutSeconds) break; + + // Sleep before the next loop iteration + usleep(250000); + } + + // All checks failed - return failure + return NO; +} + +/** + * Update connection variables from the server, collecting state and ensuring + * settings like encoding are in sync. + */ +- (void)_updateConnectionVariables +{ + if (state != SPMySQLConnected && state != SPMySQLConnecting) return; + + // Retrieve all variables from the server in a single query + SPMySQLResult *theResult = [self queryString:@"SHOW VARIABLES"]; + if (![theResult numberOfRows]) return; + + // SHOW VARIABLES can return binary results on certain MySQL 4 versions; ensure string output + [theResult setReturnDataAsStrings:YES]; + + // Convert the result set into a variables dictionary + [theResult setDefaultRowReturnType:SPMySQLResultRowAsArray]; + NSMutableDictionary *variables = [NSMutableDictionary new]; + for (NSArray *variableRow in theResult) { + [variables setObject:[variableRow objectAtIndex:1] forKey:[variableRow objectAtIndex:0]]; + } + + // Copy the server version string to the instance variable + if (serverVersionString) [serverVersionString release], serverVersionString = nil; + serverVersionString = [[variables objectForKey:@"version"] retain]; + + // Get the connection encoding. Although a specific encoding may have been requested on + // connection, it may be overridden by init_connect commands or connection state changes. + // Default to latin1 for older server versions. + NSString *retrievedEncoding = @"latin1"; + if ([variables objectForKey:@"character_set_results"]) { + retrievedEncoding = [variables objectForKey:@"character_set_results"]; + } else if ([variables objectForKey:@"character_set"]) { + retrievedEncoding = [variables objectForKey:@"character_set"]; + } + + // Update instance variables + if (encoding) [encoding release]; + encoding = [[NSString alloc] initWithString:retrievedEncoding]; + stringEncoding = [SPMySQLConnection stringEncodingForMySQLCharset:[self _cStringForString: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]; +} + +/** + * Restore the connection encoding details as necessary based on previously set + * details. + */ +- (void)_restoreConnectionVariables +{ + mysqlConnectionThreadId = mySQLConnection->thread_id; + initialConnectTime = mach_absolute_time(); + + [self selectDatabase:database]; + + [self setEncoding:encoding]; + [self setEncodingUsesLatin1Transport:encodingUsesLatin1Transport]; +} + +/** + * If thirty seconds have passed since the last time the connection was + * used, check the connection. + * This minimises the impact of continuous additional connection checks - + * each of which requires a round trip to the server - but handles most + * network issues. + * Returns whether the connection is considered still valid. + */ +- (BOOL)_checkConnectionIfNecessary +{ + + // If the connection was recently used, return success + if (_elapsedSecondsSinceAbsoluteTime(lastConnectionUsedTime) < 30) return YES; + + // Otherwise check the connection + return [self checkConnection]; +} +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnectionDelegate.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnectionDelegate.h new file mode 100644 index 00000000..97e94170 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnectionDelegate.h @@ -0,0 +1,108 @@ +// +// $Id$ +// +// SPMySQLConnectionDelegate.h +// SPMySQLFramework +// +// Created by Stuart Connolly (stuconnolly.com) on October 20, 2010. +// Copyright (c) 2010 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQLConstants.h" + +@protocol SPMySQLConnectionDelegate <NSObject> +@optional + +/** + * Notifies the delegate that a query will be performed. + * + * @param query The query string that will be sent to the MySQL server + * @param connection The connection instance performing the query + */ +- (void)willQueryString:(NSString *)query connection:(id)connection; + +/** + * Notifies the delegate that a query that was just performed gave + * an error. + * + * @param error The query error, as a string + * @param connection The connection instance which received the error + */ +- (void)queryGaveError:(NSString *)error connection:(id)connection; + +/** + * Notifies the delegate that it should display the supplied error. + * The connection may sometimes want to notify the user directly + * about certain issues, and will use this method to allow the + * delegate to do so. + * + * @param title The title of the message to display to the user + * @param message The main text of the message to display to the user + */ +- (void)showErrorWithTitle:(NSString *)title message:(NSString *)message; + +/** + * Requests the keychain password for the connection. + * When a connection is being made to a server, it is best not to + * set the password on the class; instead, it should be kept within + * the secure store, and the other connection details (user, host) + * can be used to look it up and supplied on demand. + * + * @param connection The connection instance to supply the password for + */ +- (NSString *)keychainPasswordForConnection:(id)connection; + +/** + * Notifies the delegate that no underlying connection is available, + * typically when the connection has been asked to perform a query + * or some other action for which a connection must be present. + * Those actions will still return false or error states as appropriate, + * but the delegate may wish to perform actions as a result of a total + * loss of connection. + * + * @param connection The connection instance which has lost the connection to the host + */ +- (void)noConnectionAvailable:(id)connection; + +/** + * Notifies the delegate that although a SSL connection was requested, + * MySQL made the connection without using SSL. This can happen because + * the server connected to doesn't support SSL or had it disabled, or + * that insufficient details were provided to make the connection over + * SSL. + */ +- (void)connectionFellBackToNonSSL:(id)connection; + +/** + * Notifies the delegate that the connection has been temporarily lost, + * and asks the delegate for guidance on how to proceed. If the delegate + * does not implement this method, reconnections will automatically be + * attempted - up to a small limit of attempts. + * + * @param connection The connection instance that requires a decision on how to proceed + */ +- (SPMySQLConnectionLostDecision)connectionLost:(id)connection; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLConnectionProxy.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConnectionProxy.h new file mode 100644 index 00000000..2da553c6 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConnectionProxy.h @@ -0,0 +1,77 @@ +// +// $Id$ +// +// SPMySQLConnectionProxy.h +// SPMySQLFramework +// +// Created by Stuart Connolly (stuconnolly.com) on July 2, 2009. +// Copyright (c) 2009 Stuart Connolly. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +/** + * Connection proxy state constants. + */ +typedef enum { + SPMySQLProxyIdle = 0, + SPMySQLProxyConnecting = 1, + SPMySQLProxyWaitingForAuth = 2, + SPMySQLProxyConnected = 3, + SPMySQLProxyForwardingFailed = 4 +} SPMySQLConnectionProxyState; + + +@protocol SPMySQLConnectionProxy <NSObject> + +/** + * All the methods for this protocol are required. + */ + +/** + * Connect the proxy. + */ +- (void)connect; + +/** + * Disconnect the proxy. + */ +- (void)disconnect; + +/** + * Get the current state of the proxy. + */ +- (SPMySQLConnectionProxyState)state; + +/** + * Get the local port being provided 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/SPMySQLFramework/Source/SPMySQLConstants.h b/Frameworks/SPMySQLFramework/Source/SPMySQLConstants.h new file mode 100644 index 00000000..b1689569 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLConstants.h @@ -0,0 +1,76 @@ +// +// $Id$ +// +// SPMySQLConstants.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 14, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +// Connection state +typedef enum { + SPMySQLDisconnected = 0, + SPMySQLConnecting = 1, + SPMySQLConnected = 2, + SPMySQLDisconnecting = 3 +} SPMySQLConnectionState; + +// Connection lock state +typedef enum { + SPMySQLConnectionIdle = 0, + SPMySQLConnectionBusy = 1 +} SPMySQLConnectionLockState; + +// Decision on how to handle lost connections +// Connection check constants +typedef enum { + SPMySQLConnectionLostDisconnect = 0, + SPMySQLConnectionLostReconnect = 1 +} SPMySQLConnectionLostDecision; + +// Result set row types +typedef enum { + SPMySQLResultRowAsDefault = 0, + SPMySQLResultRowAsArray = 1, + SPMySQLResultRowAsDictionary = 2 +} SPMySQLResultRowType; + +// Result charset list +typedef struct { + NSUInteger nr; + const char *name; + const char *collation; + NSUInteger char_minlen; + NSUInteger char_maxlen; +} SPMySQLResultCharset; + +// Query result types +typedef enum { + SPMySQLResultAsResult = 0, + SPMySQLResultAsFastStreamingResult = 1, + SPMySQLResultAsLowMemStreamingResult = 2 +} SPMySQLResultType; diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLFastStreamingResult.h b/Frameworks/SPMySQLFramework/Source/SPMySQLFastStreamingResult.h new file mode 100644 index 00000000..a4f07cdd --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLFastStreamingResult.h @@ -0,0 +1,47 @@ +// +// $Id$ +// +// SPMySQLFastStreamingResult.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 2, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLFastStreamingResult : SPMySQLStreamingResult { + + // Linked list setup + struct st_spmysqlstreamingrowdata *currentDataStoreEntry; + struct st_spmysqlstreamingrowdata *lastDataStoreEntry; + + // Additional counts and memory length tracking + NSUInteger processedRowCount; + + // Thread safety + pthread_mutex_t dataLock; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLFastStreamingResult.m b/Frameworks/SPMySQLFramework/Source/SPMySQLFastStreamingResult.m new file mode 100644 index 00000000..8ba55134 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLFastStreamingResult.m @@ -0,0 +1,405 @@ +// +// $Id$ +// +// SPMySQLFastStreamingResult.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 2, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQLFastStreamingResult.h" +#import "SPMySQL Private APIs.h" +#import "SPMySQLArrayAdditions.h" +#include <pthread.h> + +static id NSNullPointer; + +/** + * This type of streaming result 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 blocking (and so single-thread-compatible) + * calls. 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. + */ + +typedef struct st_spmysqlstreamingrowdata { + char *data; + unsigned long *dataLengths; + struct st_spmysqlstreamingrowdata *nextRow; +} SPMySQLStreamingRowData; + +@interface SPMySQLFastStreamingResult (Private_API) + +- (void) _downloadAllData; + +@end + +#pragma mark - + +@implementation SPMySQLFastStreamingResult + +#pragma mark - + +/** + * In the one-off class initialisation, cache static variables + */ ++ (void)initialize +{ + + // Cached NSNull singleton reference + if (!NSNullPointer) NSNullPointer = [NSNull null]; +} + +/** + * Standard init method, constructing the SPMySQLStreamingResult around a MySQL + * result pointer and the encoding to use when working with the data. + * As opposed to SPMySQLResult, defaults to returning rows as arrays, as the result + * sets are likely to be larger and processed in loops. + */ +- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding connection:(SPMySQLConnection *)theConnection +{ + + // If no result set was passed in, return nil. + if (!theResult) return nil; + + if ((self = [super initWithMySQLResult:theResult stringEncoding:theStringEncoding connection:theConnection])) { + + // Initialise the extra streaming result counts and tracking + processedRowCount = 0; + + // Initialise the linked list pointers + currentDataStoreEntry = NULL; + lastDataStoreEntry = NULL; + + // Set up the linked list lock + pthread_mutex_init(&dataLock, NULL); + + // Start the data download thread + [NSThread detachNewThreadSelector:@selector(_downloadAllData) toTarget:self withObject:nil]; + } + + return self; +} + +/** + * Deallocate the result and ensure the parent connection is unlocked for further use. + */ +- (void)dealloc +{ + + // Ensure all data is processed and the parent connection is unlocked + [self cancelResultLoad]; + + // Destroy the linked list lock + pthread_mutex_destroy(&dataLock); + + // Call dealloc on super to clean up everything else, and to throw an exception if + // the parent connection hasn't been cleaned up correctly. + [super dealloc]; +} + +#pragma mark - +#pragma mark Data retrieval + +/** + * Override the convenience selectors so that forwarding works correctly. + */ +- (id)getRow +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsDefault); +} +- (NSArray *)getRowAsArray +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsArray); +} +- (NSDictionary *)getRowAsDictionary +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsDictionary); +} + +/** + * Retrieve the next row in the result set, using the internal pointer, in the specified + * return format. + * If there are no rows remaining in the current iteration, returns nil. + */ +- (id)getRowAsType:(SPMySQLResultRowType)theType +{ + NSUInteger copiedDataLength = 0; + char *theRowData; + unsigned long *fieldLengths; + id theReturnData; + + // If the target type was unspecified, use the instance default + if (theType == SPMySQLResultRowAsDefault) theType = defaultRowReturnType; + + // Set up the return data as appropriate + if (theType == SPMySQLResultRowAsArray) { + theReturnData = [NSMutableArray arrayWithCapacity:numberOfFields]; + } else { + theReturnData = [NSMutableDictionary dictionaryWithCapacity:numberOfFields]; + } + + // Lock the data mutex for safe access of variables and counters + pthread_mutex_lock(&dataLock); + + // Determine whether any data is available; if not, wait 1ms before trying again + while (!dataDownloaded && processedRowCount == downloadedRowCount) { + pthread_mutex_unlock(&dataLock); + usleep(1000); + pthread_mutex_lock(&dataLock); + } + + // If all rows have been processed, the end of the result set has been reached; return nil. + if (processedRowCount == downloadedRowCount) { + pthread_mutex_unlock(&dataLock); + return nil; + } + + // Unlock the data mutex now checks are complete + pthread_mutex_unlock(&dataLock); + + // Get a reference to the data for the current row; this is safe to do outside the lock + // as the pointer won't change until markers are changed at the end of this process + theRowData = currentDataStoreEntry->data; + fieldLengths = currentDataStoreEntry->dataLengths; + + // Convert each of the cells in the row in turn + unsigned long fieldLength; + id cellData; + char *rawCellData; + for (NSUInteger i = 0; i < numberOfFields; i++) { + fieldLength = fieldLengths[i]; + + // If the length of this cell is NSNotFound, it's a null reference + if (fieldLength == NSNotFound) { + cellData = nil; + + // Otherwise grab a reference to that data using pointer arithmetic + } else { + rawCellData = theRowData + copiedDataLength; + copiedDataLength += fieldLength; + + // Convert to the correct object type + cellData = SPMySQLResultGetObject(self, rawCellData, fieldLength, fieldTypes[i], i); + } + + // If object creation failed, display a null + if (!cellData) cellData = NSNullPointer; + + // Add to the result array/dictionary + if (theType == SPMySQLResultRowAsArray) { + SPMySQLMutableArrayInsertObject(theReturnData, cellData, i); + } else { + [(NSMutableDictionary *)theReturnData setObject:cellData forKey:fieldNames[i]]; + } + } + + // Get a reference to the current item + SPMySQLStreamingRowData *previousDataStoreEntry = currentDataStoreEntry; + + // Lock the mutex before updating counters and linked lists + pthread_mutex_lock(&dataLock); + + // Update the active-data pointer to the next item in the list (which may be NULL) + currentDataStoreEntry = currentDataStoreEntry->nextRow; + if (!currentDataStoreEntry) lastDataStoreEntry = NULL; + + // Increment the processed counter and row index + processedRowCount++; + currentRowIndex++; + if (dataDownloaded && processedRowCount == downloadedRowCount) currentRowIndex = NSNotFound; + + // Unlock the mutex + pthread_mutex_unlock(&dataLock); + + // Free the memory for the processed row + free(previousDataStoreEntry->dataLengths); + if (previousDataStoreEntry->data != NULL) free(previousDataStoreEntry->data); + free(previousDataStoreEntry); + + return theReturnData; +} + +/* + * Ensure the result set is fully processed and freed without any processing + * This method ensures that the connection is unlocked. + */ +- (void)cancelResultLoad +{ + + // If data has already been downloaded successfully, no further action is required + if (dataDownloaded && processedRowCount == downloadedRowCount) return; + + // Loop until all data is fetched and freed + 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 + if (processedRowCount == downloadedRowCount) { + + // We don't need to unlock the connection because the data loading thread + // has already taken care of that + return; + } + + // Mark the row entry as processed without performing any actions + pthread_mutex_lock(&dataLock); + SPMySQLStreamingRowData *previousDataStoreEntry = currentDataStoreEntry; + + // Update the active-data pointer to the next item in the list (which may be NULL) + currentDataStoreEntry = currentDataStoreEntry->nextRow; + if (!currentDataStoreEntry) lastDataStoreEntry = NULL; + + processedRowCount++; + currentRowIndex++; + if (dataDownloaded && processedRowCount == downloadedRowCount) currentRowIndex = NSNotFound; + + // Unlock the mutex + pthread_mutex_unlock(&dataLock); + + // Free the memory for the processed row + free(previousDataStoreEntry->dataLengths); + if (previousDataStoreEntry->data != NULL) free(previousDataStoreEntry->data); + free(previousDataStoreEntry); + } +} + +#pragma mark - +#pragma mark Data retrieval for fast enumeration + +/** + * Implement the fast enumeration endpoint. Rows for fast enumeration are retrieved in + * the instance default, as specified in setDefaultRowReturnType: or defaulting to + * NSDictionary. + */ +- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len +{ + + // To avoid lock issues, return one row at a time. + id nextRow = SPMySQLResultGetRow(self, SPMySQLResultRowAsDefault); + + // If no row was available, return 0 to stop iteration. + if (!nextRow) return 0; + + // Otherwise, add the item to the buffer and return the appropriate state. + stackbuf[0] = nextRow; + + state->state += 1; + state->itemsPtr = stackbuf; + state->mutationsPtr = (unsigned long *)self; + + return 1; +} + +@end + +#pragma mark - +#pragma mark Result set internals + +@implementation SPMySQLFastStreamingResult (Private_API) + +/** + * 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; + SPMySQLStreamingRowData *newRowStore; + + size_t sizeOfStreamingRowData = sizeof(SPMySQLStreamingRowData); + size_t sizeOfDataLengths = (size_t)(sizeof(unsigned long) * numberOfFields); + size_t sizeOfChar = sizeof(char); + + // Loop through the rows until the end of the data is reached - indicated via a NULL + while ( + (*isConnectedPtr)(parentConnection, isConnectedSelector) + && (theRow = mysql_fetch_row(resultSet)) + ) + { + + // Retrieve the lengths of the returned data + fieldLengths = mysql_fetch_lengths(resultSet); + rowDataLength = 0; + dataCopiedLength = 0; + for (i = 0; i < numberOfFields; i++) { + rowDataLength += fieldLengths[i]; + } + + // Initialise memory for the row and set a NULL pointer for the next item + newRowStore = malloc(sizeOfStreamingRowData); + newRowStore->nextRow = NULL; + + // Set up the row data store - a char* - and copy in the data if there is any. + newRowStore->data = malloc(sizeOfChar * rowDataLength); + for (i = 0; i < numberOfFields; i++) { + if (theRow[i] != NULL) { + memcpy(newRowStore->data+dataCopiedLength, theRow[i], fieldLengths[i]); + dataCopiedLength += fieldLengths[i]; + } else { + fieldLengths[i] = NSNotFound; + } + } + + // Set up the memory for, and copy in, the field lengths + newRowStore->dataLengths = memcpy(malloc(sizeOfDataLengths), fieldLengths, sizeOfDataLengths); + + // Lock the data mutex + pthread_mutex_lock(&dataLock); + + // Add the newly allocated row to end of the storage linked list + if (lastDataStoreEntry) { + lastDataStoreEntry->nextRow = newRowStore; + } + lastDataStoreEntry = newRowStore; + if (!currentDataStoreEntry) currentDataStoreEntry = newRowStore; + + // Update the downloaded row count + downloadedRowCount++; + + // Unlock the mutex + pthread_mutex_unlock(&dataLock); + } + + // Update the connection's error statuses to reflect any errors during the content download + [parentConnection _updateLastErrorID:NSNotFound]; + [parentConnection _updateLastErrorMessage:nil]; + + // Unlock the parent connection now all data has been retrieved + [parentConnection _unlockConnection]; + connectionUnlocked = YES; + + dataDownloaded = YES; + [downloadPool drain]; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLFramework_Prefix.pch b/Frameworks/SPMySQLFramework/Source/SPMySQLFramework_Prefix.pch new file mode 100644 index 00000000..8528c29c --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLFramework_Prefix.pch @@ -0,0 +1,11 @@ +// +// Prefix header for all source files of the 'SPMySQLFramework' target in the 'SPMySQLFramework' project. +// + +#ifdef __OBJC__ + #import <Cocoa/Cocoa.h> +#endif + +#import "mysql.h" +#import "SPMySQL.h" +#import "SPMySQLUtilities.h"
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLGeometryData.h b/Frameworks/SPMySQLFramework/Source/SPMySQLGeometryData.h new file mode 100644 index 00000000..e1313032 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLGeometryData.h @@ -0,0 +1,53 @@ +// +// $Id$ +// +// SPMySQLGeometryData.h +// sequel-pro +// +// Created by Hans-Jörg Bibiko on October 07, 2010 +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLGeometryData : 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/SPMySQLFramework/Source/SPMySQLGeometryData.m b/Frameworks/SPMySQLFramework/Source/SPMySQLGeometryData.m new file mode 100644 index 00000000..3c37e403 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLGeometryData.m @@ -0,0 +1,810 @@ +// +// $Id$ +// +// SPMySQLGeometryData.m +// sequel-pro +// +// Created by Hans-Jörg Bibiko on October 07, 2010 +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQLGeometryData.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; + +#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 SPMySQLGeometryData + +/** + * Initialize the SPMySQLGeometryData object + */ +- (id)init +{ + if ((self = [super init])) { + geoBuffer = nil; + bufferLength = 0; + } + return self; +} + +/** + * Initialize the SPMySQLGeometryData 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 SPMySQLGeometryData object + */ ++ (id)dataWithBytes:(const void *)geoData length:(NSUInteger)length +{ + return [[[SPMySQLGeometryData 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 (imitating 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 = (char)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 = (char)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 = (char)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 = (char)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; + SInt32 geoType; + + NSUInteger ptr = BUFFER_START; // pointer to geoBuffer while parsing + + if (bufferLength < WKB_HEADER_SIZE) + return -1; + + byteOrder = (char)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/SPMySQLFramework/Source/SPMySQLKeepAliveTimer.h b/Frameworks/SPMySQLFramework/Source/SPMySQLKeepAliveTimer.h new file mode 100644 index 00000000..ebe46bed --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLKeepAliveTimer.h @@ -0,0 +1,45 @@ +// +// $Id$ +// +// SPMySQLKeepAliveTimer.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on March 5, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLKeepAliveTimer : NSObject { + id timerTarget; + SEL timerSelector; + NSTimeInterval timerRepeatInterval; + + NSTimer *wrappedTimer; +} + +- (id)initWithInterval:(NSTimeInterval)anInterval target:(id)aTarget selector:(SEL)aSelector; +- (void)invalidate; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLKeepAliveTimer.m b/Frameworks/SPMySQLFramework/Source/SPMySQLKeepAliveTimer.m new file mode 100644 index 00000000..f9164aff --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLKeepAliveTimer.m @@ -0,0 +1,127 @@ +// +// $Id$ +// +// SPMySQLKeepAliveTimer.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on March 5, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +#import "SPMySQLKeepAliveTimer.h" +#import "SPMySQL Private APIs.h" + +@interface SPMySQLKeepAliveTimer (Private_API) + +- (void)_initKeepAliveTimer; +- (void)_forwardPing; + +@end + +#pragma mark - + +@implementation SPMySQLKeepAliveTimer + +/** + * Prevent SPMySQLKeepAliveTimer from being init'd normally. + */ +- (id)init +{ + [NSException raise:NSInternalInconsistencyException format:@"SPMySQLKeepAliveTimers should not be init'd directly; use initWithInterval:target:selector: instead."]; + return nil; +} + +/** + * Initialise the SPMySQLKeepAliveTimer. This also sets up the contained timer, + * which has to be wrapped in this class to prevent retain cycles preventing the + * parent connection from being released. + * + * After initialisation, the delegate should be set to ensure that the timer events + * are received. + */ +- (id)initWithInterval:(NSTimeInterval)anInterval target:(id)aTarget selector:(SEL)aSelector +{ + if ((self = [super init])) { + wrappedTimer = nil; + + // Keep a weak reference to the target + timerTarget = aTarget; + timerSelector = aSelector; + timerRepeatInterval = anInterval; + + // Ensure the timer is set up on the main thread + if ([NSThread isMainThread]) { + [self _initKeepAliveTimer]; + } else { + [self performSelectorOnMainThread:@selector(_initKeepAliveTimer) withObject:nil waitUntilDone:YES]; + } + } + + return self; +} + +/** + * Invalidate the wrapped timer, which also releases the reference to the timer + * target (this object), breaking retain loops. + */ +- (void)invalidate +{ + if ([NSThread isMainThread]) { + [wrappedTimer invalidate]; + } else { + [wrappedTimer performSelectorOnMainThread:@selector(invalidate) withObject:nil waitUntilDone:YES]; + } +} + +- (void)dealloc +{ + [wrappedTimer dealloc]; + [super dealloc]; +} + +@end + +@implementation SPMySQLKeepAliveTimer (Private_API) + +/** + * Set up the timer to tickle the target. This must be set up on the main thread + * to ensure the timer events keep firing. + */ +- (void)_initKeepAliveTimer +{ + wrappedTimer = [[NSTimer scheduledTimerWithTimeInterval:timerRepeatInterval target:self selector:@selector(_forwardPing) userInfo:nil repeats:YES] retain]; +} + +/** + * Forward the NSTimer-fired ping to the target object. Performing this forwarding + * breaks the retain cycle. + */ +- (void)_forwardPing +{ + [timerTarget performSelector:timerSelector]; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Convenience Methods.h b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Convenience Methods.h new file mode 100644 index 00000000..7d870a93 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Convenience Methods.h @@ -0,0 +1,38 @@ +// +// $Id$ +// +// Convenience Methods.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 20, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLResult (Convenience_Methods) + +- (NSArray *)getAllRows; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Convenience Methods.m b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Convenience Methods.m new file mode 100644 index 00000000..2b049264 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Convenience Methods.m @@ -0,0 +1,71 @@ +// +// $Id$ +// +// Convenience Methods.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 20, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "Convenience Methods.h" + +@implementation SPMySQLResult (Convenience_Methods) + +/** + * Iterates over the result set, retrieving all the rows, and returns them + * as an array. + * The rows are in the default format for this instance, as controlled via + * -setDefaultRowReturnType:. + * Returns nil if there are no rows to return. + */ +- (NSArray *)getAllRows +{ + unsigned long long previousSeekPosition = currentRowIndex; + + NSMutableArray *rowsToReturn; + + // If the number of rows is known, pre-set the size; otherwise just create an array + if (numberOfRows != NSNotFound) { + rowsToReturn = [[NSMutableArray alloc] initWithCapacity:(NSUInteger)numberOfRows]; + } else { + rowsToReturn = [[NSMutableArray alloc] init]; + } + + // Loop through the rows in the instance-specified return format + for (id eachRow in self) { + [rowsToReturn addObject:eachRow]; + } + + // Seek to the previous position if appropriate + if (previousSeekPosition) [self seekToRow:previousSeekPosition]; + + // Instead of empty arrays, return nil if there are no rows. + if (![rowsToReturn count]) return nil; + + return rowsToReturn; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Field Definitions.h b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Field Definitions.h new file mode 100644 index 00000000..20e1ddc9 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Field Definitions.h @@ -0,0 +1,38 @@ +// +// $Id$ +// +// Field Definitions.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 2, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface SPMySQLResult (Field_Definitions) + +- (NSArray *)fieldDefinitions; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Field Definitions.m b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Field Definitions.m new file mode 100644 index 00000000..59e75d2f --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult Categories/Field Definitions.m @@ -0,0 +1,557 @@ +// +// $Id$ +// +// Field Definitions.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 2, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "Field Definitions.h" + +@interface SPMySQLResult (Field_Definitions_Private_API) + +- (NSUInteger)_findCharsetMaxByteLengthPerCharForMySQLNumber:(NSUInteger)charsetnr; +- (NSString *)_charsetNameForMySQLNumber:(NSUInteger)charsetnr; +- (NSString *)_charsetCollationForMySQLNumber:(NSUInteger)charsetnr; +- (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; + +@end + +// Import a private declaration from the SPMySQLResult file for use +@interface SPMySQLResult (Private_API) + +- (NSString *)_stringWithBytes:(const void *)bytes length:(NSUInteger)length; + +@end + +#define MAGIC_BINARY_CHARSET_NR 63 + +const SPMySQLResultCharset SPMySQLCharsetMap[] = +{ + {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} +}; + +#pragma mark - + +@implementation SPMySQLResult (Field_Definitions) + +/** + * Return an array of NSDictionaries, each containing information about one of + * the columns in the result set. + * MySQL returns non-valid details as empty strings - these are converted to + * unset entries in the dictionary. + */ +- (NSArray *)fieldDefinitions +{ + NSUInteger i; + NSMutableArray *theFieldDefinitions = [NSMutableArray array]; + NSMutableDictionary *eachField; + MYSQL_FIELD mysqlField; + + for (i = 0; i < numberOfFields; i++) { + eachField = [NSMutableDictionary dictionary]; + mysqlField = fieldDefinitions[i]; + + // Record the original column position within the result set + [eachField setObject:[NSString stringWithFormat:@"%llu", (unsigned long long)i] forKey:@"datacolumnindex"]; + + // Record the column name, or alias if one is being used + [eachField setObject:[self _stringWithBytes:mysqlField.name length:mysqlField.name_length] forKey:@"name"]; + + // Record the original column name if using an alias + [eachField setObject:[self _stringWithBytes:mysqlField.org_name length:mysqlField.org_name_length] forKey:@"org_name"]; + + // If the column had an underlying table, record the table name, respecting aliases + if (mysqlField.table_length) { + [eachField setObject:[self _stringWithBytes:mysqlField.table length:mysqlField.table_length] forKey:@"table"]; + } + + // If the column had an underlying table, record the original table name, ignoring aliases + if (mysqlField.org_table_length) { + [eachField setObject:[self _stringWithBytes:mysqlField.org_table length:mysqlField.org_table_length] forKey:@"org_table"]; + } + + // If the column had an underlying database, record the database name + if (mysqlField.db_length) { + [eachField setObject:[self _stringWithBytes:mysqlField.db length:mysqlField.db_length] forKey:@"db"]; + } + + // Width of column (minimum real length in bytes) + [eachField setObject:[NSNumber numberWithUnsignedLongLong:mysqlField.length] forKey:@"byte_length"]; + + // Width of column (as in create) + // TODO: Discuss the logic of this with Hans-Jörg Bibiko; is this related to max_byte_length? + [eachField setObject:[NSNumber numberWithUnsignedLongLong:(mysqlField.length/[self _findCharsetMaxByteLengthPerCharForMySQLNumber:mysqlField.charsetnr])] forKey:@"char_length"]; + + // Max width (bytes) for selected set. Note that this will be 0 for streaming results. + [eachField setObject:[NSNumber numberWithUnsignedLongLong:mysqlField.max_length] forKey:@"max_byte_length"]; + + // Bit-flags that describe the field, in entirety and split out + [eachField setObject:[NSNumber numberWithUnsignedInt:mysqlField.flags] forKey:@"flags"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & NOT_NULL_FLAG) ? YES : NO] forKey:@"null"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & PRI_KEY_FLAG) ? YES : NO] forKey:@"PRI_KEY_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & UNIQUE_KEY_FLAG) ? YES : NO] forKey:@"UNIQUE_KEY_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & MULTIPLE_KEY_FLAG) ? YES : NO] forKey:@"MULTIPLE_KEY_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & BLOB_FLAG) ? YES : NO] forKey:@"BLOB_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & UNSIGNED_FLAG) ? YES : NO] forKey:@"UNSIGNED_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & ZEROFILL_FLAG) ? YES : NO] forKey:@"ZEROFILL_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & BINARY_FLAG) ? YES : NO] forKey:@"BINARY_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & ENUM_FLAG) ? YES : NO] forKey:@"ENUM_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & AUTO_INCREMENT_FLAG) ? YES : NO] forKey:@"AUTO_INCREMENT_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & SET_FLAG) ? YES : NO] forKey:@"SET_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & NUM_FLAG) ? YES : NO] forKey:@"NUM_FLAG"]; + [eachField setObject:[NSNumber numberWithBool:(mysqlField.flags & PART_KEY_FLAG) ? YES : NO] forKey:@"PART_KEY_FLAG"]; + + // For numeric fields, record the number of decimals + [eachField setObject:[NSNumber numberWithUnsignedInteger:mysqlField.decimals] forKey:@"decimals"]; + + // Character set details + [eachField setObject:[NSNumber numberWithUnsignedInteger:mysqlField.charsetnr] forKey:@"charsetnr"]; + [eachField setObject:[self _charsetNameForMySQLNumber:mysqlField.charsetnr] forKey:@"charset_name"]; + [eachField setObject:[self _charsetCollationForMySQLNumber:mysqlField.charsetnr] forKey:@"charset_collation"]; + + /* Table type */ + [eachField setObject:[self _mysqlTypeToStringForType:mysqlField.type + withCharsetNr:mysqlField.charsetnr + withFlags:mysqlField.flags + withLength:mysqlField.length + ] forKey:@"type"]; + + /* Table type group*/ + [eachField setObject:[self _mysqlTypeToGroupForType:mysqlField.type + withCharsetNr:mysqlField.charsetnr + withFlags:mysqlField.flags + ] forKey:@"typegrouping"]; + + [theFieldDefinitions addObject:eachField]; + } + + return theFieldDefinitions; +} + +@end + +#pragma mark - +#pragma mark Field defintion internals + +@implementation SPMySQLResult (Field_Definitions_Private_API) + +/** + * Return the maximum byte length to store a char by using + * a specific mysql_charsetnr + */ +- (NSUInteger)_findCharsetMaxByteLengthPerCharForMySQLNumber:(NSUInteger)charsetnr +{ + const SPMySQLResultCharset *c = SPMySQLCharsetMap; + + do { + if (c->nr == charsetnr) + return c->char_maxlen; + ++c; + } while (c[0].nr != 0); + + return 1; +} + +/** + * Convert a mysql_charsetnr into a charset name as string + */ +- (NSString *)_charsetNameForMySQLNumber:(NSUInteger)charsetnr +{ + const SPMySQLResultCharset *c = SPMySQLCharsetMap; + + do { + if (c->nr == charsetnr) + return [NSString stringWithCString:c->name encoding:stringEncoding]; + ++c; + } while (c[0].nr != 0); + + return @"UNKNOWN"; +} + +/** + * Convert a mysql_charsetnr into a collation name as string + */ +- (NSString *)_charsetCollationForMySQLNumber:(NSUInteger)charsetnr +{ + const SPMySQLResultCharset *c = SPMySQLCharsetMap; + + do { + if (c->nr == charsetnr) + return [NSString stringWithCString:c->collation encoding:stringEncoding]; + ++c; + } while (c[0].nr != 0); + + return @"UNKNOWN"; +} + +/** + * Convert a mysql_type to a string + */ +- (NSString *)_mysqlTypeToStringForType:(NSUInteger)type withCharsetNr:(NSUInteger)charsetnr withFlags:(NSUInteger)flags withLength:(unsigned long long)length +{ + + switch (type) { + + case FIELD_TYPE_BIT: + return @"BIT"; + + case MYSQL_TYPE_DECIMAL: + case MYSQL_TYPE_NEWDECIMAL: + return @"DECIMAL"; + + case MYSQL_TYPE_TINY: + return @"TINYINT"; + + case MYSQL_TYPE_SHORT: + return @"SMALLINT"; + + case MYSQL_TYPE_LONG: + return @"INT"; + + case MYSQL_TYPE_FLOAT: + return @"FLOAT"; + + case MYSQL_TYPE_DOUBLE: + return @"DOUBLE"; + + case MYSQL_TYPE_NULL: + return @"NULL"; + + case MYSQL_TYPE_TIMESTAMP: + return @"TIMESTAMP"; + + case MYSQL_TYPE_LONGLONG: + return @"BIGINT"; + + case MYSQL_TYPE_INT24: + 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 (length/[self _findCharsetMaxByteLengthPerCharForMySQLNumber: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"; + } +} + +@end
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult.h b/Frameworks/SPMySQLFramework/Source/SPMySQLResult.h new file mode 100644 index 00000000..29518b5d --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult.h @@ -0,0 +1,121 @@ +// +// $Id$ +// +// SPMySQLResult.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 26, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +typedef enum { + SPMySQLResultFieldAsUnhandled = 0, + SPMySQLResultFieldAsString = 1, + SPMySQLResultFieldAsStringOrBlob = 2, + SPMySQLResultFieldAsBlob = 3, + SPMySQLResultFieldAsBit = 4, + SPMySQLResultFieldAsGeometry = 5, + SPMySQLResultFieldAsNull = 6 +} SPMySQLResultFieldProcessor; + +@interface SPMySQLResult : NSObject <NSFastEnumeration> { + + // Wrapped MySQL result set and its encoding + struct st_mysql_res *resultSet; + NSStringEncoding stringEncoding; + + // Number of fields in the result set, and the field names and information + NSUInteger numberOfFields; + struct st_mysql_field *fieldDefinitions; + unsigned int *fieldTypes; + NSString **fieldNames; + + // Number of rows in the result set and an internal data position counter + unsigned long long numberOfRows; + unsigned long long currentRowIndex; + + // How long it took to execute the query that produced this result + double queryExecutionTime; + + // The target result set type for fast enumeration and unspecified row retrieval + SPMySQLResultRowType defaultRowReturnType; + + // Whether all data should be returned as strings - useful for working with some older server types + BOOL returnDataAsStrings; +} + +// Master init method +- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding; + +// Result set information +- (NSUInteger)numberOfFields; +- (unsigned long long)numberOfRows; +- (double)queryExecutionTime; + +// Column information +- (NSArray *)fieldNames; + +// Data retrieval (note that fast enumeration is also supported, using instance-default format) +- (void)seekToRow:(unsigned long long)targetRow; +- (id)getRow; +- (NSArray *)getRowAsArray; +- (NSDictionary *)getRowAsDictionary; +- (id)getRowAsType:(SPMySQLResultRowType)theType; + +// Data conversion ++ (NSString *)bitStringWithBytes:(const char *)bytes length:(NSUInteger)length padToLength:(NSUInteger)padLength; + +#pragma mark - +#pragma mark Synthesized properties + +/** + * 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. + */ +@property (readwrite, assign) BOOL returnDataAsStrings; + +@property (readwrite, assign) SPMySQLResultRowType defaultRowReturnType; + +@end + +/** + * Set up a static function to allow fast calling with cached selectors + */ +static inline id SPMySQLResultGetRow(SPMySQLResult* self, SPMySQLResultRowType rowType) +{ + typedef id (*SPMySQLResultGetRowMethodPtr)(SPMySQLResult*, SEL, SPMySQLResultRowType); + static SPMySQLResultGetRowMethodPtr cachedMethodPointer; + static SEL cachedSelector; + + if (!cachedSelector) cachedSelector = @selector(getRowAsType:); + if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLResultGetRowMethodPtr)[self methodForSelector:cachedSelector]; + + return cachedMethodPointer(self, cachedSelector, rowType); +} diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult.m b/Frameworks/SPMySQLFramework/Source/SPMySQLResult.m new file mode 100644 index 00000000..3ccd5727 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult.m @@ -0,0 +1,464 @@ +// +// $Id$ +// +// SPMySQLResult.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on January 26, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQLResult.h" +#import "SPMySQL Private APIs.h" +#import "SPMySQLArrayAdditions.h" + +static SPMySQLResultFieldProcessor fieldProcessingMap[256]; +static id NSNullPointer; + +@implementation SPMySQLResult + +#pragma mark - +#pragma mark Synthesized properties + +@synthesize returnDataAsStrings; +@synthesize defaultRowReturnType; + +#pragma mark - +#pragma mark Setup and teardown + +/** + * In the one-off class initialisation, set up the result processing map + */ ++ (void)initialize +{ + + // Cached NSNull singleton reference + if (!NSNullPointer) NSNullPointer = [NSNull null]; + + // Go through the list of enum_field_types in mysql_com.h, mapping each to the method for + // processing that result set. + fieldProcessingMap[MYSQL_TYPE_DECIMAL] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_TINY] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_SHORT] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_LONG] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_FLOAT] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_DOUBLE] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_NULL] = SPMySQLResultFieldAsNull; + fieldProcessingMap[MYSQL_TYPE_TIMESTAMP] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_LONGLONG] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_INT24] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_DATE] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_TIME] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_DATETIME] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_YEAR] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_NEWDATE] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_VARCHAR] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_BIT] = SPMySQLResultFieldAsBit; + fieldProcessingMap[MYSQL_TYPE_NEWDECIMAL] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_ENUM] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_SET] = SPMySQLResultFieldAsString; + fieldProcessingMap[MYSQL_TYPE_TINY_BLOB] = SPMySQLResultFieldAsBlob; + fieldProcessingMap[MYSQL_TYPE_MEDIUM_BLOB] = SPMySQLResultFieldAsBlob; + fieldProcessingMap[MYSQL_TYPE_LONG_BLOB] = SPMySQLResultFieldAsBlob; + fieldProcessingMap[MYSQL_TYPE_BLOB] = SPMySQLResultFieldAsBlob; + fieldProcessingMap[MYSQL_TYPE_VAR_STRING] = SPMySQLResultFieldAsStringOrBlob; + fieldProcessingMap[MYSQL_TYPE_STRING] = SPMySQLResultFieldAsStringOrBlob; + fieldProcessingMap[MYSQL_TYPE_GEOMETRY] = SPMySQLResultFieldAsGeometry; + fieldProcessingMap[MYSQL_TYPE_DECIMAL] = SPMySQLResultFieldAsString; +} + +/** + * Prevent SPMySQLResults from being init'd normally. + */ +- (id)init +{ + [NSException raise:NSInternalInconsistencyException format:@"SPMySQLResults should not be init'd directly; use initWithMySQLResult:stringEncoding: instead."]; + return nil; +} + +/** + * Standard init method, constructing the SPMySQLResult around a MySQL + * result pointer and the encoding to use when working with the data. + */ +- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding +{ + + // If no result set was passed in, return nil. + if (!theResult) return nil; + + if ((self = [super init])) { + stringEncoding = theStringEncoding; + queryExecutionTime = -1; + + // Get the result set and cache the number of fields and number of rows + resultSet = theResult; + numberOfFields = mysql_num_fields(resultSet); + numberOfRows = mysql_num_rows(resultSet); + currentRowIndex = 0; + + // Cache the field definitions and build up an array of cached field names and types + fieldDefinitions = mysql_fetch_fields(resultSet); + fieldNames = malloc(sizeof(NSString *) * numberOfFields); + fieldTypes = malloc(sizeof(unsigned int) * numberOfFields); + for (NSUInteger i = 0; i < numberOfFields; i++) { + MYSQL_FIELD aField = fieldDefinitions[i]; + fieldNames[i] = [[self _stringWithBytes:aField.name length:aField.name_length] retain]; + fieldTypes[i] = aField.type; + } + + defaultRowReturnType = SPMySQLResultRowAsDictionary; + } + + return self; +} + +- (void)dealloc +{ + mysql_free_result(resultSet); + + for (NSUInteger i = 0; i < numberOfFields; i++) { + [fieldNames[i] release]; + } + free(fieldNames); + free(fieldTypes); + + [super dealloc]; +} + +#pragma mark - +#pragma mark Result set information + +/** + * Return the number of fields in the result set. + */ +- (NSUInteger)numberOfFields +{ + return numberOfFields; +} + +/** + * Return the number of data rows in the result set. + */ +- (unsigned long long)numberOfRows +{ + return numberOfRows; +} + +/** + * Return how long the original query took to execute - including connection lag! + */ +- (double)queryExecutionTime +{ + return queryExecutionTime; +} + +#pragma mark - +#pragma mark Column information + +/** + * Retrieve the field names for the result set, as an NSArray of NSStrings. + */ +- (NSArray *)fieldNames +{ + return [NSArray arrayWithObjects:fieldNames count:numberOfFields]; +} + +/** + * For field definitions, see Result Categories/Field Definitions.h/m + */ + +#pragma mark - +#pragma mark Data retrieval + +/** + * Jump to a specified row in the result set; when the result set is initialised, + * the internal pointer automatically starts at 0. + */ +- (void)seekToRow:(unsigned long long)targetRow +{ + if (targetRow == currentRowIndex) return; + + if (targetRow >= numberOfRows) { + targetRow = numberOfRows - 1; + } + + mysql_data_seek(resultSet, targetRow); + currentRowIndex = targetRow; +} + +/** + * Retrieve the next row in the result set, using the internal pointer, in the + * instance-specified setDefaultRowReturnType: row format (defaulting to NSDictionary). + * If there are no rows remaining, returns nil. + */ +- (id)getRow +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsDefault); +} + +/** + * Retrieve the next row in the result set, using the internal pointer, in the + * instance-specified setDefaultRowReturnType: row format (defaulting to NSDictionary). + * If there are no rows remaining, returns nil. + */ +- (NSArray *)getRowAsArray +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsArray); +} + +/** + * Retrieve the next row in the result set, using the internal pointer, in the + * instance-specified setDefaultRowReturnType: row format (defaulting to NSDictionary). + * If there are no rows remaining, returns nil. + */ +- (NSDictionary *)getRowAsDictionary +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsDictionary); +} + +/** + * Retrieve the next row in the result set, using the internal pointer, in the specified + * return format. + * If there are no rows remaining in the current iteration, returns nil. + */ +- (id)getRowAsType:(SPMySQLResultRowType)theType +{ + MYSQL_ROW theRow; + unsigned long *theRowDataLengths; + id theReturnData; + + // Retrieve the row in MySQL format, and the length of the data within the row + theRow = mysql_fetch_row(resultSet); + theRowDataLengths = mysql_fetch_lengths(resultSet); + + // If no row was returned, likely at the end of the result set - return nil + if (!theRow) return nil; + + // If the target type was unspecified, use the instance default + if (theType == SPMySQLResultRowAsDefault) theType = defaultRowReturnType; + + // Set up the return data as appropriate + if (theType == SPMySQLResultRowAsArray) { + theReturnData = [NSMutableArray arrayWithCapacity:numberOfFields]; + } else { + theReturnData = [NSMutableDictionary dictionaryWithCapacity:numberOfFields]; + } + + // Convert each of the cells in the row in turn + for (NSUInteger i = 0; i < numberOfFields; i++) { + id cellData = SPMySQLResultGetObject(self, theRow[i], theRowDataLengths[i], fieldTypes[i], i); + + // If object creation failed, display a null + if (!cellData) cellData = NSNullPointer; + + // Add to the result array/dictionary + if (theType == SPMySQLResultRowAsArray) { + SPMySQLMutableArrayInsertObject(theReturnData, cellData, i); + } else { + [(NSMutableDictionary *)theReturnData setObject:cellData forKey:fieldNames[i]]; + } + } + + // Increment the row pointer index and set to NSNotFound if the end of the result set has + // been reached + currentRowIndex++; + if (currentRowIndex > numberOfRows) currentRowIndex = NSNotFound; + + return theReturnData; +} + +#pragma mark - +#pragma mark Data retrieval for fast enumeration + +/** + * Implement the fast enumeration endpoint. Rows for fast enumeration are retrieved in + * the instance default, as specified in setDefaultRowReturnType: or defaulting to + * NSDictionary. + */ +- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len +{ + + // If the start index is out of bounds, return 0 to indicate end of results + if (state->state >= numberOfRows) return 0; + + // Sync up the MySQL pointer position with the requested state if necessary + if (state->state != currentRowIndex) [self seekToRow:state->state]; + + // Determine how many objects to return - 128, len, or all items remaining + NSUInteger itemsToReturn = 128; + if (len < 128) itemsToReturn = len; + if (numberOfRows - state->state < itemsToReturn) { + itemsToReturn = (unsigned long)(numberOfRows - state->state); + } + + // Loop through the rows and add them to the result stack + NSUInteger i; + for (i = 0; i < itemsToReturn; i++) { + stackbuf[i] = SPMySQLResultGetRow(self, SPMySQLResultRowAsDefault); + } + + state->state += itemsToReturn; + state->itemsPtr = stackbuf; + state->mutationsPtr = (unsigned long *)self; + + return itemsToReturn; +} + +#pragma mark - +#pragma mark Data conversion + +/** + * Provides a binary representation of the supplied bytes as a returned NSString. + * The resulting binary representation will be zero-padded according to the supplied + * field length. + */ ++ (NSString *)bitStringWithBytes:(const char *)bytes length:(NSUInteger)length padToLength:(NSUInteger)padLength +{ + if (bytes == NULL) return nil; + + NSUInteger i = 0; + length--; + padLength--; + + // Generate a C string representation of the binary data + char *cStringBuffer = malloc(length + 1); + while (i <= padLength) { + cStringBuffer[padLength - i++] = ( (bytes[length - (i >> 3)] >> (i & 0x7)) & 1 ) ? '1' : '0'; + } + cStringBuffer[padLength+1] = '\0'; + + // Convert to a string + NSString *returnString = [NSString stringWithUTF8String:cStringBuffer]; + + // Free up memory and return + free(cStringBuffer); + return returnString; +} + +@end + +#pragma mark - +#pragma mark Result set internals + +@implementation SPMySQLResult (Private_API) + +/** + * Support internal string conversions which take a supplied byte sequence and length + * and convert them to an NSString using the instance encoding. Will preserve nul + * characters within the string. + */ +- (id)_stringWithBytes:(const void *)bytes length:(NSUInteger)length +{ + return [[[NSString alloc] initWithBytes:bytes length:length encoding:stringEncoding] autorelease]; +} + +/** + * Allow setting the execution time for the original query (including connection lag) + * so it can be requested later without relying on connection state. + */ +- (void)_setQueryExecutionTime:(double)theExecutionTime +{ + queryExecutionTime = theExecutionTime; +} + +/** + * Core data conversion function, taking C data provided by MySQL and converting + * to an appropriate return type. + * Note that the data passed in currently is *not* nul-terminated for fast + * streaming results, which is safe for the current implementation but should be + * kept in mind for future changes. + */ +- (id)_getObjectFromBytes:(char *)bytes ofLength:(NSUInteger)length fieldType:(unsigned int)fieldType fieldDefinitionIndex:(NSUInteger)fieldIndex +{ + + // A NULL pointer for the data indicates a null value; return a NSNull object. + if (bytes == NULL) return NSNullPointer; + + // Determine the field processor to use + SPMySQLResultFieldProcessor dataProcessor = fieldProcessingMap[fieldType]; + + // Switch the method to process the cell data based on the field type mapping. + // Do this in two passes: the first as logic may cause a change in processor required. + switch (dataProcessor) { + + // STRING and VAR_STRING types may be strings or binary types; check the binary flag + case SPMySQLResultFieldAsStringOrBlob: + if (fieldDefinitions[fieldIndex].flags & BINARY_FLAG) { + dataProcessor = SPMySQLResultFieldAsBlob; + } + break; + + // Blob types may be automatically be converted to strings, or may be non-binary + case SPMySQLResultFieldAsBlob: + if (!(fieldDefinitions[fieldIndex].flags & BINARY_FLAG)) { + dataProcessor = SPMySQLResultFieldAsString; + } + break; + + // In most cases, use the original data processor. + default: + break; + } + + // If this instance is set to convert all data as strings, alter the processor. + if (returnDataAsStrings && dataProcessor == SPMySQLResultFieldAsBlob) { + dataProcessor = SPMySQLResultFieldAsString; + } + + // Now switch the processing method again to actually process the data. + switch (dataProcessor) { + + // Convert string types using a method that will preserve any nul characters + // within the string + case SPMySQLResultFieldAsString: + case SPMySQLResultFieldAsStringOrBlob: + return [[[NSString alloc] initWithBytes:bytes length:length encoding:stringEncoding] autorelease]; + + // Convert BLOB types to NSData + case SPMySQLResultFieldAsBlob: + return [NSData dataWithBytes:bytes length:length]; + + // For Geometry types, use a special Geometry object to handle their complexity + case SPMySQLResultFieldAsGeometry: + return [SPMySQLGeometryData dataWithBytes:bytes length:length]; + + // For bit fields, get a zero-padded representation of the data + case SPMySQLResultFieldAsBit: + return [SPMySQLResult bitStringWithBytes:bytes length:length padToLength:fieldDefinitions[fieldIndex].length]; + + // Convert null types to NSNulls + case SPMySQLResultFieldAsNull: + return NSNullPointer; + + case SPMySQLResultFieldAsUnhandled: + NSLog(@"SPMySQLResult processing encountered an unknown field type (%d), falling back to NSData handling", fieldType); + return [NSData dataWithBytes:bytes length:length]; + } + + [NSException raise:NSInternalInconsistencyException format:@"Unhandled field type when processing SPMySQLResults"]; + return nil; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLStreamingResult.h b/Frameworks/SPMySQLFramework/Source/SPMySQLStreamingResult.h new file mode 100644 index 00000000..5abb85db --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLStreamingResult.h @@ -0,0 +1,54 @@ +// +// $Id$ +// +// SPMySQLStreamingResult.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 18, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +@interface SPMySQLStreamingResult : SPMySQLResult { + + // Keep a link to the parent connection for locking purposes + SPMySQLConnection *parentConnection; + + // Streaming result information and tracking + BOOL connectionUnlocked; + BOOL dataDownloaded; + + // Counts and memory length tracking + NSUInteger downloadedRowCount; + + IMP isConnectedPtr; + SEL isConnectedSelector; +} + +- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding connection:(SPMySQLConnection *)theConnection; + +// Allow result fetching to be cancelled +- (void)cancelResultLoad; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLStreamingResult.m b/Frameworks/SPMySQLFramework/Source/SPMySQLStreamingResult.m new file mode 100644 index 00000000..b19e5356 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLStreamingResult.m @@ -0,0 +1,246 @@ +// +// $Id$ +// +// SPMySQLStreamingResult.m +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 18, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQLStreamingResult.h" +#import "SPMySQL Private APIs.h" + + +/** + * This type of streaming result allows each row to 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. + */ + +@implementation SPMySQLStreamingResult + +#pragma mark - + +/** + * Prevent SPMySQLStreamingResults from being init'd as SPMySQLResults. + */ +- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding +{ + [NSException raise:NSInternalInconsistencyException format:@"SPMySQLFullStreamingResults should not be init'd as SPMySQLResults; use initWithMySQLResult:stringEncoding:connection:withFullStreaming: instead."]; + return nil; +} + +/** + * Standard init method, constructing the SPMySQLStreamingResult around a MySQL + * result pointer and the encoding to use when working with the data. + * As opposed to SPMySQLResult, defaults to returning rows as arrays, as the result + * sets are likely to be larger and processed in loops. + */ +- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding connection:(SPMySQLConnection *)theConnection +{ + + // If no result set was passed in, return nil. + if (!theResult) return nil; + + if ((self = [super initWithMySQLResult:theResult stringEncoding:theStringEncoding])) { + parentConnection = theConnection; + numberOfRows = NSNotFound; + + // Start with no rows downloaded + downloadedRowCount = 0; + dataDownloaded = NO; + connectionUnlocked = NO; + + // Cache the isConnected selector and pointer for fast connection checks + isConnectedSelector = @selector(isConnected); + isConnectedPtr = [parentConnection methodForSelector:isConnectedSelector]; + + // Default to returning rows as arrays + defaultRowReturnType = SPMySQLResultRowAsArray; + } + + return self; +} + +/** + * Deallocate the result and ensure the parent connection is unlocked for further use. + */ +- (void)dealloc +{ + + // Ensure all data is processed and the parent connection is unlocked + [self cancelResultLoad]; + + // Throw an exception if in invalid state + if (!connectionUnlocked) { + [parentConnection _unlockConnection]; + [NSException raise:NSInternalInconsistencyException format:@"Parent connection remains locked after SPMySQLStreamingResult use"]; + } + + [super dealloc]; +} + +#pragma mark - +#pragma mark Result set information + +/** + * Override the return of the number of rows in the data set. If this is used before the + * data is fully downloaded, the number of results is still unknown (the server may still + * be seeking/matching), so return NSNotFound; otherwise the number of rows is returned. + */ +- (unsigned long long)numberOfRows +{ + if (!dataDownloaded) return NSNotFound; + + return downloadedRowCount; +} + +#pragma mark - +#pragma mark Data retrieval + +/** + * Override seeking behaviour: seeking cannot be used in streaming result sets. + */ +- (void)seekToRow:(unsigned long long)targetRow +{ + [NSException raise:NSInternalInconsistencyException format:@"Seeking is not supported in streaming SPMySQL result sets."]; +} + +/** + * Override the convenience selectors so that forwarding works correctly. + */ +- (id)getRow +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsDefault); +} +- (NSArray *)getRowAsArray +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsArray); +} +- (NSDictionary *)getRowAsDictionary +{ + return SPMySQLResultGetRow(self, SPMySQLResultRowAsDictionary); +} + +/** + * Retrieve the next row in the result set, using the internal pointer, in the specified + * return format. + * If there are no rows remaining in the current iteration, returns nil. + */ +- (id)getRowAsType:(SPMySQLResultRowType)theType +{ + id theRow = nil; + + // Ensure that the connection is still up before performing a row fetch + if ((*isConnectedPtr)(parentConnection, isConnectedSelector)) { + + // The core of result fetching in streaming mode is still based around mysql_fetch_row, + // so use the super to perform normal processing. + theRow = [super getRowAsType:theType]; + } + + // If no row was returned, the end of the result set has been reached. Clear markers, + // unlock the parent connection, and return nil. + if (!theRow) { + dataDownloaded = YES; + [parentConnection _unlockConnection]; + connectionUnlocked = YES; + return nil; + } + + // Otherwise increment the data downloaded counter and return the row + downloadedRowCount++; + + return theRow; +} + +/* + * Ensure the result set is fully processed and freed without any processing + * This method ensures that the connection is unlocked. + */ +- (void)cancelResultLoad +{ + + // If data has already been downloaded successfully, no further action is required + if (dataDownloaded) return; + + MYSQL_ROW theRow; + + // Loop through all the rows and ensure the rows are fetched. + while (1) { + theRow = mysql_fetch_row(resultSet); + + // If no data was returned, we're at the end of the result set - return. + if (theRow == NULL) { + dataDownloaded = YES; + if (!connectionUnlocked) { + [parentConnection _unlockConnection]; + connectionUnlocked = YES; + } + return; + } + + downloadedRowCount++; + } +} + +#pragma mark - +#pragma mark Data retrieval for fast enumeration + +/** + * Implement the fast enumeration endpoint. Rows for fast enumeration are retrieved in + * the instance default, as specified in setDefaultRowReturnType: or defaulting to + * NSDictionary. Full streaming mode - return one row at a time. + */ +- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len +{ + + // If all rows have been retrieved, return 0 to stop iteration. + if (dataDownloaded) return 0; + + // If the MySQL row pointer does not match the requested state, throw an exception + if (state->state != currentRowIndex) { + [NSException raise:NSRangeException format:@"SPMySQLStreamingResult results can only be accessed linearly"]; + } + + // In full streaming mode return one row at a time. Retrieve the row. + id theRow = SPMySQLResultGetRow(self, SPMySQLResultRowAsDefault); + + // If nil was returned the end of the result resource has been reached + if (!theRow) return 0; + + // Add the row to the result stack and update state + stackbuf[0] = theRow; + state->state += 1; + state->itemsPtr = stackbuf; + state->mutationsPtr = (unsigned long *)self; + + return 1; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLStringAdditions.h b/Frameworks/SPMySQLFramework/Source/SPMySQLStringAdditions.h new file mode 100644 index 00000000..b1f9ccd0 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLStringAdditions.h @@ -0,0 +1,39 @@ +// +// $Id$ +// +// SPMySQLStringAdditions.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 8, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + + +@interface NSString (SPMySQLStringAdditions) + +- (NSString *)mySQLBacktickQuotedString; +- (NSString *)mySQLTickQuotedString; + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLStringAdditions.m b/Frameworks/SPMySQLFramework/Source/SPMySQLStringAdditions.m new file mode 100644 index 00000000..1ea966de --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLStringAdditions.m @@ -0,0 +1,57 @@ +// +// $Id$ +// +// SPMySQLStringAdditions.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 8, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#import "SPMySQLStringAdditions.h" + +@implementation NSString (SPMySQLStringAdditions) + +/** + * Returns the string quoted with backticks as required for MySQL identifiers + * eg.: tablename => `tablename` + * my`table => `my``table` + */ +- (NSString *)mySQLBacktickQuotedString +{ + 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 *)mySQLTickQuotedString +{ + return [NSString stringWithFormat: @"'%@'", [self stringByReplacingOccurrencesOfString:@"'" withString:@"''"]]; +} + +@end diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLUtilities.h b/Frameworks/SPMySQLFramework/Source/SPMySQLUtilities.h new file mode 100644 index 00000000..0a8c19b0 --- /dev/null +++ b/Frameworks/SPMySQLFramework/Source/SPMySQLUtilities.h @@ -0,0 +1,45 @@ +// +// $Id$ +// +// Locking.h +// SPMySQLFramework +// +// Created by Rowan Beentje (rowan.beent.je) on February 6, 2012 +// Copyright (c) 2012 Rowan Beentje. All rights reserved. +// +// Permission is hereby granted, free of charge, to any person +// obtaining a copy of this software and associated documentation +// files (the "Software"), to deal in the Software without +// restriction, including without limitation the rights to use, +// copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the +// Software is furnished to do so, subject to the following +// conditions: +// +// The above copyright notice and this permission notice shall be +// included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +// OTHER DEALINGS IN THE SOFTWARE. +// +// More info at <http://code.google.com/p/sequel-pro/> + +#include <mach/mach_time.h> + +/** + * Define a project function to make it easier to use mach_absolute_time() + * to track monotonically increasing time. + */ +static double _elapsedSecondsSinceAbsoluteTime(uint64_t comparisonTime) +{ + uint64_t elapsedTime_t = mach_absolute_time() - comparisonTime; + Nanoseconds elapsedTime = AbsoluteToNanoseconds(*(AbsoluteTime *)&(elapsedTime_t)); + + return (((double)UnsignedWideToUInt64(elapsedTime)) * 1e-9); +}
\ No newline at end of file diff --git a/Frameworks/SPMySQLFramework/build-mysql-client.sh b/Frameworks/SPMySQLFramework/build-mysql-client.sh new file mode 100755 index 00000000..45e3c465 --- /dev/null +++ b/Frameworks/SPMySQLFramework/build-mysql-client.sh @@ -0,0 +1,171 @@ +#! /bin/ksh + +# +# $Id$ +# +# build-mysql-client.sh +# sequel-pro +# +# Created by Stuart Connolly (stuconnolly.com) +# Copyright (c) 2009 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/> + +# Builds the MySQL client libraries for distrubution in Sequel Pro's MySQL framework. +# +# Paramters: -s -- The path to the MySQL source directory. +# -q -- Quiet. Don't output any compiler messages. +# -c -- Clean the source after build completes. +# -d -- Debug. Output the build statements. + +QUIET='NO' +DEBUG='NO' +CLEAN='NO' + +# C/C++ compiler flags +export CFLAGS='-isysroot /Developer/SDKs/MacOSX10.5.sdk -arch ppc -arch i386 -arch x86_64 -O3 -fno-omit-frame-pointer -fno-exceptions -mmacosx-version-min=10.5' +export CXXFLAGS='-isysroot /Developer/SDKs/MacOSX10.5.sdk -arch ppc -arch i386 -arch x86_64 -O3 -fno-omit-frame-pointer -felide-constructors -fno-exceptions -fno-rtti -mmacosx-version-min=10.5' + +CONFIGURE_OPTIONS='--without-server --enable-thread-safe-client --disable-dependency-tracking --enable-local-infile --with-ssl --enable-assembler --with-mysqld-ldflags=-all-static' +BINARY_DISTRIBUTION_SCRIPT='scripts/make_binary_distribution' + +usage() +{ + cat <<!EOF +Usage: $(basename $0): -s <mysql_source_path> [-q -c -d] + +Where: -s -- Path to the MySQL source directory + -q -- Be quiet during the build. Suppress all compiler messages + -c -- Clean the source directory after the build completes + -d -- Debug. Output all the build commands +!EOF +} + +if [ $# -eq 0 ] +then + echo "Invalid number of arguments. I need the path to the MySQL source directory." + echo '' + usage + exit 1 +fi + +echo '' +echo "This script builds the MySQL client libraries for distribution in Sequel Pro's MySQL framework." +echo 'They are all built as 3-way binaries (32 bit PPC, 32/64 bit i386).' +echo '' +echo -n 'This may take a while, are you sure you want to continue [y | n]: ' + +read CONTINUE + +if [ "x${CONTINUE}" == 'xn' ] +then + echo 'Aborting...' + exit 0 +fi + +while getopts ':s:qcd' OPTION +do + case "$OPTION" in + s) MYSQL_SOURCE_DIR="$OPTARG";; + q) QUIET='YES';; + c) CLEAN='YES';; + d) DEBUG='YES';; + *) echo 'Unrecognised option'; usage; exit 1;; + esac +done + +if [ ! -d "$MYSQL_SOURCE_DIR" ] +then + echo "MySQL source directory does not exist at path '${MYSQL_SOURCE_DIR}'." + echo 'Exiting...' + exit 1 +fi + +# Change to source directory +cd "$MYSQL_SOURCE_DIR" + +echo 'Configuring MySQL source...' + +if [ "x${DEBUG}" == 'xYES' ] +then + echo "${MYSQL_SOURCE_DIR}/configure" "$CONFIGURE_OPTIONS" +fi + +if [ "x${QUIET}" == 'xYES' ] +then + ./configure $CONFIGURE_OPTIONS > /dev/null +else + ./configure $CONFIGURE_OPTIONS +fi + +if [ $? -eq 0 ] +then + echo 'Configure successfully completed' +else + echo 'Configure failed. Exiting...' + exit 1 +fi + +echo 'Building client libraries...' + +if [ "x${QUIET}" == 'xYES' ] +then + make > /dev/null +else + make +fi + +if [ $? -eq 0 ] +then + echo 'Building libraries successfully completed' +else + echo 'Building libraries failed. Exiting...' + exit 1 +fi + +echo 'Building binary distribution...' + +if [ "x${QUIET}" == 'xYES' ] +then + $BINARY_DISTRIBUTION_SCRIPT > /dev/null +else + $BINARY_DISTRIBUTION_SCRIPT +fi + +if [ $? -eq 0 ] +then + echo 'Building binary distribution successfully completed' +else + echo 'Building binary distribution failed. Exiting...' + exit 1 +fi + +if [ "x${CLEAN}" == 'xYES' ] +then + echo 'Cleaning build...' + + if [ "x${QUIET}" == 'xYES' ] + then + make clean > /dev/null + else + make clean + fi +fi + +echo 'Building MySQL client libraries successfully completed.' + +exit 0 |