public/gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-10-06 18:00:18 +09:00
Code Issues Packages Projects Releases Wiki Activity

refactor: clarify GOOS detection (#39620)

Browse Source 
Introduce `consts.IsWindows`, now it's clearer to see how Windows build works
This commit is contained in:
wxiaoguang
2026-10-06 16:22:36 +08:00
committed by GitHub
parent 052f660ba5
commit 1065f03454
16 changed files with 44 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
models/asymkey/ssh_key_authorized_keys.go
+2 -1
View File
@@ -15,6 +15,7 @@ import (
"sync"
"gitea.dev/models/db"
"gitea.dev/modules/consts"
"gitea.dev/modules/log"
"gitea.dev/modules/setting"
"gitea.dev/modules/util"
@@ -135,7 +136,7 @@ func appendAuthorizedKeysToFile(keys ...*PublicKey) error {
defer f.Close()
// Note: chmod command does not support in Windows.
if !setting.IsWindows {
if !consts.IsWindows {
fi, err := f.Stat()
if err != nil {
return err
modules/consts/runtime.go
+8
View File
@@ -0,0 +1,8 @@
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package consts
import "runtime"
const IsWindows = runtime.GOOS == "windows"
modules/dump/dumper.go
+2 -2
View File
@@ -16,8 +16,8 @@ import (
"slices"
"strings"
"gitea.dev/modules/consts"
"gitea.dev/modules/log"
"gitea.dev/modules/setting"
"gitea.dev/modules/timeutil"
"github.com/mholt/archives"
@@ -184,7 +184,7 @@ func (dumper *Dumper) Close() error {
func (dumper *Dumper) normalizeFilePath(absPath string) string {
absPath = filepath.Clean(absPath)
if setting.IsWindows {
if consts.IsWindows {
absPath = strings.ToLower(absPath)
}
return absPath
modules/git/config.go
+2 -2
View File
@@ -8,9 +8,9 @@ import (
"fmt"
"os"
"regexp"
"runtime"
"strings"
"gitea.dev/modules/consts"
"gitea.dev/modules/git/gitcmd"
"gitea.dev/modules/setting"
)
@@ -90,7 +90,7 @@ func syncGitConfig(ctx context.Context) (err error) {
return err
}
if runtime.GOOS == "windows" {
if consts.IsWindows {
if err := configSet(ctx, "core.longpaths", "true"); err != nil {
return err
}
modules/git/git.go
-9
View File
@@ -10,7 +10,6 @@ import (
"fmt"
"os"
"path/filepath"
"runtime"
"strings"
"gitea.dev/modules/cache"
@@ -126,16 +125,8 @@ func checkGitVersionCompatibility(gitVer *version.Version) error {
func ensureGitVersion() error {
if !DefaultFeatures().CheckVersionAtLeast(RequiredVersion) {
moreHint := "get git: https://git-scm.com/downloads"
if runtime.GOOS == "linux" {
// there are a lot of CentOS/RHEL users using old git, so we add a special hint for them
if _, err := os.Stat("/etc/redhat-release"); err == nil {
// ius.io is the recommended official(git-scm.com) method to install git
moreHint = "get git: https://git-scm.com/downloads/linux and https://ius.io"
}
}
return fmt.Errorf("installed git version %q is not supported, Gitea requires git version >= %q, %s", DefaultFeatures().gitVersion.Original(), RequiredVersion, moreHint)
}
if err := checkGitVersionCompatibility(DefaultFeatures().gitVersion); err != nil {
return fmt.Errorf("installed git version %s has a known compatibility issue with Gitea: %w, please upgrade (or downgrade) git", DefaultFeatures().gitVersion.String(), err)
}
modules/git/hooks.go
+2 -2
View File
@@ -8,8 +8,8 @@ import (
"fmt"
"os"
"path/filepath"
"runtime"
"gitea.dev/modules/consts"
"gitea.dev/modules/git/gitrepo"
"gitea.dev/modules/setting"
"gitea.dev/modules/util"
@@ -156,7 +156,7 @@ func createDelegateHooks(hookDir string) (err error) {
func checkExecutable(filename string) bool {
// windows has no concept of a executable bit
if runtime.GOOS == "windows" {
if consts.IsWindows {
return true
}
fileInfo, err := os.Stat(filename)
modules/setting/path.go
+2 -1
View File
@@ -10,6 +10,7 @@ import (
"path/filepath"
"strings"
"gitea.dev/modules/consts"
"gitea.dev/modules/log"
"gitea.dev/modules/tempdir"
)
@@ -39,7 +40,7 @@ var (
func getAppPath() (string, error) {
var appPath string
var err error
if IsWindows && filepath.IsAbs(os.Args[0]) {
if consts.IsWindows && filepath.IsAbs(os.Args[0]) {
appPath = filepath.Clean(os.Args[0])
} else {
appPath, err = exec.LookPath(os.Args[0])
modules/setting/setting.go
+2 -4
View File
@@ -8,18 +8,16 @@ import (
"fmt"
"os"
"path/filepath"
"runtime"
"strings"
"time"
"gitea.dev/modules/consts"
"gitea.dev/modules/log"
"gitea.dev/modules/optional"
"gitea.dev/modules/user"
"gitea.dev/modules/util"
)
const IsWindows = runtime.GOOS == "windows"
var (
// AppVer is the version of the current build of Gitea. It is set in main.go from main.Version.
AppVer string
@@ -52,7 +50,7 @@ func init() {
// This check is ignored under Windows since SSH remote login is not the main
// method to login on Windows.
func IsRunUserMatchCurrentUser(runUser string) (string, bool) {
if IsWindows || SSH.StartBuiltinServer {
if consts.IsWindows || SSH.StartBuiltinServer {
return "", true
}
modules/setting/testenv.go
+2 -1
View File
@@ -12,6 +12,7 @@ import (
"strings"
"gitea.dev/modules/auth/password/hash"
"gitea.dev/modules/consts"
"gitea.dev/modules/log"
"gitea.dev/modules/util"
@@ -66,7 +67,7 @@ func SetupGiteaTestEnv() {
StaticRootPath = giteaRoot
// during testing, the AppPath must point to the pre-built Gitea binary in the source root
// it needs to be called by git hooks
AppPath = filepath.Join(giteaRoot, "gitea") + util.Iif(IsWindows, ".exe", "")
AppPath = filepath.Join(giteaRoot, "gitea") + util.Iif(consts.IsWindows, ".exe", "")
}
initGiteaConf := func() string {
modules/user/user.go
+5 -4
View File
@@ -6,19 +6,20 @@ package user
import (
"os"
"os/user"
"runtime"
"strings"
"gitea.dev/modules/consts"
)
// CurrentUsername return current login OS user name
// CurrentUsername return current login OS username
func CurrentUsername() string {
userinfo, err := user.Current()
if err != nil {
return fallbackCurrentUsername()
}
username := userinfo.Username
if runtime.GOOS == "windows" {
parts := strings.Split(username, "\\")
if consts.IsWindows {
parts := strings.Split(username, "\\") // remove domain if present
username = parts[len(parts)-1]
}
return username
modules/user/user_test.go
+3 -2
View File
@@ -5,10 +5,11 @@ package user
import (
"os/exec"
"runtime"
"strings"
"testing"
"gitea.dev/modules/consts"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -26,7 +27,7 @@ func TestCurrentUsername(t *testing.T) {
require.NotEmpty(t, user)
// Windows whoami is weird, so just skip remaining tests
if runtime.GOOS == "windows" {
if consts.IsWindows {
t.Skip("skipped test because of weird whoami on Windows")
}
whoami, err := getWhoamiOutput()
modules/util/file_retry.go
+3 -1
View File
@@ -8,6 +8,8 @@ import (
"os"
"syscall"
"time"
"gitea.dev/modules/consts"
)
// On Windows, when a file or directory is in use (opened), the file or directory is not able to be removed or renamed.
@@ -32,7 +34,7 @@ func retryWhenFileBusyInternal(count int, delay time.Duration, f func() error) (
break
}
isErrBusy := errors.Is(err, syscall.EBUSY)
isErrBusy = isErrBusy || (isOSWindows && errors.Is(err, errWindowsSharingViolationError))
isErrBusy = isErrBusy || (consts.IsWindows && errors.Is(err, errWindowsSharingViolationError))
if !isErrBusy {
break
}
modules/util/path.go
+6 -4
View File
@@ -13,6 +13,8 @@ import (
"regexp"
"strings"
"sync"
"gitea.dev/modules/consts"
)
var PathNameValidator = sync.OnceValue(func() (ret struct {
@@ -93,7 +95,7 @@ const filepathSeparator = string(os.PathSeparator)
func FilePathJoinAbs(base string, sub ...string) string {
// POSIX filesystem can have `\` in file names. Windows: `\` and `/` are both used for path separators
// to keep the behavior consistent, we do not allow `\` in file names, replace all `\` with `/`
if !isOSWindows {
if !consts.IsWindows {
base = strings.ReplaceAll(base, "\\", filepathSeparator)
}
if !filepath.IsAbs(base) {
@@ -110,7 +112,7 @@ func FilePathJoinAbs(base string, sub ...string) string {
if s == "" {
continue
}
if isOSWindows {
if consts.IsWindows {
elems = append(elems, filepath.Clean(filepathSeparator+s))
} else {
elems = append(elems, filepath.Clean(filepathSeparator+strings.ReplaceAll(s, "\\", filepathSeparator)))
@@ -284,7 +286,7 @@ func fileURLToPathInternal(u *url.URL, isWindows bool) (string, error) {
// FileURLToPath extracts the path information from a file://... url.
// It returns an error only if the URL is not a file URL.
func FileURLToPath(u *url.URL) (string, error) {
return fileURLToPathInternal(u, isOSWindows)
return fileURLToPathInternal(u, consts.IsWindows)
}
// HomeDir returns path of '~'(in Linux) on Windows,
@@ -293,7 +295,7 @@ func HomeDir() (home string, err error) {
// TODO: some users run Gitea with mismatched uid and "HOME=xxx" (they set HOME=xxx by environment manually)
// TODO: when running gitea as a sub command inside git, the HOME directory is not the user's home directory
// so at the moment we can not use `user.Current().HomeDir`
if isOSWindows {
if consts.IsWindows {
home = os.Getenv("USERPROFILE")
if home == "" {
home = os.Getenv("HOMEDRIVE") + os.Getenv("HOMEPATH")
modules/util/path_test.go
+3 -1
View File
@@ -9,6 +9,8 @@ import (
"path/filepath"
"testing"
"gitea.dev/modules/consts"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -182,7 +184,7 @@ func TestCleanPath(t *testing.T) {
}
// for POSIX only, but the result is similar on Windows, because the first element must be an absolute path
if isOSWindows {
if consts.IsWindows {
cases = []struct {
elems []string
expected string
modules/util/runtime.go
-2
View File
@@ -8,8 +8,6 @@ import (
"strings"
)
const isOSWindows = runtime.GOOS == "windows"
func CallerFuncName(optSkipParent ...int) string {
pc := make([]uintptr, 1)
skipParent := 0
routers/web/web.go
+2 -1
View File
@@ -11,6 +11,7 @@ import (
auth_model "gitea.dev/models/auth"
"gitea.dev/models/perm"
"gitea.dev/models/unit"
"gitea.dev/modules/consts"
"gitea.dev/modules/git"
"gitea.dev/modules/graceful"
"gitea.dev/modules/imagecaptcha"
@@ -118,7 +119,7 @@ func newWebAuthMiddleware() *AuthMiddleware {
webAuth.AllowOAuth2 = middlewareSetContextValue(keyAllowOAuth2{}, true)
webAuth.AllowDeployToken = middlewareSetContextValue(keyAllowDeployToken{}, true)
enableSSPI := setting.IsWindows && auth_model.IsSSPIEnabled(graceful.GetManager().ShutdownContext())
enableSSPI := consts.IsWindows && auth_model.IsSSPIEnabled(graceful.GetManager().ShutdownContext())
webAuth.MiddlewareHandler = func(ctx *context.Context) {
allowBasic := ctx.GetContextValue(keyAllowBasic{}) == true
allowOAuth2 := ctx.GetContextValue(keyAllowOAuth2{}) == true