2016-11-03 18:16:01 -04:00
// Copyright 2015 The Gogs Authors. All rights reserved.
2017-04-28 10:20:58 -04:00
// Copyright 2017 The Gitea Authors. All rights reserved.
2016-11-03 18:16:01 -04:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package git
import (
2019-11-30 09:40:22 -05:00
"context"
2016-11-03 18:16:01 -04:00
"fmt"
2022-05-02 08:30:24 -04:00
"os"
2019-04-17 07:11:37 -04:00
"os/exec"
2022-06-09 21:57:49 -04:00
"path/filepath"
2019-11-02 01:40:49 -04:00
"runtime"
2016-11-03 18:16:01 -04:00
"strings"
2022-06-09 21:57:49 -04:00
"sync"
2016-11-03 18:16:01 -04:00
"time"
2017-04-28 10:20:58 -04:00
2022-06-09 21:57:49 -04:00
"code.gitea.io/gitea/modules/log"
2021-06-26 07:28:55 -04:00
"code.gitea.io/gitea/modules/setting"
2019-05-14 21:57:00 -04:00
2020-09-05 12:42:58 -04:00
"github.com/hashicorp/go-version"
2016-11-03 18:16:01 -04:00
)
var (
2017-04-28 10:20:58 -04:00
// GitVersionRequired is the minimum Git version required
2022-05-02 08:30:24 -04:00
// At the moment, all code for git 1.x are not changed, if some users want to test with old git client
// or bypass the check, they still have a chance to edit this variable manually.
// If everything works fine, the code for git 1.x could be removed in a separate PR before 1.17 frozen.
GitVersionRequired = "2.0.0"
2019-04-17 07:11:37 -04:00
// GitExecutable is the command name of git
// Could be updated to an absolute path while initialization
GitExecutable = "git"
2019-05-14 21:57:00 -04:00
2019-11-30 09:40:22 -05:00
// DefaultContext is the default context to run git commands in
2022-06-09 21:57:49 -04:00
// will be overwritten by InitWithConfigSync with HammerContext
2019-11-30 09:40:22 -05:00
DefaultContext = context . Background ( )
2021-07-28 05:42:56 -04:00
// SupportProcReceive version >= 2.29.0
SupportProcReceive bool
2016-11-03 18:16:01 -04:00
2022-06-09 21:57:49 -04:00
// initMutex is used to avoid Golang's data race error. see the comments below.
initMutex sync . Mutex
gitVersion * version . Version
)
2020-09-05 12:42:58 -04:00
2022-06-09 21:57:49 -04:00
// loadGitVersion returns current Git version from shell. Internal usage only.
func loadGitVersion ( ) ( * version . Version , error ) {
2020-09-05 12:42:58 -04:00
// doesn't need RWMutex because its exec by Init()
if gitVersion != nil {
2022-06-09 21:57:49 -04:00
return gitVersion , nil
2016-11-03 18:16:01 -04:00
}
2022-06-09 21:57:49 -04:00
stdout , _ , runErr := NewCommand ( DefaultContext , "version" ) . RunStdString ( nil )
2022-03-31 22:55:30 -04:00
if runErr != nil {
2022-06-09 21:57:49 -04:00
return nil , runErr
2016-11-03 18:16:01 -04:00
}
fields := strings . Fields ( stdout )
if len ( fields ) < 3 {
2022-06-09 21:57:49 -04:00
return nil , fmt . Errorf ( "invalid git version output: %s" , stdout )
2016-11-03 18:16:01 -04:00
}
2020-09-05 12:42:58 -04:00
var versionString string
2016-11-03 18:16:01 -04:00
// Handle special case on Windows.
i := strings . Index ( fields [ 2 ] , "windows" )
if i >= 1 {
2020-09-05 12:42:58 -04:00
versionString = fields [ 2 ] [ : i - 1 ]
} else {
versionString = fields [ 2 ]
2016-11-03 18:16:01 -04:00
}
2022-03-31 22:55:30 -04:00
var err error
2020-09-05 12:42:58 -04:00
gitVersion , err = version . NewVersion ( versionString )
2022-06-09 21:57:49 -04:00
return gitVersion , err
2016-11-03 18:16:01 -04:00
}
2019-07-07 03:26:56 -04:00
// SetExecutablePath changes the path of git executable and checks the file permission and version.
func SetExecutablePath ( path string ) error {
// If path is empty, we use the default value of GitExecutable "git" to search for the location of git.
if path != "" {
GitExecutable = path
}
2019-04-17 07:11:37 -04:00
absPath , err := exec . LookPath ( GitExecutable )
if err != nil {
2022-05-02 08:30:24 -04:00
return fmt . Errorf ( "git not found: %w" , err )
2019-04-17 07:11:37 -04:00
}
GitExecutable = absPath
2022-06-09 21:57:49 -04:00
_ , err = loadGitVersion ( )
2017-04-28 10:20:58 -04:00
if err != nil {
2022-05-02 08:30:24 -04:00
return fmt . Errorf ( "unable to load git version: %w" , err )
2017-04-28 10:20:58 -04:00
}
2020-09-05 12:42:58 -04:00
versionRequired , err := version . NewVersion ( GitVersionRequired )
if err != nil {
return err
}
if gitVersion . LessThan ( versionRequired ) {
2022-05-02 08:30:24 -04:00
moreHint := "get git: https://git-scm.com/download/"
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/download/linux and https://ius.io"
}
}
return fmt . Errorf ( "installed git version %q is not supported, Gitea requires git version >= %q, %s" , gitVersion . Original ( ) , GitVersionRequired , moreHint )
2017-04-28 10:20:58 -04:00
}
2019-07-07 03:26:56 -04:00
return nil
2019-06-19 12:53:37 -04:00
}
2019-05-14 21:57:00 -04:00
2021-06-26 07:28:55 -04:00
// VersionInfo returns git version information
func VersionInfo ( ) string {
2022-06-09 21:57:49 -04:00
if gitVersion == nil {
return "(git not found)"
}
format := "%s"
2022-01-20 12:46:10 -05:00
args := [ ] interface { } { gitVersion . Original ( ) }
2021-06-26 07:28:55 -04:00
// Since git wire protocol has been released from git v2.18
if setting . Git . EnableAutoGitWireProtocol && CheckGitVersionAtLeast ( "2.18" ) == nil {
format += ", Wire Protocol %s Enabled"
args = append ( args , "Version 2" ) // for focus color
}
return fmt . Sprintf ( format , args ... )
}
2022-06-09 21:57:49 -04:00
// InitSimple initializes git module with a very simple step, no config changes, no global command arguments.
// This method doesn't change anything to filesystem
func InitSimple ( ctx context . Context ) error {
initMutex . Lock ( )
defer initMutex . Unlock ( )
return initSimpleInternal ( ctx )
}
// HomeDir is the home dir for git to store the global config file used by Gitea internally
func HomeDir ( ) string {
if setting . RepoRootPath == "" {
// TODO: now, some unit test code call the git module directly without initialization, which is incorrect.
// at the moment, we just use a temp HomeDir to prevent from conflicting with user's git config
// in the future, the git module should be initialized first before use.
tmpHomeDir := filepath . Join ( os . TempDir ( ) , "gitea-temp-home" )
log . Error ( "Git's HomeDir is empty (RepoRootPath is empty), the git module is not initialized correctly, using a temp HomeDir (%s) temporarily" , tmpHomeDir )
return tmpHomeDir
}
return setting . RepoRootPath
}
func initSimpleInternal ( ctx context . Context ) error {
// at the moment, when running integration tests, the git.InitXxx would be called twice.
// one is called by the GlobalInitInstalled, one is called by TestMain.
// so the init functions should be protected by a mutex to avoid Golang's data race error.
2019-12-15 04:51:28 -05:00
DefaultContext = ctx
2020-09-05 12:42:58 -04:00
2022-03-31 07:56:22 -04:00
if setting . Git . Timeout . Default > 0 {
defaultCommandExecutionTimeout = time . Duration ( setting . Git . Timeout . Default ) * time . Second
}
2021-06-26 07:28:55 -04:00
if err := SetExecutablePath ( setting . Git . Path ) ; err != nil {
return err
}
// force cleanup args
2022-01-25 13:15:58 -05:00
globalCommandArgs = [ ] string { }
2021-06-26 07:28:55 -04:00
2022-06-09 21:57:49 -04:00
return nil
}
// InitWithConfigSync initializes git module. This method may create directories or write files into filesystem
func InitWithConfigSync ( ctx context . Context ) error {
initMutex . Lock ( )
defer initMutex . Unlock ( )
err := initSimpleInternal ( ctx )
if err != nil {
return err
}
if err = os . MkdirAll ( setting . RepoRootPath , os . ModePerm ) ; err != nil {
return fmt . Errorf ( "unable to create directory %s, err: %w" , setting . RepoRootPath , err )
}
2021-06-26 07:28:55 -04:00
if CheckGitVersionAtLeast ( "2.9" ) == nil {
// Explicitly disable credential helper, otherwise Git credentials might leak
2022-01-25 13:15:58 -05:00
globalCommandArgs = append ( globalCommandArgs , "-c" , "credential.helper=" )
2021-06-26 07:28:55 -04:00
}
// Since git wire protocol has been released from git v2.18
if setting . Git . EnableAutoGitWireProtocol && CheckGitVersionAtLeast ( "2.18" ) == nil {
2022-01-25 13:15:58 -05:00
globalCommandArgs = append ( globalCommandArgs , "-c" , "protocol.version=2" )
2021-06-26 07:28:55 -04:00
}
2022-01-06 00:38:38 -05:00
// By default partial clones are disabled, enable them from git v2.22
if ! setting . Git . DisablePartialClone && CheckGitVersionAtLeast ( "2.22" ) == nil {
2022-04-20 11:52:16 -04:00
globalCommandArgs = append ( globalCommandArgs , "-c" , "uploadpack.allowfilter=true" , "-c" , "uploadpack.allowAnySHA1InWant=true" )
2022-01-06 00:38:38 -05:00
}
2022-06-09 21:57:49 -04:00
// Git requires setting user.name and user.email in order to commit changes - old comment: "if they're not set just add some defaults"
// TODO: need to confirm whether users really need to change these values manually. It seems that these values are dummy only and not really used.
// If these values are not really used, then they can be set (overwritten) directly without considering about existence.
for configKey , defaultValue := range map [ string ] string {
"user.name" : "Gitea" ,
"user.email" : "gitea@fake.local" ,
} {
if err := configSetNonExist ( configKey , defaultValue ) ; err != nil {
2020-06-13 17:47:31 -04:00
return err
2019-05-14 21:57:00 -04:00
}
}
2020-06-13 17:47:31 -04:00
// Set git some configurations - these must be set to these values for gitea to work correctly
2022-06-09 21:57:49 -04:00
if err := configSet ( "core.quotePath" , "false" ) ; err != nil {
2020-06-13 17:47:31 -04:00
return err
2019-05-14 21:57:00 -04:00
}
2019-06-29 07:46:25 -04:00
2020-10-21 11:42:08 -04:00
if CheckGitVersionAtLeast ( "2.10" ) == nil {
2022-06-09 21:57:49 -04:00
if err := configSet ( "receive.advertisePushOptions" , "true" ) ; err != nil {
2020-08-23 12:02:35 -04:00
return err
}
}
2020-10-21 11:42:08 -04:00
if CheckGitVersionAtLeast ( "2.18" ) == nil {
2022-06-09 21:57:49 -04:00
if err := configSet ( "core.commitGraph" , "true" ) ; err != nil {
2020-06-13 17:47:31 -04:00
return err
2019-06-29 07:46:25 -04:00
}
2022-06-09 21:57:49 -04:00
if err := configSet ( "gc.writeCommitGraph" , "true" ) ; err != nil {
2020-06-13 17:47:31 -04:00
return err
2019-06-29 07:46:25 -04:00
}
}
2019-11-02 01:40:49 -04:00
2021-07-28 05:42:56 -04:00
if CheckGitVersionAtLeast ( "2.29" ) == nil {
// set support for AGit flow
2022-06-09 21:57:49 -04:00
if err := configAddNonExist ( "receive.procReceiveRefs" , "refs/for" ) ; err != nil {
2021-07-28 05:42:56 -04:00
return err
}
SupportProcReceive = true
} else {
2022-06-09 21:57:49 -04:00
if err := configUnsetAll ( "receive.procReceiveRefs" , "refs/for" ) ; err != nil {
2021-07-28 05:42:56 -04:00
return err
}
SupportProcReceive = false
}
2019-11-02 01:40:49 -04:00
if runtime . GOOS == "windows" {
2022-06-09 21:57:49 -04:00
if err := configSet ( "core.longpaths" , "true" ) ; err != nil {
2020-06-13 17:47:31 -04:00
return err
}
2022-06-09 21:57:49 -04:00
if setting . Git . DisableCoreProtectNTFS {
err = configSet ( "core.protectNTFS" , "false" )
} else {
err = configUnsetAll ( "core.protectNTFS" , "false" )
}
if err != nil {
2021-10-13 14:20:11 -04:00
return err
}
}
2022-06-09 21:57:49 -04:00
2020-06-13 17:47:31 -04:00
return nil
}
2020-10-21 11:42:08 -04:00
// CheckGitVersionAtLeast check git version is at least the constraint version
func CheckGitVersionAtLeast ( atLeast string ) error {
2022-06-09 21:57:49 -04:00
if _ , err := loadGitVersion ( ) ; err != nil {
2020-09-05 12:42:58 -04:00
return err
}
2020-10-21 11:42:08 -04:00
atLeastVersion , err := version . NewVersion ( atLeast )
2020-09-05 12:42:58 -04:00
if err != nil {
return err
}
2020-10-21 11:42:08 -04:00
if gitVersion . Compare ( atLeastVersion ) < 0 {
return fmt . Errorf ( "installed git binary version %s is not at least %s" , gitVersion . Original ( ) , atLeast )
2020-09-05 12:42:58 -04:00
}
return nil
}
2022-06-09 21:57:49 -04:00
func configSet ( key , value string ) error {
stdout , _ , err := NewCommand ( DefaultContext , "config" , "--get" , key ) . RunStdString ( nil )
if err != nil && ! err . IsExitCode ( 1 ) {
return fmt . Errorf ( "failed to get git config %s, err: %w" , key , err )
2020-06-13 17:47:31 -04:00
}
currValue := strings . TrimSpace ( stdout )
2022-06-09 21:57:49 -04:00
if currValue == value {
2020-06-13 17:47:31 -04:00
return nil
2019-11-02 01:40:49 -04:00
}
2020-06-13 17:47:31 -04:00
2022-06-09 21:57:49 -04:00
_ , _ , err = NewCommand ( DefaultContext , "config" , "--global" , key , value ) . RunStdString ( nil )
if err != nil {
return fmt . Errorf ( "failed to set git global config %s, err: %w" , key , err )
2020-06-13 17:47:31 -04:00
}
2019-06-19 12:53:37 -04:00
return nil
2016-11-03 18:16:01 -04:00
}
2022-06-09 21:57:49 -04:00
func configSetNonExist ( key , value string ) error {
_ , _ , err := NewCommand ( DefaultContext , "config" , "--get" , key ) . RunStdString ( nil )
if err == nil {
// already exist
return nil
}
if err . IsExitCode ( 1 ) {
// not exist, set new config
_ , _ , err = NewCommand ( DefaultContext , "config" , "--global" , key , value ) . RunStdString ( nil )
if err != nil {
return fmt . Errorf ( "failed to set git global config %s, err: %w" , key , err )
2021-07-28 05:42:56 -04:00
}
2022-06-09 21:57:49 -04:00
return nil
2021-07-28 05:42:56 -04:00
}
2022-06-09 21:57:49 -04:00
return fmt . Errorf ( "failed to get git config %s, err: %w" , key , err )
2021-07-28 05:42:56 -04:00
}
2022-06-09 21:57:49 -04:00
func configAddNonExist ( key , value string ) error {
_ , _ , err := NewCommand ( DefaultContext , "config" , "--fixed-value" , "--get" , key , value ) . RunStdString ( nil )
if err == nil {
// already exist
return nil
}
if err . IsExitCode ( 1 ) {
// not exist, add new config
_ , _ , err = NewCommand ( DefaultContext , "config" , "--global" , "--add" , key , value ) . RunStdString ( nil )
if err != nil {
return fmt . Errorf ( "failed to add git global config %s, err: %w" , key , err )
2021-07-28 05:42:56 -04:00
}
2022-06-09 21:57:49 -04:00
return nil
2021-07-28 05:42:56 -04:00
}
2022-06-09 21:57:49 -04:00
return fmt . Errorf ( "failed to get git config %s, err: %w" , key , err )
}
2021-07-28 05:42:56 -04:00
2022-06-09 21:57:49 -04:00
func configUnsetAll ( key , value string ) error {
_ , _ , err := NewCommand ( DefaultContext , "config" , "--get" , key ) . RunStdString ( nil )
if err == nil {
// exist, need to remove
_ , _ , err = NewCommand ( DefaultContext , "config" , "--global" , "--fixed-value" , "--unset-all" , key , value ) . RunStdString ( nil )
if err != nil {
return fmt . Errorf ( "failed to unset git global config %s, err: %w" , key , err )
}
return nil
2021-07-28 05:42:56 -04:00
}
2022-06-09 21:57:49 -04:00
if err . IsExitCode ( 1 ) {
// not exist
return nil
}
return fmt . Errorf ( "failed to get git config %s, err: %w" , key , err )
2021-07-28 05:42:56 -04:00
}
2016-11-03 18:16:01 -04:00
// Fsck verifies the connectivity and validity of the objects in the database
2020-05-16 19:31:38 -04:00
func Fsck ( ctx context . Context , repoPath string , timeout time . Duration , args ... string ) error {
2022-03-31 22:55:30 -04:00
return NewCommand ( ctx , "fsck" ) . AddArguments ( args ... ) . Run ( & RunOpts { Timeout : timeout , Dir : repoPath } )
2016-11-03 18:16:01 -04:00
}