debrepo 0.4.0

//! A Debian repository client library

mod arch;
mod archive;
/// Artifact representations and readers for repository content.
pub mod artifact;
/// Authentication providers and credential handling.
pub mod auth;
mod auth_vault;
mod builder;
/// CLI-facing types and parsers shared by binaries.
pub mod cli;
mod cli_edit;
/// Compression utilities for repository files.
pub mod comp;
/// Repository content staging and file generation helpers.
pub mod content;
/// Debian control file parsing and mutation.
pub mod control;
/// Debian package reader and staging utilities.
pub mod deb;
/// Error types for the library.
pub mod error;
/// Execution helpers for running external tools.
pub mod exec;
/// Git transport for `[import.git]` manifests.
pub mod git;
/// Hashing helpers and digest encodings.
pub mod hash;
mod idmap;
mod indexfile;
mod kvlist;
mod manifest;
mod manifest_doc;
mod packages;
/// Podman-backed sandbox execution.
pub mod podman;
mod release;
/// Sandbox abstractions and executors.
pub mod sandbox;
mod sources;
mod spec;
mod stage;
mod staging;
/// TAR archive reader and writer utilities.
pub use smol_tar as tar;
mod transport;
/// Package universe representation and query helpers.
pub mod universe;
mod version;

pub use {
    arch::DEFAULT_ARCH,
    archive::{Archive, RepositoryFile, SignedBy, Snapshot, SnapshotId},
    async_compression::Level as CompressionLevel,
    builder::{BuildJob, Executor},
    manifest::{Manifest, ResolvedSpecRef, SpecId, StageArtifactRef},
    packages::{Package, PackageOrigin, Packages},
    release::{Release, ReleaseIndexFile},
    sources::{Source, SourceUniverse, Sources},
    staging::{FileList, HostFileSystem, Stage, StagingFile, StagingFileSystem},
    transport::HttpTransport,
    version::{Constraint, Dependency, Version, VersionSet},
};
pub(crate) type LocalPackagesHash = sha2::Sha256;

pub(crate) fn parse_size(str: &[u8]) -> std::io::Result<u64> {
    let mut result: u64 = 0;
    for &byte in str {
        if byte == b' ' {
            break;
        }
        if !byte.is_ascii_digit() {
            return Err(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "not a digit",
            ));
        }
        result = result
            .checked_mul(10)
            .and_then(|res| res.checked_add((byte - b'0') as u64))
            .ok_or(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "size overflow",
            ))?;
    }
    Ok(result)
}

pub(crate) struct SafeStoreFile {
    name: std::path::PathBuf,
    file: smol::fs::File,
    path: tempfile::TempPath,
}
impl AsRef<smol::fs::File> for SafeStoreFile {
    fn as_ref(&self) -> &smol::fs::File {
        &self.file
    }
}
impl AsMut<smol::fs::File> for SafeStoreFile {
    fn as_mut(&mut self) -> &mut smol::fs::File {
        &mut self.file
    }
}
impl std::ops::Deref for SafeStoreFile {
    type Target = smol::fs::File;
    fn deref(&self) -> &Self::Target {
        &self.file
    }
}
impl Drop for SafeStoreFile {
    fn drop(&mut self) {
        use futures::AsyncWriteExt;
        let _ = smol::block_on(async {
            self.file.sync_all().await?;
            self.file.close().await?;
            smol::fs::rename(&self.path, &self.name).await
        });
    }
}
impl SafeStoreFile {
    pub(crate) async fn new<P: AsRef<std::path::Path>>(path: P) -> std::io::Result<Self> {
        use smol::io;
        use std::os::unix::fs::PermissionsExt;
        let dir = path
            .as_ref()
            .parent()
            .ok_or_else(|| io::Error::other("file has no parent"))?;
        smol::fs::create_dir_all(dir).await.map_err(|err| {
            io::Error::other(format!("Failed to create parent directories: {}", err))
        })?;
        let file_name = path
            .as_ref()
            .file_name()
            .and_then(|s| s.to_str())
            .ok_or_else(|| io::Error::other("invalid file name"))?;
        let (tmp_file, tmp_path) = tempfile::Builder::new()
            .permissions(std::fs::Permissions::from_mode(0o644))
            .prefix(file_name)
            .tempfile_in(dir)
            .map_err(|err| io::Error::other(format!("Failed to create temporary file: {}", err)))?
            .into_parts();
        Ok(Self {
            name: path.as_ref().to_path_buf(),
            file: tmp_file.into(),
            path: tmp_path,
        })
    }
}

