// Copyright 2015 The Gogs Authors. All rights reserved. // Copyright 2016 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package git import ( "bytes" "context" "fmt" "io" "os" "os/exec" "strings" "time" "unsafe" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/process" "code.gitea.io/gitea/modules/util" ) var ( // globalCommandArgs global command args for external package setting globalCommandArgs []string // defaultCommandExecutionTimeout default command execution timeout duration defaultCommandExecutionTimeout = 360 * time.Second ) // DefaultLocale is the default LC_ALL to run git commands in. const DefaultLocale = "C" // Command represents a command with its subcommands or arguments. type Command struct { name string args []string parentContext context.Context desc string globalArgsLength int } func (c *Command) String() string { if len(c.args) == 0 { return c.name } return fmt.Sprintf("%s %s", c.name, strings.Join(c.args, " ")) } // NewCommand creates and returns a new Git Command based on given command and arguments. func NewCommand(ctx context.Context, args ...string) *Command { // Make an explicit copy of globalCommandArgs, otherwise append might overwrite it cargs := make([]string, len(globalCommandArgs)) copy(cargs, globalCommandArgs) return &Command{ name: GitExecutable, args: append(cargs, args...), parentContext: ctx, globalArgsLength: len(globalCommandArgs), } } // NewCommandNoGlobals creates and returns a new Git Command based on given command and arguments only with the specify args and don't care global command args func NewCommandNoGlobals(args ...string) *Command { return NewCommandContextNoGlobals(DefaultContext, args...) } // NewCommandContextNoGlobals creates and returns a new Git Command based on given command and arguments only with the specify args and don't care global command args func NewCommandContextNoGlobals(ctx context.Context, args ...string) *Command { return &Command{ name: GitExecutable, args: args, parentContext: ctx, } } // SetParentContext sets the parent context for this command func (c *Command) SetParentContext(ctx context.Context) *Command { c.parentContext = ctx return c } // SetDescription sets the description for this command which be returned on // c.String() func (c *Command) SetDescription(desc string) *Command { c.desc = desc return c } // AddArguments adds new argument(s) to the command. func (c *Command) AddArguments(args ...string) *Command { c.args = append(c.args, args...) return c } // RunContext represents parameters to run the command type RunContext struct { Env []string Timeout time.Duration Dir string Stdout, Stderr io.Writer Stdin io.Reader PipelineFunc func(context.Context, context.CancelFunc) error } // RunWithContext run the command with context func (c *Command) RunWithContext(rc *RunContext) error { if rc.Timeout <= 0 { rc.Timeout = defaultCommandExecutionTimeout } if len(rc.Dir) == 0 { log.Debug("%s", c) } else { log.Debug("%s: %v", rc.Dir, c) } desc := c.desc if desc == "" { args := c.args[c.globalArgsLength:] var argSensitiveURLIndexes []int for i, arg := range c.args { if strings.Contains(arg, "://") && strings.Contains(arg, "@") { argSensitiveURLIndexes = append(argSensitiveURLIndexes, i) } } if len(argSensitiveURLIndexes) > 0 { args = make([]string, len(c.args)) copy(args, c.args) for _, urlArgIndex := range argSensitiveURLIndexes { args[urlArgIndex] = util.SanitizeCredentialURLs(args[urlArgIndex]) } } desc = fmt.Sprintf("%s %s [repo_path: %s]", c.name, strings.Join(args, " "), rc.Dir) } ctx, cancel, finished := process.GetManager().AddContextTimeout(c.parentContext, rc.Timeout, desc) defer finished() cmd := exec.CommandContext(ctx, c.name, c.args...) if rc.Env == nil { cmd.Env = os.Environ() } else { cmd.Env = rc.Env } cmd.Env = append( cmd.Env, fmt.Sprintf("LC_ALL=%s", DefaultLocale), // avoid prompting for credentials interactively, supported since git v2.3 "GIT_TERMINAL_PROMPT=0", // ignore replace references (https://git-scm.com/docs/git-replace) "GIT_NO_REPLACE_OBJECTS=1", ) cmd.Dir = rc.Dir cmd.Stdout = rc.Stdout cmd.Stderr = rc.Stderr cmd.Stdin = rc.Stdin if err := cmd.Start(); err != nil { return err } if rc.PipelineFunc != nil { err := rc.PipelineFunc(ctx, cancel) if err != nil { cancel() _ = cmd.Wait() return err } } if err := cmd.Wait(); err != nil && ctx.Err() != context.DeadlineExceeded { return err } return ctx.Err() } type RunError interface { error Stderr() string } type runError struct { err error stderr string errMsg string } func (r *runError) Error() string { // the stderr must be in the returned error text, some code only checks `strings.Contains(err.Error(), "git error")` if r.errMsg == "" { r.errMsg = ConcatenateError(r.err, r.stderr).Error() } return r.errMsg } func (r *runError) Unwrap() error { return r.err } func (r *runError) Stderr() string { return r.stderr } func bytesToString(b []byte) string { return *(*string)(unsafe.Pointer(&b)) // that's what Golang's strings.Builder.String() does (go/src/strings/builder.go) } // RunWithContextString run the command with context and returns stdout/stderr as string. and store stderr to returned error (err combined with stderr). func (c *Command) RunWithContextString(rc *RunContext) (stdout, stderr string, runErr RunError) { stdoutBytes, stderrBytes, err := c.RunWithContextBytes(rc) stdout = bytesToString(stdoutBytes) stderr = bytesToString(stderrBytes) if err != nil { return stdout, stderr, &runError{err: err, stderr: stderr} } // even if there is no err, there could still be some stderr output, so we just return stdout/stderr as they are return stdout, stderr, nil } // RunWithContextBytes run the command with context and returns stdout/stderr as bytes. and store stderr to returned error (err combined with stderr). func (c *Command) RunWithContextBytes(rc *RunContext) (stdout, stderr []byte, runErr RunError) { if rc.Stdout != nil || rc.Stderr != nil { // we must panic here, otherwise there would be bugs if developers set Stdin/Stderr by mistake, and it would be very difficult to debug panic("stdout and stderr field must be nil when using RunWithContextBytes") } stdoutBuf := &bytes.Buffer{} stderrBuf := &bytes.Buffer{} rc.Stdout = stdoutBuf rc.Stderr = stderrBuf err := c.RunWithContext(rc) stderr = stderrBuf.Bytes() if err != nil { return nil, stderr, &runError{err: err, stderr: string(stderr)} } // even if there is no err, there could still be some stderr output return stdoutBuf.Bytes(), stderr, nil } // RunInDirBytes executes the command in given directory // and returns stdout in []byte and error (combined with stderr). func (c *Command) RunInDirBytes(dir string) ([]byte, error) { stdout, _, err := c.RunWithContextBytes(&RunContext{Dir: dir}) return stdout, err } // RunInDir executes the command in given directory // and returns stdout in string and error (combined with stderr). func (c *Command) RunInDir(dir string) (string, error) { return c.RunInDirWithEnv(dir, nil) } // RunInDirWithEnv executes the command in given directory // and returns stdout in string and error (combined with stderr). func (c *Command) RunInDirWithEnv(dir string, env []string) (string, error) { stdout, _, err := c.RunWithContextString(&RunContext{Env: env, Dir: dir}) return stdout, err } // Run executes the command in default working directory // and returns stdout in string and error (combined with stderr). func (c *Command) Run() (string, error) { stdout, _, err := c.RunWithContextString(&RunContext{}) return stdout, err } // AllowLFSFiltersArgs return globalCommandArgs with lfs filter, it should only be used for tests func AllowLFSFiltersArgs() []string { // Now here we should explicitly allow lfs filters to run filteredLFSGlobalArgs := make([]string, len(globalCommandArgs)) j := 0 for _, arg := range globalCommandArgs { if strings.Contains(arg, "lfs") { j-- } else { filteredLFSGlobalArgs[j] = arg j++ } } return filteredLFSGlobalArgs[:j] }