Add ability to enter DB password on runtime

Author: prattpratt

README.md

@@ -70,14 +70,6 @@ If you are using `build.gradle.kts`, add the following:
 debugImplementation("com.github.amitshekhariitbhu.Android-Debug-Database:debug-db-encrypt:1.0.7")
 ```
 
-And to provide the password for the DB, you should add this in the Gradle:
-DB_PASSWORD_{VARIABLE}, if for example, PERSON is the database name: DB_PASSWORD_PERSON
-```groovy
-debug {
-    resValue("string", "DB_PASSWORD_PERSON", "password")
-}
-```
-
 Use `debugImplementation` so that it will only compile in your debug build and not in your release build.
 
 That’s all, just start the application, you will see in the logcat an entry like follows :
@@ -147,11 +139,11 @@ public static void setCustomDatabaseFiles(Context context) {
             Class<?> debugDB = Class.forName("com.amitshekhar.DebugDB");
             Class[] argTypes = new Class[]{HashMap.class};
             Method setCustomDatabaseFiles = debugDB.getMethod("setCustomDatabaseFiles", argTypes);
-            HashMap<String, Pair<File, String>> customDatabaseFiles = new HashMap<>();
+            HashMap<String, File> customDatabaseFiles = new HashMap<>();
             // set your custom database files
             customDatabaseFiles.put(ExtTestDBHelper.DATABASE_NAME,
-                    new Pair<>(new File(context.getFilesDir() + "/" + ExtTestDBHelper.DIR_NAME +
-                                                    "/" + ExtTestDBHelper.DATABASE_NAME), ""));
+                    new File(context.getFilesDir() + "/" + ExtTestDBHelper.DIR_NAME +
+                                                    "/" + ExtTestDBHelper.DATABASE_NAME));
             setCustomDatabaseFiles.invoke(null, customDatabaseFiles);
         } catch (Exception ignore) {
 

debug-db-base/src/main/assets/app.js

@@ -79,6 +79,10 @@ function getDBList() {
    $.ajax({url: "getDbList", success: function(result){
 
            result = JSON.parse(result);
+           if (!result.supportEncryptedDb) {
+                $('#password').hide();
+                $('#password-label').hide();
+           }
            var dbList = result.rows;
            $('#db-list').empty();
            var isSelectionDone = false;
@@ -130,8 +134,8 @@ function openDatabaseAndGetTableList(db, isDownloadable) {
         isDatabaseSelected = true;
     }
 
-
-   $.ajax({url: "getTableList?database="+db, success: function(result){
+    var password = $('#password').val();
+    $.ajax({url: "getTableList?database="+db+"&password="+password, success: function(result){
 
            result = JSON.parse(result);
            var tableList = result.rows;

debug-db-base/src/main/assets/index.html

@@ -107,6 +107,8 @@
     <div class="row padding-twenty">
         <div class="col-sm-12">
             <div class="form-group">
+                <label for="password" id="password-label">DB password</label>
+                <input class="form-control" id="password">
                 <label for="query">Query</label>
                 <input class="form-control" id="query">
             </div>

debug-db-base/src/main/java/com/amitshekhar/DebugDB.java

@@ -76,7 +76,7 @@ public static void shutDown() {
         }
     }
 
-    public static void setCustomDatabaseFiles(HashMap<String, Pair<File, String>> customDatabaseFiles) {
+    public static void setCustomDatabaseFiles(HashMap<String, File> customDatabaseFiles) {
         if (clientServer != null) {
             clientServer.setCustomDatabaseFiles(customDatabaseFiles);
         }

debug-db-base/src/main/java/com/amitshekhar/model/Response.java

@@ -33,6 +33,7 @@ public class Response {
     public boolean isSuccessful;
     public String error;
     public int dbVersion;
+    public boolean supportEncryptedDb;
 
     public Response() {
 

debug-db-base/src/main/java/com/amitshekhar/server/ClientServer.java

@@ -87,7 +87,7 @@ public void run() {
         }
     }
 
-    public void setCustomDatabaseFiles(HashMap<String, Pair<File, String>> customDatabaseFiles) {
+    public void setCustomDatabaseFiles(HashMap<String, File> customDatabaseFiles) {
         mRequestHandler.setCustomDatabaseFiles(customDatabaseFiles);
     }
 

debug-db-base/src/main/java/com/amitshekhar/server/RequestHandler.java

@@ -65,8 +65,8 @@ public class RequestHandler {
     private final DBFactory mDbFactory;
     private boolean isDbOpened;
     private SQLiteDB sqLiteDB;
-    private HashMap<String, Pair<File, String>> mDatabaseFiles;
-    private HashMap<String, Pair<File, String>> mCustomDatabaseFiles;
+    private HashMap<String, File> mDatabaseFiles;
+    private HashMap<String, File> mCustomDatabaseFiles;
     private String mSelectedDatabase = null;
     private HashMap<String, SupportSQLiteDatabase> mRoomInMemoryDatabases = new HashMap<>();
 
@@ -165,7 +165,7 @@ public void handle(Socket socket) throws IOException {
         }
     }
 
-    public void setCustomDatabaseFiles(HashMap<String, Pair<File, String>> customDatabaseFiles) {
+    public void setCustomDatabaseFiles(HashMap<String, File> customDatabaseFiles) {
         mCustomDatabaseFiles = customDatabaseFiles;
     }
 
@@ -178,13 +178,12 @@ private void writeServerError(PrintStream output) {
         output.flush();
     }
 
-    private void openDatabase(String database) {
+    private void openDatabase(String database, String password) {
         closeDatabase();
         if (mRoomInMemoryDatabases.containsKey(database)) {
             sqLiteDB = new InMemoryDebugSQLiteDB(mRoomInMemoryDatabases.get(database));
         } else {
-            File databaseFile = mDatabaseFiles.get(database).first;
-            String password = mDatabaseFiles.get(database).second;
+            File databaseFile = mDatabaseFiles.get(database);
             sqLiteDB = mDbFactory.create(mContext, databaseFile.getAbsolutePath(), password);
         }
         isDbOpened = true;
@@ -205,8 +204,10 @@ private String getDBListResponse() {
         }
         Response response = new Response();
         if (mDatabaseFiles != null) {
-            for (HashMap.Entry<String, Pair<File, String>> entry : mDatabaseFiles.entrySet()) {
-                String[] dbEntry = {entry.getKey(), !entry.getValue().second.equals("") ? "true" : "false", "true"};
+            for (HashMap.Entry<String, File> entry : mDatabaseFiles.entrySet()) {
+                String[] dbEntry = { entry.getKey(),
+                        Utils.isDbEncrypted(entry.getKey(), mDatabaseFiles) ? "true" : "false",
+                        "true" };
                 response.rows.add(dbEntry);
             }
         }
@@ -218,6 +219,7 @@ private String getDBListResponse() {
         }
         response.rows.add(new String[]{Constants.APP_SHARED_PREFERENCES, "false", "false"});
         response.isSuccessful = true;
+        response.supportEncryptedDb = mDbFactory.supportEncryptedDb();
         return mGson.toJson(response);
     }
 
@@ -292,10 +294,9 @@ private String executeQueryAndGetResponse(String route) {
     }
 
     private String getTableListResponse(String route) {
-        String database = null;
-        if (route.contains("?database=")) {
-            database = route.substring(route.indexOf("=") + 1, route.length());
-        }
+        Uri uri = Uri.parse(route);
+        String database = uri.getQueryParameter("database");
+        String password = uri.getQueryParameter("password");
 
         Response response;
 
@@ -305,7 +306,7 @@ private String getTableListResponse(String route) {
             mSelectedDatabase = Constants.APP_SHARED_PREFERENCES;
         } else {
             try {
-                openDatabase(database);
+                openDatabase(database, password);
                 response = DatabaseHelper.getAllTableName(sqLiteDB);
             } catch (Exception e) {
                 response = new Response();
@@ -397,7 +398,7 @@ private String deleteSelectedDatabaseAndGetResponse() {
         try {
             closeDatabase();
 
-            File dbFile = mDatabaseFiles.get(mSelectedDatabase).first;
+            File dbFile = mDatabaseFiles.get(mSelectedDatabase);
             response.isSuccessful = dbFile.delete();
 
             if (response.isSuccessful) {

debug-db-base/src/main/java/com/amitshekhar/sqlite/DBFactory.java

@@ -6,4 +6,6 @@ public interface DBFactory {
 
     SQLiteDB create(Context context, String path, String password);
 
+    boolean supportEncryptedDb();
+
 }

debug-db-base/src/main/java/com/amitshekhar/utils/DatabaseFileProvider.java

@@ -20,10 +20,8 @@
 package com.amitshekhar.utils;
 
 import android.content.Context;
-import android.util.Pair;
 
 import java.io.File;
-import java.text.MessageFormat;
 import java.util.HashMap;
 
 /**
@@ -32,39 +30,19 @@
 
 public class DatabaseFileProvider {
 
-    private final static String DB_PASSWORD_RESOURCE = "DB_PASSWORD_{0}";
-
     private DatabaseFileProvider() {
         // This class in not publicly instantiable
     }
 
-    public static HashMap<String, Pair<File, String>> getDatabaseFiles(Context context) {
-        HashMap<String, Pair<File, String>> databaseFiles = new HashMap<>();
+    public static HashMap<String, File> getDatabaseFiles(Context context) {
+        HashMap<String, File> databaseFiles = new HashMap<>();
         try {
             for (String databaseName : context.databaseList()) {
-                String password = getDbPasswordFromStringResources(context, databaseName);
-                databaseFiles.put(databaseName, new Pair<>(context.getDatabasePath(databaseName), password));
+                databaseFiles.put(databaseName, context.getDatabasePath(databaseName));
             }
         } catch (Exception e) {
             e.printStackTrace();
         }
         return databaseFiles;
     }
-
-    private static String getDbPasswordFromStringResources(Context context, String name) {
-        String nameWithoutExt = name;
-        if (nameWithoutExt.endsWith(".db")) {
-            nameWithoutExt = nameWithoutExt.substring(0, nameWithoutExt.lastIndexOf('.'));
-        }
-        String resourceName = MessageFormat.format(DB_PASSWORD_RESOURCE, nameWithoutExt.toUpperCase());
-        String password = "";
-
-        int resourceId = context.getResources().getIdentifier(resourceName, "string", context.getPackageName());
-
-        if (resourceId != 0) {
-            password = context.getString(resourceId);
-        }
-
-        return password;
-    }
 }

debug-db-base/src/main/java/com/amitshekhar/utils/Utils.java

@@ -21,16 +21,15 @@
 
 import android.content.res.AssetManager;
 import android.text.TextUtils;
-import android.util.Log;
-import android.util.Pair;
 
 import java.io.ByteArrayOutputStream;
+import java.io.DataInputStream;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Created by amitshekhar on 06/02/17.
@@ -83,35 +82,44 @@ public static byte[] loadContent(String fileName, AssetManager assetManager) thr
         }
     }
 
-    public static byte[] getDatabase(String selectedDatabase, HashMap<String, Pair<File, String>> databaseFiles) {
+    public static byte[] getDatabase(String selectedDatabase, Map<String, File> databaseFiles) {
         if (TextUtils.isEmpty(selectedDatabase) || !databaseFiles.containsKey(selectedDatabase)) {
             return null;
         }
 
         byte[] byteArray = new byte[0];
-        try {
-            File file = databaseFiles.get(selectedDatabase).first;
+        File file = databaseFiles.get(selectedDatabase);
 
-            byteArray = null;
-            try {
-                InputStream inputStream = new FileInputStream(file);
-                ByteArrayOutputStream bos = new ByteArrayOutputStream();
-                byte[] b = new byte[(int) file.length()];
-                int bytesRead;
+        try (InputStream is = new FileInputStream(file);
+             ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
+            byte[] b = new byte[(int) file.length()];
+            int bytesRead;
 
-                while ((bytesRead = inputStream.read(b)) != -1) {
-                    bos.write(b, 0, bytesRead);
-                }
-
-                byteArray = bos.toByteArray();
-            } catch (IOException e) {
-                Log.e(TAG, "getDatabase: ", e);
+            while ((bytesRead = is.read(b)) != -1) {
+                bos.write(b, 0, bytesRead);
             }
+
+            byteArray = bos.toByteArray();
         } catch (Exception e) {
             e.printStackTrace();
         }
 
         return byteArray;
     }
 
+    public static boolean isDbEncrypted(String database, Map<String, File> databaseFiles) {
+        if (TextUtils.isEmpty(database) || !databaseFiles.containsKey(database)) {
+            return false;
+        }
+        File file = databaseFiles.get(database);
+        try (DataInputStream is = new DataInputStream(new FileInputStream(file))) {
+            byte[] b = new byte[16];
+            is.readFully(b);
+            String string = new String(b);
+            return !"SQLite format 3\000".equals(string);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+        return false;
+    }
 }