pda/cmd/shared.go

/*
Copyright © 2025 Lewis Wynne <lew@ily.rs>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

package cmd

import (
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"
	"time"
	"unicode/utf8"

	"github.com/agnivade/levenshtein"
	"github.com/dgraph-io/badger/v4"
	gap "github.com/muesli/go-app-paths"
	"golang.org/x/term"
)

type errNotFound struct {
	suggestions []string
}

const (
	metaSecret byte = 0x1
)

func (err errNotFound) Error() string {
	if len(err.suggestions) == 0 {
		return "No such key"
	}
	return fmt.Sprintf("No such key. Did you mean '%s'?", strings.Join(err.suggestions, ", "))
}

type Store struct{}

type TransactionArgs struct {
	key      string
	readonly bool
	sync     bool
	transact func(tx *badger.Txn, key []byte) error
}

func (s *Store) Transaction(args TransactionArgs) error {
	spec, err := s.parseKey(args.key, true)
	if err != nil {
		return err
	}

	db, err := s.open(spec.DB)
	if err != nil {
		return err
	}
	defer db.Close()

	if args.sync {
		err = db.Sync()
		if err != nil {
			return err
		}
	}

	tx := db.NewTransaction(!args.readonly)
	defer tx.Discard()

	if err := args.transact(tx, []byte(spec.Key)); err != nil {
		return err
	}

	if args.readonly {
		return nil
	}

	return tx.Commit()
}

func (s *Store) Print(pf string, includeBinary bool, vs ...[]byte) {
	s.PrintTo(os.Stdout, pf, includeBinary, vs...)
}

func (s *Store) PrintTo(w io.Writer, pf string, includeBinary bool, vs ...[]byte) {
	tty := term.IsTerminal(int(os.Stdout.Fd()))
	fvs := make([]any, 0, len(vs))
	for _, v := range vs {
		fvs = append(fvs, s.formatBytes(includeBinary, v))
	}
	fmt.Fprintf(w, pf, fvs...)
	if w == os.Stdout && tty && !strings.HasSuffix(pf, "\n") {
		fmt.Fprintln(os.Stdout)
	}
}

func (s *Store) FormatBytes(includeBinary bool, v []byte) string {
	return s.formatBytes(includeBinary, v)
}

func (s *Store) formatBytes(includeBinary bool, v []byte) string {
	tty := term.IsTerminal(int(os.Stdout.Fd()))
	if tty && !includeBinary && !utf8.Valid(v) {
		return "(omitted binary data)"
	}
	return string(v)
}

func (s *Store) AllStores() ([]string, error) {
	path, err := s.path()
	if err != nil {
		return nil, err
	}
	dirs, err := os.ReadDir(path)
	if err != nil {
		return nil, err
	}
	var stores []string
	for _, e := range dirs {
		if e.IsDir() {
			stores = append(stores, e.Name())
		}
	}
	return stores, nil
}

func (s *Store) FindStore(k string) (string, error) {
	n, err := s.parseDB(k, false)
	if err != nil {
		return "", err
	}
	path, err := s.path(n)
	if err != nil {
		return "", err
	}
	info, statErr := os.Stat(path)
	if strings.TrimSpace(n) == "" || os.IsNotExist(statErr) || (statErr == nil && !info.IsDir()) {
		suggestions, err := s.suggestStores(n)
		if err != nil {
			return "", err
		}
		return "", errNotFound{suggestions}
	}
	if statErr != nil {
		return "", statErr
	}
	return path, nil
}

func (s *Store) parseKey(raw string, defaults bool) (KeySpec, error) {
	return ParseKey(raw, defaults)
}

func (s *Store) parseDB(v string, defaults bool) (string, error) {
	db := strings.TrimSpace(v)
	if after, ok := strings.CutPrefix(db, "@"); ok {
		db = after
	}
	if db == "" {
		if defaults {
			return config.Store.DefaultStoreName, nil
		}
		return "", fmt.Errorf("cannot parse store: bad store format, use STORE or @STORE")
	}
	if err := validateDBName(db); err != nil {
		return "", fmt.Errorf("cannot parse store: %w", err)
	}
	return strings.ToLower(db), nil
}

func (s *Store) open(name string) (*badger.DB, error) {
	if name == "" {
		name = config.Store.DefaultStoreName
	}
	path, err := s.path(name)
	if err != nil {
		return nil, err
	}
	return badger.Open(badger.DefaultOptions(path).WithLoggingLevel(badger.ERROR))
}

func (s *Store) path(args ...string) (string, error) {
	if override := os.Getenv("PDA_DATA"); override != "" {
		if err := os.MkdirAll(override, 0o750); err != nil {
			return "", err
		}
		target := filepath.Join(append([]string{override}, args...)...)
		if err := ensureSubpath(override, target); err != nil {
			return "", err
		}
		return target, nil
	}
	scope := gap.NewVendorScope(gap.User, "pda", "stores")
	dir, err := scope.DataPath("")
	if err != nil {
		return "", err
	}
	if err := os.MkdirAll(dir, 0o750); err != nil {
		return "", err
	}
	target := filepath.Join(append([]string{dir}, args...)...)
	if err := ensureSubpath(dir, target); err != nil {
		return "", err
	}
	return target, nil
}

func (s *Store) suggestStores(target string) ([]string, error) {
	stores, err := s.AllStores()
	if err != nil {
		return nil, err
	}
	target = strings.TrimSpace(target)
	minThreshold := 1
	maxThreshold := 4
	threshold := min(max(len(target)/3, minThreshold), maxThreshold)
	var suggestions []string
	for _, store := range stores {
		distance := levenshtein.ComputeDistance(target, store)
		if distance <= threshold {
			suggestions = append(suggestions, store)
		}
	}
	return suggestions, nil
}

func ensureSubpath(base, target string) error {
	absBase, err := filepath.Abs(base)
	if err != nil {
		return err
	}
	absTarget, err := filepath.Abs(target)
	if err != nil {
		return err
	}
	rel, err := filepath.Rel(absBase, absTarget)
	if err != nil {
		return err
	}
	sep := string(filepath.Separator)
	if rel == ".." || strings.HasPrefix(rel, ".."+sep) {
		return fmt.Errorf("path escapes store root")
	}
	return nil
}

func validateDBName(name string) error {
	if strings.ContainsAny(name, `/\~`) {
		return fmt.Errorf("bad store format, use STORE or @STORE")
	}
	return nil
}

func formatExpiry(expiresAt uint64) string {
	if expiresAt == 0 {
		return "never"
	}
	expiry := time.Unix(int64(expiresAt), 0).UTC()
	remaining := time.Until(expiry)
	if remaining <= 0 {
		return fmt.Sprintf("%s (expired)", expiry.Format(time.RFC3339))
	}
	return fmt.Sprintf("%s (in %s)", expiry.Format(time.RFC3339), remaining.Round(time.Second))
}

// Keys returns all keys for the provided store name (or default if empty).
// Keys are returned in lowercase to mirror stored key format.
func (s *Store) Keys(dbName string) ([]string, error) {
	db, err := s.open(dbName)
	if err != nil {
		return nil, err
	}
	defer db.Close()

	tx := db.NewTransaction(false)
	defer tx.Discard()

	it := tx.NewIterator(badger.DefaultIteratorOptions)
	defer it.Close()

	var keys []string
	for it.Rewind(); it.Valid(); it.Next() {
		item := it.Item()
		keys = append(keys, string(item.Key()))
	}
	return keys, nil
}