mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-29 23:57:30 +02:00
## 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>
300 lines
8.3 KiB
Go
300 lines
8.3 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package doctor
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"path"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/models"
|
|
"code.gitea.io/gitea/models/db"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/gitrepo"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/repository"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
lru "github.com/hashicorp/golang-lru/v2"
|
|
"xorm.io/builder"
|
|
)
|
|
|
|
func iterateRepositories(ctx context.Context, each func(*repo_model.Repository) error) error {
|
|
err := db.Iterate(
|
|
ctx,
|
|
builder.Gt{"id": 0},
|
|
func(ctx context.Context, bean *repo_model.Repository) error {
|
|
return each(bean)
|
|
},
|
|
)
|
|
return err
|
|
}
|
|
|
|
func checkScriptType(ctx context.Context, logger log.Logger, autofix bool) error {
|
|
path, err := exec.LookPath(setting.ScriptType)
|
|
if err != nil {
|
|
logger.Critical("ScriptType \"%q\" is not on the current PATH. Error: %v", setting.ScriptType, err)
|
|
return fmt.Errorf("ScriptType \"%q\" is not on the current PATH. Error: %w", setting.ScriptType, err)
|
|
}
|
|
logger.Info("ScriptType %s is on the current PATH at %s", setting.ScriptType, path)
|
|
return nil
|
|
}
|
|
|
|
func checkHooks(ctx context.Context, logger log.Logger, autofix bool) error {
|
|
if err := iterateRepositories(ctx, func(repo *repo_model.Repository) error {
|
|
results, err := repository.CheckDelegateHooks(repo.RepoPath())
|
|
if err != nil {
|
|
logger.Critical("Unable to check delegate hooks for repo %-v. ERROR: %v", repo, err)
|
|
return fmt.Errorf("Unable to check delegate hooks for repo %-v. ERROR: %w", repo, err)
|
|
}
|
|
if len(results) > 0 && autofix {
|
|
logger.Warn("Regenerated hooks for %s", repo.FullName())
|
|
if err := repository.CreateDelegateHooks(repo.RepoPath()); err != nil {
|
|
logger.Critical("Unable to recreate delegate hooks for %-v. ERROR: %v", repo, err)
|
|
return fmt.Errorf("Unable to recreate delegate hooks for %-v. ERROR: %w", repo, err)
|
|
}
|
|
}
|
|
for _, result := range results {
|
|
logger.Warn(result)
|
|
}
|
|
return nil
|
|
}); err != nil {
|
|
logger.Critical("Errors noted whilst checking delegate hooks.")
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func checkUserStarNum(ctx context.Context, logger log.Logger, autofix bool) error {
|
|
if autofix {
|
|
if err := models.DoctorUserStarNum(ctx); err != nil {
|
|
logger.Critical("Unable update User Stars numbers")
|
|
return err
|
|
}
|
|
logger.Info("Updated User Stars numbers.")
|
|
} else {
|
|
logger.Info("No check available for User Stars numbers (skipped)")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func checkEnablePushOptions(ctx context.Context, logger log.Logger, autofix bool) error {
|
|
numRepos := 0
|
|
numNeedUpdate := 0
|
|
|
|
if err := iterateRepositories(ctx, func(repo *repo_model.Repository) error {
|
|
numRepos++
|
|
r, err := gitrepo.OpenRepository(ctx, repo)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer r.Close()
|
|
|
|
if autofix {
|
|
_, _, err := git.NewCommand(ctx, "config", "receive.advertisePushOptions", "true").RunStdString(&git.RunOpts{Dir: r.Path})
|
|
return err
|
|
}
|
|
|
|
value, _, err := git.NewCommand(ctx, "config", "receive.advertisePushOptions").RunStdString(&git.RunOpts{Dir: r.Path})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
result, valid := git.ParseBool(strings.TrimSpace(value))
|
|
if !result || !valid {
|
|
numNeedUpdate++
|
|
logger.Info("%s: does not have receive.advertisePushOptions set correctly: %q", repo.FullName(), value)
|
|
}
|
|
return nil
|
|
}); err != nil {
|
|
logger.Critical("Unable to EnablePushOptions: %v", err)
|
|
return err
|
|
}
|
|
|
|
if autofix {
|
|
logger.Info("Enabled push options for %d repositories.", numRepos)
|
|
} else {
|
|
logger.Info("Checked %d repositories, %d need updates.", numRepos, numNeedUpdate)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func checkDaemonExport(ctx context.Context, logger log.Logger, autofix bool) error {
|
|
numRepos := 0
|
|
numNeedUpdate := 0
|
|
cache, err := lru.New[int64, any](512)
|
|
if err != nil {
|
|
logger.Critical("Unable to create cache: %v", err)
|
|
return err
|
|
}
|
|
if err := iterateRepositories(ctx, func(repo *repo_model.Repository) error {
|
|
numRepos++
|
|
|
|
if owner, has := cache.Get(repo.OwnerID); has {
|
|
repo.Owner = owner.(*user_model.User)
|
|
} else {
|
|
if err := repo.LoadOwner(ctx); err != nil {
|
|
return err
|
|
}
|
|
cache.Add(repo.OwnerID, repo.Owner)
|
|
}
|
|
|
|
// Create/Remove git-daemon-export-ok for git-daemon...
|
|
daemonExportFile := path.Join(repo.RepoPath(), `git-daemon-export-ok`)
|
|
isExist, err := util.IsExist(daemonExportFile)
|
|
if err != nil {
|
|
log.Error("Unable to check if %s exists. Error: %v", daemonExportFile, err)
|
|
return err
|
|
}
|
|
isPublic := !repo.IsPrivate && repo.Owner.Visibility == structs.VisibleTypePublic
|
|
|
|
if isPublic != isExist {
|
|
numNeedUpdate++
|
|
if autofix {
|
|
if !isPublic && isExist {
|
|
if err = util.Remove(daemonExportFile); err != nil {
|
|
log.Error("Failed to remove %s: %v", daemonExportFile, err)
|
|
}
|
|
} else if isPublic && !isExist {
|
|
if f, err := os.Create(daemonExportFile); err != nil {
|
|
log.Error("Failed to create %s: %v", daemonExportFile, err)
|
|
} else {
|
|
f.Close()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}); err != nil {
|
|
logger.Critical("Unable to checkDaemonExport: %v", err)
|
|
return err
|
|
}
|
|
|
|
if autofix {
|
|
logger.Info("Updated git-daemon-export-ok files for %d of %d repositories.", numNeedUpdate, numRepos)
|
|
} else {
|
|
logger.Info("Checked %d repositories, %d need updates.", numRepos, numNeedUpdate)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func checkCommitGraph(ctx context.Context, logger log.Logger, autofix bool) error {
|
|
numRepos := 0
|
|
numNeedUpdate := 0
|
|
numWritten := 0
|
|
if err := iterateRepositories(ctx, func(repo *repo_model.Repository) error {
|
|
numRepos++
|
|
|
|
commitGraphExists := func() (bool, error) {
|
|
// Check commit-graph exists
|
|
commitGraphFile := path.Join(repo.RepoPath(), `objects/info/commit-graph`)
|
|
isExist, err := util.IsExist(commitGraphFile)
|
|
if err != nil {
|
|
logger.Error("Unable to check if %s exists. Error: %v", commitGraphFile, err)
|
|
return false, err
|
|
}
|
|
|
|
if !isExist {
|
|
commitGraphsDir := path.Join(repo.RepoPath(), `objects/info/commit-graphs`)
|
|
isExist, err = util.IsExist(commitGraphsDir)
|
|
if err != nil {
|
|
logger.Error("Unable to check if %s exists. Error: %v", commitGraphsDir, err)
|
|
return false, err
|
|
}
|
|
}
|
|
return isExist, nil
|
|
}
|
|
|
|
isExist, err := commitGraphExists()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !isExist {
|
|
numNeedUpdate++
|
|
if autofix {
|
|
if err := git.WriteCommitGraph(ctx, repo.RepoPath()); err != nil {
|
|
logger.Error("Unable to write commit-graph in %s. Error: %v", repo.FullName(), err)
|
|
return err
|
|
}
|
|
isExist, err := commitGraphExists()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if isExist {
|
|
numWritten++
|
|
logger.Info("Commit-graph written: %s", repo.FullName())
|
|
} else {
|
|
logger.Warn("No commit-graph written: %s", repo.FullName())
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}); err != nil {
|
|
logger.Critical("Unable to checkCommitGraph: %v", err)
|
|
return err
|
|
}
|
|
|
|
if autofix {
|
|
logger.Info("Wrote commit-graph files for %d of %d repositories.", numWritten, numRepos)
|
|
} else {
|
|
logger.Info("Checked %d repositories, %d without commit-graphs.", numRepos, numNeedUpdate)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func init() {
|
|
Register(&Check{
|
|
Title: "Check if SCRIPT_TYPE is available",
|
|
Name: "script-type",
|
|
IsDefault: false,
|
|
Run: checkScriptType,
|
|
Priority: 5,
|
|
})
|
|
Register(&Check{
|
|
Title: "Check if hook files are up-to-date and executable",
|
|
Name: "hooks",
|
|
IsDefault: false,
|
|
Run: checkHooks,
|
|
Priority: 6,
|
|
})
|
|
Register(&Check{
|
|
Title: "Recalculate Stars number for all user",
|
|
Name: "recalculate-stars-number",
|
|
IsDefault: false,
|
|
Run: checkUserStarNum,
|
|
Priority: 6,
|
|
})
|
|
Register(&Check{
|
|
Title: "Check that all git repositories have receive.advertisePushOptions set to true",
|
|
Name: "enable-push-options",
|
|
IsDefault: false,
|
|
Run: checkEnablePushOptions,
|
|
Priority: 7,
|
|
})
|
|
Register(&Check{
|
|
Title: "Check git-daemon-export-ok files",
|
|
Name: "check-git-daemon-export-ok",
|
|
IsDefault: false,
|
|
Run: checkDaemonExport,
|
|
Priority: 8,
|
|
})
|
|
Register(&Check{
|
|
Title: "Check commit-graphs",
|
|
Name: "check-commit-graphs",
|
|
IsDefault: false,
|
|
Run: checkCommitGraph,
|
|
Priority: 9,
|
|
})
|
|
}
|