mirror of
https://github.com/go-gitea/gitea.git
synced 2024-08-26 21:54:19 -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>
132 lines
3.1 KiB
Go
132 lines
3.1 KiB
Go
// Copyright 2015 The Gogs Authors. All rights reserved.
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//go:build !gogit
|
|
|
|
package git
|
|
|
|
import (
|
|
"errors"
|
|
"io"
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
)
|
|
|
|
// IsTagExist returns true if given tag exists in the repository.
|
|
func (repo *Repository) IsTagExist(name string) bool {
|
|
if repo == nil || name == "" {
|
|
return false
|
|
}
|
|
|
|
return repo.IsReferenceExist(TagPrefix + name)
|
|
}
|
|
|
|
// GetTags returns all tags of the repository.
|
|
// returning at most limit tags, or all if limit is 0.
|
|
func (repo *Repository) GetTags(skip, limit int) (tags []string, err error) {
|
|
tags, _, err = callShowRef(repo.Ctx, repo.Path, TagPrefix, TrustedCmdArgs{TagPrefix, "--sort=-taggerdate"}, skip, limit)
|
|
return tags, err
|
|
}
|
|
|
|
// GetTagType gets the type of the tag, either commit (simple) or tag (annotated)
|
|
func (repo *Repository) GetTagType(id SHA1) (string, error) {
|
|
wr, rd, cancel := repo.CatFileBatchCheck(repo.Ctx)
|
|
defer cancel()
|
|
_, err := wr.Write([]byte(id.String() + "\n"))
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
_, typ, _, err := ReadBatchLine(rd)
|
|
if IsErrNotExist(err) {
|
|
return "", ErrNotExist{ID: id.String()}
|
|
}
|
|
return typ, nil
|
|
}
|
|
|
|
func (repo *Repository) getTag(tagID SHA1, name string) (*Tag, error) {
|
|
t, ok := repo.tagCache.Get(tagID.String())
|
|
if ok {
|
|
log.Debug("Hit cache: %s", tagID)
|
|
tagClone := *t.(*Tag)
|
|
tagClone.Name = name // This is necessary because lightweight tags may have same id
|
|
return &tagClone, nil
|
|
}
|
|
|
|
tp, err := repo.GetTagType(tagID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Get the commit ID and tag ID (may be different for annotated tag) for the returned tag object
|
|
commitIDStr, err := repo.GetTagCommitID(name)
|
|
if err != nil {
|
|
// every tag should have a commit ID so return all errors
|
|
return nil, err
|
|
}
|
|
commitID, err := NewIDFromString(commitIDStr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// If type is "commit, the tag is a lightweight tag
|
|
if ObjectType(tp) == ObjectCommit {
|
|
commit, err := repo.GetCommit(commitIDStr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
tag := &Tag{
|
|
Name: name,
|
|
ID: tagID,
|
|
Object: commitID,
|
|
Type: tp,
|
|
Tagger: commit.Committer,
|
|
Message: commit.Message(),
|
|
}
|
|
|
|
repo.tagCache.Set(tagID.String(), tag)
|
|
return tag, nil
|
|
}
|
|
|
|
// The tag is an annotated tag with a message.
|
|
wr, rd, cancel := repo.CatFileBatch(repo.Ctx)
|
|
defer cancel()
|
|
|
|
if _, err := wr.Write([]byte(tagID.String() + "\n")); err != nil {
|
|
return nil, err
|
|
}
|
|
_, typ, size, err := ReadBatchLine(rd)
|
|
if err != nil {
|
|
if errors.Is(err, io.EOF) || IsErrNotExist(err) {
|
|
return nil, ErrNotExist{ID: tagID.String()}
|
|
}
|
|
return nil, err
|
|
}
|
|
if typ != "tag" {
|
|
return nil, ErrNotExist{ID: tagID.String()}
|
|
}
|
|
|
|
// then we need to parse the tag
|
|
// and load the commit
|
|
data, err := io.ReadAll(io.LimitReader(rd, size))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
_, err = rd.Discard(1)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
tag, err := parseTagData(data)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
tag.Name = name
|
|
tag.ID = tagID
|
|
tag.Type = tp
|
|
|
|
repo.tagCache.Set(tagID.String(), tag)
|
|
return tag, nil
|
|
}
|