use crate::{ file::{self, File}, GENERATION_NUMBER_INFINITY, GENERATION_NUMBER_MAX, }; use bstr::ByteSlice; use git_object::{borrowed, owned, SHA1_SIZE}; use std::{ cmp::{max, min}, collections::HashMap, convert::TryFrom, path::Path, }; #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] Commit(#[from] file::commit::Error), #[error("commit at file position {pos} has invalid ID {id}")] CommitId { id: owned::Id, pos: file::Position }, #[error("commit at file position {pos} with ID {id} is out of order relative to its predecessor with ID {predecessor_id}")] CommitsOutOfOrder { id: owned::Id, pos: file::Position, predecessor_id: owned::Id, }, #[error("commit-graph filename should be {0}")] Filename(String), #[error("commit {id} has invalid generation {generation}")] Generation { generation: u32, id: owned::Id }, #[error("checksum mismatch: expected {expected}, got {actual}")] Mismatch { actual: owned::Id, expected: owned::Id }, #[error("{0}")] Processor(#[source] E), #[error("commit {id} has invalid root tree ID {root_tree_id}")] RootTreeId { id: owned::Id, root_tree_id: owned::Id }, } #[derive(Clone, Debug, Eq, PartialEq)] #[cfg_attr(feature = "serde1", derive(serde::Deserialize, serde::Serialize))] pub struct Outcome { pub max_generation: u32, pub max_parents: u32, pub min_generation: u32, pub num_commits: u32, pub parent_counts: HashMap, } impl File { pub fn checksum(&self) -> borrowed::Id<'_> { borrowed::Id::try_from(&self.data[self.data.len() - SHA1_SIZE..]).expect("file to be large enough for a hash") } pub fn traverse<'a, E, Processor>(&'a self, mut processor: Processor) -> Result> where E: std::error::Error + 'static, Processor: FnMut(&file::Commit<'a>) -> Result<(), E>, { self.verify_checksum() .map_err(|(actual, expected)| Error::Mismatch { actual, expected })?; verify_split_chain_filename_hash(&self.path, self.checksum()).map_err(Error::Filename)?; let null_id = borrowed::Id::null_sha1(); let mut stats = Outcome { max_generation: 0, max_parents: 0, min_generation: GENERATION_NUMBER_INFINITY, num_commits: self.num_commits(), parent_counts: HashMap::new(), }; // TODO: Verify self.fan values as we go. let mut prev_id: borrowed::Id<'a> = null_id; for commit in self.iter_commits() { if commit.id() <= prev_id { if commit.id() == null_id { return Err(Error::CommitId { pos: commit.position(), id: commit.id().into(), }); } return Err(Error::CommitsOutOfOrder { pos: commit.position(), id: commit.id().into(), predecessor_id: prev_id.into(), }); } if commit.root_tree_id() == null_id { return Err(Error::RootTreeId { id: commit.id().into(), root_tree_id: commit.root_tree_id().into(), }); } if commit.generation() > GENERATION_NUMBER_MAX { return Err(Error::Generation { generation: commit.generation(), id: commit.id().into(), }); } processor(&commit).map_err(Error::Processor)?; stats.max_generation = max(stats.max_generation, commit.generation()); stats.min_generation = min(stats.min_generation, commit.generation()); let parent_count = commit .iter_parents() .try_fold(0u32, |acc, pos| pos.map(|_| acc + 1)) .map_err(Error::Commit)?; *stats.parent_counts.entry(parent_count).or_insert(0) += 1; prev_id = commit.id(); } if stats.min_generation == GENERATION_NUMBER_INFINITY { stats.min_generation = 0; } Ok(stats) } pub fn verify_checksum(&self) -> Result { // Even though we could use git_features::hash::bytes_of_file(…), this would require using our own // Error type to support io::Error and Mismatch. As we only gain progress, there probably isn't much value // as these files are usually small enough to process them in less than a second, even for the large ones. // But it's possible, once a progress instance is passed. let data_len_without_trailer = self.data.len() - SHA1_SIZE; let mut hasher = git_features::hash::Sha1::default(); hasher.update(&self.data[..data_len_without_trailer]); let actual = owned::Id::new_sha1(hasher.digest()); let expected = self.checksum(); if actual.to_borrowed() == expected { Ok(actual) } else { Err((actual, expected.into())) } } } /// If the given path's filename matches "graph-{hash}.graph", check that `hash` matches the /// expected hash. fn verify_split_chain_filename_hash(path: impl AsRef, expected: borrowed::Id<'_>) -> Result<(), String> { let path = path.as_ref(); path.file_name() .and_then(|filename| filename.to_str()) .and_then(|filename| filename.strip_suffix(".graph")) .and_then(|stem| stem.strip_prefix("graph-")) .map_or(Ok(()), |hex| match owned::Id::from_40_bytes_in_hex(hex.as_bytes()) { Ok(actual) if actual.to_borrowed() == expected => Ok(()), _ => Err(format!("graph-{}.graph", expected.to_sha1_hex().as_bstr())), }) }