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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
use std::{borrow::Cow, ops::Range};
use bstr::BStr;
use gix_hash::{oid, ObjectId};
use winnow::{
combinator::{alt, eof, opt, terminated},
error::StrContext,
prelude::*,
token::take_till1,
};
use crate::{
bstr::ByteSlice,
commit::{decode, SignedData},
parse,
parse::NL,
CommitRefIter,
};
#[derive(Copy, Clone)]
pub(crate) enum SignatureKind {
Author,
Committer,
}
#[derive(Default, Copy, Clone)]
pub(crate) enum State {
#[default]
Tree,
Parents,
Signature {
of: SignatureKind,
},
Encoding,
ExtraHeaders,
Message,
}
/// Lifecycle
impl<'a> CommitRefIter<'a> {
/// Create a commit iterator from data.
pub fn from_bytes(data: &'a [u8]) -> CommitRefIter<'a> {
CommitRefIter {
data,
state: State::default(),
}
}
}
/// Access
impl<'a> CommitRefIter<'a> {
/// Parse `data` as commit and return its PGP signature, along with *all non-signature* data as [`SignedData`], or `None`
/// if the commit isn't signed.
///
/// This allows the caller to validate the signature by passing the signed data along with the signature back to the program
/// that created it.
pub fn signature(data: &'a [u8]) -> Result<Option<(Cow<'a, BStr>, SignedData<'a>)>, crate::decode::Error> {
let mut signature_and_range = None;
let raw_tokens = CommitRefIterRaw {
data,
state: State::default(),
offset: 0,
};
for token in raw_tokens {
let token = token?;
if let Token::ExtraHeader((name, value)) = &token.token {
if *name == "gpgsig" {
// keep track of the signature range alongside the signature data,
// because all but the signature is the signed data.
signature_and_range = Some((value.clone(), token.token_range));
break;
}
}
}
Ok(signature_and_range.map(|(sig, signature_range)| (sig, SignedData { data, signature_range })))
}
/// Returns the object id of this commits tree if it is the first function called and if there is no error in decoding
/// the data.
///
/// Note that this method must only be called once or else will always return None while consuming a single token.
/// Errors are coerced into options, hiding whether there was an error or not. The caller should assume an error if they
/// call the method as intended. Such a squelched error cannot be recovered unless the objects data is retrieved and parsed again.
/// `next()`.
pub fn tree_id(&mut self) -> Result<ObjectId, crate::decode::Error> {
let tree_id = self.next().ok_or_else(missing_field)??;
Token::try_into_id(tree_id).ok_or_else(missing_field)
}
/// Return all `parent_ids` as iterator.
///
/// Parsing errors are ignored quietly.
pub fn parent_ids(self) -> impl Iterator<Item = gix_hash::ObjectId> + 'a {
self.filter_map(|t| match t {
Ok(Token::Parent { id }) => Some(id),
_ => None,
})
}
/// Returns all signatures, first the author, then the committer, if there is no decoding error.
///
/// Errors are coerced into options, hiding whether there was an error or not. The caller knows if there was an error or not
/// if not exactly two signatures were iterable.
/// Errors are not the common case - if an error needs to be detectable, use this instance as iterator.
pub fn signatures(self) -> impl Iterator<Item = gix_actor::SignatureRef<'a>> + 'a {
self.filter_map(|t| match t {
Ok(Token::Author { signature } | Token::Committer { signature }) => Some(signature),
_ => None,
})
}
/// Returns the committer signature if there is no decoding error.
pub fn committer(mut self) -> Result<gix_actor::SignatureRef<'a>, crate::decode::Error> {
self.find_map(|t| match t {
Ok(Token::Committer { signature }) => Some(Ok(signature)),
Err(err) => Some(Err(err)),
_ => None,
})
.ok_or_else(missing_field)?
}
/// Returns the author signature if there is no decoding error.
///
/// It may contain white space surrounding it, and is exactly as parsed.
pub fn author(mut self) -> Result<gix_actor::SignatureRef<'a>, crate::decode::Error> {
self.find_map(|t| match t {
Ok(Token::Author { signature }) => Some(Ok(signature)),
Err(err) => Some(Err(err)),
_ => None,
})
.ok_or_else(missing_field)?
}
/// Returns the message if there is no decoding error.
///
/// It may contain white space surrounding it, and is exactly as
// parsed.
pub fn message(mut self) -> Result<&'a BStr, crate::decode::Error> {
self.find_map(|t| match t {
Ok(Token::Message(msg)) => Some(Ok(msg)),
Err(err) => Some(Err(err)),
_ => None,
})
.transpose()
.map(Option::unwrap_or_default)
}
}
fn missing_field() -> crate::decode::Error {
crate::decode::empty_error()
}
impl<'a> CommitRefIter<'a> {
#[inline]
fn next_inner(i: &'a [u8], state: &mut State) -> Result<(&'a [u8], Token<'a>), crate::decode::Error> {
Self::next_inner_(i, state).map_err(crate::decode::Error::with_err)
}
fn next_inner_(
mut i: &'a [u8],
state: &mut State,
) -> Result<(&'a [u8], Token<'a>), winnow::error::ErrMode<crate::decode::ParseError>> {
use State::*;
Ok(match state {
Tree => {
let tree = (|i: &mut _| parse::header_field(i, b"tree", parse::hex_hash))
.context(StrContext::Expected("tree <40 lowercase hex char>".into()))
.parse_next(&mut i)?;
*state = State::Parents;
(
i,
Token::Tree {
id: ObjectId::from_hex(tree).expect("parsing validation"),
},
)
}
Parents => {
let parent = opt(|i: &mut _| parse::header_field(i, b"parent", parse::hex_hash))
.context(StrContext::Expected("commit <40 lowercase hex char>".into()))
.parse_next(&mut i)?;
match parent {
Some(parent) => (
i,
Token::Parent {
id: ObjectId::from_hex(parent).expect("parsing validation"),
},
),
None => {
*state = State::Signature {
of: SignatureKind::Author,
};
return Self::next_inner_(i, state);
}
}
}
Signature { ref mut of } => {
let who = *of;
let (field_name, err_msg) = match of {
SignatureKind::Author => {
*of = SignatureKind::Committer;
(&b"author"[..], "author <signature>")
}
SignatureKind::Committer => {
*state = State::Encoding;
(&b"committer"[..], "committer <signature>")
}
};
let signature = (|i: &mut _| parse::header_field(i, field_name, parse::signature))
.context(StrContext::Expected(err_msg.into()))
.parse_next(&mut i)?;
(
i,
match who {
SignatureKind::Author => Token::Author { signature },
SignatureKind::Committer => Token::Committer { signature },
},
)
}
Encoding => {
let encoding = opt(|i: &mut _| parse::header_field(i, b"encoding", take_till1(NL)))
.context(StrContext::Expected("encoding <encoding>".into()))
.parse_next(&mut i)?;
*state = State::ExtraHeaders;
match encoding {
Some(encoding) => (i, Token::Encoding(encoding.as_bstr())),
None => return Self::next_inner_(i, state),
}
}
ExtraHeaders => {
let extra_header = opt(alt((
|i: &mut _| parse::any_header_field_multi_line(i).map(|(k, o)| (k.as_bstr(), Cow::Owned(o))),
|i: &mut _| {
parse::any_header_field(i, take_till1(NL))
.map(|(k, o)| (k.as_bstr(), Cow::Borrowed(o.as_bstr())))
},
)))
.context(StrContext::Expected("<field> <single-line|multi-line>".into()))
.parse_next(&mut i)?;
match extra_header {
Some(extra_header) => (i, Token::ExtraHeader(extra_header)),
None => {
*state = State::Message;
return Self::next_inner_(i, state);
}
}
}
Message => {
let message = terminated(decode::message, eof).parse_next(&mut i)?;
debug_assert!(
i.is_empty(),
"we should have consumed all data - otherwise iter may go forever"
);
return Ok((i, Token::Message(message)));
}
})
}
}
impl<'a> Iterator for CommitRefIter<'a> {
type Item = Result<Token<'a>, crate::decode::Error>;
fn next(&mut self) -> Option<Self::Item> {
if self.data.is_empty() {
return None;
}
match Self::next_inner(self.data, &mut self.state) {
Ok((data, token)) => {
self.data = data;
Some(Ok(token))
}
Err(err) => {
self.data = &[];
Some(Err(err))
}
}
}
}
/// A variation of [`CommitRefIter`] that return's [`RawToken`]s instead.
struct CommitRefIterRaw<'a> {
data: &'a [u8],
state: State,
offset: usize,
}
impl<'a> Iterator for CommitRefIterRaw<'a> {
type Item = Result<RawToken<'a>, crate::decode::Error>;
fn next(&mut self) -> Option<Self::Item> {
if self.data.is_empty() {
return None;
}
match CommitRefIter::next_inner(self.data, &mut self.state) {
Ok((remaining, token)) => {
let consumed = self.data.len() - remaining.len();
let start = self.offset;
let end = start + consumed;
self.offset = end;
self.data = remaining;
Some(Ok(RawToken {
token,
token_range: start..end,
}))
}
Err(err) => {
self.data = &[];
Some(Err(err))
}
}
}
}
/// A combination of a parsed [`Token`] as well as the range of bytes that were consumed to parse it.
struct RawToken<'a> {
/// The parsed token.
token: Token<'a>,
token_range: Range<usize>,
}
/// A token returned by the [commit iterator][CommitRefIter].
#[allow(missing_docs)]
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
pub enum Token<'a> {
Tree {
id: ObjectId,
},
Parent {
id: ObjectId,
},
/// A person who authored the content of the commit.
Author {
signature: gix_actor::SignatureRef<'a>,
},
/// A person who committed the authors work to the repository.
Committer {
signature: gix_actor::SignatureRef<'a>,
},
Encoding(&'a BStr),
ExtraHeader((&'a BStr, Cow<'a, BStr>)),
Message(&'a BStr),
}
impl<'a> Token<'a> {
/// Return the object id of this token if its a [tree][Token::Tree] or a [parent commit][Token::Parent].
pub fn id(&self) -> Option<&oid> {
match self {
Token::Tree { id } | Token::Parent { id } => Some(id.as_ref()),
_ => None,
}
}
/// Return the owned object id of this token if its a [tree][Token::Tree] or a [parent commit][Token::Parent].
pub fn try_into_id(self) -> Option<ObjectId> {
match self {
Token::Tree { id } | Token::Parent { id } => Some(id),
_ => None,
}
}
}