zsh 0.8.13

//! The classes responsible for autoloading functions and completions.

use crate::{
    env::Environment,
    flogf,
    io::IoChain,
    parser::Parser,
    wutil::{file_id_for_path, FileId, INVALID_FILE_ID},
};
use fish_common::{escape, ScopeGuard};
use fish_widestring::{wcs2bytes, wstr, WExt as _, WString, L};
use lru::LruCache;
use rust_embed::RustEmbed;
use std::collections::{HashMap, HashSet};
use std::num::NonZeroUsize;
use std::time;

/// autoload_t is a class that knows how to autoload .fish files from a list of directories. This
/// is used by autoloading functions and completions. It maintains a file cache, which is
/// responsible for potentially cached accesses of files, and then a list of files that have
/// actually been autoloaded. A client may request a file to autoload given a command name, and may
/// be returned a path which it is expected to source.
/// autoload_t does not have any internal locks; it is the responsibility of the caller to lock
/// it.
#[derive(Default)]
pub struct Autoload {
    /// The environment variable whose paths we observe.
    env_var_name: &'static wstr,

    /// A map from command to the files we have autoloaded.
    autoloaded_files: HashMap<WString, FileId>,

    /// The list of commands that we are currently autoloading.
    current_autoloading: HashSet<WString>,

    /// The autoload cache.
    cache: AutoloadFileCache,
}

#[derive(RustEmbed)]
#[folder = "share"]
#[exclude = "__fish_build_paths.fish.in"]
pub struct Asset;

pub fn has_asset(cmd: &str) -> bool {
    Asset::get(cmd).is_some()
}

#[derive(Clone, Copy, Eq, PartialEq)]
enum AssetDir {
    Functions,
    Completions,
}

#[derive(Debug)]
pub enum AutoloadPath {
    Embedded(String),
    Path(WString),
}

#[derive(Debug)]
pub enum AutoloadResult {
    Path(AutoloadPath),
    Loaded,
    Pending,
    None,
}

#[cfg(test)]
impl AutoloadResult {
    fn is_none(&self) -> bool {
        matches!(self, AutoloadResult::None)
    }
    fn is_some(&self) -> bool {
        !self.is_none()
    }
}

impl Autoload {
    /// Construct an autoloader that loads from the paths given by `env_var_name`.
    pub fn new(env_var_name: &'static wstr) -> Self {
        Self {
            env_var_name,
            ..Default::default()
        }
    }

    /// Given a command, get a path to autoload.
    /// For example, if the environment variable is 'fish_function_path' and the command is 'foo',
    /// this will look for a file 'foo.fish' in one of the directories given by fish_function_path.
    /// If there is no such file, OR if the file has been previously resolved and is now unchanged,
    /// this will return none. But if the file is either new or changed, this will return the path.
    /// After returning a path, the command is marked in-progress until the caller calls
    /// mark_autoload_finished() with the same command. Note this does not actually execute any
    /// code; it is the caller's responsibility to load the file.
    pub fn resolve_command(&mut self, cmd: &wstr, env: &dyn Environment) -> AutoloadResult {
        let result = self.resolve_command_impl(
            cmd,
            env.get(self.env_var_name)
                .as_ref()
                .map(|var| var.as_list())
                .unwrap_or_default(),
        );
        match result {
            AutoloadResult::Path(AutoloadPath::Embedded(_)) => {
                flogf!(autoload, "Embedded: %s", cmd);
            }
            AutoloadResult::Path(AutoloadPath::Path(ref path)) => {
                flogf!(
                    autoload,
                    "Loading %s from var %s from path %s",
                    cmd,
                    self.env_var_name,
                    path
                );
            }
            AutoloadResult::Loaded | AutoloadResult::Pending | AutoloadResult::None => {}
        }
        result
    }