pub(crate) async fn safe_store<P: AsRef<std::path::Path>, D: smol::io::AsyncRead + Send>(
    path: P,
    data: D,
) -> std::io::Result<()> {
    let mut tempfile = SafeStoreFile::new(&path).await?;
    smol::io::copy(data, tempfile.as_mut())
        .await
        .map_err(|err| {
            std::io::Error::other(format!("Failed to copy to temporary file: {}", err))
        })?;
    Ok(())
}

#[inline]
pub fn is_url(s: &str) -> bool {
    let mut bytes = s.as_bytes();
    if bytes.len() < 4 {
        return false;
    }
    if !bytes[0].is_ascii_alphabetic() {
        return false;
    }
    bytes = &bytes[1..];
    while let [c, rest @ ..] = bytes {
        if c.is_ascii_alphanumeric() || matches!(c, b'+' | b'-' | b'.') {
            bytes = rest;
        } else {
            break;
        }
    }
    if bytes.len() < 3 {
        return false;
    }
    bytes[0] == b':' && bytes[1] == b'/' && bytes[2] == b'/'
}
pub fn strip_url_scheme(s: &str) -> &str {
    let mut bytes = s.as_bytes();
    if bytes.len() < 4 {
        return s;
    }
    if !bytes[0].is_ascii_alphabetic() {
        return s;
    }
    bytes = &bytes[1..];
    while let [c, rest @ ..] = bytes {
        if c.is_ascii_alphanumeric() || matches!(c, b'+' | b'-' | b'.') {
            bytes = rest;
        } else {
            break;
        }
    }
    if bytes.len() < 3 {
        return s;
    }
    if bytes[0] == b':' && bytes[1] == b'/' && bytes[2] == b'/' {
        // SAFETY: we are just slicing the original string
        unsafe { std::str::from_utf8_unchecked(&bytes[3..]) }
    } else {
        s
    }
}

pub fn packer<'a, W: smol::io::AsyncWrite + Send + 'a>(
    u: &str,
    w: W,
    level: async_compression::Level,
) -> std::pin::Pin<Box<dyn smol::io::AsyncWrite + Send + 'a>> {
    use async_compression::futures::write::{
        BzEncoder, GzipEncoder, LzmaEncoder, XzEncoder, ZstdEncoder,
    };
    match u.rsplit('.').next().unwrap_or("") {
        "xz" => Box::pin(XzEncoder::with_quality(w, level)),
        "gz" => Box::pin(GzipEncoder::with_quality(w, level)),
        "bz2" => Box::pin(BzEncoder::with_quality(w, level)),
        "lzma" => Box::pin(LzmaEncoder::with_quality(w, level)),
        "zstd" | "zst" => Box::pin(ZstdEncoder::with_quality(w, level)),
        _ => Box::pin(w),
    }
}

pub fn unpacker<'a, R: smol::io::AsyncRead + Send + 'a>(
    u: &str,
    r: R,
) -> std::pin::Pin<Box<dyn smol::io::AsyncRead + Send + 'a>> {
    use async_compression::futures::bufread::{
        BzDecoder, GzipDecoder, LzmaDecoder, XzDecoder, ZstdDecoder,
    };
    use smol::io::BufReader;
    match u.rsplit('.').next().unwrap_or("") {
        "xz" => Box::pin(XzDecoder::new(BufReader::new(r))),
        "gz" => Box::pin(GzipDecoder::new(BufReader::new(r))),
        "bz2" => Box::pin(BzDecoder::new(BufReader::new(r))),
        "lzma" => Box::pin(LzmaDecoder::new(BufReader::new(r))),
        "zstd" | "zst" => Box::pin(ZstdDecoder::new(BufReader::new(r))),
        _ => Box::pin(r),
    }
}

