fetter 3.4.0

use crate::write_color::write_color;
use sha2::{Digest, Sha256};
use std::collections::HashSet;
use std::env;
use std::fmt::Write;
use std::fs;
use std::io;
use std::io::Stderr;
use std::ops::DerefMut;
use std::os::fd::{AsRawFd, RawFd};
use std::os::unix::fs::PermissionsExt;
use std::path::Path;
use std::path::PathBuf;
use std::process::Command;
use std::sync::{Mutex, OnceLock};
use std::thread;
use std::time::Duration;
use std::time::{SystemTime, UNIX_EPOCH};
use toml::Value as TomlValue;

//------------------------------------------------------------------------------

pub type ResultDynError<T> = Result<T, Box<dyn std::error::Error>>;

pub(crate) const DURATION_0: Duration = Duration::from_secs(0);

pub(crate) const WILDCARD: &str = "*";

//------------------------------------------------------------------------------
#[derive(Debug, Copy, Clone)]
pub enum Anchor {
    Lower,
    Upper,
    Both,
}

//------------------------------------------------------------------------------

#[derive(Clone, Copy, Debug)]
pub struct FlagLog(pub bool);

impl From<bool> for FlagLog {
    fn from(value: bool) -> Self {
        FlagLog(value)
    }
}

impl From<FlagLog> for bool {
    fn from(val: FlagLog) -> Self {
        val.0
    }
}

//------------------------------------------------------------------------------

#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ScanConfig {
    pub force_usite: bool,
    pub all_users: bool,
}

impl ScanConfig {
    pub fn new(force_usite: bool, all_users: bool) -> Self {
        Self {
            force_usite,
            all_users,
        }
    }
}

//------------------------------------------------------------------------------

#[derive(Clone, Debug)]
pub struct CacheConfig {
    pub duration: Duration,
    pub directory: PathBuf,
}

impl CacheConfig {
    pub fn new(duration: Duration, directory: PathBuf) -> Self {
        Self {
            duration,
            directory,
        }
    }
}

//------------------------------------------------------------------------------

#[derive(Clone, Copy, Debug)]
pub struct FlagCacheRefresh(pub bool);

impl From<bool> for FlagCacheRefresh {
    fn from(value: bool) -> Self {
        FlagCacheRefresh(value)
    }
}

impl From<FlagCacheRefresh> for bool {
    fn from(val: FlagCacheRefresh) -> Self {
        val.0
    }
}

#[derive(Clone, Copy, Debug)]
pub struct FlagRetainPassing(pub bool);

impl From<bool> for FlagRetainPassing {
    fn from(value: bool) -> Self {
        FlagRetainPassing(value)
    }
}

impl From<FlagRetainPassing> for bool {
    fn from(val: FlagRetainPassing) -> Self {
        val.0
    }
}

//------------------------------------------------------------------------------

// Global Mutex to ensure thread-safe logging
static LOGGER: OnceLock<Mutex<Stderr>> = OnceLock::new();

pub(crate) fn logger_core(module: &str, msg: &str) {
    let thread_id = thread::current().id();
    let duration_since_epoch = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .expect("Time went backwards");

    let mut logger = LOGGER
        .get_or_init(|| Mutex::new(io::stderr())) // Initialize Mutex<Stderr> lazily
        .lock()
        .unwrap();
    let writer = logger.deref_mut();

    write_color(writer, "#333333", "fetter: ");
    write_color(
        writer,
        "#3333ff",
        format!("[{:<21}] ", format!("{:?}", duration_since_epoch)).as_str(),
    );
    write_color(writer, "#0033ff", format!("[{module}] ").as_str());
    write_color(writer, "#336666", format!("[{thread_id:?}] ").as_str());
    write_color(writer, "#333333", format!("{msg}\n").as_str());
}

#[macro_export]
macro_rules! logger {
    ($log:expr, $module:expr, $($arg:tt)*) => {{
        if ::core::convert::Into::<bool>::into($log) {
            $crate::util::logger_core($module, &format!($($arg)*));
        }
    }};
}

pub use crate::logger;

