Support reflogs

Signed-off-by: Philip Peterson <philip.c.peterson@gmail.com>

Author: philip-peterson

custom/conf/app.example.ini

@@ -2145,6 +2145,18 @@ ROUTER = console
 ;NOTICE_ON_SUCCESS = false
 ;SCHEDULE = @every 72h
 
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; Resynchronize Git configurations of all repositories.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;[cron.resync_all_configs]
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;ENABLED = false
+;RUN_AT_START = false
+;NOTICE_ON_SUCCESS = false
+;SCHEDULE = @every 72h
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; Reinitialize all missing Git repositories for which records exist
@@ -2256,6 +2268,17 @@ ROUTER = console
 ;PULL = 300
 ;GC = 60
 
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; Git Reflog timeout in days
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;[git.reflog]
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;ENABLED = true
+;EXPIRATION = 90
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;[mirror]

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -1011,6 +1011,13 @@ Default templates for project boards:
 - `NOTICE_ON_SUCCESS`: **false**: Set to true to switch on success notices.
 - `SCHEDULE`: **@every 72h**: Cron syntax for scheduling repository archive cleanup, e.g. `@every 1h`.
 
+#### Cron - Resynchronize Git configs of all repositories ('cron.resync_all_configs')
+
+- `ENABLED`: **false**: Enable service.
+- `RUN_AT_START`: **false**: Run tasks at start up time (if ENABLED).
+- `NOTICE_ON_SUCCESS`: **false**: Set to true to switch on success notices.
+- `SCHEDULE`: **@every 72h**: Cron syntax for scheduling repository archive cleanup, e.g. `@every 1h`.
+
 #### Cron - Reinitialize all missing Git repositories for which records exist ('cron.reinit_missing_repos')
 
 - `ENABLED`: **false**: Enable service.

modules/git/repo.go

@@ -18,6 +18,7 @@ import (
 	"time"
 
 	"code.gitea.io/gitea/modules/proxy"
+	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
 )
 
@@ -302,6 +303,47 @@ func GetDivergingCommits(ctx context.Context, repoPath, baseBranch, targetBranch
 	return DivergeObject{ahead, behind}, nil
 }
 
