opendp_tooling/proven/
filesystem.rs

use std::{collections::HashMap, env, ffi::OsStr, path::PathBuf};

use darling::{Error, Result};
use regex::Regex;

/// Traverses the filesystem, starting at src_dir, looking for .tex files.
/// If more than one file is discovered with the same name, the value becomes None
pub fn find_proof_paths(
    src_dir: &std::path::Path,
) -> std::io::Result<HashMap<String, Option<String>>> {
    let mut proof_paths = HashMap::new();
    find_unique_file_names_with_extension(&mut proof_paths, &OsStr::new("tex"), src_dir, src_dir)?;
    Ok(proof_paths)
}

/// Writes a collection of proof paths to {OUT_DIR}/proof_paths.json.
pub fn write_proof_paths(proof_paths: &HashMap<String, Option<String>>) -> Result<()> {
    std::fs::write(
        get_out_dir()?.join("proof_paths.json"),
        serde_json::to_string(proof_paths).map_err(Error::custom)?,
    )
    .map_err(Error::custom)
}

/// Load proof paths from {OUT_DIR}/proof_paths.json.
/// Assumes the file was written in the build script.
pub fn load_proof_paths() -> Result<HashMap<String, Option<String>>> {
    serde_json::from_str(
        &std::fs::read_to_string(get_out_dir()?.join("proof_paths.json")).map_err(Error::custom)?,
    )
    .map_err(Error::custom)
}

/// The inner function for find_proof_paths
fn find_unique_file_names_with_extension(
    matches: &mut HashMap<String, Option<String>>,
    file_extension: &OsStr,
    root_dir: &std::path::Path,
    dir: &std::path::Path,
) -> std::io::Result<()> {
    if dir.is_dir() {
        for entry in std::fs::read_dir(dir)? {
            let path = entry?.path();
            if path.is_dir() {
                find_unique_file_names_with_extension(matches, file_extension, root_dir, &path)?;
            } else {
                if path.extension() != Some(file_extension) {
                    continue;
                }
                if let Some(file_name) = path.file_stem() {
                    matches
                        .entry(file_name.to_string_lossy().to_string())
                        // replaces the Option with None, because the name is no longer unique
                        .and_modify(|v| drop(v.take()))
                        .or_insert_with(|| {
                            Some(
                                path.strip_prefix(root_dir)
                                    .expect("unreachable")
                                    .to_string_lossy()
                                    .to_string(),
                            )
                        });
                }
            };
        }
    }
    Ok(())
}

pub fn get_src_dir() -> Result<PathBuf> {
    let manifest_dir = std::env::var_os("CARGO_MANIFEST_DIR")
        .ok_or_else(|| Error::custom("Failed to determine location of Cargo.toml."))?;
    Ok(PathBuf::from(manifest_dir).join("src"))
}

fn get_out_dir() -> Result<PathBuf> {
    let manifest_dir =
        std::env::var_os("OUT_DIR").ok_or_else(|| Error::custom("Failed to determine OUT_DIR."))?;
    Ok(PathBuf::from(manifest_dir))
}

pub fn make_proof_link(
    source_dir: PathBuf,
    mut relative_path: PathBuf,
    repo_path: PathBuf,
) -> Result<String> {
    // construct absolute path
    let absolute_path = source_dir.join(&relative_path);

    if !absolute_path.exists() {
        return Err(Error::custom(format!("{absolute_path:?} does not exist!")));
    }

    // link to the pdf, not the tex
    relative_path.set_extension("pdf");

    // link from sphinx and rustdoc to latex
    let proof_uri = if let Ok(sphinx_port) = env::var("OPENDP_SPHINX_PORT") {
        format!("http://localhost:{sphinx_port}")
    } else {
        // find the docs uri
        let docs_uri = env::var("OPENDP_REMOTE_SPHINX_URI")
            .unwrap_or_else(|_| "https://docs.opendp.org".to_string());

        // find the version
        let version = env!("CARGO_PKG_VERSION");
        let docs_ref = get_docs_ref(version);

        format!("{docs_uri}/en/{docs_ref}")
    };

    Ok(format!(
        "{proof_uri}/proofs/{repo_path}/{relative_path}",
        proof_uri = proof_uri,
        repo_path = repo_path.display(),
        relative_path = relative_path.display()
    ))
}

fn get_docs_ref(version: &str) -> String {
    // docs.opendp.org has tags for stable versions, but only a single branch for beta & nightly.
    let channel = get_channel(version);
    match channel.as_str() {
        "stable" => format!("v{version}"), // For stable, we have tags.
        "dev" => "nightly".to_string(),    // Will be replaced by the @versioned decorator.
        _ => channel, // For beta & nightly, we don't have tags, just a single branch.
    }
}

fn get_channel(version: &str) -> String {
    let re = Regex::new(r"^(\d+\.\d+\.\d+)(?:-(dev|nightly|beta)(?:\.(.+))?)?$").unwrap();
    if let Some(caps) = re.captures(version) {
        let channel = caps.get(2);
        return channel.map_or("stable", |m| m.as_str()).to_string();
    }
    "unknown".to_string()
}
opendp_tooling/proven/filesystem.rs

opendp_tooling/proven/
filesystem.rs
