forked from DavidGamba/dgtools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
grepp.go
536 lines (491 loc) · 13.6 KB
/
grepp.go
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
// This file is part of grepp.
//
// Copyright (C) 2012-2017 David Gamba Rios
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
/*
Package main provides an improved version of the most common combinations of grep, find and sed in a single script.
*/
package main
import (
"bufio"
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"path/filepath"
"regexp"
"strconv"
"strings"
greppLib "github.com/DavidGamba/dgtools/grepp/lib/grepp"
l "github.com/DavidGamba/dgtools/grepp/logging"
"github.com/DavidGamba/dgtools/grepp/runInPager"
"github.com/DavidGamba/dgtools/grepp/semver"
"github.com/DavidGamba/ffind/lib/ffind"
"github.com/DavidGamba/go-getoptions"
"github.com/mgutz/ansi"
)
// Buffer Size used to read files when searching through them.
// Default value should cover most cases.
var bufferSize int
var errorBufferSizeTooSmall = fmt.Errorf("buffer size too small")
type LineError struct {
Line string
LineNumber int
Error error
}
func ReadLineByLine(filename string, bufferSize int) <-chan LineError {
l.Debug.Printf("[readLineByLine] %s : %d\n", filename, bufferSize)
c := make(chan LineError)
go func() {
fh, err := os.Open(filename)
if err != nil {
c <- LineError{Error: err}
close(c)
return
}
defer fh.Close()
reader := bufio.NewReaderSize(fh, bufferSize)
// line number
n := 0
for {
n++
line, isPrefix, err := reader.ReadLine()
if isPrefix {
err := fmt.Errorf("%s: %w\n", filename, errorBufferSizeTooSmall)
c <- LineError{Error: err}
break
}
// stop reading file
if err != nil {
if err != io.EOF {
c <- LineError{Error: err}
}
break
}
c <- LineError{Line: string(line), LineNumber: n}
}
close(c)
}()
return c
}
func checkPatternInFile(filename string, pattern string, ignoreCase bool) (bool, error) {
re, _ := getRegex(pattern, ignoreCase)
for le := range ReadLineByLine(filename, bufferSize) {
if le.Error != nil {
return false, le.Error
}
match := re.MatchString(string(le.Line))
if match {
return true, nil
}
}
return false, nil
}
type lineMatch struct {
filename string
n int
match [][]string
end []string
line string
}
func getRegex(pattern string, ignoreCase bool) (re, reEnd *regexp.Regexp) {
if ignoreCase {
re = regexp.MustCompile(`(?i)(.*?)(?P<pattern>` + pattern + `)`)
reEnd = regexp.MustCompile(`(?i).*` + pattern + `(.*?)$`)
} else {
re = regexp.MustCompile(`(.*?)(?P<pattern>` + pattern + `)`)
reEnd = regexp.MustCompile(`.*` + pattern + `(.*?)$`)
}
return
}
// TODO: Handle error properly here
func searchInFile(filename, pattern string, ignoreCase bool) <-chan lineMatch {
c := make(chan lineMatch)
re, reEnd := getRegex(pattern, ignoreCase)
go func() {
for le := range ReadLineByLine(filename, bufferSize) {
if le.Error != nil {
l.Error.Fatal(le.Error)
}
match := re.FindAllStringSubmatch(string(le.Line), -1)
remainder := reEnd.FindStringSubmatch(string(le.Line))
c <- lineMatch{filename: filename, n: le.LineNumber, line: string(le.Line), match: match, end: remainder}
}
close(c)
}()
return c
}
func color(color string, line string, useColor bool) string {
if useColor {
return fmt.Sprintf("%s%s", color, line)
}
return fmt.Sprintf("%s", line)
}
func colorReset(useColor bool) string {
if useColor {
return fmt.Sprintf("%s", ansi.Reset)
}
return ""
}
//TODO: Don't drop the control char but scape it and show it like less.
// http://rosettacode.org/wiki/Strip_control_codes_and_extended_characters_from_a_string#Go
// two UTF-8 functions identical except for operator comparing c to 127
func stripCtlFromUTF8(str string) string {
return strings.Map(func(r rune) rune {
if r >= 32 && r != 127 {
return r
}
return -1
}, str)
}
func (g grepp) writeLineMatch(file *os.File, lm lineMatch) {
for _, m := range lm.match {
file.WriteString(m[1] + g.replace)
}
file.WriteString(lm.end[1] + "\n")
}
// Each section is in charge of starting with the color or reset.
func (g grepp) printLineMatch(lm lineMatch) {
stringLine := func() string {
if g.useColor {
result := ansi.Reset
for _, m := range lm.match {
result += fmt.Sprintf("%s%s%s%s%s%s",
stripCtlFromUTF8(m[1]),
ansi.Red,
stripCtlFromUTF8(m[2]),
ansi.Green,
stripCtlFromUTF8(g.replace),
ansi.Reset)
}
result += stripCtlFromUTF8(lm.end[1])
return result
}
return stripCtlFromUTF8(lm.line)
}
result := ""
if g.showFile {
result += color(ansi.Magenta, lm.filename, g.useColor) + " " + color(ansi.Blue, ":", g.useColor)
}
if g.useNumber {
result += color(ansi.Green, strconv.Itoa(lm.n), g.useColor) + color(ansi.Blue, ":", g.useColor)
}
result += colorReset(g.useColor) + " " + stringLine()
fmt.Fprintln(g.Stdout, result)
}
// Each section is in charge of starting with the color or reset.
func (g grepp) printMinorWarning(line string) {
result := color(ansi.LightBlack, line, g.useColor)
fmt.Fprintln(g.Stderr, result)
}
// Each section is in charge of starting with the color or reset.
func (g grepp) printLineContext(lm lineMatch) {
result := ""
if g.showFile {
result += color(ansi.Magenta, lm.filename, g.useColor) + " " + color(ansi.Blue, "-", g.useColor)
}
if g.useNumber {
result += color(ansi.Green, strconv.Itoa(lm.n), g.useColor) + color(ansi.Blue, "-", g.useColor)
}
result += colorReset(g.useColor) + " " + lm.line
fmt.Fprintln(g.Stdout, result)
}
// copyFileContents copies the contents of the file named src to the file named
// by dst. The file will be created if it does not already exist. If the
// destination file exists, all it's contents will be replaced by the contents
// of the source file.
func copyFileContents(src, dst string) (err error) {
in, err := os.Open(src)
if err != nil {
return
}
defer in.Close()
out, err := os.Create(dst)
if err != nil {
return
}
defer func() {
cerr := out.Close()
if err == nil {
err = cerr
}
}()
if _, err = io.Copy(out, in); err != nil {
return
}
err = out.Sync()
return
}
type grepp struct {
ignoreBinary bool
caseSensitive bool
useColor bool
useNumber bool
filenameOnly bool
replace string
force bool
context int
searchBase string
// Controls whether or not to show the filename. If the given location is a
// file then there is no need to show the filename
showFile bool
showBufferSizeErrors bool
bufferSizeErrorsC int
pattern string
filePattern string
ignoreFilePattern string
ignoreExtensionList []string
Stdout io.Writer
Stderr io.Writer
}
func (g grepp) String() string {
return fmt.Sprintf("ignoreBinary: %v, caseSensitive: %v, useColor %v, useNumber %v, filenameOnly %v, force %v",
g.ignoreBinary, g.caseSensitive, g.useColor, g.useNumber, g.filenameOnly, g.force)
}
func (g grepp) getFileList() <-chan ffind.FileError {
c := make(chan ffind.FileError)
go func() {
if g.showFile {
ch := ffind.ListRecursive(
g.searchBase,
true,
&ffind.BasicFileMatch{
IgnoreDirResults: true,
IgnoreFileResults: false,
IgnoreVCSDirs: true,
IgnoreHidden: true,
IgnoreFileExtensionList: g.ignoreExtensionList,
},
ffind.SortFnByName)
for e := range ch {
if e.Error != nil {
fmt.Fprintf(os.Stderr, "ERROR: '%s' %s\n", e.Path, e.Error)
// Ignore broken symlinks
if os.IsNotExist(e.Error) {
continue
}
}
c <- e
}
} else {
// TODO: FileInfo is not generated here. Check if it is needed.
c <- ffind.FileError{
Path: g.searchBase,
}
}
close(c)
}()
return c
}
func (g grepp) Run() {
for ch := range g.getFileList() {
filename := ch.Path
if g.ignoreBinary == true && !greppLib.IsTextMIME(filename) {
continue
}
if g.filenameOnly {
ok, err := checkPatternInFile(filename, g.pattern, !g.caseSensitive)
if err != nil {
if errors.Is(err, errorBufferSizeTooSmall) {
if g.showBufferSizeErrors {
g.printMinorWarning(fmt.Sprintf("%s : %s\n", filename, err.Error()))
} else {
g.bufferSizeErrorsC++
}
} else {
fmt.Fprintf(g.Stderr, "%s\n", err)
}
} else if ok {
fmt.Fprintf(g.Stdout, "%s%s\n", color(ansi.Magenta, filename, g.useColor), colorReset(g.useColor))
}
} else {
ok, err := checkPatternInFile(filename, g.pattern, !g.caseSensitive)
if err != nil {
if errors.Is(err, errorBufferSizeTooSmall) {
if g.showBufferSizeErrors {
g.printMinorWarning(fmt.Sprintf("%s : %s\n", filename, err.Error()))
} else {
g.bufferSizeErrorsC++
}
} else {
fmt.Fprintf(g.Stderr, "%s\n", err)
}
} else if ok {
var tmpFile *os.File
var err error
if g.force {
tmpFile, err = ioutil.TempFile("", filepath.Base(filename)+"-")
defer tmpFile.Close()
if err != nil {
l.Error.Println("cannot open ", tmpFile)
l.Error.Fatal(err)
}
l.Debug.Printf("tmpFile: %v", tmpFile.Name())
}
for d := range searchInFile(filename, g.pattern, !g.caseSensitive) {
if len(d.match) == 0 {
if g.context > 0 {
g.printLineContext(d)
}
} else {
g.printLineMatch(d)
}
if g.force {
if len(d.match) == 0 {
tmpFile.WriteString(d.line + "\n")
} else {
g.writeLineMatch(tmpFile, d)
}
}
}
if g.force {
tmpFile.Close()
err = copyFileContents(tmpFile.Name(), filename)
if err != nil {
l.Warning.Printf("Couldn't update file: %s. '%s'\n", filename, err)
}
}
}
}
}
if g.bufferSizeErrorsC > 0 {
fmt.Fprintf(g.Stderr, "WARNING: %s found %d times\n", errorBufferSizeTooSmall, g.bufferSizeErrorsC)
}
}
func (g *grepp) SetStderr(w io.Writer) {
l.Warning.SetOutput(w)
l.Error.SetOutput(w)
g.Stderr = w
}
func (g *grepp) SetStdout(w io.Writer) {
l.Info.SetOutput(w)
g.Stdout = w
}
func synopsis() {
synopsis := `grepp <pattern> [<location>] [-r <replace pattern> [-f]]
[-I] [-c] [-n] [-l] [--ignore-extension|--ie <ext>] [--color]
[--buffer <size>] [--show-buffer-errors|--sbe]
[--no-pager]
[--debug | --trace]
# not available yet
[-C <lines of context>] [--fp] [--name <file pattern>]
[--spacing] [--ignore <file pattern>]
grepp --version
grepp -h # show this help
man grepp # show manpage`
fmt.Fprintln(os.Stderr, synopsis)
}
func main() {
l.LogInit(ioutil.Discard, ioutil.Discard, os.Stdout, os.Stderr, os.Stderr)
l.Debug.Printf("args: %s", os.Args[1:])
var noPager bool
var debug, trace bool
g := grepp{}
// TODO: Read from ~/.grepprc
g.ignoreExtensionList = []string{
".un~", // vim
".swp", // vim
".a", // c
".so", // c
".db", // Database file
".base64", // encoded_data
".svg", // image
".png", // image
".PNG", // image
".jpg", // image
".ttf", // font
".pdf", // pdf
".tfstate", // terraform state
}
opt := getoptions.New()
opt.Bool("h", false) // Help
opt.Bool("version", false) // version info
opt.BoolVar(&g.ignoreBinary, "I", true)
opt.BoolVar(&g.caseSensitive, "c", false)
opt.BoolVar(&g.useColor, "color", false)
opt.BoolVar(&g.useNumber, "n", true)
opt.BoolVar(&g.filenameOnly, "l", false)
opt.StringVar(&g.replace, "r", "")
opt.BoolVar(&g.force, "f", false)
opt.IntVar(&g.context, "C", 0)
opt.IntVar(&bufferSize, "buffer", 16384)
opt.BoolVar(&g.showBufferSizeErrors, "show-buffer-errors", false, opt.Alias("sbe"))
opt.BoolVar(&noPager, "no-pager", false)
opt.BoolVar(&debug, "debug", false) // debug logging
opt.BoolVar(&trace, "trace", false) // trace logging
ie := opt.StringSlice("ignore-extension", 1, 1, opt.Alias("ie"))
// "fp" // fullPath - Used to show the file full path instead of the relative to the current dir.
// "name" // filePattern - Use to further filter the search to files matching that pattern.
// "ignore" // ignoreFilePattern - Use to further filter the search to files not matching that pattern.
// "spacing" // keepSpacing - Do not remove initial spacing.
// "no-page" // Don't use pager for output
remaining, err := opt.Parse(os.Args[1:])
if err != nil {
fmt.Println(err)
os.Exit(1)
}
if opt.Called("h") {
synopsis()
os.Exit(1)
}
if opt.Called("version") {
version := semver.Version{Major: 0, Minor: 1, Patch: 0, PreReleaseLabel: "dev"}
fmt.Println(version)
os.Exit(1)
}
for _, ext := range *ie {
g.ignoreExtensionList = append(g.ignoreExtensionList, ext)
}
// Check if stdout is pipe p or device D
statStdout, _ := os.Stdout.Stat()
stdoutIsDevice := (statStdout.Mode() & os.ModeDevice) != 0
if debug || trace {
l.Debug.SetOutput(os.Stderr)
}
if trace {
l.Trace.SetOutput(os.Stderr)
}
l.Debug.Printf("stats Stdout: %s, is device: %v", statStdout.Mode(), stdoutIsDevice)
if len(remaining) < 1 {
l.Error.Fatal("Missing pattern!")
}
if len(remaining) < 2 {
g.searchBase = "."
} else {
g.searchBase = remaining[1]
}
searchBaseInfo, err := os.Stat(g.searchBase)
if err != nil {
l.Error.Println("cannot stat", g.searchBase)
l.Error.Fatal(err)
}
if searchBaseInfo.IsDir() {
g.showFile = true
} else {
g.showFile = false
// If filename provided, don't skip it
g.ignoreBinary = false
}
g.pattern = remaining[0]
l.Debug.Printf("pattern: %s, searchBase: %s, replace: %s", g.pattern, g.searchBase, g.replace)
l.Debug.Printf(fmt.Sprintln(g))
g.useColor = !g.useColor
if !noPager && stdoutIsDevice {
l.Debug.Println("runInPager")
runInPager.Command(&g)
os.Exit(0)
} else if noPager && stdoutIsDevice {
g.Stdout = os.Stdout
g.Stderr = os.Stderr
g.Run()
} else {
g.useColor = false
g.Stdout = os.Stdout
g.Stderr = os.Stderr
g.Run()
}
}