|
|
|
// Copyright 2015 The Gogs Authors. All rights reserved.
|
|
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
|
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
|
|
|
|
package git
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bufio"
|
|
|
|
"bytes"
|
|
|
|
"context"
|
|
|
|
"errors"
|
|
|
|
"io"
|
|
|
|
"os/exec"
|
|
|
|
"strconv"
|
|
|
|
"strings"
|
|
|
|
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Commit represents a git commit.
|
|
|
|
type Commit struct {
|
|
|
|
Tree
|
|
|
|
ID ObjectID // The ID of this commit object
|
|
|
|
Author *Signature
|
|
|
|
Committer *Signature
|
|
|
|
CommitMessage string
|
|
|
|
Signature *CommitGPGSignature
|
|
|
|
|
|
|
|
Parents []ObjectID // ID strings
|
|
|
|
submoduleCache *ObjectCache
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitGPGSignature represents a git commit signature part.
|
|
|
|
type CommitGPGSignature struct {
|
|
|
|
Signature string
|
|
|
|
Payload string // TODO check if can be reconstruct from the rest of commit information to not have duplicate data
|
|
|
|
}
|
|
|
|
|
|
|
|
// Message returns the commit message. Same as retrieving CommitMessage directly.
|
|
|
|
func (c *Commit) Message() string {
|
|
|
|
return c.CommitMessage
|
|
|
|
}
|
|
|
|
|
|
|
|
// Summary returns first line of commit message.
|
|
|
|
// The string is forced to be valid UTF8
|
|
|
|
func (c *Commit) Summary() string {
|
|
|
|
return strings.ToValidUTF8(strings.Split(strings.TrimSpace(c.CommitMessage), "\n")[0], "?")
|
|
|
|
}
|
|
|
|
|
|
|
|
// ParentID returns oid of n-th parent (0-based index).
|
|
|
|
// It returns nil if no such parent exists.
|
|
|
|
func (c *Commit) ParentID(n int) (ObjectID, error) {
|
|
|
|
if n >= len(c.Parents) {
|
|
|
|
return nil, ErrNotExist{"", ""}
|
|
|
|
}
|
|
|
|
return c.Parents[n], nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Parent returns n-th parent (0-based index) of the commit.
|
|
|
|
func (c *Commit) Parent(n int) (*Commit, error) {
|
|
|
|
id, err := c.ParentID(n)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
parent, err := c.repo.getCommit(id)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return parent, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// ParentCount returns number of parents of the commit.
|
|
|
|
// 0 if this is the root commit, otherwise 1,2, etc.
|
|
|
|
func (c *Commit) ParentCount() int {
|
|
|
|
return len(c.Parents)
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetCommitByPath return the commit of relative path object.
|
|
|
|
func (c *Commit) GetCommitByPath(relpath string) (*Commit, error) {
|
|
|
|
if c.repo.LastCommitCache != nil {
|
|
|
|
return c.repo.LastCommitCache.GetCommitByPath(c.ID.String(), relpath)
|
|
|
|
}
|
|
|
|
return c.repo.getCommitByPathWithID(c.ID, relpath)
|
|
|
|
}
|
|
|
|
|
|
|
|
// AddChanges marks local changes to be ready for commit.
|
|
|
|
func AddChanges(repoPath string, all bool, files ...string) error {
|
|
|
|
return AddChangesWithArgs(repoPath, globalCommandArgs, all, files...)
|
|
|
|
}
|
|
|
|
|
|
|
|
// AddChangesWithArgs marks local changes to be ready for commit.
|
Refactor git command package to improve security and maintainability (#22678)
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>
2 years ago
|
|
|
func AddChangesWithArgs(repoPath string, globalArgs TrustedCmdArgs, all bool, files ...string) error {
|
|
|
|
cmd := NewCommandContextNoGlobals(DefaultContext, globalArgs...).AddArguments("add")
|
|
|
|
if all {
|
|
|
|
cmd.AddArguments("--all")
|
|
|
|
}
|
|
|
|
cmd.AddDashesAndList(files...)
|
|
|
|
_, _, err := cmd.RunStdString(&RunOpts{Dir: repoPath})
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitChangesOptions the options when a commit created
|
|
|
|
type CommitChangesOptions struct {
|
|
|
|
Committer *Signature
|
|
|
|
Author *Signature
|
|
|
|
Message string
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitChanges commits local changes with given committer, author and message.
|
|
|
|
// If author is nil, it will be the same as committer.
|
|
|
|
func CommitChanges(repoPath string, opts CommitChangesOptions) error {
|
Refactor git command package to improve security and maintainability (#22678)
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>
2 years ago
|
|
|
cargs := make(TrustedCmdArgs, len(globalCommandArgs))
|
|
|
|
copy(cargs, globalCommandArgs)
|
|
|
|
return CommitChangesWithArgs(repoPath, cargs, opts)
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitChangesWithArgs commits local changes with given committer, author and message.
|
|
|
|
// If author is nil, it will be the same as committer.
|
Refactor git command package to improve security and maintainability (#22678)
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>
2 years ago
|
|
|
func CommitChangesWithArgs(repoPath string, args TrustedCmdArgs, opts CommitChangesOptions) error {
|
|
|
|
cmd := NewCommandContextNoGlobals(DefaultContext, args...)
|
|
|
|
if opts.Committer != nil {
|
Refactor git command package to improve security and maintainability (#22678)
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>
2 years ago
|
|
|
cmd.AddOptionValues("-c", "user.name="+opts.Committer.Name)
|
|
|
|
cmd.AddOptionValues("-c", "user.email="+opts.Committer.Email)
|
|
|
|
}
|
|
|
|
cmd.AddArguments("commit")
|
|
|
|
|
|
|
|
if opts.Author == nil {
|
|
|
|
opts.Author = opts.Committer
|
|
|
|
}
|
|
|
|
if opts.Author != nil {
|
Refactor git command package to improve security and maintainability (#22678)
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>
2 years ago
|
|
|
cmd.AddOptionFormat("--author='%s <%s>'", opts.Author.Name, opts.Author.Email)
|
|
|
|
}
|
Use `--message=%s` for git commit message (#23028)
Close #23027
`git commit` message option _only_ supports 4 formats (well, only ....):
* `"commit", "-m", msg`
* `"commit", "-m{msg}"` (no space)
* `"commit", "--message", msg`
* `"commit", "--message={msg}"`
The long format with `=` is the best choice, and it's documented in `man
git-commit`:
`-m <msg>, --message=<msg> ...`
ps: I would suggest always use long format option for git command, as
much as possible.
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2 years ago
|
|
|
cmd.AddOptionFormat("--message=%s", opts.Message)
|
|
|
|
|
|
|
|
_, _, err := cmd.RunStdString(&RunOpts{Dir: repoPath})
|
|
|
|
// No stderr but exit status 1 means nothing to commit.
|
|
|
|
if err != nil && err.Error() == "exit status 1" {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// AllCommitsCount returns count of all commits in repository
|
|
|
|
func AllCommitsCount(ctx context.Context, repoPath string, hidePRRefs bool, files ...string) (int64, error) {
|
|
|
|
cmd := NewCommand(ctx, "rev-list")
|
|
|
|
if hidePRRefs {
|
|
|
|
cmd.AddArguments("--exclude=" + PullPrefix + "*")
|
|
|
|
}
|
|
|
|
cmd.AddArguments("--all", "--count")
|
|
|
|
if len(files) > 0 {
|
|
|
|
cmd.AddDashesAndList(files...)
|
|
|
|
}
|
|
|
|
|
|
|
|
stdout, _, err := cmd.RunStdString(&RunOpts{Dir: repoPath})
|
|
|
|
if err != nil {
|
|
|
|
return 0, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return strconv.ParseInt(strings.TrimSpace(stdout), 10, 64)
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsCountOptions the options when counting commits
|
|
|
|
type CommitsCountOptions struct {
|
|
|
|
RepoPath string
|
|
|
|
Not string
|
|
|
|
Revision []string
|
|
|
|
RelPath []string
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsCount returns number of total commits of until given revision.
|
|
|
|
func CommitsCount(ctx context.Context, opts CommitsCountOptions) (int64, error) {
|
|
|
|
cmd := NewCommand(ctx, "rev-list", "--count")
|
|
|
|
|
|
|
|
cmd.AddDynamicArguments(opts.Revision...)
|
|
|
|
|
|
|
|
if opts.Not != "" {
|
|
|
|
cmd.AddOptionValues("--not", opts.Not)
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(opts.RelPath) > 0 {
|
|
|
|
cmd.AddDashesAndList(opts.RelPath...)
|
|
|
|
}
|
|
|
|
|
|
|
|
stdout, _, err := cmd.RunStdString(&RunOpts{Dir: opts.RepoPath})
|
|
|
|
if err != nil {
|
|
|
|
return 0, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return strconv.ParseInt(strings.TrimSpace(stdout), 10, 64)
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsCount returns number of total commits of until current revision.
|
|
|
|
func (c *Commit) CommitsCount() (int64, error) {
|
|
|
|
return CommitsCount(c.repo.Ctx, CommitsCountOptions{
|
|
|
|
RepoPath: c.repo.Path,
|
|
|
|
Revision: []string{c.ID.String()},
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsByRange returns the specific page commits before current revision, every page's number default by CommitsRangeSize
|
|
|
|
func (c *Commit) CommitsByRange(page, pageSize int, not string) ([]*Commit, error) {
|
|
|
|
return c.repo.commitsByRange(c.ID, page, pageSize, not)
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsBefore returns all the commits before current revision
|
|
|
|
func (c *Commit) CommitsBefore() ([]*Commit, error) {
|
|
|
|
return c.repo.getCommitsBefore(c.ID)
|
|
|
|
}
|
|
|
|
|
|
|
|
// HasPreviousCommit returns true if a given commitHash is contained in commit's parents
|
|
|
|
func (c *Commit) HasPreviousCommit(objectID ObjectID) (bool, error) {
|
|
|
|
this := c.ID.String()
|
|
|
|
that := objectID.String()
|
|
|
|
|
|
|
|
if this == that {
|
|
|
|
return false, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
_, _, err := NewCommand(c.repo.Ctx, "merge-base", "--is-ancestor").AddDynamicArguments(that, this).RunStdString(&RunOpts{Dir: c.repo.Path})
|
|
|
|
if err == nil {
|
|
|
|
return true, nil
|
|
|
|
}
|
|
|
|
var exitError *exec.ExitError
|
|
|
|
if errors.As(err, &exitError) {
|
|
|
|
if exitError.ProcessState.ExitCode() == 1 && len(exitError.Stderr) == 0 {
|
|
|
|
return false, nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsForcePush returns true if a push from oldCommitHash to this is a force push
|
|
|
|
func (c *Commit) IsForcePush(oldCommitID string) (bool, error) {
|
|
|
|
objectFormat, err := c.repo.GetObjectFormat()
|
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
if oldCommitID == objectFormat.EmptyObjectID().String() {
|
|
|
|
return false, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
oldCommit, err := c.repo.GetCommit(oldCommitID)
|
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
hasPreviousCommit, err := c.HasPreviousCommit(oldCommit.ID)
|
|
|
|
return !hasPreviousCommit, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsBeforeLimit returns num commits before current revision
|
|
|
|
func (c *Commit) CommitsBeforeLimit(num int) ([]*Commit, error) {
|
|
|
|
return c.repo.getCommitsBeforeLimit(c.ID, num)
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitsBeforeUntil returns the commits between commitID to current revision
|
|
|
|
func (c *Commit) CommitsBeforeUntil(commitID string) ([]*Commit, error) {
|
|
|
|
endCommit, err := c.repo.GetCommit(commitID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return c.repo.CommitsBetween(c, endCommit)
|
|
|
|
}
|
|
|
|
|
|
|
|
// SearchCommitsOptions specify the parameters for SearchCommits
|
|
|
|
type SearchCommitsOptions struct {
|
|
|
|
Keywords []string
|
|
|
|
Authors, Committers []string
|
|
|
|
After, Before string
|
|
|
|
All bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewSearchCommitsOptions construct a SearchCommitsOption from a space-delimited search string
|
|
|
|
func NewSearchCommitsOptions(searchString string, forAllRefs bool) SearchCommitsOptions {
|
|
|
|
var keywords, authors, committers []string
|
|
|
|
var after, before string
|
|
|
|
|
|
|
|
fields := strings.Fields(searchString)
|
|
|
|
for _, k := range fields {
|
|
|
|
switch {
|
|
|
|
case strings.HasPrefix(k, "author:"):
|
|
|
|
authors = append(authors, strings.TrimPrefix(k, "author:"))
|
|
|
|
case strings.HasPrefix(k, "committer:"):
|
|
|
|
committers = append(committers, strings.TrimPrefix(k, "committer:"))
|
|
|
|
case strings.HasPrefix(k, "after:"):
|
|
|
|
after = strings.TrimPrefix(k, "after:")
|
|
|
|
case strings.HasPrefix(k, "before:"):
|
|
|
|
before = strings.TrimPrefix(k, "before:")
|
|
|
|
default:
|
|
|
|
keywords = append(keywords, k)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return SearchCommitsOptions{
|
|
|
|
Keywords: keywords,
|
|
|
|
Authors: authors,
|
|
|
|
Committers: committers,
|
|
|
|
After: after,
|
|
|
|
Before: before,
|
|
|
|
All: forAllRefs,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// SearchCommits returns the commits match the keyword before current revision
|
|
|
|
func (c *Commit) SearchCommits(opts SearchCommitsOptions) ([]*Commit, error) {
|
|
|
|
return c.repo.searchCommits(c.ID, opts)
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetFilesChangedSinceCommit get all changed file names between pastCommit to current revision
|
|
|
|
func (c *Commit) GetFilesChangedSinceCommit(pastCommit string) ([]string, error) {
|
|
|
|
return c.repo.GetFilesChangedBetween(pastCommit, c.ID.String())
|
|
|
|
}
|
|
|
|
|
|
|
|
// FileChangedSinceCommit Returns true if the file given has changed since the past commit
|
|
|
|
// YOU MUST ENSURE THAT pastCommit is a valid commit ID.
|
|
|
|
func (c *Commit) FileChangedSinceCommit(filename, pastCommit string) (bool, error) {
|
|
|
|
return c.repo.FileChangedBetweenCommits(filename, pastCommit, c.ID.String())
|
|
|
|
}
|
|
|
|
|
|
|
|
// HasFile returns true if the file given exists on this commit
|
|
|
|
// This does only mean it's there - it does not mean the file was changed during the commit.
|
|
|
|
func (c *Commit) HasFile(filename string) (bool, error) {
|
|
|
|
_, err := c.GetBlobByPath(filename)
|
|
|
|
if err != nil {
|
|
|
|
return false, err
|
|
|
|
}
|
|
|
|
return true, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetFileContent reads a file content as a string or returns false if this was not possible
|
|
|
|
func (c *Commit) GetFileContent(filename string, limit int) (string, error) {
|
|
|
|
entry, err := c.GetTreeEntryByPath(filename)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
r, err := entry.Blob().DataAsync()
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
defer r.Close()
|
|
|
|
|
|
|
|
if limit > 0 {
|
|
|
|
bs := make([]byte, limit)
|
|
|
|
n, err := util.ReadAtMost(r, bs)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
return string(bs[:n]), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
bytes, err := io.ReadAll(r)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
return string(bytes), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetSubModules get all the sub modules of current revision git tree
|
|
|
|
func (c *Commit) GetSubModules() (*ObjectCache, error) {
|
|
|
|
if c.submoduleCache != nil {
|
|
|
|
return c.submoduleCache, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
entry, err := c.GetTreeEntryByPath(".gitmodules")
|
|
|
|
if err != nil {
|
|
|
|
if _, ok := err.(ErrNotExist); ok {
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
rd, err := entry.Blob().DataAsync()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
defer rd.Close()
|
|
|
|
scanner := bufio.NewScanner(rd)
|
|
|
|
c.submoduleCache = newObjectCache()
|
|
|
|
var ismodule bool
|
|
|
|
var path string
|
|
|
|
for scanner.Scan() {
|
|
|
|
if strings.HasPrefix(scanner.Text(), "[submodule") {
|
|
|
|
ismodule = true
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if ismodule {
|
|
|
|
fields := strings.Split(scanner.Text(), "=")
|
|
|
|
k := strings.TrimSpace(fields[0])
|
|
|
|
if k == "path" {
|
|
|
|
path = strings.TrimSpace(fields[1])
|
|
|
|
} else if k == "url" {
|
|
|
|
c.submoduleCache.Set(path, &SubModule{path, strings.TrimSpace(fields[1])})
|
|
|
|
ismodule = false
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return c.submoduleCache, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetSubModule get the sub module according entryname
|
|
|
|
func (c *Commit) GetSubModule(entryname string) (*SubModule, error) {
|
|
|
|
modules, err := c.GetSubModules()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
if modules != nil {
|
|
|
|
module, has := modules.Get(entryname)
|
|
|
|
if has {
|
|
|
|
return module.(*SubModule), nil
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetBranchName gets the closest branch name (as returned by 'git name-rev --name-only')
|
|
|
|
func (c *Commit) GetBranchName() (string, error) {
|
|
|
|
cmd := NewCommand(c.repo.Ctx, "name-rev")
|
|
|
|
if CheckGitVersionAtLeast("2.13.0") == nil {
|
|
|
|
cmd.AddArguments("--exclude", "refs/tags/*")
|
|
|
|
}
|
|
|
|
cmd.AddArguments("--name-only", "--no-undefined").AddDynamicArguments(c.ID.String())
|
|
|
|
data, _, err := cmd.RunStdString(&RunOpts{Dir: c.repo.Path})
|
|
|
|
if err != nil {
|
|
|
|
// handle special case where git can not describe commit
|
|
|
|
if strings.Contains(err.Error(), "cannot describe") {
|
|
|
|
return "", nil
|
|
|
|
}
|
|
|
|
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
// name-rev commitID output will be "master" or "master~12"
|
|
|
|
return strings.SplitN(strings.TrimSpace(data), "~", 2)[0], nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// CommitFileStatus represents status of files in a commit.
|
|
|
|
type CommitFileStatus struct {
|
|
|
|
Added []string
|
|
|
|
Removed []string
|
|
|
|
Modified []string
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewCommitFileStatus creates a CommitFileStatus
|
|
|
|
func NewCommitFileStatus() *CommitFileStatus {
|
|
|
|
return &CommitFileStatus{
|
|
|
|
[]string{}, []string{}, []string{},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func parseCommitFileStatus(fileStatus *CommitFileStatus, stdout io.Reader) {
|
|
|
|
rd := bufio.NewReader(stdout)
|
|
|
|
peek, err := rd.Peek(1)
|
|
|
|
if err != nil {
|
|
|
|
if err != io.EOF {
|
|
|
|
log.Error("Unexpected error whilst reading from git log --name-status. Error: %v", err)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
if peek[0] == '\n' || peek[0] == '\x00' {
|
|
|
|
_, _ = rd.Discard(1)
|
|
|
|
}
|
|
|
|
for {
|
|
|
|
modifier, err := rd.ReadSlice('\x00')
|
|
|
|
if err != nil {
|
|
|
|
if err != io.EOF {
|
|
|
|
log.Error("Unexpected error whilst reading from git log --name-status. Error: %v", err)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
file, err := rd.ReadString('\x00')
|
|
|
|
if err != nil {
|
|
|
|
if err != io.EOF {
|
|
|
|
log.Error("Unexpected error whilst reading from git log --name-status. Error: %v", err)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
|
|
|
file = file[:len(file)-1]
|
|
|
|
switch modifier[0] {
|
|
|
|
case 'A':
|
|
|
|
fileStatus.Added = append(fileStatus.Added, file)
|
|
|
|
case 'D':
|
|
|
|
fileStatus.Removed = append(fileStatus.Removed, file)
|
|
|
|
case 'M':
|
|
|
|
fileStatus.Modified = append(fileStatus.Modified, file)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetCommitFileStatus returns file status of commit in given repository.
|
|
|
|
func GetCommitFileStatus(ctx context.Context, repoPath, commitID string) (*CommitFileStatus, error) {
|
|
|
|
stdout, w := io.Pipe()
|
|
|
|
done := make(chan struct{})
|
|
|
|
fileStatus := NewCommitFileStatus()
|
|
|
|
go func() {
|
|
|
|
parseCommitFileStatus(fileStatus, stdout)
|
|
|
|
close(done)
|
|
|
|
}()
|
|
|
|
|
|
|
|
stderr := new(bytes.Buffer)
|
|
|
|
err := NewCommand(ctx, "log", "--name-status", "-m", "--pretty=format:", "--first-parent", "--no-renames", "-z", "-1").AddDynamicArguments(commitID).Run(&RunOpts{
|
|
|
|
Dir: repoPath,
|
|
|
|
Stdout: w,
|
|
|
|
Stderr: stderr,
|
|
|
|
})
|
|
|
|
w.Close() // Close writer to exit parsing goroutine
|
|
|
|
if err != nil {
|
|
|
|
return nil, ConcatenateError(err, stderr.String())
|
|
|
|
}
|
|
|
|
|
|
|
|
<-done
|
|
|
|
return fileStatus, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetFullCommitID returns full length (40) of commit ID by given short SHA in a repository.
|
|
|
|
func GetFullCommitID(ctx context.Context, repoPath, shortID string) (string, error) {
|
|
|
|
commitID, _, err := NewCommand(ctx, "rev-parse").AddDynamicArguments(shortID).RunStdString(&RunOpts{Dir: repoPath})
|
|
|
|
if err != nil {
|
|
|
|
if strings.Contains(err.Error(), "exit status 128") {
|
|
|
|
return "", ErrNotExist{shortID, ""}
|
|
|
|
}
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
return strings.TrimSpace(commitID), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetRepositoryDefaultPublicGPGKey returns the default public key for this commit
|
|
|
|
func (c *Commit) GetRepositoryDefaultPublicGPGKey(forceUpdate bool) (*GPGSettings, error) {
|
|
|
|
if c.repo == nil {
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
return c.repo.GetDefaultPublicGPGKey(forceUpdate)
|
|
|
|
}
|