5 Commits

Author SHA1 Message Date
ac9aab63bd Change 'timestamp' to simple unix epoch
Subjectively, 6d4e7a96dc increases
lag on a years-old production database with ~240k entries when searching
with CTRL+R.

So change timestamp column from datetime type (which is a string)
to integer, storing unix epoch now. As we deal with those primarily,
we also avoid conversions now.

Mentioned database shrinks by 2MB compared to previously (both VACCUMed)...

DROP unused count_by_date VIEW.
2021-09-28 18:27:39 +02:00
d0e07640e8 Update README.md 2021-09-25 13:40:34 +02:00
6d4e7a96dc Implement --today
Also assign timestamp to HistoryEntry during search

Closes: #3
2021-09-25 12:49:50 +02:00
ebcdfa5ff4 Print failed commands in red.
Optimized for dark terminals :-).

Closes: #8
2021-09-25 12:14:07 +02:00
0949ee422a Implement mode for reverse search in cwd
Add a mode selection mode to liner.

Add modes to search globally or in the cwd.
2021-09-25 11:52:39 +02:00
5 changed files with 124 additions and 44 deletions

View File

@ -20,12 +20,13 @@ hs -cwd .
Lists all commands ever entered in this directory Lists all commands ever entered in this directory
``` ```
hs -after yesterday -cwd . git hs -today -cwd . git
``` ```
Lists all git commands in the current directory which have been entered today. Lists all git commands in the current directory which have been entered today.
Also, it (by default) replaces bash's built-in CTRL-R mechanism, so hs9001's database will be used instead Also, it (by default) replaces bash's built-in CTRL-R mechanism, so hs9001's database will be used instead of bash's limited history files.
of bash's limited history files.
When in reverse-search mode, you can only search the history of the current directory by pressing CTRL+A and then "w".
## Install ## Install
@ -51,9 +52,6 @@ apk add hs9001
go build go build
#move hs9001 to a PATH location #move hs9001 to a PATH location
``` ```
## Setup / Config
Add this to .bashrc Add this to .bashrc
``` ```
@ -62,8 +60,7 @@ eval "$(hs9001 bash-enable)"
This will also create a `hs`alias so you have to type less in everyday usage. This will also create a `hs`alias so you have to type less in everyday usage.
By default, every system user gets his own database. You can override this by setting the environment variable 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.
for all users that should write to your unified database.
``` ```
export HS9001_DB_PATH="/home/db/history.sqlite" export HS9001_DB_PATH="/home/db/history.sqlite"
``` ```

View File

