1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
|
package ask
import (
"bufio"
"fmt"
"os"
"slices"
"strconv"
"strings"
"golang.org/x/term"
)
// Asker holds a reader for reading input into CLI questions.
type Asker struct {
reader *bufio.Reader
}
// NewAsker returns a new Asker that utilizes the supplied reader.
func NewAsker(reader *bufio.Reader) Asker {
return Asker{reader: reader}
}
// AskBool asks a question and expect a yes/no answer.
func (a *Asker) AskBool(question string, defaultAnswer string) (bool, error) {
for {
answer, err := a.askQuestion(question, defaultAnswer)
if err != nil {
return false, err
}
if slices.Contains([]string{"yes", "y"}, strings.ToLower(answer)) {
return true, nil
} else if slices.Contains([]string{"no", "n"}, strings.ToLower(answer)) {
return false, nil
}
invalidInput()
}
}
// AskChoice asks the user to select one of multiple options.
func (a *Asker) AskChoice(question string, choices []string, defaultAnswer string) (string, error) {
for {
answer, err := a.askQuestion(question, defaultAnswer)
if err != nil {
return "", err
}
if slices.Contains(choices, answer) {
return answer, nil
}
invalidInput()
}
}
// AskInt asks the user to enter an integer between a min and max value.
func (a *Asker) AskInt(question string, minValue int64, maxValue int64, defaultAnswer string, validate func(int64) error) (int64, error) {
for {
answer, err := a.askQuestion(question, defaultAnswer)
if err != nil {
return -1, err
}
result, err := strconv.ParseInt(answer, 10, 64)
if err != nil {
fmt.Fprintf(os.Stderr, "Invalid input: %v\n\n", err)
continue
}
if !((minValue == -1 || result >= minValue) && (maxValue == -1 || result <= maxValue)) {
fmt.Fprintf(os.Stderr, "Invalid input: out of range\n\n")
continue
}
if validate != nil {
err = validate(result)
if err != nil {
fmt.Fprintf(os.Stderr, "Invalid input: %v\n\n", err)
continue
}
}
return result, err
}
}
// AskString asks the user to enter a string, which optionally
// conforms to a validation function.
func (a *Asker) AskString(question string, defaultAnswer string, validate func(string) error) (string, error) {
for {
answer, err := a.askQuestion(question, defaultAnswer)
if err != nil {
return "", err
}
if validate != nil {
err := validate(answer)
if err != nil {
fmt.Fprintf(os.Stderr, "Invalid input: %s\n\n", err)
continue
}
return answer, err
}
if len(answer) != 0 {
return answer, err
}
invalidInput()
}
}
// AskPassword asks the user to enter a password.
func (a *Asker) AskPassword(question string) string {
return AskPassword(question)
}
// AskPassword asks the user to enter a password.
// Deprecated: Use asker.AskPassword instead.
func AskPassword(question string) string {
for {
fmt.Print(question)
pwd, _ := term.ReadPassword(0)
fmt.Println("")
inFirst := string(pwd)
inFirst = strings.TrimSuffix(inFirst, "\n")
fmt.Print("Again: ")
pwd, _ = term.ReadPassword(0)
fmt.Println("")
inSecond := string(pwd)
inSecond = strings.TrimSuffix(inSecond, "\n")
// refuse empty password or if password inputs do not match
if len(inFirst) > 0 && inFirst == inSecond {
return inFirst
}
invalidInput()
}
}
// AskPasswordOnce asks the user to enter a password.
//
// It's the same as AskPassword, but it won't ask to enter it again.
func (a *Asker) AskPasswordOnce(question string) string {
return AskPasswordOnce(question)
}
// AskPasswordOnce asks the user to enter a password.
//
// It's the same as AskPassword, but it won't ask to enter it again.
// Deprecated: Use asker.AskPasswordOnce instead.
func AskPasswordOnce(question string) string {
for {
fmt.Print(question)
pwd, _ := term.ReadPassword(0)
fmt.Println("")
// refuse empty password
spwd := string(pwd)
if len(spwd) > 0 {
return spwd
}
invalidInput()
}
}
// Ask a question on the output stream and read the answer from the input stream.
func (a *Asker) askQuestion(question, defaultAnswer string) (string, error) {
fmt.Print(question)
return a.readAnswer(defaultAnswer)
}
// Read the user's answer from the input stream, trimming newline and providing a default.
func (a *Asker) readAnswer(defaultAnswer string) (string, error) {
answer, err := a.reader.ReadString('\n')
answer = strings.TrimSpace(strings.TrimSuffix(answer, "\n"))
if answer == "" {
answer = defaultAnswer
}
return answer, err
}
// Print an invalid input message on the error stream.
func invalidInput() {
fmt.Fprintf(os.Stderr, "Invalid input, try again.\n\n")
}
|