refactor search function. rename -being and -end to -after and -before

The nolog subcommand instructs the user on how to disable logging
for the current shell. This is not (easily) doable automatically
since we can't affect a parent's environment without insane hacks.

Fixes #4

Makefile

@@ -0,0 +1,6 @@
+GIT_COMMIT=$(shell git rev-list -1 HEAD)
+GIT_TAG=$(shell git tag --sort="-version:refname" | head -n 1)
+all:
+	go build -ldflags "-X main.GitCommit=${GIT_COMMIT} -X main.GitTag=${GIT_TAG}"
+
+

README.md

@@ -34,9 +34,7 @@ apk add hs9001
 Add this to .bashrc
 
 ```
-if [ -n "$PS1" ] ; then
+eval "$(hs9001 bash-enable)"
-    PROMPT_COMMAND='hs9001 add -ret $? "$(history 1)"'
-fi
 ```
 By default, every system user gets his own database. You can override this by setting the environment variable
 for all users that should write to your unified database.

go.mod

@@ -3,6 +3,7 @@ module hs9001
 go 1.16
 
 require (
+	github.com/peterh/liner v1.2.1 
 	github.com/tj/go-naturaldate v1.3.0
 	modernc.org/sqlite v1.10.0
 )

go.sum

@@ -8,8 +8,12 @@ github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNU
 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8=
 github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
 github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/mattn/go-runewidth v0.0.3 h1:a+kO+98RDGEfo6asOGMmpodZq4FNtnGP54yps8BzLR4=
+github.com/mattn/go-runewidth v0.0.3/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
 github.com/mattn/go-sqlite3 v1.14.6 h1:dNPt6NO46WmLVt2DLNpwczCmdV5boIZ6g/tlDrlRUbg=
 github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU=
+github.com/peterh/liner v1.2.1 h1:O4BlKaq/LWu6VRWmol4ByWfzx6MfXc5Op5HETyIy5yg=
+github.com/peterh/liner v1.2.1/go.mod h1:CRroGNssyjTd/qIG2FyxByd2S8JEAZXBl4qUrZf8GS0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 h1:OdAsTTz6OkFY5QxjkYwrChwuRruF69c169dPK26NUlk=
@@ -50,7 +54,6 @@ golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8T
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

history.go

@@ -0,0 +1,63 @@
+package main
+
+import (
+	"database/sql"
+	"io"
+	"log"
+	"strings"
+)
+
+type history struct {
+	conn *sql.DB
+}
+
+func (h *history) GetHistoryByPrefix(prefix string) (ph []string) {
+	opts := searchopts{}
+	opts.order = "DESC"
+	cmdqry := prefix + "%"
+	opts.command = &cmdqry
+	results := search(h.conn, opts)
+	for e := results.Front(); e != nil; e = e.Next() {
+		entry, ok := e.Value.(*HistoryEntry)
+		if !ok {
+			log.Panic("Failed to retrieve entries")
+		}
+		ph = append(ph, entry.cmd)
+	}
+	return
+}
+func (h *history) GetHistoryByPattern(pattern string) (ph []string, pos []int) {
+	opts := searchopts{}
+	opts.order = "DESC"
+	cmdqry := "%" + pattern + "%"
+	opts.command = &cmdqry
+	results := search(h.conn, opts)
+	for e := results.Front(); e != nil; e = e.Next() {
+		entry, ok := e.Value.(*HistoryEntry)
+		if !ok {
+			log.Panic("Failed to retrieve entries")
+		}
+		ph = append(ph, entry.cmd)
+		pos = append(pos, strings.Index(strings.ToLower(entry.cmd), strings.ToLower(pattern)))
+	}
+	return
+}
+
+func (h *history) ReadHistory(r io.Reader) (num int, err error) {
+	panic("not implemented")
+}
+func (h *history) WriteHistory(w io.Writer) (num int, err error) {
+	panic("not implemented")
+}
+func (h *history) AppendHistory(item string) {
+	panic("not implemented")
+}
+func (h *history) ClearHistory() {
+	panic("not implemented")
+}
+func (h *history) RLock() {
+	//noop
+}
+func (h *history) RUnlock() {
+	//noop
+}

