Fix hooks

This commit is contained in:
gwenn 2018-08-11 11:14:17 +02:00
parent 87a0c3abca
commit 2a29717c5a
3 changed files with 73 additions and 20 deletions

View File

@ -182,7 +182,7 @@ impl<'a> ValueRef<'a> {
} }
unsafe extern "C" fn free_boxed_value<T>(p: *mut c_void) { unsafe extern "C" fn free_boxed_value<T>(p: *mut c_void) {
let _: Box<T> = Box::from_raw(p as *mut T); drop(Box::from_raw(p as *mut T));
} }
/// Context is a wrapper for the SQLite function evaluation context. /// Context is a wrapper for the SQLite function evaluation context.

View File

@ -1,7 +1,6 @@
//! Commit, Data Change and Rollback Notification Callbacks //! Commit, Data Change and Rollback Notification Callbacks
#![allow(non_camel_case_types)] #![allow(non_camel_case_types)]
use std::mem::size_of;
use std::ptr; use std::ptr;
use std::os::raw::{c_int, c_char, c_void}; use std::os::raw::{c_int, c_char, c_void};
@ -136,12 +135,10 @@ impl InnerConnection {
self.rollback_hook(None::<fn()>); self.rollback_hook(None::<fn()>);
} }
fn commit_hook<F>(&self, hook: Option<F>) fn commit_hook<F>(&mut self, hook: Option<F>)
where where
F: FnMut() -> bool, F: FnMut() -> bool,
{ {
assert_eq!(size_of::<*mut F>(), size_of::<*mut c_void>());
unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void) -> c_int unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void) -> c_int
where where
F: FnMut() -> bool, F: FnMut() -> bool,
@ -154,6 +151,14 @@ impl InnerConnection {
} }
} }
// 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::<F> as fn(*mut c_void))
} else {
None
};
let previous_hook = match hook { let previous_hook = match hook {
Some(hook) => { Some(hook) => {
let boxed_hook: *mut F = Box::into_raw(Box::new(hook)); let boxed_hook: *mut F = Box::into_raw(Box::new(hook));
@ -167,15 +172,18 @@ impl InnerConnection {
} }
_ => unsafe { ffi::sqlite3_commit_hook(self.db(), None, ptr::null_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); free_boxed_hook(previous_hook);
} }
}
self.free_commit_hook = free_commit_hook;
}
fn rollback_hook<F>(&self, hook: Option<F>) fn rollback_hook<F>(&mut self, hook: Option<F>)
where where
F: FnMut(), F: FnMut(),
{ {
assert_eq!(size_of::<*mut F>(), size_of::<*mut c_void>());
unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void) unsafe extern "C" fn call_boxed_closure<F>(p_arg: *mut c_void)
where where
F: FnMut(), F: FnMut(),
@ -184,6 +192,12 @@ impl InnerConnection {
(*boxed_hook)(); (*boxed_hook)();
} }
let free_rollback_hook = if hook.is_some() {
Some(free_boxed_hook::<F> as fn(*mut c_void))
} else {
None
};
let previous_hook = match hook { let previous_hook = match hook {
Some(hook) => { Some(hook) => {
let boxed_hook: *mut F = Box::into_raw(Box::new(hook)); let boxed_hook: *mut F = Box::into_raw(Box::new(hook));
@ -197,15 +211,18 @@ impl InnerConnection {
} }
_ => unsafe { ffi::sqlite3_rollback_hook(self.db(), None, ptr::null_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); free_boxed_hook(previous_hook);
} }
}
self.free_rollback_hook = free_rollback_hook;
}
fn update_hook<F>(&mut self, hook: Option<F>) fn update_hook<F>(&mut self, hook: Option<F>)
where where
F: FnMut(Action, &str, &str, i64), F: FnMut(Action, &str, &str, i64),
{ {
assert_eq!(size_of::<*mut F>(), size_of::<*mut c_void>());
unsafe extern "C" fn call_boxed_closure<F>( unsafe extern "C" fn call_boxed_closure<F>(
p_arg: *mut c_void, p_arg: *mut c_void,
action_code: c_int, action_code: c_int,
@ -233,6 +250,12 @@ impl InnerConnection {
(*boxed_hook)(action, db_name, tbl_name, row_id); (*boxed_hook)(action, db_name, tbl_name, row_id);
} }
let free_update_hook = if hook.is_some() {
Some(free_boxed_hook::<F> as fn(*mut c_void))
} else {
None
};
let previous_hook = match hook { let previous_hook = match hook {
Some(hook) => { Some(hook) => {
let boxed_hook: *mut F = Box::into_raw(Box::new(hook)); let boxed_hook: *mut F = Box::into_raw(Box::new(hook));
@ -246,15 +269,17 @@ impl InnerConnection {
} }
_ => unsafe { ffi::sqlite3_update_hook(self.db(), None, ptr::null_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); free_boxed_hook(previous_hook);
} }
}
self.free_update_hook = free_update_hook;
}
} }
fn free_boxed_hook(hook: *mut c_void) { fn free_boxed_hook<F>(p: *mut c_void) {
if !hook.is_null() { drop(unsafe { Box::from_raw(p as *mut F) });
// 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)] #[cfg(test)]
@ -276,6 +301,19 @@ mod test {
assert!(called); assert!(called);
} }
#[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] #[test]
fn test_rollback_hook() { fn test_rollback_hook() {
let db = Connection::open_in_memory().unwrap(); let db = Connection::open_in_memory().unwrap();

View File

@ -72,7 +72,7 @@ use std::result;
use std::str; use std::str;
use std::sync::{Once, ONCE_INIT}; use std::sync::{Once, ONCE_INIT};
use std::sync::atomic::{AtomicBool, ATOMIC_BOOL_INIT, Ordering}; use std::sync::atomic::{AtomicBool, ATOMIC_BOOL_INIT, Ordering};
use std::os::raw::{c_int, c_char}; use std::os::raw::{c_int, c_char, c_void};
use types::{ToSql, ValueRef}; use types::{ToSql, ValueRef};
use error::{error_from_sqlite_code, error_from_handle}; use error::{error_from_sqlite_code, error_from_handle};
@ -597,6 +597,12 @@ impl fmt::Debug for Connection {
struct InnerConnection { struct InnerConnection {
db: *mut ffi::sqlite3, db: *mut ffi::sqlite3,
#[cfg(feature = "hooks")]
free_commit_hook: Option<fn(*mut c_void)>,
#[cfg(feature = "hooks")]
free_rollback_hook: Option<fn(*mut c_void)>,
#[cfg(feature = "hooks")]
free_update_hook: Option<fn(*mut c_void)>,
} }
/// Old name for `OpenFlags`. `SqliteOpenFlags` is deprecated. /// Old name for `OpenFlags`. `SqliteOpenFlags` is deprecated.
@ -755,6 +761,15 @@ To fix this, either:
} }
impl InnerConnection { impl InnerConnection {
#[cfg(not(feature = "hooks"))]
fn new(db: *mut ffi::sqlite3) -> InnerConnection {
InnerConnection { db }
}
#[cfg(feature = "hooks")]
fn new(db: *mut ffi::sqlite3) -> InnerConnection {
InnerConnection { db, free_commit_hook: None, free_rollback_hook: None, free_update_hook: None }
}
fn open_with_flags(c_path: &CString, flags: OpenFlags) -> Result<InnerConnection> { fn open_with_flags(c_path: &CString, flags: OpenFlags) -> Result<InnerConnection> {
ensure_valid_sqlite_version(); ensure_valid_sqlite_version();
ensure_safe_sqlite_threading_mode()?; ensure_safe_sqlite_threading_mode()?;
@ -792,7 +807,7 @@ impl InnerConnection {
// attempt to turn on extended results code; don't fail if we can't. // attempt to turn on extended results code; don't fail if we can't.
ffi::sqlite3_extended_result_codes(db, 1); ffi::sqlite3_extended_result_codes(db, 1);
Ok(InnerConnection { db }) Ok(InnerConnection::new(db))
} }
} }