cacache 13.1.0

#[cfg(any(feature = "async-std", feature = "tokio"))]
use crate::async_lib::AsyncRead;
#[cfg(any(feature = "async-std", feature = "tokio"))]
use crate::async_lib::AsyncReadExt;
use crate::content::linkto;
use crate::errors::{Error, IoErrorExt, Result};
use crate::{index, WriteOpts};
use ssri::{Algorithm, Integrity};
use std::io::Read;
use std::path::{Path, PathBuf};
#[cfg(any(feature = "async-std", feature = "tokio"))]
use std::pin::Pin;
#[cfg(any(feature = "async-std", feature = "tokio"))]
use std::task::{Context as TaskContext, Poll};

const BUF_SIZE: usize = 16 * 1024;
const PROBE_SIZE: usize = 8;

/// Asynchronously adds `target` to the `cache` with a symlink, indexing it
/// under `key`.
///
/// ## Example
/// ```no_run
/// use async_attributes;
/// use std::path::Path;
///
/// #[async_attributes::main]
/// async fn main() -> cacache::Result<()> {
///     cacache::link_to("./my-cache", "my-key", "../my-other-files/my-file.tgz").await?;
///     Ok(())
/// }
/// ```
#[cfg(any(feature = "async-std", feature = "tokio"))]
pub async fn link_to<P, K, T>(cache: P, key: K, target: T) -> Result<Integrity>
where
    P: AsRef<Path>,
    K: AsRef<str>,
    T: AsRef<Path>,
{
    ToLinker::open(cache, key, target).await?.commit().await
}

/// Asynchrounously adds `target` to the `cache` with a symlink, skipping
/// associating an index key with it.
///
/// ## Example
/// ```no_run
/// use async_attributes;
/// use std::path::Path;
///
/// #[async_attributes::main]
/// async fn main() -> cacache::Result<()> {
///     cacache::link_to_hash("./my-cache", "../my-other-files/my-file.tgz").await?;
///     Ok(())
/// }
/// ```
#[cfg(any(feature = "async-std", feature = "tokio"))]
pub async fn link_to_hash<P, T>(cache: P, target: T) -> Result<Integrity>
where
    P: AsRef<Path>,
    T: AsRef<Path>,
{
    ToLinker::open_hash(cache, target).await?.commit().await
}

/// Synchronously creates a symlink in the `cache` to the `target`, indexing it
/// under `key`.
///
/// ## Example
/// ```no_run
/// use std::io::Read;
/// use std::path::Path;
///
/// fn main() -> cacache::Result<()> {
///     cacache::link_to_sync("./my-cache", "my-key", "../my-other-files/my-file.tgz")?;
///     Ok(())
/// }
/// ```
pub fn link_to_sync<P, K, T>(cache: P, key: K, target: T) -> Result<Integrity>
where
    P: AsRef<Path>,
    K: AsRef<str>,
    T: AsRef<Path>,
{
    SyncToLinker::open(cache, key, target)?.commit()
}

/// Synchronously creates a symlink in the `cache` to the `target`, skipping
/// associating an index key with it.
///
/// ## Example
/// ```no_run
/// use std::io::Read;
/// use std::path::Path;
///
/// fn main() -> cacache::Result<()> {
///     cacache::link_to_hash_sync("./my-cache", "../foo/bar.tgz")?;
///     Ok(())
/// }
/// ```
pub fn link_to_hash_sync<P, T>(cache: P, target: T) -> Result<Integrity>
where
    P: AsRef<Path>,
    T: AsRef<Path>,
{
    SyncToLinker::open_hash(cache, target)?.commit()
}