//------------------------------------------------------------------------------

pub(crate) enum StdWriter {
    Stdout(io::Stdout),
    Stderr(io::Stderr),
}

impl io::Write for StdWriter {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        match self {
            StdWriter::Stdout(stdout) => stdout.write(buf),
            StdWriter::Stderr(stderr) => stderr.write(buf),
        }
    }

    fn flush(&mut self) -> io::Result<()> {
        match self {
            StdWriter::Stdout(stdout) => stdout.flush(),
            StdWriter::Stderr(stderr) => stderr.flush(),
        }
    }
}

impl AsRawFd for StdWriter {
    fn as_raw_fd(&self) -> RawFd {
        match self {
            StdWriter::Stdout(stdout) => stdout.as_raw_fd(),
            StdWriter::Stderr(stderr) => stderr.as_raw_fd(),
        }
    }
}

pub(crate) fn get_writer(stderr: bool) -> StdWriter {
    if stderr {
        StdWriter::Stderr(io::stderr())
    } else {
        StdWriter::Stdout(io::stdout())
    }
}

//------------------------------------------------------------------------------

pub fn vecs_equal_as_sets<T: Eq + std::hash::Hash>(vec1: &[T], vec2: &[T]) -> bool {
    if vec1.len() != vec2.len() {
        return false;
    }
    let set1: HashSet<_> = vec1.iter().collect();
    let set2: HashSet<_> = vec2.iter().collect();
    set1 == set2
}

// Normalize all names
pub(crate) fn name_to_key(name: &str) -> String {
    name.to_lowercase().replace('-', "_")
}

/// Remove whitespace and a leading "@" if found. Note: this owns the passed String as this is appropriate for the context in which it is used.
pub(crate) fn url_trim(mut input: String) -> String {
    input = input.trim().to_string();
    if input.starts_with('@') {
        input.remove(0);
        input = input.trim().to_string();
    }
    input
}

pub(crate) fn url_strip_user(url: &String) -> String {
    if let Some(pos_protocol) = url.find("://") {
        let pos_start = pos_protocol + 3;
        // get span to first @ if it exists
        if let Some(pos_span) = url[pos_start..].find('@') {
            let pos_end = pos_start + pos_span + 1;
            if url[pos_start..pos_end].find('/').is_none() {
                return format!("{}{}", &url[..pos_start], &url[pos_end..]);
            }
        }
    }
    url.to_string()
}

const PY_SYS_EXE: &str = "import sys;print(sys.executable)";

// Use the default Python to get absolute path to the exe. Use "-S" to skip site configuration.
pub(crate) fn get_absolute_path_from_exe(executable: &str) -> Option<PathBuf> {
    match Command::new(executable)
        .arg("-S")
        .arg("-c")
        .arg(PY_SYS_EXE)
        .output()
    {
        Ok(output) => match std::str::from_utf8(&output.stdout) {
            Ok(s) => Some(PathBuf::from(s.trim())),
            Err(_) => None,
        },
        Err(_) => None,
    }
}

//------------------------------------------------------------------------------

// Determine if the Path is an exe; must be an absolute path.
fn is_python_exe_file_name(path: &Path) -> bool {
    match path.file_name().and_then(|f| f.to_str()) {
        Some(name) if name.starts_with("python") => {
            let suffix = &name[6..];
            // NOTE: this will not work for windows .exe
            suffix.is_empty() || suffix.chars().all(|c| c.is_ascii_digit() || c == '.')
        }
        _ => false,
    }
}

// Return True if the absolute path points to a python executable. We assume this has already been proven to exist.
pub(crate) fn is_python_exe(path: &Path) -> bool {
    if is_python_exe_file_name(path) {
        match fs::metadata(path) {
            Ok(md) => md.permissions().mode() & 0o111 != 0,
            Err(_) => false,
        }
    } else {
        false
    }
}

pub(crate) fn path_home() -> Option<PathBuf> {
    if env::consts::OS == "windows" {
        env::var_os("USERPROFILE").map(PathBuf::from)
    } else {
        env::var_os("HOME").map(PathBuf::from)
    }
}

