Repository navigation
Expand file tree
/
Copy pathinput.go
More file actions
343 lines (279 loc) · 8.82 KB
/
Copy pathinput.go
File metadata and controls
343 lines (279 loc) · 8.82 KB
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
// Inspired by the git-appraise project
// Package input contains helpers to use a text editor as an input for
// various field of a bug
package input
import (
"bufio"
"bytes"
"fmt"
"io/ioutil"
"os"
"os/exec"
"strings"
"github.com/MichaelMure/git-bug/repository"
"github.com/pkg/errors"
)
const messageFilename = "BUG_MESSAGE_EDITMSG"
// ErrEmptyMessage is returned when the required message has not been entered
var ErrEmptyMessage = errors.New("empty message")
// ErrEmptyMessage is returned when the required title has not been entered
var ErrEmptyTitle = errors.New("empty title")
const bugTitleCommentTemplate = `%s%s
# Please enter the title and comment message. The first non-empty line will be
# used as the title. Lines starting with '#' will be ignored.
# An empty title aborts the operation.
`
// BugCreateEditorInput will open the default editor in the terminal with a
// template for the user to fill. The file is then processed to extract title
// and message.
func BugCreateEditorInput(repo repository.RepoCommon, preTitle string, preMessage string) (string, string, error) {
if preMessage != "" {
preMessage = "\n\n" + preMessage
}
template := fmt.Sprintf(bugTitleCommentTemplate, preTitle, preMessage)
raw, err := launchEditorWithTemplate(repo, messageFilename, template)
if err != nil {
return "", "", err
}
return processCreate(raw)
}
// BugCreateFileInput read from either from a file or from the standard input
// and extract a title and a message
func BugCreateFileInput(fileName string) (string, string, error) {
raw, err := fromFile(fileName)
if err != nil {
return "", "", err
}
return processCreate(raw)
}
func processCreate(raw string) (string, string, error) {
lines := strings.Split(raw, "\n")
var title string
var buffer bytes.Buffer
for _, line := range lines {
if strings.HasPrefix(line, "#") {
continue
}
if title == "" {
trimmed := strings.TrimSpace(line)
if trimmed != "" {
title = trimmed
}
continue
}
buffer.WriteString(line)
buffer.WriteString("\n")
}
if title == "" {
return "", "", ErrEmptyTitle
}
message := strings.TrimSpace(buffer.String())
return title, message, nil
}
const bugCommentTemplate = `%s
# Please enter the comment message. Lines starting with '#' will be ignored,
# and an empty message aborts the operation.
`
// BugCommentEditorInput will open the default editor in the terminal with a
// template for the user to fill. The file is then processed to extract a comment.
func BugCommentEditorInput(repo repository.RepoCommon, preMessage string) (string, error) {
template := fmt.Sprintf(bugCommentTemplate, preMessage)
raw, err := launchEditorWithTemplate(repo, messageFilename, template)
if err != nil {
return "", err
}
return processComment(raw)
}
// BugCommentFileInput read from either from a file or from the standard input
// and extract a message
func BugCommentFileInput(fileName string) (string, error) {
raw, err := fromFile(fileName)
if err != nil {
return "", err
}
return processComment(raw)
}
func processComment(raw string) (string, error) {
lines := strings.Split(raw, "\n")
var buffer bytes.Buffer
for _, line := range lines {
if strings.HasPrefix(line, "#") {
continue
}
buffer.WriteString(line)
buffer.WriteString("\n")
}
message := strings.TrimSpace(buffer.String())
if message == "" {
return "", ErrEmptyMessage
}
return message, nil
}
const bugTitleTemplate = `%s
# Please enter the new title. Only one line will used.
# Lines starting with '#' will be ignored, and an empty title aborts the operation.
`
// BugTitleEditorInput will open the default editor in the terminal with a
// template for the user to fill. The file is then processed to extract a title.
func BugTitleEditorInput(repo repository.RepoCommon, preTitle string) (string, error) {
template := fmt.Sprintf(bugTitleTemplate, preTitle)
raw, err := launchEditorWithTemplate(repo, messageFilename, template)
if err != nil {
return "", err
}
lines := strings.Split(raw, "\n")
var title string
for _, line := range lines {
if strings.HasPrefix(line, "#") {
continue
}
trimmed := strings.TrimSpace(line)
if trimmed == "" {
continue
}
title = trimmed
break
}
if title == "" {
return "", ErrEmptyTitle
}
return title, nil
}
const queryTemplate = `%s
# Please edit the bug query.
# Lines starting with '#' will be ignored, and an empty query aborts the operation.
#
# Example: status:open author:"rené descartes" sort:edit
#
# Valid filters are:
#
# - status:open, status:closed
# - author:<query>
# - title:<title>
# - label:<label>
# - no:label
#
# Sorting
#
# - sort:id, sort:id-desc, sort:id-asc
# - sort:creation, sort:creation-desc, sort:creation-asc
# - sort:edit, sort:edit-desc, sort:edit-asc
#
# Notes
#
# - queries are case insensitive.
# - you can combine as many qualifiers as you want.
# - you can use double quotes for multi-word search terms (ex: author:"René Descartes")
`
// QueryEditorInput will open the default editor in the terminal with a
// template for the user to fill. The file is then processed to extract a query.
func QueryEditorInput(repo repository.RepoCommon, preQuery string) (string, error) {
template := fmt.Sprintf(queryTemplate, preQuery)
raw, err := launchEditorWithTemplate(repo, messageFilename, template)
if err != nil {
return "", err
}
lines := strings.Split(raw, "\n")
for _, line := range lines {
if strings.HasPrefix(line, "#") {
continue
}
trimmed := strings.TrimSpace(line)
if trimmed == "" {
continue
}
return trimmed, nil
}
return "", nil
}
// launchEditorWithTemplate will launch an editor as launchEditor do, but with a
// provided template.
func launchEditorWithTemplate(repo repository.RepoCommon, fileName string, template string) (string, error) {
path := fmt.Sprintf("%s/%s", repo.GetPath(), fileName)
err := ioutil.WriteFile(path, []byte(template), 0644)
if err != nil {
return "", err
}
return launchEditor(repo, fileName)
}
// launchEditor launches the default editor configured for the given repo. This
// method blocks until the editor command has returned.
//
// The specified filename should be a temporary file and provided as a relative path
// from the repo (e.g. "FILENAME" will be converted to "[<reporoot>/].git/FILENAME"). This file
// will be deleted after the editor is closed and its contents have been read.
//
// This method returns the text that was read from the temporary file, or
// an error if any step in the process failed.
func launchEditor(repo repository.RepoCommon, fileName string) (string, error) {
path := fmt.Sprintf("%s/%s", repo.GetPath(), fileName)
defer os.Remove(path)
editor, err := repo.GetCoreEditor()
if err != nil {
return "", fmt.Errorf("Unable to detect default git editor: %v\n", err)
}
cmd, err := startInlineCommand(editor, path)
if err != nil {
// Running the editor directly did not work. This might mean that
// the editor string is not a path to an executable, but rather
// a shell command (e.g. "emacsclient --tty"). As such, we'll try
// to run the command through bash, and if that fails, try with sh
args := []string{"-c", fmt.Sprintf("%s %q", editor, path)}
cmd, err = startInlineCommand("bash", args...)
if err != nil {
cmd, err = startInlineCommand("sh", args...)
}
}
if err != nil {
return "", fmt.Errorf("Unable to start editor: %v\n", err)
}
if err := cmd.Wait(); err != nil {
return "", fmt.Errorf("Editing finished with error: %v\n", err)
}
output, err := ioutil.ReadFile(path)
if err != nil {
return "", fmt.Errorf("Error reading edited file: %v\n", err)
}
return string(output), err
}
// fromFile loads and returns the contents of a given file. If - is passed
// through, much like git, it will read from stdin. This can be piped data,
// unless there is a tty in which case the user will be prompted to enter a
// message.
func fromFile(fileName string) (string, error) {
if fileName == "-" {
stat, err := os.Stdin.Stat()
if err != nil {
return "", fmt.Errorf("Error reading from stdin: %v\n", err)
}
if (stat.Mode() & os.ModeCharDevice) == 0 {
// There is no tty. This will allow us to read piped data instead.
output, err := ioutil.ReadAll(os.Stdin)
if err != nil {
return "", fmt.Errorf("Error reading from stdin: %v\n", err)
}
return string(output), err
}
fmt.Printf("(reading comment from standard input)\n")
var output bytes.Buffer
s := bufio.NewScanner(os.Stdin)
for s.Scan() {
output.Write(s.Bytes())
output.WriteRune('\n')
}
return output.String(), nil
}
output, err := ioutil.ReadFile(fileName)
if err != nil {
return "", fmt.Errorf("Error reading file: %v\n", err)
}
return string(output), err
}
func startInlineCommand(command string, args ...string) (*exec.Cmd, error) {
cmd := exec.Command(command, args...)
cmd.Stdin = os.Stdin
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
err := cmd.Start()
return cmd, err
}