/// Extend the `WriteOpts` struct with factories for creating `ToLinker` and
/// `SyncToLinker` instances.
impl WriteOpts {
    /// Opens the target file handle for reading, returning a ToLinker instance.
    #[cfg(any(feature = "async-std", feature = "tokio"))]
    pub async fn link_to<P, K, T>(self, cache: P, key: K, target: T) -> Result<ToLinker>
    where
        P: AsRef<Path>,
        K: AsRef<str>,
        T: AsRef<Path>,
    {
        async fn inner(
            opts: WriteOpts,
            cache: &Path,
            key: &str,
            target: &Path,
        ) -> Result<ToLinker> {
            Ok(ToLinker {
                cache: cache.to_path_buf(),
                key: Some(String::from(key)),
                read: 0,
                linker: linkto::AsyncToLinker::new(
                    cache,
                    opts.algorithm.unwrap_or(Algorithm::Sha256),
                    target,
                )
                .await?,
                opts,
            })
        }
        inner(self, cache.as_ref(), key.as_ref(), target.as_ref()).await
    }

    /// Opens the target file handle for reading, without a key, returning a
    /// ToLinker instance.
    #[cfg(any(feature = "async-std", feature = "tokio"))]
    pub async fn link_to_hash<P, T>(self, cache: P, target: T) -> Result<ToLinker>
    where
        P: AsRef<Path>,
        T: AsRef<Path>,
    {
        async fn inner(opts: WriteOpts, cache: &Path, target: &Path) -> Result<ToLinker> {
            Ok(ToLinker {
                cache: cache.to_path_buf(),
                key: None,
                read: 0,
                linker: linkto::AsyncToLinker::new(
                    cache,
                    opts.algorithm.unwrap_or(Algorithm::Sha256),
                    target,
                )
                .await?,
                opts,
            })
        }
        inner(self, cache.as_ref(), target.as_ref()).await
    }

    /// Opens the target file handle for reading synchronously, returning a
    /// SyncToLinker instance.
    pub fn link_to_sync<P, K, T>(self, cache: P, key: K, target: T) -> Result<SyncToLinker>
    where
        P: AsRef<Path>,
        K: AsRef<str>,
        T: AsRef<Path>,
    {
        fn inner(opts: WriteOpts, cache: &Path, key: &str, target: &Path) -> Result<SyncToLinker> {
            Ok(SyncToLinker {
                cache: cache.to_path_buf(),
                key: Some(String::from(key)),
                read: 0,
                linker: linkto::ToLinker::new(
                    cache,
                    opts.algorithm.unwrap_or(Algorithm::Sha256),
                    target,
                )?,
                opts,
            })
        }
        inner(self, cache.as_ref(), key.as_ref(), target.as_ref())
    }

    /// Opens the target file handle for reading synchronously, without a key,
    /// returning a SyncToLinker instance.
    pub fn link_to_hash_sync<P, T>(self, cache: P, target: T) -> Result<SyncToLinker>
    where
        P: AsRef<Path>,
        T: AsRef<Path>,
    {
        fn inner(opts: WriteOpts, cache: &Path, target: &Path) -> Result<SyncToLinker> {
            Ok(SyncToLinker {
                cache: cache.to_path_buf(),
                key: None,
                read: 0,
                linker: linkto::ToLinker::new(
                    cache,
                    opts.algorithm.unwrap_or(Algorithm::Sha256),
                    target,
                )?,
                opts,
            })
        }
        inner(self, cache.as_ref(), target.as_ref())
    }
}

/// A file handle for asynchronously reading in data from a file to be added to
/// the cache via a symlink to the target file.
///
/// Make sure to call `.commit()` when done reading to actually add the file to
/// the cache.
#[cfg(any(feature = "async-std", feature = "tokio"))]
pub struct ToLinker {
    cache: PathBuf,
    key: Option<String>,
    read: usize,
    pub(crate) linker: linkto::AsyncToLinker,
    opts: WriteOpts,
}

