2 Commits

Autor SHA1 Mensaje Fecha
6e4ed9a1cd Implement bash CTRL-R reverse history
Fork customized liner into own repo bash.
Rename -being and -end options to -after and -before.
2021-08-08 11:37:48 +02:00
26ababc93e Begin liner integration 2021-08-08 11:31:41 +02:00
Se han modificado 5 ficheros con 53 adiciones y 156 borrados

Ver fichero

@ -2,33 +2,15 @@
hs9001 (history search 9001) is an easy, quite simple bash history enhancement. It simply writes all hs9001 (history search 9001) is an easy, quite simple bash history enhancement. It simply writes all
your bash commands into an sqlite database. You can then search this database. your bash commands into an sqlite database. You can then search this database.
It improves over bash's built-in history mechanism as it'll aggregate the shell history of all open shells,
timestamp them and also record additional information such as the directory a command was executed in.
## Usage / Examples
### Search
```
hs [search terms]
```
You can further filter with options like `-cwd`, `-after` and so on...
For a full list, see `-help`.
```
hs -cwd .
```
Lists all commands ever entered in this directory
```
hs -after yesterday -cwd . git
```
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
of bash's limited history files.
## Install ## Install
### From source
```
go build
#move hs9001 to a PATH location
```
### Debian / Ubuntu ### Debian / Ubuntu
Latest release can be installed using apt Latest release can be installed using apt
``` ```
@ -46,26 +28,31 @@ apk update
apk add hs9001 apk add hs9001
``` ```
### From source
```
go build
#move hs9001 to a PATH location
```
## Setup / Config ### Setup / Config
Add this to .bashrc Add this to .bashrc
``` ```
eval "$(hs9001 bash-enable)" eval "$(hs9001 bash-enable)"
``` ```
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"
``` ```
## Usage
### Search
```
hs9001 search [search terms]
```
It is recommended to create an alias for search to make life easier, e. g.:
```
alias searchh='hs9001 search'
```

Ver fichero

@ -2,10 +2,8 @@ package main
import ( import (
"database/sql" "database/sql"
"hs9001/liner"
"io" "io"
"log" "log"
"path/filepath"
"strings" "strings"
) )
@ -13,34 +11,13 @@ type history struct {
conn *sql.DB conn *sql.DB
} }
func createSearchOpts(query string, mode int) searchopts { func (h *history) GetHistoryByPrefix(prefix string) (ph []string) {
opts := searchopts{} opts := searchopts{}
o := "DESC" opts.order = "DESC"
opts.order = &o cmdqry := prefix + "%"
lim := 100 opts.command = &cmdqry
opts.limit = &lim
opts.command = &query
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.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")
@ -49,13 +26,13 @@ func (h *history) GetHistoryByPrefix(prefix string, mode int) (ph []string) {
} }
return return
} }
func (h *history) GetHistoryByPattern(pattern string) (ph []string, pos []int) {
func (h *history) GetHistoryByPattern(pattern string, mode int) (ph []string, pos []int) { opts := searchopts{}
cmdquery := "%" + pattern + "%" opts.order = "DESC"
opts := createSearchOpts(cmdquery, mode) 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.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")

Ver fichero

@ -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, mode int) (ph []string) GetHistoryByPrefix(prefix string) (ph []string)
GetHistoryByPattern(pattern string, mode int) (ph []string, pos []int) GetHistoryByPattern(pattern string) (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, mode int) (ph []string) { func (s *State) getHistoryByPrefix(prefix string) (ph []string) {
return s.historyProvider.GetHistoryByPrefix(prefix, mode) return s.historyProvider.GetHistoryByPrefix(prefix)
} }
func (s *State) getHistoryByPattern(pattern string, mode int) (ph []string, pos []int) { func (s *State) getHistoryByPattern(pattern string) (ph []string, pos []int) {
return s.historyProvider.GetHistoryByPattern(pattern, mode) return s.historyProvider.GetHistoryByPattern(pattern)
} }
// SetHistoryProvider allows you to set a custom provider // SetHistoryProvider allows you to set a custom provider

Ver fichero

@ -90,11 +90,6 @@ 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
@ -416,26 +411,8 @@ 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) {
modeSelect := false p := "(reverse-i-search)`': "
currentMode := ModeGlobal err := s.refresh([]rune(p), origLine, origPos)
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
} }
@ -449,10 +426,11 @@ 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)
return []rune(getPrompt(search)), []rune(foundLine), foundPos prompt := "(reverse-i-search)`%s': "
return []rune(fmt.Sprintf(prompt, search)), []rune(foundLine), foundPos
} }
history, positions := s.getHistoryByPattern(string(line), currentMode) history, positions := s.getHistoryByPattern(string(line))
historyPos := len(history) - 1 historyPos := len(history) - 1
for { for {
@ -472,8 +450,6 @@ 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++
@ -491,7 +467,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), currentMode) history, positions := s.getHistoryByPattern(string(line))
historyPos = len(history) - 1 historyPos = len(history) - 1
if len(history) > 0 { if len(history) > 0 {
foundLine = history[historyPos] foundLine = history[historyPos]
@ -504,28 +480,17 @@ 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, ctrlB, ctrlD, ctrlE, ctrlF, ctrlK, case tab, cr, lf, ctrlA, 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), currentMode) history, positions = s.getHistoryByPattern(string(line))
historyPos = len(history) - 1 historyPos = len(history) - 1
if len(history) > 0 { if len(history) > 0 {
foundLine = history[historyPos] foundLine = history[historyPos]
@ -761,7 +726,7 @@ mainLoop:
case ctrlP: // up case ctrlP: // up
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal) historyPrefix = s.getHistoryByPrefix(string(line))
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }
@ -779,7 +744,7 @@ mainLoop:
case ctrlN: // down case ctrlN: // down
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal) historyPrefix = s.getHistoryByPrefix(string(line))
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }
@ -947,7 +912,7 @@ mainLoop:
case up: case up:
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal) historyPrefix = s.getHistoryByPrefix(string(line))
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }
@ -964,7 +929,7 @@ mainLoop:
case down: case down:
historyAction = true historyAction = true
if historyStale { if historyStale {
historyPrefix = s.getHistoryByPrefix(string(line), ModeGlobal) historyPrefix = s.getHistoryByPrefix(string(line))
historyPos = len(historyPrefix) historyPos = len(historyPrefix)
historyStale = false historyStale = false
} }

