mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-28 22:14:20 -04:00
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>
162 lines
3.9 KiB
Go
162 lines
3.9 KiB
Go
// Copyright 2015 The Gogs Authors. All rights reserved.
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//go:build gogit
|
|
|
|
package git
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"github.com/go-git/go-git/v5/plumbing"
|
|
"github.com/go-git/go-git/v5/plumbing/storer"
|
|
)
|
|
|
|
// IsObjectExist returns true if given reference exists in the repository.
|
|
func (repo *Repository) IsObjectExist(name string) bool {
|
|
if name == "" {
|
|
return false
|
|
}
|
|
|
|
_, err := repo.gogitRepo.ResolveRevision(plumbing.Revision(name))
|
|
|
|
return err == nil
|
|
}
|
|
|
|
// IsReferenceExist returns true if given reference exists in the repository.
|
|
func (repo *Repository) IsReferenceExist(name string) bool {
|
|
if name == "" {
|
|
return false
|
|
}
|
|
|
|
reference, err := repo.gogitRepo.Reference(plumbing.ReferenceName(name), true)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
return reference.Type() != plumbing.InvalidReference
|
|
}
|
|
|
|
// IsBranchExist returns true if given branch exists in current repository.
|
|
func (repo *Repository) IsBranchExist(name string) bool {
|
|
if name == "" {
|
|
return false
|
|
}
|
|
reference, err := repo.gogitRepo.Reference(plumbing.ReferenceName(BranchPrefix+name), true)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
return reference.Type() != plumbing.InvalidReference
|
|
}
|
|
|
|
// GetBranches returns branches from the repository, skipping "skip" initial branches and
|
|
// returning at most "limit" branches, or all branches if "limit" is 0.
|
|
func (repo *Repository) GetBranchNames(skip, limit int) ([]string, int, error) {
|
|
var branchNames []string
|
|
|
|
branches, err := repo.gogitRepo.Branches()
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
|
|
i := 0
|
|
count := 0
|
|
_ = branches.ForEach(func(branch *plumbing.Reference) error {
|
|
count++
|
|
if i < skip {
|
|
i++
|
|
return nil
|
|
} else if limit != 0 && count > skip+limit {
|
|
return nil
|
|
}
|
|
|
|
branchNames = append(branchNames, strings.TrimPrefix(branch.Name().String(), BranchPrefix))
|
|
return nil
|
|
})
|
|
|
|
// TODO: Sort?
|
|
|
|
return branchNames, count, nil
|
|
}
|
|
|
|
// WalkReferences walks all the references from the repository
|
|
// refType should be empty, ObjectTag or ObjectBranch. All other values are equivalent to empty.
|
|
func WalkReferences(ctx context.Context, repoPath string, walkfn func(sha1, refname string) error) (int, error) {
|
|
repo := RepositoryFromContext(ctx, repoPath)
|
|
if repo == nil {
|
|
var err error
|
|
repo, err = OpenRepository(ctx, repoPath)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
defer repo.Close()
|
|
}
|
|
|
|
i := 0
|
|
iter, err := repo.gogitRepo.References()
|
|
if err != nil {
|
|
return i, err
|
|
}
|
|
defer iter.Close()
|
|
|
|
err = iter.ForEach(func(ref *plumbing.Reference) error {
|
|
err := walkfn(ref.Hash().String(), string(ref.Name()))
|
|
i++
|
|
return err
|
|
})
|
|
return i, err
|
|
}
|
|
|
|
// WalkReferences walks all the references from the repository
|
|
func (repo *Repository) WalkReferences(arg ObjectType, skip, limit int, walkfn func(sha1, refname string) error) (int, error) {
|
|
i := 0
|
|
var iter storer.ReferenceIter
|
|
var err error
|
|
switch arg {
|
|
case ObjectTag:
|
|
iter, err = repo.gogitRepo.Tags()
|
|
case ObjectBranch:
|
|
iter, err = repo.gogitRepo.Branches()
|
|
default:
|
|
iter, err = repo.gogitRepo.References()
|
|
}
|
|
if err != nil {
|
|
return i, err
|
|
}
|
|
defer iter.Close()
|
|
|
|
err = iter.ForEach(func(ref *plumbing.Reference) error {
|
|
if i < skip {
|
|
i++
|
|
return nil
|
|
}
|
|
err := walkfn(ref.Hash().String(), string(ref.Name()))
|
|
i++
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if limit != 0 && i >= skip+limit {
|
|
return storer.ErrStop
|
|
}
|
|
return nil
|
|
})
|
|
return i, err
|
|
}
|
|
|
|
// GetRefsBySha returns all references filtered with prefix that belong to a sha commit hash
|
|
func (repo *Repository) GetRefsBySha(sha, prefix string) ([]string, error) {
|
|
var revList []string
|
|
iter, err := repo.gogitRepo.References()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
err = iter.ForEach(func(ref *plumbing.Reference) error {
|
|
if ref.Hash().String() == sha && strings.HasPrefix(string(ref.Name()), prefix) {
|
|
revList = append(revList, string(ref.Name()))
|
|
}
|
|
return nil
|
|
})
|
|
return revList, err
|
|
}
|