From ce3c52182a198e35cb504835e8e7800a04a95a96 Mon Sep 17 00:00:00 2001
From: Dominik Schulz <dominik.schulz@gauner.org>
Date: Fri, 18 Nov 2022 18:34:51 +0100
Subject: [PATCH] Handle vim variant nvi (#2414)

RELEASE_NOTES=[BUGFIX] Handle nvi

Fixes #2412

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>

Signed-off-by: Dominik Schulz <dominik.schulz@gauner.org>
---
 internal/editor/editor.go      | 54 ++++++++++++++++++++++++++++++----
 internal/editor/editor_test.go | 25 ++++++++++++++++
 2 files changed, 74 insertions(+), 5 deletions(-)
 create mode 100644 internal/editor/editor_test.go

diff --git a/internal/editor/editor.go b/internal/editor/editor.go
index 1067e25c..3e0819a6 100644
--- a/internal/editor/editor.go
+++ b/internal/editor/editor.go
@@ -5,8 +5,10 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"io/fs"
 	"os"
 	"os/exec"
+	"path/filepath"
 	"runtime"
 
 	"github.com/fatih/color"
@@ -59,7 +61,7 @@ func Invoke(ctx context.Context, editor string, content []byte) ([]byte, error)
 
 		editor = cmdArgs[0]
 		args = append(args, cmdArgs[1:]...)
-		args = append(args, vimOptions(editor)...)
+		args = append(args, vimOptions(resolveEditor(editor))...)
 	}
 
 	args = append(args, tmpfile.Name())
@@ -88,7 +90,7 @@ func Invoke(ctx context.Context, editor string, content []byte) ([]byte, error)
 }
 
 func vimOptions(editor string) []string {
-	if editor != "vi" && editor != "vim" && editor != "neovim" {
+	if editor != "vi" && editor != "vim" && editor != "neovim" && editor != "nvi" {
 		return []string{}
 	}
 
@@ -101,10 +103,52 @@ func vimOptions(editor string) []string {
 		viminfo = `shada=""`
 	}
 
-	return []string{
-		"-i", "NONE", // disable viminfo
-		"-n", // disable swap
+	args := []string{
 		"-c",
 		fmt.Sprintf("autocmd BufNewFile,BufRead %s setlocal noswapfile nobackup noundofile %s", path, viminfo),
 	}
+
+	if editor == "nvi" {
+		return args
+	}
+
+	args = append(args, "-i", "NONE") // disable viminfo
+	args = append(args, "-n")         // disable swap
+
+	return args
+}
+
+// resolveEditor tries to resolve the final link destination of the editor name given
+// and then extract the binary file name from the path. In practice the actual editor
+// is often hidden behing several layers of indirection and we want to get an idea
+// which options might work.
+func resolveEditor(editor string) string {
+	path, err := exec.LookPath(editor)
+	if err != nil {
+		debug.Log("failed to look up editor binary: %s", err)
+
+		return editor
+	}
+
+	for {
+		fi, err := os.Stat(path)
+		if err != nil {
+			debug.Log("failed to resolve %s: %s", path, err)
+
+			return editor
+		}
+
+		if fi.Mode()&fs.ModeSymlink != fs.ModeSymlink {
+			// not a symlink
+			break
+		}
+
+		path, err = os.Readlink(path)
+		if err != nil {
+			debug.Log("failed to read link %s: %s", path, err)
+		}
+	}
+
+	// return the binary name only
+	return filepath.Base(path)
 }
diff --git a/internal/editor/editor_test.go b/internal/editor/editor_test.go
new file mode 100644
index 00000000..fd6a99c7
--- /dev/null
+++ b/internal/editor/editor_test.go
@@ -0,0 +1,25 @@
+package editor
+
+import (
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestVimArgs(t *testing.T) {
+	t.Parallel()
+
+	if runtime.GOOS != "linux" {
+		t.Skip("not supported")
+	}
+
+	for ed, args := range map[string][]string{
+		"vi":     {"-c", "autocmd BufNewFile,BufRead /dev/shm/gopass* setlocal noswapfile nobackup noundofile viminfo=\"\"", "-i", "NONE", "-n"},
+		"nvi":    {"-c", "autocmd BufNewFile,BufRead /dev/shm/gopass* setlocal noswapfile nobackup noundofile viminfo=\"\""},
+		"neovim": {"-c", "autocmd BufNewFile,BufRead /dev/shm/gopass* setlocal noswapfile nobackup noundofile shada=\"\"", "-i", "NONE", "-n"},
+		"vim":    {"-c", "autocmd BufNewFile,BufRead /dev/shm/gopass* setlocal noswapfile nobackup noundofile viminfo=\"\"", "-i", "NONE", "-n"},
+	} {
+		assert.Equal(t, vimOptions(ed), args, ed)
+	}
+}