cmd.go

package hype

import (
	"context"
	"encoding/json"
	"fmt"
	"path/filepath"
	"strconv"
	"strings"
	"time"

	"github.com/markbates/clam"
	"github.com/mattn/go-shellwords"
)

// Cmd is a tag representing a command to be executed.
type Cmd struct {
	*Element

	Args         []string
	Env          []string
	ExpectedExit int
	Timeout      time.Duration

	res *CmdResult
}

func (c *Cmd) MarshalJSON() ([]byte, error) {
	if c == nil {
		return nil, ErrIsNil("cmd")
	}

	c.RLock()
	defer c.RUnlock()

	m, err := c.JSONMap()
	if err != nil {
		return nil, err
	}

	m["type"] = toType(c)
	m["expected_exit"] = c.ExpectedExit
	m["timeout"] = c.Timeout.String()

	if len(c.Args) > 0 {
		m["args"] = c.Args
	}

	if len(c.Env) > 0 {
		m["env"] = c.Env
	}

	if c.res != nil {
		m["result"] = c.res
	}

	return json.MarshalIndent(m, "", "  ")
}

func (c *Cmd) MD() string {
	if c == nil {
		return ""
	}

	return c.Children().MD()
}

// Result returns the result of executing the command.
func (c *Cmd) Result() *CmdResult {
	c.RLock()
	defer c.RUnlock()
	return c.res
}

// Execute the command.
func (c *Cmd) Execute(ctx context.Context, doc *Document) error {
	if c == nil {
		return ErrIsNil("cmd")
	}

	if c.Element == nil {
		return ErrIsNil("element")
	}

	if doc == nil {
		return ErrIsNil("document")
	}

	if c.Timeout == 0 {
		c.Timeout = time.Second * 30
	}

	var cancel context.CancelFunc
	ctx, cancel = context.WithTimeout(ctx, c.Timeout)
	defer cancel()

	cmd := &clam.Cmd{
		Env: c.Env,
	}

	src, ok := c.Get("src")
	if ok {
		dir := filepath.Join(doc.Root, src)
		cmd.Dir = dir
	}

	// Check the args for the ~ character and replace it with the home directory
	// Make a copy of those args as we only want to change them when we pass it to the clam.Cmd
	args := make([]string, len(c.Args))
	copy(args, c.Args)
	for i, arg := range args {
		if strings.HasPrefix(arg, "~") {
			hd, err := homeDirectory()
			if err != nil {
				return c.newError(err)
			}
			args[i] = filepath.Join(hd, arg[1:])
		}
	}

	res, err := cmd.Run(ctx, args...)
	if err != nil {
		switch c.ExpectedExit {
		case -1:
			if res.Exit == 0 {
				return c.newError(err)
			}
		default:
			if res.Exit != c.ExpectedExit {
				return c.newError(err)
			}
		}
	}

	cres, err := NewCmdResult(doc.Parser, c, res)
	if err != nil {
		return c.newError(err)
	}

	c.Lock()
	c.res = cres
	c.Nodes = Nodes{cres}
	c.Unlock()

	return nil
}

func (c *Cmd) newError(err error) error {
	if c == nil {
		return err
	}

	re, ok := err.(clam.RunError)
	if !ok {
		return CmdError{
			RunError: clam.RunError{
				Err: err,
			},
			Filename: c.Filename,
		}
	}

	return CmdError{
		RunError: re,
		Filename: c.Filename,
	}
}

func NewCmd(el *Element) (*Cmd, error) {
	if el == nil {
		return nil, ErrIsNil("element")
	}

	c := &Cmd{
		Element: el,
		Timeout: time.Second * 30,
	}

	ex, err := el.ValidAttr("exec")
	if err != nil {
		return nil, err
	}

	args, err := shellwords.Parse(ex)
	if err != nil {
		return nil, err
	}

	if len(args) == 0 {
		return nil, c.WrapErr(fmt.Errorf("no command specified"))
	}

	c.Args = args

	if en, ok := el.Get("environ"); ok {
		c.Env = append(c.Env, strings.Split(en, ",")...)
	}

	if ee, ok := el.Get("exit"); ok {
		c.ExpectedExit, err = strconv.Atoi(ee)
		if err != nil {
			return nil, err
		}
	}

	if to, ok := el.Get("timeout"); ok {
		c.Timeout, err = time.ParseDuration(to)
		if err != nil {
			return nil, err
		}
	}

	return c, nil
}

func NewAttrCode(p *Parser, el *Element) (Nodes, error) {
	if el == nil {
		return nil, ErrIsNil("element")
	}

	var nodes Nodes

	code, ok := el.Get("code")
	if !ok {
		return nodes, nil
	}

	el.Delete("code")

	src, ok := el.Get("src")
	if ok {
		code = filepath.Join(src, code)
	}

	ats := &Attributes{}

	if err := ats.Set("src", code); err != nil {
		return nil, err
	}

	cel := NewEl("code", el.Parent)
	cel.Attributes = ats
	codes, err := NewCodeNodes(p, cel)

	if err != nil {
		return nil, err
	}

	nodes = append(nodes, codes...)

	nodes = append(nodes, NewEl("hr", nil))

	return nodes, nil
}

func NewCmdNodes(p *Parser, el *Element) (Nodes, error) {
	if el == nil {
		return nil, ErrIsNil("element")
	}

	nodes, err := NewAttrCode(p, el)
	if err != nil {
		return nil, err
	}

	cmd, err := NewCmd(el)
	if err != nil {
		return nil, err
	}

	nodes = append(nodes, cmd)
	return nodes, nil
}