osexec.go

package osexec

import (
	"fmt"
	"os"
	"os/exec"
	"strings"

	"github.com/yyle88/done"
	"github.com/yyle88/erero"
	"github.com/yyle88/osexec/internal/utils"
	"github.com/yyle88/zaplog"
	"go.uber.org/zap"
)

// Exec executes a command.
// Exec 执行一个命令且获得结果。
func Exec(name string, args ...string) ([]byte, error) {
	if name == "" {
		return nil, erero.New("can-not-execute-with-empty-command-name")
	}
	if strings.Contains(name, " ") {
		return nil, erero.New("can-not-contains-space-in-command-name")
	}
	if debugModeOpen {
		debugMessage := strings.TrimSpace(fmt.Sprintf("%s %s", name, strings.Join(args, " ")))
		utils.ShowCommand(debugMessage)
		zaplog.ZAPS.P1.LOG.Debug("EXEC:", zap.String("CMD", debugMessage))
	}
	command := exec.Command(name, args...)
	return utils.WarpMessage(done.VAE(command.CombinedOutput()), debugModeOpen)
}

// ExecInPath executes a command in a specified directory.
// ExecInPath 在指定的目录中执行一个命令。
func ExecInPath(path string, name string, args ...string) ([]byte, error) {
	if path == "" {
		return nil, erero.New("can-not-execute-in-empty-directory-path")
	}
	if name == "" {
		return nil, erero.New("can-not-execute-with-empty-command-name")
	}
	if strings.Contains(name, " ") {
		return nil, erero.New("can-not-contains-space-in-command-name")
	}
	if debugModeOpen {
		debugMessage := strings.TrimSpace(fmt.Sprintf("cd %s && %s", path, makeCommandMessage(name, args)))
		utils.ShowCommand(debugMessage)
		zaplog.ZAPS.P1.LOG.Debug("EXEC_IN_PATH:", zap.String("CMD", debugMessage))
	}
	command := exec.Command(name, args...)
	command.Dir = path
	return utils.WarpMessage(done.VAE(command.CombinedOutput()), debugModeOpen)
}

// ExecInEnvs executes a command with custom environment variables.
// ExecInEnvs 使用自定义环境变量执行一个命令。
func ExecInEnvs(envs []string, name string, args ...string) ([]byte, error) {
	if name == "" {
		return nil, erero.New("can-not-execute-with-empty-command-name")
	}
	if strings.Contains(name, " ") {
		return nil, erero.New("can-not-contains-space-in-command-name")
	}
	if debugModeOpen {
		debugMessage := strings.TrimSpace(fmt.Sprintf("%s %s", strings.Join(envs, " "), makeCommandMessage(name, args)))
		utils.ShowCommand(debugMessage)
		zaplog.ZAPS.P1.LOG.Debug("EXEC_IN_ENVS:", zap.String("CMD", debugMessage))
	}
	command := exec.Command(name, args...)
	command.Env = os.Environ() // Add custom environment variables
	command.Env = append(command.Env, envs...)
	return utils.WarpMessage(done.VAE(command.CombinedOutput()), debugModeOpen)
}

// ExecXshRun executes a command using a specific shell type and shell flag.
// ExecXshRun 使用指定的 shell 类型和 shell 标志执行一个命令。
func ExecXshRun(shellType, shellFlag string, name string, args ...string) ([]byte, error) {
	if shellType == "" {
		return nil, erero.New("can-not-execute-with-wrong-shell-command")
	}
	if shellFlag != "-c" {
		return nil, erero.New("can-not-execute-with-wrong-shell-options")
	}
	if name == "" {
		return nil, erero.New("can-not-execute-with-empty-command-name")
	}
	if debugModeOpen {
		debugMessage := strings.TrimSpace(fmt.Sprintf("%s %s '%s'", shellType, shellFlag, escapeSingleQuotes(makeCommandMessage(name, args))))
		utils.ShowCommand(debugMessage)
		zaplog.ZAPS.P1.LOG.Debug("EXEC_XSH_RUN:", zap.String("CMD", debugMessage))
	}
	command := exec.Command(shellType, "-c", name+" "+strings.Join(args, " "))
	return utils.WarpMessage(done.VAE(command.CombinedOutput()), debugModeOpen)
}

// makeCommandMessage formats a command name and its arguments into a single command-line string.
// makeCommandMessage 将命令名称及其参数格式化为一个命令行字符串。
func makeCommandMessage(name string, args []string) string {
	return strings.TrimSpace(fmt.Sprintf("%s %s", name, strings.Join(args, " ")))
}

// escapeSingleQuotes escapes single quotes in a string for safe use in shell commands.
// escapeSingleQuotes 转义字符串中的单引号，以便在 shell 命令中安全使用。
func escapeSingleQuotes(input string) string {
	return strings.ReplaceAll(input, "'", `'\''`)
}