+// CreateConfig creates a git config for the repo
+func CreateConfig(repoPath string) error {
+	return createConfig(repoPath)
+}
+
+// createConfig creates a git config for the repo
+func createConfig(repoPath string) (err error) {
+	gitConfigPath := filepath.Join(repoPath, "config")
+
+	reflogEnabled := setting.Git.Reflog.Enabled
+	reflogExpirationDays := setting.Git.Reflog.Expiration
+
+	configStr := strings.TrimSpace(`
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = true
+	ignorecase = true
+	precomposeunicode = true
+`)
+
+	if reflogEnabled {
+		configStr += "\n	logAllRefUpdates = true"
+		if reflogExpirationDays != 90 {
+			configStr += "\n[gc]"
+			configStr += fmt.Sprintf("\n	reflogExpire = %d", reflogExpirationDays)
+		}
+	}
+
+	configStr += "\n"
+
+	if err = util.Remove(gitConfigPath); err != nil && !os.IsNotExist(err) {
+		return fmt.Errorf("unable to pre-remove config file '%s' prior to rewriting: %w ", gitConfigPath, err)
+	}
+	if err = os.WriteFile(gitConfigPath, []byte(configStr), 0o644); err != nil {
+		return fmt.Errorf("write config file '%s': %w", gitConfigPath, err)
+	}
+
+	return nil
+}
+
 // CreateBundle create bundle content to the target path
 func (repo *Repository) CreateBundle(ctx context.Context, commit string, out io.Writer) error {
 	tmp, err := os.MkdirTemp(os.TempDir(), "gitea-bundle")

modules/repository/init.go

@@ -277,6 +277,8 @@ func checkInitRepository(ctx context.Context, owner, name string) (err error) {
 	// Init git bare new repository.
 	if err = git.InitRepository(ctx, repoPath, true); err != nil {
 		return fmt.Errorf("git.InitRepository: %w", err)
+	} else if err = git.CreateConfig(repoPath); err != nil {
+		return fmt.Errorf("git.CreateConfig: %v", err)
 	} else if err = createDelegateHooks(repoPath); err != nil {
 		return fmt.Errorf("createDelegateHooks: %w", err)
 	}

modules/setting/git.go

@@ -12,9 +12,13 @@ import (
 
 // Git settings
 var Git = struct {
-	Path                      string
-	HomePath                  string
-	DisableDiffHighlight      bool
+	Path                 string
+	HomePath             string
+	DisableDiffHighlight bool
+	Reflog               struct {
+		Enabled    bool
+		Expiration int
+	} `ini:"git.reflog"`
 	MaxGitDiffLines           int
 	MaxGitDiffLineCharacters  int
 	MaxGitDiffFiles           int
@@ -37,6 +41,13 @@ var Git = struct {
 		GC      int `ini:"GC"`
 	} `ini:"git.timeout"`
 }{
+	Reflog: struct {
+		Enabled    bool
+		Expiration int
+	}{
+		Enabled:    false,
+		Expiration: 90,
+	},
 	DisableDiffHighlight:      false,
 	MaxGitDiffLines:           1000,
 	MaxGitDiffLineCharacters:  5000,

options/locale/locale_en-US.ini

@@ -2543,6 +2543,7 @@ dashboard.resync_all_sshkeys.desc = (Not needed for the built-in SSH server.)
 dashboard.resync_all_sshprincipals = Update the '.ssh/authorized_principals' file with Gitea SSH principals.
 dashboard.resync_all_sshprincipals.desc = (Not needed for the built-in SSH server.)
 dashboard.resync_all_hooks = Resynchronize pre-receive, update and post-receive hooks of all repositories.
+dashboard.resync_all_configs = Resynchronize Git configuration of all repositories.
 dashboard.reinit_missing_repos = Reinitialize all missing Git repositories for which records exist
 dashboard.sync_external_users = Synchronize external user data
 dashboard.cleanup_hook_task_table = Cleanup hook_task table
@@ -2928,6 +2929,8 @@ config.git_disable_diff_highlight = Disable Diff Syntax Highlight
 config.git_max_diff_lines = Max Diff Lines (for a single file)
 config.git_max_diff_line_characters = Max Diff Characters (for a single line)
 config.git_max_diff_files = Max Diff Files (to be shown)
+config.git_enable_reflogs = Enable Reflogs
+config.git_reflog_expiry_time = Expiry Time
 config.git_gc_args = GC Arguments
 config.git_migrate_timeout = Migration Timeout
 config.git_mirror_timeout = Mirror Update Timeout

services/cron/tasks_extended.go

@@ -95,6 +95,16 @@ func registerRepositoryUpdateHook() {
 	})
 }
 
+func registerRepositoryUpdateConfig() {
+	RegisterTaskFatal("resync_all_configs", &BaseConfig{
+		Enabled:    false,
+		RunAtStart: false,
+		Schedule:   "@every 72h",
+	}, func(ctx context.Context, _ *user_model.User, _ Config) error {
+		return repo_service.SyncRepositoryConfig(ctx)
+	})
+}
+
 func registerReinitMissingRepositories() {
 	RegisterTaskFatal("reinit_missing_repos", &BaseConfig{
 		Enabled:    false,
@@ -220,6 +230,7 @@ func initExtendedTasks() {
 	registerRewriteAllPublicKeys()
 	registerRewriteAllPrincipalKeys()
 	registerRepositoryUpdateHook()
+	registerRepositoryUpdateConfig()
 	registerReinitMissingRepositories()
 	registerDeleteMissingRepositories()
 	registerRemoveRandomAvatars()

services/repository/config.go

@@ -0,0 +1,49 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package repository
+
+import (
+	"context"
+	"fmt"
+
+	"code.gitea.io/gitea/models/db"
+	repo_model "code.gitea.io/gitea/models/repo"
+	"code.gitea.io/gitea/modules/git"
+	"code.gitea.io/gitea/modules/log"
+
+	"xorm.io/builder"
+)
+
+// SyncRepositoryConfig rewrites all repositories' pre-receive, update and post-receive hooks
+// to make sure the binary and custom conf path are up-to-date.
+func SyncRepositoryConfig(ctx context.Context) error {
+	log.Trace("Doing: SyncRepositoryConfig")
+
+	if err := db.Iterate(
+		ctx,
+		builder.Gt{"id": 0},
+		func(ctx context.Context, repo *repo_model.Repository) error {
+			select {
+			case <-ctx.Done():
+				return db.ErrCancelledf("before sync repository config for %s", repo.FullName())
+			default:
+			}
+
+			if err := git.CreateConfig(repo.RepoPath()); err != nil {
+				return fmt.Errorf("SyncRepositoryConfig: %w", err)
+			}
+			if repo.HasWiki() {
+				if err := git.CreateConfig(repo.WikiPath()); err != nil {
+					return fmt.Errorf("SyncRepositoryConfig: %w", err)
+				}
+			}
+			return nil
+		},
+	); err != nil {
+		return err
+	}
+
+	log.Trace("Finished: SyncRepositoryConfig")
+	return nil
+}

templates/admin/config.tmpl

@@ -331,7 +331,19 @@
 				<dd>{{.Git.MaxGitDiffFiles}}</dd>
 				<dt>{{.locale.Tr "admin.config.git_gc_args"}}</dt>
 				<dd><code>{{.Git.GCArgs}}</code></dd>
+
 				<div class="ui divider"></div>
+
+				<dt>{{.locale.Tr "admin.config.git_enable_reflogs"}}</dt>
+				<dd>{{if .Git.Reflog.Enabled}}{{svg "octicon-check"}}{{else}}{{svg "octicon-x"}}{{end}}</dd>
+
+				{{if .Git.Reflog.Enabled }}
+					<dt>{{.locale.Tr "admin.config.git_reflog_expiry_time"}}</dt>
+					<dd>{{.locale.Tr "tool.days" .Git.Reflog.Expiration}}</dd>
+				{{end}}
+
+				<div class="ui divider"></div>
+
 				<dt>{{.locale.Tr "admin.config.git_migrate_timeout"}}</dt>
 				<dd>{{.Git.Timeout.Migrate}} {{.locale.Tr "tool.raw_seconds"}}</dd>
 				<dt>{{.locale.Tr "admin.config.git_mirror_timeout"}}</dt>

templates/admin/dashboard.tmpl

@@ -56,6 +56,10 @@
 							<td>{{.locale.Tr "admin.dashboard.resync_all_hooks"}}</td>
 							<td><button type="submit" class="ui green button" name="op" value="resync_all_hooks">{{svg "octicon-play"}} {{.locale.Tr "admin.dashboard.operation_run"}}</button></td>
 						</tr>
+						<tr>
+							<td>{{.locale.Tr "admin.dashboard.resync_all_configs"}}</td>
+							<td><button type="submit" class="ui green button" name="op" value="resync_all_configs">{{svg "octicon-play"}} {{.locale.Tr "admin.dashboard.operation_run"}}</button></td>
+						</tr>
 						<tr>
 							<td>{{.locale.Tr "admin.dashboard.reinit_missing_repos"}}</td>
 							<td><button type="submit" class="ui green button" name="op" value="reinit_missing_repos">{{svg "octicon-play"}} {{.locale.Tr "admin.dashboard.operation_run"}}</button></td>