Explicitly allow specifying WAL journal mode with SQLiteOpenHelper constructor

Author: developernotes

sqlcipher/src/androidTest/assets/sqlcipher-4-wal-journal.db

@@ -26,7 +26,7 @@ class MyHelper extends SQLiteOpenHelper {
     public static final String DATABASE_NAME = "mydb.db";
 
     public MyHelper(Context ctx){
-        super(ctx, ctx.getDatabasePath(DATABASE_NAME).getAbsolutePath(), "secret", null, 1, 1, null, null);
+        super(ctx, ctx.getDatabasePath(DATABASE_NAME).getAbsolutePath(), "secret", null, 1, 1, null, null, false);
     }
     public void onConfigure(SQLiteDatabase db){
         db.enableWriteAheadLogging();

sqlcipher/src/androidTest/java/net/zetetic/database/SQLCipherWALTestScenario.java

@@ -481,7 +481,7 @@ public void shouldRetrieveLargeSingleRowResultFromCursor(){
   public void shouldAllowCursorWindowToResize(){
     try {
       Cursor cursor;
-      int id = 1, extra = 100, size = 256;
+      int id = 1, extra = 1024, size = 256;
       byte[] tooLargeQueriedData = null;
       SQLiteCursor.setCursorWindowSize(size);
       byte[] tooLargeData = generateRandomBytes(size + extra);

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

@@ -15,6 +15,8 @@
 
 import org.junit.Test;
 
+import java.io.File;
+
 public class SQLCipherOpenHelperTest extends AndroidSQLCipherTestCase {
 
   @Test
@@ -28,6 +30,43 @@ public void shouldAccessReadOnlyDatabaseFromOpenHelper(){
     assertThat(db, is(notNullValue()));
   }
 
+  @Test
+  public void shouldSpecifyWALModeFromSQLiteOpenHelperConstructor(){
+    database.close();
+    File file = extractAssetToDatabaseDirectory("sqlcipher-4-wal-journal.db");
+    SqlCipherOpenHelper helper = new SqlCipherOpenHelper(context, file, "test", true);
+    SQLiteDatabase database = helper.getWritableDatabase();
+    SQLiteStatement statement = database.compileStatement("PRAGMA journal_mode;");
+    String mode = statement.simpleQueryForString();
+    statement.close();
+    assertThat(mode, is("wal"));
+  }
+
+  @Test
+  public void shouldIgnoreWALModeInDatabaseWhenExplicitlyDisableInConstructor(){
+    database.close();
+    File file = extractAssetToDatabaseDirectory("sqlcipher-4-wal-journal.db");
+    SqlCipherOpenHelper helper = new SqlCipherOpenHelper(context, file, "test", false);
+    SQLiteDatabase database = helper.getWritableDatabase();
+    SQLiteStatement statement = database.compileStatement("PRAGMA journal_mode;");
+    String mode = statement.simpleQueryForString();
+    statement.close();
+    assertThat(mode, is("delete"));
+  }
+
+  @Test
+  public void shouldAllowWALModeWhenEnabledViaSettingFromHelperInstance(){
+    database.close();
+    File file = extractAssetToDatabaseDirectory("sqlcipher-4-wal-journal.db");
+    SqlCipherOpenHelper helper = new SqlCipherOpenHelper(context, file, "test", false);
+    helper.setWriteAheadLoggingEnabled(true);
+    SQLiteDatabase database = helper.getWritableDatabase();
+    SQLiteStatement statement = database.compileStatement("PRAGMA journal_mode;");
+    String mode = statement.simpleQueryForString();
+    statement.close();
+    assertThat(mode, is("wal"));
+  }
+
   private class SqlCipherOpenHelper extends SQLiteOpenHelper {
 
     private final String TAG = getClass().getSimpleName();
@@ -43,7 +82,11 @@ public void preKey(SQLiteConnection sqLiteConnection) {
         public void postKey(SQLiteConnection sqLiteConnection) {
           Log.d(SQLCipherOpenHelperTest.this.TAG, "postKey()");
         }
-      });
+      }, false);
+    }
+
+    public SqlCipherOpenHelper(Context context, File file, String password, boolean enableWriteAheadLogging){
+      super(context, file.getAbsolutePath(), password, null, 1, 1, null, null, enableWriteAheadLogging);
     }
 
     @Override

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

@@ -17,6 +17,6 @@ public void shouldExtractLibraryCipherVersion() {
       cipherVersion = cursor.getString(0);
       cursor.close();
     }
-    assertThat(cipherVersion, containsString("4.5.0"));
+    assertThat(cipherVersion, containsString("4.5.1"));
   }
 }

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

@@ -140,7 +140,7 @@ public SQLiteOpenHelper(Context context, String name, CursorFactory factory, int
     public SQLiteOpenHelper(Context context, String name, CursorFactory factory, int version,
             int minimumSupportedVersion, DatabaseErrorHandler errorHandler) {
         this(context, name, new byte[0], factory, version, minimumSupportedVersion,
-            errorHandler, null);
+            errorHandler, null, false);
     }
 
     /**
@@ -170,9 +170,10 @@ public SQLiteOpenHelper(Context context, String name, CursorFactory factory, int
      */
     public SQLiteOpenHelper(Context context, String name, String password, CursorFactory factory,
                             int version, int minimumSupportedVersion,
-                            DatabaseErrorHandler errorHandler, SQLiteDatabaseHook databaseHook){
+                            DatabaseErrorHandler errorHandler, SQLiteDatabaseHook databaseHook,
+                            boolean enableWriteAheadLogging) {
         this(context, name, getBytes(password), factory, version, minimumSupportedVersion,
-            errorHandler, databaseHook);
+            errorHandler, databaseHook, enableWriteAheadLogging);
     }
 
     /**
@@ -202,7 +203,8 @@ public SQLiteOpenHelper(Context context, String name, String password, CursorFac
      */
     public SQLiteOpenHelper(Context context, String name, byte[] password, CursorFactory factory,
                             int version, int minimumSupportedVersion,
-                            DatabaseErrorHandler errorHandler, SQLiteDatabaseHook databaseHook) {
+                            DatabaseErrorHandler errorHandler, SQLiteDatabaseHook databaseHook,
+                            boolean enableWriteAheadLogging) {
         if (version < 1) throw new IllegalArgumentException("Version must be >= 1, was " + version);
 
         mContext = context;
@@ -212,6 +214,7 @@ public SQLiteOpenHelper(Context context, String name, byte[] password, CursorFac
         mNewVersion = version;
         mErrorHandler = errorHandler;
         mDatabaseHook = databaseHook;
+        mEnableWriteAheadLogging = enableWriteAheadLogging;
         mMinimumSupportedVersion = Math.max(0, minimumSupportedVersion);
     }
 

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

@@ -8,10 +8,11 @@ public class SupportHelper implements SupportSQLiteOpenHelper {
 
   private SQLiteOpenHelper openHelper;
 
-  public SupportHelper(final Configuration configuration, byte[] password, SQLiteDatabaseHook hook) {
+  public SupportHelper(final Configuration configuration, byte[] password, SQLiteDatabaseHook hook,
+                       boolean enableWriteAheadLogging) {
     openHelper = new SQLiteOpenHelper(configuration.context, configuration.name, password,
         null, configuration.callback.version, configuration.callback.version,
-        null, hook) {
+        null, hook, enableWriteAheadLogging) {
       @Override
       public void onCreate(SQLiteDatabase db) {
         configuration.callback.onCreate(db);

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

@@ -7,19 +7,21 @@ public class SupportOpenHelperFactory implements SupportSQLiteOpenHelper.Factory
 
   private final byte[] password;
   private final SQLiteDatabaseHook hook;
+  private final boolean enableWriteAheadLogging;
 
   public SupportOpenHelperFactory(byte[] password){
-    this(password, null);
+    this(password, null, false);
   }
 
-  public SupportOpenHelperFactory(byte[] password, SQLiteDatabaseHook hook){
+  public SupportOpenHelperFactory(byte[] password, SQLiteDatabaseHook hook, boolean enableWriteAheadLogging) {
     this.password = password;
     this.hook = hook;
+    this.enableWriteAheadLogging = enableWriteAheadLogging;
   }
 
   @NonNull
   @Override
   public SupportSQLiteOpenHelper create(@NonNull SupportSQLiteOpenHelper.Configuration configuration) {
-    return new SupportHelper(configuration, this.password, this.hook);
+    return new SupportHelper(configuration, this.password, this.hook, enableWriteAheadLogging);
   }
 }