Move hooks function to gitrepo and reduce expose repopath (#33890)

lunny · web-flow · commit 7fd44a85ca8e · 2025-03-16T16:12:55.000Z
Extract from #28966 Follow #33874
diff --git a/modules/gitrepo/hooks.go b/modules/gitrepo/hooks.go
@@ -1,9 +1,10 @@
 // Copyright 2020 The Gitea Authors. All rights reserved.
 // SPDX-License-Identifier: MIT
 
-package repository
+package gitrepo
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -105,10 +106,18 @@ done
 	return hookNames, hookTpls, giteaHookTpls
 }
 
-// CreateDelegateHooks creates all the hooks scripts for the repo
-func CreateDelegateHooks(repoPath string) (err error) {
+// CreateDelegateHooksForRepo creates all the hooks scripts for the repo
+func CreateDelegateHooksForRepo(_ context.Context, repo Repository) (err error) {
+	return createDelegateHooks(filepath.Join(repoPath(repo), "hooks"))
+}
+
+// CreateDelegateHooksForWiki creates all the hooks scripts for the wiki repo
+func CreateDelegateHooksForWiki(_ context.Context, repo Repository) (err error) {
+	return createDelegateHooks(filepath.Join(wikiPath(repo), "hooks"))
+}
+
+func createDelegateHooks(hookDir string) (err error) {
 	hookNames, hookTpls, giteaHookTpls := getHookTemplates()
-	hookDir := filepath.Join(repoPath, "hooks")
 
 	for i, hookName := range hookNames {
 		oldHookPath := filepath.Join(hookDir, hookName)
@@ -169,11 +178,19 @@ func ensureExecutable(filename string) error {
 	return os.Chmod(filename, mode)
 }
 
-// CheckDelegateHooks checks the hooks scripts for the repo
-func CheckDelegateHooks(repoPath string) ([]string, error) {
+// CheckDelegateHooksForRepo checks the hooks scripts for the repo
+func CheckDelegateHooksForRepo(_ context.Context, repo Repository) ([]string, error) {
+	return checkDelegateHooks(filepath.Join(repoPath(repo), "hooks"))
+}
+
+// CheckDelegateHooksForWiki checks the hooks scripts for the repo
+func CheckDelegateHooksForWiki(_ context.Context, repo Repository) ([]string, error) {
+	return checkDelegateHooks(filepath.Join(wikiPath(repo), "hooks"))
+}
+
+func checkDelegateHooks(hookDir string) ([]string, error) {
 	hookNames, hookTpls, giteaHookTpls := getHookTemplates()
 
-	hookDir := filepath.Join(repoPath, "hooks")
 	results := make([]string, 0, 10)
 
 	for i, hookName := range hookNames {
diff --git a/modules/repository/init.go b/modules/repository/init.go
@@ -138,7 +138,7 @@ func CheckInitRepository(ctx context.Context, repo *repo_model.Repository) (err
 	// Init git bare new repository.
 	if err = git.InitRepository(ctx, repo.RepoPath(), true, repo.ObjectFormatName); err != nil {
 		return fmt.Errorf("git.InitRepository: %w", err)
-	} else if err = CreateDelegateHooks(repo.RepoPath()); err != nil {
+	} else if err = gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {
 		return fmt.Errorf("createDelegateHooks: %w", err)
 	}
 	return nil
diff --git a/services/doctor/misc.go b/services/doctor/misc.go
@@ -18,7 +18,6 @@ import (
 	"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"
@@ -50,14 +49,14 @@ func checkScriptType(ctx context.Context, logger log.Logger, autofix bool) error
 
 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())
+		results, err := gitrepo.CheckDelegateHooksForRepo(ctx, repo)
 		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 {
+			if err := gitrepo.CreateDelegateHooksForRepo(ctx, repo); 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)
 			}
diff --git a/services/repository/adopt.go b/services/repository/adopt.go
@@ -115,7 +115,7 @@ func adoptRepository(ctx context.Context, repo *repo_model.Repository, defaultBr
 		return fmt.Errorf("adoptRepository: path does not already exist: %s", repo.FullName())
 	}
 
-	if err := repo_module.CreateDelegateHooks(repo.RepoPath()); err != nil {
+	if err := gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {
 		return fmt.Errorf("createDelegateHooks: %w", err)
 	}
 
diff --git a/services/repository/fork.go b/services/repository/fork.go
@@ -154,8 +154,7 @@ func ForkRepository(ctx context.Context, doer, owner *user_model.User, opts Fork
 		if opts.SingleBranch != "" {
 			cloneCmd.AddArguments("--single-branch", "--branch").AddDynamicArguments(opts.SingleBranch)
 		}
-		repoPath := repo_model.RepoPath(owner.Name, repo.Name)
-		if stdout, _, err := cloneCmd.AddDynamicArguments(oldRepoPath, repoPath).
+		if stdout, _, err := cloneCmd.AddDynamicArguments(oldRepoPath, repo.RepoPath()).
 			RunStdBytes(txCtx, &git.RunOpts{Timeout: 10 * time.Minute}); err != nil {
 			log.Error("Fork Repository (git clone) Failed for %v (from %v):\nStdout: %s\nError: %v", repo, opts.BaseRepo, stdout, err)
 			return fmt.Errorf("git clone: %w", err)
@@ -166,12 +165,12 @@ func ForkRepository(ctx context.Context, doer, owner *user_model.User, opts Fork
 		}
 
 		if stdout, _, err := git.NewCommand("update-server-info").
-			RunStdString(txCtx, &git.RunOpts{Dir: repoPath}); err != nil {
+			RunStdString(txCtx, &git.RunOpts{Dir: repo.RepoPath()}); err != nil {
 			log.Error("Fork Repository (git update-server-info) failed for %v:\nStdout: %s\nError: %v", repo, stdout, err)
 			return fmt.Errorf("git update-server-info: %w", err)
 		}
 
-		if err = repo_module.CreateDelegateHooks(repoPath); err != nil {
+		if err = gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {
 			return fmt.Errorf("createDelegateHooks: %w", err)
 		}
 
diff --git a/services/repository/hooks.go b/services/repository/hooks.go
@@ -12,7 +12,6 @@ import (
 	"code.gitea.io/gitea/models/webhook"
 	"code.gitea.io/gitea/modules/gitrepo"
 	"code.gitea.io/gitea/modules/log"
-	repo_module "code.gitea.io/gitea/modules/repository"
 
 	"xorm.io/builder"
 )
@@ -32,11 +31,11 @@ func SyncRepositoryHooks(ctx context.Context) error {
 			default:
 			}
 
-			if err := repo_module.CreateDelegateHooks(repo.RepoPath()); err != nil {
+			if err := gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {
 				return fmt.Errorf("SyncRepositoryHook: %w", err)
 			}
 			if repo.HasWiki() {
-				if err := repo_module.CreateDelegateHooks(repo.WikiPath()); err != nil {
+				if err := gitrepo.CreateDelegateHooksForWiki(ctx, repo); err != nil {
 					return fmt.Errorf("SyncRepositoryHook: %w", err)
 				}
 			}
diff --git a/services/repository/migrate.go b/services/repository/migrate.go
@@ -15,6 +15,7 @@ import (
 	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/lfs"
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/migration"
@@ -264,17 +265,16 @@ func cleanUpMigrateGitConfig(ctx context.Context, repoPath string) error {
 
 // CleanUpMigrateInfo finishes migrating repository and/or wiki with things that don't need to be done for mirrors.
 func CleanUpMigrateInfo(ctx context.Context, repo *repo_model.Repository) (*repo_model.Repository, error) {
-	repoPath := repo.RepoPath()
-	if err := repo_module.CreateDelegateHooks(repoPath); err != nil {
+	if err := gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {
 		return repo, fmt.Errorf("createDelegateHooks: %w", err)
 	}
 	if repo.HasWiki() {
-		if err := repo_module.CreateDelegateHooks(repo.WikiPath()); err != nil {
+		if err := gitrepo.CreateDelegateHooksForWiki(ctx, repo); err != nil {
 			return repo, fmt.Errorf("createDelegateHooks.(wiki): %w", err)
 		}
 	}
 
-	_, _, err := git.NewCommand("remote", "rm", "origin").RunStdString(ctx, &git.RunOpts{Dir: repoPath})
+	_, _, err := git.NewCommand("remote", "rm", "origin").RunStdString(ctx, &git.RunOpts{Dir: repo.RepoPath()})
 	if err != nil && !git.IsRemoteNotExistError(err) {
 		return repo, fmt.Errorf("CleanUpMigrateInfo: %w", err)
 	}
diff --git a/services/wiki/wiki.go b/services/wiki/wiki.go
@@ -41,7 +41,7 @@ func InitWiki(ctx context.Context, repo *repo_model.Repository) error {
 
 	if err := git.InitRepository(ctx, repo.WikiPath(), true, repo.ObjectFormatName); err != nil {
 		return fmt.Errorf("InitRepository: %w", err)
-	} else if err = repo_module.CreateDelegateHooks(repo.WikiPath()); err != nil {
+	} else if err = gitrepo.CreateDelegateHooksForWiki(ctx, repo); err != nil {
 		return fmt.Errorf("createDelegateHooks: %w", err)
 	} else if _, _, err = git.NewCommand("symbolic-ref", "HEAD").AddDynamicArguments(git.BranchPrefix+repo.DefaultWikiBranch).RunStdString(ctx, &git.RunOpts{Dir: repo.WikiPath()}); err != nil {
 		return fmt.Errorf("unable to set default wiki branch to %q: %w", repo.DefaultWikiBranch, err)

Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ func CheckInitRepository(ctx context.Context, repo *repo_model.Repository) (err`
`138`	`138`	`// Init git bare new repository.`
`139`	`139`	`if err = git.InitRepository(ctx, repo.RepoPath(), true, repo.ObjectFormatName); err != nil {`
`140`	`140`	`return fmt.Errorf("git.InitRepository: %w", err)`
`141`		`- } else if err = CreateDelegateHooks(repo.RepoPath()); err != nil {`
	`141`	`+ } else if err = gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {`
`142`	`142`	`return fmt.Errorf("createDelegateHooks: %w", err)`
`143`	`143`	`}`
`144`	`144`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ func adoptRepository(ctx context.Context, repo *repo_model.Repository, defaultBr`
`115`	`115`	`return fmt.Errorf("adoptRepository: path does not already exist: %s", repo.FullName())`
`116`	`116`	`}`
`117`	`117`
`118`		`- if err := repo_module.CreateDelegateHooks(repo.RepoPath()); err != nil {`
	`118`	`+ if err := gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {`
`119`	`119`	`return fmt.Errorf("createDelegateHooks: %w", err)`
`120`	`120`	`}`
`121`	`121`
Original file line number	Diff line number	Diff line change
`@@ -154,8 +154,7 @@ func ForkRepository(ctx context.Context, doer, owner *user_model.User, opts Fork`
`154`	`154`	`if opts.SingleBranch != "" {`
`155`	`155`	`cloneCmd.AddArguments("--single-branch", "--branch").AddDynamicArguments(opts.SingleBranch)`
`156`	`156`	`}`
`157`		`- repoPath := repo_model.RepoPath(owner.Name, repo.Name)`
`158`		`- if stdout, _, err := cloneCmd.AddDynamicArguments(oldRepoPath, repoPath).`
	`157`	`+ if stdout, _, err := cloneCmd.AddDynamicArguments(oldRepoPath, repo.RepoPath()).`
`159`	`158`	`RunStdBytes(txCtx, &git.RunOpts{Timeout: 10 * time.Minute}); err != nil {`
`160`	`159`	`log.Error("Fork Repository (git clone) Failed for %v (from %v):\nStdout: %s\nError: %v", repo, opts.BaseRepo, stdout, err)`
`161`	`160`	`return fmt.Errorf("git clone: %w", err)`
`@@ -166,12 +165,12 @@ func ForkRepository(ctx context.Context, doer, owner *user_model.User, opts Fork`
`166`	`165`	`}`
`167`	`166`
`168`	`167`	`if stdout, _, err := git.NewCommand("update-server-info").`
`169`		`- RunStdString(txCtx, &git.RunOpts{Dir: repoPath}); err != nil {`
	`168`	`+ RunStdString(txCtx, &git.RunOpts{Dir: repo.RepoPath()}); err != nil {`
`170`	`169`	`log.Error("Fork Repository (git update-server-info) failed for %v:\nStdout: %s\nError: %v", repo, stdout, err)`
`171`	`170`	`return fmt.Errorf("git update-server-info: %w", err)`
`172`	`171`	`}`
`173`	`172`
`174`		`- if err = repo_module.CreateDelegateHooks(repoPath); err != nil {`
	`173`	`+ if err = gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {`
`175`	`174`	`return fmt.Errorf("createDelegateHooks: %w", err)`
`176`	`175`	`}`
`177`	`176`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ import (`
`12`	`12`	`"code.gitea.io/gitea/models/webhook"`
`13`	`13`	`"code.gitea.io/gitea/modules/gitrepo"`
`14`	`14`	`"code.gitea.io/gitea/modules/log"`
`15`		`- repo_module "code.gitea.io/gitea/modules/repository"`
`16`	`15`
`17`	`16`	`"xorm.io/builder"`
`18`	`17`	`)`
`@@ -32,11 +31,11 @@ func SyncRepositoryHooks(ctx context.Context) error {`
`32`	`31`	`default:`
`33`	`32`	`}`
`34`	`33`
`35`		`- if err := repo_module.CreateDelegateHooks(repo.RepoPath()); err != nil {`
	`34`	`+ if err := gitrepo.CreateDelegateHooksForRepo(ctx, repo); err != nil {`
`36`	`35`	`return fmt.Errorf("SyncRepositoryHook: %w", err)`
`37`	`36`	`}`
`38`	`37`	`if repo.HasWiki() {`
`39`		`- if err := repo_module.CreateDelegateHooks(repo.WikiPath()); err != nil {`
	`38`	`+ if err := gitrepo.CreateDelegateHooksForWiki(ctx, repo); err != nil {`
`40`	`39`	`return fmt.Errorf("SyncRepositoryHook: %w", err)`
`41`	`40`	`}`
`42`	`41`	`}`