prompter.go

// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package client

import (
	"strings"

	"github.com/keybase/client/go/libkb"
)

type Field struct {
	Name             string
	Prompt           string
	FirstPrompt      string
	Defval           string
	Hint             string
	Checker          *libkb.Checker
	Thrower          func(key, value string) error
	Disabled         bool
	Value            *string
	PromptDescriptor libkb.PromptDescriptor
}

func (f Field) GetValue() string {
	if f.Value == nil {
		return ""
	}
	return *f.Value
}

type Prompter struct {
	Fields []*Field
	tui    libkb.TerminalUI
}

func NewPrompter(f []*Field, tui libkb.TerminalUI) *Prompter {
	return &Prompter{Fields: f, tui: tui}
}

func (p *Prompter) Run() error {
	for _, f := range p.Fields {
		if f.Disabled {
			continue
		}
		if err := p.ReadField(f); err != nil {
			return err
		}
	}
	return nil
}

func (f *Field) Clear() string {
	old := f.GetValue()
	f.Value = nil
	return old
}

func (p *Prompter) ReadField(f *Field) (err error) {

	done := false
	first := true

	var val string

	if p.tui == nil {
		return NoTerminalError{}
	}

	for !done && err == nil {

		prompt := f.Prompt
		if first {
			if len(f.FirstPrompt) > 0 {
				prompt += f.FirstPrompt
			}
			first = false
		} else {
			hint := f.Hint
			if len(hint) == 0 {
				hint = f.Checker.Hint
			}
			prompt += " (" + hint + ")"
		}

		var def string
		if len(f.Defval) > 0 {
			def = f.Defval
		} else if f.Value != nil {
			def = *f.Value
		}

		if len(def) > 0 {
			prompt += " [" + def + "]"
		}
		prompt += ": "

		if val, err = p.tui.Prompt(f.PromptDescriptor, prompt); err != nil {
			break
		}

		if len(val) == 0 && len(def) > 0 {
			val = def
		}

		if f.Checker == nil || !f.Checker.PreserveSpace {
			val = strings.TrimSpace(val)
		}

		if f.Thrower != nil {
			if err = f.Thrower(f.Name, val); err != nil {
				break
			}
		}
		if f.Checker != nil {
			if f.Checker.Transform != nil {
				val = f.Checker.Transform(val)
			}

			done = f.Checker.F(val)
		} else {
			done = true
		}
		if done {
			f.Value = &val
		}
	}

	if err == nil {
		f.Value = &val
	}

	return
}