@capacitor-community/sqlite 4.1.0-3 → 4.1.0-6

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

@@ -2,14 +2,14 @@ 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;
@@ -24,14 +24,13 @@ import com.getcapacitor.community.database.sqlite.SQLite.UtilsMigrate;
 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 org.json.JSONException;
+import org.json.JSONObject;
+
 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 +39,28 @@ 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 {
@@ -92,10 +87,10 @@ public class CapacitorSQLite {
                                 Enumeration<String> aliases = ks.aliases();
                                 if (aliases.hasMoreElements()) {
                                     masterKeyAlias =
-                                        new MasterKey.Builder(context)
-                                            .setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
-                                            .setUserAuthenticationRequired(true, VALIDITY_DURATION)
-                                            .build();
+                                            new MasterKey.Builder(context)
+                                                    .setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
+                                                    .setUserAuthenticationRequired(true, VALIDITY_DURATION)
+                                                    .build();
                                 } else {
                                     masterKeyAlias = new MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build();
                                 }
@@ -150,13 +145,13 @@ public class CapacitorSQLite {
         try {
             // get instance of the EncryptedSharedPreferences class
             this.sharedPreferences =
-                EncryptedSharedPreferences.create(
-                    context,
-                    "sqlite_encrypted_shared_prefs",
-                    masterKeyAlias,
-                    EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
-                    EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
-                );
+                    EncryptedSharedPreferences.create(
+                            context,
+                            "sqlite_encrypted_shared_prefs",
+                            masterKeyAlias,
+                            EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
+                            EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
+                    );
             this.uSecret = new UtilsSecret(this.context, this.sharedPreferences);
         } catch (Exception e) {
             throw new Exception(e.getMessage());
@@ -165,6 +160,7 @@ public class CapacitorSQLite {
 
     /**
      * Echo
+     *
      * @param value
      * @return
      */
@@ -189,6 +185,7 @@ public class CapacitorSQLite {
 
     /**
      * SetEncryptionSecret
+     *
      * @param passphrase
      * @throws Exception
      */
@@ -209,6 +206,7 @@ public class CapacitorSQLite {
 
     /**
      * ChangeEncryptionSecret
+     *
      * @param passphrase
      * @param oldPassphrase
      * @throws Exception
@@ -293,6 +291,7 @@ public class CapacitorSQLite {
 
     /**
      * CreateConnection
+     *
      * @param dbName
      * @param encrypted
      * @param mode
@@ -301,7 +300,7 @@ public class CapacitorSQLite {
      * @throws Exception
      */
     public void createConnection(String dbName, boolean encrypted, String mode, int version, Dictionary<Integer, JSONObject> vUpgObject)
-        throws Exception {
+            throws Exception {
         dbName = getDatabaseName(dbName);
         // check if connection already exists
         Database conn = dbDict.get(dbName);
@@ -314,14 +313,14 @@ public class CapacitorSQLite {
         }
         try {
             Database db = new Database(
-                context,
-                dbName + "SQLite.db",
-                encrypted,
-                mode,
-                version,
-                isEncryption,
-                vUpgObject,
-                sharedPreferences
+                    context,
+                    dbName + "SQLite.db",
+                    encrypted,
+                    mode,
+                    version,
+                    isEncryption,
+                    vUpgObject,
+                    sharedPreferences
             );
             if (db != null) {
                 dbDict.put(dbName, db);
@@ -337,6 +336,7 @@ public class CapacitorSQLite {
 
     /**
      * CreateNCConnection
+     *
      * @param dbPath
      * @param version
      * @throws Exception
@@ -355,14 +355,14 @@ public class CapacitorSQLite {
                 throw new Exception(msg);
             }
             Database db = new Database(
-                context,
-                dbPath,
-                false,
-                "no-encryption",
-                version,
-                isEncryption,
-                new Hashtable<>(),
-                sharedPreferences
+                    context,
+                    dbPath,
+                    false,
+                    "no-encryption",
+                    version,
+                    isEncryption,
+                    new Hashtable<>(),
+                    sharedPreferences
             );
             if (db != null) {
                 dbDict.put(dbPath, db);
@@ -378,6 +378,7 @@ public class CapacitorSQLite {
 
     /**
      * Open
+     *
      * @param dbName
      * @throws Exception
      */
@@ -399,6 +400,7 @@ public class CapacitorSQLite {
 
     /**
      * Close
+     *
      * @param dbName
      * @throws Exception
      */
@@ -430,9 +432,10 @@ public class CapacitorSQLite {
 
     /**
      * GetUrl
+     *
      * @param dbName
-     * @throws Exception
      * @return String
+     * @throws Exception
      */
     public String getUrl(String dbName) throws Exception {
         dbName = getDatabaseName(dbName);
@@ -452,9 +455,10 @@ public class CapacitorSQLite {
 
     /**
      * GetVersion
+     *
      * @param dbName
-     * @throws Exception
      * @return Integer
+     * @throws Exception
      */
     public Integer getVersion(String dbName) throws Exception {
         dbName = getDatabaseName(dbName);
@@ -474,6 +478,7 @@ public class CapacitorSQLite {
 
     /**
      * CloseNCConnection
+     *
      * @param dbPath
      * @throws Exception
      */
@@ -497,6 +502,7 @@ public class CapacitorSQLite {
 
     /**
      * CloseConnection
+     *
      * @param dbName
      * @throws Exception
      */
@@ -565,6 +571,7 @@ public class CapacitorSQLite {
 
     /**
      * IsDatabase
+     *
      * @param dbName
      * @return Boolean
      * @throws Exception
@@ -576,6 +583,7 @@ public class CapacitorSQLite {
 
     /**
      * IsNCDatabase
+     *
      * @param dbPath
      * @return Boolean
      * @throws Exception
@@ -586,6 +594,7 @@ public class CapacitorSQLite {
 
     /**
      * IsTableExists
+     *
      * @param dbName
      * @param tableName
      * @throws Exception
@@ -604,6 +613,7 @@ public class CapacitorSQLite {
 
     /**
      * GetDatabaseList
+     *
      * @return JSArray
      * @throws Exception
      */
@@ -623,6 +633,7 @@ public class CapacitorSQLite {
 
     /**
      * GetMigratableDbList
+     *
      * @return JSArray
      * @throws Exception
      */
@@ -642,6 +653,7 @@ public class CapacitorSQLite {
 
     /**
      * AddSQLiteSuffix
+     *
      * @param folderPath
      * @throws Exception
      */
@@ -656,7 +668,6 @@ public class CapacitorSQLite {
     }
 
     /**
-     *
      * @param folderPath
      * @throws Exception
      */
@@ -687,6 +698,7 @@ public class CapacitorSQLite {
 
     /**
      * Execute
+     *
      * @param dbName
      * @param statements
      * @return
@@ -717,6 +729,7 @@ public class CapacitorSQLite {
 
     /**
      * ExecuteSet
+     *
      * @param dbName
      * @param set
      * @return
@@ -745,6 +758,7 @@ public class CapacitorSQLite {
 
     /**
      * Run
+     *
      * @param dbName
      * @param statement
      * @param values
@@ -787,6 +801,7 @@ public class CapacitorSQLite {
 
     /**
      * Query
+     *
      * @param dbName
      * @param statement
      * @param values
@@ -850,11 +865,7 @@ public class CapacitorSQLite {
         Database db = dbDict.get(dbName);
         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);
@@ -866,11 +877,7 @@ public class CapacitorSQLite {
         Database db = dbDict.get(dbName);
         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);
@@ -964,17 +971,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);
         }
     }
@@ -1128,7 +1135,7 @@ public class CapacitorSQLite {
         try {
             Enumeration<String> connections = dbDict.keys();
             while (connections.hasMoreElements()) {
-                String dbName = (String) connections.nextElement();
+                String dbName = connections.nextElement();
                 closeConnection(dbName);
             }
         } catch (Exception e) {

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

@@ -8,21 +8,27 @@ import static android.database.Cursor.FIELD_TYPE_STRING;
 
 import android.content.Context;
 import android.content.SharedPreferences;
-import android.text.TextUtils;
 import android.util.Log;
+
 import androidx.sqlite.db.SimpleSQLiteQuery;
 import androidx.sqlite.db.SupportSQLiteDatabase;
 import androidx.sqlite.db.SupportSQLiteStatement;
+
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
-import com.getcapacitor.community.database.sqlite.SQLite.GlobalSQLite;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.ExportToJson;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.ImportFromJson;
-import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.JsonIndex;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.JsonSQLite;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.UtilsJson;
-import com.getcapacitor.community.database.sqlite.SQLite.UtilsSQLCipher;
-import com.getcapacitor.community.database.sqlite.SQLite.UtilsSQLite;
+
+import net.sqlcipher.Cursor;
+import net.sqlcipher.database.SQLiteDatabase;
+import net.sqlcipher.database.SQLiteException;
+
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+
 import java.io.File;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
@@ -31,51 +37,44 @@ import java.util.Collections;
 import java.util.Date;
 import java.util.Dictionary;
 import java.util.Hashtable;
-import java.util.Iterator;
 import java.util.List;
-import net.sqlcipher.Cursor;
-import net.sqlcipher.database.SQLiteDatabase;
-import net.sqlcipher.database.SQLiteException;
-import org.json.JSONArray;
-import org.json.JSONException;
-import org.json.JSONObject;
 
 public class Database {
 
     private static final String TAG = Database.class.getName();
     private Boolean _isOpen = false;
-    private String _dbName;
-    private Context _context;
-    private String _mode;
+    private final String _dbName;
+    private final Context _context;
+    private final String _mode;
     private String _secret;
-    private Boolean _encrypted;
-    private Boolean _isEncryption;
-    private SharedPreferences _sharedPreferences;
-    private File _file;
-    private int _version;
-    private GlobalSQLite _globVar;
+    private final Boolean _encrypted;
+    private final Boolean _isEncryption;
+    private final SharedPreferences _sharedPreferences;
+    private final File _file;
+    private final int _version;
+    private final GlobalSQLite _globVar;
     private SupportSQLiteDatabase _db = null;
-    private UtilsSQLite _uSqlite;
-    private UtilsSQLCipher _uCipher;
-    private UtilsFile _uFile;
-    private UtilsJson _uJson;
-    private UtilsUpgrade _uUpg;
-    private UtilsDrop _uDrop;
-    private UtilsSecret _uSecret;
+    private final UtilsSQLite _uSqlite;
+    private final UtilsSQLCipher _uCipher;
+    private final UtilsFile _uFile;
+    private final UtilsJson _uJson;
+    private final UtilsUpgrade _uUpg;
+    private final UtilsDrop _uDrop;
+    private final UtilsSecret _uSecret;
     private Dictionary<Integer, JSONObject> _vUpgObject = new Hashtable<>();
-    private ImportFromJson fromJson = new ImportFromJson();
-    private ExportToJson toJson = new ExportToJson();
+    private final ImportFromJson fromJson = new ImportFromJson();
+    private final ExportToJson toJson = new ExportToJson();
     private Boolean ncDB = false;
 
     public Database(
-        Context context,
-        String dbName,
-        Boolean encrypted,
-        String mode,
-        int version,
-        Boolean isEncryption,
-        Dictionary<Integer, JSONObject> vUpgObject,
-        SharedPreferences sharedPreferences
+            Context context,
+            String dbName,
+            Boolean encrypted,
+            String mode,
+            int version,
+            Boolean isEncryption,
+            Dictionary<Integer, JSONObject> vUpgObject,
+            SharedPreferences sharedPreferences
     ) {
         this._context = context;
         this._dbName = dbName;
@@ -155,8 +154,8 @@ public class Database {
         int curVersion;
 
         String password = _uSecret != null && _encrypted && (_mode.equals("secret") || _mode.equals("encryption"))
-            ? _uSecret.getPassphrase()
-            : "";
+                ? _uSecret.getPassphrase()
+                : "";
         if (_mode.equals("encryption")) {
             if (_isEncryption) {
                 try {
@@ -190,11 +189,7 @@ public class Database {
                     }
                     if (!isNCDB()) {
                         try {
-                            curVersion = _db.getVersion();
-                            if (curVersion == 0) {
-                                _db.setVersion(1);
-                                curVersion = _db.getVersion();
-                            }
+                            curVersion = _db.getVersion(); // default 0
                         } catch (IllegalStateException e) {
                             String msg = "Failed in get/setVersion " + e.getMessage();
                             Log.v(TAG, msg);
@@ -211,7 +206,10 @@ public class Database {
                         if (_version > curVersion && _vUpgObject != null && _vUpgObject.size() > 0) {
                             //                           if (_vUpgObject != null && _vUpgObject.size() > 0) {
                             try {
-                                _uUpg.onUpgrade(this, _context, _dbName, _vUpgObject, curVersion, _version);
+                                this._uFile.copyFile(_context, _dbName, "backup-" + _dbName);
+
+                                _uUpg.onUpgrade(this, _vUpgObject, curVersion, _version);
+
                                 boolean ret = _uFile.deleteBackupDB(_context, _dbName);
                                 if (!ret) {
                                     String msg = "Failed in deleteBackupDB backup-\" + _dbName";
@@ -230,17 +228,6 @@ public class Database {
                                 _db = null;
                                 throw new Exception(msg);
                             }
-                            /*                           } else {
-                                try {
-                                    _db.setVersion(_version);
-                                } catch (Exception e) {
-                                    String msg = e.getMessage() + "Failed in setting version " + _version;
-                                    close();
-                                    _db = null;
-                                    throw new Exception(msg);
-                                }
-                            }
-  */
                         }
                         _isOpen = true;
                         return;
@@ -306,11 +293,7 @@ public class Database {
      * @return the existence of the database on folder
      */
     public boolean isDBExists() {
-        if (_file.exists()) {
-            return true;
-        } else {
-            return false;
-        }
+        return _file.exists();
     }
 
     /**
@@ -524,7 +507,7 @@ public class Database {
                 // Replace DELETE by UPDATE and set sql_deleted to 1
                 Integer wIdx = statement.toUpperCase().indexOf("WHERE");
                 String preStmt = statement.substring(0, wIdx - 1);
-                String clauseStmt = statement.substring(wIdx, statement.length());
+                String clauseStmt = statement.substring(wIdx);
                 String tableName = preStmt.substring(("DELETE FROM").length()).trim();
                 sqlStmt = "UPDATE " + tableName + " SET sql_deleted = 1 " + clauseStmt;
                 // Find REFERENCES if any and update the sql_deleted column
@@ -738,6 +721,7 @@ public class Database {
             "sql LIKE('%" +
             tableName +
             "%') AND sql LIKE('%ON DELETE%');";
+
         try {
             JSArray references = mDB.selectSQL(sqlStmt, new ArrayList<Object>());
             ArrayList<String> retRefs = new ArrayList<String>();
@@ -895,8 +879,8 @@ public class Database {
                 Date date = new Date();
                 long syncTime = date.getTime() / 1000L;
                 String[] statements = {
-                    "CREATE TABLE IF NOT EXISTS sync_table (" + "id INTEGER PRIMARY KEY NOT NULL," + "sync_date INTEGER);",
-                    "INSERT INTO sync_table (sync_date) VALUES ('" + syncTime + "');"
+                        "CREATE TABLE IF NOT EXISTS sync_table (" + "id INTEGER PRIMARY KEY NOT NULL," + "sync_date INTEGER);",
+                        "INSERT INTO sync_table (sync_date) VALUES ('" + syncTime + "');"
                 };
                 try {
                     retObj = execute(statements);
@@ -914,50 +898,50 @@ public class Database {
     }
 
     /**
-     * SetSyncDate Method
-     * Set the synchronization date
+     * GetSyncDate method
+     * get the synchronization date
      *
-     * @param syncDate
      * @return
+     * @throws Exception
      */
-    public void setSyncDate(String syncDate) throws Exception {
-        JSObject retObj = new JSObject();
+    public Long getSyncDate() throws Exception {
+        long syncDate = 0;
         try {
             boolean isSyncTable = _uJson.isTableExists(this, "sync_table");
             if (!isSyncTable) {
                 throw new Exception("No sync_table available");
             }
-            SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
-            Date date = formatter.parse(syncDate.replaceAll("Z$", "+0000"));
-            long syncTime = date.getTime() / 1000L;
-            String[] statements = { "UPDATE sync_table SET sync_date = " + syncTime + " WHERE id = 1;" };
-            retObj = execute(statements);
-            if (retObj.getInteger("changes") != Integer.valueOf(-1)) {
-                return;
-            } else {
-                throw new Exception("changes < 0");
-            }
+            syncDate = toJson.getSyncDate(this);
+            return syncDate;
         } catch (Exception e) {
             throw new Exception(e.getMessage());
         }
     }
 
     /**
-     * GetSyncDate method
-     * get the synchronization date
+     * SetSyncDate Method
+     * Set the synchronization date
      *
+     * @param syncDate
      * @return
-     * @throws Exception
      */
-    public Long getSyncDate() throws Exception {
-        long syncDate = 0;
+    public void setSyncDate(String syncDate) throws Exception {
+        JSObject retObj = new JSObject();
         try {
             boolean isSyncTable = _uJson.isTableExists(this, "sync_table");
             if (!isSyncTable) {
                 throw new Exception("No sync_table available");
             }
-            syncDate = toJson.getSyncDate(this);
-            return syncDate;
+            SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
+            Date date = formatter.parse(syncDate.replaceAll("Z$", "+0000"));
+            long syncTime = date.getTime() / 1000L;
+            String[] statements = {"UPDATE sync_table SET sync_date = " + syncTime + " WHERE id = 1;"};
+            retObj = execute(statements);
+            if (retObj.getInteger("changes") != Integer.valueOf(-1)) {
+                return;
+            } else {
+                throw new Exception("changes < 0");
+            }
         } catch (Exception e) {
             throw new Exception(e.getMessage());
         }
@@ -1037,7 +1021,8 @@ public class Database {
         } catch (Exception e) {
             Log.e(TAG, "Error: exportToJson " + e.getMessage());
             throw new Exception(e.getMessage());
-        } finally {}
+        } finally {
+        }
     }
 
     /**