@capacitor-community/sqlite 4.1.0-4 → 4.1.0-7

package/README.md

@@ -39,7 +39,7 @@ npx cap sync
  - [Issues](https://github.com/capacitor-community/sqlite/issues)
  - [Capacitor documentation](https://capacitorjs.com/docs/)
  - [Datatypes In SQLite Version 3](https://www.sqlite.org/datatype3.html)
-
+ - [IncrementalUpgradeDatabaseVersion](https://capacitorjs.com/docs/IncrementalUpgradeDatabaseVersion.md)
 
 ## Web Quirks
 
@@ -90,9 +90,12 @@ npm install --save-dev @types/sqlite3
 
 | Name                        | Android | iOS | Electron | Web |
 | :-------------------------- | :------ | :-- | :------- | :-- |
-| createConnection            | ✅      | ✅  | ✅        | ✅  |
-| closeConnection             | ✅      | ✅  | ✅        | ✅  |
-| isConnection                | ✅      | ✅  | ✅        | ✅  |
+| createConnection (ReadWrite)| ✅      | ✅  | ✅        | ✅  |
+| createConnection (ReadOnly) | ✅      | ✅  | ❌        | ❌  | since 4.1.0-7
+| closeConnection (ReadWrite) | ✅      | ✅  | ✅        | ✅  |
+| closeConnection (ReadOnly)  | ✅      | ✅  | ❌        | ❌  | since 4.1.0-7
+| isConnection (ReadWrite)    | ✅      | ✅  | ✅        | ✅  |
+| isConnection (ReadOnly)     | ✅      | ✅  | ❌        | ❌  | since 4.1.0-7
 | open (non-encrypted DB)     | ✅      | ✅  | ✅        | ✅  |
 | open (encrypted DB)         | ✅      | ✅  | ❌        | ❌  |
 | close                       | ✅      | ✅  | ✅        | ✅  |
@@ -111,7 +114,7 @@ npm install --save-dev @types/sqlite3
 | getSyncDate                 | ✅      | ✅  | ✅        | ✅  |
 | isJsonValid                 | ✅      | ✅  | ✅        | ✅  |
 | isDBExists                  | ✅      | ✅  | ✅        | ✅  |
-| addUpgradeStatement         | ✅      | ✅  | ✅        | ✅  |
+| addUpgradeStatement         | ✅      | ✅  | ✅        | ✅  | Modified 4.1.0-6
 | copyFromAssets              | ✅      | ✅  | ✅        | ✅  |
 | isDBOpen                    | ✅      | ✅  | ✅        | ✅  |
 | isDatabase                  | ✅      | ✅  | ✅        | ✅  |

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLite.java

@@ -2,14 +2,12 @@ package com.getcapacitor.community.database.sqlite;
 
 import android.content.Context;
 import android.content.SharedPreferences;
-import android.text.TextUtils;
 import android.util.Log;
 import android.widget.Toast;
 import androidx.biometric.BiometricManager;
 import androidx.biometric.BiometricPrompt;
 import androidx.security.crypto.EncryptedSharedPreferences;
 import androidx.security.crypto.MasterKey;
-import androidx.security.crypto.MasterKeys;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
 import com.getcapacitor.PluginCall;
@@ -25,13 +23,8 @@ import com.getcapacitor.community.database.sqlite.SQLite.UtilsNCDatabase;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsSQLite;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsSecret;
 import java.io.File;
-import java.io.IOException;
-import java.nio.charset.Charset;
-import java.nio.charset.StandardCharsets;
-import java.security.GeneralSecurityException;
 import java.security.KeyStore;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.Dictionary;
 import java.util.Enumeration;
@@ -40,32 +33,30 @@ import java.util.HashSet;
 import java.util.Hashtable;
 import java.util.Map;
 import java.util.Set;
-import javax.crypto.BadPaddingException;
-import javax.crypto.IllegalBlockSizeException;
 import org.json.JSONException;
 import org.json.JSONObject;
 
 public class CapacitorSQLite {
 
     private static final String TAG = CapacitorSQLite.class.getName();
-    private Context context;
-    private Dictionary<String, Database> dbDict = new Hashtable<>();
-    private UtilsSQLite uSqlite = new UtilsSQLite();
-    private UtilsFile uFile = new UtilsFile();
-    private UtilsJson uJson = new UtilsJson();
-    private UtilsMigrate uMigrate = new UtilsMigrate();
-    private UtilsNCDatabase uNCDatabase = new UtilsNCDatabase();
+    private final Context context;
+    private final Dictionary<String, Database> dbDict = new Hashtable<>();
+    private final UtilsSQLite uSqlite = new UtilsSQLite();
+    private final UtilsFile uFile = new UtilsFile();
+    private final UtilsJson uJson = new UtilsJson();
+    private final UtilsMigrate uMigrate = new UtilsMigrate();
+    private final UtilsNCDatabase uNCDatabase = new UtilsNCDatabase();
     private UtilsSecret uSecret;
     private SharedPreferences sharedPreferences = null;
     private MasterKey masterKeyAlias;
     private BiometricManager biometricManager;
-    private SqliteConfig config;
+    private final SqliteConfig config;
     private Boolean isEncryption = true;
     private Boolean biometricAuth = false;
-    private String biometricTitle;
-    private String biometricSubTitle;
-    private int VALIDITY_DURATION = 5;
-    private RetHandler rHandler = new RetHandler();
+    private final String biometricTitle;
+    private final String biometricSubTitle;
+    private final int VALIDITY_DURATION = 5;
+    private final RetHandler rHandler = new RetHandler();
     private PluginCall call;
 
     public CapacitorSQLite(Context context, SqliteConfig config) throws Exception {
@@ -165,6 +156,7 @@ public class CapacitorSQLite {
 
     /**
      * Echo
+     *
      * @param value
      * @return
      */
@@ -189,6 +181,7 @@ public class CapacitorSQLite {
 
     /**
      * SetEncryptionSecret
+     *
      * @param passphrase
      * @throws Exception
      */
@@ -209,6 +202,7 @@ public class CapacitorSQLite {
 
     /**
      * ChangeEncryptionSecret
+     *
      * @param passphrase
      * @param oldPassphrase
      * @throws Exception
@@ -293,6 +287,7 @@ public class CapacitorSQLite {
 
     /**
      * CreateConnection
+     *
      * @param dbName
      * @param encrypted
      * @param mode
@@ -300,11 +295,18 @@ public class CapacitorSQLite {
      * @param vUpgObject
      * @throws Exception
      */
-    public void createConnection(String dbName, boolean encrypted, String mode, int version, Dictionary<Integer, JSONObject> vUpgObject)
-        throws Exception {
+    public void createConnection(
+        String dbName,
+        boolean encrypted,
+        String mode,
+        int version,
+        Dictionary<Integer, JSONObject> vUpgObject,
+        Boolean readonly
+    ) throws Exception {
         dbName = getDatabaseName(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
         // check if connection already exists
-        Database conn = dbDict.get(dbName);
+        Database conn = dbDict.get(connName);
         if (conn != null) {
             String msg = "Connection " + dbName + " already exists";
             throw new Exception(msg);
@@ -321,10 +323,11 @@ public class CapacitorSQLite {
                 version,
                 isEncryption,
                 vUpgObject,
-                sharedPreferences
+                sharedPreferences,
+                readonly
             );
             if (db != null) {
-                dbDict.put(dbName, db);
+                dbDict.put(connName, db);
                 return;
             } else {
                 String msg = "db is null";
@@ -337,13 +340,15 @@ public class CapacitorSQLite {
 
     /**
      * CreateNCConnection
+     *
      * @param dbPath
      * @param version
      * @throws Exception
      */
     public void createNCConnection(String dbPath, int version) throws Exception {
         // check if connection already exists
-        Database conn = dbDict.get(dbPath);
+        String connName = "RO_" + dbPath;
+        Database conn = dbDict.get(connName);
         if (conn != null) {
             String msg = "Connection " + dbPath + " already exists";
             throw new Exception(msg);
@@ -362,7 +367,8 @@ public class CapacitorSQLite {
                 version,
                 isEncryption,
                 new Hashtable<>(),
-                sharedPreferences
+                sharedPreferences,
+                true
             );
             if (db != null) {
                 dbDict.put(dbPath, db);
@@ -378,12 +384,14 @@ public class CapacitorSQLite {
 
     /**
      * Open
+     *
      * @param dbName
      * @throws Exception
      */
-    public void open(String dbName) throws Exception {
+    public void open(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             try {
                 db.open();
@@ -399,12 +407,14 @@ public class CapacitorSQLite {
 
     /**
      * Close
+     *
      * @param dbName
      * @throws Exception
      */
-    public void close(String dbName) throws Exception {
+    public void close(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             if (db.isOpen()) {
                 if (!db.inTransaction()) {
@@ -430,13 +440,15 @@ public class CapacitorSQLite {
 
     /**
      * GetUrl
+     *
      * @param dbName
-     * @throws Exception
      * @return String
+     * @throws Exception
      */
-    public String getUrl(String dbName) throws Exception {
+    public String getUrl(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             try {
                 String url = db.getUrl();
@@ -452,13 +464,15 @@ public class CapacitorSQLite {
 
     /**
      * GetVersion
+     *
      * @param dbName
-     * @throws Exception
      * @return Integer
+     * @throws Exception
      */
-    public Integer getVersion(String dbName) throws Exception {
+    public Integer getVersion(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             try {
                 Integer version = db.getVersion();
@@ -474,20 +488,22 @@ public class CapacitorSQLite {
 
     /**
      * CloseNCConnection
+     *
      * @param dbPath
      * @throws Exception
      */
     public void closeNCConnection(String dbPath) throws Exception {
+        String connName = "RO_" + dbPath;
         Database db = dbDict.get(dbPath);
         if (db != null) {
             if (db.isOpen()) {
                 try {
-                    close(dbPath);
+                    db.close();
                 } catch (Exception e) {
                     throw new Exception(e.getMessage());
                 }
             }
-            dbDict.remove(dbPath);
+            dbDict.remove(connName);
             return;
         } else {
             String msg = "No available connection for database " + dbPath;
@@ -497,21 +513,23 @@ public class CapacitorSQLite {
 
     /**
      * CloseConnection
+     *
      * @param dbName
      * @throws Exception
      */
-    public void closeConnection(String dbName) throws Exception {
+    public void closeConnection(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             if (db.isOpen()) {
                 try {
-                    close(dbName);
+                    db.close();
                 } catch (Exception e) {
                     throw new Exception(e.getMessage());
                 }
             }
-            dbDict.remove(dbName);
+            dbDict.remove(connName);
             return;
         } else {
             String msg = "No available connection for database " + dbName;
@@ -565,6 +583,7 @@ public class CapacitorSQLite {
 
     /**
      * IsDatabase
+     *
      * @param dbName
      * @return Boolean
      * @throws Exception
@@ -576,6 +595,7 @@ public class CapacitorSQLite {
 
     /**
      * IsNCDatabase
+     *
      * @param dbPath
      * @return Boolean
      * @throws Exception
@@ -586,13 +606,15 @@ public class CapacitorSQLite {
 
     /**
      * IsTableExists
+     *
      * @param dbName
      * @param tableName
      * @throws Exception
      */
-    public Boolean isTableExists(String dbName, String tableName) throws Exception {
+    public Boolean isTableExists(String dbName, String tableName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             boolean res = uJson.isTableExists(db, tableName);
             return res;
@@ -604,6 +626,7 @@ public class CapacitorSQLite {
 
     /**
      * GetDatabaseList
+     *
      * @return JSArray
      * @throws Exception
      */
@@ -623,6 +646,7 @@ public class CapacitorSQLite {
 
     /**
      * GetMigratableDbList
+     *
      * @return JSArray
      * @throws Exception
      */
@@ -642,6 +666,7 @@ public class CapacitorSQLite {
 
     /**
      * AddSQLiteSuffix
+     *
      * @param folderPath
      * @throws Exception
      */
@@ -656,7 +681,6 @@ public class CapacitorSQLite {
     }
 
     /**
-     *
      * @param folderPath
      * @throws Exception
      */
@@ -687,15 +711,20 @@ public class CapacitorSQLite {
 
     /**
      * Execute
+     *
      * @param dbName
      * @param statements
      * @return
      * @throws Exception
      */
-    public JSObject execute(String dbName, String statements, Boolean transaction) throws Exception {
+    public JSObject execute(String dbName, String statements, Boolean transaction, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             if (!db.isNCDB() && db.isOpen()) {
                 // convert string in string[]
                 String[] sqlCmdArray = uSqlite.getStatementsArray(statements);
@@ -717,15 +746,20 @@ public class CapacitorSQLite {
 
     /**
      * ExecuteSet
+     *
      * @param dbName
      * @param set
      * @return
      * @throws Exception
      */
-    public JSObject executeSet(String dbName, JSArray set, Boolean transaction) throws Exception {
+    public JSObject executeSet(String dbName, JSArray set, Boolean transaction, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             if (!db.isNCDB() && db.isOpen()) {
                 try {
                     JSObject res = db.executeSet(set, transaction);
@@ -745,17 +779,22 @@ public class CapacitorSQLite {
 
     /**
      * Run
+     *
      * @param dbName
      * @param statement
      * @param values
      * @return
      * @throws Exception
      */
-    public JSObject run(String dbName, String statement, JSArray values, Boolean transaction) throws Exception {
+    public JSObject run(String dbName, String statement, JSArray values, Boolean transaction, Boolean readonly) throws Exception {
         JSObject res;
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             if (!db.isNCDB() && db.isOpen()) {
                 if (values.length() > 0) {
                     try {
@@ -787,16 +826,18 @@ public class CapacitorSQLite {
 
     /**
      * Query
+     *
      * @param dbName
      * @param statement
      * @param values
      * @return
      * @throws Exception
      */
-    public JSArray query(String dbName, String statement, JSArray values) throws Exception {
+    public JSArray query(String dbName, String statement, JSArray values, Boolean readonly) throws Exception {
         JSArray res;
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             if (db.isOpen()) {
                 if (values.length() > 0) {
@@ -827,10 +868,10 @@ public class CapacitorSQLite {
         }
     }
 
-    public JSArray getTableList(String dbName) throws Exception {
+    public JSArray getTableList(String dbName, Boolean readonly) throws Exception {
         JSArray res;
-        dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             if (db.isOpen()) {
                 res = db.getTableNames();
@@ -845,42 +886,40 @@ public class CapacitorSQLite {
         }
     }
 
-    public Boolean isDBExists(String dbName) throws Exception {
+    public Boolean isDBExists(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             File databaseFile = context.getDatabasePath(dbName + "SQLite.db");
-            if (databaseFile.exists()) {
-                return true;
-            } else {
-                return false;
-            }
+            return databaseFile.exists();
         } else {
             String msg = "No available connection for database " + dbName;
             throw new Exception(msg);
         }
     }
 
-    public Boolean isDBOpen(String dbName) throws Exception {
+    public Boolean isDBOpen(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             Boolean isOpen = db.isOpen();
-            if (isOpen) {
-                return true;
-            } else {
-                return false;
-            }
+            return isOpen;
         } else {
             String msg = "No available connection for database " + dbName;
             throw new Exception(msg);
         }
     }
 
-    public void deleteDatabase(String dbName) throws Exception {
+    public void deleteDatabase(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             try {
                 db.deleteDB(dbName + "SQLite.db");
                 return;
@@ -893,10 +932,14 @@ public class CapacitorSQLite {
         }
     }
 
-    public JSObject createSyncTable(String dbName) throws Exception {
+    public JSObject createSyncTable(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             try {
                 if (!db.isOpen()) {
                     String msg = "CreateSyncTable: db not opened";
@@ -913,10 +956,14 @@ public class CapacitorSQLite {
         }
     }
 
-    public void setSyncDate(String dbName, String syncDate) throws Exception {
+    public void setSyncDate(String dbName, String syncDate, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             try {
                 if (!db.isOpen()) {
                     String msg = "SetSyncDate: db not opened";
@@ -933,9 +980,10 @@ public class CapacitorSQLite {
         }
     }
 
-    public Long getSyncDate(String dbName) throws Exception {
+    public Long getSyncDate(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             try {
                 if (!db.isOpen()) {
@@ -964,17 +1012,17 @@ public class CapacitorSQLite {
             throw new Exception(msg);
         }
 
-        if (upgObj == null || !upgObj.has("fromVersion") || !upgObj.has("toVersion") || !upgObj.has("statement")) {
+        if (upgObj == null || !upgObj.has("toVersion") || !upgObj.has("statements")) {
             String msg = "Must provide an upgrade statement";
-            msg += " {fromVersion,toVersion,statement}";
+            msg += " {toVersion,statement}";
             throw new Exception(msg);
         }
         try {
-            int fromVersion = upgObj.getInt("fromVersion");
-            upgDict.put(fromVersion, upgObj);
+            int toVersion = upgObj.getInt("toVersion");
+            upgDict.put(toVersion, upgObj);
             return upgDict;
         } catch (Exception e) {
-            String msg = "Must provide fromVersion as Integer" + e.getMessage();
+            String msg = "Must provide toVersion as Integer" + e.getMessage();
             throw new Exception(msg);
         }
     }
@@ -1010,7 +1058,17 @@ public class CapacitorSQLite {
             if (encrypted) {
                 inMode = "secret";
             }
-            Database db = new Database(context, dbName, encrypted, inMode, dbVersion, isEncryption, new Hashtable<>(), sharedPreferences);
+            Database db = new Database(
+                context,
+                dbName,
+                encrypted,
+                inMode,
+                dbVersion,
+                isEncryption,
+                new Hashtable<>(),
+                sharedPreferences,
+                false
+            );
             if (overwrite && mode.equals("full")) {
                 Boolean isExists = this.uFile.isFileExists(context, dbName);
                 if (isExists) {
@@ -1052,9 +1110,10 @@ public class CapacitorSQLite {
         }
     }
 
-    public JSObject exportToJson(String dbName, String expMode) throws Exception {
+    public JSObject exportToJson(String dbName, String expMode, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = readonly ? "RO_" + dbName : "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
             try {
                 if (!db.isOpen()) {
@@ -1081,10 +1140,14 @@ public class CapacitorSQLite {
         }
     }
 
-    public void deleteExportedRows(String dbName) throws Exception {
+    public void deleteExportedRows(String dbName, Boolean readonly) throws Exception {
         dbName = getDatabaseName(dbName);
-        Database db = dbDict.get(dbName);
+        String connName = "RW_" + dbName;
+        Database db = dbDict.get(connName);
         if (db != null) {
+            if (readonly) {
+                throw new Exception("not allowed in read-only mode");
+            }
             try {
                 if (!db.isOpen()) {
                     String msg = "deleteExportedRows: db not opened";
@@ -1128,8 +1191,13 @@ public class CapacitorSQLite {
         try {
             Enumeration<String> connections = dbDict.keys();
             while (connections.hasMoreElements()) {
-                String dbName = (String) connections.nextElement();
-                closeConnection(dbName);
+                String dbName = connections.nextElement();
+                Boolean readonly = false;
+                if (dbName.substring(0, 3).equals("RO_")) {
+                    readonly = true;
+                }
+                dbName = dbName.substring(3);
+                closeConnection(dbName, readonly);
             }
         } catch (Exception e) {
             String msg = "close all connections " + e.getMessage();