@ -2,8 +2,10 @@ package main
import ( import (
"database/sql" "database/sql"
"hs9001/liner"
"io" "io"
"log" "log"
"path/filepath"
"strings" "strings"
) )
@ -11,14 +13,32 @@ type history struct {
conn *sql.DB conn *sql.DB
} }
func (h *history) GetHistoryByPrefix(prefix string) (ph []string) { func createSearchOpts(query string, mode int) searchopts {
opts := searchopts{} opts := searchopts{}
o := "DESC" o := "DESC"
opts.order = &o opts.order = &o
lim := 100 lim := 100
opts.limit = &lim opts.limit = &lim
cmdqry := prefix + "%" opts.command = &query
opts.command = &cmdqry
switch mode {
case liner.ModeGlobal:
break
case liner.ModeWorkdir:
workdir, err := filepath.Abs(".")
if err != nil {
panic(err)
}
opts.workdir = &workdir
default:
panic("Invalid mode supplied")
}
return opts
}
func (h *history) GetHistoryByPrefix(prefix string, mode int) (ph []string) {
cmdquery := prefix + "%"
opts := createSearchOpts(cmdquery, mode)
results := search(h.conn, opts) results := search(h.conn, opts)
for e := results.Back(); e != nil; e = e.Prev() { for e := results.Back(); e != nil; e = e.Prev() {
entry, ok := e.Value.(*HistoryEntry) entry, ok := e.Value.(*HistoryEntry)
@ -29,14 +49,11 @@ func (h *history) GetHistoryByPrefix(prefix string) (ph []string) {
} }
return return
} }
func (h *history) GetHistoryByPattern(pattern string) (ph []string, pos []int) {
opts := searchopts{} func (h *history) GetHistoryByPattern(pattern string, mode int) (ph []string, pos []int) {
o := "DESC" cmdquery := "%" + pattern + "%"
opts.order = &o opts := createSearchOpts(cmdquery, mode)
lim := 100
opts.limit = &lim
cmdqry := "%" + pattern + "%"
opts.command = &cmdqry
results := search(h.conn, opts) results := search(h.conn, opts)
for e := results.Back(); e != nil; e = e.Prev() { for e := results.Back(); e != nil; e = e.Prev() {
entry, ok := e.Value.(*HistoryEntry) entry, ok := e.Value.(*HistoryEntry)

View File

@ -37,8 +37,8 @@ type HistoryProvider interface {
WriteHistory(w io.Writer) (num int, err error) WriteHistory(w io.Writer) (num int, err error)
AppendHistory(item string) AppendHistory(item string)
ClearHistory() ClearHistory()
GetHistoryByPrefix(prefix string) (ph []string) GetHistoryByPrefix(prefix string, mode int) (ph []string)
GetHistoryByPattern(pattern string) (ph []string, pos []int) GetHistoryByPattern(pattern string, mode int) (ph []string, pos []int)
RLock() RLock()
RUnlock() RUnlock()
} }
@ -95,11 +95,11 @@ func (s *State) AppendHistory(item string) {
func (s *State) ClearHistory() { func (s *State) ClearHistory() {
s.historyProvider.ClearHistory() s.historyProvider.ClearHistory()
} }
func (s *State) getHistoryByPrefix(prefix string) (ph []string) { func (s *State) getHistoryByPrefix(prefix string, mode int) (ph []string) {
return s.historyProvider.GetHistoryByPrefix(prefix) return s.historyProvider.GetHistoryByPrefix(prefix, mode)
} }
func (s *State) getHistoryByPattern(pattern string) (ph []string, pos []int) { func (s *State) getHistoryByPattern(pattern string, mode int) (ph []string, pos []int) {
return s.historyProvider.GetHistoryByPattern(pattern) return s.historyProvider.GetHistoryByPattern(pattern, mode)
} }
// SetHistoryProvider allows you to set a custom provider // SetHistoryProvider allows you to set a custom provider

View File

@ -90,6 +90,11 @@ const (
tabReverse tabReverse
) )
const (
ModeGlobal = iota
ModeWorkdir
)
func (s *State) refresh(prompt []rune, buf []rune, pos int) error { func (s *State) refresh(prompt []rune, buf []rune, pos int) error {
if s.columns == 0 { if s.columns == 0 {
return ErrInternal return ErrInternal
@ -411,8 +416,26 @@ func (s *State) tabComplete(p []rune, line []rune, pos int) ([]rune, int, interf
// reverse intelligent search, implements a bash-like history search. // reverse intelligent search, implements a bash-like history search.
func (s *State) reverseISearch(origLine []rune, origPos int) ([]rune, int, interface{}, error) { func (s *State) reverseISearch(origLine []rune, origPos int) ([]rune, int, interface{}, error) {
p := "(reverse-i-search)`': " modeSelect := false
err := s.refresh([]rune(p), origLine, origPos) currentMode := ModeGlobal
getPrompt := func(arg string) string {
prompt := ""
switch currentMode {
case ModeWorkdir:
prompt = "(reverse:cwd)`%s': "
case ModeGlobal:
prompt = "(reverse:global)`%s': "
default:
panic("Invalid mode")
}
if modeSelect {
prompt = "(select mode)`%s': "
}
return fmt.Sprintf(prompt, arg)
}
err := s.refresh([]rune(getPrompt("")), origLine, origPos)
if err != nil { if err != nil {
return origLine, origPos, rune(esc), err return origLine, origPos, rune(esc), err
} }
@ -426,11 +449,10 @@ func (s *State) reverseISearch(origLine []rune, origPos int) ([]rune, int, inter
getLine := func() ([]rune, []rune, int) { getLine := func() ([]rune, []rune, int) {
search := string(line) search := string(line)
prompt := "(reverse-i-search)`%s': " return []rune(getPrompt(search)), []rune(foundLine), foundPos
return []rune(fmt.Sprintf(prompt, search)), []rune(foundLine), foundPos
} }
history, positions := s.getHistoryByPattern(string(line)) history, positions := s.getHistoryByPattern(string(line), currentMode)
historyPos := len(history) - 1 historyPos := len(history) - 1
for { for {
@ -450,6 +472,8 @@ func (s *State) reverseISearch(origLine []rune, origPos int) ([]rune, int, inter
} else { } else {
s.doBeep() s.doBeep()
} }
case ctrlA:
modeSelect = true
case ctrlS: // Search forward case ctrlS: // Search forward
if historyPos < len(history)-1 && historyPos >= 0 { if historyPos < len(history)-1 && historyPos >= 0 {
historyPos++ historyPos++
@ -467,7 +491,7 @@ func (s *State) reverseISearch(origLine []rune, origPos int) ([]rune, int, inter
pos -= n pos -= n
// For each char deleted, display the last matching line of history // For each char deleted, display the last matching line of history
history, positions := s.getHistoryByPattern(string(line)) history, positions := s.getHistoryByPattern(string(line), currentMode)
historyPos = len(history) - 1 historyPos = len(history) - 1
if len(history) > 0 { if len(history) > 0 {
foundLine = history[historyPos] foundLine = history[historyPos]
@ -480,17 +504,28 @@ func (s *State) reverseISearch(origLine []rune, origPos int) ([]rune, int, inter
case ctrlG: // Cancel case ctrlG: // Cancel
return origLine, origPos, rune(esc), err return origLine, origPos, rune(esc), err
case tab, cr, lf, ctrlA, ctrlB, ctrlD, ctrlE, ctrlF, ctrlK, case tab, cr, lf, ctrlB, ctrlD, ctrlE, ctrlF, ctrlK,
ctrlL, ctrlN, ctrlO, ctrlP, ctrlQ, ctrlT, ctrlU, ctrlV, ctrlW, ctrlX, ctrlY, ctrlZ: ctrlL, ctrlN, ctrlO, ctrlP, ctrlQ, ctrlT, ctrlU, ctrlV, ctrlW, ctrlX, ctrlY, ctrlZ:
fallthrough fallthrough
case 0, ctrlC, esc, 28, 29, 30, 31: case 0, ctrlC, esc, 28, 29, 30, 31:
return []rune(foundLine), foundPos, next, err return []rune(foundLine), foundPos, next, err
default: default:
if modeSelect {
switch v {
case 'g':
currentMode = ModeGlobal
case 'w':
currentMode = ModeWorkdir
}
modeSelect = false
break
}
line = append(line[:pos], append([]rune{v}, line[pos:]...)...) line = append(line[:pos], append([]rune{v}, line[pos:]...)...)
pos++ pos++
// For each keystroke typed, display the last matching line of history // For each keystroke typed, display the last matching line of history
history, positions = s.getHistoryByPattern(string(line)) history, positions = s.getHistoryByPattern(string(line), currentMode)
historyPos = len(history) - 1 historyPos = len(history) - 1
if len(history) > 0 { if len(history) > 0 {
foundLine = history[historyPos] foundLine = history[historyPos]
@ -726,7 +761,7 @@ mainLoop:
case ctrlP: // up case ctrlP: // up
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line)) historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal)
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }
@ -744,7 +779,7 @@ mainLoop:
case ctrlN: // down case ctrlN: // down
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line)) historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal)
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }
@ -912,7 +947,7 @@ mainLoop:
case up: case up:
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line)) historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal)
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }
@ -929,7 +964,7 @@ mainLoop:
case down: case down:
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line)) historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal)
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }

45
main.go
View File

@ -66,6 +66,11 @@ func migrateDatabase(conn *sql.DB, currentVersion int) {
migrations := []string{ 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", "ALTER TABLE history ADD COLUMN retval integer DEFAULT -9001",
"ALTER TABLE history ADD COLUMN unix_tmp integer",
"UPDATE history SET unix_tmp = strftime('%s', timestamp)",
"DROP VIEW count_by_date",
"ALTER TABLE history DROP COLUMN timestamp",
"ALTER TABLE history RENAME COLUMN unix_tmp TO timestamp",
} }
if !(len(migrations) > currentVersion) { if !(len(migrations) > currentVersion) {
@ -164,7 +169,7 @@ type searchopts struct {
func search(conn *sql.DB, opts searchopts) list.List { func search(conn *sql.DB, opts searchopts) list.List {
args := make([]interface{}, 0) args := make([]interface{}, 0)
var sb strings.Builder var sb strings.Builder
sb.WriteString("SELECT id, command, workdir, user, hostname, retval ") sb.WriteString("SELECT id, command, workdir, user, hostname, retval, timestamp ")
sb.WriteString("FROM history ") sb.WriteString("FROM history ")
sb.WriteString("WHERE 1=1 ") //1=1 so we can append as many AND foo as we want, or none sb.WriteString("WHERE 1=1 ") //1=1 so we can append as many AND foo as we want, or none
@ -177,11 +182,11 @@ func search(conn *sql.DB, opts searchopts) list.List {
args = append(args, opts.workdir) args = append(args, opts.workdir)
} }
if opts.after != nil { if opts.after != nil {
sb.WriteString("AND timestamp > datetime(?, 'unixepoch') ") sb.WriteString("AND timestamp > ? ")
args = append(args, opts.after.Unix()) args = append(args, opts.after.Unix())
} }
if opts.before != nil { if opts.before != nil {
sb.WriteString("AND timestamp < datetime(?, 'unixepoch') ") sb.WriteString("AND timestamp < ? ")
args = append(args, opts.before.Unix()) args = append(args, opts.before.Unix())
} }
if opts.retval != nil { if opts.retval != nil {
@ -213,10 +218,12 @@ func search(conn *sql.DB, opts searchopts) list.List {
defer rows.Close() defer rows.Close()
for rows.Next() { for rows.Next() {
var entry HistoryEntry var entry HistoryEntry
err = rows.Scan(&entry.id, &entry.cmd, &entry.cwd, &entry.user, &entry.hostname, &entry.retval) var timestamp int64
err = rows.Scan(&entry.id, &entry.cmd, &entry.cwd, &entry.user, &entry.hostname, &entry.retval, &timestamp)
if err != nil { if err != nil {
log.Panic(err) log.Panic(err)
} }
entry.timestamp = time.Unix(timestamp, 0)
result.PushBack(&entry) result.PushBack(&entry)
} }
return result return result
@ -232,7 +239,7 @@ func delete(conn *sql.DB, entryId uint32) {
} }
func add(conn *sql.DB, entry HistoryEntry) { func add(conn *sql.DB, entry HistoryEntry) {
stmt, err := conn.Prepare("INSERT INTO history (user, command, hostname, workdir, timestamp, retval) VALUES (?, ?, ?, ?, datetime(?, 'unixepoch'),?)") stmt, err := conn.Prepare("INSERT INTO history (user, command, hostname, workdir, timestamp, retval) VALUES (?, ?, ?, ?, ?,?)")
if err != nil { if err != nil {
log.Panic(err) log.Panic(err)
} }
@ -351,13 +358,14 @@ func main() {
var afterTime string var afterTime string
var beforeTime string var beforeTime string
var distinct bool = true var distinct bool = true
var today bool = false
var retVal int var retVal int
searchCmd.StringVar(&workDir, "cwd", "", "Search only within this workdir") searchCmd.StringVar(&workDir, "cwd", "", "Search only within this workdir")
searchCmd.StringVar(&afterTime, "after", "", "Start searching from this timeframe") searchCmd.StringVar(&afterTime, "after", "", "Start searching from this timeframe")
searchCmd.StringVar(&beforeTime, "before", "", "End 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.BoolVar(&distinct, "distinct", true, "Remove consecutive duplicate commands from output")
searchCmd.BoolVar(&today, "today", false, "Search only today's entries. Overrides --after")
searchCmd.IntVar(&retVal, "ret", -9001, "Only query commands that returned with this exit code. -9001=all (default)") searchCmd.IntVar(&retVal, "ret", -9001, "Only query commands that returned with this exit code. -9001=all (default)")
searchCmd.Parse(globalargs) searchCmd.Parse(globalargs)
args := searchCmd.Args() args := searchCmd.Args()
@ -378,6 +386,11 @@ func main() {
} }
opts.workdir = &wd opts.workdir = &wd
} }
if today {
afterTime = "today"
}
if afterTime != "" { if afterTime != "" {
afterTimestamp, err := naturaldate.Parse(afterTime, time.Now()) afterTimestamp, err := naturaldate.Parse(afterTime, time.Now())
if err != nil { if err != nil {
@ -398,13 +411,31 @@ func main() {
results := search(conn, opts) results := search(conn, opts)
previousCmd := "" previousCmd := ""
fi, err := os.Stdout.Stat()
if err != nil {
panic(err)
}
//Don't print colors if output is piped
printColors := true
if (fi.Mode() & os.ModeCharDevice) == 0 {
printColors = false
}
for e := results.Front(); e != nil; e = e.Next() { for e := results.Front(); e != nil; e = e.Next() {
entry, ok := e.Value.(*HistoryEntry) entry, ok := e.Value.(*HistoryEntry)
if !ok { if !ok {
log.Panic("Failed to retrieve entries") log.Panic("Failed to retrieve entries")
} }
if !distinct || previousCmd != entry.cmd { if !distinct || previousCmd != entry.cmd {
fmt.Printf("%s\n", entry.cmd) prefix := ""
postfix := ""
if printColors && entry.retval != 0 {
prefix = "\033[38;5;88m"
postfix = "\033[0m"
}
fmt.Printf("%s%s%s\n", prefix, entry.cmd, postfix)
} }
previousCmd = entry.cmd previousCmd = entry.cmd
} }