terminal.go

// Utiltities for formatting Ripple data in a terminal
package terminal

import (
	"fmt"
	"reflect"

	"github.com/atticlab/ripple/data"
	"github.com/atticlab/ripple/websockets"
	"github.com/fatih/color"
)

type Flag uint32

const (
	Indent Flag = 1 << iota
	DoubleIndent
	TripleIndent

	ShowLedgerSequence
	ShowTransactionId
)

var Default Flag

var (
	ledgerStyle     = color.New(color.FgRed, color.Underline)
	leStyle         = color.New(color.FgWhite)
	txStyle         = color.New(color.FgGreen)
	proposalStyle   = color.New(color.FgYellow)
	validationStyle = color.New(color.FgYellow, color.Bold)
	tradeStyle      = color.New(color.FgBlue)
	balanceStyle    = color.New(color.FgMagenta)
	pathStyle       = color.New(color.FgYellow)
	offerStyle      = color.New(color.FgYellow)
	lineStyle       = color.New(color.FgYellow)
	infoStyle       = color.New(color.FgRed)
)

func defaultUint32(v *uint32) uint32 {
	if v != nil {
		return *v
	}
	return 0
}

func BoolSymbol(v bool) string {
	if v {
		return "✓"
	}
	return "✗"
}

func MemoSymbol(tx data.Transaction) string {
	return BoolSymbol(len(tx.GetBase().Memos) > 0)
}

func SignSymbol(s data.SignerAgent) string {
	valid, err := data.CheckSignature(s)
	return BoolSymbol(!valid || err != nil)
}

type bundle struct {
	color  *color.Color
	format string
	values []interface{}
	flag   Flag
}

func newLeBundle(v interface{}, flag Flag) (*bundle, error) {
	var (
		format = "%-11s "
		values = []interface{}{v.(data.LedgerEntry).GetLedgerEntryType()}
	)
	switch le := v.(type) {
	case *data.AccountRoot:
		format += "%-34s %08X %s"
		values = append(values, []interface{}{le.Account, *le.Flags, le.Balance}...)
	case *data.LedgerHashes:
		format += "%d hashes"
		values = append(values, []interface{}{len(*le.Hashes)}...)
	case *data.RippleState:
		format += "%s %s %s"
		values = append(values, []interface{}{le.Balance, le.HighLimit, le.LowLimit}...)
	case *data.Offer:
		format += "%-34s %-60s %-60s %-18s"
		values = append(values, []interface{}{le.Account, le.TakerPays, le.TakerGets, le.Ratio()}...)
	case *data.FeeSettings:
		format += "%d %d %d %d"
		values = append(values, []interface{}{le.BaseFee, le.ReferenceFeeUnits, le.ReserveBase, le.ReserveIncrement}...)
	case *data.Amendments:
		format += "%s"
		values = append(values, []interface{}{le.Amendments}...)
	default:
		return nil, fmt.Errorf("Unknown Ledger Entry Type")
	}
	return &bundle{
		color:  leStyle,
		format: format,
		values: values,
		flag:   flag,
	}, nil
}

func newTxBundle(v data.Transaction, insert string, flag Flag) (*bundle, error) {
	var (
		base   = v.GetBase()
		format = "%s %-11s %-8s %s%s %-34s %-9d "
		values = []interface{}{SignSymbol(v), base.GetType(), base.Fee, insert, MemoSymbol(v), base.Account, base.Sequence}
	)
	if flag&ShowTransactionId > 0 {
		txId, err := data.NodeId(v)
		if err != nil {
			return nil, err
		}
		format = "%s " + format
		values = append([]interface{}{txId}, values...)
	}
	switch tx := v.(type) {
	case *data.Payment:
		format += "=> %-34s %-60s %-60s"
		values = append(values, []interface{}{tx.Destination, tx.Amount, tx.SendMax}...)
	case *data.OfferCreate:
		format += "%-9d %-60s %-60s %-18s"
		values = append(values, []interface{}{defaultUint32(tx.OfferSequence), tx.TakerPays, tx.TakerGets, tx.Ratio()}...)
	case *data.OfferCancel:
		format += "%-9d"
		values = append(values, tx.OfferSequence)
	case *data.AccountSet:
		format += "%-9d"
		values = append(values, tx.Sequence)
	case *data.TrustSet:
		format += "%-60s %d %d"
		values = append(values, tx.LimitAmount, tx.QualityIn, tx.QualityOut)
	}
	return &bundle{
		color:  txStyle,
		format: format,
		values: values,
		flag:   flag,
	}, nil
}

func newTxmBundle(txm *data.TransactionWithMetaData, flag Flag) (*bundle, error) {
	insert := fmt.Sprintf("%s ", txm.MetaData.TransactionResult.Symbol())
	if flag&ShowLedgerSequence > 0 {
		insert = fmt.Sprintf("%-9d %s", txm.LedgerSequence, insert)
	}
	b, err := newTxBundle(txm.Transaction, insert, flag)
	if err != nil {
		return nil, err
	}
	if len(txm.MetaData.AffectedNodes) == 0 {
		// Likely a proposed transaction
		b.color = proposalStyle
	} else if !txm.MetaData.TransactionResult.Success() {
		b.color = infoStyle
	}
	return b, nil
}

