Add support for executing rawQuery with Object varargs as binding parameters

Author: developernotes

sqlcipher/src/androidTest/java/net/zetetic/database/sqlcipher_cts/AndroidSQLCipherTestCase.java

@@ -23,19 +23,18 @@ public abstract class AndroidSQLCipherTestCase {
   protected SQLiteDatabase database;
   protected String DATABASE_NAME = "database_test.db";
   protected String TAG = getClass().getSimpleName();
+  protected File databasePath = null;
   protected Context context = null;
 
   @Before
-  public void setUp() throws Exception {
+  public void setUp() {
     context = InstrumentationRegistry.getInstrumentation().getTargetContext();
     System.loadLibrary("sqlcipher");
-    File databasePath = context.getDatabasePath(DATABASE_NAME);
+    databasePath = context.getDatabasePath(DATABASE_NAME);
     databasePath.mkdirs();
     if (databasePath.exists()) {
       databasePath.delete();
     }
-    database = SQLiteDatabase.openOrCreateDatabase(databasePath, null);
-    assertNotNull(database);
   }
 
   @After

sqlcipher/src/androidTest/java/net/zetetic/database/sqlcipher_cts/SQLCipherDatabaseTest.java

@@ -6,6 +6,7 @@
 import net.zetetic.database.sqlcipher.SQLiteDatabase;
 import net.zetetic.database.sqlcipher.SQLiteDatabaseHook;
 
+import org.junit.Before;
 import org.junit.Test;
 
 import java.io.File;
@@ -18,12 +19,6 @@ public class SQLCipherDatabaseTest extends AndroidSQLCipherTestCase {
   @Test
   public void testConnectionWithPassword(){
     int a = 0, b = 0;
-    database.close();
-    database = null;
-    File databasePath = context.getDatabasePath("foo.db");
-    if(databasePath.exists()){
-      databasePath.delete();
-    }
     database = SQLiteDatabase.openOrCreateDatabase(databasePath, "foo", null, null);
     database.execSQL("create table t1(a,b);");
     database.execSQL("insert into t1(a,b) values(?,?)", new Object[]{1, 2});
@@ -35,4 +30,20 @@ public void testConnectionWithPassword(){
     assertThat(a, is(1));
     assertThat(b, is(2));
   }
+
+  @Test
+  public void insertDataQueryByObjectParams(){
+    float a = 1.25f, a1 = 0.0f;
+    double b = 2.00123d, b1 = 0.0d;
+    database = SQLiteDatabase.openOrCreateDatabase(databasePath, "foo", null, null);
+    database.execSQL("create table t1(a,b);");
+    database.execSQL("insert into t1(a,b) values(?,?)", new Object[]{a, b});
+    Cursor cursor = database.rawQuery("select * from t1 where a = ? and b = ?;", a, b);
+    if(cursor != null && cursor.moveToFirst()){
+      a1 = cursor.getFloat(0);
+      b1 = cursor.getDouble(1);
+    }
+    assertThat(a1, is(a));
+    assertThat(b1, is(b));
+  }
 }

sqlcipher/src/main/java/net/zetetic/database/sqlcipher/SQLiteDatabase.java

@@ -1435,6 +1435,26 @@ public Cursor rawQuery(String sql, String[] selectionArgs) {
         return rawQueryWithFactory(null, sql, selectionArgs, null, null);
     }
 
+    /**
+     * Runs the provided SQL and returns a {@link Cursor} over the result set.
+     *
+     * @param sql the SQL query. The SQL string must not be ; terminated
+     * @param bindingArgs You may include ?s in where clause in the query,
+     *     which will be replaced by the values from bindingArgs. The
+     *     values will be bound as Objects.
+     * @return A {@link Cursor} object, which is positioned before the first entry. Note that
+     * {@link Cursor}s are not synchronized, see the documentation for more details.
+     */
+    public Cursor rawQuery(String sql, Object... bindingArgs) {
+        acquireReference();
+        try {
+            SQLiteDirectCursorDriver driver = new SQLiteDirectCursorDriver(this, sql, null, null);
+            return driver.query(mCursorFactory, bindingArgs);
+        } finally {
+            releaseReference();
+        }
+    }
+
     /**
      * Runs the provided SQL and returns a {@link Cursor} over the result set.
      *

sqlcipher/src/main/java/net/zetetic/database/sqlcipher/SQLiteDirectCursorDriver.java

@@ -64,6 +64,26 @@ public Cursor query(CursorFactory factory, String[] selectionArgs) {
         return cursor;
     }
 
+    public Cursor query(CursorFactory factory, Object... bindingArgs){
+        final SQLiteQuery query = new SQLiteQuery(mDatabase, mSql, mCancellationSignal);
+        final Cursor cursor;
+        try {
+            query.bindAllArgs(bindingArgs);
+
+            if (factory == null) {
+                cursor = new SQLiteCursor(this, mEditTable, query);
+            } else {
+                cursor = factory.newCursor(mDatabase, this, mEditTable, query);
+            }
+        } catch (RuntimeException ex) {
+            query.close();
+            throw ex;
+        }
+
+        mQuery = query;
+        return cursor;
+    }
+
     public void cursorClosed() {
         // Do nothing
     }

sqlcipher/src/main/java/net/zetetic/database/sqlcipher/SQLiteProgram.java

@@ -206,6 +206,22 @@ public void bindAllArgsAsStrings(String[] bindArgs) {
         }
     }
 
+    /**
+     * Given a varargs of Object bindArgs, this method binds all of them in one single call.
+     *
+     * @param bindArgs the varargs of bind args, none of which must be null.
+     */
+    public void bindAllArgs(Object... bindArgs){
+        if (bindArgs != null) {
+            for (int i = bindArgs.length; i != 0; i--) {
+                if (bindArgs[i - 1] == null) {
+                    throw new IllegalArgumentException("the bind value at index " + i + " is null");
+                }
+                bind(i, bindArgs[i - 1]);
+            }
+        }
+    }
+
     @Override
     protected void onAllReferencesReleased() {
         clearBindings();