Simplify how git repositories are opened (#28937)
## Purpose
This is a refactor toward building an abstraction over managing git
repositories.
Afterwards, it does not matter anymore if they are stored on the local
disk or somewhere remote.
## What this PR changes
We used `git.OpenRepository` everywhere previously.
Now, we should split them into two distinct functions:
Firstly, there are temporary repositories which do not change:
```go
git.OpenRepository(ctx, diskPath)
```
Gitea managed repositories having a record in the database in the
`repository` table are moved into the new package `gitrepo`:
```go
gitrepo.OpenRepository(ctx, repo_model.Repo)
```
Why is `repo_model.Repository` the second parameter instead of file
path?
Because then we can easily adapt our repository storage strategy.
The repositories can be stored locally, however, they could just as well
be stored on a remote server.
## Further changes in other PRs
- A Git Command wrapper on package `gitrepo` could be created. i.e.
`NewCommand(ctx, repo_model.Repository, commands...)`. `git.RunOpts{Dir:
repo.RepoPath()}`, the directory should be empty before invoking this
method and it can be filled in the function only. #28940
- Remove the `RepoPath()`/`WikiPath()` functions to reduce the
possibility of mistakes.
---------
Co-authored-by: delvh <dev.lh@web.de>
2024-01-27 21:09:51 +01:00
|
|
|
// Copyright 2024 The Gitea Authors. All rights reserved.
|
|
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
|
|
|
|
package gitrepo
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
|
|
|
|
"code.gitea.io/gitea/modules/git"
|
|
|
|
)
|
|
|
|
|
|
|
|
// GetBranchesByPath returns a branch by its path
|
|
|
|
// if limit = 0 it will not limit
|
|
|
|
func GetBranchesByPath(ctx context.Context, repo Repository, skip, limit int) ([]*git.Branch, int, error) {
|
|
|
|
gitRepo, err := OpenRepository(ctx, repo)
|
|
|
|
if err != nil {
|
|
|
|
return nil, 0, err
|
|
|
|
}
|
|
|
|
defer gitRepo.Close()
|
|
|
|
|
|
|
|
return gitRepo.GetBranches(skip, limit)
|
|
|
|
}
|
|
|
|
|
|
|
|
func GetBranchCommitID(ctx context.Context, repo Repository, branch string) (string, error) {
|
|
|
|
gitRepo, err := OpenRepository(ctx, repo)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
defer gitRepo.Close()
|
|
|
|
|
|
|
|
return gitRepo.GetBranchCommitID(branch)
|
|
|
|
}
|
2024-03-08 08:30:10 +01:00
|
|
|
|
|
|
|
// SetDefaultBranch sets default branch of repository.
|
|
|
|
func SetDefaultBranch(ctx context.Context, repo Repository, name string) error {
|
|
|
|
_, _, err := git.NewCommand(ctx, "symbolic-ref", "HEAD").
|
|
|
|
AddDynamicArguments(git.BranchPrefix + name).
|
|
|
|
RunStdString(&git.RunOpts{Dir: repoPath(repo)})
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetDefaultBranch gets default branch of repository.
|
|
|
|
func GetDefaultBranch(ctx context.Context, repo Repository) (string, error) {
|
|
|
|
return git.GetDefaultBranch(ctx, repoPath(repo))
|
|
|
|
}
|
|
|
|
|
|
|
|
func GetWikiDefaultBranch(ctx context.Context, repo Repository) (string, error) {
|
|
|
|
return git.GetDefaultBranch(ctx, wikiPath(repo))
|
|
|
|
}
|