helix/helix-vcs/src/git.rs

use anyhow::{bail, Context, Result};
use arc_swap::ArcSwap;
use gix::filter::plumbing::driver::apply::Delay;
use std::io::Read;
use std::path::Path;
use std::sync::Arc;

use gix::bstr::ByteSlice;
use gix::diff::Rewrites;
use gix::dir::entry::Status;
use gix::objs::tree::EntryKind;
use gix::sec::trust::DefaultForLevel;
use gix::status::{
    index_worktree::iter::Item,
    plumbing::index_as_worktree::{Change, EntryStatus},
    UntrackedFiles,
};
use gix::{Commit, ObjectId, Repository, ThreadSafeRepository};

use crate::{DiffProvider, FileChange};

#[cfg(test)]
mod test;

#[derive(Clone, Copy)]
pub struct Git;

impl Git {
    fn open_repo(path: &Path, ceiling_dir: Option<&Path>) -> Result<ThreadSafeRepository> {
        // custom open options
        let mut git_open_opts_map = gix::sec::trust::Mapping::<gix::open::Options>::default();

        // On windows various configuration options are bundled as part of the installations
        // This path depends on the install location of git and therefore requires some overhead to lookup
        // This is basically only used on windows and has some overhead hence it's disabled on other platforms.
        // `gitoxide` doesn't use this as default
        let config = gix::open::permissions::Config {
            system: true,
            git: true,
            user: true,
            env: true,
            includes: true,
            git_binary: cfg!(windows),
        };
        // change options for config permissions without touching anything else
        git_open_opts_map.reduced = git_open_opts_map
            .reduced
            .permissions(gix::open::Permissions {
                config,
                ..gix::open::Permissions::default_for_level(gix::sec::Trust::Reduced)
            });
        git_open_opts_map.full = git_open_opts_map.full.permissions(gix::open::Permissions {
            config,
            ..gix::open::Permissions::default_for_level(gix::sec::Trust::Full)
        });

        let open_options = gix::discover::upwards::Options {
            ceiling_dirs: ceiling_dir
                .map(|dir| vec![dir.to_owned()])
                .unwrap_or_default(),
            dot_git_only: true,
            ..Default::default()
        };

        let res = ThreadSafeRepository::discover_with_environment_overrides_opts(
            path,
            open_options,
            git_open_opts_map,
        )?;

        Ok(res)
    }

    /// Emulates the result of running `git status` from the command line.
    fn status(repo: &Repository, f: impl Fn(Result<FileChange>) -> bool) -> Result<()> {
        let work_dir = repo
            .work_dir()
            .ok_or_else(|| anyhow::anyhow!("working tree not found"))?
            .to_path_buf();

        let status_platform = repo
            .status(gix::progress::Discard)?
            // Here we discard the `status.showUntrackedFiles` config, as it makes little sense in
            // our case to not list new (untracked) files. We could have respected this config
            // if the default value weren't `Collapsed` though, as this default value would render
            // the feature unusable to many.
            .untracked_files(UntrackedFiles::Files)
            // Turn on file rename detection, which is off by default.
            .index_worktree_rewrites(Some(Rewrites {
                copies: None,
                percentage: Some(0.5),
                limit: 1000,
            }));

        // No filtering based on path
        let empty_patterns = vec![];

        let status_iter = status_platform.into_index_worktree_iter(empty_patterns)?;

        for item in status_iter {
            let Ok(item) = item.map_err(|err| f(Err(err.into()))) else {
                continue;
            };
            let change = match item {
                Item::Modification {
                    rela_path, status, ..
                } => {
                    let path = work_dir.join(rela_path.to_path()?);
                    match status {
                        EntryStatus::Conflict(_) => FileChange::Conflict { path },
                        EntryStatus::Change(Change::Removed) => FileChange::Deleted { path },
                        EntryStatus::Change(Change::Modification { .. }) => {
                            FileChange::Modified { path }
                        }
                        _ => continue,
                    }
                }
                Item::DirectoryContents { entry, .. } if entry.status == Status::Untracked => {
                    FileChange::Untracked {
                        path: work_dir.join(entry.rela_path.to_path()?),
                    }
                }
                Item::Rewrite {
                    source,
                    dirwalk_entry,
                    ..
                } => FileChange::Renamed {
                    from_path: work_dir.join(source.rela_path().to_path()?),
                    to_path: work_dir.join(dirwalk_entry.rela_path.to_path()?),
                },
                _ => continue,
            };
            if !f(Ok(change)) {
                break;
            }
        }

        Ok(())
    }
}

