Merge pull request #266 from gwenn/hooks

Implementation of sqlite3_update_hook #260

.travis.yml

@@ -30,6 +30,7 @@ script:
   - cargo test --features backup
   - cargo test --features blob
   - cargo test --features functions
+  - cargo test --features hooks
   - cargo test --features limits
   - cargo test --features load_extension
   - cargo test --features trace
@@ -37,7 +38,7 @@ script:
   - cargo test --features serde_json
   - cargo test --features bundled
   - cargo test --features sqlcipher
-  - cargo test --features "backup blob chrono functions limits load_extension serde_json trace"
+  - cargo test --features "backup blob chrono functions hooks limits load_extension serde_json trace"
-  - cargo test --features "backup blob chrono functions limits load_extension serde_json trace buildtime_bindgen"
+  - cargo test --features "backup blob chrono functions hooks limits load_extension serde_json trace buildtime_bindgen"
-  - cargo test --features "backup blob chrono functions limits load_extension serde_json trace bundled"
+  - cargo test --features "backup blob chrono functions hooks limits load_extension serde_json trace bundled"
-  - cargo test --features "backup blob chrono functions limits load_extension serde_json trace bundled buildtime_bindgen"
+  - cargo test --features "backup blob chrono functions hooks limits load_extension serde_json trace bundled buildtime_bindgen"

Cargo.toml

@@ -26,6 +26,7 @@ trace = ["libsqlite3-sys/min_sqlite_version_3_6_23"]
 bundled = ["libsqlite3-sys/bundled"]
 buildtime_bindgen = ["libsqlite3-sys/buildtime_bindgen"]
 limits = []
+hooks = []
 sqlcipher = ["libsqlite3-sys/sqlcipher"]
 
 [dependencies]

appveyor.yml

@@ -34,10 +34,10 @@ build: false
 test_script:
   - cargo test --lib --verbose
   - cargo test --lib --verbose --features bundled
-  - cargo test --lib --features "backup blob chrono functions limits load_extension serde_json trace"
+  - cargo test --lib --features "backup blob chrono functions hooks limits load_extension serde_json trace"
-  - cargo test --lib --features "backup blob chrono functions limits load_extension serde_json trace buildtime_bindgen"
+  - cargo test --lib --features "backup blob chrono functions hooks limits load_extension serde_json trace buildtime_bindgen"
-  - cargo test --lib --features "backup blob chrono functions limits load_extension serde_json trace bundled"
+  - cargo test --lib --features "backup blob chrono functions hooks limits load_extension serde_json trace bundled"
-  - cargo test --lib --features "backup blob chrono functions limits load_extension serde_json trace bundled buildtime_bindgen"
+  - cargo test --lib --features "backup blob chrono functions hooks limits load_extension serde_json trace bundled buildtime_bindgen"
 
 cache:
   - C:\Users\appveyor\.cargo

src/blob.rs

@@ -50,7 +50,6 @@
 //! ```
 use std::io;
 use std::cmp::min;
-use std::mem;
 use std::ptr;
 
 use super::ffi;
@@ -65,7 +64,7 @@ pub struct Blob<'conn> {
 }
 
 impl Connection {
-    /// Open a handle to the BLOB located in `row`, `column`, `table` in database `db`.
+    /// Open a handle to the BLOB located in `row_id`, `column`, `table` in database `db`.
     ///
     /// # Failure
     ///
@@ -75,7 +74,7 @@ impl Connection {
                          db: DatabaseName,
                          table: &str,
                          column: &str,
-                         row: i64,
+                         row_id: i64,
                          read_only: bool)
                          -> Result<Blob<'a>> {
         let mut c = self.db.borrow_mut();
@@ -88,7 +87,7 @@ impl Connection {
                                    db.as_ptr(),
                                    table.as_ptr(),
                                    column.as_ptr(),
-                                   row,
+                                   row_id,
                                    if read_only { 0 } else { 1 },
                                    &mut blob)
         };
@@ -156,7 +155,7 @@ impl<'conn> io::Read for Blob<'conn> {
             return Ok(0);
         }
         let rc =
