|
1 | | -use std::marker; |
| 1 | +use std::ffi::CStr; |
| 2 | +use std::mem::MaybeUninit; |
| 3 | +use std::path::Path; |
| 4 | +use std::{io, marker, mem, ptr}; |
2 | 5 |
|
3 | | -use crate::raw; |
| 6 | +use libc::c_void; |
| 7 | + |
| 8 | +use crate::odb::{write_pack_progress_cb, OdbPackwriterCb}; |
4 | 9 | use crate::util::Binding; |
| 10 | +use crate::{raw, Error, IntoCString, Odb}; |
5 | 11 |
|
6 | 12 | /// Struct representing the progress by an in-flight transfer. |
7 | 13 | pub struct Progress<'a> { |
@@ -94,3 +100,159 @@ impl<'a> Binding for Progress<'a> { |
94 | 100 | )] |
95 | 101 | #[allow(dead_code)] |
96 | 102 | pub type TransportProgress<'a> = IndexerProgress<'a>; |
| 103 | + |
| 104 | +/// A stream to write and index a packfile |
| 105 | +/// |
| 106 | +/// This is equivalent to [`crate::OdbPackwriter`], but allows to store the pack |
| 107 | +/// and index at an arbitrary path. It also does not require access to an object |
| 108 | +/// database if, and only if, the pack file is self-contained (i.e. not "thin"). |
| 109 | +pub struct Indexer<'odb> { |
| 110 | + raw: *mut raw::git_indexer, |
| 111 | + progress: MaybeUninit<raw::git_indexer_progress>, |
| 112 | + progress_payload_ptr: *mut OdbPackwriterCb<'odb>, |
| 113 | +} |
| 114 | + |
| 115 | +impl<'a> Indexer<'a> { |
| 116 | + /// Create a new indexer |
| 117 | + /// |
| 118 | + /// The [`Odb`] is used to resolve base objects when fixing thin packs. It |
| 119 | + /// can be `None` if no thin pack is expected, in which case missing bases |
| 120 | + /// will result in an error. |
| 121 | + /// |
| 122 | + /// `mode` is the permissions to use for the output files, use `0` for defaults. |
| 123 | + /// |
| 124 | + /// If `verify` is `false`, the indexer will bypass object connectivity checks. |
| 125 | + pub fn new(odb: Option<&Odb<'a>>, path: &Path, mode: u32, verify: bool) -> Result<Self, Error> { |
| 126 | + let path = path.into_c_string()?; |
| 127 | + |
| 128 | + let odb = odb.map(Binding::raw).unwrap_or_else(ptr::null_mut); |
| 129 | + |
| 130 | + let mut out = ptr::null_mut(); |
| 131 | + let progress = MaybeUninit::uninit(); |
| 132 | + let progress_cb: raw::git_indexer_progress_cb = Some(write_pack_progress_cb); |
| 133 | + let progress_payload = Box::new(OdbPackwriterCb { cb: None }); |
| 134 | + let progress_payload_ptr = Box::into_raw(progress_payload); |
| 135 | + |
| 136 | + unsafe { |
| 137 | + let mut opts = mem::zeroed(); |
| 138 | + try_call!(raw::git_indexer_options_init( |
| 139 | + &mut opts, |
| 140 | + raw::GIT_INDEXER_OPTIONS_VERSION |
| 141 | + )); |
| 142 | + opts.progress_cb = progress_cb; |
| 143 | + opts.progress_cb_payload = progress_payload_ptr as *mut c_void; |
| 144 | + opts.verify = verify.into(); |
| 145 | + |
| 146 | + try_call!(raw::git_indexer_new(&mut out, path, mode, odb, &mut opts)); |
| 147 | + } |
| 148 | + |
| 149 | + Ok(Self { |
| 150 | + raw: out, |
| 151 | + progress, |
| 152 | + progress_payload_ptr, |
| 153 | + }) |
| 154 | + } |
| 155 | + |
| 156 | + /// Finalize the pack and index |
| 157 | + /// |
| 158 | + /// Resolves any pending deltas and writes out the index file. The returned |
| 159 | + /// string is the hexadecimal checksum of the packfile, which is also used |
| 160 | + /// to name the pack and index files (`pack-<checksum>.pack` and |
| 161 | + /// `pack-<checksum>.idx` respectively). |
| 162 | + pub fn commit(mut self) -> Result<String, Error> { |
| 163 | + unsafe { |
| 164 | + try_call!(raw::git_indexer_commit( |
| 165 | + self.raw, |
| 166 | + self.progress.as_mut_ptr() |
| 167 | + )); |
| 168 | + |
| 169 | + let name = CStr::from_ptr(raw::git_indexer_name(self.raw)); |
| 170 | + Ok(name.to_str().expect("pack name not utf8").to_owned()) |
| 171 | + } |
| 172 | + } |
| 173 | + |
| 174 | + /// The callback through which progress is monitored. Be aware that this is |
| 175 | + /// called inline, so performance may be affected. |
| 176 | + pub fn progress<F>(&mut self, cb: F) -> &mut Self |
| 177 | + where |
| 178 | + F: FnMut(Progress<'_>) -> bool + 'a, |
| 179 | + { |
| 180 | + let progress_payload = |
| 181 | + unsafe { &mut *(self.progress_payload_ptr as *mut OdbPackwriterCb<'_>) }; |
| 182 | + progress_payload.cb = Some(Box::new(cb) as Box<IndexerProgress<'a>>); |
| 183 | + |
| 184 | + self |
| 185 | + } |
| 186 | +} |
| 187 | + |
| 188 | +impl io::Write for Indexer<'_> { |
| 189 | + fn write(&mut self, buf: &[u8]) -> io::Result<usize> { |
| 190 | + unsafe { |
| 191 | + let ptr = buf.as_ptr() as *mut c_void; |
| 192 | + let len = buf.len(); |
| 193 | + |
| 194 | + let res = raw::git_indexer_append(self.raw, ptr, len, self.progress.as_mut_ptr()); |
| 195 | + |
| 196 | + if res < 0 { |
| 197 | + Err(io::Error::new(io::ErrorKind::Other, "Write error")) |
| 198 | + } else { |
| 199 | + Ok(buf.len()) |
| 200 | + } |
| 201 | + } |
| 202 | + } |
| 203 | + |
| 204 | + fn flush(&mut self) -> io::Result<()> { |
| 205 | + Ok(()) |
| 206 | + } |
| 207 | +} |
| 208 | + |
| 209 | +impl Drop for Indexer<'_> { |
| 210 | + fn drop(&mut self) { |
| 211 | + unsafe { |
| 212 | + raw::git_indexer_free(self.raw); |
| 213 | + drop(Box::from_raw(self.progress_payload_ptr)) |
| 214 | + } |
| 215 | + } |
| 216 | +} |
| 217 | + |
| 218 | +#[cfg(test)] |
| 219 | +mod tests { |
| 220 | + use crate::{Buf, Indexer}; |
| 221 | + use std::io::prelude::*; |
| 222 | + |
| 223 | + #[test] |
| 224 | + fn indexer() { |
| 225 | + let (_td, repo_source) = crate::test::repo_init(); |
| 226 | + let (_td, repo_target) = crate::test::repo_init(); |
| 227 | + |
| 228 | + let mut progress_called = false; |
| 229 | + |
| 230 | + // Create an in-memory packfile |
| 231 | + let mut builder = t!(repo_source.packbuilder()); |
| 232 | + let mut buf = Buf::new(); |
| 233 | + let (commit_source_id, _tree) = crate::test::commit(&repo_source); |
| 234 | + t!(builder.insert_object(commit_source_id, None)); |
| 235 | + t!(builder.write_buf(&mut buf)); |
| 236 | + |
| 237 | + // Write it to the standard location in the target repo, but via indexer |
| 238 | + let odb = repo_source.odb().unwrap(); |
| 239 | + let mut indexer = Indexer::new( |
| 240 | + Some(&odb), |
| 241 | + repo_target.path().join("objects").join("pack").as_path(), |
| 242 | + 0o644, |
| 243 | + true, |
| 244 | + ) |
| 245 | + .unwrap(); |
| 246 | + indexer.progress(|_| { |
| 247 | + progress_called = true; |
| 248 | + true |
| 249 | + }); |
| 250 | + indexer.write(&buf).unwrap(); |
| 251 | + indexer.commit().unwrap(); |
| 252 | + |
| 253 | + // Assert that target repo picks it up as valid |
| 254 | + let commit_target = repo_target.find_commit(commit_source_id).unwrap(); |
| 255 | + assert_eq!(commit_target.id(), commit_source_id); |
| 256 | + assert!(progress_called); |
| 257 | + } |
| 258 | +} |
0 commit comments