Add configuration to allow customize global temp path

lunny · lunny · commit 178da3118bc7 · 2025-03-27T16:20:19.000-07:00
diff --git a/cmd/dump.go b/cmd/dump.go
@@ -49,7 +49,7 @@ var CmdDump = &cli.Command{
 		&cli.StringFlag{
 			Name:    "tempdir",
 			Aliases: []string{"t"},
-			Value:   setting.TempDir(),
+			Value:   setting.TempPath,
 			Usage:   "Temporary dir path",
 		},
 		&cli.StringFlag{
diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini
@@ -53,6 +53,9 @@ RUN_USER = ; git
 ;; The working directory, see the comment of AppWorkPath above
 ;WORK_PATH =
 
+;; The temporary directory, defaults to a directory named gitea under the system temporary directory
+;TEMP_PATH =
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 [server]
diff --git a/models/migrations/base/tests.go b/models/migrations/base/tests.go
@@ -15,6 +15,7 @@ import (
 	"code.gitea.io/gitea/models/unittest"
 	"code.gitea.io/gitea/modules/git"
 	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/temp"
 	"code.gitea.io/gitea/modules/test"
 	"code.gitea.io/gitea/modules/testlogger"
 
@@ -114,7 +115,7 @@ func MainTest(m *testing.M) {
 		setting.CustomConf = giteaConf
 	}
 
-	tmpDataPath, err := os.MkdirTemp(setting.TempDir(), "data")
+	tmpDataPath, _, err := temp.MkdirTemp("data")
 	if err != nil {
 		testlogger.Fatalf("Unable to create temporary data path %v\n", err)
 	}
diff --git a/models/unittest/testdb.go b/models/unittest/testdb.go
@@ -20,6 +20,7 @@ import (
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/setting/config"
 	"code.gitea.io/gitea/modules/storage"
+	"code.gitea.io/gitea/modules/temp"
 	"code.gitea.io/gitea/modules/test"
 	"code.gitea.io/gitea/modules/util"
 
@@ -92,12 +93,12 @@ func MainTest(m *testing.M, testOptsArg ...*TestOptions) {
 	setting.SSH.Domain = "try.gitea.io"
 	setting.Database.Type = "sqlite3"
 	setting.Repository.DefaultBranch = "master" // many test code still assume that default branch is called "master"
-	repoRootPath, err := os.MkdirTemp(setting.TempDir(), "repos")
+	repoRootPath, _, err := temp.MkdirTemp("repos")
 	if err != nil {
 		fatalTestError("TempDir: %v\n", err)
 	}
 	setting.RepoRootPath = repoRootPath
-	appDataPath, err := os.MkdirTemp(setting.TempDir(), "appdata")
+	appDataPath, _, err := temp.MkdirTemp("appdata")
 	if err != nil {
 		fatalTestError("TempDir: %v\n", err)
 	}
diff --git a/modules/git/blame.go b/modules/git/blame.go
@@ -11,7 +11,7 @@ import (
 	"os"
 
 	"code.gitea.io/gitea/modules/log"
-	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/temp"
 	"code.gitea.io/gitea/modules/util"
 )
 
@@ -193,7 +193,7 @@ func tryCreateBlameIgnoreRevsFile(commit *Commit) *string {
 	}
 	defer r.Close()
 
-	f, err := os.CreateTemp(setting.TempDir(), "gitea_git-blame-ignore-revs")
+	f, err := temp.CreateTemp("gitea_git-blame-ignore-revs")
 	if err != nil {
 		return nil
 	}
diff --git a/modules/git/git_test.go b/modules/git/git_test.go
@@ -10,18 +10,19 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/modules/setting"
-	"code.gitea.io/gitea/modules/util"
+	"code.gitea.io/gitea/modules/temp"
 
 	"github.com/hashicorp/go-version"
 	"github.com/stretchr/testify/assert"
 )
 
 func testRun(m *testing.M) error {
-	gitHomePath, err := os.MkdirTemp(setting.TempDir(), "git-home")
+	gitHomePath, cleanup, err := temp.MkdirTemp("git-home")
 	if err != nil {
 		return fmt.Errorf("unable to create temp dir: %w", err)
 	}
-	defer util.RemoveAll(gitHomePath)
+	defer cleanup()
+
 	setting.Git.HomePath = gitHomePath
 
 	if err = InitFull(context.Background()); err != nil {
diff --git a/modules/git/repo.go b/modules/git/repo.go
@@ -18,8 +18,7 @@ import (
 	"time"
 
 	"code.gitea.io/gitea/modules/proxy"
-	"code.gitea.io/gitea/modules/setting"
-	"code.gitea.io/gitea/modules/util"
+	"code.gitea.io/gitea/modules/temp"
 )
 
 // GPGSettings represents the default GPG settings for this repository
@@ -268,13 +267,11 @@ func GetDivergingCommits(ctx context.Context, repoPath, baseBranch, targetBranch
 
 // 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(setting.TempDir(), "gitea-bundle")
+	tmp, cleanup, err := temp.MkdirTemp("gitea-bundle")
 	if err != nil {
 		return err
 	}
-	defer func() {
-		_ = util.RemoveAll(tmp)
-	}()
+	defer cleanup()
 
 	env := append(os.Environ(), "GIT_OBJECT_DIRECTORY="+filepath.Join(repo.Path, "objects"))
 	_, _, err = NewCommand("init", "--bare").RunStdString(ctx, &RunOpts{Dir: tmp, Env: env})
diff --git a/modules/git/repo_index.go b/modules/git/repo_index.go
@@ -10,9 +10,7 @@ import (
 	"path/filepath"
 	"strings"
 
-	"code.gitea.io/gitea/modules/log"
-	"code.gitea.io/gitea/modules/setting"
-	"code.gitea.io/gitea/modules/util"
+	"code.gitea.io/gitea/modules/temp"
 )
 
 // ReadTreeToIndex reads a treeish to the index
@@ -60,26 +58,18 @@ func (repo *Repository) ReadTreeToTemporaryIndex(treeish string) (tmpIndexFilena
 		}
 	}()
 
-	removeDirFn := func(dir string) func() { // it can't use the return value "tmpDir" directly because it is empty when error occurs
-		return func() {
-			if err := util.RemoveAll(dir); err != nil {
-				log.Error("failed to remove tmp index dir: %v", err)
-			}
-		}
-	}
-
-	tmpDir, err = os.MkdirTemp(setting.TempDir(), "index")
+	tmpDir, cancel, err = temp.MkdirTemp("index")
 	if err != nil {
 		return "", "", nil, err
 	}
 
 	tmpIndexFilename = filepath.Join(tmpDir, ".tmp-index")
-	cancel = removeDirFn(tmpDir)
+
 	err = repo.ReadTreeToIndex(treeish, tmpIndexFilename)
 	if err != nil {
 		return "", "", cancel, err
 	}
-	return tmpIndexFilename, tmpDir, cancel, err
+	return tmpIndexFilename, tmpDir, cancel, nil
 }
 
 // EmptyIndex empties the index
diff --git a/modules/markup/external/external.go b/modules/markup/external/external.go
@@ -16,6 +16,7 @@ import (
 	"code.gitea.io/gitea/modules/markup"
 	"code.gitea.io/gitea/modules/process"
 	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/temp"
 	"code.gitea.io/gitea/modules/util"
 )
 
@@ -88,7 +89,7 @@ func (p *Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.
 
 	if p.IsInputFile {
 		// write to temp file
-		f, err := os.CreateTemp(setting.TempDir(), "gitea_input")
+		f, err := temp.CreateTemp("gitea_input")
 		if err != nil {
 			return fmt.Errorf("%s create temp file when rendering %s failed: %w", p.Name(), p.Command, err)
 		}
diff --git a/modules/repository/temp.go b/modules/repository/temp.go
@@ -17,9 +17,9 @@ import (
 // localCopyPath returns the local repository temporary copy path.
 func localCopyPath() string {
 	if setting.Repository.Local.LocalCopyPath == "" {
-		return filepath.Join(setting.TempDir(), "local-repo")
+		return filepath.Join(setting.TempPath, "local-repo")
 	} else if !filepath.IsAbs(setting.Repository.Local.LocalCopyPath) {
-		return filepath.Join(setting.TempDir(), setting.Repository.Local.LocalCopyPath)
+		return filepath.Join(setting.TempPath, setting.Repository.Local.LocalCopyPath)
 	}
 	return setting.Repository.Local.LocalCopyPath
 }
diff --git a/modules/setting/global.go b/modules/setting/global.go
@@ -3,13 +3,6 @@
 
 package setting
 
-import (
-	"log"
-	"os"
-	"path/filepath"
-	"sync"
-)
-
 // Global settings
 var (
 	// RunUser is the OS user that Gitea is running as. ini:"RUN_USER"
@@ -23,17 +16,6 @@ var (
 	// AppName is the Application name, used in the page title. ini: "APP_NAME"
 	AppName string
 
-	tempDir        string
-	createTempOnce sync.Once
+	// TempPath is the directory used for temporary files. ini: "TEMP_PATH"
+	TempPath string
 )
-
-// TempDir returns the OS temp directory
-func TempDir() string {
-	tempDir = filepath.Join(os.TempDir(), "gitea")
-	createTempOnce.Do(func() {
-		if err := os.MkdirAll(tempDir, os.ModePerm); err != nil {
-			log.Fatalf("Failed to create temp directory %s: %v", tempDir, err)
-		}
-	})
-	return tempDir
-}
diff --git a/modules/setting/setting.go b/modules/setting/setting.go
@@ -7,6 +7,7 @@ package setting
 import (
 	"fmt"
 	"os"
+	"path/filepath"
 	"runtime"
 	"strings"
 	"time"
@@ -110,6 +111,7 @@ func LoadCommonSettings() {
 func loadCommonSettingsFrom(cfg ConfigProvider) error {
 	// WARNING: don't change the sequence except you know what you are doing.
 	loadRunModeFrom(cfg)
+	loadTempDir(cfg)
 	loadLogGlobalFrom(cfg)
 	loadServerFrom(cfg)
 	loadSSHFrom(cfg)
@@ -182,6 +184,16 @@ func loadRunModeFrom(rootCfg ConfigProvider) {
 	}
 }
 
+func loadTempDir(rootCfg ConfigProvider) {
+	rootSec := rootCfg.Section("")
+	tempDir := rootSec.Key("TEMP_DIR").MustString(filepath.Join(os.TempDir(), "gitea"))
+	if tempDir != "" {
+		if err := os.MkdirAll(tempDir, os.ModePerm); err != nil {
+			log.Fatal("Failed to create temp directory %s: %v", tempDir, err)
+		}
+	}
+}
+
 // HasInstallLock checks the install-lock in ConfigProvider directly, because sometimes the config file is not loaded into setting variables yet.
 func HasInstallLock(rootCfg ConfigProvider) bool {
 	return rootCfg.Section("security").Key("INSTALL_LOCK").MustBool(false)
diff --git a/modules/setting/ssh.go b/modules/setting/ssh.go
@@ -122,7 +122,7 @@ func loadSSHFrom(rootCfg ConfigProvider) {
 	if len(serverMACs) > 0 {
 		SSH.ServerMACs = serverMACs
 	}
-	SSH.KeyTestPath = TempDir()
+	SSH.KeyTestPath = TempPath
 	if err = sec.MapTo(&SSH); err != nil {
 		log.Fatal("Failed to map SSH settings: %v", err)
 	}
diff --git a/modules/storage/local.go b/modules/storage/local.go
@@ -36,7 +36,7 @@ func NewLocalStorage(ctx context.Context, config *setting.Storage) (ObjectStorag
 	}
 
 	if config.TemporaryPath == "" {
-		config.TemporaryPath = filepath.Join(setting.TempDir(), filepath.Base(config.Path))
+		config.TemporaryPath = filepath.Join(setting.TempPath, filepath.Base(config.Path))
 	}
 	if !filepath.IsAbs(config.TemporaryPath) {
 		return nil, fmt.Errorf("LocalStorageConfig.TemporaryPath should be an absolute path, but not: %q", config.TemporaryPath)
diff --git a/modules/temp/temp.go b/modules/temp/temp.go
@@ -0,0 +1,28 @@
+// Copyright 2025 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package temp
+
+import (
+	"os"
+
+	"code.gitea.io/gitea/modules/log"
+	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/util"
+)
+
+func MkdirTemp(pattern string) (string, func(), error) {
+	dir, err := os.MkdirTemp(setting.TempPath, pattern)
+	if err != nil {
+		return "", nil, err
+	}
+	return dir, func() {
+		if err := util.RemoveAll(dir); err != nil {
+			log.Error("Failed to remove temp directory %s: %v", dir, err)
+		}
+	}, nil
+}
+
+func CreateTemp(pattern string) (*os.File, error) {
+	return os.CreateTemp(setting.TempPath, pattern)
+}
diff --git a/modules/util/filebuffer/file_backed_buffer.go b/modules/util/filebuffer/file_backed_buffer.go
@@ -75,7 +75,7 @@ func (b *FileBackedBuffer) Write(p []byte) (int, error) {
 		n, err = b.file.Write(p)
 	} else {
 		if b.size+int64(len(p)) > b.maxMemorySize {
-			b.file, err = os.CreateTemp(setting.TempDir(), "gitea-buffer-")
+			b.file, err = os.CreateTemp(setting.TempPath, "gitea-buffer-")
 			if err != nil {
 				return 0, err
 			}
diff --git a/routers/web/repo/githttp.go b/routers/web/repo/githttp.go
@@ -29,7 +29,7 @@ import (
 	repo_module "code.gitea.io/gitea/modules/repository"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/structs"
-	"code.gitea.io/gitea/modules/util"
+	"code.gitea.io/gitea/modules/temp"
 	"code.gitea.io/gitea/services/context"
 	repo_service "code.gitea.io/gitea/services/repository"
 
@@ -303,17 +303,12 @@ var (
 
 func dummyInfoRefs(ctx *context.Context) {
 	infoRefsOnce.Do(func() {
-		tmpDir, err := os.MkdirTemp(setting.TempDir(), "gitea-info-refs-cache")
+		tmpDir, cleanup, err := temp.MkdirTemp("gitea-info-refs-cache")
 		if err != nil {
 			log.Error("Failed to create temp dir for git-receive-pack cache: %v", err)
 			return
 		}
-
-		defer func() {
-			if err := util.RemoveAll(tmpDir); err != nil {
-				log.Error("RemoveAll: %v", err)
-			}
-		}()
+		defer cleanup()
 
 		if err := git.InitRepository(ctx, tmpDir, true, git.Sha1ObjectFormat.Name()); err != nil {
 			log.Error("Failed to init bare repo for git-receive-pack cache: %v", err)
diff --git a/services/pull/patch.go b/services/pull/patch.go
@@ -23,6 +23,7 @@ import (
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/process"
 	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/temp"
 	"code.gitea.io/gitea/modules/util"
 
 	"github.com/gobwas/glob"
@@ -355,23 +356,22 @@ func checkConflicts(ctx context.Context, pr *issues_model.PullRequest, gitRepo *
 	}
 
 	// 3b. Create a plain patch from head to base
-	tmpPatchFile, err := os.CreateTemp(setting.TempDir(), "patch")
+	tmpPatchFile, err := temp.CreateTemp("patch")
 	if err != nil {
 		log.Error("Unable to create temporary patch file! Error: %v", err)
 		return false, fmt.Errorf("unable to create temporary patch file! Error: %w", err)
 	}
 	defer func() {
+		tmpPatchFile.Close()
 		_ = util.Remove(tmpPatchFile.Name())
 	}()
 
 	if err := gitRepo.GetDiffBinary(pr.MergeBase+"...tracking", tmpPatchFile); err != nil {
-		tmpPatchFile.Close()
 		log.Error("Unable to get patch file from %s to %s in %s Error: %v", pr.MergeBase, pr.HeadBranch, pr.BaseRepo.FullName(), err)
 		return false, fmt.Errorf("unable to get patch file from %s to %s in %s Error: %w", pr.MergeBase, pr.HeadBranch, pr.BaseRepo.FullName(), err)
 	}
 	stat, err := tmpPatchFile.Stat()
 	if err != nil {
-		tmpPatchFile.Close()
 		return false, fmt.Errorf("unable to stat patch file: %w", err)
 	}
 	patchPath := tmpPatchFile.Name()
diff --git a/services/repository/create.go b/services/repository/create.go
diff --git a/services/repository/generate.go b/services/repository/generate.go

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ import (`
`15`	`15`	`"code.gitea.io/gitea/models/unittest"`
`16`	`16`	`"code.gitea.io/gitea/modules/git"`
`17`	`17`	`"code.gitea.io/gitea/modules/setting"`
	`18`	`+ "code.gitea.io/gitea/modules/temp"`
`18`	`19`	`"code.gitea.io/gitea/modules/test"`
`19`	`20`	`"code.gitea.io/gitea/modules/testlogger"`
`20`	`21`
`@@ -114,7 +115,7 @@ func MainTest(m *testing.M) {`
`114`	`115`	`setting.CustomConf = giteaConf`
`115`	`116`	`}`
`116`	`117`
`117`		`- tmpDataPath, err := os.MkdirTemp(setting.TempDir(), "data")`
	`118`	`+ tmpDataPath, _, err := temp.MkdirTemp("data")`
`118`	`119`	`if err != nil {`
`119`	`120`	`testlogger.Fatalf("Unable to create temporary data path %v\n", err)`
`120`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`"os"`
`12`	`12`
`13`	`13`	`"code.gitea.io/gitea/modules/log"`
`14`		`- "code.gitea.io/gitea/modules/setting"`
	`14`	`+ "code.gitea.io/gitea/modules/temp"`
`15`	`15`	`"code.gitea.io/gitea/modules/util"`
`16`	`16`	`)`
`17`	`17`
`@@ -193,7 +193,7 @@ func tryCreateBlameIgnoreRevsFile(commit Commit) string {`
`193`	`193`	`}`
`194`	`194`	`defer r.Close()`
`195`	`195`
`196`		`- f, err := os.CreateTemp(setting.TempDir(), "gitea_git-blame-ignore-revs")`
	`196`	`+ f, err := temp.CreateTemp("gitea_git-blame-ignore-revs")`
`197`	`197`	`if err != nil {`
`198`	`198`	`return nil`
`199`	`199`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ import (`
`16`	`16`	`"code.gitea.io/gitea/modules/markup"`
`17`	`17`	`"code.gitea.io/gitea/modules/process"`
`18`	`18`	`"code.gitea.io/gitea/modules/setting"`
	`19`	`+ "code.gitea.io/gitea/modules/temp"`
`19`	`20`	`"code.gitea.io/gitea/modules/util"`
`20`	`21`	`)`
`21`	`22`
`@@ -88,7 +89,7 @@ func (p Renderer) Render(ctx markup.RenderContext, input io.Reader, output io.`
`88`	`89`
`89`	`90`	`if p.IsInputFile {`
`90`	`91`	`// write to temp file`
`91`		`- f, err := os.CreateTemp(setting.TempDir(), "gitea_input")`
	`92`	`+ f, err := temp.CreateTemp("gitea_input")`
`92`	`93`	`if err != nil {`
`93`	`94`	`return fmt.Errorf("%s create temp file when rendering %s failed: %w", p.Name(), p.Command, err)`
`94`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,9 @@ import (`
`17`	`17`	`// localCopyPath returns the local repository temporary copy path.`
`18`	`18`	`func localCopyPath() string {`
`19`	`19`	`if setting.Repository.Local.LocalCopyPath == "" {`
`20`		`- return filepath.Join(setting.TempDir(), "local-repo")`
	`20`	`+ return filepath.Join(setting.TempPath, "local-repo")`
`21`	`21`	`} else if !filepath.IsAbs(setting.Repository.Local.LocalCopyPath) {`
`22`		`- return filepath.Join(setting.TempDir(), setting.Repository.Local.LocalCopyPath)`
	`22`	`+ return filepath.Join(setting.TempPath, setting.Repository.Local.LocalCopyPath)`
`23`	`23`	`}`
`24`	`24`	`return setting.Repository.Local.LocalCopyPath`
`25`	`25`	`}`