repo.go

  1package backend
  2
  3import (
  4	"bufio"
  5	"context"
  6	"errors"
  7	"fmt"
  8	"io/fs"
  9	"os"
 10	"path"
 11	"path/filepath"
 12	"time"
 13
 14	"github.com/charmbracelet/soft-serve/git"
 15	"github.com/charmbracelet/soft-serve/server/db"
 16	"github.com/charmbracelet/soft-serve/server/db/models"
 17	"github.com/charmbracelet/soft-serve/server/hooks"
 18	"github.com/charmbracelet/soft-serve/server/lfs"
 19	"github.com/charmbracelet/soft-serve/server/proto"
 20	"github.com/charmbracelet/soft-serve/server/storage"
 21	"github.com/charmbracelet/soft-serve/server/utils"
 22)
 23
 24func (d *Backend) reposPath() string {
 25	return filepath.Join(d.cfg.DataPath, "repos")
 26}
 27
 28// CreateRepository creates a new repository.
 29//
 30// It implements backend.Backend.
 31func (d *Backend) CreateRepository(ctx context.Context, name string, opts proto.RepositoryOptions) (proto.Repository, error) {
 32	name = utils.SanitizeRepo(name)
 33	if err := utils.ValidateRepo(name); err != nil {
 34		return nil, err
 35	}
 36
 37	repo := name + ".git"
 38	rp := filepath.Join(d.reposPath(), repo)
 39
 40	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
 41		if err := d.store.CreateRepo(
 42			ctx,
 43			tx,
 44			name,
 45			opts.ProjectName,
 46			opts.Description,
 47			opts.Private,
 48			opts.Hidden,
 49			opts.Mirror,
 50		); err != nil {
 51			return err
 52		}
 53
 54		_, err := git.Init(rp, true)
 55		if err != nil {
 56			d.logger.Debug("failed to create repository", "err", err)
 57			return err
 58		}
 59
 60		if err := os.WriteFile(filepath.Join(rp, "description"), []byte(opts.Description), fs.ModePerm); err != nil {
 61			d.logger.Error("failed to write description", "repo", name, "err", err)
 62			return err
 63		}
 64
 65		if !opts.Private {
 66			if err := os.WriteFile(filepath.Join(rp, "git-daemon-export-ok"), []byte{}, fs.ModePerm); err != nil {
 67				d.logger.Error("failed to write git-daemon-export-ok", "repo", name, "err", err)
 68				return err
 69			}
 70		}
 71
 72		return hooks.GenerateHooks(ctx, d.cfg, repo)
 73	}); err != nil {
 74		d.logger.Debug("failed to create repository in database", "err", err)
 75		return nil, db.WrapError(err)
 76	}
 77
 78	return d.Repository(ctx, name)
 79}
 80
 81// ImportRepository imports a repository from remote.
 82func (d *Backend) ImportRepository(ctx context.Context, name string, remote string, opts proto.RepositoryOptions) (proto.Repository, error) {
 83	name = utils.SanitizeRepo(name)
 84	if err := utils.ValidateRepo(name); err != nil {
 85		return nil, err
 86	}
 87
 88	repo := name + ".git"
 89	rp := filepath.Join(d.reposPath(), repo)
 90
 91	if _, err := os.Stat(rp); err == nil || os.IsExist(err) {
 92		return nil, proto.ErrRepoExist
 93	}
 94
 95	copts := git.CloneOptions{
 96		Bare:   true,
 97		Mirror: opts.Mirror,
 98		Quiet:  true,
 99		CommandOptions: git.CommandOptions{
100			Timeout: -1,
101			Context: ctx,
102			Envs: []string{
103				fmt.Sprintf(`GIT_SSH_COMMAND=ssh -o UserKnownHostsFile="%s" -o StrictHostKeyChecking=no -i "%s"`,
104					filepath.Join(d.cfg.DataPath, "ssh", "known_hosts"),
105					d.cfg.SSH.ClientKeyPath,
106				),
107			},
108		},
109	}
110
111	if err := git.Clone(remote, rp, copts); err != nil {
112		d.logger.Error("failed to clone repository", "err", err, "mirror", opts.Mirror, "remote", remote, "path", rp)
113		// Cleanup the mess!
114		if rerr := os.RemoveAll(rp); rerr != nil {
115			err = errors.Join(err, rerr)
116		}
117		return nil, err
118	}
119
120	r, err := d.CreateRepository(ctx, name, opts)
121	if err != nil {
122		d.logger.Error("failed to create repository", "err", err, "name", name)
123		return nil, err
124	}
125
126	rr, err := r.Open()
127	if err != nil {
128		d.logger.Error("failed to open repository", "err", err, "path", rp)
129		return nil, err
130	}
131
132	rcfg, err := rr.Config()
133	if err != nil {
134		d.logger.Error("failed to get repository config", "err", err, "path", rp)
135		return nil, err
136	}
137
138	rcfg.Section("lfs").SetOption("url", remote)
139
140	if err := rr.SetConfig(rcfg); err != nil {
141		d.logger.Error("failed to set repository config", "err", err, "path", rp)
142		return nil, err
143	}
144
145	endpoint, err := lfs.NewEndpoint(remote)
146	if err != nil {
147		d.logger.Error("failed to create lfs endpoint", "err", err, "path", rp)
148		return nil, err
149	}
150
151	client := lfs.NewClient(endpoint)
152
153	if err := StoreRepoMissingLFSObjects(ctx, r, d.db, d.store, client); err != nil {
154		d.logger.Error("failed to store missing lfs objects", "err", err, "path", rp)
155		return nil, err
156	}
157
158	return r, nil
159}
160
161// DeleteRepository deletes a repository.
162//
163// It implements backend.Backend.
164func (d *Backend) DeleteRepository(ctx context.Context, name string, deleteLFS bool) error {
165	name = utils.SanitizeRepo(name)
166	repo := name + ".git"
167	rp := filepath.Join(d.reposPath(), repo)
168
169	return d.db.TransactionContext(ctx, func(tx *db.Tx) error {
170		// Delete repo from cache
171		defer d.cache.Delete(name)
172
173		if deleteLFS {
174			strg := storage.NewLocalStorage(filepath.Join(d.cfg.DataPath, "lfs"))
175			objs, err := d.store.GetLFSObjectsByName(ctx, tx, name)
176			if err != nil {
177				return err
178			}
179
180			for _, obj := range objs {
181				p := lfs.Pointer{
182					Oid:  obj.Oid,
183					Size: obj.Size,
184				}
185
186				d.logger.Debug("deleting lfs object", "repo", name, "oid", obj.Oid)
187				if err := strg.Delete(path.Join("objects", p.RelativePath())); err != nil {
188					d.logger.Error("failed to delete lfs object", "repo", name, "err", err, "oid", obj.Oid)
189				}
190			}
191		}
192
193		if err := d.store.DeleteRepoByName(ctx, tx, name); err != nil {
194			return err
195		}
196
197		return os.RemoveAll(rp)
198	})
199}
200
201// RenameRepository renames a repository.
202//
203// It implements backend.Backend.
204func (d *Backend) RenameRepository(ctx context.Context, oldName string, newName string) error {
205	oldName = utils.SanitizeRepo(oldName)
206	if err := utils.ValidateRepo(oldName); err != nil {
207		return err
208	}
209
210	newName = utils.SanitizeRepo(newName)
211	if err := utils.ValidateRepo(newName); err != nil {
212		return err
213	}
214	oldRepo := oldName + ".git"
215	newRepo := newName + ".git"
216	op := filepath.Join(d.reposPath(), oldRepo)
217	np := filepath.Join(d.reposPath(), newRepo)
218	if _, err := os.Stat(op); err != nil {
219		return proto.ErrRepoNotExist
220	}
221
222	if _, err := os.Stat(np); err == nil {
223		return proto.ErrRepoExist
224	}
225
226	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
227		// Delete cache
228		defer d.cache.Delete(oldName)
229
230		if err := d.store.SetRepoNameByName(ctx, tx, oldName, newName); err != nil {
231			return err
232		}
233
234		// Make sure the new repository parent directory exists.
235		if err := os.MkdirAll(filepath.Dir(np), os.ModePerm); err != nil {
236			return err
237		}
238
239		return os.Rename(op, np)
240	}); err != nil {
241		return db.WrapError(err)
242	}
243
244	return nil
245}
246
247// Repositories returns a list of repositories per page.
248//
249// It implements backend.Backend.
250func (d *Backend) Repositories(ctx context.Context) ([]proto.Repository, error) {
251	repos := make([]proto.Repository, 0)
252
253	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
254		ms, err := d.store.GetAllRepos(ctx, tx)
255		if err != nil {
256			return err
257		}
258
259		for _, m := range ms {
260			r := &repo{
261				name: m.Name,
262				path: filepath.Join(d.reposPath(), m.Name+".git"),
263				repo: m,
264			}
265
266			// Cache repositories
267			d.cache.Set(m.Name, r)
268
269			repos = append(repos, r)
270		}
271
272		return nil
273	}); err != nil {
274		return nil, db.WrapError(err)
275	}
276
277	return repos, nil
278}
279
280// Repository returns a repository by name.
281//
282// It implements backend.Backend.
283func (d *Backend) Repository(ctx context.Context, name string) (proto.Repository, error) {
284	var m models.Repo
285	name = utils.SanitizeRepo(name)
286
287	if r, ok := d.cache.Get(name); ok && r != nil {
288		return r, nil
289	}
290
291	rp := filepath.Join(d.reposPath(), name+".git")
292	if _, err := os.Stat(rp); err != nil {
293		return nil, os.ErrNotExist
294	}
295
296	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
297		var err error
298		m, err = d.store.GetRepoByName(ctx, tx, name)
299		return err
300	}); err != nil {
301		return nil, db.WrapError(err)
302	}
303
304	r := &repo{
305		name: name,
306		path: rp,
307		repo: m,
308	}
309
310	// Add to cache
311	d.cache.Set(name, r)
312
313	return r, nil
314}
315
316// Description returns the description of a repository.
317//
318// It implements backend.Backend.
319func (d *Backend) Description(ctx context.Context, name string) (string, error) {
320	name = utils.SanitizeRepo(name)
321	var desc string
322	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
323		var err error
324		desc, err = d.store.GetRepoDescriptionByName(ctx, tx, name)
325		return err
326	}); err != nil {
327		return "", db.WrapError(err)
328	}
329
330	return desc, nil
331}
332
333// IsMirror returns true if the repository is a mirror.
334//
335// It implements backend.Backend.
336func (d *Backend) IsMirror(ctx context.Context, name string) (bool, error) {
337	name = utils.SanitizeRepo(name)
338	var mirror bool
339	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
340		var err error
341		mirror, err = d.store.GetRepoIsMirrorByName(ctx, tx, name)
342		return err
343	}); err != nil {
344		return false, db.WrapError(err)
345	}
346	return mirror, nil
347}
348
349// IsPrivate returns true if the repository is private.
350//
351// It implements backend.Backend.
352func (d *Backend) IsPrivate(ctx context.Context, name string) (bool, error) {
353	name = utils.SanitizeRepo(name)
354	var private bool
355	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
356		var err error
357		private, err = d.store.GetRepoIsPrivateByName(ctx, tx, name)
358		return err
359	}); err != nil {
360		return false, db.WrapError(err)
361	}
362
363	return private, nil
364}
365
366// IsHidden returns true if the repository is hidden.
367//
368// It implements backend.Backend.
369func (d *Backend) IsHidden(ctx context.Context, name string) (bool, error) {
370	name = utils.SanitizeRepo(name)
371	var hidden bool
372	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
373		var err error
374		hidden, err = d.store.GetRepoIsHiddenByName(ctx, tx, name)
375		return err
376	}); err != nil {
377		return false, db.WrapError(err)
378	}
379
380	return hidden, nil
381}
382
383// ProjectName returns the project name of a repository.
384//
385// It implements backend.Backend.
386func (d *Backend) ProjectName(ctx context.Context, name string) (string, error) {
387	name = utils.SanitizeRepo(name)
388	var pname string
389	if err := d.db.TransactionContext(ctx, func(tx *db.Tx) error {
390		var err error
391		pname, err = d.store.GetRepoProjectNameByName(ctx, tx, name)
392		return err
393	}); err != nil {
394		return "", db.WrapError(err)
395	}
396
397	return pname, nil
398}
399
400// SetHidden sets the hidden flag of a repository.
401//
402// It implements backend.Backend.
403func (d *Backend) SetHidden(ctx context.Context, name string, hidden bool) error {
404	name = utils.SanitizeRepo(name)
405
406	// Delete cache
407	d.cache.Delete(name)
408
409	return db.WrapError(d.db.TransactionContext(ctx, func(tx *db.Tx) error {
410		return d.store.SetRepoIsHiddenByName(ctx, tx, name, hidden)
411	}))
412}
413
414// SetDescription sets the description of a repository.
415//
416// It implements backend.Backend.
417func (d *Backend) SetDescription(ctx context.Context, name string, desc string) error {
418	name = utils.SanitizeRepo(name)
419	rp := filepath.Join(d.reposPath(), name+".git")
420
421	// Delete cache
422	d.cache.Delete(name)
423
424	return d.db.TransactionContext(ctx, func(tx *db.Tx) error {
425		if err := os.WriteFile(filepath.Join(rp, "description"), []byte(desc), fs.ModePerm); err != nil {
426			d.logger.Error("failed to write description", "repo", name, "err", err)
427			return err
428		}
429
430		return d.store.SetRepoDescriptionByName(ctx, tx, name, desc)
431	})
432}
433
434// SetPrivate sets the private flag of a repository.
435//
436// It implements backend.Backend.
437func (d *Backend) SetPrivate(ctx context.Context, name string, private bool) error {
438	name = utils.SanitizeRepo(name)
439	rp := filepath.Join(d.reposPath(), name+".git")
440
441	// Delete cache
442	d.cache.Delete(name)
443
444	return db.WrapError(
445		d.db.TransactionContext(ctx, func(tx *db.Tx) error {
446			fp := filepath.Join(rp, "git-daemon-export-ok")
447			if !private {
448				if err := os.WriteFile(fp, []byte{}, fs.ModePerm); err != nil {
449					d.logger.Error("failed to write git-daemon-export-ok", "repo", name, "err", err)
450					return err
451				}
452			} else {
453				if _, err := os.Stat(fp); err == nil {
454					if err := os.Remove(fp); err != nil {
455						d.logger.Error("failed to remove git-daemon-export-ok", "repo", name, "err", err)
456						return err
457					}
458				}
459			}
460
461			return d.store.SetRepoIsPrivateByName(ctx, tx, name, private)
462		}),
463	)
464}
465
466// SetProjectName sets the project name of a repository.
467//
468// It implements backend.Backend.
469func (d *Backend) SetProjectName(ctx context.Context, repo string, name string) error {
470	repo = utils.SanitizeRepo(repo)
471
472	// Delete cache
473	d.cache.Delete(repo)
474
475	return db.WrapError(
476		d.db.TransactionContext(ctx, func(tx *db.Tx) error {
477			return d.store.SetRepoProjectNameByName(ctx, tx, repo, name)
478		}),
479	)
480}
481
482var _ proto.Repository = (*repo)(nil)
483
484// repo is a Git repository with metadata stored in a SQLite database.
485type repo struct {
486	name string
487	path string
488	repo models.Repo
489}
490
491// ID returns the repository's ID.
492//
493// It implements proto.Repository.
494func (r *repo) ID() int64 {
495	return r.repo.ID
496}
497
498// Description returns the repository's description.
499//
500// It implements backend.Repository.
501func (r *repo) Description() string {
502	return r.repo.Description
503}
504
505// IsMirror returns whether the repository is a mirror.
506//
507// It implements backend.Repository.
508func (r *repo) IsMirror() bool {
509	return r.repo.Mirror
510}
511
512// IsPrivate returns whether the repository is private.
513//
514// It implements backend.Repository.
515func (r *repo) IsPrivate() bool {
516	return r.repo.Private
517}
518
519// Name returns the repository's name.
520//
521// It implements backend.Repository.
522func (r *repo) Name() string {
523	return r.name
524}
525
526// Open opens the repository.
527//
528// It implements backend.Repository.
529func (r *repo) Open() (*git.Repository, error) {
530	return git.Open(r.path)
531}
532
533// ProjectName returns the repository's project name.
534//
535// It implements backend.Repository.
536func (r *repo) ProjectName() string {
537	return r.repo.ProjectName
538}
539
540// IsHidden returns whether the repository is hidden.
541//
542// It implements backend.Repository.
543func (r *repo) IsHidden() bool {
544	return r.repo.Hidden
545}
546
547// UpdatedAt returns the repository's last update time.
548func (r *repo) UpdatedAt() time.Time {
549	// Try to read the last modified time from the info directory.
550	if t, err := readOneline(filepath.Join(r.path, "info", "last-modified")); err == nil {
551		if t, err := time.Parse(time.RFC3339, t); err == nil {
552			return t
553		}
554	}
555
556	rr, err := git.Open(r.path)
557	if err == nil {
558		t, err := rr.LatestCommitTime()
559		if err == nil {
560			return t
561		}
562	}
563
564	return r.repo.UpdatedAt
565}
566
567func (r *repo) writeLastModified(t time.Time) error {
568	fp := filepath.Join(r.path, "info", "last-modified")
569	if err := os.MkdirAll(filepath.Dir(fp), os.ModePerm); err != nil {
570		return err
571	}
572
573	return os.WriteFile(fp, []byte(t.Format(time.RFC3339)), os.ModePerm)
574}
575
576func readOneline(path string) (string, error) {
577	f, err := os.Open(path)
578	if err != nil {
579		return "", err
580	}
581
582	defer f.Close() // nolint: errcheck
583	s := bufio.NewScanner(f)
584	s.Scan()
585	return s.Text(), s.Err()
586}