@capacitor-community/sqlite 3.2.5-1 → 3.3.2

package/electron/rollup.config.js

@@ -12,6 +12,6 @@ export default {
       exports: 'named',
     },
   ],
-  external: ['@capacitor/core', 'sqlite3', 'path', 'fs', 'os'],
+  external: ['@capacitor/core', 'sqlite3', 'path', 'fs', 'os', 'jszip'],
   plugins: [nodeResolve(), commonjs()],
 };

package/ios/Plugin/CapacitorSQLite.swift

@@ -676,7 +676,7 @@ enum CapacitorSQLiteError: Error {
 
     // MARK: - copyFromAssets
 
-    @objc func copyFromAssets() throws {
+    @objc func copyFromAssets(overwrite: Bool) throws {
 
         // check if the assets/database folder exists
         do {
@@ -687,7 +687,7 @@ enum CapacitorSQLiteError: Error {
             if bRes {
                 // get the database files
                 let dbList: [String] = try UtilsFile
-                    .getFileList(path: aPath)
+                    .getFileList(path: aPath, ext: ".db")
                 // loop through the database files
                 for mDb in dbList {
                     // for each check if the suffix SQLite.db is there
@@ -698,13 +698,27 @@ enum CapacitorSQLiteError: Error {
                     // database folder
                     _ = try UtilsFile
                         .copyFromAssetToDatabase(fromDb: mDb,
-                                                 toDb: toDb)
+                                                 toDb: toDb, overwrite: overwrite)
+                }
+                // get the zip files
+                let zipList: [String] = try UtilsFile
+                    .getFileList(path: aPath, ext: ".zip")
+                // loop through the database files
+                for zip in zipList {
+                    // for each zip uncompress the file to the Application
+                    // database folder
+                    _ = try UtilsFile
+                        .unzipFromAssetToDatabase(zip: zip, overwrite: overwrite)
                 }
                 return
             } else {
                 let msg: String = "assets database path does not exist"
                 throw CapacitorSQLiteError.failed(message: msg)
             }
+        } catch UtilsFileError.copyFromAssetToDatabaseFailed(let message) {
+            throw CapacitorSQLiteError.failed(message: message)
+        } catch UtilsFileError.unzipFromAssetToDatabaseFailed(let message) {
+            throw CapacitorSQLiteError.failed(message: message)
         } catch let error {
             let msg: String = "\(error)"
             throw CapacitorSQLiteError.failed(message: msg)
@@ -717,7 +731,7 @@ enum CapacitorSQLiteError: Error {
         do {
             let aPath: String = try UtilsFile.getDatabasesPath()
             // get the database files
-            let dbList: [String] = try UtilsFile.getFileList(path: aPath)
+            let dbList: [String] = try UtilsFile.getFileList(path: aPath, ext: ".db")
             return dbList
 
         } catch let error {
@@ -792,7 +806,7 @@ enum CapacitorSQLiteError: Error {
     }
 
     func closeAllConnections() throws {
-        var keys: [String] = Array(self.dbDict.keys)
+        let keys: [String] = Array(self.dbDict.keys)
 
         for key in keys {
             guard let mDb: Database = dbDict[key] else {

package/ios/Plugin/CapacitorSQLitePlugin.swift

@@ -949,8 +949,10 @@ public class CapacitorSQLitePlugin: CAPPlugin {
     // MARK: copyFromAssets
 
     @objc func copyFromAssets(_ call: CAPPluginCall) {
+        let overwrite: Bool = call.getBool("overwrite") ?? true
+
         do {
-            try implementation.copyFromAssets()
+            try implementation.copyFromAssets(overwrite: overwrite)
             retHandler.rResult(call: call)
             return
         } catch CapacitorSQLiteError.failed(let message) {

package/ios/Plugin/ImportExportJson/ExportToJson.swift

@@ -706,7 +706,6 @@ class ExportToJson {
                                                 after: oPar)..<cPar]
                                 row[1] = rstr[rstr.index(
                                                 cPar, offsetBy: 2)..<rstr.endIndex]
-                                print("row[0] \(row[0]) row[1] \(row[1]) ")
                                 columns["foreignkey"] = String(row[0])
                             }
                             columns["value"] = String(row[1]).replacingOccurrences(of: "§", with: ",")

package/ios/Plugin/Utils/UtilsFile.swift

@@ -7,6 +7,8 @@
 //
 
 import Foundation
+import ZIPFoundation
+
 enum UtilsFileError: Error {
     case getFilePathFailed
     case copyFileFailed
@@ -20,9 +22,11 @@ enum UtilsFileError: Error {
     case getLibraryPathFailed
     case getLibraryURLFailed
     case getFileListFailed
-    case copyFromAssetToDatabaseFailed
+    case copyFromAssetToDatabaseFailed(message: String)
+    case unzipFromAssetToDatabaseFailed(message: String)
     case copyFromNamesFailed
 }
+// swiftlint:disable file_length
 // swiftlint:disable type_body_length
 class UtilsFile {
 
@@ -165,13 +169,10 @@ class UtilsFile {
 
     class func setPathSuffix(sDb: String ) -> String {
         var toDb: String = sDb
-        if sDb.count > 9 {
-            let last9: String = String(sDb.suffix(9))
-            let ext: String = ".db"
-            if last9 != "SQLite.db" {
-                if sDb.hasSuffix(ext) {
-                    toDb = sDb.prefix(sDb.count - ext.count) + "SQLite.db"
-                }
+        let ext: String = ".db"
+        if sDb.hasSuffix(ext) {
+            if !sDb.contains("SQLite.db") {
+                toDb = sDb.prefix(sDb.count - ext.count) + "SQLite.db"
             }
         }
         return toDb
@@ -179,18 +180,24 @@ class UtilsFile {
 
     // MARK: - GetFileList
 
-    class func getFileList(path: String) throws -> [String] {
+    class func getFileList(path: String, ext: String? = nil) throws -> [String] {
+
         do {
-            var dbs: [String] = []
+            var files: [String] = []
             let filenames = try FileManager.default
                 .contentsOfDirectory(atPath: path)
-            let ext: String = ".db"
             for file in filenames {
-                if file.hasSuffix(ext) {
-                    dbs.append(file)
+                if let mExtension = ext {
+                    if file.hasSuffix(mExtension) {
+                        files.append(file)
+                    }
+                } else {
+                    if file.prefix(1) != "." {
+                        files.append(file)
+                    }
                 }
             }
-            return dbs
+            return files
         } catch let error {
             print("Error: \(error)")
             throw UtilsFileError.getFileListFailed
@@ -206,7 +213,8 @@ class UtilsFile {
             let uTo: URL = databaseURL.appendingPathComponent(toFile)
             let pFrom: String = uFrom.path
             let pTo: String = uTo.path
-            let bRet: Bool = try copyFile(pathName: pFrom, toPathName: pTo)
+            let bRet: Bool = try copyFile(pathName: pFrom, toPathName: pTo,
+                                          overwrite: true)
             if bRet {
                 return
             } else {
@@ -222,7 +230,8 @@ class UtilsFile {
 
     // MARK: - CopyFromAssetToDatabase
 
-    class func copyFromAssetToDatabase(fromDb: String, toDb: String) throws {
+    class func copyFromAssetToDatabase(fromDb: String, toDb: String,
+                                       overwrite: Bool) throws {
         do {
             let uAsset: URL = try getAssetsDatabasesPath()
                 .appendingPathComponent(fromDb)
@@ -230,42 +239,96 @@ class UtilsFile {
             let uDb: URL = try getDatabasesUrl()
                 .appendingPathComponent(toDb)
             let pDb: String = uDb.path
-            let bRet: Bool = try copyFile(pathName: pAsset, toPathName: pDb)
+            let bRet: Bool = try copyFile(pathName: pAsset, toPathName: pDb,
+                                          overwrite: overwrite)
             if bRet {
                 return
             } else {
-                print("Error: copyFile return false")
-                throw UtilsFileError.copyFromAssetToDatabaseFailed
+                let msg = "Error: copyFile return false"
+                print("\(msg)")
+                throw UtilsFileError.copyFromAssetToDatabaseFailed(message: msg)
             }
         } catch UtilsFileError.getAssetsDatabasesPathFailed {
-            print("Error: getAssetsDatabasesPath Failed")
-            throw UtilsFileError.copyFromAssetToDatabaseFailed
+            let msg = "Error: getAssetsDatabasesPath Failed"
+            print("\(msg)")
+            throw UtilsFileError.copyFromAssetToDatabaseFailed(message: msg)
         } catch UtilsFileError.getDatabasesURLFailed {
-            print("Error: getDatabasesUrl Failed")
-            throw UtilsFileError.copyFromAssetToDatabaseFailed
+            let msg = "Error: getDatabasesUrl Failed"
+            print("\(msg)")
+
+            throw UtilsFileError.copyFromAssetToDatabaseFailed(message: msg)
         } catch UtilsFileError.copyFileFailed {
-            print("Error: copyFile Failed")
-            throw UtilsFileError.copyFromAssetToDatabaseFailed
+            let msg = "Error: copyFile Failed"
+            print("\(msg)")
+
+            throw UtilsFileError.copyFromAssetToDatabaseFailed(message: msg)
         } catch let error {
-            print("Error: \(error)")
-            throw UtilsFileError.copyFromAssetToDatabaseFailed
+            let msg = "Error: \(error)"
+            print("\(msg)")
+            throw UtilsFileError.copyFromAssetToDatabaseFailed(message: msg)
         }
 
     }
 
+    class func unzipFromAssetToDatabase(zip: String, overwrite: Bool) throws {
+        do {
+            let zipAsset: URL = try getAssetsDatabasesPath()
+                .appendingPathComponent(zip)
+            guard let archive = Archive(url: zipAsset, accessMode: .read) else {
+                let msg = "Error: Read Archive: \(zipAsset) failed"
+                print("\(msg)")
+                throw UtilsFileError.unzipFromAssetToDatabaseFailed(message: msg)
+            }
+            for entry in archive {
+                let dbEntry = setPathSuffix(sDb: entry.path)
+                let zipCopy: URL = try getDatabasesUrl()
+                    .appendingPathComponent(dbEntry)
+                do {
+                    let isExist: Bool = isFileExist(filePath: zipCopy.path)
+                    if !isExist || overwrite {
+                        if overwrite && isExist {
+                            _ = try deleteFile(filePath: zipCopy.path)
+                        }
+                        _ = try archive.extract(entry, to: zipCopy)
+                    }
+
+                } catch {
+                    let msg = "Error: Extracting \(entry.path) from archive failed \(error.localizedDescription)"
+                    print("\(msg)")
+                    throw UtilsFileError.unzipFromAssetToDatabaseFailed(message: msg)
+                }
+            }
+        } catch UtilsFileError.getAssetsDatabasesPathFailed {
+            let msg = "Error: getAssetsDatabasesPath Failed"
+            print("\(msg)")
+            throw UtilsFileError.unzipFromAssetToDatabaseFailed(message: msg)
+        } catch UtilsFileError.getDatabasesURLFailed {
+            let msg = "Error: getDatabasesUrl Failed"
+            print("\(msg)")
+            throw UtilsFileError.unzipFromAssetToDatabaseFailed(message: msg)
+        } catch let error {
+            let msg = "Error: \(error)"
+            print("\(msg)")
+            throw UtilsFileError.unzipFromAssetToDatabaseFailed(message: msg)
+        }
+    }
+
     // MARK: - CopyFile
 
-    class func copyFile(pathName: String, toPathName: String) throws -> Bool {
+    class func copyFile(pathName: String, toPathName: String, overwrite: Bool) throws -> Bool {
         if pathName.count > 0 && toPathName.count > 0 {
             let isPath = isFileExist(filePath: pathName)
             if isPath {
                 do {
-                    if isFileExist(filePath: toPathName) {
-                        _ = try deleteFile(filePath: toPathName)
+                    let isExist: Bool = isFileExist(filePath: toPathName)
+                    if !isExist || overwrite {
+                        if overwrite && isExist {
+                            _ = try deleteFile(filePath: toPathName)
+                        }
+                        let fileManager = FileManager.default
+                        try fileManager.copyItem(atPath: pathName,
+                                                 toPath: toPathName)
                     }
-                    let fileManager = FileManager.default
-                    try fileManager.copyItem(atPath: pathName,
-                                             toPath: toPathName)
                     return true
                 } catch let error {
                     print("Error: \(error)")
@@ -289,7 +352,7 @@ class UtilsFile {
         do {
             let fromPath: String = try getFilePath(fileName: fileName)
             let toPath: String = try getFilePath(fileName: toFileName)
-            ret = try copyFile(pathName: fromPath, toPathName: toPath)
+            ret = try copyFile(pathName: fromPath, toPathName: toPath, overwrite: true)
             return ret
         } catch UtilsFileError.getFilePathFailed {
             print("Error: getFilePath Failed")
@@ -373,3 +436,4 @@ class UtilsFile {
     }
 }
 // swiftlint:enable type_body_length
+// swiftlint:enable file_length

package/ios/Plugin/Utils/UtilsMigrate.swift

@@ -14,7 +14,7 @@ enum UtilsMigrateError: Error {
 
 class UtilsMigrate {
 
-    // MARK: - addSQLiteSuffix
+    // MARK: - getMigratableList
 
     class func getMigratableList(folderPath: String) throws -> [String] {
         var mDbList: [String] = []
@@ -25,7 +25,7 @@ class UtilsMigrate {
             if FileManager.default.fileExists(atPath: dbPathURL.relativePath,
                                               isDirectory: &isDir) &&
                 isDir.boolValue {
-                mDbList = try UtilsFile.getFileList(path: dbPathURL.relativePath)
+                mDbList = try UtilsFile.getFileList(path: dbPathURL.relativePath, ext: nil)
 
                 return mDbList
             } else {
@@ -47,7 +47,9 @@ class UtilsMigrate {
     }
 
     // MARK: - addSQLiteSuffix
+
     // swiftlint:disable function_body_length
+    // swiftlint:disable cyclomatic_complexity
     class func addSQLiteSuffix(folderPath: String, dbList: [String]) throws {
         var fromFile: String = ""
         var toFile: String = ""
@@ -59,12 +61,32 @@ class UtilsMigrate {
             if FileManager.default.fileExists(atPath: dbPathURL.relativePath,
                                               isDirectory: &isDir) &&
                 isDir.boolValue {
-                let mDbList: [String] = try UtilsFile
-                    .getFileList(path: dbPathURL.relativePath)
+                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
@@ -98,9 +120,13 @@ 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
@@ -109,17 +135,35 @@ class UtilsMigrate {
             if FileManager.default.fileExists(atPath: dbPathURL.relativePath,
                                               isDirectory: &isDir) &&
                 isDir.boolValue {
-                let mDbList: [String] = try UtilsFile
-                    .getFileList(path: dbPathURL.relativePath)
+                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")
+                                }
                             }
+
                         }
                     }
                 }
@@ -144,6 +188,8 @@ class UtilsMigrate {
             throw UtilsMigrateError.addSQLiteSuffix(message: msg)
         }
     }
+    // swiftlint:enable cyclomatic_complexity
+    // swiftlint:enable function_body_length
 
     // MARK: - getFolderURL
     class func getFolderURL(folderPath: String) throws -> URL {

package/ios/Plugin/Utils/UtilsSecret.swift

@@ -100,11 +100,9 @@ class UtilsSecret {
             if FileManager.default.fileExists(atPath: databaseURL.relativePath,
                                               isDirectory: &isDir) && isDir.boolValue {
                 let dbList: [String] = try UtilsFile
-                    .getFileList(path: databaseURL.relativePath)
+                    .getFileList(path: databaseURL.relativePath, ext: ".db")
                 for file: String in dbList {
-                    print("file: \(file)")
                     let state: State = UtilsSQLCipher.getDatabaseState(databaseName: file)
-                    print("state: \(state)")
                     if state.rawValue == "ENCRYPTEDGLOBALSECRET" {
                         let globalData: GlobalSQLite = GlobalSQLite()
                         let password: String = globalData.secret
@@ -140,7 +138,6 @@ class UtilsSecret {
 
     // MARK: - ChangeEncryptionSecret
 
-    // swiftlint:disable function_body_length
     class func changeEncryptionSecret(passphrase: String, oldPassphrase: String) throws {
         do {
             if passphrase.isEmpty ||  oldPassphrase.isEmpty {
@@ -162,11 +159,9 @@ class UtilsSecret {
             if FileManager.default.fileExists(atPath: databaseURL.relativePath,
                                               isDirectory: &isDir) && isDir.boolValue {
                 let dbList: [String] = try UtilsFile
-                    .getFileList(path: databaseURL.relativePath)
+                    .getFileList(path: databaseURL.relativePath, ext: ".db")
                 for file: String in dbList {
-                    print("file: \(file)")
                     let state: State = UtilsSQLCipher.getDatabaseState(databaseName: file)
-                    print("state: \(state)")
                     if state.rawValue == "ENCRYPTEDSECRET" {
                         let dbPath: String  = try UtilsFile
                             .getFilePath(fileName: file)
@@ -198,6 +193,5 @@ class UtilsSecret {
         }
 
     }
-    // swiftlint:enable function_body_length
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/sqlite",
-  "version": "3.2.5-1",
+  "version": "3.3.2",
   "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.2.5",
-    "@capacitor/core": "3.2.5",
+    "@capacitor/android": "^3.3.2",
+    "@capacitor/core": "3.3.2",
     "@capacitor/docgen": "^0.0.17",
-    "@capacitor/ios": "^3.2.5",
+    "@capacitor/ios": "^3.3.2",
     "@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.2.5"
+    "@capacitor/core": "^3.3.2"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",