fix(io): verify saves through edit leases

This commit is contained in:
Hakan Seven committed 2026-08-17 23:13:07 +03:00
commit 313349fd71
4 files changed
+342 -25

No files matched your search

+124 -1
View File
@@ -22,7 +22,11 @@ pub struct FileFingerprint {
impl FileFingerprint {
pub fn capture(path: &Path) -> std::io::Result<Self> {
let mut file = File::open(path)?;
Self::capture_from(&mut File::open(path)?)
}
/// Fingerprint an already-open drawing handle.
pub fn capture_from(file: &mut File) -> std::io::Result<Self> {
let metadata = file.metadata()?;
let len = metadata.len();
let modified_ns = metadata
@@ -66,6 +70,52 @@ impl FileFingerprint {
}
}
#[cfg(unix)]
pub(crate) fn path_matches_file(path: &Path, file: &File) -> std::io::Result<bool> {
use std::os::unix::fs::MetadataExt;
let path_metadata = std::fs::metadata(path)?;
let file_metadata = file.metadata()?;
Ok(path_metadata.dev() == file_metadata.dev() && path_metadata.ino() == file_metadata.ino())
}
#[cfg(target_os = "windows")]
pub(crate) fn path_matches_file(path: &Path, file: &File) -> std::io::Result<bool> {
use std::os::windows::fs::OpenOptionsExt;
use windows_sys::Win32::Storage::FileSystem::{
FILE_SHARE_DELETE, FILE_SHARE_READ, FILE_SHARE_WRITE,
};
let path_file = OpenOptions::new()
.access_mode(0)
.share_mode(FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE)
.open(path)?;
Ok(windows_file_identity(&path_file)? == windows_file_identity(file)?)
}
#[cfg(target_os = "windows")]
fn windows_file_identity(file: &File) -> std::io::Result<(u32, u64)> {
use std::os::windows::io::AsRawHandle;
use windows_sys::Win32::Storage::FileSystem::{
BY_HANDLE_FILE_INFORMATION, GetFileInformationByHandle,
};
let mut info = BY_HANDLE_FILE_INFORMATION::default();
if unsafe { GetFileInformationByHandle(file.as_raw_handle() as _, &mut info) } == 0 {
return Err(std::io::Error::last_os_error());
}
let index = (u64::from(info.nFileIndexHigh) << 32) | u64::from(info.nFileIndexLow);
Ok((info.dwVolumeSerialNumber, index))
}
#[cfg(not(any(unix, target_os = "windows")))]
pub(crate) fn path_matches_file(path: &Path, file: &File) -> std::io::Result<bool> {
let mut path_file = File::open(path)?;
let mut leased_file = file.try_clone()?;
Ok(FileFingerprint::capture_from(&mut path_file)?
== FileFingerprint::capture_from(&mut leased_file)?)
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum EditLeaseError {
Locked(String),
@@ -153,6 +203,19 @@ impl EditLease {
self.platform_warning.as_deref()
}
/// Fingerprint through the lease's drawing handle.
pub fn fingerprint(&mut self) -> std::io::Result<Option<FileFingerprint>> {
self.drawing
.as_mut()
.map(FileFingerprint::capture_from)
.transpose()
}
/// Clone the leased drawing handle for a worker.
pub fn reader(&self) -> std::io::Result<Option<File>> {
self.drawing.as_ref().map(File::try_clone).transpose()
}
/// Atomic save replaces the path with a new file object. Move the platform
/// lock to that new object; the sidecar remains locked throughout.
pub fn refresh_drawing_lock(&mut self, path: &Path) -> Result<(), EditLeaseError> {
@@ -255,6 +318,66 @@ mod tests {
let _ = std::fs::remove_file(path);
}
#[test]
fn a_lease_fingerprints_the_drawing_it_has_locked() {
let path = unique_path("leased.dwg");
std::fs::write(&path, b"drawing bytes").unwrap();
let unlocked = FileFingerprint::capture(&path).unwrap();
let mut lease = EditLease::acquire(&path).unwrap();
let leased = lease
.fingerprint()
.expect("the lease handle is readable")
.expect("the lease holds a drawing handle");
assert_eq!(unlocked, leased);
drop(lease);
let _ = std::fs::remove_file(sidecar_path(&path));
let _ = std::fs::remove_file(path);
}
#[test]
fn a_lease_lends_a_reader_for_the_drawing_it_has_locked() {
let path = unique_path("leased_reader.dwg");
std::fs::write(&path, b"drawing bytes").unwrap();
let lease = EditLease::acquire(&path).unwrap();
let mut reader = lease
.reader()
.expect("the lease handle is cloneable")
.expect("the lease holds a drawing handle");
let mut bytes = Vec::new();
reader.read_to_end(&mut bytes).unwrap();
assert_eq!(b"drawing bytes".as_slice(), bytes.as_slice());
drop(reader);
drop(lease);
let _ = std::fs::remove_file(sidecar_path(&path));
let _ = std::fs::remove_file(path);
}
#[test]
fn a_replaced_path_no_longer_matches_the_lease() {
let path = unique_path("identity.dwg");
let replacement = unique_path("replacement.dwg");
std::fs::write(&path, b"old").unwrap();
std::fs::write(&replacement, b"new").unwrap();
let lease = EditLease::acquire(&path).unwrap();
let reader = lease
.reader()
.unwrap()
.expect("the lease holds a drawing handle");
std::fs::remove_file(&path).unwrap();
std::fs::rename(&replacement, &path).unwrap();
assert!(!path_matches_file(&path, &reader).unwrap());
drop(reader);
drop(lease);
let _ = std::fs::remove_file(sidecar_path(&path));
let _ = std::fs::remove_file(path);
}
#[test]
fn fingerprint_detects_same_size_content_change() {
let path = unique_path("fingerprint.dwg");
+44 -1
View File
@@ -1437,6 +1437,41 @@ mod save_failure_tests {
acadrust::DxfVersion::AC1032,
false,
Some(expected),
None,
)
.unwrap_err();
assert!(error.externally_modified);
assert_eq!(std::fs::read(&path).unwrap(), b"new");
let _ = std::fs::remove_file(path);
}
#[cfg(not(target_arch = "wasm32"))]
#[test]
fn external_path_replacement_prevents_atomic_replace() {
let path = std::env::temp_dir().join(format!(
"ocs_external_replace_{}_{}.dwg",
std::process::id(),
std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap()
.as_nanos()
));
let replacement = path.with_extension("replacement.dwg");
std::fs::write(&path, b"old").unwrap();
let expected = super::edit_lock::FileFingerprint::capture(&path).unwrap();
let reader = std::fs::File::open(&path).unwrap();
std::fs::write(&replacement, b"new").unwrap();
std::fs::remove_file(&path).unwrap();
std::fs::rename(&replacement, &path).unwrap();
let error = super::save_owned_as_version_atomic(
acadrust::CadDocument::new(),
&path,
acadrust::DxfVersion::AC1032,
false,
Some(expected),
Some(reader),
)
.unwrap_err();
@@ -1509,12 +1544,20 @@ pub fn save_owned_as_version_atomic(
version: acadrust::DxfVersion,
backup: bool,
expected_fingerprint: Option<edit_lock::FileFingerprint>,
verify_reader: Option<std::fs::File>,
) -> Result<(), SaveFailure> {
save_owned_as_version_inner(doc, path, version, backup, 0.0, move |path| {
let Some(expected) = expected_fingerprint else {
return Ok(());
};
match edit_lock::FileFingerprint::capture(path) {
let current = match verify_reader {
Some(mut file) => match edit_lock::path_matches_file(path, &file) {
Ok(true) => edit_lock::FileFingerprint::capture_from(&mut file),
Ok(false) | Err(_) => return Err(SaveFailure::externally_modified(path)),
},
None => edit_lock::FileFingerprint::capture(path),
};
match current {
Ok(current) if current == expected => Ok(()),
_ => Err(SaveFailure::externally_modified(path)),
}