    /// Helper to actually perform an autoload.
    /// This is a static function because it executes fish script, and so must be called without
    /// holding any particular locks.
    pub fn perform_autoload(path: &AutoloadPath, parser: &Parser) {
        // We do the useful part of what exec_subshell does ourselves
        // - we source the file.
        // We don't create a buffer or check ifs or create a read_limit
        let prev_statuses = parser.get_last_statuses();
        let _put_back = ScopeGuard::new((), |()| parser.set_last_statuses(prev_statuses));
        match path {
            AutoloadPath::Path(p) => {
                let script_source = L!("source ").to_owned() + &escape(p)[..];
                parser.eval(&script_source, &IoChain::new());
            }
            AutoloadPath::Embedded(name) => {
                use fish_widestring::bytes2wcstring;
                use std::sync::Arc;
                flogf!(autoload, "Loading embedded: %s", name);
                let emfile = Asset::get(name).expect("Embedded file not found");
                let src = bytes2wcstring(&emfile.data);
                let mut widename = L!("embedded:").to_owned();
                widename.push_str(name);
                let ret = parser.eval_file_wstr(src, Arc::new(widename), &IoChain::new(), None);
                if let Err(msg) = ret {
                    eprintf!("%s", msg);
                }
            }
        }
    }

    /// Mark that a command previously returned from path_to_autoload is finished autoloading.
    pub fn mark_autoload_finished(&mut self, cmd: &wstr) {
        let removed = self.current_autoloading.remove(cmd);
        assert!(removed, "cmd was not being autoloaded");
    }

    /// Return whether a command is currently being autoloaded.
    pub fn autoload_in_progress(&self, cmd: &wstr) -> bool {
        self.current_autoloading.contains(cmd)
    }

    /// Return whether a command could potentially be autoloaded.
    /// This does not actually mark the command as being autoloaded.
    pub fn can_autoload(&mut self, cmd: &wstr) -> bool {
        self.cache
            .check(self.env_var_name, cmd, true /* allow stale */)
            .is_some()
    }

    /// Return whether autoloading has been attempted for a command.
    pub fn has_attempted_autoload(&self, cmd: &wstr) -> bool {
        self.cache.is_cached(cmd)
    }

    /// Return the names of all commands that have been autoloaded. Note this includes "in-flight"
    /// commands.
    pub fn get_autoloaded_commands(&self) -> Vec<WString> {
        let mut result = Vec::with_capacity(self.autoloaded_files.len());
        for k in self.autoloaded_files.keys() {
            result.push(k.to_owned());
        }
        // Sort the output to make it easier to test.
        result.sort();
        result
    }

    /// Mark that all autoloaded files have been forgotten.
    /// Future calls to path_to_autoload() will return previously-returned paths.
    pub fn clear(&mut self) {
        // Note there is no reason to invalidate the cache here.
        self.autoloaded_files.clear();
    }

    /// Invalidate any underlying cache.
    #[cfg(test)]
    fn invalidate_cache(&mut self) {
        self.cache = AutoloadFileCache::with_dirs(self.cache.dirs().to_owned());
    }

    /// Like resolve_autoload(), but accepts the paths directly.
    /// This is exposed for testing.
    fn resolve_command_impl(&mut self, cmd: &wstr, paths: &[WString]) -> AutoloadResult {
        // Are we currently in the process of autoloading this?
        if self.current_autoloading.contains(cmd) {
            return AutoloadResult::Pending;
        }

        // Check to see if our paths have changed. If so, replace our cache.
        // Note we don't have to modify autoloadable_files_. We'll naturally detect if those have
        // changed when we query the cache.
        if paths != self.cache.dirs() {
            self.cache = AutoloadFileCache::with_dirs(paths.to_owned());
        }

        // Do we have an entry to load?
        let Some(file) = self.cache.check(self.env_var_name, cmd, false) else {
            return AutoloadResult::None;
        };

        let file_id = match &file {
            AutoloadableFileInfo::FileInfo(file) => &file.file_id,
            AutoloadableFileInfo::EmbeddedPath(_) => &INVALID_FILE_ID,
        };

        // Is this file the same as what we previously autoloaded?
        if let Some(loaded_file) = self.autoloaded_files.get(cmd) {
            if *loaded_file == *file_id {
                // The file has been autoloaded and is unchanged.
                return AutoloadResult::Loaded;
            }
        }

        // We're going to (tell our caller to) autoload this command.
        self.current_autoloading.insert(cmd.to_owned());
        self.autoloaded_files
            .insert(cmd.to_owned(), file_id.clone());
        AutoloadResult::Path(match file {
            AutoloadableFileInfo::FileInfo(path) => AutoloadPath::Path(path.path),
            AutoloadableFileInfo::EmbeddedPath(path) => AutoloadPath::Embedded(path),
        })
    }
}

