mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-30 05:46:09 +01:00
480 lines
14 KiB
Go
480 lines
14 KiB
Go
|
package git
|
||
|
|
||
|
import (
|
||
|
"errors"
|
||
|
"regexp"
|
||
|
"strings"
|
||
|
|
||
|
"golang.org/x/crypto/openpgp"
|
||
|
"gopkg.in/src-d/go-git.v4/config"
|
||
|
"gopkg.in/src-d/go-git.v4/plumbing"
|
||
|
"gopkg.in/src-d/go-git.v4/plumbing/object"
|
||
|
"gopkg.in/src-d/go-git.v4/plumbing/protocol/packp/sideband"
|
||
|
"gopkg.in/src-d/go-git.v4/plumbing/transport"
|
||
|
)
|
||
|
|
||
|
// SubmoduleRescursivity defines how depth will affect any submodule recursive
|
||
|
// operation.
|
||
|
type SubmoduleRescursivity uint
|
||
|
|
||
|
const (
|
||
|
// DefaultRemoteName name of the default Remote, just like git command.
|
||
|
DefaultRemoteName = "origin"
|
||
|
|
||
|
// NoRecurseSubmodules disables the recursion for a submodule operation.
|
||
|
NoRecurseSubmodules SubmoduleRescursivity = 0
|
||
|
// DefaultSubmoduleRecursionDepth allow recursion in a submodule operation.
|
||
|
DefaultSubmoduleRecursionDepth SubmoduleRescursivity = 10
|
||
|
)
|
||
|
|
||
|
var (
|
||
|
ErrMissingURL = errors.New("URL field is required")
|
||
|
)
|
||
|
|
||
|
// CloneOptions describes how a clone should be performed.
|
||
|
type CloneOptions struct {
|
||
|
// The (possibly remote) repository URL to clone from.
|
||
|
URL string
|
||
|
// Auth credentials, if required, to use with the remote repository.
|
||
|
Auth transport.AuthMethod
|
||
|
// Name of the remote to be added, by default `origin`.
|
||
|
RemoteName string
|
||
|
// Remote branch to clone.
|
||
|
ReferenceName plumbing.ReferenceName
|
||
|
// Fetch only ReferenceName if true.
|
||
|
SingleBranch bool
|
||
|
// No checkout of HEAD after clone if true.
|
||
|
NoCheckout bool
|
||
|
// Limit fetching to the specified number of commits.
|
||
|
Depth int
|
||
|
// RecurseSubmodules after the clone is created, initialize all submodules
|
||
|
// within, using their default settings. This option is ignored if the
|
||
|
// cloned repository does not have a worktree.
|
||
|
RecurseSubmodules SubmoduleRescursivity
|
||
|
// Progress is where the human readable information sent by the server is
|
||
|
// stored, if nil nothing is stored and the capability (if supported)
|
||
|
// no-progress, is sent to the server to avoid send this information.
|
||
|
Progress sideband.Progress
|
||
|
// Tags describe how the tags will be fetched from the remote repository,
|
||
|
// by default is AllTags.
|
||
|
Tags TagMode
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *CloneOptions) Validate() error {
|
||
|
if o.URL == "" {
|
||
|
return ErrMissingURL
|
||
|
}
|
||
|
|
||
|
if o.RemoteName == "" {
|
||
|
o.RemoteName = DefaultRemoteName
|
||
|
}
|
||
|
|
||
|
if o.ReferenceName == "" {
|
||
|
o.ReferenceName = plumbing.HEAD
|
||
|
}
|
||
|
|
||
|
if o.Tags == InvalidTagMode {
|
||
|
o.Tags = AllTags
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// PullOptions describes how a pull should be performed.
|
||
|
type PullOptions struct {
|
||
|
// Name of the remote to be pulled. If empty, uses the default.
|
||
|
RemoteName string
|
||
|
// Remote branch to clone. If empty, uses HEAD.
|
||
|
ReferenceName plumbing.ReferenceName
|
||
|
// Fetch only ReferenceName if true.
|
||
|
SingleBranch bool
|
||
|
// Limit fetching to the specified number of commits.
|
||
|
Depth int
|
||
|
// Auth credentials, if required, to use with the remote repository.
|
||
|
Auth transport.AuthMethod
|
||
|
// RecurseSubmodules controls if new commits of all populated submodules
|
||
|
// should be fetched too.
|
||
|
RecurseSubmodules SubmoduleRescursivity
|
||
|
// Progress is where the human readable information sent by the server is
|
||
|
// stored, if nil nothing is stored and the capability (if supported)
|
||
|
// no-progress, is sent to the server to avoid send this information.
|
||
|
Progress sideband.Progress
|
||
|
// Force allows the pull to update a local branch even when the remote
|
||
|
// branch does not descend from it.
|
||
|
Force bool
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *PullOptions) Validate() error {
|
||
|
if o.RemoteName == "" {
|
||
|
o.RemoteName = DefaultRemoteName
|
||
|
}
|
||
|
|
||
|
if o.ReferenceName == "" {
|
||
|
o.ReferenceName = plumbing.HEAD
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
type TagMode int
|
||
|
|
||
|
const (
|
||
|
InvalidTagMode TagMode = iota
|
||
|
// TagFollowing any tag that points into the histories being fetched is also
|
||
|
// fetched. TagFollowing requires a server with `include-tag` capability
|
||
|
// in order to fetch the annotated tags objects.
|
||
|
TagFollowing
|
||
|
// AllTags fetch all tags from the remote (i.e., fetch remote tags
|
||
|
// refs/tags/* into local tags with the same name)
|
||
|
AllTags
|
||
|
//NoTags fetch no tags from the remote at all
|
||
|
NoTags
|
||
|
)
|
||
|
|
||
|
// FetchOptions describes how a fetch should be performed
|
||
|
type FetchOptions struct {
|
||
|
// Name of the remote to fetch from. Defaults to origin.
|
||
|
RemoteName string
|
||
|
RefSpecs []config.RefSpec
|
||
|
// Depth limit fetching to the specified number of commits from the tip of
|
||
|
// each remote branch history.
|
||
|
Depth int
|
||
|
// Auth credentials, if required, to use with the remote repository.
|
||
|
Auth transport.AuthMethod
|
||
|
// Progress is where the human readable information sent by the server is
|
||
|
// stored, if nil nothing is stored and the capability (if supported)
|
||
|
// no-progress, is sent to the server to avoid send this information.
|
||
|
Progress sideband.Progress
|
||
|
// Tags describe how the tags will be fetched from the remote repository,
|
||
|
// by default is TagFollowing.
|
||
|
Tags TagMode
|
||
|
// Force allows the fetch to update a local branch even when the remote
|
||
|
// branch does not descend from it.
|
||
|
Force bool
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *FetchOptions) Validate() error {
|
||
|
if o.RemoteName == "" {
|
||
|
o.RemoteName = DefaultRemoteName
|
||
|
}
|
||
|
|
||
|
if o.Tags == InvalidTagMode {
|
||
|
o.Tags = TagFollowing
|
||
|
}
|
||
|
|
||
|
for _, r := range o.RefSpecs {
|
||
|
if err := r.Validate(); err != nil {
|
||
|
return err
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// PushOptions describes how a push should be performed.
|
||
|
type PushOptions struct {
|
||
|
// RemoteName is the name of the remote to be pushed to.
|
||
|
RemoteName string
|
||
|
// RefSpecs specify what destination ref to update with what source
|
||
|
// object. A refspec with empty src can be used to delete a reference.
|
||
|
RefSpecs []config.RefSpec
|
||
|
// Auth credentials, if required, to use with the remote repository.
|
||
|
Auth transport.AuthMethod
|
||
|
// Progress is where the human readable information sent by the server is
|
||
|
// stored, if nil nothing is stored.
|
||
|
Progress sideband.Progress
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *PushOptions) Validate() error {
|
||
|
if o.RemoteName == "" {
|
||
|
o.RemoteName = DefaultRemoteName
|
||
|
}
|
||
|
|
||
|
if len(o.RefSpecs) == 0 {
|
||
|
o.RefSpecs = []config.RefSpec{
|
||
|
config.RefSpec(config.DefaultPushRefSpec),
|
||
|
}
|
||
|
}
|
||
|
|
||
|
for _, r := range o.RefSpecs {
|
||
|
if err := r.Validate(); err != nil {
|
||
|
return err
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// SubmoduleUpdateOptions describes how a submodule update should be performed.
|
||
|
type SubmoduleUpdateOptions struct {
|
||
|
// Init, if true initializes the submodules recorded in the index.
|
||
|
Init bool
|
||
|
// NoFetch tell to the update command to not fetch new objects from the
|
||
|
// remote site.
|
||
|
NoFetch bool
|
||
|
// RecurseSubmodules the update is performed not only in the submodules of
|
||
|
// the current repository but also in any nested submodules inside those
|
||
|
// submodules (and so on). Until the SubmoduleRescursivity is reached.
|
||
|
RecurseSubmodules SubmoduleRescursivity
|
||
|
// Auth credentials, if required, to use with the remote repository.
|
||
|
Auth transport.AuthMethod
|
||
|
}
|
||
|
|
||
|
var (
|
||
|
ErrBranchHashExclusive = errors.New("Branch and Hash are mutually exclusive")
|
||
|
ErrCreateRequiresBranch = errors.New("Branch is mandatory when Create is used")
|
||
|
)
|
||
|
|
||
|
// CheckoutOptions describes how a checkout 31operation should be performed.
|
||
|
type CheckoutOptions struct {
|
||
|
// Hash is the hash of the commit to be checked out. If used, HEAD will be
|
||
|
// in detached mode. If Create is not used, Branch and Hash are mutually
|
||
|
// exclusive.
|
||
|
Hash plumbing.Hash
|
||
|
// Branch to be checked out, if Branch and Hash are empty is set to `master`.
|
||
|
Branch plumbing.ReferenceName
|
||
|
// Create a new branch named Branch and start it at Hash.
|
||
|
Create bool
|
||
|
// Force, if true when switching branches, proceed even if the index or the
|
||
|
// working tree differs from HEAD. This is used to throw away local changes
|
||
|
Force bool
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *CheckoutOptions) Validate() error {
|
||
|
if !o.Create && !o.Hash.IsZero() && o.Branch != "" {
|
||
|
return ErrBranchHashExclusive
|
||
|
}
|
||
|
|
||
|
if o.Create && o.Branch == "" {
|
||
|
return ErrCreateRequiresBranch
|
||
|
}
|
||
|
|
||
|
if o.Branch == "" {
|
||
|
o.Branch = plumbing.Master
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// ResetMode defines the mode of a reset operation.
|
||
|
type ResetMode int8
|
||
|
|
||
|
const (
|
||
|
// MixedReset resets the index but not the working tree (i.e., the changed
|
||
|
// files are preserved but not marked for commit) and reports what has not
|
||
|
// been updated. This is the default action.
|
||
|
MixedReset ResetMode = iota
|
||
|
// HardReset resets the index and working tree. Any changes to tracked files
|
||
|
// in the working tree are discarded.
|
||
|
HardReset
|
||
|
// MergeReset resets the index and updates the files in the working tree
|
||
|
// that are different between Commit and HEAD, but keeps those which are
|
||
|
// different between the index and working tree (i.e. which have changes
|
||
|
// which have not been added).
|
||
|
//
|
||
|
// If a file that is different between Commit and the index has unstaged
|
||
|
// changes, reset is aborted.
|
||
|
MergeReset
|
||
|
// SoftReset does not touch the index file or the working tree at all (but
|
||
|
// resets the head to <commit>, just like all modes do). This leaves all
|
||
|
// your changed files "Changes to be committed", as git status would put it.
|
||
|
SoftReset
|
||
|
)
|
||
|
|
||
|
// ResetOptions describes how a reset operation should be performed.
|
||
|
type ResetOptions struct {
|
||
|
// Commit, if commit is pressent set the current branch head (HEAD) to it.
|
||
|
Commit plumbing.Hash
|
||
|
// Mode, form resets the current branch head to Commit and possibly updates
|
||
|
// the index (resetting it to the tree of Commit) and the working tree
|
||
|
// depending on Mode. If empty MixedReset is used.
|
||
|
Mode ResetMode
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *ResetOptions) Validate(r *Repository) error {
|
||
|
if o.Commit == plumbing.ZeroHash {
|
||
|
ref, err := r.Head()
|
||
|
if err != nil {
|
||
|
return err
|
||
|
}
|
||
|
|
||
|
o.Commit = ref.Hash()
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
type LogOrder int8
|
||
|
|
||
|
const (
|
||
|
LogOrderDefault LogOrder = iota
|
||
|
LogOrderDFS
|
||
|
LogOrderDFSPost
|
||
|
LogOrderBSF
|
||
|
LogOrderCommitterTime
|
||
|
)
|
||
|
|
||
|
// LogOptions describes how a log action should be performed.
|
||
|
type LogOptions struct {
|
||
|
// When the From option is set the log will only contain commits
|
||
|
// reachable from it. If this option is not set, HEAD will be used as
|
||
|
// the default From.
|
||
|
From plumbing.Hash
|
||
|
|
||
|
// The default traversal algorithm is Depth-first search
|
||
|
// set Order=LogOrderCommitterTime for ordering by committer time (more compatible with `git log`)
|
||
|
// set Order=LogOrderBSF for Breadth-first search
|
||
|
Order LogOrder
|
||
|
|
||
|
// Show only those commits in which the specified file was inserted/updated.
|
||
|
// It is equivalent to running `git log -- <file-name>`.
|
||
|
FileName *string
|
||
|
}
|
||
|
|
||
|
var (
|
||
|
ErrMissingAuthor = errors.New("author field is required")
|
||
|
)
|
||
|
|
||
|
// CommitOptions describes how a commit operation should be performed.
|
||
|
type CommitOptions struct {
|
||
|
// All automatically stage files that have been modified and deleted, but
|
||
|
// new files you have not told Git about are not affected.
|
||
|
All bool
|
||
|
// Author is the author's signature of the commit.
|
||
|
Author *object.Signature
|
||
|
// Committer is the committer's signature of the commit. If Committer is
|
||
|
// nil the Author signature is used.
|
||
|
Committer *object.Signature
|
||
|
// Parents are the parents commits for the new commit, by default when
|
||
|
// len(Parents) is zero, the hash of HEAD reference is used.
|
||
|
Parents []plumbing.Hash
|
||
|
// SignKey denotes a key to sign the commit with. A nil value here means the
|
||
|
// commit will not be signed. The private key must be present and already
|
||
|
// decrypted.
|
||
|
SignKey *openpgp.Entity
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *CommitOptions) Validate(r *Repository) error {
|
||
|
if o.Author == nil {
|
||
|
return ErrMissingAuthor
|
||
|
}
|
||
|
|
||
|
if o.Committer == nil {
|
||
|
o.Committer = o.Author
|
||
|
}
|
||
|
|
||
|
if len(o.Parents) == 0 {
|
||
|
head, err := r.Head()
|
||
|
if err != nil && err != plumbing.ErrReferenceNotFound {
|
||
|
return err
|
||
|
}
|
||
|
|
||
|
if head != nil {
|
||
|
o.Parents = []plumbing.Hash{head.Hash()}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
var (
|
||
|
ErrMissingName = errors.New("name field is required")
|
||
|
ErrMissingTagger = errors.New("tagger field is required")
|
||
|
ErrMissingMessage = errors.New("message field is required")
|
||
|
)
|
||
|
|
||
|
// CreateTagOptions describes how a tag object should be created.
|
||
|
type CreateTagOptions struct {
|
||
|
// Tagger defines the signature of the tag creator.
|
||
|
Tagger *object.Signature
|
||
|
// Message defines the annotation of the tag. It is canonicalized during
|
||
|
// validation into the format expected by git - no leading whitespace and
|
||
|
// ending in a newline.
|
||
|
Message string
|
||
|
// SignKey denotes a key to sign the tag with. A nil value here means the tag
|
||
|
// will not be signed. The private key must be present and already decrypted.
|
||
|
SignKey *openpgp.Entity
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *CreateTagOptions) Validate(r *Repository, hash plumbing.Hash) error {
|
||
|
if o.Tagger == nil {
|
||
|
return ErrMissingTagger
|
||
|
}
|
||
|
|
||
|
if o.Message == "" {
|
||
|
return ErrMissingMessage
|
||
|
}
|
||
|
|
||
|
// Canonicalize the message into the expected message format.
|
||
|
o.Message = strings.TrimSpace(o.Message) + "\n"
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// ListOptions describes how a remote list should be performed.
|
||
|
type ListOptions struct {
|
||
|
// Auth credentials, if required, to use with the remote repository.
|
||
|
Auth transport.AuthMethod
|
||
|
}
|
||
|
|
||
|
// CleanOptions describes how a clean should be performed.
|
||
|
type CleanOptions struct {
|
||
|
Dir bool
|
||
|
}
|
||
|
|
||
|
// GrepOptions describes how a grep should be performed.
|
||
|
type GrepOptions struct {
|
||
|
// Patterns are compiled Regexp objects to be matched.
|
||
|
Patterns []*regexp.Regexp
|
||
|
// InvertMatch selects non-matching lines.
|
||
|
InvertMatch bool
|
||
|
// CommitHash is the hash of the commit from which worktree should be derived.
|
||
|
CommitHash plumbing.Hash
|
||
|
// ReferenceName is the branch or tag name from which worktree should be derived.
|
||
|
ReferenceName plumbing.ReferenceName
|
||
|
// PathSpecs are compiled Regexp objects of pathspec to use in the matching.
|
||
|
PathSpecs []*regexp.Regexp
|
||
|
}
|
||
|
|
||
|
var (
|
||
|
ErrHashOrReference = errors.New("ambiguous options, only one of CommitHash or ReferenceName can be passed")
|
||
|
)
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *GrepOptions) Validate(w *Worktree) error {
|
||
|
if !o.CommitHash.IsZero() && o.ReferenceName != "" {
|
||
|
return ErrHashOrReference
|
||
|
}
|
||
|
|
||
|
// If none of CommitHash and ReferenceName are provided, set commit hash of
|
||
|
// the repository's head.
|
||
|
if o.CommitHash.IsZero() && o.ReferenceName == "" {
|
||
|
ref, err := w.r.Head()
|
||
|
if err != nil {
|
||
|
return err
|
||
|
}
|
||
|
o.CommitHash = ref.Hash()
|
||
|
}
|
||
|
|
||
|
return nil
|
||
|
}
|
||
|
|
||
|
// PlainOpenOptions describes how opening a plain repository should be
|
||
|
// performed.
|
||
|
type PlainOpenOptions struct {
|
||
|
// DetectDotGit defines whether parent directories should be
|
||
|
// walked until a .git directory or file is found.
|
||
|
DetectDotGit bool
|
||
|
}
|
||
|
|
||
|
// Validate validates the fields and sets the default values.
|
||
|
func (o *PlainOpenOptions) Validate() error { return nil }
|