main.go

@@ -10,9 +10,11 @@ import (
 	"os"
 	"path/filepath"
 	"regexp"
+	"strconv"
 	"strings"
 	"time"
 
+	"github.com/peterh/liner"
 	"github.com/tj/go-naturaldate"
 	_ "modernc.org/sqlite"
 )
@@ -23,9 +25,13 @@ type HistoryEntry struct {
 	cwd       string
 	hostname  string
 	user      string
+	retval    int
 	timestamp time.Time
 }
 
+var GitTag string
+var GitCommit string
+
 func databaseLocation() string {
 	envOverride := os.Getenv("HS9001_DB_PATH")
 	if envOverride != "" {
@@ -57,7 +63,8 @@ func initDatabase(conn *sql.DB) {
 func migrateDatabase(conn *sql.DB, currentVersion int) {
 
 	migrations := []string{
-		"ALTER TABLE history add column workdir varchar(4096) DEFAULT ''",
+		"ALTER TABLE history ADD COLUMN workdir varchar(4096) DEFAULT ''",
+		"ALTER TABLE history ADD COLUMN retval integer DEFAULT -9001",
 	}
 
 	if !(len(migrations) > currentVersion) {
@@ -103,7 +110,7 @@ func setDBVersion(conn *sql.DB, ver int) {
 	}
 }
 
-func NewHistoryEntry(cmd string) HistoryEntry {
+func NewHistoryEntry(cmd string, retval int) HistoryEntry {
 	wd, err := os.Getwd()
 	if err != nil {
 		log.Panic(err)
@@ -118,6 +125,7 @@ func NewHistoryEntry(cmd string) HistoryEntry {
 		cmd:       cmd,
 		cwd:       wd,
 		timestamp: time.Now(),
+		retval:    retval,
 	}
 }
 
@@ -130,7 +138,7 @@ func importFromStdin(conn *sql.DB) {
 	}
 
 	for scanner.Scan() {
-		entry := NewHistoryEntry(scanner.Text())
+		entry := NewHistoryEntry(scanner.Text(), -9001)
 		entry.cwd = ""
 		entry.timestamp = time.Unix(0, 0)
 		add(conn, entry)
@@ -142,10 +150,48 @@ func importFromStdin(conn *sql.DB) {
 	}
 }
 
-func search(conn *sql.DB, q string, workdir string, beginTime time.Time, endTime time.Time) list.List {
+type searchopts struct {
-	queryStmt := "SELECT id, command, workdir, user, hostname FROM history WHERE timestamp BETWEEN datetime(?, 'unixepoch') AND datetime(?, 'unixepoch') AND command LIKE ? AND workdir LIKE ? ORDER BY timestamp ASC"
+	command *string
+	workdir *string
+	after   *time.Time
+	before  *time.Time
+	retval  *int
+	order   string
+}
 
-	rows, err := conn.Query(queryStmt, beginTime.Unix(), endTime.Unix(), q, workdir)
+func search(conn *sql.DB, opts searchopts) list.List {
+	args := make([]interface{}, 0)
+	var sb strings.Builder
+	sb.WriteString("SELECT id, command, workdir, user, hostname, retval ")
+	sb.WriteString("FROM history ")
+	sb.WriteString("WHERE 1=1 ") //1=1 so we can append as many AND foo as we want, or none
+
+	if opts.command != nil {
+		sb.WriteString("AND command LIKE ? ")
+		args = append(args, opts.command)
+	}
+	if opts.workdir != nil {
+		sb.WriteString("AND workdir LIKE ? ")
+		args = append(args, opts.workdir)
+	}
+	if opts.after != nil {
+		sb.WriteString("AND timestamp > datetime(?, 'unixepoch') ")
+		args = append(args, opts.after.Unix())
+	}
+	if opts.before != nil {
+		sb.WriteString("AND timestamp < datetime(?, 'unixepoch') ")
+		args = append(args, opts.before.Unix())
+	}
+	if opts.retval != nil {
+		sb.WriteString("AND retval = ? ")
+		args = append(args, opts.retval)
+	}
+	sb.WriteString("ORDER BY timestamp ")
+	sb.WriteString("ASC ")
+
+	queryStmt := sb.String()
+
+	rows, err := conn.Query(queryStmt, args...)
 	if err != nil {
 		log.Panic(err)
 	}
@@ -154,7 +200,7 @@ func search(conn *sql.DB, q string, workdir string, beginTime time.Time, endTime
 	defer rows.Close()
 	for rows.Next() {
 		var entry HistoryEntry
-		err = rows.Scan(&entry.id, &entry.cmd, &entry.cwd, &entry.user, &entry.hostname)
+		err = rows.Scan(&entry.id, &entry.cmd, &entry.cwd, &entry.user, &entry.hostname, &entry.retval)
 		if err != nil {
 			log.Panic(err)
 		}
@@ -173,12 +219,12 @@ func delete(conn *sql.DB, entryId uint32) {
 }
 
 func add(conn *sql.DB, entry HistoryEntry) {
-	stmt, err := conn.Prepare("INSERT INTO history (user, command, hostname, workdir, timestamp) VALUES (?, ?, ?, ?, datetime(?, 'unixepoch'))")
+	stmt, err := conn.Prepare("INSERT INTO history (user, command, hostname, workdir, timestamp, retval) VALUES (?, ?, ?, ?, datetime(?, 'unixepoch'),?)")
 	if err != nil {
 		log.Panic(err)
 	}
 
-	_, err = stmt.Exec(entry.user, entry.cmd, entry.hostname, entry.cwd, entry.timestamp.Unix())
+	_, err = stmt.Exec(entry.user, entry.cmd, entry.hostname, entry.cwd, entry.timestamp.Unix(), entry.retval)
 	if err != nil {
 		log.Panic(err)
 	}
@@ -209,7 +255,7 @@ func exists(path string) (bool, error) {
 }
 
 func printUsage() {
-	fmt.Fprintf(os.Stderr, "Usage:   ./hs9001 <add/search/import>\n")
+	fmt.Fprintf(os.Stderr, "Usage:   ./hs9001 <add/search/import/nolog/bash-enable>\n")
 }
 
 func main() {
@@ -241,6 +287,29 @@ func main() {
 	migrateDatabase(conn, fetchDBVersion(conn))
 
 	switch cmd {
+	case "bash-ctrlr":
+		line := liner.NewLiner()
+		defer line.Close()
+		line.SetCtrlCAborts(true)
+		line.SetHistoryProvider(&history{conn: conn})
+
+		rdlineline := os.Getenv("READLINE_LINE")
+		rdlinepos := os.Getenv("READLINE_POS")
+		rdlineposint, _ := strconv.Atoi(rdlinepos)
+
+		if name, err := line.PromptWithSuggestionReverse("", rdlineline, rdlineposint); err == nil {
+			fmt.Fprintf(os.Stderr, "%s\n", name)
+		}
+
+	case "bash-enable":
+		fmt.Printf(`
+			if [ -n "$PS1" ] ; then
+				PROMPT_COMMAND='hs9001 add -ret $? "$(history 1)"'
+				bind -x '"\C-r": " READLINE_LINE=$(hs9001 bash-ctrlr 3>&1 1>&2 2>&3) READLINE_POINT=0"'
+			fi
+		`)
+	case "bash-disable":
+		fmt.Printf("unset PROMPT_COMMAND\n")
 	case "add":
 		var ret int
 		addCmd.IntVar(&ret, "ret", 0, "Return value of the command to add")
@@ -255,47 +324,74 @@ func main() {
 
 		}
 		historycmd := args[0]
-		var rgx = regexp.MustCompile("\\s+\\d+\\s+(.*)")
+		var rgx = regexp.MustCompile(`\s+\d+\s+(.*)`)
 		rs := rgx.FindStringSubmatch(historycmd)
 		if len(rs) == 2 {
-			add(conn, NewHistoryEntry(rs[1]))
+			add(conn, NewHistoryEntry(rs[1], ret))
 		}
 	case "search":
 		fallthrough
 	case "delete":
 		var workDir string
-		var beginTime string
+		var afterTime string
-		var endTime string
+		var beforeTime string
-
+		var distinct bool = true
-		searchCmd.StringVar(&workDir, "workdir", "%", "Search only within this workdir")
+		var retVal int
-		searchCmd.StringVar(&beginTime, "begin", "50 years ago", "Start searching from this timeframe")
+		searchCmd.StringVar(&workDir, "cwd", "", "Search only within this workdir")
-		searchCmd.StringVar(&endTime, "end", "now", "End searching from this timeframe")
+		searchCmd.StringVar(&afterTime, "after", "", "Start searching from this timeframe")
+		searchCmd.StringVar(&beforeTime, "before", "", "End searching from this timeframe")
+		searchCmd.BoolVar(&distinct, "distinct", true, "Remove consecutive duplicate commands from output")
+		searchCmd.IntVar(&retVal, "ret", -9001, "Only query commands that returned with this exit code. -9001=all (default)")
 
 		searchCmd.Parse(globalargs)
 
 		args := searchCmd.Args()
 
-		beginTimestamp, err := naturaldate.Parse(beginTime, time.Now())
-		if err != nil {
-			fmt.Fprintf(os.Stderr, "Failed to convert time string: %s\n", err.Error())
-		}
-
-		endTimeStamp, err := naturaldate.Parse(endTime, time.Now())
-		if err != nil {
-			fmt.Fprintf(os.Stderr, "Failed to convert time string: %s\n", err.Error())
-		}
-
 		q := strings.Join(args, " ")
-		results := search(conn, "%"+q+"%", workDir, beginTimestamp, endTimeStamp)
 
+		opts := searchopts{}
+		opts.order = "ASC"
+		if q != "" {
+			cmd := "%" + q + "%"
+			opts.command = &cmd
+		}
+		if workDir != "" {
+			wd, err := filepath.Abs(workDir)
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "Failed parse working directory path: %s\n", err.Error())
+			}
+			opts.workdir = &wd
+		}
+		if afterTime != "" {
+			afterTimestamp, err := naturaldate.Parse(afterTime, time.Now())
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "Failed to convert time string: %s\n", err.Error())
+			}
+			opts.after = &afterTimestamp
+		}
+		if beforeTime != "" {
+			beforeTimestamp, err := naturaldate.Parse(beforeTime, time.Now())
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "Failed to convert time string: %s\n", err.Error())
+			}
+			opts.before = &beforeTimestamp
+		}
+		if retVal != -9001 {
+			opts.retval = &retVal
+		}
+		results := search(conn, opts)
+
+		previousCmd := ""
 		for e := results.Front(); e != nil; e = e.Next() {
 			entry, ok := e.Value.(*HistoryEntry)
 			if !ok {
 				log.Panic("Failed to retrieve entries")
 			}
-
+			if !distinct || previousCmd != entry.cmd {
 				fmt.Printf("%s\n", entry.cmd)
 			}
+			previousCmd = entry.cmd
+		}
 
 		if cmd == "delete" {
 
@@ -326,6 +422,8 @@ func main() {
 		os.Exit(23)
 	case "import":
 		importFromStdin(conn)
+	case "version":
+		fmt.Fprintf(os.Stdout, "Git Tag: %s\nGit Commit: %s\n", GitTag, GitCommit)
 	default:
 		fmt.Fprintf(os.Stderr, "Error: Unknown subcommand '%s' supplied\n\n", cmd)
 		printUsage()