/// The time before we'll recheck an autoloaded file.
const AUTOLOAD_STALENESS_INTERVALL: u64 = 15;

/// Represents a file that we might want to autoload.
#[derive(Clone)]
struct FileInfo {
    /// The path to the file.
    path: WString,
    /// The metadata for the file.
    file_id: FileId,
}

#[derive(Clone)]
enum AutoloadableFileInfo {
    /// An on-disk file.
    FileInfo(FileInfo),
    /// An embedded file.
    EmbeddedPath(String),
}

// A timestamp is a monotonic point in time.
type Timestamp = time::Instant;
type MissesLruCache = LruCache<WString, Timestamp>;

struct KnownFile {
    file: AutoloadableFileInfo,
    last_checked: Timestamp,
}

/// Class representing a cache of files that may be autoloaded.
/// This is responsible for performing cached accesses to a set of paths.
struct AutoloadFileCache {
    /// The directories from which to load.
    dirs: Vec<WString>,

    /// Our LRU cache of checks that were misses.
    /// The key is the command, the  value is the time of the check.
    misses_cache: MissesLruCache,

    /// The set of files that we have returned to the caller, along with the time of the check.
    /// The key is the command (not the path).
    known_files: HashMap<WString, KnownFile>,
}

impl Default for AutoloadFileCache {
    fn default() -> Self {
        Self::new()
    }
}

impl AutoloadFileCache {
    /// Initialize with a set of directories.
    fn with_dirs(dirs: Vec<WString>) -> Self {
        Self {
            dirs,
            misses_cache: MissesLruCache::new(NonZeroUsize::new(1024).unwrap()),
            known_files: HashMap::new(),
        }
    }

    /// Initialize with empty directories.
    fn new() -> Self {
        Self::with_dirs(vec![])
    }

    /// Return the directories.
    fn dirs(&self) -> &[WString] {
        &self.dirs
    }

    /// Check if a command `cmd` can be loaded.
    /// If `allow_stale` is true, allow stale entries; otherwise discard them.
    /// This returns an autoloadable file, or none() if there is no such file.
    fn check(
        &mut self,
        env_var_name: &wstr,
        cmd: &wstr,
        allow_stale: bool,
    ) -> Option<AutoloadableFileInfo> {
        let asset_dir = match env_var_name {
            s if s == "fish_function_path" => Some(AssetDir::Functions),
            s if s == "fish_complete_path" => Some(AssetDir::Completions),
            _ => None,
        };

        // Check hits.
        if let Some(value) = self.known_files.get(cmd) {
            let embedded = matches!(value.file, AutoloadableFileInfo::EmbeddedPath(_));
            if allow_stale
                || embedded
                || Self::is_fresh(value.last_checked, Self::current_timestamp())
            {
                // Re-use this cached hit.
                return Some(value.file.clone());
            }
            // The file is stale, remove it.
            self.known_files.remove(cmd);
        }

        // Check misses.
        if let Some(miss) = self.misses_cache.get(cmd) {
            if allow_stale || Self::is_fresh(*miss, Self::current_timestamp()) {
                // Re-use this cached miss.
                return None;
            }
            // The miss is stale, remove it.
            self.misses_cache.pop(cmd);
        }

        // We couldn't satisfy this request from the cache. Hit the disk.
        let file = self
            .locate_file(cmd, asset_dir, false)
            .or_else(|| self.locate_asset(cmd, asset_dir?))
            .or_else(|| self.locate_file(cmd, asset_dir, true));
        if let Some(file) = file.as_ref() {
            let old_value = self.known_files.insert(
                cmd.to_owned(),
                KnownFile {
                    file: file.clone(),
                    last_checked: Self::current_timestamp(),
                },
            );
            assert!(
                old_value.is_none(),
                "Known files cache should not have contained this cmd"
            );
        } else {
            let old_value = self
                .misses_cache
                .put(cmd.to_owned(), Self::current_timestamp());
            assert!(
                old_value.is_none(),
                "Misses cache should not have contained this cmd",
            );
        }
        file
    }