impl Git {
    pub fn get_diff_base(&self, file: &Path) -> Result<Vec<u8>> {
        debug_assert!(!file.exists() || file.is_file());
        debug_assert!(file.is_absolute());

        // TODO cache repository lookup

        let repo_dir = file.parent().context("file has no parent directory")?;
        let repo = Git::open_repo(repo_dir, None)
            .context("failed to open git repo")?
            .to_thread_local();
        let head = repo.head_commit()?;
        let file_oid = find_file_in_commit(&repo, &head, file)?;

        let file_object = repo.find_object(file_oid)?;
        let data = file_object.detach().data;
        // Get the actual data that git would make out of the git object.
        // This will apply the user's git config or attributes like crlf conversions.
        if let Some(work_dir) = repo.work_dir() {
            let rela_path = file.strip_prefix(work_dir)?;
            let rela_path = gix::path::try_into_bstr(rela_path)?;
            let (mut pipeline, _) = repo.filter_pipeline(None)?;
            let mut worktree_outcome =
                pipeline.convert_to_worktree(&data, rela_path.as_ref(), Delay::Forbid)?;
            let mut buf = Vec::with_capacity(data.len());
            worktree_outcome.read_to_end(&mut buf)?;
            Ok(buf)
        } else {
            Ok(data)
        }
    }

    pub fn get_current_head_name(&self, file: &Path) -> Result<Arc<ArcSwap<Box<str>>>> {
        debug_assert!(!file.exists() || file.is_file());
        debug_assert!(file.is_absolute());
        let repo_dir = file.parent().context("file has no parent directory")?;
        let repo = Git::open_repo(repo_dir, None)
            .context("failed to open git repo")?
            .to_thread_local();
        let head_ref = repo.head_ref()?;
        let head_commit = repo.head_commit()?;

        let name = match head_ref {
            Some(reference) => reference.name().shorten().to_string(),
            None => head_commit.id.to_hex_with_len(8).to_string(),
        };

        Ok(Arc::new(ArcSwap::from_pointee(name.into_boxed_str())))
    }

    pub fn for_each_changed_file(
        &self,
        cwd: &Path,
        f: impl Fn(Result<FileChange>) -> bool,
    ) -> Result<()> {
        Self::status(&Self::open_repo(cwd, None)?.to_thread_local(), f)
    }
}

impl From<Git> for DiffProvider {
    fn from(value: Git) -> Self {
        DiffProvider::Git(value)
    }
}

/// Finds the object that contains the contents of a file at a specific commit.
fn find_file_in_commit(repo: &Repository, commit: &Commit, file: &Path) -> Result<ObjectId> {
    let repo_dir = repo.work_dir().context("repo has no worktree")?;
    let rel_path = file.strip_prefix(repo_dir)?;
    let tree = commit.tree()?;
    let tree_entry = tree
        .lookup_entry_by_path(rel_path, &mut Vec::new())?
        .context("file is untracked")?;
    match tree_entry.mode().kind() {
        // not a file, everything is new, do not show diff
        mode @ (EntryKind::Tree | EntryKind::Commit | EntryKind::Link) => {
            bail!("entry at {} is not a file but a {mode:?}", file.display())
        }
        // found a file
        EntryKind::Blob | EntryKind::BlobExecutable => Ok(tree_entry.object_id()),
    }
}