gotenberg/app/converter/process/process.go

// Package process handles all commands executions.
package process

import (
	"bytes"
	"fmt"
	"os/exec"
	"sync"
	"time"

	"github.com/thecodingmachine/gotenberg/app/config"
	gfile "github.com/thecodingmachine/gotenberg/app/converter/file"
	"github.com/thecodingmachine/gotenberg/app/logger"
)

type runner struct {
	mu sync.Mutex
}

var forest = &runner{}

type commandTimeoutError struct {
	command string
	timeout int
}

const commandTimeoutErrorMessage = "the command %s has reached the %d second(s) timeout"

func (e *commandTimeoutError) Error() string {
	return fmt.Sprintf(commandTimeoutErrorMessage, e.command, e.timeout)
}

// run runs the given command. If timeout is reached or
// something bad happened, returns an error.
func (r *runner) run(command string, interpreter []string, timeout int) error {
	if config.HasLock() {
		r.mu.Lock()
		defer r.mu.Unlock()
	} else {
		logger.Warn("lock disabled")
	}

	binary := interpreter[0]
	parameters := append(interpreter[1:], command)
	cmd := exec.Command(binary, parameters...)
	logger.Debugf("executing command %s", cmd.Args)

	if err := cmd.Start(); err != nil {
		return err
	}

	done := make(chan error, 1)
	go func() {
		done <- cmd.Wait()
	}()

	// wait for the process to finish or kill it after a timeout.
	select {
	case <-time.After(time.Duration(timeout) * time.Second):
		if err := cmd.Process.Kill(); err != nil {
			return err
		}

		return &commandTimeoutError{command, timeout}
	case err := <-done:
		if err != nil {
			return err
		}

		return nil
	}
}

// conversionData will be applied to the data-driven templates of conversions commands.
type conversionData struct {
	FilePath       string
	ResultFilePath string
}

// Unconv converts a file to PDF and returns the new file path.
func Unconv(workingDir string, file *gfile.File) (string, error) {
	cmdData := &conversionData{file.Path, gfile.MakeFilePath(workingDir, ".pdf")}

	cmd, err := config.GetCommand(file.Extension)
	if err != nil {
		return "", err
	}

	var data bytes.Buffer
	if err := cmd.Template.Execute(&data, cmdData); err != nil {
		return "", err
	}

	err = forest.run(data.String(), cmd.Interpreter, cmd.Timeout)
	if err != nil {
		return "", err
	}

	logger.Debugf("created %s from %s", cmdData.ResultFilePath, cmdData.FilePath)
	return cmdData.ResultFilePath, nil
}

// mergeData will be applied to the data-driven template of the merge command.
type mergeData struct {
	FilesPaths     []string
	ResultFilePath string
}

// Merge merges many PDF files to one unique PDF file and returns the new file path.
func Merge(workingDir string, filesPaths []string) (string, error) {
	cmdData := &mergeData{filesPaths, gfile.MakeFilePath(workingDir, ".pdf")}

	cmd, err := config.GetCommand(".pdf")
	if err != nil {
		return "", err
	}

	var data bytes.Buffer
	if err := cmd.Template.Execute(&data, cmdData); err != nil {
		return "", err
	}

	err = forest.run(data.String(), cmd.Interpreter, cmd.Timeout)
	if err != nil {
		return "", err
	}

	logger.Debugf("created %s from %+v", cmdData.ResultFilePath, cmdData.FilesPaths)
	return cmdData.ResultFilePath, nil
}