//! Commit, Data Change and Rollback Notification Callbacks #![allow(non_camel_case_types)] use std::os::raw::{c_char, c_int, c_void}; use std::panic::catch_unwind; use std::ptr; use crate::ffi; use crate::{Connection, InnerConnection}; /// Action Codes #[derive(Clone, Copy, Debug, PartialEq)] #[repr(i32)] pub enum Action { UNKNOWN = -1, SQLITE_DELETE = ffi::SQLITE_DELETE, SQLITE_INSERT = ffi::SQLITE_INSERT, SQLITE_UPDATE = ffi::SQLITE_UPDATE, } impl From for Action { fn from(code: i32) -> Action { match code { ffi::SQLITE_DELETE => Action::SQLITE_DELETE, ffi::SQLITE_INSERT => Action::SQLITE_INSERT, ffi::SQLITE_UPDATE => Action::SQLITE_UPDATE, _ => 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(&self, hook: Option) where F: FnMut() -> bool + Send + 'static, { 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(&self, hook: Option) where F: FnMut() + Send + 'static, { 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(&self, hook: Option) where F: FnMut(Action, &str, &str, i64) + Send + 'static, { self.db.borrow_mut().update_hook(hook); } } impl InnerConnection { pub fn remove_hooks(&mut self) { self.update_hook(None::); self.commit_hook(None:: bool>); self.rollback_hook(None::); } fn commit_hook(&mut self, hook: Option) where F: FnMut() -> bool + Send + 'static, { unsafe extern "C" fn call_boxed_closure(p_arg: *mut c_void) -> c_int where F: FnMut() -> bool, { let r = catch_unwind(|| { let boxed_hook: *mut F = p_arg as *mut F; (*boxed_hook)() }); if let Ok(true) = r { 1 } else { 0 } } // unlike `sqlite3_create_function_v2`, we cannot specify a `xDestroy` with // `sqlite3_commit_hook`. so we keep the `xDestroy` function in // `InnerConnection.free_boxed_hook`. let free_commit_hook = if hook.is_some() { Some(free_boxed_hook:: as fn(*mut c_void)) } else { None }; let previous_hook = match hook { Some(hook) => { let boxed_hook: *mut F = Box::into_raw(Box::new(hook)); unsafe { ffi::sqlite3_commit_hook( self.db(), Some(call_boxed_closure::), boxed_hook as *mut _, ) } } _ => unsafe { ffi::sqlite3_commit_hook(self.db(), None, ptr::null_mut()) }, }; if !previous_hook.is_null() { if let Some(free_boxed_hook) = self.free_commit_hook { free_boxed_hook(previous_hook); } } self.free_commit_hook = free_commit_hook; } fn rollback_hook(&mut self, hook: Option) where F: FnMut() + Send + 'static, { unsafe extern "C" fn call_boxed_closure(p_arg: *mut c_void) where F: FnMut(), { let _ = catch_unwind(|| { let boxed_hook: *mut F = p_arg as *mut F; (*boxed_hook)(); }); } let free_rollback_hook = if hook.is_some() { Some(free_boxed_hook:: as fn(*mut c_void)) } else { None }; let previous_hook = match hook { Some(hook) => { let boxed_hook: *mut F = Box::into_raw(Box::new(hook)); unsafe { ffi::sqlite3_rollback_hook( self.db(), Some(call_boxed_closure::), boxed_hook as *mut _, ) } } _ => unsafe { ffi::sqlite3_rollback_hook(self.db(), None, ptr::null_mut()) }, }; if !previous_hook.is_null() { if let Some(free_boxed_hook) = self.free_rollback_hook { free_boxed_hook(previous_hook); } } self.free_rollback_hook = free_rollback_hook; } fn update_hook(&mut self, hook: Option) where F: FnMut(Action, &str, &str, i64) + Send + 'static, { unsafe extern "C" fn call_boxed_closure( 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 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) }; let _ = catch_unwind(|| { let boxed_hook: *mut F = p_arg as *mut F; (*boxed_hook)(action, db_name, tbl_name, row_id); }); } let free_update_hook = if hook.is_some() { Some(free_boxed_hook:: as fn(*mut c_void)) } else { None }; let previous_hook = match hook { Some(hook) => { let boxed_hook: *mut F = Box::into_raw(Box::new(hook)); unsafe { ffi::sqlite3_update_hook( self.db(), Some(call_boxed_closure::), boxed_hook as *mut _, ) } } _ => unsafe { ffi::sqlite3_update_hook(self.db(), None, ptr::null_mut()) }, }; if !previous_hook.is_null() { if let Some(free_boxed_hook) = self.free_update_hook { free_boxed_hook(previous_hook); } } self.free_update_hook = free_update_hook; } } fn free_boxed_hook(p: *mut c_void) { drop(unsafe { Box::from_raw(p as *mut F) }); } #[cfg(test)] mod test { use super::Action; use crate::Connection; use lazy_static::lazy_static; use std::sync::atomic::{AtomicBool, Ordering}; #[test] fn test_commit_hook() { let db = Connection::open_in_memory().unwrap(); lazy_static! { static ref CALLED: AtomicBool = AtomicBool::new(false); } db.commit_hook(Some(|| { CALLED.store(true, Ordering::Relaxed); false })); db.execute_batch("BEGIN; CREATE TABLE foo (t TEXT); COMMIT;") .unwrap(); assert!(CALLED.load(Ordering::Relaxed)); } #[test] fn test_fn_commit_hook() { let db = Connection::open_in_memory().unwrap(); fn hook() -> bool { true } db.commit_hook(Some(hook)); db.execute_batch("BEGIN; CREATE TABLE foo (t TEXT); COMMIT;") .unwrap_err(); } #[test] fn test_rollback_hook() { let db = Connection::open_in_memory().unwrap(); lazy_static! { static ref CALLED: AtomicBool = AtomicBool::new(false); } db.rollback_hook(Some(|| { CALLED.store(true, Ordering::Relaxed); })); db.execute_batch("BEGIN; CREATE TABLE foo (t TEXT); ROLLBACK;") .unwrap(); assert!(CALLED.load(Ordering::Relaxed)); } #[test] fn test_update_hook() { let db = Connection::open_in_memory().unwrap(); lazy_static! { static ref CALLED: AtomicBool = AtomicBool::new(false); } db.update_hook(Some(|action, db: &str, tbl: &str, row_id| { assert_eq!(Action::SQLITE_INSERT, action); assert_eq!("main", db); assert_eq!("foo", tbl); assert_eq!(1, row_id); CALLED.store(true, Ordering::Relaxed); })); db.execute_batch("CREATE TABLE foo (t TEXT)").unwrap(); db.execute_batch("INSERT INTO foo VALUES ('lisa')").unwrap(); assert!(CALLED.load(Ordering::Relaxed)); } }