const IO_FETTER: &str = "io.fetter";

// TOOD: return error instead of option
pub fn path_cache(create: bool) -> Option<PathBuf> {
    let cache_path = if env::consts::OS == "windows" {
        env::var_os("LOCALAPPDATA").map(|local_app_data| {
            let mut path = PathBuf::from(local_app_data);
            path.push(IO_FETTER);
            path.push("Cache");
            path
        })
    } else if env::consts::OS == "macos" {
        path_home().map(|mut path| {
            path.push("Library");
            path.push("Caches");
            path.push(IO_FETTER);
            path
        })
    } else {
        path_home().map(|mut path| {
            path.push(".cache");
            path.push(IO_FETTER);
            path
        })
    };
    if create {
        if let Some(ref path) = cache_path {
            if let Err(e) = fs::create_dir_all(path) {
                eprintln!("Failed to create cache directory: {e}");
                return None;
            }
        }
    }
    cache_path
}

/// Return the base directory that typically contains user home folders.
pub(crate) fn path_users() -> Option<PathBuf> {
    let path_str = match env::consts::OS {
        "linux" => "/home",
        "macos" => "/Users",
        "windows" => r"C:\Users",
        _ => "/home", // generic UNIX fallback
    };

    let path = Path::new(path_str);
    if path.is_dir() {
        Some(path.to_path_buf())
    } else {
        None
    }
}

/// Given a Path, make it absolute, either expanding `~` or prepending current working directory.
pub(crate) fn path_normalize(path: &Path, validate: bool) -> ResultDynError<PathBuf> {
    let mut fp = path.to_path_buf();
    if let Some(path_str) = fp.to_str() {
        if path_str.starts_with('~') {
            let home = path_home().ok_or("Cannot get home directory")?;
            let path_stripped =
                fp.strip_prefix("~").map_err(|_| "Failed to strip prefix")?;
            fp = home.join(path_stripped);
        }
    }
    if fp.is_relative() {
        let cwd = env::current_dir().map_err(|e| e.to_string())?;
        fp = cwd.join(fp);
    }
    if validate && !fp.exists() {
        return Err(format!("File path does not exist: {}", fp.display()).into());
    }
    Ok(fp)
}

/// Optimal routine to determine if a Path has only one component. A single component at the root directory ("/bin") has two components and will return false.
pub(crate) fn path_is_component(path: &Path) -> bool {
    let mut components = path.components();
    components.next().is_some() && components.next().is_none()
}

pub(crate) fn exe_path_normalize(path: &Path) -> ResultDynError<PathBuf> {
    let mut fp = path.to_path_buf();
    // if given a single-component path that is a Python name, call it to get the full path to the exe
    if is_python_exe_file_name(path) && path_is_component(path) {
        fp = match path.file_name().and_then(|f| f.to_str()) {
            Some(name) => get_absolute_path_from_exe(name)
                .ok_or_else(|| format!("cannot get absolute path from exe: {path:?}"))?,
            None => {
                let msg = format!("cannot get absolute path from exe: {path:?}");
                return Err(msg.into());
            }
        };
    }
    path_normalize(&fp, true) // always validate
}

// Return True of the Path specified was saved within the provided duration from now.
pub(crate) fn path_within_duration<P: AsRef<Path>>(
    cache_path: P,
    max_dur: Duration,
) -> bool {
    if let Ok(metadata) = fs::metadata(&cache_path) {
        if let Ok(modified) = metadata.modified() {
            if let Ok(dur) = SystemTime::now().duration_since(modified) {
                return dur <= max_dur;
            }
        }
    }
    false
}

/// Create a hash of an iterable of PathBuf plus scan configuration options.
pub(crate) fn hash_paths(paths: &[PathBuf], config: &ScanConfig) -> String {
    let mut ps: Vec<PathBuf> = paths.to_owned();
    ps.sort();

    let concatenated = ps
        .iter()
        .map(|path| path.to_string_lossy())
        .collect::<Vec<_>>()
        .join("\n");

    let input = format!(
        "{concatenated}\n{}\n{}",
        config.force_usite, config.all_users
    );
    hash_string(&input)
}

