#import "FMDatabase.h" #import "unistd.h" @implementation FMDatabase @synthesize inTransaction; @synthesize cachedStatements; @synthesize logsErrors; @synthesize crashOnErrors; @synthesize busyRetryTimeout; @synthesize checkedOut; @synthesize traceExecution; + (id)databaseWithPath:(NSString*)aPath { return [[[self alloc] initWithPath:aPath] autorelease]; } + (NSString*)sqliteLibVersion { return [NSString stringWithFormat:@"%s", sqlite3_libversion()]; } + (BOOL)isThreadSafe { // make sure to read the sqlite headers on this guy! return sqlite3_threadsafe(); } - (id)initWithPath:(NSString*)aPath { assert(sqlite3_threadsafe()); // whoa there big boy- gotta make sure sqlite it happy with what we're going to do. self = [super init]; if (self) { databasePath = [aPath copy]; openResultSets = [[NSMutableSet alloc] init]; db = 0x00; logsErrors = 0x00; crashOnErrors = 0x00; busyRetryTimeout = 0x00; _lockQueue = dispatch_queue_create([[NSString stringWithFormat:@"fmdb.%@", self] UTF8String], NULL); } return self; } - (void)finalize { [self close]; [super finalize]; } - (void)dealloc { [self close]; [openResultSets release]; [cachedStatements release]; [databasePath release]; if (_lockQueue) { dispatch_release(_lockQueue); _lockQueue = 0x00; } [super dealloc]; } - (void)executeLocked:(void (^)(void))aBlock { dispatch_sync(_lockQueue, aBlock); } - (NSString *)databasePath { return databasePath; } - (sqlite3*)sqliteHandle { return db; } - (BOOL)open { if (db) { return YES; } int err = sqlite3_open((databasePath ? [databasePath fileSystemRepresentation] : ":memory:"), &db ); if(err != SQLITE_OK) { NSLog(@"error opening!: %d", err); return NO; } return YES; } #if SQLITE_VERSION_NUMBER >= 3005000 - (BOOL)openWithFlags:(int)flags { int err = sqlite3_open_v2((databasePath ? [databasePath fileSystemRepresentation] : ":memory:"), &db, flags, NULL /* Name of VFS module to use */); if(err != SQLITE_OK) { NSLog(@"error opening!: %d", err); return NO; } return YES; } #endif - (BOOL)close { [self clearCachedStatements]; [self closeOpenResultSets]; if (!db) { return YES; } int rc; BOOL retry; int numberOfRetries = 0; BOOL triedFinalizingOpenStatements = NO; do { retry = NO; rc = sqlite3_close(db); if (SQLITE_BUSY == rc || SQLITE_LOCKED == rc) { retry = YES; usleep(20); if (busyRetryTimeout && (numberOfRetries++ > busyRetryTimeout)) { NSLog(@"%s:%d", __FUNCTION__, __LINE__); NSLog(@"Database busy, unable to close"); return NO; } if (!triedFinalizingOpenStatements) { triedFinalizingOpenStatements = YES; sqlite3_stmt *pStmt; while ((pStmt = sqlite3_next_stmt(db, 0x00)) !=0) { NSLog(@"Closing leaked statement"); sqlite3_finalize(pStmt); } } } else if (SQLITE_OK != rc) { NSLog(@"error closing!: %d", rc); } } while (retry); db = nil; return YES; } - (void)clearCachedStatements { [self executeLocked:^() { for (FMStatement *cachedStmt in [cachedStatements objectEnumerator]) { //NSLog(@"cachedStmt: '%@'", cachedStmt); [cachedStmt close]; } [cachedStatements removeAllObjects]; }]; } - (void)closeOpenResultSets { [self executeLocked:^() { //Copy the set so we don't get mutation errors for (NSValue *rsInWrappedInATastyValueMeal in [[openResultSets copy] autorelease]) { FMResultSet *rs = (FMResultSet *)[rsInWrappedInATastyValueMeal pointerValue]; [rs setParentDB:nil]; [rs close]; [openResultSets removeObject:rsInWrappedInATastyValueMeal]; } }]; } - (void)resultSetDidClose:(FMResultSet *)resultSet { NSValue *setValue = [NSValue valueWithNonretainedObject:resultSet]; [self executeLocked:^() { [openResultSets removeObject:setValue]; }]; } - (FMStatement*)cachedStatementForQuery:(NSString*)query { return [cachedStatements objectForKey:query]; } - (void)setCachedStatement:(FMStatement*)statement forQuery:(NSString*)query { //NSLog(@"setting query: %@", query); query = [query copy]; // in case we got handed in a mutable string... [statement setQuery:query]; [self executeLocked:^() { [cachedStatements setObject:statement forKey:query]; }]; [query release]; } - (BOOL)rekey:(NSString*)key { #ifdef SQLITE_HAS_CODEC if (!key) { return NO; } int rc = sqlite3_rekey(db, [key UTF8String], strlen([key UTF8String])); if (rc != SQLITE_OK) { NSLog(@"error on rekey: %d", rc); NSLog(@"%@", [self lastErrorMessage]); } return (rc == SQLITE_OK); #else return NO; #endif } - (BOOL)setKey:(NSString*)key { #ifdef SQLITE_HAS_CODEC if (!key) { return NO; } int rc = sqlite3_key(db, [key UTF8String], strlen([key UTF8String])); return (rc == SQLITE_OK); #else return NO; #endif } - (BOOL)goodConnection { if (!db) { return NO; } FMResultSet *rs = [self executeQuery:@"select name from sqlite_master where type='table'"]; if (rs) { [rs close]; return YES; } return NO; } - (void)warnInUse { NSLog(@"The FMDatabase %@ is currently in use.", self); #ifndef NS_BLOCK_ASSERTIONS if (crashOnErrors) { NSAssert1(false, @"The FMDatabase %@ is currently in use.", self); } #endif } - (BOOL)databaseExists { if (!db) { NSLog(@"The FMDatabase %@ is not open.", self); #ifndef NS_BLOCK_ASSERTIONS if (crashOnErrors) { NSAssert1(false, @"The FMDatabase %@ is not open.", self); } #endif return NO; } return YES; } - (NSString*)lastErrorMessage { return [NSString stringWithUTF8String:sqlite3_errmsg(db)]; } - (BOOL)hadError { int lastErrCode = [self lastErrorCode]; return (lastErrCode > SQLITE_OK && lastErrCode < SQLITE_ROW); } - (int)lastErrorCode { return sqlite3_errcode(db); } - (sqlite_int64)lastInsertRowId { return sqlite3_last_insert_rowid(db); } - (int)changes { return sqlite3_changes(db); } - (void)bindObject:(id)obj toColumn:(int)idx inStatement:(sqlite3_stmt*)pStmt { if ((!obj) || ((NSNull *)obj == [NSNull null])) { sqlite3_bind_null(pStmt, idx); } // FIXME - someday check the return codes on these binds. else if ([obj isKindOfClass:[NSData class]]) { sqlite3_bind_blob(pStmt, idx, [obj bytes], (int)[obj length], SQLITE_STATIC); } else if ([obj isKindOfClass:[NSDate class]]) { sqlite3_bind_double(pStmt, idx, [obj timeIntervalSince1970]); } else if ([obj isKindOfClass:[NSNumber class]]) { if (strcmp([obj objCType], @encode(BOOL)) == 0) { sqlite3_bind_int(pStmt, idx, ([obj boolValue] ? 1 : 0)); } else if (strcmp([obj objCType], @encode(int)) == 0) { sqlite3_bind_int64(pStmt, idx, [obj longValue]); } else if (strcmp([obj objCType], @encode(long)) == 0) { sqlite3_bind_int64(pStmt, idx, [obj longValue]); } else if (strcmp([obj objCType], @encode(long long)) == 0) { sqlite3_bind_int64(pStmt, idx, [obj longLongValue]); } else if (strcmp([obj objCType], @encode(float)) == 0) { sqlite3_bind_double(pStmt, idx, [obj floatValue]); } else if (strcmp([obj objCType], @encode(double)) == 0) { sqlite3_bind_double(pStmt, idx, [obj doubleValue]); } else { sqlite3_bind_text(pStmt, idx, [[obj description] UTF8String], -1, SQLITE_STATIC); } } else { sqlite3_bind_text(pStmt, idx, [[obj description] UTF8String], -1, SQLITE_STATIC); } } - (void)_extractSQL:(NSString *)sql argumentsList:(va_list)args intoString:(NSMutableString *)cleanedSQL arguments:(NSMutableArray *)arguments { NSUInteger length = [sql length]; unichar last = '\0'; for (NSUInteger i = 0; i < length; ++i) { id arg = nil; unichar current = [sql characterAtIndex:i]; unichar add = current; if (last == '%') { switch (current) { case '@': arg = va_arg(args, id); break; case 'c': arg = [NSString stringWithFormat:@"%c", va_arg(args, char)]; break; case 's': arg = [NSString stringWithUTF8String:va_arg(args, char*)]; break; case 'd': case 'D': case 'i': arg = [NSNumber numberWithInt:va_arg(args, int)]; break; case 'u': case 'U': arg = [NSNumber numberWithUnsignedInt:va_arg(args, unsigned int)]; break; case 'h': i++; if (i < length && [sql characterAtIndex:i] == 'i') { arg = [NSNumber numberWithShort:va_arg(args, short)]; } else if (i < length && [sql characterAtIndex:i] == 'u') { arg = [NSNumber numberWithUnsignedShort:va_arg(args, unsigned short)]; } else { i--; } break; case 'q': i++; if (i < length && [sql characterAtIndex:i] == 'i') { arg = [NSNumber numberWithLongLong:va_arg(args, long long)]; } else if (i < length && [sql characterAtIndex:i] == 'u') { arg = [NSNumber numberWithUnsignedLongLong:va_arg(args, unsigned long long)]; } else { i--; } break; case 'f': arg = [NSNumber numberWithDouble:va_arg(args, double)]; break; case 'g': arg = [NSNumber numberWithFloat:va_arg(args, float)]; break; case 'l': i++; if (i < length) { unichar next = [sql characterAtIndex:i]; if (next == 'l') { i++; if (i < length && [sql characterAtIndex:i] == 'd') { //%lld arg = [NSNumber numberWithLongLong:va_arg(args, long long)]; } else if (i < length && [sql characterAtIndex:i] == 'u') { //%llu arg = [NSNumber numberWithUnsignedLongLong:va_arg(args, unsigned long long)]; } else { i--; } } else if (next == 'd') { //%ld arg = [NSNumber numberWithLong:va_arg(args, long)]; } else if (next == 'u') { //%lu arg = [NSNumber numberWithUnsignedLong:va_arg(args, unsigned long)]; } else { i--; } } else { i--; } break; default: // something else that we can't interpret. just pass it on through like normal break; } } else if (current == '%') { // percent sign; skip this character add = '\0'; } if (arg != nil) { [cleanedSQL appendString:@"?"]; [arguments addObject:arg]; } else if (add != '\0') { [cleanedSQL appendFormat:@"%C", add]; } last = current; } } - (FMResultSet *)executeQuery:(NSString *)sql withArgumentsInArray:(NSArray*)arrayArgs orVAList:(va_list)args { if (![self databaseExists]) { return 0x00; } int rc = 0x00; sqlite3_stmt *pStmt = 0x00; FMStatement *statement = 0x00; FMResultSet *rs = 0x00; if (traceExecution && sql) { NSLog(@"%@ executeQuery: %@", self, sql); } if (shouldCacheStatements) { statement = [self cachedStatementForQuery:sql]; pStmt = statement ? [statement statement] : 0x00; } int numberOfRetries = 0; BOOL retry = NO; if (!pStmt) { do { retry = NO; rc = sqlite3_prepare_v2(db, [sql UTF8String], -1, &pStmt, 0); if (SQLITE_BUSY == rc || SQLITE_LOCKED == rc) { retry = YES; usleep(20); if (busyRetryTimeout && (numberOfRetries++ > busyRetryTimeout)) { NSLog(@"%s:%d Database busy (%@)", __FUNCTION__, __LINE__, [self databasePath]); NSLog(@"Database busy"); sqlite3_finalize(pStmt); return nil; } } else if (SQLITE_OK != rc) { if (logsErrors) { NSLog(@"DB Error: %d \"%@\"", [self lastErrorCode], [self lastErrorMessage]); NSLog(@"DB Query: %@", sql); #ifndef NS_BLOCK_ASSERTIONS if (crashOnErrors) { NSAssert2(false, @"DB Error: %d \"%@\"", [self lastErrorCode], [self lastErrorMessage]); } #endif } sqlite3_finalize(pStmt); return nil; } } while (retry); } id obj; int idx = 0; int queryCount = sqlite3_bind_parameter_count(pStmt); // pointed out by Dominic Yu (thanks!) while (idx < queryCount) { if (arrayArgs) { obj = [arrayArgs objectAtIndex:idx]; } else { obj = va_arg(args, id); } if (traceExecution) { NSLog(@"obj: %@", obj); } idx++; [self bindObject:obj toColumn:idx inStatement:pStmt]; } if (idx != queryCount) { NSLog(@"Error: the bind count is not correct for the # of variables (executeQuery)"); sqlite3_finalize(pStmt); return nil; } [statement retain]; // to balance the release below if (!statement) { statement = [[FMStatement alloc] init]; [statement setStatement:pStmt]; if (shouldCacheStatements) { [self setCachedStatement:statement forQuery:sql]; } } // the statement gets closed in rs's dealloc or [rs close]; rs = [FMResultSet resultSetWithStatement:statement usingParentDatabase:self]; [rs setQuery:sql]; NSValue *openResultSet = [NSValue valueWithNonretainedObject:rs]; [openResultSets addObject:openResultSet]; [statement setUseCount:[statement useCount] + 1]; [statement release]; return rs; } - (FMResultSet *)executeQuery:(NSString*)sql, ... { va_list args; va_start(args, sql); id result = [self executeQuery:sql withArgumentsInArray:nil orVAList:args]; va_end(args); return result; } - (FMResultSet *)executeQueryWithFormat:(NSString*)format, ... { va_list args; va_start(args, format); NSMutableString *sql = [NSMutableString stringWithCapacity:[format length]]; NSMutableArray *arguments = [NSMutableArray array]; [self _extractSQL:format argumentsList:args intoString:sql arguments:arguments]; va_end(args); return [self executeQuery:sql withArgumentsInArray:arguments]; } - (FMResultSet *)executeQuery:(NSString *)sql withArgumentsInArray:(NSArray *)arguments { return [self executeQuery:sql withArgumentsInArray:arguments orVAList:nil]; } - (BOOL)executeUpdate:(NSString*)sql error:(NSError**)outErr withArgumentsInArray:(NSArray*)arrayArgs orVAList:(va_list)args { if (![self databaseExists]) { return NO; } int rc = 0x00; sqlite3_stmt *pStmt = 0x00; FMStatement *cachedStmt = 0x00; if (traceExecution && sql) { NSLog(@"%@ executeUpdate: %@", self, sql); } if (shouldCacheStatements) { cachedStmt = [self cachedStatementForQuery:sql]; pStmt = cachedStmt ? [cachedStmt statement] : 0x00; } int numberOfRetries = 0; BOOL retry = NO; if (!pStmt) { do { retry = NO; rc = sqlite3_prepare_v2(db, [sql UTF8String], -1, &pStmt, 0); if (SQLITE_BUSY == rc || SQLITE_LOCKED == rc) { retry = YES; usleep(20); if (busyRetryTimeout && (numberOfRetries++ > busyRetryTimeout)) { NSLog(@"%s:%d Database busy (%@)", __FUNCTION__, __LINE__, [self databasePath]); NSLog(@"Database busy"); sqlite3_finalize(pStmt); return NO; } } else if (SQLITE_OK != rc) { if (logsErrors) { NSLog(@"DB Error: %d \"%@\"", [self lastErrorCode], [self lastErrorMessage]); NSLog(@"DB Query: %@", sql); #ifndef NS_BLOCK_ASSERTIONS if (crashOnErrors) { NSAssert2(false, @"DB Error: %d \"%@\"", [self lastErrorCode], [self lastErrorMessage]); } #endif } sqlite3_finalize(pStmt); if (outErr) { *outErr = [NSError errorWithDomain:[NSString stringWithUTF8String:sqlite3_errmsg(db)] code:rc userInfo:nil]; } return NO; } } while (retry); } id obj; int idx = 0; int queryCount = sqlite3_bind_parameter_count(pStmt); while (idx < queryCount) { if (arrayArgs) { obj = [arrayArgs objectAtIndex:idx]; } else { obj = va_arg(args, id); } if (traceExecution) { NSLog(@"obj: %@", obj); } idx++; [self bindObject:obj toColumn:idx inStatement:pStmt]; } if (idx != queryCount) { NSLog(@"Error: the bind count is not correct for the # of variables (%@) (executeUpdate)", sql); sqlite3_finalize(pStmt); return NO; } /* Call sqlite3_step() to run the virtual machine. Since the SQL being ** executed is not a SELECT statement, we assume no data will be returned. */ numberOfRetries = 0; do { rc = sqlite3_step(pStmt); retry = NO; if (SQLITE_BUSY == rc || SQLITE_LOCKED == rc) { // this will happen if the db is locked, like if we are doing an update or insert. // in that case, retry the step... and maybe wait just 10 milliseconds. retry = YES; if (SQLITE_LOCKED == rc) { rc = sqlite3_reset(pStmt); if (rc != SQLITE_LOCKED) { NSLog(@"Unexpected result from sqlite3_reset (%d) eu", rc); } } usleep(20); if (busyRetryTimeout && (numberOfRetries++ > busyRetryTimeout)) { NSLog(@"%s:%d Database busy (%@)", __FUNCTION__, __LINE__, [self databasePath]); NSLog(@"Database busy"); retry = NO; } } else if (SQLITE_DONE == rc || SQLITE_ROW == rc) { // all is well, let's return. } else if (SQLITE_ERROR == rc) { NSLog(@"Error calling sqlite3_step (%d: %s) SQLITE_ERROR", rc, sqlite3_errmsg(db)); NSLog(@"DB Query: %@", sql); } else if (SQLITE_MISUSE == rc) { // uh oh. NSLog(@"Error calling sqlite3_step (%d: %s) SQLITE_MISUSE", rc, sqlite3_errmsg(db)); NSLog(@"DB Query: %@", sql); } else { // wtf? NSLog(@"Unknown error calling sqlite3_step (%d: %s) eu", rc, sqlite3_errmsg(db)); NSLog(@"DB Query: %@", sql); } } while (retry); assert( rc!=SQLITE_ROW ); if (shouldCacheStatements && !cachedStmt) { cachedStmt = [[FMStatement alloc] init]; [cachedStmt setStatement:pStmt]; [self setCachedStatement:cachedStmt forQuery:sql]; [cachedStmt release]; } if (cachedStmt) { [cachedStmt setUseCount:[cachedStmt useCount] + 1]; rc = sqlite3_reset(pStmt); } else { /* Finalize the virtual machine. This releases all memory and other ** resources allocated by the sqlite3_prepare() call above. */ rc = sqlite3_finalize(pStmt); } return (rc == SQLITE_OK); } - (BOOL)executeUpdate:(NSString*)sql, ... { va_list args; va_start(args, sql); BOOL result = [self executeUpdate:sql error:nil withArgumentsInArray:nil orVAList:args]; va_end(args); return result; } - (BOOL)executeUpdate:(NSString*)sql withArgumentsInArray:(NSArray *)arguments { return [self executeUpdate:sql error:nil withArgumentsInArray:arguments orVAList:nil]; } - (BOOL)executeUpdateWithFormat:(NSString*)format, ... { va_list args; va_start(args, format); NSMutableString *sql = [NSMutableString stringWithCapacity:[format length]]; NSMutableArray *arguments = [NSMutableArray array]; [self _extractSQL:format argumentsList:args intoString:sql arguments:arguments]; va_end(args); return [self executeUpdate:sql withArgumentsInArray:arguments]; } - (BOOL)update:(NSString*)sql error:(NSError**)outErr bind:(id)bindArgs, ... { va_list args; va_start(args, bindArgs); BOOL result = [self executeUpdate:sql error:outErr withArgumentsInArray:nil orVAList:args]; va_end(args); return result; } - (BOOL)rollback { BOOL b = [self executeUpdate:@"ROLLBACK TRANSACTION;"]; if (b) { inTransaction = NO; } return b; } - (BOOL)commit { BOOL b = [self executeUpdate:@"COMMIT TRANSACTION;"]; if (b) { inTransaction = NO; } return b; } - (BOOL)beginDeferredTransaction { BOOL b = [self executeUpdate:@"BEGIN DEFERRED TRANSACTION;"]; if (b) { inTransaction = YES; } return b; } - (BOOL)beginTransaction { BOOL b = [self executeUpdate:@"BEGIN EXCLUSIVE TRANSACTION;"]; if (b) { inTransaction = YES; } return b; } - (BOOL)shouldCacheStatements { return shouldCacheStatements; } - (void)setShouldCacheStatements:(BOOL)value { shouldCacheStatements = value; if (shouldCacheStatements && !cachedStatements) { [self setCachedStatements:[NSMutableDictionary dictionary]]; } if (!shouldCacheStatements) { [self setCachedStatements:nil]; } } @end @implementation FMStatement @synthesize statement; @synthesize query; @synthesize useCount; - (void)finalize { [self close]; [super finalize]; } - (void)dealloc { [self close]; [query release]; [super dealloc]; } - (void)close { if (statement) { sqlite3_finalize(statement); statement = 0x00; } } - (void)reset { if (statement) { sqlite3_reset(statement); } } - (NSString*)description { return [NSString stringWithFormat:@"%@ %d hit(s) for query %@", [super description], useCount, query]; } @end