mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-11-03 08:02:36 +09:00 
			
		
		
		
	Refactor Git command functions to use WithXXX methods instead of exposing RunOpts. This change simplifies reuse across gitrepo and improves consistency, encapsulation, and maintainability of command options. --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
		
			
				
	
	
		
			102 lines
		
	
	
		
			3.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			102 lines
		
	
	
		
			3.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2021 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package git
 | 
						|
 | 
						|
import (
 | 
						|
	"context"
 | 
						|
	"fmt"
 | 
						|
	"net/url"
 | 
						|
	"strings"
 | 
						|
 | 
						|
	"code.gitea.io/gitea/modules/git/gitcmd"
 | 
						|
	"code.gitea.io/gitea/modules/util"
 | 
						|
)
 | 
						|
 | 
						|
// GetRemoteAddress returns remote url of git repository in the repoPath with special remote name
 | 
						|
func GetRemoteAddress(ctx context.Context, repoPath, remoteName string) (string, error) {
 | 
						|
	var cmd *gitcmd.Command
 | 
						|
	if DefaultFeatures().CheckVersionAtLeast("2.7") {
 | 
						|
		cmd = gitcmd.NewCommand("remote", "get-url").AddDynamicArguments(remoteName)
 | 
						|
	} else {
 | 
						|
		cmd = gitcmd.NewCommand("config", "--get").AddDynamicArguments("remote." + remoteName + ".url")
 | 
						|
	}
 | 
						|
 | 
						|
	result, _, err := cmd.WithDir(repoPath).RunStdString(ctx)
 | 
						|
	if err != nil {
 | 
						|
		return "", err
 | 
						|
	}
 | 
						|
 | 
						|
	if len(result) > 0 {
 | 
						|
		result = result[:len(result)-1]
 | 
						|
	}
 | 
						|
	return result, nil
 | 
						|
}
 | 
						|
 | 
						|
// ErrInvalidCloneAddr represents a "InvalidCloneAddr" kind of error.
 | 
						|
type ErrInvalidCloneAddr struct {
 | 
						|
	Host               string
 | 
						|
	IsURLError         bool
 | 
						|
	IsInvalidPath      bool
 | 
						|
	IsProtocolInvalid  bool
 | 
						|
	IsPermissionDenied bool
 | 
						|
	LocalPath          bool
 | 
						|
}
 | 
						|
 | 
						|
// IsErrInvalidCloneAddr checks if an error is a ErrInvalidCloneAddr.
 | 
						|
func IsErrInvalidCloneAddr(err error) bool {
 | 
						|
	_, ok := err.(*ErrInvalidCloneAddr)
 | 
						|
	return ok
 | 
						|
}
 | 
						|
 | 
						|
func (err *ErrInvalidCloneAddr) Error() string {
 | 
						|
	if err.IsInvalidPath {
 | 
						|
		return fmt.Sprintf("migration/cloning from '%s' is not allowed: the provided path is invalid", err.Host)
 | 
						|
	}
 | 
						|
	if err.IsProtocolInvalid {
 | 
						|
		return fmt.Sprintf("migration/cloning from '%s' is not allowed: the provided url protocol is not allowed", err.Host)
 | 
						|
	}
 | 
						|
	if err.IsPermissionDenied {
 | 
						|
		return fmt.Sprintf("migration/cloning from '%s' is not allowed.", err.Host)
 | 
						|
	}
 | 
						|
	if err.IsURLError {
 | 
						|
		return fmt.Sprintf("migration/cloning from '%s' is not allowed: the provided url is invalid", err.Host)
 | 
						|
	}
 | 
						|
 | 
						|
	return fmt.Sprintf("migration/cloning from '%s' is not allowed", err.Host)
 | 
						|
}
 | 
						|
 | 
						|
func (err *ErrInvalidCloneAddr) Unwrap() error {
 | 
						|
	return util.ErrInvalidArgument
 | 
						|
}
 | 
						|
 | 
						|
// IsRemoteNotExistError checks the prefix of the error message to see whether a remote does not exist.
 | 
						|
func IsRemoteNotExistError(err error) bool {
 | 
						|
	// see: https://github.com/go-gitea/gitea/issues/32889#issuecomment-2571848216
 | 
						|
	// Should not add space in the end, sometimes git will add a `:`
 | 
						|
	prefix1 := "exit status 128 - fatal: No such remote" // git < 2.30
 | 
						|
	prefix2 := "exit status 2 - error: No such remote"   // git >= 2.30
 | 
						|
	return strings.HasPrefix(err.Error(), prefix1) || strings.HasPrefix(err.Error(), prefix2)
 | 
						|
}
 | 
						|
 | 
						|
// ParseRemoteAddr checks if given remote address is valid,
 | 
						|
// and returns composed URL with needed username and password.
 | 
						|
func ParseRemoteAddr(remoteAddr, authUsername, authPassword string) (string, error) {
 | 
						|
	remoteAddr = strings.TrimSpace(remoteAddr)
 | 
						|
	// Remote address can be HTTP/HTTPS/Git URL or local path.
 | 
						|
	if strings.HasPrefix(remoteAddr, "http://") ||
 | 
						|
		strings.HasPrefix(remoteAddr, "https://") ||
 | 
						|
		strings.HasPrefix(remoteAddr, "git://") {
 | 
						|
		u, err := url.Parse(remoteAddr)
 | 
						|
		if err != nil {
 | 
						|
			return "", &ErrInvalidCloneAddr{IsURLError: true, Host: remoteAddr}
 | 
						|
		}
 | 
						|
		if len(authUsername)+len(authPassword) > 0 {
 | 
						|
			u.User = url.UserPassword(authUsername, authPassword)
 | 
						|
		}
 | 
						|
		remoteAddr = u.String()
 | 
						|
	}
 | 
						|
 | 
						|
	return remoteAddr, nil
 | 
						|
}
 |