/// Generate SHA256 hash of a string and return it as a lowercase hexadecimal string
pub(crate) fn hash_string(input: &str) -> String {
    let mut hasher = Sha256::new();
    hasher.update(input.as_bytes());
    let hash = hasher.finalize();

    hash.iter().fold(String::new(), |mut acc, byte| {
        write!(&mut acc, "{byte:02x}").unwrap();
        acc
    })
}

// Converts a version constraint string into a PEP 508-compatible py marker string
pub(crate) fn str_to_py_marker(s: &str) -> String {
    s.split(',')
        .map(str::trim)
        .filter_map(|s| {
            if s == "*" {
                None
            } else {
                let pos = s.find(|c: char| c.is_ascii_digit()).unwrap_or(s.len());
                let (op, ver) = s.split_at(pos);
                if ver.trim().is_empty() {
                    None
                } else {
                    Some(format!("python_version {} '{}'", op.trim(), ver.trim()))
                }
            }
        })
        .collect::<Vec<_>>()
        .join(" and ")
}

pub(crate) fn toml_to_py_marker(
    package: &TomlValue,
    py_version_key: &str,
) -> Vec<String> {
    if let Some(pyv) = package.get(py_version_key).and_then(|v| v.as_str()) {
        let marker = str_to_py_marker(pyv);
        if !marker.is_empty() {
            vec![marker]
        } else {
            Vec::with_capacity(0)
        }
    } else {
        Vec::with_capacity(0)
    }
}

// Helper to extract name and version from conda package filenames in Pixi lock files
pub(crate) fn conda_fn_to_name_version(filename: &str) -> Option<(String, String)> {
    let filename = filename.strip_suffix(".conda").unwrap_or(filename);
    let tokens: Vec<&str> = filename.split('-').collect();
    let version_index = tokens.iter().position(|token| {
        token
            .chars()
            .next()
            .map(|c| c.is_ascii_digit())
            .unwrap_or(false)
    })?;
    if version_index == 0 {
        return None;
    }
    let name = tokens[..version_index].join("-");
    let version = tokens[version_index].to_string();
    Some((name, version))
}

//------------------------------------------------------------------------------
#[cfg(test)]
mod tests {
    use super::*;
    use std::fs::File;
    use std::path::Component;

    use tempfile::tempdir;

    #[test]
    fn test_url_strip_user_a() {
        let s1 = "file:///localbuilds/pip-1.3.1-py33-none-any.whl".to_string();
        let s2 = url_strip_user(&s1);
        assert_eq!(s1, s2)
    }

    #[test]
    fn test_url_strip_user_b() {
        let s1 = "file://foo@/localbuilds/pip-1.3.1-py33-none-any.whl".to_string();
        let s2 = url_strip_user(&s1);
        assert_eq!(s2, "file:///localbuilds/pip-1.3.1-py33-none-any.whl")
    }

    #[test]
    fn test_url_strip_user_c() {
        let s1 = "https://github.com/pypa/pip/archive/1.3.1.zip#sha1=da9234ee9982d4bbb3c72346a6de940a148ea686".to_string();
        let s2 = url_strip_user(&s1);
        assert_eq!(s2, s1)
    }

    #[test]
    fn test_url_strip_user_d() {
        let s1 = "git+https://git.repo/some_pkg.git@1.3.1".to_string();
        let s2 = url_strip_user(&s1);
        assert_eq!(s2, s1)
    }

    #[test]
    fn test_url_strip_user_e() {
        let s1 = "git+ssh://git@github.com/uqfoundation/dill.git@0.3.8".to_string();
        let s2 = url_strip_user(&s1);
        assert_eq!(s2, "git+ssh://github.com/uqfoundation/dill.git@0.3.8")
    }

    #[test]
    fn test_url_strip_user_f() {
        let s1 = "git+https://foo@github.com/pypa/packaging.git@cf2cbe2aec28f87c6228a6fb136c27931c9af407".to_string();
        let s2 = url_strip_user(&s1);
        assert_eq!(s2, "git+https://github.com/pypa/packaging.git@cf2cbe2aec28f87c6228a6fb136c27931c9af407")
    }