38
main.go
Ver fichero

@ -157,8 +157,7 @@ type searchopts struct {
after *time.Time after *time.Time
before *time.Time before *time.Time
retval *int retval *int
order *string order string
limit *int
} }
func search(conn *sql.DB, opts searchopts) list.List { func search(conn *sql.DB, opts searchopts) list.List {
@ -189,18 +188,7 @@ func search(conn *sql.DB, opts searchopts) list.List {
args = append(args, opts.retval) args = append(args, opts.retval)
} }
sb.WriteString("ORDER BY timestamp ") sb.WriteString("ORDER BY timestamp ")
if opts.order != nil {
sb.WriteString(*opts.order)
sb.WriteRune(' ')
} else {
sb.WriteString("ASC ") sb.WriteString("ASC ")
}
if opts.limit != nil {
sb.WriteString("LIMIT ")
sb.WriteString(strconv.Itoa(*opts.limit))
sb.WriteRune(' ')
}
queryStmt := sb.String() queryStmt := sb.String()
@ -321,7 +309,6 @@ func main() {
PROMPT_COMMAND='hs9001 add -ret $? "$(history 1)"' 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"' bind -x '"\C-r": " READLINE_LINE=$(hs9001 bash-ctrlr 3>&1 1>&2 2>&3) READLINE_POINT=0"'
fi fi
alias hs='hs9001 search'
`) `)
case "bash-disable": case "bash-disable":
fmt.Printf("unset PROMPT_COMMAND\n") fmt.Printf("unset PROMPT_COMMAND\n")
@ -365,8 +352,7 @@ func main() {
q := strings.Join(args, " ") q := strings.Join(args, " ")
opts := searchopts{} opts := searchopts{}
o := "ASC" opts.order = "ASC"
opts.order = &o
if q != "" { if q != "" {
cmd := "%" + q + "%" cmd := "%" + q + "%"
opts.command = &cmd opts.command = &cmd
@ -398,31 +384,13 @@ 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 {
prefix := "" fmt.Printf("%s\n", entry.cmd)
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
} }