@capacitor-community/sqlite 5.0.5-2 → 5.0.6

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

@@ -0,0 +1,111 @@
+package com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.util.Base64;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.community.database.sqlite.SQLite.UtilsSecret;
+import java.security.NoSuchAlgorithmException;
+import java.security.SecureRandom;
+import java.security.spec.InvalidKeySpecException;
+import javax.crypto.Cipher;
+import javax.crypto.SecretKey;
+import javax.crypto.SecretKeyFactory;
+import javax.crypto.spec.GCMParameterSpec;
+import javax.crypto.spec.PBEKeySpec;
+import javax.crypto.spec.SecretKeySpec;
+import org.json.JSONObject;
+
+public class UtilsEncryption {
+
+    private static final int ITERATION_COUNT = 65536;
+    private static final String PBKDF2_ALGORITHM = "PBKDF2WithHmacSHA1";
+    private static final String CIPHER_TRANSFORMATION = "AES/GCM/NoPadding";
+
+    private static final String SALT = "jeep_capacitor_sqlite";
+
+    public static String encryptJSONObject(Context context, JSONObject jsonObject) throws Exception {
+        String jsonString = jsonObject.toString();
+
+        if (!UtilsSecret.isPassphrase()) {
+            throw new Exception("encryptJSONObject: No Passphrase stored");
+        }
+        String passphrase = UtilsSecret.getPassphrase();
+
+        try {
+            //     byte[] saltBytes = generateSalt();
+            byte[] saltBytes = SALT.getBytes("UTF-8");
+            // Derive a secure key from the passphrase using PBKDF2
+            SecretKeyFactory factory = SecretKeyFactory.getInstance(PBKDF2_ALGORITHM);
+            PBEKeySpec keySpec = new PBEKeySpec(passphrase.toCharArray(), saltBytes, ITERATION_COUNT, 256);
+            SecretKey secretKey = new SecretKeySpec(factory.generateSecret(keySpec).getEncoded(), "AES");
+
+            Cipher cipher = Cipher.getInstance(CIPHER_TRANSFORMATION);
+            // Extract the IV from the saltBytes (first 12 bytes for GCM)
+            GCMParameterSpec spec = new GCMParameterSpec(128, saltBytes, 0, 12);
+            cipher.init(Cipher.ENCRYPT_MODE, secretKey, spec);
+
+            byte[] encryptedBytes = cipher.doFinal(jsonString.getBytes());
+
+            // Concatenate salt and encrypted data for storage
+            byte[] combined = new byte[saltBytes.length + encryptedBytes.length];
+            System.arraycopy(saltBytes, 0, combined, 0, saltBytes.length);
+            System.arraycopy(encryptedBytes, 0, combined, saltBytes.length, encryptedBytes.length);
+
+            return Base64.encodeToString(combined, Base64.DEFAULT);
+        } catch (Exception e) {
+            e.printStackTrace();
+            throw new Exception("encryptJSONObject: " + e.getMessage());
+        }
+    }
+
+    // Decrypts the JSONObject from the Base64 string
+    public static JSObject decryptJSONObject(Context context, String encryptedBase64) throws Exception {
+        if (!UtilsSecret.isPassphrase()) {
+            throw new Exception("decryptJSONObject: No Passphrase stored");
+        }
+        String passphrase = UtilsSecret.getPassphrase();
+
+        try {
+            byte[] combined = Base64.decode(encryptedBase64, Base64.DEFAULT);
+
+            //      byte[] saltBytes =  generateSalt();
+            byte[] saltBytes = SALT.getBytes("UTF-8");
+
+            byte[] encryptedBytes = new byte[combined.length - saltBytes.length];
+            System.arraycopy(combined, 0, saltBytes, 0, saltBytes.length);
+            System.arraycopy(combined, saltBytes.length, encryptedBytes, 0, encryptedBytes.length);
+
+            // Derive a secure key from the passphrase using PBKDF2
+            SecretKeyFactory factory = SecretKeyFactory.getInstance(PBKDF2_ALGORITHM);
+            PBEKeySpec keySpec = new PBEKeySpec(passphrase.toCharArray(), saltBytes, ITERATION_COUNT, 256);
+            SecretKey secretKey = new SecretKeySpec(factory.generateSecret(keySpec).getEncoded(), "AES");
+
+            Cipher cipher = Cipher.getInstance(CIPHER_TRANSFORMATION);
+
+            // Extract the IV from the saltBytes (first 12 bytes for GCM)
+            GCMParameterSpec spec = new GCMParameterSpec(128, saltBytes, 0, 12);
+            cipher.init(Cipher.DECRYPT_MODE, secretKey, spec);
+
+            byte[] decryptedBytes = cipher.doFinal(encryptedBytes);
+            return new JSObject(new String(decryptedBytes, "UTF-8"));
+        } catch (Exception e) {
+            e.printStackTrace();
+            throw new Exception("decryptJSONObject: " + e.getMessage());
+        }
+    }
+
+    // Other methods...
+
+    private static byte[] generateSalt() {
+        try {
+            SecureRandom secureRandom = SecureRandom.getInstance("SHA1PRNG");
+            byte[] salt = new byte[16]; // 16 bytes is recommended for AES
+            secureRandom.nextBytes(salt);
+            return salt;
+        } catch (NoSuchAlgorithmException e) {
+            e.printStackTrace();
+        }
+        return null;
+    }
+}

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

