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 363 364 365 366
|
package lfs
import (
"bufio"
"bytes"
"fmt"
"io"
"regexp"
"strconv"
"strings"
"time"
"github.com/git-lfs/git-lfs/v3/errors"
"github.com/git-lfs/git-lfs/v3/filepathfilter"
"github.com/git-lfs/git-lfs/v3/git"
"github.com/git-lfs/git-lfs/v3/subprocess"
"github.com/git-lfs/git-lfs/v3/tr"
"github.com/rubyist/tracerx"
)
// When scanning diffs with parseScannerLogOutput(), the direction of diff
// to include data from, i.e., '+' or '-'. Depending on what you're scanning
// for either might be useful.
type LogDiffDirection byte
const (
LogDiffAdditions = LogDiffDirection('+') // include '+' diffs
LogDiffDeletions = LogDiffDirection('-') // include '-' diffs
)
var (
// Arguments to append to a git log call which will limit the output to
// lfs changes and format the output suitable for parseLogOutput.. method(s)
logLfsSearchArgs = []string{
"--no-ext-diff",
"--no-textconv",
"--color=never",
"-G", "oid sha256:", // only diffs which include an lfs file SHA change
"-p", // include diff so we can read the SHA
"-U12", // Make sure diff context is always big enough to support 10 extension lines to get whole pointer
`--format=lfs-commit-sha: %H %P`, // just a predictable commit header we can detect
}
)
type gitscannerResult struct {
Pointer *WrappedPointer
Err error
}
func scanUnpushed(cb GitScannerFoundPointer, remote string) error {
logArgs := []string{
"--branches", "--tags", // include all locally referenced commits
"--not"} // but exclude everything that comes after
if len(remote) == 0 {
logArgs = append(logArgs, "--remotes")
} else {
logArgs = append(logArgs, fmt.Sprintf("--remotes=%v", remote))
}
// Add standard search args to find lfs references
logArgs = append(logArgs, logLfsSearchArgs...)
cmd, err := git.Log(logArgs...)
if err != nil {
return err
}
parseScannerLogOutput(cb, LogDiffAdditions, cmd, nil)
return nil
}
func scanStashed(cb GitScannerFoundPointer) error {
// Stashes are actually 2-3 commits, each containing one of:
// 1. Working copy (WIP) modified files
// 2. Index changes
// 3. Untracked files (but only if "git stash -u" was used)
// The first of these, the WIP commit, is a merge whose first parent
// is HEAD and whose other parent(s) are commits 2 and 3 above.
// We need to get the individual diff of each of these commits to
// ensure we have all of the LFS objects referenced by the stash,
// so a future "git stash pop" can restore them all.
// First we get the list of SHAs of the WIP merge commits from the
// reflog using "git log -g --format=%h refs/stash --". Because
// older Git versions (at least <=2.7) don't report merge parents in
// the reflog, we can't extract the parent SHAs from "Merge:" lines
// in the log; we can, however, use the "git log -m" option to force
// an individual diff with the first merge parent in a second step.
logArgs := []string{"-g", "--format=%h", "refs/stash", "--"}
cmd, err := git.Log(logArgs...)
if err != nil {
return err
}
scanner := bufio.NewScanner(cmd.Stdout)
var stashMergeShas []string
for scanner.Scan() {
stashMergeSha := strings.TrimSpace(scanner.Text())
stashMergeShas = append(stashMergeShas, fmt.Sprintf("%v^..%v", stashMergeSha, stashMergeSha))
}
if err := scanner.Err(); err != nil {
errors.New(tr.Tr.Get("error while scanning `git log` for stashed refs: %v", err))
}
err = cmd.Wait()
if err != nil {
// Ignore this error, it really only happens when there's no refs/stash
return nil
}
// We can use the log parser if we provide the -m and --first-parent
// options to get the first WIP merge diff shown individually, then
// no additional options to get the second index merge diff and
// possible third untracked files merge diff in a subsequent step.
stashMergeLogArgs := [][]string{{"-m", "--first-parent"}, {}}
for _, logArgs := range stashMergeLogArgs {
// Add standard search args to find lfs references
logArgs = append(logArgs, logLfsSearchArgs...)
logArgs = append(logArgs, stashMergeShas...)
cmd, err = git.Log(logArgs...)
if err != nil {
return err
}
parseScannerLogOutput(cb, LogDiffAdditions, cmd, nil)
}
return nil
}
func parseScannerLogOutput(cb GitScannerFoundPointer, direction LogDiffDirection, cmd *subprocess.BufferedCmd, filter *filepathfilter.Filter) {
ch := make(chan gitscannerResult, chanBufSize)
cherr := make(chan []byte)
go func() {
stderr, _ := io.ReadAll(cmd.Stderr)
cherr <- stderr
close(cherr)
}()
go func() {
scanner := newLogScanner(direction, cmd.Stdout)
scanner.Filter = filter
for scanner.Scan() {
if p := scanner.Pointer(); p != nil {
ch <- gitscannerResult{Pointer: p}
}
}
if err := scanner.Err(); err != nil {
io.ReadAll(cmd.Stdout)
ch <- gitscannerResult{Err: errors.New(tr.Tr.Get("error while scanning `git log`: %v", err))}
}
stderr := <-cherr
err := cmd.Wait()
if err != nil {
ch <- gitscannerResult{Err: errors.New(tr.Tr.Get("error in `git log`: %v %v", err, string(stderr)))}
}
close(ch)
}()
cmd.Stdin.Close()
for result := range ch {
cb(result.Pointer, result.Err)
}
}
// logPreviousVersions scans history for all previous versions of LFS pointers
// from 'since' up to (but not including) the final state at ref
func logPreviousSHAs(cb GitScannerFoundPointer, ref string, filter *filepathfilter.Filter, since time.Time) error {
logArgs := []string{
fmt.Sprintf("--since=%v", git.FormatGitDate(since)),
}
// Add standard search args to find lfs references
logArgs = append(logArgs, logLfsSearchArgs...)
// ending at ref
logArgs = append(logArgs, ref)
cmd, err := git.Log(logArgs...)
if err != nil {
return err
}
parseScannerLogOutput(cb, LogDiffDeletions, cmd, filter)
return nil
}
// logScanner parses log output formatted as per logLfsSearchArgs & returns
// pointers.
type logScanner struct {
// Filter will ensure file paths matching the include patterns, or not matching
// the exclude patterns are skipped.
Filter *filepathfilter.Filter
r *bufio.Reader
err error
dir LogDiffDirection
pointer *WrappedPointer
pointerData *bytes.Buffer
currentFilename string
currentFileIncluded bool
commitHeaderRegex *regexp.Regexp
fileHeaderRegex *regexp.Regexp
fileMergeHeaderRegex *regexp.Regexp
pointerDataRegex *regexp.Regexp
}
// dir: whether to include results from + or - diffs
// r: a stream of output from git log with at least logLfsSearchArgs specified
func newLogScanner(dir LogDiffDirection, r io.Reader) *logScanner {
return &logScanner{
r: bufio.NewReader(r),
dir: dir,
pointerData: &bytes.Buffer{},
currentFileIncluded: true,
// no need to compile these regexes on every `git-lfs` call, just ones that
// use the scanner.
commitHeaderRegex: regexp.MustCompile(fmt.Sprintf(`^lfs-commit-sha: (%s)(?: (%s))*`, git.ObjectIDRegex, git.ObjectIDRegex)),
fileHeaderRegex: regexp.MustCompile(`^diff --git "?a\/(.+?)\s+"?b\/(.+)`),
fileMergeHeaderRegex: regexp.MustCompile(`^diff --cc (.+)`),
pointerDataRegex: regexp.MustCompile(`^([\+\- ])(version https://git-lfs|oid sha256|size|ext-).*$`),
}
}
func (s *logScanner) Pointer() *WrappedPointer {
return s.pointer
}
func (s *logScanner) Err() error {
return s.err
}
func (s *logScanner) Scan() bool {
s.pointer = nil
p, canScan := s.scan()
s.pointer = p
return canScan
}
// Utility func used at several points below (keep in narrow scope)
func (s *logScanner) finishLastPointer() *WrappedPointer {
if s.pointerData.Len() == 0 || !s.currentFileIncluded {
return nil
}
p, err := DecodePointer(s.pointerData)
s.pointerData.Reset()
if err == nil {
return &WrappedPointer{Name: s.currentFilename, Pointer: p}
} else {
tracerx.Printf("Unable to parse pointer from log: %v", err)
return nil
}
}
// For each commit we'll get something like this:
/*
lfs-commit-sha: 60fde3d23553e10a55e2a32ed18c20f65edd91e7 e2eaf1c10b57da7b98eb5d722ec5912ddeb53ea1
diff --git a/1D_Noise.png b/1D_Noise.png
new file mode 100644
index 0000000..2622b4a
--- /dev/null
+++ b/1D_Noise.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f5d84da40ab1f6aa28df2b2bf1ade2cdcd4397133f903c12b4106641b10e1ed6
+size 1289
*/
// There can be multiple diffs per commit (multiple binaries)
// Also when a binary is changed the diff will include a '-' line for the old SHA
func (s *logScanner) scan() (*WrappedPointer, bool) {
for {
line, err := s.r.ReadString('\n')
if err != nil && err != io.EOF {
s.err = err
return nil, false
}
// remove trailing newline delimiter and optional single carriage return
line = strings.TrimSuffix(strings.TrimRight(line, "\n"), "\r")
if match := s.commitHeaderRegex.FindStringSubmatch(line); match != nil {
// Currently we're not pulling out commit groupings, but could if we wanted
// This just acts as a delimiter for finishing a multiline pointer
if p := s.finishLastPointer(); p != nil {
return p, true
}
} else if match := s.fileHeaderRegex.FindStringSubmatch(line); match != nil {
// Finding a regular file header
p := s.finishLastPointer()
// Pertinent file name depends on whether we're listening to additions or removals
if s.dir == LogDiffAdditions {
s.setFilename(match[2])
} else {
s.setFilename(match[1])
}
if p != nil {
return p, true
}
} else if match := s.fileMergeHeaderRegex.FindStringSubmatch(line); match != nil {
// Git merge file header is a little different, only one file
p := s.finishLastPointer()
s.setFilename(match[1])
if p != nil {
return p, true
}
} else if s.currentFileIncluded {
if match := s.pointerDataRegex.FindStringSubmatch(line); match != nil {
// An LFS pointer data line
// Include only the entirety of one side of the diff
// -U3 will ensure we always get all of it, even if only
// the SHA changed (version & size the same)
changeType := match[1][0]
// Always include unchanged context lines (normally just the version line)
if LogDiffDirection(changeType) == s.dir || changeType == ' ' {
// Must skip diff +/- marker
s.pointerData.WriteString(line[1:])
s.pointerData.WriteString("\n") // newline was stripped off by scanner
}
}
}
if err == io.EOF {
break
}
}
if p := s.finishLastPointer(); p != nil {
return p, true
}
return nil, false
}
func (s *logScanner) setFilename(name string) {
// Trim last character if it's a quote
if len(name) > 0 && name[len(name)-1] == '"' {
name = name[:len(name)-1]
}
// Convert octals to proper UTF-8 code
unquotedName, err := strconv.Unquote(`"` + name + `"`)
if err == nil {
name = unquotedName
}
s.currentFilename = name
s.currentFileIncluded = s.Filter.Allows(name)
}
|