@capacitor-community/sqlite 3.3.1 → 3.3.3-3

package/ios/Plugin/Utils/UtilsMigrate.swift

@@ -9,23 +9,22 @@ enum UtilsMigrateError: Error {
     case addSQLiteSuffix(message: String)
     case getMigratableList(message: String)
     case deleteOldDatabases(message: String)
-    case getFolderURL(message: String)
 }
 
 class UtilsMigrate {
 
-    // MARK: - addSQLiteSuffix
+    // MARK: - getMigratableList
 
     class func getMigratableList(folderPath: String) throws -> [String] {
         var mDbList: [String] = []
         do {
-            let dbPathURL: URL = try UtilsMigrate
+            let dbPathURL: URL = try UtilsFile
                 .getFolderURL(folderPath: folderPath)
             var isDir = ObjCBool(true)
             if FileManager.default.fileExists(atPath: dbPathURL.relativePath,
                                               isDirectory: &isDir) &&
                 isDir.boolValue {
-                mDbList = try UtilsFile.getFileList(path: dbPathURL.relativePath, ext: ".db")
+                mDbList = try UtilsFile.getFileList(path: dbPathURL.relativePath, ext: nil)
 
                 return mDbList
             } else {
@@ -34,9 +33,9 @@ class UtilsMigrate {
                 throw UtilsMigrateError.getMigratableList(message: msg)
             }
 
-        } catch UtilsFileError.getDatabasesURLFailed {
+        } catch UtilsFileError.getFolderURLFailed {
             throw UtilsMigrateError
-            .getMigratableList(message: "getDatabasesURLFailed")
+            .getMigratableList(message: "getFolderURLFailed")
         } catch UtilsFileError.getFileListFailed {
             throw UtilsMigrateError.getMigratableList(message: "getFileListFailed")
         } catch let error {
@@ -47,24 +46,48 @@ class UtilsMigrate {
     }
 
     // MARK: - addSQLiteSuffix
+
     // swiftlint:disable function_body_length
-    class func addSQLiteSuffix(folderPath: String, dbList: [String]) throws {
+    // swiftlint:disable cyclomatic_complexity
+    class func addSQLiteSuffix(databaseLocation: String, folderPath: String,
+                               dbList: [String]) throws {
         var fromFile: String = ""
         var toFile: String = ""
         do {
-            let databaseURL = try UtilsFile.getDatabasesUrl().absoluteURL
-            let dbPathURL: URL = try UtilsMigrate
+            let databaseURL: URL = try UtilsFile
+                .getFolderURL(folderPath: databaseLocation)
+            let dbPathURL: URL = try UtilsFile
                 .getFolderURL(folderPath: folderPath)
             var isDir = ObjCBool(true)
             if FileManager.default.fileExists(atPath: dbPathURL.relativePath,
                                               isDirectory: &isDir) &&
                 isDir.boolValue {
-                let mDbList: [String] = try UtilsFile
-                    .getFileList(path: dbPathURL.relativePath, ext: ".db")
+                var mDbList: [String]
+                if dbList.count > 0 {
+                    mDbList = try UtilsFile
+                        .getFileList(path: dbPathURL.relativePath, ext: nil)
+                } else {
+                    mDbList = try UtilsFile
+                        .getFileList(path: dbPathURL.relativePath, ext: "db")
+                }
                 for file: String in mDbList {
                     if !file.contains("SQLite.db") {
                         fromFile = file
-                        if dbList.contains(fromFile) {
+                        if dbList.count > 0 {
+                            if dbList.contains(fromFile) {
+                                if String(file.suffix(3)) == ".db" {
+                                    toFile = file
+                                        .replacingOccurrences(of: ".db", with: "SQLite.db")
+                                } else {
+                                    toFile = file + "SQLite.db"
+                                }
+                                try UtilsFile
+                                    .copyFromNames(dbPathURL: dbPathURL,
+                                                   fromFile: fromFile,
+                                                   databaseURL: databaseURL,
+                                                   toFile: toFile)
+                            }
+                        } else {
                             toFile = file
                                 .replacingOccurrences(of: ".db", with: "SQLite.db")
                             try UtilsFile
@@ -84,7 +107,7 @@ class UtilsMigrate {
         } catch UtilsFileError.getDatabasesURLFailed {
             throw UtilsMigrateError
             .addSQLiteSuffix(message: "getDatabasesURLFailed")
-        } catch UtilsMigrateError.getFolderURL(let message) {
+        } catch UtilsFileError.getFolderURLFailed(let message) {
             throw UtilsMigrateError.addSQLiteSuffix(message: message)
         } catch UtilsFileError.getFileListFailed {
             throw UtilsMigrateError.addSQLiteSuffix(message: "getFileListFailed")
@@ -98,28 +121,50 @@ class UtilsMigrate {
             throw UtilsMigrateError.addSQLiteSuffix(message: msg)
         }
     }
+    // swiftlint:enable cyclomatic_complexity
     // swiftlint:enable function_body_length
 
     // MARK: - deleteOldDatabase
+
+    // swiftlint:disable function_body_length
+    // swiftlint:disable cyclomatic_complexity
     class func deleteOldDatabases(folderPath: String, dbList: [String]) throws {
         do {
-            let dbPathURL: URL = try UtilsMigrate
+            let dbPathURL: URL = try UtilsFile
                 .getFolderURL(folderPath: folderPath)
             var isDir = ObjCBool(true)
             if FileManager.default.fileExists(atPath: dbPathURL.relativePath,
                                               isDirectory: &isDir) &&
                 isDir.boolValue {
-                let mDbList: [String] = try UtilsFile
-                    .getFileList(path: dbPathURL.relativePath, ext: ".db")
+                var mDbList: [String]
+                if dbList.count > 0 {
+                    mDbList = try UtilsFile
+                        .getFileList(path: dbPathURL.relativePath, ext: nil)
+                } else {
+                    mDbList = try UtilsFile
+                        .getFileList(path: dbPathURL.relativePath, ext: "db")
+                }
                 for file: String in mDbList {
                     if !file.contains("SQLite.db") {
-                        if dbList.contains(file) {
-                            let ret: Bool = try UtilsFile
-                                .deleteFile(dbPathURL: dbPathURL, fileName: file)
-                            if !ret {
-                                throw UtilsMigrateError
-                                .deleteOldDatabases(message: "deleteFileFailed")
+                        if dbList.count > 0 {
+                            if dbList.contains(file) {
+                                let ret: Bool = try UtilsFile
+                                    .deleteFile(dbPathURL: dbPathURL, fileName: file)
+                                if !ret {
+                                    throw UtilsMigrateError
+                                    .deleteOldDatabases(message: "deleteFileFailed")
+                                }
+                            }
+                        } else {
+                            if file.contains(".db") {
+                                let ret: Bool = try UtilsFile
+                                    .deleteFile(dbPathURL: dbPathURL, fileName: file)
+                                if !ret {
+                                    throw UtilsMigrateError
+                                    .deleteOldDatabases(message: "deleteFileFailed")
+                                }
                             }
+
                         }
                     }
                 }
@@ -132,7 +177,7 @@ class UtilsMigrate {
         } catch UtilsFileError.getDatabasesURLFailed {
             throw UtilsMigrateError
             .addSQLiteSuffix(message: "getDatabasesURLFailed")
-        } catch UtilsMigrateError.getFolderURL(let message) {
+        } catch UtilsFileError.getFolderURLFailed(let message) {
             throw UtilsMigrateError.addSQLiteSuffix(message: message)
         } catch UtilsFileError.getFileListFailed {
             throw UtilsMigrateError.addSQLiteSuffix(message: "getFileListFailed")
@@ -144,39 +189,7 @@ class UtilsMigrate {
             throw UtilsMigrateError.addSQLiteSuffix(message: msg)
         }
     }
-
-    // MARK: - getFolderURL
-    class func getFolderURL(folderPath: String) throws -> URL {
-        do {
-            let databaseURL = try UtilsFile.getDatabasesUrl().absoluteURL
-            var dbPathURL: URL
-            let first = folderPath.split(separator: "/", maxSplits: 1)
-            if first[0] == "Applications" {
-                dbPathURL = try UtilsFile.getApplicationURL().absoluteURL
-            } else if first[0] == "Library" {
-                dbPathURL = try UtilsFile.getLibraryURL().absoluteURL
-            } else if first[0] == "Documents" || first[0] == "default" {
-                dbPathURL = databaseURL
-            } else {
-                var msg: String = "addSQLiteSuffix command failed :"
-                msg.append(" Folder '\(first[0])' not allowed")
-                throw UtilsMigrateError.getFolderURL(message: msg)
-            }
-            if first.count > 1 {
-                dbPathURL = dbPathURL
-                    .appendingPathComponent(String(first[1])).absoluteURL
-            }
-            return dbPathURL
-        } catch UtilsFileError.getDatabasesURLFailed {
-            throw UtilsMigrateError.getFolderURL(message: "getDatabasesURLFailed")
-        } catch UtilsFileError.getApplicationURLFailed {
-            throw UtilsMigrateError
-            .getFolderURL(message: "getApplicationURLFailed")
-        } catch let error {
-            var msg: String = "getFolderURL command failed :"
-            msg.append(" \(error.localizedDescription)")
-            throw UtilsMigrateError.getFolderURL(message: msg)
-        }
-    }
+    // swiftlint:enable cyclomatic_complexity
+    // swiftlint:enable function_body_length
 
 }

package/ios/Plugin/Utils/UtilsNCDatabase.swift

@@ -0,0 +1,31 @@
+//
+//  UtilsNCDatabase.swift
+//  CapacitorCommunitySqlite
+//
+//  Created by  Quéau Jean Pierre on 17/12/2021.
+//
+
+import Foundation
+enum UtilsNCDatabaseError: Error {
+    case getNCDatabasePath(message: String)
+}
+
+class UtilsNCDatabase {
+
+    // MARK: - getNCDatabasePath
+
+    class func getNCDatabasePath(folderPath: String, database: String) throws -> String {
+        do {
+            let dbPathURL: URL = try UtilsFile
+                .getFolderURL(folderPath: folderPath)
+            return dbPathURL.appendingPathComponent("\(database)").path
+        } catch UtilsFileError.getFolderURLFailed(let message) {
+            throw UtilsNCDatabaseError.getNCDatabasePath(message: message)
+        } catch let error {
+            var msg: String = "getNCDatabasePath command failed :"
+            msg.append(" \(error.localizedDescription)")
+            throw UtilsNCDatabaseError.getNCDatabasePath(message: msg)
+        }
+
+    }
+}

package/ios/Plugin/Utils/UtilsSQLCipher.swift

@@ -43,9 +43,12 @@ enum State: String {
 // swiftlint:disable type_body_length
 class UtilsSQLCipher {
 
-    class func getDatabaseState(databaseName: String) -> State {
+    class func getDatabaseState(databaseLocation: String,
+                                databaseName: String) -> State {
         do {
-            let path: String  = try UtilsFile.getFilePath(fileName: databaseName)
+            let path: String  = try UtilsFile
+                .getFilePath(databaseLocation: databaseLocation,
+                             fileName: databaseName)
             if UtilsFile.isFileExist(filePath: path) {
                 do {
                     try openDBNoPassword(dBPath: path)
@@ -586,17 +589,17 @@ class UtilsSQLCipher {
 
     // MARK: - DeleteDB
 
-    class func deleteDB(databaseName: String) throws {
-        if let dir = FileManager.default.urls(
-            for: .documentDirectory,
-            in: .userDomainMask).first {
+    class func deleteDB(databaseLocation: String, databaseName: String) throws {
+        do {
+            let dir: URL = try UtilsFile
+                .getFolderURL(folderPath: databaseLocation)
+
             let fileURL = dir.appendingPathComponent(databaseName)
             let isFileExists = FileManager.default.fileExists(
                 atPath: fileURL.path)
             if isFileExists {
                 do {
                     try FileManager.default.removeItem(at: fileURL)
-                    print("Database \(databaseName) deleted")
                 } catch let error {
                     var msg: String = "Error: deleteDB: "
                     msg.append(" \(error.localizedDescription)")
@@ -604,6 +607,9 @@ class UtilsSQLCipher {
                         message: msg)
                 }
             }
+        } catch UtilsFileError.getFolderURLFailed(let message) {
+            let msg = "Error: deleteDB: \(message)"
+            throw UtilsSQLCipherError.deleteDB(message: msg)
         }
     }
 
@@ -663,10 +669,11 @@ class UtilsSQLCipher {
 
     // MARK: - RestoreDB
 
-    class func restoreDB(databaseName: String) throws {
-        if let dir = FileManager.default.urls(
-            for: .documentDirectory,
-            in: .userDomainMask).first {
+    class func restoreDB(databaseLocation: String, databaseName: String) throws {
+        do {
+            let dir: URL = try UtilsFile
+                .getFolderURL(folderPath: databaseLocation)
+
             let fileURL = dir.appendingPathComponent(databaseName)
             let backupURL = dir
                 .appendingPathComponent("backup-\(databaseName)")
@@ -678,13 +685,11 @@ class UtilsSQLCipher {
                 if isFileExists {
                     do {
                         try FileManager.default.removeItem(at: fileURL)
-                        print("Database \(databaseName) deleted")
                         try FileManager
                             .default.copyItem(atPath: backupURL.path,
                                               toPath: fileURL.path)
                         try FileManager.default
                             .removeItem(at: backupURL)
-                        print("Database backup-\(databaseName) deleted")
                     } catch {
                         var msg = "Error: restoreDB : \(databaseName)"
                         msg += " \(error)"
@@ -704,19 +709,20 @@ class UtilsSQLCipher {
                 throw UtilsSQLCipherError.restoreDB(
                     message: msg)
             }
-        } else {
-            let msg = "Error: restoreDB: FileManager.default.urls"
-            throw UtilsSQLCipherError.restoreDB(
-                message: msg)
+        } catch UtilsFileError.getFolderURLFailed(let message) {
+            let msg = "Error: restoreDB: \(message)"
+            throw UtilsSQLCipherError.restoreDB(message: msg)
         }
     }
 
     // MARK: - deleteBackupDB
 
-    class func deleteBackupDB(databaseName: String) throws {
-        if let dir = FileManager.default.urls(
-            for: .documentDirectory,
-            in: .userDomainMask).first {
+    class func deleteBackupDB(databaseLocation: String,
+                              databaseName: String) throws {
+
+        do {
+            let dir: URL = try UtilsFile
+                .getFolderURL(folderPath: databaseLocation)
             let backupURL = dir
                 .appendingPathComponent("backup-\(databaseName)")
             let isBackupExists = FileManager.default.fileExists(
@@ -725,7 +731,6 @@ class UtilsSQLCipher {
                 do {
                     try FileManager.default
                         .removeItem(at: backupURL)
-                    print("Database backup-\(databaseName) deleted")
                 } catch {
                     var msg = "Error: deleteBackupDB : \(databaseName)"
                     msg += " \(error)"
@@ -737,8 +742,8 @@ class UtilsSQLCipher {
                 msg.append("backup-\(databaseName) does not exist")
                 throw UtilsSQLCipherError.deleteBackupDB(message: msg)
             }
-        } else {
-            let msg = "Error: deleteBackupDB: FileManager.default.urls"
+        } catch UtilsFileError.getFolderURLFailed(let message) {
+            let msg = "Error: deleteBackupDB: \(message)"
             throw UtilsSQLCipherError.deleteBackupDB(
                 message: msg)
         }

package/ios/Plugin/Utils/UtilsSecret.swift

@@ -85,7 +85,9 @@ class UtilsSecret {
 
     // MARK: - SetEncryptionSecret
 
-    class func setEncryptionSecret(passphrase: String) throws {
+    // swiftlint:disable function_body_length
+    class func setEncryptionSecret(passphrase: String,
+                                   databaseLocation: String) throws {
         do {
             if passphrase.isEmpty {
                 let msg: String = "passphrase must not be empty"
@@ -102,13 +104,16 @@ class UtilsSecret {
                 let dbList: [String] = try UtilsFile
                     .getFileList(path: databaseURL.relativePath, ext: ".db")
                 for file: String in dbList {
-                    let state: State = UtilsSQLCipher.getDatabaseState(databaseName: file)
+                    let state: State = UtilsSQLCipher
+                        .getDatabaseState(databaseLocation: databaseLocation,
+                                          databaseName: file)
                     if state.rawValue == "ENCRYPTEDGLOBALSECRET" {
                         let globalData: GlobalSQLite = GlobalSQLite()
                         let password: String = globalData.secret
 
                         let dbPath: String  = try UtilsFile
-                            .getFilePath(fileName: file)
+                            .getFilePath(databaseLocation: databaseLocation,
+                                         fileName: file)
                         try UtilsSQLCipher.changePassword(filename: dbPath,
                                                           password: password,
                                                           newpassword: passphrase)
@@ -135,10 +140,14 @@ class UtilsSecret {
         }
 
     }
+    // swiftlint:enable function_body_length
 
     // MARK: - ChangeEncryptionSecret
 
-    class func changeEncryptionSecret(passphrase: String, oldPassphrase: String) throws {
+    // swiftlint:disable function_body_length
+    class func changeEncryptionSecret(passphrase: String,
+                                      oldPassphrase: String,
+                                      databaseLocation: String) throws {
         do {
             if passphrase.isEmpty ||  oldPassphrase.isEmpty {
                 let msg: String = "Passphrase and/or oldpassphrase must not " +
@@ -153,18 +162,22 @@ class UtilsSecret {
                 let msg: String = "Given oldpassphrase is wrong"
                 throw UtilsSecretError.changeEncryptionSecret(message: msg)
             }
-            // get the list of databases
-            let databaseURL: URL = try UtilsFile.getDatabasesUrl().absoluteURL
+            // get the list of databases from the database folder
+            let databaseURL: URL = try UtilsFile
+                .getFolderURL(folderPath: databaseLocation).absoluteURL
             var isDir = ObjCBool(true)
             if FileManager.default.fileExists(atPath: databaseURL.relativePath,
                                               isDirectory: &isDir) && isDir.boolValue {
                 let dbList: [String] = try UtilsFile
                     .getFileList(path: databaseURL.relativePath, ext: ".db")
                 for file: String in dbList {
-                    let state: State = UtilsSQLCipher.getDatabaseState(databaseName: file)
+                    let state: State = UtilsSQLCipher
+                        .getDatabaseState(databaseLocation: databaseLocation,
+                                          databaseName: file)
                     if state.rawValue == "ENCRYPTEDSECRET" {
                         let dbPath: String  = try UtilsFile
-                            .getFilePath(fileName: file)
+                            .getFilePath(databaseLocation: databaseLocation,
+                                         fileName: file)
                         try UtilsSQLCipher.changePassword(filename: dbPath,
                                                           password: oldPassphrase,
                                                           newpassword: passphrase)
@@ -193,5 +206,6 @@ class UtilsSecret {
         }
 
     }
+    // swiftlint:enable function_body_length
 
 }

package/ios/Plugin/Utils/UtilsUpgrade.swift

@@ -33,10 +33,12 @@ class UtilsUpgrade {
 
     // swiftlint:disable cyclomatic_complexity
     // swiftlint:disable function_body_length
+    // swiftlint:disable function_parameter_count
     func onUpgrade(mDB: Database,
                    upgDict: [Int: [String: Any]],
                    dbName: String, currentVersion: Int,
-                   targetVersion: Int) throws -> Int {
+                   targetVersion: Int,
+                   databaseLocation: String) throws -> Int {
 
         var changes: Int = -1
         guard let upgrade: [String: Any] = upgDict[currentVersion]
@@ -76,7 +78,8 @@ class UtilsUpgrade {
                                                  toggle: false)
             // backup the database
             _ = try UtilsFile.copyFile(fileName: dbName,
-                                       toFileName: "backup-\(dbName)")
+                                       toFileName: "backup-\(dbName)",
+                                       databaseLocation: databaseLocation)
 
             let initChanges = UtilsSQLCipher.dbChanges(mDB: mDB.mDb)
 
@@ -121,6 +124,7 @@ class UtilsUpgrade {
                 message: message)
         }
     }
+    // swiftlint:enable function_parameter_count
     // swiftlint:enable function_body_length
     // swiftlint:enable cyclomatic_complexity
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/sqlite",
-  "version": "3.3.1",
+  "version": "3.3.3-3",
   "description": "Community plugin for native & electron SQLite databases",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -55,10 +55,10 @@
     "prepublishOnly": "npm run build && npm run build-electron && npm run docgen"
   },
   "devDependencies": {
-    "@capacitor/android": "^3.3.1",
-    "@capacitor/core": "3.3.1",
+    "@capacitor/android": "^3.3.3",
+    "@capacitor/core": "3.3.3",
     "@capacitor/docgen": "^0.0.17",
-    "@capacitor/ios": "^3.3.1",
+    "@capacitor/ios": "^3.3.3",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "^1.0.1",
     "@ionic/swiftlint-config": "^1.1.2",
@@ -74,7 +74,7 @@
     "typescript": "~4.0.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "^3.3.1"
+    "@capacitor/core": "^3.3.3"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",