1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
use std::{io::Read, path::Path};
use bstr::BStr;
use crate::{driver, eol, ident, pipeline::util::Configuration, worktree, Pipeline};
///
pub mod configuration {
use bstr::BString;
/// Errors related to the configuration of filter attributes.
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("The encoding named '{name}' isn't available")]
UnknownEncoding { name: BString },
#[error("Encodings must be names, like UTF-16, and cannot be booleans.")]
InvalidEncoding,
}
}
///
pub mod to_git {
/// A function that fills `buf` `fn(&mut buf)` with the data stored in the index of the file that should be converted.
pub type IndexObjectFn<'a> = dyn FnMut(&mut Vec<u8>) -> Result<Option<()>, gix_object::find::Error> + 'a;
/// The error returned by [Pipeline::convert_to_git()][super::Pipeline::convert_to_git()].
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error(transparent)]
Eol(#[from] crate::eol::convert_to_git::Error),
#[error(transparent)]
Worktree(#[from] crate::worktree::encode_to_git::Error),
#[error(transparent)]
Driver(#[from] crate::driver::apply::Error),
#[error(transparent)]
Configuration(#[from] super::configuration::Error),
#[error("Copy of driver process output to memory failed")]
ReadProcessOutputToBuffer(#[from] std::io::Error),
}
}
///
pub mod to_worktree {
/// The error returned by [Pipeline::convert_to_worktree()][super::Pipeline::convert_to_worktree()].
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error(transparent)]
Worktree(#[from] crate::worktree::encode_to_worktree::Error),
#[error(transparent)]
Driver(#[from] crate::driver::apply::Error),
#[error(transparent)]
Configuration(#[from] super::configuration::Error),
}
}
/// Access
impl Pipeline {
/// Convert a `src` stream (to be found at `rela_path`) to a representation suitable for storage in `git`
/// based on the `attributes` at `rela_path` which is passed as first argument..
/// When converting to `crlf`, and depending on the configuration, `index_object` might be called to obtain the index
/// version of `src` if available. It can return `Ok(None)` if this information isn't available.
pub fn convert_to_git<R>(
&mut self,
mut src: R,
rela_path: &Path,
attributes: &mut dyn FnMut(&BStr, &mut gix_attributes::search::Outcome),
index_object: &mut to_git::IndexObjectFn<'_>,
) -> Result<ToGitOutcome<'_, R>, to_git::Error>
where
R: std::io::Read,
{
let bstr_path = gix_path::into_bstr(rela_path);
let Configuration {
driver,
digest,
_attr_digest: _,
encoding,
apply_ident_filter,
} = Configuration::at_path(
bstr_path.as_ref(),
&self.options.drivers,
&mut self.attrs,
attributes,
self.options.eol_config,
)?;
let mut in_buffer = false;
// this is just an approximation, but it's as good as it gets without reading the actual input.
let would_convert_eol = eol::convert_to_git(
b"\r\n",
digest,
&mut self.bufs.dest,
&mut |_| Ok(None),
eol::convert_to_git::Options {
round_trip_check: None,
config: self.options.eol_config,
},
)?;
if let Some(driver) = driver {
if let Some(mut read) = self.processes.apply(
driver,
&mut src,
driver::Operation::Clean,
self.context.with_path(bstr_path.as_ref()),
)? {
if !apply_ident_filter && encoding.is_none() && !would_convert_eol {
// Note that this is not typically a benefit in terms of saving memory as most filters
// aren't expected to make the output file larger. It's more about who is waiting for the filter's
// output to arrive, which won't be us now. For `git-lfs` it definitely won't matter though.
return Ok(ToGitOutcome::Process(read));
}
self.bufs.clear();
read.read_to_end(&mut self.bufs.src)?;
in_buffer = true;
}
}
if !in_buffer && (apply_ident_filter || encoding.is_some() || would_convert_eol) {
self.bufs.clear();
src.read_to_end(&mut self.bufs.src)?;
in_buffer = true;
}
if let Some(encoding) = encoding {
worktree::encode_to_git(
&self.bufs.src,
encoding,
&mut self.bufs.dest,
if self.options.encodings_with_roundtrip_check.contains(&encoding) {
worktree::encode_to_git::RoundTripCheck::Fail
} else {
worktree::encode_to_git::RoundTripCheck::Skip
},
)?;
self.bufs.swap();
}
if eol::convert_to_git(
&self.bufs.src,
digest,
&mut self.bufs.dest,
&mut |buf| index_object(buf),
eol::convert_to_git::Options {
round_trip_check: self.options.crlf_roundtrip_check.to_eol_roundtrip_check(rela_path),
config: self.options.eol_config,
},
)? {
self.bufs.swap();
}
if apply_ident_filter && ident::undo(&self.bufs.src, &mut self.bufs.dest) {
self.bufs.swap();
}
Ok(if in_buffer {
ToGitOutcome::Buffer(&self.bufs.src)
} else {
ToGitOutcome::Unchanged(src)
})
}
/// Convert a `src` buffer located at `rela_path` (in the index) from what's in `git` to the worktree representation,
/// asking for `attributes` with `rela_path` as first argument to configure the operation automatically.
/// `can_delay` defines if long-running processes can delay their response, and if they *choose* to the caller has to
/// specifically deal with it by interacting with the [`driver_state`][Pipeline::driver_state_mut()] directly.
///
/// The reason `src` is a buffer is to indicate that `git` generally doesn't do well streaming data, so it should be small enough
/// to be performant while being held in memory. This is typically the case, especially if `git-lfs` is used as intended.
pub fn convert_to_worktree<'input>(
&mut self,
src: &'input [u8],
rela_path: &BStr,
attributes: &mut dyn FnMut(&BStr, &mut gix_attributes::search::Outcome),
can_delay: driver::apply::Delay,
) -> Result<ToWorktreeOutcome<'input, '_>, to_worktree::Error> {
let Configuration {
driver,
digest,
_attr_digest: _,
encoding,
apply_ident_filter,
} = Configuration::at_path(
rela_path,
&self.options.drivers,
&mut self.attrs,
attributes,
self.options.eol_config,
)?;
let mut bufs = self.bufs.use_foreign_src(src);
let (src, dest) = bufs.src_and_dest();
if apply_ident_filter && ident::apply(src, self.options.object_hash, dest) {
bufs.swap();
}
let (src, dest) = bufs.src_and_dest();
if eol::convert_to_worktree(src, digest, dest, self.options.eol_config) {
bufs.swap();
};
if let Some(encoding) = encoding {
let (src, dest) = bufs.src_and_dest();
worktree::encode_to_worktree(src, encoding, dest)?;
bufs.swap();
}
if let Some(driver) = driver {
let (mut src, _dest) = bufs.src_and_dest();
if let Some(maybe_delayed) = self.processes.apply_delayed(
driver,
&mut src,
driver::Operation::Smudge,
can_delay,
self.context.with_path(rela_path),
)? {
return Ok(ToWorktreeOutcome::Process(maybe_delayed));
}
}
Ok(match bufs.ro_src {
Some(src) => ToWorktreeOutcome::Unchanged(src),
None => ToWorktreeOutcome::Buffer(bufs.src),
})
}
}
/// The result of a conversion with zero or more filters to be stored in git.
pub enum ToGitOutcome<'pipeline, R> {
/// The original input wasn't changed and the reader is still available for consumption.
Unchanged(R),
/// An external filter (and only that) was applied and its results *have to be consumed*.
Process(Box<dyn std::io::Read + 'pipeline>),
/// A reference to the result of one or more filters of which one didn't support streaming.
///
/// This can happen if an `eol`, `working-tree-encoding` or `ident` filter is applied, possibly on top of an external filter.
Buffer(&'pipeline [u8]),
}
/// The result of a conversion with zero or more filters.
///
/// ### Panics
///
/// If `std::io::Read` is used on it and the output is delayed, a panic will occur. The caller is responsible for either disallowing delayed
/// results or if allowed, handle them. Use [`is_delayed()][Self::is_delayed()].
pub enum ToWorktreeOutcome<'input, 'pipeline> {
/// The original input wasn't changed and the original buffer is present
Unchanged(&'input [u8]),
/// A reference to the result of one or more filters of which one didn't support streaming.
///
/// This can happen if an `eol`, `working-tree-encoding` or `ident` filter is applied, possibly on top of an external filter.
Buffer(&'pipeline [u8]),
/// An external filter (and only that) was applied and its results *have to be consumed*. Note that the output might be delayed,
/// which requires special handling to eventually receive it.
Process(driver::apply::MaybeDelayed<'pipeline>),
}
impl<'input, 'pipeline> ToWorktreeOutcome<'input, 'pipeline> {
/// Return true if this outcome is delayed. In that case, one isn't allowed to use [`Read`] or cause a panic.
pub fn is_delayed(&self) -> bool {
matches!(
self,
ToWorktreeOutcome::Process(driver::apply::MaybeDelayed::Delayed(_))
)
}
/// Returns `true` if the input buffer was actually changed, or `false` if it is returned directly.
pub fn is_changed(&self) -> bool {
!matches!(self, ToWorktreeOutcome::Unchanged(_))
}
/// Return a buffer if we contain one, or `None` otherwise.
///
/// This method is useful only if it's clear that no driver is available, which may cause a stream to be returned and not a buffer.
pub fn as_bytes(&self) -> Option<&[u8]> {
match self {
ToWorktreeOutcome::Unchanged(b) | ToWorktreeOutcome::Buffer(b) => Some(b),
ToWorktreeOutcome::Process(_) => None,
}
}
/// Return a stream to read the drivers output from, if possible.
///
/// Note that this is only the case if the driver process was applied last *and* didn't delay its output.
pub fn as_read(&mut self) -> Option<&mut (dyn std::io::Read + '_)> {
match self {
ToWorktreeOutcome::Process(driver::apply::MaybeDelayed::Delayed(_))
| ToWorktreeOutcome::Unchanged(_)
| ToWorktreeOutcome::Buffer(_) => None,
ToWorktreeOutcome::Process(driver::apply::MaybeDelayed::Immediate(read)) => Some(read),
}
}
}
impl<'input, 'pipeline> std::io::Read for ToWorktreeOutcome<'input, 'pipeline> {
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
match self {
ToWorktreeOutcome::Unchanged(b) => b.read(buf),
ToWorktreeOutcome::Buffer(b) => b.read(buf),
ToWorktreeOutcome::Process(driver::apply::MaybeDelayed::Delayed(_)) => {
panic!("BUG: must not try to read delayed output")
}
ToWorktreeOutcome::Process(driver::apply::MaybeDelayed::Immediate(r)) => r.read(buf),
}
}
}
impl<'pipeline, R> std::io::Read for ToGitOutcome<'pipeline, R>
where
R: std::io::Read,
{
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
match self {
ToGitOutcome::Unchanged(r) => r.read(buf),
ToGitOutcome::Process(r) => r.read(buf),
ToGitOutcome::Buffer(r) => r.read(buf),
}
}
}
impl<'a, R> ToGitOutcome<'a, R>
where
R: std::io::Read,
{
/// If we contain a buffer, and not a stream, return it.
pub fn as_bytes(&self) -> Option<&'a [u8]> {
match self {
ToGitOutcome::Unchanged(_) | ToGitOutcome::Process(_) => None,
ToGitOutcome::Buffer(b) => Some(b),
}
}
/// Return a stream to read the drivers output from. This is only possible if there is only a driver, and no other filter.
pub fn as_read(&mut self) -> Option<&mut (dyn std::io::Read + '_)> {
match self {
ToGitOutcome::Process(read) => Some(read),
ToGitOutcome::Unchanged(read) => Some(read),
ToGitOutcome::Buffer(_) => None,
}
}
/// Returns `true` if the input buffer was actually changed, or `false` if it is returned directly.
pub fn is_changed(&self) -> bool {
!matches!(self, ToGitOutcome::Unchanged(_))
}
}