2021-11-24 07:56:24 +00:00
|
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
2022-11-27 18:20:29 +00:00
|
|
|
// SPDX-License-Identifier: MIT
|
2021-11-24 07:56:24 +00:00
|
|
|
|
|
|
|
|
package files
|
|
|
|
|
|
|
|
|
|
import (
|
2022-01-19 23:26:57 +00:00
|
|
|
"context"
|
2021-11-24 07:56:24 +00:00
|
|
|
"fmt"
|
|
|
|
|
|
2021-12-10 08:14:24 +00:00
|
|
|
asymkey_model "code.gitea.io/gitea/models/asymkey"
|
2022-06-12 15:51:54 +00:00
|
|
|
git_model "code.gitea.io/gitea/models/git"
|
2021-12-10 01:27:50 +00:00
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-24 09:49:20 +00:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2021-11-24 07:56:24 +00:00
|
|
|
"code.gitea.io/gitea/modules/git"
|
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 20:09:51 +00:00
|
|
|
"code.gitea.io/gitea/modules/gitrepo"
|
2021-11-24 07:56:24 +00:00
|
|
|
"code.gitea.io/gitea/modules/structs"
|
2022-05-07 17:05:52 +00:00
|
|
|
"code.gitea.io/gitea/services/automerge"
|
2021-11-24 07:56:24 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// CreateCommitStatus creates a new CommitStatus given a bunch of parameters
|
|
|
|
|
// NOTE: All text-values will be trimmed from whitespaces.
|
|
|
|
|
// Requires: Repo, Creator, SHA
|
2022-06-12 15:51:54 +00:00
|
|
|
func CreateCommitStatus(ctx context.Context, repo *repo_model.Repository, creator *user_model.User, sha string, status *git_model.CommitStatus) error {
|
2021-11-24 07:56:24 +00:00
|
|
|
repoPath := repo.RepoPath()
|
|
|
|
|
|
|
|
|
|
// confirm that commit is exist
|
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 20:09:51 +00:00
|
|
|
gitRepo, closer, err := gitrepo.RepositoryFromContextOrOpen(ctx, repo)
|
2021-11-24 07:56:24 +00:00
|
|
|
if err != nil {
|
2022-10-24 19:29:17 +00:00
|
|
|
return fmt.Errorf("OpenRepository[%s]: %w", repoPath, err)
|
2021-11-24 07:56:24 +00:00
|
|
|
}
|
2022-01-19 23:26:57 +00:00
|
|
|
defer closer.Close()
|
|
|
|
|
|
2024-02-24 06:55:19 +00:00
|
|
|
objectFormat := git.ObjectFormatFromName(repo.ObjectFormatName)
|
|
|
|
|
|
2023-12-13 21:02:00 +00:00
|
|
|
commit, err := gitRepo.GetCommit(sha)
|
|
|
|
|
if err != nil {
|
2021-11-24 07:56:24 +00:00
|
|
|
gitRepo.Close()
|
2022-10-24 19:29:17 +00:00
|
|
|
return fmt.Errorf("GetCommit[%s]: %w", sha, err)
|
2023-12-13 21:02:00 +00:00
|
|
|
} else if len(sha) != objectFormat.FullLength() {
|
2022-12-27 13:12:49 +00:00
|
|
|
// use complete commit sha
|
|
|
|
|
sha = commit.ID.String()
|
2021-11-24 07:56:24 +00:00
|
|
|
}
|
|
|
|
|
gitRepo.Close()
|
|
|
|
|
|
2023-01-09 03:50:54 +00:00
|
|
|
if err := git_model.NewCommitStatus(ctx, git_model.NewCommitStatusOptions{
|
2021-11-24 07:56:24 +00:00
|
|
|
Repo: repo,
|
|
|
|
|
Creator: creator,
|
2023-12-13 21:02:00 +00:00
|
|
|
SHA: commit.ID,
|
2021-11-24 07:56:24 +00:00
|
|
|
CommitStatus: status,
|
|
|
|
|
}); err != nil {
|
2022-10-24 19:29:17 +00:00
|
|
|
return fmt.Errorf("NewCommitStatus[repo_id: %d, user_id: %d, sha: %s]: %w", repo.ID, creator.ID, sha, err)
|
2021-11-24 07:56:24 +00:00
|
|
|
}
|
|
|
|
|
|
2022-05-07 17:05:52 +00:00
|
|
|
if status.State.IsSuccess() {
|
|
|
|
|
if err := automerge.MergeScheduledPullRequest(ctx, sha, repo); err != nil {
|
|
|
|
|
return fmt.Errorf("MergeScheduledPullRequest[repo_id: %d, user_id: %d, sha: %s]: %w", repo.ID, creator.ID, sha, err)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-11-24 07:56:24 +00:00
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// CountDivergingCommits determines how many commits a branch is ahead or behind the repository's base branch
|
2022-01-19 23:26:57 +00:00
|
|
|
func CountDivergingCommits(ctx context.Context, repo *repo_model.Repository, branch string) (*git.DivergeObject, error) {
|
|
|
|
|
divergence, err := git.GetDivergingCommits(ctx, repo.RepoPath(), repo.DefaultBranch, branch)
|
2021-11-24 07:56:24 +00:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
return &divergence, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// GetPayloadCommitVerification returns the verification information of a commit
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 13:37:34 +00:00
|
|
|
func GetPayloadCommitVerification(ctx context.Context, commit *git.Commit) *structs.PayloadCommitVerification {
|
2021-11-24 07:56:24 +00:00
|
|
|
verification := &structs.PayloadCommitVerification{}
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 13:37:34 +00:00
|
|
|
commitVerification := asymkey_model.ParseCommitWithSignature(ctx, commit)
|
2021-11-24 07:56:24 +00:00
|
|
|
if commit.Signature != nil {
|
|
|
|
|
verification.Signature = commit.Signature.Signature
|
|
|
|
|
verification.Payload = commit.Signature.Payload
|
|
|
|
|
}
|
|
|
|
|
if commitVerification.SigningUser != nil {
|
|
|
|
|
verification.Signer = &structs.PayloadUser{
|
|
|
|
|
Name: commitVerification.SigningUser.Name,
|
|
|
|
|
Email: commitVerification.SigningUser.Email,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
verification.Verified = commitVerification.Verified
|
|
|
|
|
verification.Reason = commitVerification.Reason
|
|
|
|
|
if verification.Reason == "" && !verification.Verified {
|
|
|
|
|
verification.Reason = "gpg.error.not_signed_commit"
|
|
|
|
|
}
|
|
|
|
|
return verification
|
|
|
|
|
}
|
