appcore-sync 1.0.1-rc.8

use crate::sync::error::{SyncError, SyncResult, UPDATE_REQUIRED_MESSAGE};
use fs2::FileExt;
use std::fs::{self, File, OpenOptions};
use std::io::{Read, Write};
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicU64, Ordering};

static TEMP_COUNTER: AtomicU64 = AtomicU64::new(0);

pub(super) struct PersistenceLock {
    file: File,
}

impl Drop for PersistenceLock {
    fn drop(&mut self) {
        let _ = FileExt::unlock(&self.file);
    }
}

pub(super) struct FormatBody<'a> {
    pub(super) body: &'a str,
}

pub(super) fn split_format<'a>(text: &'a str, marker: &str) -> SyncResult<FormatBody<'a>> {
    if let Some(body) = text
        .strip_prefix(marker)
        .and_then(|rest| rest.strip_prefix('\n'))
    {
        return Ok(FormatBody { body });
    }
    if text == marker {
        return Ok(FormatBody { body: "" });
    }
    Err(SyncError::ReplicationFailed(
        UPDATE_REQUIRED_MESSAGE.to_string(),
    ))
}

pub(super) fn read_bounded_text(path: &Path, max_bytes: u64) -> SyncResult<String> {
    reject_symlink(path)?;
    let mut file =
        File::open(path).map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
    let length = file
        .metadata()
        .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?
        .len();
    if length > max_bytes {
        return Err(SyncError::ReplicationFailed(
            "persistent file exceeds configured limit".to_string(),
        ));
    }
    let mut text = String::with_capacity(length as usize);
    Read::by_ref(&mut file)
        .take(max_bytes.saturating_add(1))
        .read_to_string(&mut text)
        .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
    if text.len() as u64 > max_bytes {
        return Err(SyncError::ReplicationFailed(
            "persistent file exceeds configured limit".to_string(),
        ));
    }
    Ok(text)
}

pub(super) fn atomic_write(path: &Path, bytes: &[u8]) -> SyncResult<()> {
    let parent = path.parent().unwrap_or_else(|| Path::new("."));
    fs::create_dir_all(parent).map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
    reject_symlink(path)?;
    let temporary = temporary_path(path, parent);
    let result = (|| {
        let mut file = OpenOptions::new()
            .create_new(true)
            .write(true)
            .open(&temporary)
            .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
        file.write_all(bytes)
            .and_then(|_| file.sync_all())
            .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
        fs::rename(&temporary, path)
            .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
        sync_parent(parent)
    })();
    if result.is_err() {
        let _ = fs::remove_file(temporary);
    }
    result
}

pub(super) fn acquire_persistence_lock(path: &Path) -> SyncResult<PersistenceLock> {
    let parent = path.parent().unwrap_or_else(|| Path::new("."));
    fs::create_dir_all(parent).map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
    let lock_path = lock_path(path, parent);
    reject_symlink(&lock_path)?;
    let file = OpenOptions::new()
        .create(true)
        .truncate(false)
        .read(true)
        .write(true)
        .open(lock_path)
        .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
    file.lock_exclusive()
        .map_err(|error| SyncError::ReplicationFailed(error.to_string()))?;
    Ok(PersistenceLock { file })
}

pub(super) fn reject_symlink(path: &Path) -> SyncResult<()> {
    match fs::symlink_metadata(path) {
        Ok(metadata) if metadata.file_type().is_symlink() => Err(SyncError::ReplicationFailed(
            "persistent path must not be a symlink".to_string(),
        )),
        Ok(metadata) if !metadata.is_file() => Err(SyncError::ReplicationFailed(
            "persistent path is not a regular file".to_string(),
        )),
        Ok(_) => Ok(()),
        Err(error) if error.kind() == std::io::ErrorKind::NotFound => Ok(()),
        Err(error) => Err(SyncError::ReplicationFailed(error.to_string())),
    }
}

fn temporary_path(path: &Path, parent: &Path) -> PathBuf {
    let name = path
        .file_name()
        .and_then(|value| value.to_str())
        .unwrap_or("appcore-sync");
    parent.join(format!(
        ".{name}.{}-{}.tmp",
        std::process::id(),
        TEMP_COUNTER.fetch_add(1, Ordering::Relaxed)
    ))
}

fn lock_path(path: &Path, parent: &Path) -> PathBuf {
    let name = path
        .file_name()
        .and_then(|value| value.to_str())
        .unwrap_or("appcore-sync");
    parent.join(format!(".{name}.lock"))
}

#[cfg(unix)]
fn sync_parent(path: &Path) -> SyncResult<()> {
    File::open(path)
        .and_then(|directory| directory.sync_all())
        .map_err(|error| SyncError::ReplicationFailed(error.to_string()))
}

#[cfg(not(unix))]
fn sync_parent(_path: &Path) -> SyncResult<()> {
    Ok(())
}