@capacitor-community/sqlite 3.3.2 → 3.3.3-4

package/ios/Plugin/CapacitorSQLite.swift

@@ -5,7 +5,19 @@ enum CapacitorSQLiteError: Error {
 // swiftlint:disable file_length
 // swiftlint:disable type_body_length
 @objc public class CapacitorSQLite: NSObject {
+    private var config: SqliteConfig
     private var dbDict: [String: Database] = [:]
+    private var databaseLocation: String
+
+    init(config: SqliteConfig) {
+        self.config = config
+        if let isLocation = config.iosDatabaseLocation {
+            self.databaseLocation = isLocation
+        } else {
+            self.databaseLocation = "Documents"
+        }
+        super.init()
+    }
 
     // MARK: - Echo
 
@@ -31,7 +43,9 @@ enum CapacitorSQLiteError: Error {
             // close all connections
             try closeAllConnections()
             // set encryption secret
-            try UtilsSecret.setEncryptionSecret(passphrase: passphrase)
+            try UtilsSecret
+                .setEncryptionSecret(passphrase: passphrase,
+                                     databaseLocation: databaseLocation)
             return
         } catch UtilsSecretError.setEncryptionSecret(let message) {
             throw CapacitorSQLiteError.failed(message: message)
@@ -48,7 +62,10 @@ enum CapacitorSQLiteError: Error {
             // close all connections
             try closeAllConnections()
             // set encryption secret
-            try UtilsSecret.changeEncryptionSecret(passphrase: passphrase, oldPassphrase: oldPassphrase)
+            try UtilsSecret
+                .changeEncryptionSecret(passphrase: passphrase,
+                                        oldPassphrase: oldPassphrase,
+                                        databaseLocation: databaseLocation)
             return
         } catch UtilsSecretError.changeEncryptionSecret(let message) {
             throw CapacitorSQLiteError.failed(message: message)
@@ -57,6 +74,68 @@ enum CapacitorSQLiteError: Error {
         }
 
     }
+    // MARK: - getNCDatabasePath
+
+    @objc public func getNCDatabasePath(_ folderPath: String, dbName: String ) throws -> String {
+        do {
+            let databasePath: String = try UtilsNCDatabase
+                .getNCDatabasePath(folderPath: folderPath,
+                                   database: dbName )
+            return databasePath
+        } catch let error {
+            throw CapacitorSQLiteError.failed(message: "\(error)")
+        }
+
+    }
+
+    // MARK: - CreateNCConnection
+
+    @objc public func createNCConnection(_ databasePath: String,
+                                         version: Int) throws {
+
+        // check if the connection already exists
+        let conn = dbDict[databasePath]
+        if conn != nil {
+            let msg = "Connection \(databasePath) already exists"
+            throw CapacitorSQLiteError.failed(message: msg)
+        }
+
+        do {
+            let isFileExists: Bool = UtilsFile
+                .isFileExist(filePath: databasePath)
+
+            if !isFileExists {
+                throw CapacitorSQLiteError.failed(message: "database \(databasePath) does not exist")
+            }
+            let mDb: Database = try Database(
+                databaseLocation: databaseLocation,
+                databaseName: databasePath,
+                encrypted: false, mode: "no-encryption", version: version,
+                vUpgDict: [:])
+            dbDict[databasePath] = mDb
+            return
+        } catch let error {
+            throw CapacitorSQLiteError.failed(message: "\(error)")
+        }
+    }
+
+    // MARK: - CloseNCConnection
+
+    @objc public func closeNCConnection(_ dbName: String) throws {
+        guard let mDb: Database = dbDict[dbName] else {
+            let msg = "Connection to \(dbName) not available"
+            throw CapacitorSQLiteError.failed(message: msg)
+        }
+        if mDb.isDBOpen() {
+            do {
+                try mDb.close()
+            } catch DatabaseError.close(let message) {
+                throw CapacitorSQLiteError.failed(message: message)
+            }
+        }
+        dbDict.removeValue(forKey: dbName)
+        return
+    }
 
     // MARK: - CreateConnection
 
@@ -75,6 +154,7 @@ enum CapacitorSQLiteError: Error {
 
         do {
             let mDb: Database = try Database(
+                databaseLocation: databaseLocation,
                 databaseName: "\(mDbName)SQLite.db",
                 encrypted: encrypted, mode: mode, version: version,
                 vUpgDict: vUpgDict)
@@ -117,6 +197,22 @@ enum CapacitorSQLiteError: Error {
         }
     }
 
+    // MARK: - getUrl
+
+    @objc public func getUrl(_ dbName: String) throws -> String {
+        let mDbName = CapacitorSQLite.getDatabaseName(dbName: dbName)
+        guard let mDb: Database = dbDict[mDbName] else {
+            let msg = "Connection to \(mDbName) not available"
+            throw CapacitorSQLiteError.failed(message: msg)
+        }
+        do {
+            let res: String = try mDb.getUrl()
+            return res
+        } catch DatabaseError.close(let message) {
+            throw CapacitorSQLiteError.failed(message: message)
+        }
+    }
+
     // MARK: - GetVersion
 
     @objc public func getVersion(_ dbName: String) throws ->  NSNumber {
@@ -133,6 +229,7 @@ enum CapacitorSQLiteError: Error {
             throw CapacitorSQLiteError.failed(message: message)
         }
     }
+
     // MARK: - Close Connection
 
     @objc public func closeConnection(_ dbName: String) throws {
@@ -193,12 +290,26 @@ enum CapacitorSQLiteError: Error {
             throw CapacitorSQLiteError.failed(message: "\(error)")
         }
     }
+
     // MARK: - IsDatabase
 
     @objc public func isDatabase(_ dbName: String) throws -> NSNumber {
         let mDbName = CapacitorSQLite.getDatabaseName(dbName: dbName)
         let isFileExists: Bool = UtilsFile
-            .isFileExist(fileName: mDbName + "SQLite.db")
+            .isFileExist(databaseLocation: databaseLocation,
+                         fileName: mDbName + "SQLite.db")
+        if isFileExists {
+            return 1
+        } else {
+            return 0
+        }
+    }
+
+    // MARK: - IsNCDatabase
+
+    @objc public func isNCDatabase(_ databasePath: String) throws -> NSNumber {
+        let isFileExists: Bool = UtilsFile
+            .isFileExist(filePath: databasePath)
         if isFileExists {
             return 1
         } else {
@@ -244,7 +355,7 @@ enum CapacitorSQLiteError: Error {
             let msg = "Connection to \(mDbName) not available"
             throw CapacitorSQLiteError.failed(message: msg)
         }
-        if mDb.isDBOpen() {
+        if !mDb.isNCDB() && mDb.isDBOpen() {
             do {
                 var stmts = statements
                 // remove carriage returns
@@ -268,7 +379,7 @@ enum CapacitorSQLiteError: Error {
                 throw CapacitorSQLiteError.failed(message: msg)
             }
         } else {
-            let msg = "Database \(mDbName) not opened"
+            let msg = "Database \(mDbName) not opened or in read-only"
             throw CapacitorSQLiteError.failed(message: msg)
         }
     }
@@ -283,7 +394,7 @@ enum CapacitorSQLiteError: Error {
             let msg = "Connection to \(mDbName) not available"
             throw CapacitorSQLiteError.failed(message: msg)
         }
-        if mDb.isDBOpen() {
+        if !mDb.isNCDB() && mDb.isDBOpen() {
             do {
                 let res = try mDb.execSet(set: set, transaction: transaction)
                 return res
@@ -294,7 +405,7 @@ enum CapacitorSQLiteError: Error {
                 throw CapacitorSQLiteError.failed(message: msg)
             }
         } else {
-            let msg = "Database \(mDbName) not opened"
+            let msg = "Database \(mDbName) not opened or in read-only"
             throw CapacitorSQLiteError.failed(message: msg)
         }
     }
@@ -310,7 +421,7 @@ enum CapacitorSQLiteError: Error {
             let msg = "Connection to \(mDbName) not available"
             throw CapacitorSQLiteError.failed(message: msg)
         }
-        if mDb.isDBOpen() {
+        if !mDb.isNCDB() && mDb.isDBOpen() {
             do {
                 var val: [Any] = []
                 if values.count > 0 {
@@ -343,7 +454,7 @@ enum CapacitorSQLiteError: Error {
                 throw CapacitorSQLiteError.failed(message: msg)
             }
         } else {
-            let msg = "Database \(mDbName) not opened"
+            let msg = "Database \(mDbName) not opened or in read-only"
             throw CapacitorSQLiteError.failed(message: msg)
         }
     }
@@ -384,7 +495,8 @@ enum CapacitorSQLiteError: Error {
             throw CapacitorSQLiteError.failed(message: msg)
         }
         let res: Bool = UtilsFile
-            .isFileExist(fileName: "\(mDbName)SQLite.db")
+            .isFileExist(databaseLocation: databaseLocation,
+                         fileName: "\(mDbName)SQLite.db")
         if res {
             return 1
         } else {
@@ -421,8 +533,7 @@ enum CapacitorSQLiteError: Error {
             if !mDb.isDBOpen() {
                 try mDb.open()
             }
-            let res: Bool = try mDb.deleteDB(
-                databaseName: "\(mDbName)SQLite.db")
+            let res: Bool = try mDb.deleteDB(databaseName: "\(mDbName)SQLite.db")
             if res {
                 return
             } else {
@@ -483,6 +594,7 @@ enum CapacitorSQLiteError: Error {
             // open the database
             do {
                 mDb = try Database(
+                    databaseLocation: databaseLocation,
                     databaseName: dbName, encrypted: encrypted,
                     mode: inMode, version: version, vUpgDict: [:])
                 try mDb.open()
@@ -685,7 +797,7 @@ enum CapacitorSQLiteError: Error {
             let aPath: String = assetsDbPath.path
             let bRes: Bool = UtilsFile.isDirExist(dirPath: aPath)
             if bRes {
-                // get the database files
+                // get the database files from assets
                 let dbList: [String] = try UtilsFile
                     .getFileList(path: aPath, ext: ".db")
                 // loop through the database files
@@ -697,7 +809,8 @@ enum CapacitorSQLiteError: Error {
                     // for each copy the file to the Application
                     // database folder
                     _ = try UtilsFile
-                        .copyFromAssetToDatabase(fromDb: mDb,
+                        .copyFromAssetToDatabase(databaseLocation: databaseLocation,
+                                                 fromDb: mDb,
                                                  toDb: toDb, overwrite: overwrite)
                 }
                 // get the zip files
@@ -708,7 +821,8 @@ enum CapacitorSQLiteError: Error {
                     // for each zip uncompress the file to the Application
                     // database folder
                     _ = try UtilsFile
-                        .unzipFromAssetToDatabase(zip: zip, overwrite: overwrite)
+                        .unzipFromAssetToDatabase(databaseLocation: databaseLocation,
+                                                  zip: zip, overwrite: overwrite)
                 }
                 return
             } else {
@@ -729,7 +843,7 @@ enum CapacitorSQLiteError: Error {
 
     @objc func getDatabaseList() throws -> [String] {
         do {
-            let aPath: String = try UtilsFile.getDatabasesPath()
+            let aPath: String = try (UtilsFile.getFolderURL(folderPath: databaseLocation)).path
             // get the database files
             let dbList: [String] = try UtilsFile.getFileList(path: aPath, ext: ".db")
             return dbList
@@ -765,7 +879,9 @@ enum CapacitorSQLiteError: Error {
     @objc func addSQLiteSuffix(_ folderPath: String, dbList: [String]) throws {
 
         do {
-            try UtilsMigrate.addSQLiteSuffix(folderPath: folderPath, dbList: dbList)
+            try UtilsMigrate.addSQLiteSuffix(databaseLocation: databaseLocation,
+                                             folderPath: folderPath,
+                                             dbList: dbList)
             return
         } catch UtilsMigrateError.addSQLiteSuffix(let message) {
             var msg: String = "addSQLiteSuffix:"
@@ -783,7 +899,8 @@ enum CapacitorSQLiteError: Error {
 
     @objc func deleteOldDatabases(_ folderPath: String, dbList: [String]) throws {
         do {
-            try UtilsMigrate.deleteOldDatabases(folderPath: folderPath, dbList: dbList)
+            try UtilsMigrate
+                .deleteOldDatabases(folderPath: folderPath, dbList: dbList)
             return
         } catch UtilsMigrateError.deleteOldDatabases(let message) {
             var msg: String = "deleteOldDatabases:"
@@ -799,8 +916,10 @@ enum CapacitorSQLiteError: Error {
     }
     class func getDatabaseName(dbName: String) -> String {
         var retName: String = dbName
-        if retName.suffix(3) == ".db" {
-            retName = String(retName.dropLast(3))
+        if !retName.contains("/") {
+            if retName.suffix(3) == ".db" {
+                retName = String(retName.dropLast(3))
+            }
         }
         return retName
     }

package/ios/Plugin/CapacitorSQLitePlugin.m

@@ -7,8 +7,12 @@ CAP_PLUGIN(CapacitorSQLitePlugin, "CapacitorSQLite",
            CAP_PLUGIN_METHOD(echo, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(createConnection, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(closeConnection, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(createNCConnection, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(closeNCConnection, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(getNCDatabasePath, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(open, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(close, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(getUrl, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getVersion, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(execute, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(executeSet, CAPPluginReturnPromise);
@@ -26,6 +30,7 @@ CAP_PLUGIN(CapacitorSQLitePlugin, "CapacitorSQLite",
            CAP_PLUGIN_METHOD(addUpgradeStatement, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(copyFromAssets, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(isDatabase, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(isNCDatabase, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(isTableExists, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getDatabaseList, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getMigratableDbList, CAPPluginReturnPromise);