jira-cli/pkg/surveyext/editor_manual.go

107 lines
2.4 KiB
Go

package surveyext
import (
"bytes"
"io"
"os"
"os/exec"
"runtime"
"github.com/cli/safeexec"
shellquote "github.com/kballard/go-shellquote"
)
type showable interface {
Show() error
}
func defaultLookPath(name string) ([]string, []string, error) {
exe, err := safeexec.LookPath(name)
if err != nil {
return nil, nil, err
}
return []string{exe}, nil, nil
}
func needsBom() bool {
// The reason why we do this is because notepad.exe on Windows determines the
// encoding of an "empty" text file by the locale, for example, GBK in China,
// while golang string only handles utf8 well. However, a text file with utf8
// BOM header is not considered "empty" on Windows, and the encoding will then
// be determined utf8 by notepad.exe, instead of GBK or other encodings.
// This could be enhanced in the future by doing this only when a non-utf8
// locale is in use, and possibly doing that for any OS, not just windows.
return runtime.GOOS == "windows"
}
func edit(editorCommand, fn, initialValue string, stdin io.Reader, stdout io.Writer, stderr io.Writer, cursor showable, lookPath func(string) ([]string, []string, error)) (string, error) {
// prepare the temp file
pattern := fn
if pattern == "" {
pattern = "survey*.md"
}
f, err := os.CreateTemp("", pattern)
if err != nil {
return "", err
}
defer func() { _ = os.Remove(f.Name()) }()
// write utf8 BOM header if necessary for the current platform and/or locale
if needsBom() {
if _, err := f.Write(bom); err != nil {
return "", err
}
}
// write initial value
if _, err := f.WriteString(initialValue); err != nil {
return "", err
}
// close the fd to prevent the editor unable to save file
if err := f.Close(); err != nil {
return "", err
}
if editorCommand == "" {
editorCommand = defaultEditor
}
args, err := shellquote.Split(editorCommand)
if err != nil {
return "", err
}
args = append(args, f.Name())
editorExe, env, err := lookPath(args[0])
if err != nil {
return "", err
}
args = append(editorExe, args[1:]...)
cmd := exec.Command(args[0], args[1:]...)
cmd.Env = env
cmd.Stdin = stdin
cmd.Stdout = stdout
cmd.Stderr = stderr
if cursor != nil {
_ = cursor.Show()
}
// open the editor
if err := cmd.Run(); err != nil {
return "", err
}
// raw is a BOM-unstripped UTF8 byte slice
raw, err := os.ReadFile(f.Name())
if err != nil {
return "", err
}
// strip BOM header
return string(bytes.TrimPrefix(raw, bom)), nil
}