    /// Return true if a command is cached (either as a hit or miss).
    fn is_cached(&self, cmd: &wstr) -> bool {
        self.known_files.contains_key(cmd) || self.misses_cache.contains(cmd)
    }

    /// Return the current timestamp.
    fn current_timestamp() -> Timestamp {
        Timestamp::now()
    }

    /// Return whether a timestamp is fresh enough to use.
    fn is_fresh(then: Timestamp, now: Timestamp) -> bool {
        let seconds = now.duration_since(then).as_secs();
        seconds < AUTOLOAD_STALENESS_INTERVALL
    }

    /// Attempt to find an autoloadable file by searching our path list for a given command.
    /// Return the file, or none() if none.
    fn locate_file(
        &self,
        cmd: &wstr,
        asset_dir: Option<AssetDir>,
        want_generated_completions: bool,
    ) -> Option<AutoloadableFileInfo> {
        // If the command is empty or starts with NULL (i.e. is empty as a path)
        // we'd try to source the *directory*, which exists.
        // So instead ignore these here.
        if cmd.is_empty() {
            return None;
        }
        if cmd.as_char_slice()[0] == '\0' {
            return None;
        }
        // Re-use the storage for path.
        let mut path;
        for dir in self.dirs() {
            if asset_dir == Some(AssetDir::Completions) {
                // HACK: Ignore generated_completions until we tried the embedded assets
                if dir.ends_with(L!("/generated_completions")) != want_generated_completions {
                    continue;
                }
            }
            // Construct the path as dir/cmd.fish
            path = dir.to_owned();
            path.push('/');
            path.push_utfstr(cmd);
            path.push_str(".fish");

            let file_id = file_id_for_path(&path);
            if file_id != INVALID_FILE_ID {
                // Found it.
                return Some(AutoloadableFileInfo::FileInfo(FileInfo { path, file_id }));
            }
        }
        None
    }

    fn locate_asset(&self, cmd: &wstr, asset_dir: AssetDir) -> Option<AutoloadableFileInfo> {
        // HACK: In cargo tests, this used to never load functions
        // It will hang for reasons unrelated to this.
        if cfg!(test) {
            return None;
        }
        let narrow = wcs2bytes(cmd);
        let cmdstr = std::str::from_utf8(&narrow).ok()?;
        let p = match asset_dir {
            AssetDir::Functions => "functions/".to_owned() + cmdstr + ".fish",
            AssetDir::Completions => "completions/".to_owned() + cmdstr + ".fish",
        };
        has_asset(&p).then_some(AutoloadableFileInfo::EmbeddedPath(p))
    }
}

#[cfg(test)]
mod tests {
    use super::{Autoload, AutoloadResult};
    use crate::prelude::*;
    use crate::tests::prelude::*;
    use assert_matches::assert_matches;