    #[test]
    fn test_path_normalize_a() {
        let p1 = Path::new("~/foo/bar");
        let p2 = path_normalize(p1, false).unwrap();
        let home = path_home().unwrap();
        assert!(p2.starts_with(home));
    }

    #[test]
    fn test_path_cache_a() {
        let p1 = path_cache(false).unwrap();
        let result = p1.components().any(|component| match component {
            Component::Normal(name) => name == IO_FETTER,
            _ => false,
        });
        assert!(result);
    }

    #[test]
    fn test_path_within_duration_a() {
        let temp_dir = tempdir().unwrap();
        let fp = temp_dir.path().join("foo.txt");
        let _ = File::create(fp.clone()).unwrap();
        assert!(path_within_duration(&fp, Duration::from_secs(60)));
        assert!(!path_within_duration(&fp, Duration::from_nanos(1)));
    }

    #[test]
    fn test_is_python_exe_file_name_a() {
        let temp_dir = tempdir().unwrap();
        let fp = temp_dir.path().join("python3");
        assert!(is_python_exe_file_name(&fp));
    }

    #[test]
    fn test_is_python_exe_file_name_b() {
        let temp_dir = tempdir().unwrap();
        let fp = temp_dir.path().join("python--");
        assert!(!is_python_exe_file_name(&fp));
    }

    #[test]
    fn test_is_python_exe_file_name_c() {
        let temp_dir = tempdir().unwrap();
        let fp = temp_dir.path().join("python3.12.1000");
        assert!(is_python_exe_file_name(&fp));
    }

    #[test]
    fn test_path_is_component_a() {
        let fp = PathBuf::from("python3.12.1000");
        assert!(path_is_component(&fp));
    }

    #[test]
    fn test_path_is_component_b1() {
        let fp = PathBuf::from("/foo");
        assert!(!path_is_component(&fp));
    }

    #[test]
    fn test_path_is_component_b2() {
        let fp = PathBuf::from("/bin");
        assert!(!path_is_component(&fp));
    }

    #[test]
    fn test_path_is_component_c() {
        let fp = PathBuf::from("/foo/bar");
        assert!(!path_is_component(&fp));
    }

    #[test]
    fn test_hash_paths_a() {
        let paths = vec![
            Path::new("/a/foo/bar").to_path_buf(),
            Path::new("/b/foo/bar").to_path_buf(),
        ];
        let config = ScanConfig::new(true, true);
        let hashed = hash_paths(&paths, &config);
        assert_eq!(
            hashed,
            "83259d61ab78d5a4afb670e167bab74b0d1532878a45aa5c2848a8bb05f41903"
        )
    }

    #[test]
    fn test_hash_paths_b() {
        let paths = vec![Path::new("*").to_path_buf()];
        let config = ScanConfig::new(true, true);
        let hashed = hash_paths(&paths, &config);
        assert_eq!(
            hashed,
            "aa0a2150615aa2de8849dedd49f8fb9bb6114270c98bfbf4d117faf39b172720"
        )
    }
    //--------------------------------------------------------------------------
    #[test]
    fn test_get_absolute_path_from_exe_a() {
        let p = get_absolute_path_from_exe("python3");
        assert!(p.clone().unwrap().is_absolute());
        assert!(p.unwrap().ends_with("python3"));
    }

    #[test]
    fn test_conda_fn_to_name_version() {
        let filename = "_libgcc_mutex-0.1-conda_forge.tar.bz2";
        let parsed_filename = conda_fn_to_name_version(filename);

        assert_eq!(
            parsed_filename,
            Some(("_libgcc_mutex".to_string(), "0.1".to_string()))
        );
    }

    //--------------------------------------------------------------------------

    #[test]
    fn test_path_users() {
        let home = path_home().unwrap();
        let users = path_users().unwrap();

        assert_eq!(users, home.parent().map(|p| p.to_path_buf()).unwrap());
    }
}