Fix a problem with using "<db>-vacuum" (the default) as the state database

when resuming an RBU vacuum.

FossilOrigin-Name: c878d741733a897d47a1a0b57b454bc9095ce302b48cc01089336d5d20e2a24c

ext/rbu/rbu_common.tcl

@@ -86,12 +86,13 @@ proc step_rbu_legacy {target rbu} {
   set rc
 }
 
-proc do_rbu_vacuum_test {tn step} {
-  forcedelete state.db
-  uplevel [list do_test $tn.1 {
-    if {$step==0} { sqlite3rbu_vacuum rbu test.db state.db }
+proc do_rbu_vacuum_test {tn step {statedb state.db}} {
+  forcedelete $statedb
+  if {$statedb=="" && $step==1} breakpoint
+  uplevel [list do_test $tn.1 [string map [list %state% $statedb] {
+    if {$step==0} { sqlite3rbu_vacuum rbu test.db {%state%}}
     while 1 {
-      if {$step==1} { sqlite3rbu_vacuum rbu test.db state.db }
+      if {$step==1} { sqlite3rbu_vacuum rbu test.db {%state%}}
       set state [rbu state]
       check_prestep_state test.db $state
       set rc [rbu step]
@@ -100,7 +101,7 @@ proc do_rbu_vacuum_test {tn step} {
       if {$step==1} { rbu close }
     }
     rbu close
-  } {SQLITE_DONE}]
+  }] {SQLITE_DONE}]
 
   uplevel [list do_execsql_test $tn.2 {
     PRAGMA integrity_check

ext/rbu/rbuvacuum2.test

@@ -16,8 +16,11 @@
 
 source [file join [file dirname [info script]] rbu_common.tcl]
 
-foreach step {0 1} {
-  set ::testprefix rbuvacuum2-$step
+foreach {step} {0 1} {
+foreach {ttt state} {
+  s state.db t test.db-vacuum n {}
+} {
+  set ::testprefix rbuvacuum2-$step$ttt
   
   #-------------------------------------------------------------------------
   # Test that a database that contains fts3 tables can be vacuumed.
@@ -29,7 +32,7 @@ foreach step {0 1} {
       INSERT INTO t1 VALUES('fix this issue', 'at some point');
     }
   
-    do_rbu_vacuum_test 1.2 $step
+    do_rbu_vacuum_test 1.2 $step $state
   
     do_execsql_test 1.3 {
       SELECT * FROM t1;
@@ -46,7 +49,7 @@ foreach step {0 1} {
       INSERT INTO t1 VALUES('a b c', 'x y z');
     }
 
-    do_rbu_vacuum_test 1.6 $step
+    do_rbu_vacuum_test 1.6 $step $state
     do_execsql_test 1.7 {
       INSERT INTO t1(t1) VALUES('integrity-check');
       SELECT * FROM t1;
@@ -67,7 +70,7 @@ foreach step {0 1} {
       INSERT INTO t1 VALUES('fix this issue', 'at some point');
     }
   
-    do_rbu_vacuum_test 2.2 $step
+    do_rbu_vacuum_test 2.2 $step $state
   
     do_execsql_test 2.3 {
       SELECT * FROM t1;
@@ -84,7 +87,7 @@ foreach step {0 1} {
       INSERT INTO t1 VALUES('a b c', 'x y z');
     }
 
-    do_rbu_vacuum_test 2.6 $step
+    do_rbu_vacuum_test 2.6 $step $state
     do_execsql_test 2.7 {
       INSERT INTO t1(t1) VALUES('integrity-check');
       SELECT * FROM t1;
@@ -107,7 +110,7 @@ foreach step {0 1} {
       INSERT INTO rt VALUES(3, 55, 65);
     }
   
-    do_rbu_vacuum_test 3.2 $step
+    do_rbu_vacuum_test 3.2 $step $state
   
     do_execsql_test 3.3 {
       SELECT * FROM rt;
@@ -120,7 +123,7 @@ foreach step {0 1} {
       SELECT rowid FROM rt WHERE x2>59 AND x1 < 59
     } {2 3}
 
-    do_rbu_vacuum_test 3.5 $step
+    do_rbu_vacuum_test 3.5 $step $state
 
     do_execsql_test 3.6.1 {
       SELECT rowid FROM rt WHERE x2>51 AND x1 < 51
@@ -147,7 +150,7 @@ foreach step {0 1} {
     trigger tr1 t1 0 {CREATE TRIGGER tr1 AFTER INSERT ON t1 BEGIN SELECT 1; END}
     }
 
-    do_rbu_vacuum_test 4.3 $step
+    do_rbu_vacuum_test 4.3 $step $state
     do_execsql_test 4.4 {
       SELECT * FROM sqlite_master;
     } {
@@ -157,6 +160,7 @@ foreach step {0 1} {
     }
   }
 }
+}
   
 #-------------------------------------------------------------------------
 # Test that passing a NULL value as the second argument to 
@@ -231,4 +235,9 @@ do_test 6.3 {
   execsql { PRAGMA integrity_check }
 } {ok}
 
+do_test 6.4 {
+  sqlite3rbu_vacuum rbu test.db test.db-vactmp
+  list [catch { rbu close } msg] $msg
+} {1 SQLITE_MISUSE}
+
 finish_test

ext/rbu/sqlite3rbu.c

@@ -2477,7 +2477,7 @@ static void rbuOpenDatabase(sqlite3rbu *p, int *pbRetry){
         if( *zExtra=='\0' ) zExtra = 0;
       }
 
-      zTarget = sqlite3_mprintf("file:%s-vacuum?rbu_memory=1%s%s", 
+      zTarget = sqlite3_mprintf("file:%s-vactmp?rbu_memory=1%s%s", 
           sqlite3_db_filename(p->dbRbu, "main"),
           (zExtra==0 ? "" : "&"), (zExtra==0 ? "" : zExtra)
       );
@@ -3743,6 +3743,12 @@ sqlite3rbu *sqlite3rbu_vacuum(
   const char *zState
 ){
   if( zTarget==0 ){ return rbuMisuseError(); }
+  if( zState ){
+    int n = strlen(zState);
+    if( n>=7 && 0==memcmp("-vactmp", &zState[n-7], 7) ){
+      return rbuMisuseError();
+    }
+  }
   /* TODO: Check that both arguments are non-NULL */
   return openRbuHandle(0, zTarget, zState);
 }

ext/rbu/sqlite3rbu.h

@@ -333,7 +333,11 @@ SQLITE_API sqlite3rbu *sqlite3rbu_open(
 ** name of the state database is "<database>-vacuum", where <database>
 ** is the name of the target database file. In this case, on UNIX, if the
 ** state database is not already present in the file-system, it is created
-** with the same permissions as the target db is made.
+** with the same permissions as the target db is made. 
+**
+** With an RBU vacuum, it is an SQLITE_MISUSE error if the name of the 
+** state database ends with "-vactmp". This name is reserved for internal 
+** use.
 **
 ** This function does not delete the state database after an RBU vacuum
 ** is completed, even if it created it. However, if the call to

ext/rbu/test_rbu.c

@@ -273,6 +273,7 @@ static int SQLITE_TCLAPI test_sqlite3rbu_vacuum(
   zCmd = Tcl_GetString(objv[1]);
   zTarget = Tcl_GetString(objv[2]);
   if( objc==4 ) zStateDb = Tcl_GetString(objv[3]);
+  if( zStateDb && zStateDb[0]=='\0' ) zStateDb = 0;
 
   pRbu = sqlite3rbu_vacuum(zTarget, zStateDb);
   Tcl_CreateObjCommand(interp, zCmd, test_sqlite3rbu_cmd, (ClientData)pRbu, 0);