func newBundle(value interface{}, flag Flag) (*bundle, error) {
	switch v := value.(type) {
	case *data.TransactionWithMetaData:
		return newTxmBundle(v, flag)
	case data.Transaction:
		return newTxBundle(v, "", flag)
	case data.LedgerEntry:
		return newLeBundle(v, flag)
	}
	switch v := reflect.Indirect(reflect.ValueOf(value)).Interface().(type) {
	case websockets.LedgerStreamMsg:
		return &bundle{
			color:  ledgerStyle,
			format: "Ledger %d closed at %s with %d transactions",
			values: []interface{}{v.LedgerSequence, v.LedgerTime.String(), v.TxnCount},
			flag:   flag,
		}, nil
	case websockets.ServerStreamMsg:
		return &bundle{
			color:  infoStyle,
			format: "Server Status: %s (%d/%d)",
			values: []interface{}{v.Status, v.LoadFactor, v.LoadBase},
			flag:   flag,
		}, nil
	case data.Ledger:
		return &bundle{
			color:  ledgerStyle,
			format: "Ledger %d closed at %s",
			values: []interface{}{v.LedgerSequence, v.CloseTime.String()},
			flag:   flag,
		}, nil
	case data.InnerNode:
		return &bundle{
			color:  leStyle,
			format: "%s: %d hashes",
			values: []interface{}{v.Type, v.Count()},
			flag:   flag,
		}, nil
	case data.Proposal:
		return &bundle{
			color:  proposalStyle,
			format: "%s Proposal:   %s %s %s %s",
			values: []interface{}{SignSymbol(&v), v.PublicKey.NodePublicKey(), v.CloseTime.String(), v.PreviousLedger, v.LedgerHash},
			flag:   flag,
		}, nil
	case data.Validation:
		return &bundle{
			color:  validationStyle,
			format: "%s Validation: %s %s %s %-8d %08X %s",
			values: []interface{}{SignSymbol(&v), v.SigningPubKey.NodePublicKey(), v.SigningTime.String(), v.LedgerHash, v.LedgerSequence, v.Flags, v.Amendments},
			flag:   flag,
		}, nil
	case data.Trade:
		return &bundle{
			color:  tradeStyle,
			format: "Trade: %-34s => %-34s  %22.8f  %60s =>  %-60s",
			values: []interface{}{v.Giver, v.Taker, v.Rate(), v.Got, v.Paid},
			flag:   flag,
		}, nil
	case data.Balance:
		return &bundle{
			color:  balanceStyle,
			format: "Balance: %-34s  Currency: %s Balance: %20s Change: %20s",
			values: []interface{}{v.Account, v.Currency, v.Balance, v.Change},
			flag:   flag,
		}, nil
	case data.Path:
		sig, err := v.Signature()
		if err != nil {
			return nil, err
		}
		return &bundle{
			color:  pathStyle,
			format: "Path: %08X %s",
			values: []interface{}{sig, v.String()},
			flag:   flag,
		}, nil
	case data.OrderBookOffer:
		return &bundle{
			color:  offerStyle,
			format: "Offer: %34s %8d %s %25s %62s %62s",
			values: []interface{}{v.Account, v.Sequence, BoolSymbol(v.Expiration != nil && *v.Expiration > 0), v.Ratio(), v.TakerPays, v.TakerGets},
			flag:   flag,
		}, nil
	case data.AccountOffer:
		return &bundle{
			color:  offerStyle,
			format: "Offer: %08X %9d %34s %62s %62s",
			values: []interface{}{v.Flags, v.Sequence, v.Quality, v.TakerPays, v.TakerGets},
			flag:   flag,
		}, nil
	case data.AccountLine:
		return &bundle{
			color:  lineStyle,
			format: "Line: %20s %3s %34s %34s %20s %s %s %8d %8d",
			values: []interface{}{v.Balance, v.Currency, v.Account, v.Limit, v.LimitPeer, BoolSymbol(v.NoRipple), BoolSymbol(v.NoRipplePeer), v.QualityIn, v.QualityOut},
			flag:   flag,
		}, nil
	default:
		return &bundle{
			color:  infoStyle,
			format: "%s",
			values: []interface{}{v},
			flag:   flag,
		}, nil
	}
}

func indent(flag Flag) string {
	switch {
	case flag&Indent > 0:
		return "    "
	case flag&DoubleIndent > 0:
		return "        "
	case flag&TripleIndent > 0:
		return "           "
	default:
		return ""
	}
}

func println(value interface{}, flag Flag) (int, error) {
	b, err := newBundle(value, flag)
	if err != nil {
		return 0, err
	}
	return b.color.Printf(indent(flag)+b.format+"\n", b.values...)
}

func Println(value interface{}, flag Flag) {
	if _, err := println(value, flag); err != nil {
		infoStyle.Println(err.Error())
	}
}

func Sprint(value interface{}, flag Flag) string {
	b, err := newBundle(value, flag)
	if err != nil {
		return fmt.Sprintf("Cannot format: %+v", value)
	}
	return b.color.SprintfFunc()(indent(flag)+b.format, b.values...)
}