mirror of
				https://gitcode.com/gitea/gitea.git
				synced 2025-10-25 12:26:40 +08:00 
			
		
		
		
	 6bc3079c00
			
		
	
	6bc3079c00
	
	
	
		
			
			This PR follows #21535 (and replace #22592) ## Review without space diff https://github.com/go-gitea/gitea/pull/22678/files?diff=split&w=1 ## Purpose of this PR 1. Make git module command completely safe (risky user inputs won't be passed as argument option anymore) 2. Avoid low-level mistakes like https://github.com/go-gitea/gitea/pull/22098#discussion_r1045234918 3. Remove deprecated and dirty `CmdArgCheck` function, hide the `CmdArg` type 4. Simplify code when using git command ## The main idea of this PR * Move the `git.CmdArg` to the `internal` package, then no other package except `git` could use it. Then developers could never do `AddArguments(git.CmdArg(userInput))` any more. * Introduce `git.ToTrustedCmdArgs`, it's for user-provided and already trusted arguments. It's only used in a few cases, for example: use git arguments from config file, help unit test with some arguments. * Introduce `AddOptionValues` and `AddOptionFormat`, they make code more clear and simple: * Before: `AddArguments("-m").AddDynamicArguments(message)` * After: `AddOptionValues("-m", message)` * - * Before: `AddArguments(git.CmdArg(fmt.Sprintf("--author='%s <%s>'", sig.Name, sig.Email)))` * After: `AddOptionFormat("--author='%s <%s>'", sig.Name, sig.Email)` ## FAQ ### Why these changes were not done in #21535 ? #21535 is mainly a search&replace, it did its best to not change too much logic. Making the framework better needs a lot of changes, so this separate PR is needed as the second step. ### The naming of `AddOptionXxx` According to git's manual, the `--xxx` part is called `option`. ### How can it guarantee that `internal.CmdArg` won't be not misused? Go's specification guarantees that. Trying to access other package's internal package causes compilation error. And, `golangci-lint` also denies the git/internal package. Only the `git/command.go` can use it carefully. ### There is still a `ToTrustedCmdArgs`, will it still allow developers to make mistakes and pass untrusted arguments? Generally speaking, no. Because when using `ToTrustedCmdArgs`, the code will be very complex (see the changes for examples). Then developers and reviewers can know that something might be unreasonable. ### Why there was a `CmdArgCheck` and why it's removed? At the moment of #21535, to reduce unnecessary changes, `CmdArgCheck` was introduced as a hacky patch. Now, almost all code could be written as `cmd := NewCommand(); cmd.AddXxx(...)`, then there is no need for `CmdArgCheck` anymore. ### Why many codes for `signArg == ""` is deleted? Because in the old code, `signArg` could never be empty string, it's either `-S[key-id]` or `--no-gpg-sign`. So the `signArg == ""` is just dead code. --------- Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
		
			
				
	
	
		
			76 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			76 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2015 The Gogs Authors. All rights reserved.
 | |
| // Copyright 2020 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package git
 | |
| 
 | |
| import (
 | |
| 	"context"
 | |
| 	"fmt"
 | |
| 	"io"
 | |
| 	"path/filepath"
 | |
| 	"strings"
 | |
| )
 | |
| 
 | |
| // ArchiveType archive types
 | |
| type ArchiveType int
 | |
| 
 | |
| const (
 | |
| 	// ZIP zip archive type
 | |
| 	ZIP ArchiveType = iota + 1
 | |
| 	// TARGZ tar gz archive type
 | |
| 	TARGZ
 | |
| 	// BUNDLE bundle archive type
 | |
| 	BUNDLE
 | |
| )
 | |
| 
 | |
| // String converts an ArchiveType to string
 | |
| func (a ArchiveType) String() string {
 | |
| 	switch a {
 | |
| 	case ZIP:
 | |
| 		return "zip"
 | |
| 	case TARGZ:
 | |
| 		return "tar.gz"
 | |
| 	case BUNDLE:
 | |
| 		return "bundle"
 | |
| 	}
 | |
| 	return "unknown"
 | |
| }
 | |
| 
 | |
| func ToArchiveType(s string) ArchiveType {
 | |
| 	switch s {
 | |
| 	case "zip":
 | |
| 		return ZIP
 | |
| 	case "tar.gz":
 | |
| 		return TARGZ
 | |
| 	case "bundle":
 | |
| 		return BUNDLE
 | |
| 	}
 | |
| 	return 0
 | |
| }
 | |
| 
 | |
| // CreateArchive create archive content to the target path
 | |
| func (repo *Repository) CreateArchive(ctx context.Context, format ArchiveType, target io.Writer, usePrefix bool, commitID string) error {
 | |
| 	if format.String() == "unknown" {
 | |
| 		return fmt.Errorf("unknown format: %v", format)
 | |
| 	}
 | |
| 
 | |
| 	cmd := NewCommand(ctx, "archive")
 | |
| 	if usePrefix {
 | |
| 		cmd.AddOptionFormat("--prefix=%s", filepath.Base(strings.TrimSuffix(repo.Path, ".git"))+"/")
 | |
| 	}
 | |
| 	cmd.AddOptionFormat("--format=%s", format.String())
 | |
| 	cmd.AddDynamicArguments(commitID)
 | |
| 
 | |
| 	var stderr strings.Builder
 | |
| 	err := cmd.Run(&RunOpts{
 | |
| 		Dir:    repo.Path,
 | |
| 		Stdout: target,
 | |
| 		Stderr: &stderr,
 | |
| 	})
 | |
| 	if err != nil {
 | |
| 		return ConcatenateError(err, stderr.String())
 | |
| 	}
 | |
| 	return nil
 | |
| }
 |