File: ref_updater.go

package info (click to toggle)
git-lfs 3.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,880 kB
  • sloc: sh: 23,157; makefile: 519; ruby: 404
file content (194 lines) | stat: -rw-r--r-- 4,595 bytes parent folder | download
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
package githistory

import (
	"bytes"
	"encoding/hex"
	"fmt"
	"io"
	"strings"

	"github.com/git-lfs/git-lfs/v3/errors"
	"github.com/git-lfs/git-lfs/v3/git"
	"github.com/git-lfs/git-lfs/v3/tasklog"
	"github.com/git-lfs/git-lfs/v3/tr"
	"github.com/git-lfs/gitobj/v2"
)

// refUpdater is a type responsible for moving references from one point in the
// Git object graph to another.
type refUpdater struct {
	// cacheFn is a function that returns the SHA1 transformation from an
	// original hash to a new one. It specifies a "bool" return value
	// signaling whether or not that given "old" SHA1 was migrated.
	cacheFn func(old []byte) ([]byte, bool)
	// logger logs the progress of reference updating.
	logger *tasklog.Logger
	// refs is a set of *git.Ref's to migrate.
	refs []*git.Ref
	// root is the given directory on disk in which the repository is
	// located.
	root string
	// db is the *ObjectDatabase from which blobs, commits, and trees are
	// loaded.
	db *gitobj.ObjectDatabase
}

// updateRefs performs the reference update(s) from existing locations (see:
// Refs) to their respective new locations in the graph (see CacheFn).
//
// It creates reflog entries as well as stderr log entries as it progresses
// through the reference updates.
//
// It returns any error encountered, or nil if the reference update(s) was/were
// successful.
func (r *refUpdater) updateRefs() error {
	list := r.logger.List(tr.Tr.Get("Updating refs"))
	defer list.Complete()

	var maxNameLen int
	for _, ref := range r.refs {
		maxNameLen = max(maxNameLen, len(ref.Name))
	}

	cmd, err := git.UpdateRefsFromStdin(r.root)
	if err != nil {
		return err
	}

	var output bytes.Buffer
	cmd.Stdout = &output
	cmd.Stderr = &output

	input, err := cmd.StdinPipe()
	if err != nil {
		return err
	}

	err = cmd.Start()
	if err != nil {
		return err
	}
	defer func() {
		if cmd != nil {
			cmd.Wait()
		}
	}()

	gitUpRefTransactions := git.IsGitVersionAtLeast("2.27.0")
	if gitUpRefTransactions {
		if _, err = io.WriteString(input, "start\x00"); err != nil {
			return err
		}
	}

	seen := make(map[string][]byte)
	for _, ref := range r.refs {
		if err := r.updateOneRef(list, maxNameLen, seen, ref, input); err != nil {
			return err
		}
	}

	if gitUpRefTransactions {
		if _, err = io.WriteString(input, "prepare\x00commit\x00"); err != nil {
			return err
		}
	}

	if err = input.Close(); err != nil {
		return err
	}

	err = cmd.Wait()
	cmd = nil
	if err != nil {
		return fmt.Errorf("git update-ref failed: %s, output: %s", err.Error(), output.String())
	}

	return nil
}

func (r *refUpdater) updateOneTag(tag *gitobj.Tag, toObj []byte) ([]byte, error) {
	newTag, err := r.db.WriteTag(&gitobj.Tag{
		Object:     toObj,
		ObjectType: tag.ObjectType,
		Name:       tag.Name,
		Tagger:     tag.Tagger,

		Message: tag.Message,
	})

	if err != nil {
		return nil, errors.Wrap(err, tr.Tr.Get("could not rewrite tag: %s", tag.Name))
	}
	return newTag, nil
}

func (r *refUpdater) updateOneRef(list *tasklog.ListTask, maxNameLen int, seen map[string][]byte, ref *git.Ref, gitUpRefIn io.WriteCloser) error {
	sha1, err := hex.DecodeString(ref.Sha)
	if err != nil {
		return errors.Wrap(err, tr.Tr.Get("could not decode: %q", ref.Sha))
	}

	refspec := ref.Refspec()
	if _, ok := seen[refspec]; ok {
		return nil
	}

	to, ok := r.cacheFn(sha1)

	if ref.Type == git.RefTypeLocalTag {
		tag, _ := r.db.Tag(sha1)
		if tag != nil && tag.ObjectType == gitobj.TagObjectType {
			innerTag, _ := r.db.Tag(tag.Object)
			name := fmt.Sprintf("refs/tags/%s", innerTag.Name)
			if _, ok := seen[name]; !ok {
				old, err := git.ResolveRef(name)
				if err != nil {
					return err
				}

				err = r.updateOneRef(list, maxNameLen, seen, old, gitUpRefIn)
				if err != nil {
					return err
				}
			}

			updatedSha, refUpOk := seen[name]
			if !refUpOk {
				return nil
			}

			newTag, err := r.updateOneTag(tag, updatedSha)
			if newTag == nil {
				return err
			}
			to = newTag
			ok = true
		} else if tag != nil && tag.ObjectType == gitobj.CommitObjectType {
			toObj, okObj := r.cacheFn(tag.Object)
			if !okObj {
				return nil
			}

			newTag, err := r.updateOneTag(tag, toObj)
			if newTag == nil {
				return err
			}
			to = newTag
			ok = true
		}
	}

	if !ok {
		return nil
	}

	if _, err = io.WriteString(gitUpRefIn, fmt.Sprintf("update %s\x00%s\x00\x00", ref.Refspec(), hex.EncodeToString(to))); err != nil {
		return err
	}

	namePadding := max(maxNameLen-len(ref.Name), 0)
	list.Entry(fmt.Sprintf("  %s%s\t%s -> %x", ref.Name, strings.Repeat(" ", namePadding), ref.Sha, to))
	seen[refspec] = to
	return nil
}