#[cfg(any(feature = "async-std", feature = "tokio"))]
impl AsyncRead for ToLinker {
    #[cfg(feature = "async-std")]
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut TaskContext<'_>,
        buf: &mut [u8],
    ) -> Poll<std::io::Result<usize>> {
        let amt = futures::ready!(Pin::new(&mut self.linker).poll_read(cx, buf))?;
        self.read += amt;
        Poll::Ready(Ok(amt))
    }

    #[cfg(feature = "tokio")]
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut TaskContext<'_>,
        buf: &mut tokio::io::ReadBuf<'_>,
    ) -> Poll<tokio::io::Result<()>> {
        let pre_len = buf.filled().len();
        futures::ready!(Pin::new(&mut self.linker).poll_read(cx, buf))?;
        self.read += buf.filled().len() - pre_len;
        Poll::Ready(Ok(()))
    }
}

fn filesize(target: &Path) -> Result<usize> {
    Ok(target
        .metadata()
        .with_context(|| format!("Failed to get metadata of {}", target.display()))?
        .len() as usize)
}

#[cfg(any(feature = "async-std", feature = "tokio"))]
impl ToLinker {
    /// Creates a new asynchronous readable file handle into the cache.
    pub async fn open<P, K, T>(cache: P, key: K, target: T) -> Result<Self>
    where
        P: AsRef<Path>,
        K: AsRef<str>,
        T: AsRef<Path>,
    {
        async fn inner(cache: &Path, key: &str, target: &Path) -> Result<ToLinker> {
            let size = filesize(target)?;
            WriteOpts::new()
                .algorithm(Algorithm::Sha256)
                .size(size)
                .link_to(cache, key, target)
                .await
        }
        inner(cache.as_ref(), key.as_ref(), target.as_ref()).await
    }

    /// Creates a new asynchronous readable file handle into the cache.
    pub async fn open_hash<P, T>(cache: P, target: T) -> Result<Self>
    where
        P: AsRef<Path>,
        T: AsRef<Path>,
    {
        async fn inner(cache: &Path, target: &Path) -> Result<ToLinker> {
            let size = filesize(target)?;
            WriteOpts::new()
                .algorithm(Algorithm::Sha256)
                .size(size)
                .link_to_hash(cache, target)
                .await
        }
        inner(cache.as_ref(), target.as_ref()).await
    }

    /// Consumes the rest of the file handle, creates an symlink into
    /// the cache, and creates index entries for the linked file. Also verifies
    /// data against `size` and `integrity` options, if provided. Must be called
    /// manually in order to complete the writing process, otherwise everything
    /// will be thrown out.
    pub async fn commit(mut self) -> Result<Integrity> {
        self.consume().await?;
        let linker_sri = self.linker.commit().await?;
        if let Some(sri) = &self.opts.sri {
            if sri.matches(&linker_sri).is_none() {
                return Err(ssri::Error::IntegrityCheckError(sri.clone(), linker_sri).into());
            }
        } else {
            self.opts.sri = Some(linker_sri.clone());
        }
        if let Some(size) = self.opts.size {
            if size != self.read {
                return Err(Error::SizeMismatch(size, self.read));
            }
        }
        if let Some(key) = self.key {
            index::insert(&self.cache, &key, self.opts)
        } else {
            Ok(linker_sri)
        }
    }

    // "Consume" the remainder of the reader, so that the integrity is properly
    // calculated.
    async fn consume(&mut self) -> Result<()> {
        // Do a small 'test' read to avoid allocating a larger buffer if it
        // isn't necessary.
        let mut probe = [0; PROBE_SIZE];
        if self.context_read(&mut probe).await? > 0 {
            // Make sure all the bytes are read so that the integrity is
            // properly calculated.
            let mut buf = [0; BUF_SIZE];
            while self.context_read(&mut buf).await? > 0 {}
        }
        Ok(())
    }

    async fn context_read(&mut self, buf: &mut [u8]) -> Result<usize> {
        AsyncReadExt::read(self, buf).await.with_context(|| {
            "Failed to read target file contents while calculating integrity".into()
        })
    }
}

/// A file handle for synchronously reading data from a file to be added to the
/// cache via a symlink.
///
/// Make sure to call `.commit()` when done reading to actually add the file
/// to the cache.
pub struct SyncToLinker {
    cache: PathBuf,
    key: Option<String>,
    read: usize,
    pub(crate) linker: linkto::ToLinker,
    opts: WriteOpts,
}