    #[test]
    #[serial]
    fn test_autoload() {
        let _cleanup = test_init();
        use crate::fds::wopen_cloexec;
        use fish_widestring::wcs2zstring;
        use nix::fcntl::OFlag;

        macro_rules! run {
            ( $fmt:expr $(, $arg:expr )* $(,)? ) => {
                let cmd = wcs2zstring(&sprintf!($fmt $(, $arg)*));
                let status = unsafe { libc::system(cmd.as_ptr()) };
                assert_eq!(status, 0);
            };
        }

        fn touch_file(path: &wstr) {
            use nix::sys::stat::Mode;
            use std::io::Write as _;

            let mut file = wopen_cloexec(
                path,
                OFlag::O_RDWR | OFlag::O_CREAT,
                Mode::from_bits_truncate(0o666),
            )
            .unwrap();
            file.write_all(b"Hello").unwrap();
        }

        let p1 = fish_tempfile::new_dir().unwrap();
        let p1 = WString::from(p1.path().to_str().unwrap());
        let p2 = fish_tempfile::new_dir().unwrap();
        let p2 = WString::from(p2.path().to_str().unwrap());

        let paths = &[p1.clone(), p2.clone()];
        let mut autoload = Autoload::new(L!("test_var"));
        assert!(autoload.resolve_command_impl(L!("file1"), paths).is_none());
        assert!(autoload
            .resolve_command_impl(L!("nothing"), paths)
            .is_none());
        assert!(autoload.get_autoloaded_commands().is_empty());

        run!("touch %s/file1.fish", p1);
        run!("touch %s/file2.fish", p2);
        autoload.invalidate_cache();

        assert!(!autoload.autoload_in_progress(L!("file1")));
        assert_matches!(
            autoload.resolve_command_impl(L!("file1"), paths),
            AutoloadResult::Path(_)
        );
        assert_matches!(
            autoload.resolve_command_impl(L!("file1"), paths),
            AutoloadResult::Pending
        );
        assert!(autoload.autoload_in_progress(L!("file1")));
        assert_eq!(autoload.get_autoloaded_commands(), vec![L!("file1")]);
        autoload.mark_autoload_finished(L!("file1"));
        assert!(!autoload.autoload_in_progress(L!("file1")));
        assert_eq!(autoload.get_autoloaded_commands(), vec![L!("file1")]);

        assert_matches!(
            autoload.resolve_command_impl(L!("file1"), paths),
            AutoloadResult::Loaded
        );
        assert!(autoload
            .resolve_command_impl(L!("nothing"), paths)
            .is_none());
        assert!(autoload.resolve_command_impl(L!("file2"), paths).is_some());
        assert_matches!(
            autoload.resolve_command_impl(L!("file2"), paths),
            AutoloadResult::Pending
        );
        autoload.mark_autoload_finished(L!("file2"));
        assert_matches!(
            autoload.resolve_command_impl(L!("file2"), paths),
            AutoloadResult::Loaded
        );
        assert_eq!(
            autoload.get_autoloaded_commands(),
            vec![L!("file1"), L!("file2")]
        );

        autoload.clear();
        assert!(autoload.resolve_command_impl(L!("file1"), paths).is_some());
        autoload.mark_autoload_finished(L!("file1"));
        assert_matches!(
            autoload.resolve_command_impl(L!("file1"), paths),
            AutoloadResult::Loaded
        );
        assert!(autoload
            .resolve_command_impl(L!("nothing"), paths)
            .is_none());
        assert!(autoload.resolve_command_impl(L!("file2"), paths).is_some());
        assert_matches!(
            autoload.resolve_command_impl(L!("file2"), paths),
            AutoloadResult::Pending
        );
        autoload.mark_autoload_finished(L!("file2"));

        assert_matches!(
            autoload.resolve_command_impl(L!("file1"), paths),
            AutoloadResult::Loaded
        );
        touch_file(&sprintf!("%s/file1.fish", p1));
        autoload.invalidate_cache();
        assert!(autoload.resolve_command_impl(L!("file1"), paths).is_some());
        autoload.mark_autoload_finished(L!("file1"));
    }
}