aboutsummaryrefslogtreecommitdiff
path: root/repository/repository.go
blob: 418941a00a15bb793d27d634fba2a00c4ee1dd96 (about) (plain) (blame)
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
// Package repository wires object and ref storage for one Git repository.
package repository

import (
	"errors"
	"fmt"
	"os"

	"codeberg.org/lindenii/furgit/config"
	"codeberg.org/lindenii/furgit/objectid"
	"codeberg.org/lindenii/furgit/objectstore"
	objectchain "codeberg.org/lindenii/furgit/objectstore/chain"
	objectloose "codeberg.org/lindenii/furgit/objectstore/loose"
	objectpacked "codeberg.org/lindenii/furgit/objectstore/packed"
	"codeberg.org/lindenii/furgit/refstore"
	refchain "codeberg.org/lindenii/furgit/refstore/chain"
	refloose "codeberg.org/lindenii/furgit/refstore/loose"
	refpacked "codeberg.org/lindenii/furgit/refstore/packed"
	reftable "codeberg.org/lindenii/furgit/refstore/reftable"
)

// Repository is a thin composition root for repository-local stores.
//
// Open expects a root for the Git directory itself:
// a bare repository root or a non-bare ".git" directory.
type Repository struct {
	config *config.Config
	algo   objectid.Algorithm

	objects                    objectstore.Store
	objectsLooseForWritingOnly *objectloose.Store
	refs                       refstore.Store
}

// Open opens a repository and wires object/ref stores from its on-disk format.
//
// Open borrows root during construction and does not close it.
func Open(root *os.Root) (repo *Repository, err error) {
	repo = &Repository{}
	defer func() {
		if err != nil {
			_ = repo.Close()
		}
	}()

	cfg, err := parseRepositoryConfig(root)
	if err != nil {
		return nil, err
	}
	repo.config = cfg

	algo, err := detectObjectAlgorithm(cfg)
	if err != nil {
		return nil, err
	}
	repo.algo = algo

	objects, objectsLooseForWritingOnly, err := openObjectStore(root, algo)
	if err != nil {
		return nil, err
	}
	repo.objects = objects
	repo.objectsLooseForWritingOnly = objectsLooseForWritingOnly

	refs, err := openRefStore(root, algo)
	if err != nil {
		return nil, err
	}
	repo.refs = refs

	return repo, nil
}

// Algorithm returns the repository object ID algorithm.
func (repo *Repository) Algorithm() objectid.Algorithm {
	return repo.algo
}

// Config returns the parsed repository configuration snapshot.
//
// The returned pointer is owned by Repository. Callers should treat it as
// read-only.
func (repo *Repository) Config() *config.Config {
	return repo.config
}

// Objects returns the configured object store.
func (repo *Repository) Objects() objectstore.Store {
	return repo.objects
}

// Refs returns the configured ref store.
func (repo *Repository) Refs() refstore.Store {
	return repo.refs
}

// Close closes owned stores and filesystem roots.
// The behavior of the repo after Close is undefined.
func (repo *Repository) Close() error {
	var errs []error

	if repo.refs != nil {
		if err := repo.refs.Close(); err != nil {
			errs = append(errs, err)
		}
	}
	if repo.objects != nil {
		if err := repo.objects.Close(); err != nil {
			errs = append(errs, err)
		}
	}
	if repo.objectsLooseForWritingOnly != nil {
		if err := repo.objectsLooseForWritingOnly.Close(); err != nil {
			errs = append(errs, err)
		}
	}

	return errors.Join(errs...)
}

func parseRepositoryConfig(root *os.Root) (*config.Config, error) {
	configFile, err := root.Open("config")
	if err != nil {
		return nil, fmt.Errorf("repository: open config: %w", err)
	}
	defer func() { _ = configFile.Close() }()

	cfg, err := config.ParseConfig(configFile)
	if err != nil {
		return nil, fmt.Errorf("repository: parse config: %w", err)
	}
	return cfg, nil
}

func detectObjectAlgorithm(cfg *config.Config) (objectid.Algorithm, error) {
	algoName := cfg.Get("extensions", "", "objectformat")
	if algoName == "" {
		algoName = objectid.AlgorithmSHA1.String()
	}
	algo, ok := objectid.ParseAlgorithm(algoName)
	if !ok {
		return objectid.AlgorithmUnknown, fmt.Errorf("repository: unsupported object format %q", algoName)
	}
	return algo, nil
}

func openObjectStore(root *os.Root, algo objectid.Algorithm) (objectstore.Store, *objectloose.Store, error) {
	objectsRoot, err := root.OpenRoot("objects")
	if err != nil {
		return nil, nil, fmt.Errorf("repository: open objects: %w", err)
	}

	looseStore, err := objectloose.New(objectsRoot, algo)
	if err != nil {
		return nil, nil, err
	}
	backends := []objectstore.Store{looseStore}

	packRoot, err := objectsRoot.OpenRoot("pack")
	if err == nil {
		var packedStore *objectpacked.Store
		packedStore, err = objectpacked.New(packRoot, algo)
		if err != nil {
			_ = looseStore.Close()
			return nil, nil, err
		}
		backends = append(backends, packedStore)
	} else if !errors.Is(err, os.ErrNotExist) {
		_ = looseStore.Close()
		return nil, nil, fmt.Errorf("repository: open objects/pack: %w", err)
	}

	objectsChain := objectchain.New(backends...)

	objectsRootForWriting, err := root.OpenRoot("objects")
	if err != nil {
		_ = objectsChain.Close()
		return nil, nil, fmt.Errorf("repository: open objects for loose writing: %w", err)
	}
	objectsLooseForWritingOnly, err := objectloose.New(objectsRootForWriting, algo)
	if err != nil {
		_ = objectsRootForWriting.Close()
		_ = objectsChain.Close()
		return nil, nil, err
	}

	return objectsChain, objectsLooseForWritingOnly, nil
}

func openRefStore(root *os.Root, algo objectid.Algorithm) (out refstore.Store, err error) {
	hasReftable, err := hasReftableStack(root)
	if err != nil {
		return nil, err
	}
	if hasReftable {
		reftableRoot, err := root.OpenRoot("reftable")
		if err != nil {
			return nil, fmt.Errorf("repository: open reftable: %w", err)
		}
		reftableStore, err := reftable.New(reftableRoot, algo)
		if err != nil {
			_ = reftableRoot.Close()
			return nil, err
		}
		return reftableStore, nil
	}

	looseRoot, err := root.OpenRoot(".")
	if err != nil {
		return nil, fmt.Errorf("repository: open root for loose refs: %w", err)
	}
	looseStore, err := refloose.New(looseRoot, algo)
	if err != nil {
		_ = looseRoot.Close()
		return nil, err
	}
	backends := []refstore.Store{looseStore}

	packedRefsFile, err := root.Open("packed-refs")
	if err == nil {
		packedStore, packedErr := refpacked.New(packedRefsFile, algo)
		_ = packedRefsFile.Close()
		if packedErr != nil {
			_ = looseStore.Close()
			return nil, packedErr
		}
		backends = append(backends, packedStore)
	} else if !errors.Is(err, os.ErrNotExist) {
		_ = looseStore.Close()
		return nil, fmt.Errorf("repository: open packed-refs: %w", err)
	}

	return refchain.New(backends...), nil
}

func hasReftableStack(root *os.Root) (bool, error) {
	_, err := root.Stat("reftable/tables.list")
	if err == nil {
		return true, nil
	}
	if errors.Is(err, os.ErrNotExist) {
		return false, nil
	}
	return false, fmt.Errorf("repository: stat reftable/tables.list: %w", err)
}