impl std::io::Read for SyncToLinker {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        let amt = self.linker.read(buf)?;
        self.read += amt;
        Ok(amt)
    }
}

impl SyncToLinker {
    /// Creates a new readable file handle to a file the cache will link to,
    /// indexed at the provided key, on commit.
    ///
    /// It is not necessary to read any of the file before calling `.commit()`.
    ///
    /// ## Example
    /// ```no_run
    /// use std::io::prelude::*;
    ///
    /// fn main() -> cacache::Result<()> {
    ///     let path = "../my-other-files/my-file.tgz";
    ///     let mut fd = cacache::SyncToLinker::open("./my-cache", "my-key", path)?;
    ///     let mut str = String::new();
    ///     fd.read_to_string(&mut str).expect("Failed to read to string");
    ///     // The file is not linked into the cache until you commit it.
    ///     fd.commit()?;
    ///     Ok(())
    /// }
    /// ```
    pub fn open<P, K, T>(cache: P, key: K, target: T) -> Result<Self>
    where
        P: AsRef<Path>,
        K: AsRef<str>,
        T: AsRef<Path>,
    {
        fn inner(cache: &Path, key: &str, target: &Path) -> Result<SyncToLinker> {
            let size = filesize(target)?;
            WriteOpts::new()
                .algorithm(Algorithm::Sha256)
                .size(size)
                .link_to_sync(cache, key, target)
        }
        inner(cache.as_ref(), key.as_ref(), target.as_ref())
    }

    /// Creates a new readable file handle to a file that the cache will link
    /// to, without an indexe key, on commit.
    ///
    /// It is not necessary to read any of the file before calling `.commit()`.
    ///
    /// ## Example
    /// ```no_run
    /// use std::io::prelude::*;
    ///
    /// fn main() -> cacache::Result<()> {
    ///     let path = "../my-other-files/my-file.tgz";
    ///     let mut fd = cacache::SyncToLinker::open_hash("./my-cache", path)?;
    ///     let mut str = String::new();
    ///     fd.read_to_string(&mut str).expect("Failed to read to string");
    ///     // The file is not linked into the cache until you commit it.
    ///     fd.commit()?;
    ///     Ok(())
    /// }
    /// ```
    pub fn open_hash<P, T>(cache: P, target: T) -> Result<Self>
    where
        P: AsRef<Path>,
        T: AsRef<Path>,
    {
        fn inner(cache: &Path, target: &Path) -> Result<SyncToLinker> {
            let size = filesize(target)?;
            WriteOpts::new()
                .algorithm(Algorithm::Sha256)
                .size(size)
                .link_to_hash_sync(cache, target)
        }
        inner(cache.as_ref(), target.as_ref())
    }

    /// Consumes the rest of the file handle, creates a symlink to the file, and
    /// creates index entries for the linked file. Also verifies data against
    /// `size` and `integrity` options, if provided. Must be called manually in
    /// order to complete the writing process, otherwise everything will be
    /// thrown out.
    pub fn commit(mut self) -> Result<Integrity> {
        self.consume()?;
        let cache = self.cache;
        let linker_sri = self.linker.commit()?;
        if let Some(sri) = &self.opts.sri {
            if sri.matches(&linker_sri).is_none() {
                return Err(ssri::Error::IntegrityCheckError(sri.clone(), linker_sri).into());
            }
        } else {
            self.opts.sri = Some(linker_sri.clone());
        }
        if let Some(size) = self.opts.size {
            if size != self.read {
                return Err(Error::SizeMismatch(size, self.read));
            }
        }
        if let Some(key) = self.key {
            index::insert(&cache, &key, self.opts)
        } else {
            Ok(linker_sri)
        }
    }