@@ -1,7 +1,6 @@
 package com.getcapacitor.community.database.sqlite.SQLite;
 
 import android.content.Context;
-import android.content.SharedPreferences;
 import android.util.Log;
 import android.widget.Toast;
 import androidx.annotation.NonNull;
@@ -9,9 +8,6 @@ import androidx.biometric.BiometricManager;
 import androidx.biometric.BiometricPrompt;
 import androidx.core.content.ContextCompat;
 import androidx.fragment.app.FragmentActivity;
-import androidx.security.crypto.MasterKey;
-import java.io.IOException;
-import java.security.GeneralSecurityException;
 import java.util.concurrent.Executor;
 
 public class UtilsBiometric {

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

@@ -2,9 +2,7 @@ package com.getcapacitor.community.database.sqlite.SQLite;
 
 import android.content.Context;
 import android.content.res.AssetManager;
-import android.os.Build;
 import android.util.Log;
-import androidx.annotation.RequiresApi;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
@@ -12,16 +10,8 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.nio.channels.FileChannel;
-import java.nio.file.DirectoryStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
 import java.util.ArrayList;
-import java.util.HashSet;
 import java.util.List;
-import java.util.Set;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
@@ -90,7 +80,10 @@ public class UtilsFile {
             String pathDB = new File(context.getFilesDir().getParentFile(), "databases").getAbsolutePath();
             File dirDB = new File(pathDB);
             if (!dirDB.isDirectory()) {
-                dirDB.mkdir();
+                boolean nDir = dirDB.mkdir();
+                if (!nDir) {
+                    throw new Exception("Cannot create dir" + pathDB);
+                }
             }
 
             // look into the public/assets/databases to get databases to copy
@@ -228,7 +221,10 @@ public class UtilsFile {
 
         try {
             if (!toFile.exists()) {
-                toFile.createNewFile();
+                boolean cFile = toFile.createNewFile();
+                if (!cFile) {
+                    throw new Exception("Cannot create file" + dbName);
+                }
             }
             copyFileFromFile(file, toFile);
             return true;
@@ -240,13 +236,19 @@ public class UtilsFile {
 
     public Boolean copyFromNames(Context context, String fromPath, String fromName, String toPath, String toName) {
         File fromFile = new File(fromPath, fromName);
-        fromFile.setReadable(true, false);
+        boolean fFile = fromFile.setReadable(true, false);
+        if (!fFile) {
+            Log.e(TAG, "Error: in fromFile " + fromName);
+            return false;
+        }
         File toFile = context.getDatabasePath(toName);
         try {
             if (!toFile.exists()) {
-                toFile.createNewFile();
-                //                toFile.setReadable(true, false);
-
+                boolean cFile = toFile.createNewFile();
+                if (!cFile) {
+                    Log.e(TAG, "Error: in toFile " + toName);
+                    return false;
+                }
             }
             copyFileFromFile(fromFile, toFile);
             return true;
@@ -372,10 +374,20 @@ public class UtilsFile {
     }
 
     private static void copyFileFromFile(File sourceFile, File destFile) throws IOException {
-        if (!destFile.getParentFile().exists()) destFile.getParentFile().mkdirs();
+        if (!destFile.getParentFile().exists()) {
+            boolean mDir = destFile.getParentFile().mkdirs();
+            if (!mDir) {
+                String message = "failed in creating directory";
+                throw new IOException(message);
+            }
+        }
 
         if (!destFile.exists()) {
-            destFile.createNewFile();
+            boolean cFile = destFile.createNewFile();
+            if (!cFile) {
+                String message = "failed in creating new file";
+                throw new IOException(message);
+            }
         }
 
         FileChannel source = null;

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

@@ -1,7 +1,6 @@
 package com.getcapacitor.community.database.sqlite.SQLite;
 
 import android.content.Context;
-import com.getcapacitor.community.database.sqlite.SQLite.UtilsFile;
 import java.io.File;
 import java.util.ArrayList;
 
@@ -14,7 +13,10 @@ public class UtilsMigrate {
         String pathDB = new File(context.getFilesDir().getParentFile(), "databases").getAbsolutePath();
         File dirDB = new File(pathDB);
         if (!dirDB.isDirectory()) {
-            dirDB.mkdir();
+            boolean nDir = dirDB.mkdir();
+            if (!nDir) {
+                throw new Exception("Cannot create dir" + pathDB);
+            }
         }
         String pathFiles = this.getFolder(context, folderPath);
         // check if the path exists
@@ -30,7 +32,10 @@ public class UtilsMigrate {
         String pathDB = new File(context.getFilesDir().getParentFile(), "databases").getAbsolutePath();
         File dirDB = new File(pathDB);
         if (!dirDB.isDirectory()) {
-            dirDB.mkdir();
+            boolean nDir = dirDB.mkdir();
+            if (!nDir) {
+                throw new Exception("Cannot create dir" + pathDB);
+            }
         }
         String pathFiles = this.getFolder(context, folderPath);
         // check if the path exists
@@ -129,7 +134,10 @@ public class UtilsMigrate {
         String pathDB = new File(context.getFilesDir().getParentFile(), "databases").getAbsolutePath();
         File dirDB = new File(pathDB);
         if (!dirDB.isDirectory()) {
-            dirDB.mkdir();
+            boolean nDir = dirDB.mkdir();
+            if (!nDir) {
+                throw new Exception("Cannot create dir" + pathDB);
+            }
         }
         String pathFiles = this.getFolder(context, folderPath);
         // check if the path exists

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

@@ -12,7 +12,10 @@ public class UtilsNCDatabase {
         String pathDB = new File(context.getFilesDir().getParentFile(), "databases").getAbsolutePath();
         File dirDB = new File(pathDB);
         if (!dirDB.isDirectory()) {
-            dirDB.mkdir();
+            boolean nDir = dirDB.mkdir();
+            if (!nDir) {
+                throw new Exception("Cannot create dir" + pathDB);
+            }
         }
         String pathFiles = uMigrate.getFolder(context, folderPath);
         // check if the path exists

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

@@ -2,13 +2,9 @@ package com.getcapacitor.community.database.sqlite.SQLite;
 
 import android.content.Context;
 import android.content.SharedPreferences;
-import android.text.Editable;
-import android.util.Log;
-import androidx.sqlite.db.SupportSQLiteDatabase;
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.util.Arrays;
 import net.sqlcipher.database.SQLiteDatabase;
 import net.sqlcipher.database.SQLiteException;
 import net.sqlcipher.database.SQLiteStatement;
@@ -125,8 +121,14 @@ public class UtilsSQLCipher {
             st.close();
             db.close();
 
-            originalFile.delete();
-            newFile.renameTo(originalFile);
+            boolean delFile = originalFile.delete();
+            if (!delFile) {
+                throw new FileNotFoundException(originalFile.getAbsolutePath() + " not deleted");
+            }
+            boolean renFile = newFile.renameTo(originalFile);
+            if (!renFile) {
+                throw new FileNotFoundException(originalFile.getAbsolutePath() + " not renamed");
+            }
         } else {
             throw new FileNotFoundException(originalFile.getAbsolutePath() + " not found");
         }

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

@@ -3,8 +3,6 @@ package com.getcapacitor.community.database.sqlite.SQLite;
 import android.util.Log;
 import androidx.sqlite.db.SupportSQLiteDatabase;
 import com.getcapacitor.JSArray;
-import java.nio.ByteBuffer;
-import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -21,44 +19,32 @@ public class UtilsSQLite {
         String SELECT_CHANGE = "SELECT total_changes()";
         Boolean success = true;
         int ret = Integer.valueOf(-1);
-        try {
-            Cursor cursor = (Cursor) db.query(SELECT_CHANGE, null);
-            if (cursor != null) {
-                if (cursor.moveToFirst()) {
-                    ret = Integer.parseInt(cursor.getString(0));
-                }
+        Cursor cursor = (Cursor) db.query(SELECT_CHANGE, null);
+        if (cursor != null) {
+            if (cursor.moveToFirst()) {
+                ret = Integer.parseInt(cursor.getString(0));
             }
-            cursor.close();
-        } catch (Exception e) {
-            Log.d(TAG, "Error: dbChanges failed: ", e);
-        } finally {
-            return ret;
         }
+        cursor.close();
+        return ret;
     }
 
     public long dbLastId(SupportSQLiteDatabase db) {
         String SELECT_CHANGE = "SELECT last_insert_rowid()";
         Boolean success = true;
-        long ret = Long.valueOf(-1);
-        try {
-            Cursor cursor = (Cursor) db.query(SELECT_CHANGE, null);
-            if (cursor != null) {
-                if (cursor.moveToFirst()) {
-                    ret = Long.parseLong(cursor.getString(0));
-                }
-            }
-            cursor.close();
-        } catch (Exception e) {
-            Log.d(TAG, "Error: dbLastId failed: ", e);
-        } finally {
-            return ret;
+        long ret = (long) -1;
+        Cursor cursor = (Cursor) db.query(SELECT_CHANGE, null);
+        if (cursor.moveToFirst()) {
+            ret = Long.parseLong(cursor.getString(0));
         }
+        cursor.close();
+        return ret;
     }
 
     public String[] getStatementsArray(String statements) {
-        statements.replace("end;", "END;");
+        String stmts = statements.replace("end;", "END;");
         // split for each statement
-        String[] sqlCmdArray = statements.split(";\n");
+        String[] sqlCmdArray = stmts.split(";\n");
         // deal with trigger if any
         sqlCmdArray = dealWithTriggers(sqlCmdArray);
         // split for a single statement on multilines

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

@@ -9,7 +9,6 @@ import android.content.Context;
 import android.content.SharedPreferences;
 import android.text.TextUtils;
 import java.io.File;
-import net.sqlcipher.database.SQLiteDatabase;
 
 public class UtilsSecret {
 
@@ -18,7 +17,7 @@ public class UtilsSecret {
     private GlobalSQLite globVar = new GlobalSQLite();
     private UtilsSQLCipher uCipher = new UtilsSQLCipher();
 
-    private SharedPreferences sharedPreferences;
+    private static SharedPreferences sharedPreferences;
     private Context context;
 
     public UtilsSecret(Context context, SharedPreferences sharedPreferences) {
@@ -159,7 +158,7 @@ public class UtilsSecret {
         sharedPreferences.edit().putString("secret", passphrase).apply();
     }
 
-    public String getPassphrase() {
+    public static String getPassphrase() {
         String passphrase = sharedPreferences.getString("secret", "");
         return passphrase;
     }
@@ -168,7 +167,7 @@ public class UtilsSecret {
         sharedPreferences.edit().remove("secret").commit();
     }
 
-    public Boolean isPassphrase() {
+    public static Boolean isPassphrase() {
         if (!getPassphrase().isEmpty()) {
             return true;
         }

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

@@ -1,7 +1,6 @@
 package com.getcapacitor.community.database.sqlite.SQLite;
 
 import android.util.Log;
-import com.getcapacitor.JSObject;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Dictionary;

package/dist/esm/definitions.d.ts

@@ -112,6 +112,18 @@ export interface CapacitorSQLitePlugin {
      * @since 0.0.1
      */
     close(options: capSQLiteOptions): Promise<void>;
+    /**
+     * Load a SQlite extension
+     * @param options :capSQLiteExtensionPath
+     * @returns Promise<void>
+     * @since 5.0.6
+     */
+    /**
+     * Enable Or Disable Extension Loading
+     * @param options
+     * @returns Promise<void>
+     * @since 5.0.6
+     */
     /**
      * GetUrl get the database Url
      * @param options: capSQLiteOptions
@@ -378,6 +390,38 @@ export interface capEchoOptions {
      */
     value?: string;
 }
+export interface capSQLiteExtensionPath {
+    /**
+     * The database name
+     */
+    database?: string;
+    /**
+     * The extension path
+     */
+    path?: string;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
+}
+export interface capSQLiteExtensionEnable {
+    /**
+     * The database name
+     */
+    database?: string;
+    /**
+     * The enabling toggle (1: ON, 0: OFF)
+     */
+    toggle?: boolean;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
+}
 export interface capConnectionOptions {
     /**
      * The database name
@@ -492,6 +536,14 @@ export interface capSQLiteSetOptions {
      * @since 4.1.0-7
      */
     readonly?: boolean;
+    /**
+     * return mode
+     * default 'no'
+     * value 'all'
+     * value 'one' for Electron platform
+     * @since 5.0.5-3
+     */
+    returnMode?: string;
 }
 export interface capSQLiteRunOptions {
     /**
@@ -518,6 +570,14 @@ export interface capSQLiteRunOptions {
      * @since 4.1.0-7
      */
     readonly?: boolean;
+    /**
+     * return mode
+     * default 'no'
+     * value 'all'
+     * value 'one' for Electron platform
+     * @since 5.0.5-3
+     */
+    returnMode?: string;
 }
 export interface capSQLiteQueryOptions {
     /**
@@ -706,6 +766,10 @@ export interface Changes {
      * the lastId created from a run command
      */
     lastId?: number;
+    /**
+     * values when RETURNING
+     */
+    values?: any[];
 }
 export interface capSQLiteValues {
     /**
@@ -732,6 +796,12 @@ export interface capSQLiteSyncDate {
      */
     syncDate?: number;
 }
+export interface EncryptJson {
+    /**
+     * The encrypted JsonSQLite base64 string
+     */
+    expData: string;
+}
 export interface JsonSQLite {
     /**
      * The database name
@@ -1243,6 +1313,20 @@ export interface ISQLiteDBConnection {
      * @since 3.2.0
      */
     getVersion(): Promise<capVersionResult>;
+    /**
+     * Load a SQlite extension
+     * @param path :SQlite extension path
+     * @returns Promise<void>
+     * @since 5.0.6
+     */
+    loadExtension(path: string): Promise<void>;
+    /**
+     * Enable Or Disable Extension Loading
+     * @param toggle true:on false:off
+     * @returns Promise<void>
+     * @since 5.0.6
+     */
+    enableLoadExtension(toggle: boolean): Promise<void>;
     /**
      * Execute SQLite DB Connection Statements
      * @param statements
@@ -1265,14 +1349,14 @@ export interface ISQLiteDBConnection {
      * @returns Promise<capSQLiteChanges>
      * @since 2.9.0 refactor
      */
-    run(statement: string, values?: any[], transaction?: boolean): Promise<capSQLiteChanges>;
+    run(statement: string, values?: any[], transaction?: boolean, returnMode?: string): Promise<capSQLiteChanges>;
     /**
      * Execute SQLite DB Connection Set
      * @param set
      * @returns Promise<capSQLiteChanges>
      * @since 2.9.0 refactor
      */
-    executeSet(set: capSQLiteSet[], transaction?: boolean): Promise<capSQLiteChanges>;
+    executeSet(set: capSQLiteSet[], transaction?: boolean, returnMode?: string): Promise<capSQLiteChanges>;
     /**
      * Check if a SQLite DB Connection exists
      * @returns Promise<capSQLiteResult>
@@ -1357,13 +1441,15 @@ export declare class SQLiteDBConnection implements ISQLiteDBConnection {
     getConnectionReadOnly(): boolean;
     open(): Promise<void>;
     close(): Promise<void>;
+    loadExtension(path: string): Promise<void>;
+    enableLoadExtension(toggle: boolean): Promise<void>;
     getUrl(): Promise<capSQLiteUrl>;
     getVersion(): Promise<capVersionResult>;
     getTableList(): Promise<DBSQLiteValues>;
     execute(statements: string, transaction?: boolean): Promise<capSQLiteChanges>;
     query(statement: string, values?: any[]): Promise<DBSQLiteValues>;
-    run(statement: string, values?: any[], transaction?: boolean): Promise<capSQLiteChanges>;
-    executeSet(set: capSQLiteSet[], transaction?: boolean): Promise<capSQLiteChanges>;
+    run(statement: string, values?: any[], transaction?: boolean, returnMode?: string): Promise<capSQLiteChanges>;
+    executeSet(set: capSQLiteSet[], transaction?: boolean, returnMode?: string): Promise<capSQLiteChanges>;
     isExists(): Promise<capSQLiteResult>;
     isTable(table: string): Promise<capSQLiteResult>;
     isDBOpen(): Promise<capSQLiteResult>;
@@ -1377,4 +1463,5 @@ export declare class SQLiteDBConnection implements ISQLiteDBConnection {
         statement: string;
         values?: any[];
     }[]): Promise<void>;
+    private reorderRows;
 }