pub fn strip_compression_ext(str: &str) -> &str {
    if let Some(pos) = str.rfind('.') {
        match &str[pos + 1..] {
            "xz" | "gz" | "bz2" | "lzma" | "zstd" | "zst" => &str[..pos],
            _ => str,
        }
    } else {
        str
    }
}

/// A small enum dispatch macro for defining CLI commands.
///
/// Examples
/// ```ignore
/// #[derive(Parser)]
/// #[command(name = "app")]
/// struct App {
///   // ...
/// }
///
/// impl debrepo::cli::Config for App {
///   // ...
///   #[command(subcommand)]
///   cmd: Commands,
/// }
///
/// debrepo::cli_commands! {
///   enum Commands<App> {
///     Init(debrepo::cli::cmd::Init),
///     // ...
///     #[command(name = "app-specific")]
///     Local,
///   }
/// }
///
/// #[derive(Parser)]
/// struct Local {
/// }
/// impl debrepo::cli::Command<App> for Local {
///   fn exec(&self, conf: &App) -> anyhow::Result<()> {
///     // ...
///   }
/// }
///
/// fn main() -> anyhow::Result<()> {
///   let mut app = App::parse();  
///   app.cmd.exec(&app)
/// }
// ```
#[macro_export]
macro_rules! cli_commands {
    ($v:vis enum $E:ident <$C:ident> { $($rest:tt)* }) => {
        $crate::__commands_collect! {
            @vis ($v)
            @enum $E
            @conf $C
            @items ()
            @rest $($rest)*
        }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! __commands_collect {
    (@vis ($v:vis) @enum $E:ident @conf $C:ident @items ( $($items:tt)* ) @rest $(#[$attrs:meta])* $V:ident ( $T:path ) , $($rest:tt)* ) => {
        $crate::__commands_collect! {
            @vis ($v)
            @enum $E
            @conf $C
            @items ( $($items)* ( [$(#[$attrs])*] $V $T ) )
            @rest $($rest)*
        }
    };
    (@vis ($v:vis) @enum $E:ident @conf $C:ident @items ( $($items:tt)* ) @rest $(#[$attrs:meta])* $V:ident ( $T:path ) ) => {
        $crate::__commands_expand! { @vis ($v) @enum $E @conf $C @items ( $($items)* ( [$(#[$attrs])*] $V $T ) ) }
    };
    (@vis ($v:vis) @enum $E:ident @conf $C:ident @items ( $($items:tt)* ) @rest $(#[$attrs:meta])* $V:ident , $($rest:tt)* ) => {
        $crate::__commands_collect! {
            @vis ($v)
            @enum $E
            @conf $C
            @items ( $($items)* ( [$(#[$attrs])*] $V $V ) )
            @rest $($rest)*
        }
    };
    (@vis ($v:vis) @enum $E:ident @conf $C:ident @items ( $($items:tt)* ) @rest $(#[$attrs:meta])* $V:ident ) => {
        $crate::__commands_expand! { @vis ($v) @enum $E @conf $C @items ( $($items)* ( [$(#[$attrs])*] $V $V ) ) }
    };
    (@vis ($v:vis) @enum $E:ident @conf $C:ident @items ( $($items:tt)* ) @rest) => {
        $crate::__commands_expand! { @vis ($v) @enum $E @conf $C @items ( $($items)* ) }
    };
}

#[doc(hidden)]
#[macro_export]
macro_rules! __commands_expand {
    (@vis ($v:vis) @enum $E:ident @conf $C:ident @items ( $( ( [$($attrs:tt)*] $V:ident $T:path ) )* ) ) => {
        #[derive(::clap::Subcommand)]
        $v enum $E {
            $( $($attrs)* $V($T), )*
        }
        impl $crate::cli::Command<$C> for $E {
            fn exec(&self, conf: &$C) -> ::anyhow::Result<()> {
                match self {
                    $( Self::$V(cmd) => cmd.exec(conf), )*
                }
            }
        }
    };
}