-            unsafe { ffi::sqlite3_blob_read(self.blob, mem::transmute(buf.as_ptr()), n, self.pos) };
+            unsafe { ffi::sqlite3_blob_read(self.blob, buf.as_ptr() as *mut _, n, self.pos) };
         self.conn
             .decode_result(rc)
             .map(|_| {
@@ -185,7 +184,7 @@ impl<'conn> io::Write for Blob<'conn> {
             return Ok(0);
         }
         let rc = unsafe {
-            ffi::sqlite3_blob_write(self.blob, mem::transmute(buf.as_ptr()), n, self.pos)
+            ffi::sqlite3_blob_write(self.blob, buf.as_ptr() as *mut _, n, self.pos)
         };
         self.conn
             .decode_result(rc)

src/hooks.rs

@@ -0,0 +1,309 @@
+//! Commit, Data Change and Rollback Notification Callbacks
+#![allow(non_camel_case_types)]
+
+use std::mem;
+use std::ptr;
+use std::os::raw::{c_int, c_char, c_void};
+
+use ffi;
+
+use {Connection, InnerConnection};
+
+/// Authorizer Action Codes
+#[derive(Debug, PartialEq)]
+pub enum Action {
+    UNKNOWN = -1,
+    SQLITE_CREATE_INDEX = ffi::SQLITE_CREATE_INDEX as isize,
+    SQLITE_CREATE_TABLE = ffi::SQLITE_CREATE_TABLE as isize,
+    SQLITE_CREATE_TEMP_INDEX = ffi::SQLITE_CREATE_TEMP_INDEX as isize,
+    SQLITE_CREATE_TEMP_TABLE = ffi::SQLITE_CREATE_TEMP_TABLE as isize,
+    SQLITE_CREATE_TEMP_TRIGGER = ffi::SQLITE_CREATE_TEMP_TRIGGER as isize,
+    SQLITE_CREATE_TEMP_VIEW = ffi::SQLITE_CREATE_TEMP_VIEW as isize,
+    SQLITE_CREATE_TRIGGER = ffi::SQLITE_CREATE_TRIGGER as isize,
+    SQLITE_CREATE_VIEW = ffi::SQLITE_CREATE_VIEW as isize,
+    SQLITE_DELETE = ffi::SQLITE_DELETE as isize,
+    SQLITE_DROP_INDEX = ffi::SQLITE_DROP_INDEX as isize,
+    SQLITE_DROP_TABLE = ffi::SQLITE_DROP_TABLE as isize,
+    SQLITE_DROP_TEMP_INDEX = ffi::SQLITE_DROP_TEMP_INDEX as isize,
+    SQLITE_DROP_TEMP_TABLE = ffi::SQLITE_DROP_TEMP_TABLE as isize,
+    SQLITE_DROP_TEMP_TRIGGER = ffi::SQLITE_DROP_TEMP_TRIGGER as isize,
+    SQLITE_DROP_TEMP_VIEW = ffi::SQLITE_DROP_TEMP_VIEW as isize,
+    SQLITE_DROP_TRIGGER = ffi::SQLITE_DROP_TRIGGER as isize,
+    SQLITE_DROP_VIEW = ffi::SQLITE_DROP_VIEW as isize,
+    SQLITE_INSERT = ffi::SQLITE_INSERT as isize,
+    SQLITE_PRAGMA = ffi::SQLITE_PRAGMA as isize,
+    SQLITE_READ = ffi::SQLITE_READ as isize,
+    SQLITE_SELECT = ffi::SQLITE_SELECT as isize,
+    SQLITE_TRANSACTION = ffi::SQLITE_TRANSACTION as isize,
+    SQLITE_UPDATE = ffi::SQLITE_UPDATE as isize,
+    SQLITE_ATTACH = ffi::SQLITE_ATTACH as isize,
+    SQLITE_DETACH = ffi::SQLITE_DETACH as isize,
+    SQLITE_ALTER_TABLE = ffi::SQLITE_ALTER_TABLE as isize,
+    SQLITE_REINDEX = ffi::SQLITE_REINDEX as isize,
+    SQLITE_ANALYZE = ffi::SQLITE_ANALYZE as isize,
+    SQLITE_CREATE_VTABLE = ffi::SQLITE_CREATE_VTABLE as isize,
+    SQLITE_DROP_VTABLE = ffi::SQLITE_DROP_VTABLE as isize,
+    SQLITE_FUNCTION = ffi::SQLITE_FUNCTION as isize,
+    SQLITE_SAVEPOINT = ffi::SQLITE_SAVEPOINT as isize,
+    SQLITE_COPY = ffi::SQLITE_COPY as isize,
+    SQLITE_RECURSIVE = 33,
+}
+
+impl From<i32> for Action {
+    fn from(code: i32) -> Action {
+        match code {
+            ffi::SQLITE_CREATE_INDEX => Action::SQLITE_CREATE_INDEX,
+            ffi::SQLITE_CREATE_TABLE => Action::SQLITE_CREATE_TABLE,
+            ffi::SQLITE_CREATE_TEMP_INDEX => Action::SQLITE_CREATE_TEMP_INDEX,
+            ffi::SQLITE_CREATE_TEMP_TABLE => Action::SQLITE_CREATE_TEMP_TABLE,
+            ffi::SQLITE_CREATE_TEMP_TRIGGER => Action::SQLITE_CREATE_TEMP_TRIGGER,
+            ffi::SQLITE_CREATE_TEMP_VIEW => Action::SQLITE_CREATE_TEMP_VIEW,
+            ffi::SQLITE_CREATE_TRIGGER => Action::SQLITE_CREATE_TRIGGER,
+            ffi::SQLITE_CREATE_VIEW => Action::SQLITE_CREATE_VIEW,
+            ffi::SQLITE_DELETE => Action::SQLITE_DELETE,
+            ffi::SQLITE_DROP_INDEX => Action::SQLITE_DROP_INDEX,
+            ffi::SQLITE_DROP_TABLE => Action::SQLITE_DROP_TABLE,
+            ffi::SQLITE_DROP_TEMP_INDEX => Action::SQLITE_DROP_TEMP_INDEX,
+            ffi::SQLITE_DROP_TEMP_TABLE => Action::SQLITE_DROP_TEMP_TABLE,
+            ffi::SQLITE_DROP_TEMP_TRIGGER => Action::SQLITE_DROP_TEMP_TRIGGER,
+            ffi::SQLITE_DROP_TEMP_VIEW => Action::SQLITE_DROP_TEMP_VIEW,
+            ffi::SQLITE_DROP_TRIGGER => Action::SQLITE_DROP_TRIGGER,
+            ffi::SQLITE_DROP_VIEW => Action::SQLITE_DROP_VIEW,
+            ffi::SQLITE_INSERT => Action::SQLITE_INSERT,
+            ffi::SQLITE_PRAGMA => Action::SQLITE_PRAGMA,
+            ffi::SQLITE_READ => Action::SQLITE_READ,
+            ffi::SQLITE_SELECT => Action::SQLITE_SELECT,
+            ffi::SQLITE_TRANSACTION => Action::SQLITE_TRANSACTION,
+            ffi::SQLITE_UPDATE => Action::SQLITE_UPDATE,
+            ffi::SQLITE_ATTACH => Action::SQLITE_ATTACH,
+            ffi::SQLITE_DETACH => Action::SQLITE_DETACH,
+            ffi::SQLITE_ALTER_TABLE => Action::SQLITE_ALTER_TABLE,
+            ffi::SQLITE_REINDEX => Action::SQLITE_REINDEX,
+            ffi::SQLITE_ANALYZE => Action::SQLITE_ANALYZE,
+            ffi::SQLITE_CREATE_VTABLE => Action::SQLITE_CREATE_VTABLE,
+            ffi::SQLITE_DROP_VTABLE => Action::SQLITE_DROP_VTABLE,
+            ffi::SQLITE_FUNCTION => Action::SQLITE_FUNCTION,
+            ffi::SQLITE_SAVEPOINT => Action::SQLITE_SAVEPOINT,
+            ffi::SQLITE_COPY => Action::SQLITE_COPY,
+            33 => Action::SQLITE_RECURSIVE,
+            _ => Action::UNKNOWN,
+        }
+    }
+}
+
+impl Connection {
+    /// Register a callback function to be invoked whenever a transaction is committed.
+    ///
+    /// The callback returns `true` to rollback.
+    pub fn commit_hook<F>(&self, hook: F)
+        where F: FnMut() -> bool
+    {
+        self.db.borrow_mut().commit_hook(hook);
+    }
+
+    /// Register a callback function to be invoked whenever a transaction is committed.
+    ///
+    /// The callback returns `true` to rollback.
+    pub fn rollback_hook<F>(&self, hook: F)
+        where F: FnMut()
+    {
+        self.db.borrow_mut().rollback_hook(hook);
+    }
+
+    /// Register a callback function to be invoked whenever a row is updated,
+    /// inserted or deleted in a rowid table.
+    ///
+    /// The callback parameters are:
+    ///
+    ///   - the type of database update (SQLITE_INSERT, SQLITE_UPDATE or SQLITE_DELETE),
+    ///   - the name of the database ("main", "temp", ...),
+    ///   - the name of the table that is updated,
+    ///   - the ROWID of the row that is updated.
+    pub fn update_hook<F>(&self, hook: F)
+        where F: FnMut(Action, &str, &str, i64)
+    {
+        self.db.borrow_mut().update_hook(hook);
+    }
+
+    /// Remove hook installed by `update_hook`.
+    pub fn remove_update_hook(&self) {
+        self.db.borrow_mut().remove_update_hook();
+    }
+
+    /// Remove hook installed by `commit_hook`.
+    pub fn remove_commit_hook(&self) {
+        self.db.borrow_mut().remove_commit_hook();
+    }
+
+    /// Remove hook installed by `rollback_hook`.
+    pub fn remove_rollback_hook(&self) {
+        self.db.borrow_mut().remove_rollback_hook();
+    }
+}
+
+impl InnerConnection {
+    pub fn remove_hooks(&mut self) {
+        self.remove_update_hook();
+        self.remove_commit_hook();
+        self.remove_rollback_hook();
+    }
+
+    fn commit_hook<F>(&self, hook: F)
+        where F: FnMut() -> bool
+    {
+        unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void) -> c_int
+            where F: FnMut() -> bool
+        {
+            let boxed_hook: *mut F = mem::transmute(p_arg);
+            assert!(!boxed_hook.is_null(),
+                    "Internal error - null function pointer");
+
+            if (*boxed_hook)() { 1 } else { 0 }
+        }
+
+        let previous_hook = {
+            let boxed_hook: *mut F = Box::into_raw(Box::new(hook));
+            unsafe {
+                ffi::sqlite3_commit_hook(self.db(),
+                                         Some(call_boxed_closure::<F>),
+                                         boxed_hook as *mut _)
+            }
+        };
+        free_boxed_hook(previous_hook);
+    }
+
+    fn rollback_hook<F>(&self, hook: F)
+        where F: FnMut()
+    {
+        unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void)
+            where F: FnMut()
+        {
+            let boxed_hook: *mut F = mem::transmute(p_arg);
+            assert!(!boxed_hook.is_null(),
+                    "Internal error - null function pointer");
+
+            (*boxed_hook)();
+        }
+
+        let previous_hook = {
+            let boxed_hook: *mut F = Box::into_raw(Box::new(hook));
+            unsafe {
+                ffi::sqlite3_rollback_hook(self.db(),
+                                           Some(call_boxed_closure::<F>),
+                                           boxed_hook as *mut _)
+            }
+        };
+        free_boxed_hook(previous_hook);
+    }
+
+    fn update_hook<F>(&mut self, hook: F)
+        where F: FnMut(Action, &str, &str, i64)
+    {
+        unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void,
+                                                   action_code: c_int,
+                                                   db_str: *const c_char,
+                                                   tbl_str: *const c_char,
+                                                   row_id: i64)
+            where F: FnMut(Action, &str, &str, i64)
+        {
+            use std::ffi::CStr;
+            use std::str;
+
+            let boxed_hook: *mut F = mem::transmute(p_arg);
+            assert!(!boxed_hook.is_null(),
+                    "Internal error - null function pointer");
+
+            let action = Action::from(action_code);
+            let db_name = {
+                let c_slice = CStr::from_ptr(db_str).to_bytes();
+                str::from_utf8_unchecked(c_slice)
+            };
+            let tbl_name = {
+                let c_slice = CStr::from_ptr(tbl_str).to_bytes();
+                str::from_utf8_unchecked(c_slice)
+            };
+
+            (*boxed_hook)(action, db_name, tbl_name, row_id);
+        }
+
+        let previous_hook = {
+            let boxed_hook: *mut F = Box::into_raw(Box::new(hook));
+            unsafe {
+                ffi::sqlite3_update_hook(self.db(),
+                                         Some(call_boxed_closure::<F>),
+                                         boxed_hook as *mut _)
+            }
+        };
+        free_boxed_hook(previous_hook);
+    }
+
+    fn remove_update_hook(&mut self) {
+        let previous_hook = unsafe { ffi::sqlite3_update_hook(self.db(), None, ptr::null_mut()) };
+        free_boxed_hook(previous_hook);
+    }
+
+    fn remove_commit_hook(&mut self) {
+        let previous_hook = unsafe { ffi::sqlite3_commit_hook(self.db(), None, ptr::null_mut()) };
+        free_boxed_hook(previous_hook);
+    }
+
+    fn remove_rollback_hook(&mut self) {
+        let previous_hook = unsafe { ffi::sqlite3_rollback_hook(self.db(), None, ptr::null_mut()) };
+        free_boxed_hook(previous_hook);
+    }
+}
+
+fn free_boxed_hook(hook: *mut c_void) {
+    if !hook.is_null() {
+        // TODO make sure that size_of::<*mut F>() is always equal to size_of::<*mut c_void>()
+        let _: Box<*mut c_void> = unsafe { Box::from_raw(hook as *mut _) };
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::Action;
+    use Connection;
+
+    #[test]
+    fn test_commit_hook() {
+        let db = Connection::open_in_memory().unwrap();
+
+        let mut called = false;
+        db.commit_hook(|| {
+                           called = true;
+                           false
+                       });
+        db.execute_batch("BEGIN; CREATE TABLE foo (t TEXT); COMMIT;")
+            .unwrap();
+        assert!(called);
+    }
+
+    #[test]
+    fn test_rollback_hook() {
+        let db = Connection::open_in_memory().unwrap();
+
+        let mut called = false;
+        db.rollback_hook(|| { called = true; });
+        db.execute_batch("BEGIN; CREATE TABLE foo (t TEXT); ROLLBACK;")
+            .unwrap();
+        assert!(called);
+    }
+
+    #[test]
+    fn test_update_hook() {
+        let db = Connection::open_in_memory().unwrap();
+
+        let mut called = false;
+        db.update_hook(|action, db, tbl, row_id| {
+                           assert_eq!(Action::SQLITE_INSERT, action);
+                           assert_eq!("main", db);
+                           assert_eq!("foo", tbl);
+                           assert_eq!(1, row_id);
+                           called = true;
+                       });
+        db.execute_batch("CREATE TABLE foo (t TEXT)").unwrap();
+        db.execute_batch("INSERT INTO foo VALUES ('lisa')").unwrap();
+        assert!(called);
+    }
+}

src/lib.rs

@@ -121,6 +121,10 @@ pub mod functions;
 pub mod blob;
 #[cfg(feature = "limits")]
 pub mod limits;
+#[cfg(feature = "hooks")]
+mod hooks;
+#[cfg(feature = "hooks")]
+pub use hooks::*;
 
 // Number of cached prepared statements we'll hold on to.
 const STATEMENT_CACHE_DEFAULT_CAPACITY: usize = 16;
@@ -792,6 +796,10 @@ impl InnerConnection {
     }
 
     fn close(&mut self) -> Result<()> {
+        if self.db.is_null() {
+            return Ok(());
+        }
+        self.remove_hooks();
         unsafe {
             let r = ffi::sqlite3_close(self.db());
             let r = self.decode_result(r);
@@ -869,6 +877,10 @@ impl InnerConnection {
     fn changes(&mut self) -> c_int {
         unsafe { ffi::sqlite3_changes(self.db()) }
     }
+
+    #[cfg(not(feature = "hooks"))]
+    fn remove_hooks(&mut self) {
+    }
 }
 
 impl Drop for InnerConnection {