-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
SQLiteModuleNext.swift
619 lines (541 loc) · 22.4 KB
/
SQLiteModuleNext.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
// Copyright 2015-present 650 Industries. All rights reserved.
import ExpoModulesCore
import sqlite3
private typealias SQLiteColumnNames = [String]
private typealias SQLiteColumnValues = [Any]
private let SQLITE_TRANSIENT = unsafeBitCast(OpaquePointer(bitPattern: -1), to: sqlite3_destructor_type.self)
private let MEMORY_DB_NAME = ":memory:"
public final class SQLiteModuleNext: Module {
// Store unmanaged (SQLiteModuleNext, Database) pairs for sqlite callbacks,
// will release the pair when `closeDatabase` is called.
private var contextPairs = [Unmanaged<AnyObject>]()
private static let lockQueue = DispatchQueue(label: "expo.modules.sqlite.lockQueue")
private var cachedDatabases = [NativeDatabase]()
private var cachedStatements = [NativeDatabase: [NativeStatement]]()
private var hasListeners = false
public func definition() -> ModuleDefinition {
Name("ExpoSQLiteNext")
Events("onDatabaseChange")
OnStartObserving {
hasListeners = true
}
OnStopObserving {
hasListeners = false
}
OnDestroy {
removeAllCachedDatabases().forEach {
do {
try closeDatabase($0)
} catch {}
}
}
AsyncFunction("deleteDatabaseAsync") { (databaseName: String) in
try deleteDatabase(databaseName: databaseName)
}
Function("deleteDatabaseSync") { (databaseName: String) in
try deleteDatabase(databaseName: databaseName)
}
AsyncFunction("importAssetDatabaseAsync") { (databaseName: String, assetDatabasePath: String, forceOverwrite: Bool) in
guard let path = pathForDatabaseName(name: databaseName) else {
throw Exceptions.FileSystemModuleNotFound()
}
let fileManager = FileManager.default
if fileManager.fileExists(atPath: path.absoluteString) && !forceOverwrite {
return
}
guard let assetPath = URL(string: assetDatabasePath)?.path,
fileManager.fileExists(atPath: assetPath) else {
throw DatabaseNotFoundException(assetDatabasePath)
}
try? fileManager.removeItem(atPath: path.absoluteString)
try fileManager.copyItem(atPath: assetPath, toPath: path.absoluteString)
}
// swiftlint:disable:next closure_body_length
Class(NativeDatabase.self) {
Constructor { (databaseName: String, options: OpenDatabaseOptions, serializedData: Data?) -> NativeDatabase in
var db: OpaquePointer?
if let serializedData = serializedData {
db = try deserializeDatabase(serializedData)
} else {
guard let path = pathForDatabaseName(name: databaseName) else {
throw DatabaseException()
}
// Try to find opened database for fast refresh
if let cachedDb = findCachedDatabase(where: { $0.databaseName == databaseName && $0.openOptions == options && !options.useNewConnection }) {
return cachedDb
}
if sqlite3_open(path.absoluteString, &db) != SQLITE_OK {
throw DatabaseException()
}
}
let database = NativeDatabase(db, databaseName: databaseName, openOptions: options)
addCachedDatabase(database)
return database
}
AsyncFunction("initAsync") { (database: NativeDatabase) in
try initDb(database: database)
}
Function("initSync") { (database: NativeDatabase) in
try initDb(database: database)
}
AsyncFunction("isInTransactionAsync") { (database: NativeDatabase) -> Bool in
try maybeThrowForClosedDatabase(database)
return sqlite3_get_autocommit(database.pointer) == 0
}
Function("isInTransactionSync") { (database: NativeDatabase) -> Bool in
try maybeThrowForClosedDatabase(database)
return sqlite3_get_autocommit(database.pointer) == 0
}
AsyncFunction("closeAsync") { (database: NativeDatabase) in
removeCachedDatabase(of: database)
try closeDatabase(database)
}
Function("closeSync") { (database: NativeDatabase) in
removeCachedDatabase(of: database)
try closeDatabase(database)
}
AsyncFunction("execAsync") { (database: NativeDatabase, source: String) in
try exec(database: database, source: source)
}
Function("execSync") { (database: NativeDatabase, source: String) in
try exec(database: database, source: source)
}
AsyncFunction("serializeAsync") { (database: NativeDatabase, databaseName: String) in
try serialize(database: database, databaseName: databaseName)
}
Function("serializeSync") { (database: NativeDatabase, databaseName: String) in
try serialize(database: database, databaseName: databaseName)
}
AsyncFunction("prepareAsync") { (database: NativeDatabase, statement: NativeStatement, source: String) in
try prepareStatement(database: database, statement: statement, source: source)
}
Function("prepareSync") { (database: NativeDatabase, statement: NativeStatement, source: String) in
try prepareStatement(database: database, statement: statement, source: source)
}
}
// swiftlint:disable:next closure_body_length
Class(NativeStatement.self) {
Constructor {
return NativeStatement()
}
// swiftlint:disable line_length
AsyncFunction("runAsync") { (statement: NativeStatement, database: NativeDatabase, bindParams: [String: Any], bindBlobParams: [String: Data], shouldPassAsArray: Bool) -> [String: Any] in
return try run(statement: statement, database: database, bindParams: bindParams, bindBlobParams: bindBlobParams, shouldPassAsArray: shouldPassAsArray)
}
Function("runSync") { (statement: NativeStatement, database: NativeDatabase, bindParams: [String: Any], bindBlobParams: [String: Data], shouldPassAsArray: Bool) -> [String: Any] in
return try run(statement: statement, database: database, bindParams: bindParams, bindBlobParams: bindBlobParams, shouldPassAsArray: shouldPassAsArray)
}
// swiftlint:enable line_length
AsyncFunction("stepAsync") { (statement: NativeStatement, database: NativeDatabase) -> SQLiteColumnValues? in
return try step(statement: statement, database: database)
}
Function("stepSync") { (statement: NativeStatement, database: NativeDatabase) -> SQLiteColumnValues? in
return try step(statement: statement, database: database)
}
AsyncFunction("getAllAsync") { (statement: NativeStatement, database: NativeDatabase) -> [SQLiteColumnValues] in
return try getAll(statement: statement, database: database)
}
Function("getAllSync") { (statement: NativeStatement, database: NativeDatabase) -> [SQLiteColumnValues] in
return try getAll(statement: statement, database: database)
}
AsyncFunction("resetAsync") { (statement: NativeStatement, database: NativeDatabase) in
try reset(statement: statement, database: database)
}
Function("resetSync") { (statement: NativeStatement, database: NativeDatabase) in
try reset(statement: statement, database: database)
}
AsyncFunction("getColumnNamesAsync") { (statement: NativeStatement) -> SQLiteColumnNames in
return try getColumnNames(statement: statement)
}
Function("getColumnNamesSync") { (statement: NativeStatement) -> SQLiteColumnNames in
return try getColumnNames(statement: statement)
}
AsyncFunction("finalizeAsync") { (statement: NativeStatement, database: NativeDatabase) in
try finalize(statement: statement, database: database)
}
Function("finalizeSync") { (statement: NativeStatement, database: NativeDatabase) in
try finalize(statement: statement, database: database)
}
}
}
private func pathForDatabaseName(name: String) -> URL? {
if name == MEMORY_DB_NAME {
return URL(string: name)
}
guard let fileSystem = appContext?.fileSystem else {
return nil
}
let directory = URL(string: fileSystem.documentDirectory)?.appendingPathComponent("SQLite")
fileSystem.ensureDirExists(withPath: directory?.absoluteString)
return directory?.appendingPathComponent(name)
}
private func deserializeDatabase(_ serializedData: Data) throws -> OpaquePointer? {
var db: OpaquePointer?
if sqlite3_open(MEMORY_DB_NAME, &db) != SQLITE_OK {
throw DatabaseException()
}
let size = sqlite3_int64(serializedData.count)
guard let buffer = sqlite3_malloc64(sqlite3_uint64(size)) else {
throw SQLiteErrorException("Unable to allocate memory for \(size) bytes")
}
try serializedData.withUnsafeBytes {
guard let baseAddress = $0.baseAddress else {
sqlite3_free(buffer)
throw SQLiteErrorException("Unable to get allocated memory base address")
}
memcpy(buffer, baseAddress, Int(size))
}
let flags = UInt32(SQLITE_DESERIALIZE_RESIZEABLE | SQLITE_DESERIALIZE_FREEONCLOSE)
let ret = sqlite3_deserialize(db, "main", buffer.assumingMemoryBound(to: UInt8.self), size, size, flags)
if ret != SQLITE_OK {
throw SQLiteErrorException(convertSqlLiteErrorToString(db))
}
return db
}
private func initDb(database: NativeDatabase) throws {
try maybeThrowForClosedDatabase(database)
if database.openOptions.enableCRSQLite {
crsqlite_init_from_swift(database.pointer)
}
if database.openOptions.enableChangeListener {
addUpdateHook(database)
}
}
private func exec(database: NativeDatabase, source: String) throws {
try maybeThrowForClosedDatabase(database)
var error: UnsafeMutablePointer<CChar>?
let ret = sqlite3_exec(database.pointer, source, nil, nil, &error)
if ret != SQLITE_OK, let error = error {
let errorString = String(cString: error)
sqlite3_free(error)
throw SQLiteErrorException(errorString)
}
}
private func serialize(database: NativeDatabase, databaseName: String) throws -> Data {
try maybeThrowForClosedDatabase(database)
var size: sqlite3_int64 = 0
guard let bytes = sqlite3_serialize(database.pointer, databaseName, &size, 0) else {
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
let serializedData = Data(bytes: bytes, count: Int(size))
sqlite3_free(bytes)
return serializedData
}
private func prepareStatement(database: NativeDatabase, statement: NativeStatement, source: String) throws {
try maybeThrowForClosedDatabase(database)
try maybeThrowForFinalizedStatement(statement)
if sqlite3_prepare_v2(database.pointer, source, Int32(source.count), &statement.pointer, nil) != SQLITE_OK {
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
maybeAddCachedStatement(database: database, statement: statement)
}
// swiftlint:disable line_length
private func run(statement: NativeStatement, database: NativeDatabase, bindParams: [String: Any], bindBlobParams: [String: Data], shouldPassAsArray: Bool) throws -> [String: Any] {
try maybeThrowForClosedDatabase(database)
try maybeThrowForFinalizedStatement(statement)
sqlite3_reset(statement.pointer)
sqlite3_clear_bindings(statement.pointer)
for (key, param) in bindParams {
let index = try getBindParamIndex(statement: statement, key: key, shouldPassAsArray: shouldPassAsArray)
if index > 0 {
try bindStatementParam(statement: statement, with: param, at: index)
}
}
for (key, param) in bindBlobParams {
let index = try getBindParamIndex(statement: statement, key: key, shouldPassAsArray: shouldPassAsArray)
if index > 0 {
try bindStatementParam(statement: statement, with: param, at: index)
}
}
let ret = sqlite3_step(statement.pointer)
if ret != SQLITE_ROW && ret != SQLITE_DONE {
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
let firstRowValues: SQLiteColumnValues = (ret == SQLITE_ROW) ? try getColumnValues(statement: statement) : []
return [
"lastInsertRowId": Int(sqlite3_last_insert_rowid(database.pointer)),
"changes": Int(sqlite3_changes(database.pointer)),
"firstRowValues": firstRowValues
]
}
// swiftlint:enable line_length
private func step(statement: NativeStatement, database: NativeDatabase) throws -> SQLiteColumnValues? {
try maybeThrowForClosedDatabase(database)
try maybeThrowForFinalizedStatement(statement)
let ret = sqlite3_step(statement.pointer)
if ret == SQLITE_ROW {
return try getColumnValues(statement: statement)
}
if ret != SQLITE_DONE {
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
return nil
}
private func getAll(statement: NativeStatement, database: NativeDatabase) throws -> [SQLiteColumnValues] {
try maybeThrowForClosedDatabase(database)
try maybeThrowForFinalizedStatement(statement)
var columnValuesList: [SQLiteColumnValues] = []
while true {
let ret = sqlite3_step(statement.pointer)
if ret == SQLITE_ROW {
columnValuesList.append(try getColumnValues(statement: statement))
continue
} else if ret == SQLITE_DONE {
break
}
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
return columnValuesList
}
private func reset(statement: NativeStatement, database: NativeDatabase) throws {
try maybeThrowForClosedDatabase(database)
try maybeThrowForFinalizedStatement(statement)
if sqlite3_reset(statement.pointer) != SQLITE_OK {
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
}
private func finalize(statement: NativeStatement, database: NativeDatabase) throws {
try maybeThrowForClosedDatabase(database)
try maybeThrowForFinalizedStatement(statement)
maybeRemoveCachedStatement(database: database, statement: statement)
if sqlite3_finalize(statement.pointer) != SQLITE_OK {
throw SQLiteErrorException(convertSqlLiteErrorToString(database))
}
statement.isFinalized = true
}
private func convertSqlLiteErrorToString(_ db: OpaquePointer?) -> String {
let code = sqlite3_errcode(db)
let message = String(cString: sqlite3_errmsg(db), encoding: .utf8) ?? ""
return "Error code \(code): \(message)"
}
private func convertSqlLiteErrorToString(_ db: NativeDatabase) -> String {
return convertSqlLiteErrorToString(db.pointer)
}
private func closeDatabase(_ db: NativeDatabase) throws {
try maybeThrowForClosedDatabase(db)
for removedStatement in maybeRemoveAllCachedStatements(database: db) {
sqlite3_finalize(removedStatement.pointer)
}
if db.openOptions.enableCRSQLite {
sqlite3_exec(db.pointer, "SELECT crsql_finalize()", nil, nil, nil)
}
let ret = sqlite3_close(db.pointer)
db.isClosed = true
if let index = contextPairs.firstIndex(where: {
guard let pair = $0.takeUnretainedValue() as? (SQLiteModuleNext, NativeDatabase) else {
return false
}
if pair.1.sharedObjectId != db.sharedObjectId {
return false
}
$0.release()
return true
}) {
contextPairs.remove(at: index)
}
if ret != SQLITE_OK {
throw SQLiteErrorException(convertSqlLiteErrorToString(db))
}
}
private func deleteDatabase(databaseName: String) throws {
if findCachedDatabase(where: { $0.databaseName == databaseName }) != nil {
throw DeleteDatabaseException(databaseName)
}
if databaseName == MEMORY_DB_NAME {
return
}
guard let path = pathForDatabaseName(name: databaseName) else {
throw Exceptions.FileSystemModuleNotFound()
}
if !FileManager.default.fileExists(atPath: path.absoluteString) {
throw DatabaseNotFoundException(databaseName)
}
do {
try FileManager.default.removeItem(atPath: path.absoluteString)
} catch {
throw DeleteDatabaseFileException(databaseName)
}
}
private func addUpdateHook(_ database: NativeDatabase) {
let contextPair = Unmanaged.passRetained(((self, database) as AnyObject))
contextPairs.append(contextPair)
// swiftlint:disable:next multiline_arguments
sqlite3_update_hook(database.pointer, { obj, action, databaseName, tableName, rowId in
guard let obj,
let tableName,
let pair = Unmanaged<AnyObject>.fromOpaque(obj).takeUnretainedValue() as? (SQLiteModuleNext, NativeDatabase) else {
return
}
let selfInstance = pair.0
let database = pair.1
let databaseFilePath = sqlite3_db_filename(database.pointer, databaseName)
if selfInstance.hasListeners, let databaseName, let databaseFilePath {
selfInstance.sendEvent("onDatabaseChange", [
"databaseName": String(cString: UnsafePointer(databaseName)),
"databaseFilePath": String(cString: UnsafePointer(databaseFilePath)),
"tableName": String(cString: UnsafePointer(tableName)),
"rowId": rowId,
"typeId": SQLAction.fromCode(value: action)
])
}
},
contextPair.toOpaque())
}
private func getColumnNames(statement: NativeStatement) throws -> SQLiteColumnNames {
try maybeThrowForFinalizedStatement(statement)
let columnCount = Int(sqlite3_column_count(statement.pointer))
var columnNames: SQLiteColumnNames = Array(repeating: "", count: columnCount)
for i in 0..<columnCount {
columnNames[i] = String(cString: sqlite3_column_name(statement.pointer, Int32(i)))
}
return columnNames
}
private func getColumnValues(statement: NativeStatement) throws -> SQLiteColumnValues {
try maybeThrowForFinalizedStatement(statement)
let columnCount = Int(sqlite3_column_count(statement.pointer))
var columnValues: SQLiteColumnValues = Array(repeating: 0, count: columnCount)
for i in 0..<columnCount {
columnValues[i] = try getColumnValue(statement: statement, at: Int32(i))
}
return columnValues
}
@inline(__always)
private func getColumnValue(statement: NativeStatement, at index: Int32) throws -> Any {
let instance = statement.pointer
let type = sqlite3_column_type(instance, index)
switch type {
case SQLITE_INTEGER:
return sqlite3_column_int64(instance, index)
case SQLITE_FLOAT:
return sqlite3_column_double(instance, index)
case SQLITE_TEXT:
guard let text = sqlite3_column_text(instance, index) else {
throw InvalidConvertibleException("Null text")
}
return String(cString: text)
case SQLITE_BLOB:
guard let blob = sqlite3_column_blob(instance, index) else {
throw InvalidConvertibleException("Null blob")
}
let size = sqlite3_column_bytes(instance, index)
return Data(bytes: blob, count: Int(size))
case SQLITE_NULL:
return NSNull()
default:
throw InvalidConvertibleException("Unsupported column type: \(type)")
}
}
private func bindStatementParam(statement: NativeStatement, with param: Any, at index: Int32) throws {
let instance = statement.pointer
switch param {
case Optional<Any>.none:
sqlite3_bind_null(instance, index)
case _ as NSNull:
sqlite3_bind_null(instance, index)
case let param as Int64:
sqlite3_bind_int64(instance, index, Int64(param))
case let param as Double:
sqlite3_bind_double(instance, index, param)
case let param as String:
sqlite3_bind_text(instance, index, param, -1, SQLITE_TRANSIENT)
case let param as Data:
_ = param.withUnsafeBytes {
sqlite3_bind_blob(instance, index, $0.baseAddress, Int32(param.count), SQLITE_TRANSIENT)
}
case let param as Bool:
sqlite3_bind_int(instance, index, param ? 1 : 0)
default:
throw InvalidConvertibleException("Unsupported parameter type: \(type(of: param))")
}
}
private func maybeThrowForClosedDatabase(_ database: NativeDatabase) throws {
if database.isClosed {
throw AccessClosedResourceException()
}
}
private func maybeThrowForFinalizedStatement(_ statement: NativeStatement) throws {
if statement.isFinalized {
throw AccessClosedResourceException()
}
}
@inline(__always)
private func getBindParamIndex(statement: NativeStatement, key: String, shouldPassAsArray: Bool) throws -> Int32 {
let index: Int32
if shouldPassAsArray {
guard let intKey = Int32(key) else {
throw InvalidBindParameterException()
}
index = intKey + 1
} else {
index = sqlite3_bind_parameter_index(statement.pointer, key.cString(using: .utf8))
}
return index
}
// MARK: - cachedDatabases managements
private func addCachedDatabase(_ database: NativeDatabase) {
Self.lockQueue.sync {
cachedDatabases.append(database)
}
}
@discardableResult
private func removeCachedDatabase(of database: NativeDatabase) -> NativeDatabase? {
return Self.lockQueue.sync {
if let index = cachedDatabases.firstIndex(of: database) {
let database = cachedDatabases[index]
cachedDatabases.remove(at: index)
return database
}
return nil
}
}
private func findCachedDatabase(where predicate: (NativeDatabase) -> Bool) -> NativeDatabase? {
return Self.lockQueue.sync {
if let database = cachedDatabases.first(where: predicate) {
return database
}
return nil
}
}
private func removeAllCachedDatabases() -> [NativeDatabase] {
return Self.lockQueue.sync {
let databases = cachedDatabases
cachedDatabases.removeAll()
return databases
}
}
// MARK: - cachedStatements managements
private func maybeAddCachedStatement(database: NativeDatabase, statement: NativeStatement) {
if !database.openOptions.finalizeUnusedStatementsBeforeClosing {
return
}
Self.lockQueue.sync {
if cachedStatements[database] != nil {
cachedStatements[database]?.append(statement)
} else {
cachedStatements[database] = [statement]
}
}
}
private func maybeRemoveCachedStatement(database: NativeDatabase, statement: NativeStatement) {
if !database.openOptions.finalizeUnusedStatementsBeforeClosing {
return
}
Self.lockQueue.sync {
if let index = cachedStatements[database]?.firstIndex(of: statement) {
cachedStatements[database]?.remove(at: index)
}
}
}
private func maybeRemoveAllCachedStatements(database: NativeDatabase) -> [NativeStatement] {
if !database.openOptions.finalizeUnusedStatementsBeforeClosing {
return []
}
return Self.lockQueue.sync {
if let statements = cachedStatements[database] {
cachedStatements.removeValue(forKey: database)
return statements
}
return []
}
}
}