use std::{io::Read, path::PathBuf};
use crate::{
store_impl::{file, file::log},
FullNameRef,
};
impl file::Store {
pub fn reflog_exists<'a, Name, E>(&self, name: Name) -> Result<bool, E>
where
Name: TryInto<&'a FullNameRef, Error = E>,
crate::name::Error: From<E>,
{
Ok(self.reflog_path(name.try_into()?).is_file())
}
pub fn reflog_iter_rev<'a, 'b, Name, E>(
&self,
name: Name,
buf: &'b mut [u8],
) -> Result<Option<log::iter::Reverse<'b, std::fs::File>>, Error>
where
Name: TryInto<&'a FullNameRef, Error = E>,
crate::name::Error: From<E>,
{
let name: &FullNameRef = name.try_into().map_err(|err| Error::RefnameValidation(err.into()))?;
let path = self.reflog_path(name);
if path.is_dir() {
return Ok(None);
}
match std::fs::File::open(&path) {
Ok(file) => Ok(Some(log::iter::reverse(file, buf)?)),
Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(None),
Err(err) => Err(err.into()),
}
}
pub fn reflog_iter<'a, 'b, Name, E>(
&self,
name: Name,
buf: &'b mut Vec<u8>,
) -> Result<Option<log::iter::Forward<'b>>, Error>
where
Name: TryInto<&'a FullNameRef, Error = E>,
crate::name::Error: From<E>,
{
let name: &FullNameRef = name.try_into().map_err(|err| Error::RefnameValidation(err.into()))?;
let path = self.reflog_path(name);
match std::fs::File::open(&path) {
Ok(mut file) => {
buf.clear();
if let Err(err) = file.read_to_end(buf) {
return if path.is_dir() { Ok(None) } else { Err(err.into()) };
}
Ok(Some(log::iter::forward(buf)))
}
Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(None),
#[cfg(windows)]
Err(err) if err.kind() == std::io::ErrorKind::PermissionDenied => Ok(None),
Err(err) => Err(err.into()),
}
}
}
impl file::Store {
pub(crate) fn reflog_path(&self, name: &FullNameRef) -> PathBuf {
let (base, rela_path) = self.reflog_base_and_relative_path(name);
base.join(rela_path)
}
}
#[allow(clippy::empty_docs)]
pub mod create_or_update {
use std::{
borrow::Cow,
io::Write,
path::{Path, PathBuf},
};
use gix_hash::{oid, ObjectId};
use gix_object::bstr::BStr;
use crate::store_impl::{file, file::WriteReflog};
impl file::Store {
#[allow(clippy::too_many_arguments)]
pub(crate) fn reflog_create_or_append(
&self,
name: &FullNameRef,
previous_oid: Option<ObjectId>,
new: &oid,
committer: Option<gix_actor::SignatureRef<'_>>,
message: &BStr,
mut force_create_reflog: bool,
) -> Result<(), Error> {
let (reflog_base, full_name) = self.reflog_base_and_relative_path(name);
match self.write_reflog {
WriteReflog::Normal | WriteReflog::Always => {
if self.write_reflog == WriteReflog::Always {
force_create_reflog = true;
}
let mut options = std::fs::OpenOptions::new();
options.append(true).read(false);
let log_path = reflog_base.join(&full_name);
if force_create_reflog || self.should_autocreate_reflog(&full_name) {
let parent_dir = log_path.parent().expect("always with parent directory");
gix_tempfile::create_dir::all(parent_dir, Default::default()).map_err(|err| {
Error::CreateLeadingDirectories {
source: err,
reflog_directory: parent_dir.to_owned(),
}
})?;
options.create(true);
};
let file_for_appending = match options.open(&log_path) {
Ok(f) => Some(f),
Err(err) if err.kind() == std::io::ErrorKind::NotFound => None,
Err(err) => {
if log_path.is_dir() {
gix_tempfile::remove_dir::empty_depth_first(log_path.clone())
.and_then(|_| options.open(&log_path))
.map(Some)
.map_err(|_| Error::Append {
source: err,
reflog_path: self.reflog_path(name),
})?
} else {
return Err(Error::Append {
source: err,
reflog_path: log_path,
});
}
}
};
if let Some(mut file) = file_for_appending {
let committer = committer.ok_or(Error::MissingCommitter)?;
write!(file, "{} {} ", previous_oid.unwrap_or_else(|| new.kind().null()), new)
.and_then(|_| committer.write_to(&mut file))
.and_then(|_| {
if !message.is_empty() {
writeln!(file, "\t{message}")
} else {
writeln!(file)
}
})
.map_err(|err| Error::Append {
source: err,
reflog_path: self.reflog_path(name),
})?;
}
Ok(())
}
WriteReflog::Disable => Ok(()),
}
}
fn should_autocreate_reflog(&self, full_name: &Path) -> bool {
full_name.starts_with("refs/heads/")
|| full_name.starts_with("refs/remotes/")
|| full_name.starts_with("refs/notes/")
|| full_name.starts_with("refs/worktree/") || full_name == Path::new("HEAD")
}
pub(in crate::store_impl::file) fn reflog_base_and_relative_path<'a>(
&self,
name: &'a FullNameRef,
) -> (PathBuf, Cow<'a, Path>) {
let is_reflog = true;
let (base, name) = self.to_base_dir_and_relative_name(name, is_reflog);
(
base.join("logs"),
match &self.namespace {
None => gix_path::to_native_path_on_windows(name.as_bstr()),
Some(namespace) => gix_path::to_native_path_on_windows(
namespace.to_owned().into_namespaced_name(name).into_inner(),
),
},
)
}
}
#[cfg(test)]
mod tests;
mod error {
use std::path::PathBuf;
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("Could create one or more directories in {reflog_directory:?} to contain reflog file")]
CreateLeadingDirectories {
source: std::io::Error,
reflog_directory: PathBuf,
},
#[error("Could not open reflog file at {reflog_path:?} for appending")]
Append {
source: std::io::Error,
reflog_path: PathBuf,
},
#[error("reflog message must not contain newlines")]
MessageWithNewlines,
#[error("reflog messages need a committer which isn't set")]
MissingCommitter,
}
}
pub use error::Error;
use crate::FullNameRef;
}
mod error {
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("The reflog name or path is not a valid ref name")]
RefnameValidation(#[from] crate::name::Error),
#[error("The reflog file could not read")]
Io(#[from] std::io::Error),
}
}
pub use error::Error;