    fn consume(&mut self) -> Result<()> {
        // Do a small 'test' read to avoid allocating a larger buffer if it
        // isn't necessary.
        let mut probe = [0; PROBE_SIZE];
        if self.context_read(&mut probe)? > 0 {
            // Make sure all the bytes are read so that the integrity is
            // properly calculated.
            let mut buf = [0; BUF_SIZE];
            while self.context_read(&mut buf)? > 0 {}
        }
        Ok(())
    }

    fn context_read(&mut self, buf: &mut [u8]) -> Result<usize> {
        self.read(buf).with_context(|| {
            "Failed to read target file contents while calculating integrity".into()
        })
    }
}

#[cfg(test)]
mod tests {
    use std::fs::File;
    use std::io::Write;

    use super::*;

    #[cfg(feature = "async-std")]
    use async_attributes::test as async_test;
    #[cfg(feature = "tokio")]
    use tokio::test as async_test;

    fn create_tmpfile(tmp: &tempfile::TempDir, buf: &[u8]) -> PathBuf {
        let dir = tmp.path().to_owned();
        let target = dir.join("target-file");
        std::fs::create_dir_all(target.parent().unwrap()).unwrap();
        let mut file = File::create(&target).unwrap();
        file.write_all(buf).unwrap();
        file.flush().unwrap();
        target
    }

    #[cfg(any(feature = "async-std", feature = "tokio"))]
    #[async_test]
    async fn test_link() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        crate::link_to(&dir, "my-key", target).await.unwrap();

        let buf = crate::read(&dir, "my-key").await.unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[cfg(any(feature = "async-std", feature = "tokio"))]
    #[async_test]
    async fn test_link_to_hash() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        let sri = crate::link_to_hash(&dir, target).await.unwrap();

        let buf = crate::read_hash(&dir, &sri).await.unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[test]
    fn test_link_to_sync() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        crate::link_to_sync(&dir, "my-key", target).unwrap();

        let buf = crate::read_sync(&dir, "my-key").unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[test]
    fn test_link_to_hash_sync() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        let sri = crate::link_to_hash_sync(&dir, target).unwrap();

        let buf = crate::read_hash_sync(&dir, &sri).unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[cfg(any(feature = "async-std", feature = "tokio"))]
    #[async_test]
    async fn test_open() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        let mut handle = crate::ToLinker::open(&dir, "my-key", target).await.unwrap();

        let mut buf = Vec::new();
        handle.read_to_end(&mut buf).await.unwrap();
        handle.commit().await.unwrap();
        assert_eq!(buf, b"hello world");

        let buf = crate::read_sync(&dir, "my-key").unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[cfg(any(feature = "async-std", feature = "tokio"))]
    #[async_test]
    async fn test_open_hash() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        let mut handle = crate::ToLinker::open_hash(&dir, target).await.unwrap();

        let mut buf = Vec::new();
        handle.read_to_end(&mut buf).await.unwrap();
        let sri = handle.commit().await.unwrap();
        assert_eq!(buf, b"hello world");

        let buf = crate::read_hash_sync(&dir, &sri).unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[test]
    fn test_open_sync() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        let mut handle = crate::SyncToLinker::open(&dir, "my-key", target).unwrap();

        let mut buf = Vec::new();
        handle.read_to_end(&mut buf).unwrap();
        handle.commit().unwrap();
        assert_eq!(buf, b"hello world");

        let buf = crate::read_sync(&dir, "my-key").unwrap();
        assert_eq!(buf, b"hello world");
    }

    #[test]
    fn test_open_hash_sync() {
        let tmp = tempfile::tempdir().unwrap();
        let target = create_tmpfile(&tmp, b"hello world");

        let tmp = tempfile::tempdir().unwrap();
        let dir = tmp.path().to_owned();
        let mut handle = crate::SyncToLinker::open_hash(&dir, target).unwrap();

        let mut buf = Vec::new();
        handle.read_to_end(&mut buf).unwrap();
        let sri = handle.commit().unwrap();
        assert_eq!(buf, b"hello world");

        let buf = crate::read_hash_sync(&dir, &sri).unwrap();
        assert_eq!(buf, b"hello world");
    }
}