-
-
Notifications
You must be signed in to change notification settings - Fork 255
/
processor.go
667 lines (527 loc) · 18.8 KB
/
processor.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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
// SPDX-License-Identifier: MIT
package processor
import (
"bytes"
"compress/gzip"
"encoding/base64"
"fmt"
"os"
"path/filepath"
"regexp"
"runtime"
"runtime/debug"
"slices"
"strconv"
"strings"
"sync"
"github.com/boyter/gocodewalker"
jsoniter "github.com/json-iterator/go"
)
// Version indicates the version of the application
var Version = "3.4.0 (beta)"
// Flags set via the CLI which control how the output is displayed
// Files indicates if there should be file output or not when formatting
var Files = false
// Languages indicates if the command line should print out the supported languages
var Languages = false
// Verbose enables verbose logging output
var Verbose = false
// Debug enables debug logging output
var Debug = false
// Trace enables trace logging output which is extremely verbose
var Trace = false
// Duplicates enables duplicate file detection
var Duplicates = false
// MinifiedGenerated enables minified/generated file detection
var MinifiedGenerated = false
// IgnoreMinifiedGenerate printing counts for minified/generated files
var IgnoreMinifiedGenerate = false
// MinifiedGeneratedLineByteLength number of bytes per average line to determine file is minified/generated
var MinifiedGeneratedLineByteLength = 255
// Minified enables minified file detection
var Minified = false
// IgnoreMinified ignore printing counts for minified files
var IgnoreMinified = false
// Generated enables generated file detection
var Generated = false
// GeneratedMarkers defines head markers for generated file detection
var GeneratedMarkers []string
// IgnoreGenerated ignore printing counts for generated files
var IgnoreGenerated = false
// Complexity toggles complexity calculation
var Complexity = false
// More enables wider output with more information in formatter
var More = false
// Cocomo toggles the COCOMO calculation
var Cocomo = false
// SLOCCountFormat prints a more SLOCCount like COCOMO calculation
var SLOCCountFormat = false
// CocomoProjectType allows the flipping between project types which impacts the calculation
var CocomoProjectType = "organic"
// Size toggles the Size calculation
var Size = false
// Draw horizontal borders between sections.
var HBorder = false
// SizeUnit determines what size calculation is used for megabytes
var SizeUnit = "si"
// Ci indicates if running inside a CI so to disable box drawing characters
var Ci = false
// GitIgnore disables .gitignore checks
var GitIgnore = false
// Ignore disables ignore file checks
var Ignore = false
// CountIgnore should we count ignore files?
var CountIgnore = false
// DisableCheckBinary toggles checking for binary files using NUL bytes
var DisableCheckBinary = false
// UlocMode toggles checking for binary files using NUL bytes
var UlocMode = false
// Percent toggles checking for binary files using NUL bytes
var Percent = false
// MaxMean toggles checking for binary files using NUL bytes
var MaxMean = false
// Dryness toggles checking for binary files using NUL bytes
var Dryness = false
// SortBy sets which column output in formatter should be sorted by
var SortBy = ""
// Exclude is a regular expression which is used to exclude files from being processed
var Exclude = []string{}
// CountAs is a rule for mapping known or new extensions to other rules
var CountAs = ""
// Format sets the output format of the formatter
var Format = ""
// FormatMulti is a rule for defining multiple output formats
var FormatMulti = ""
// SQLProject is used to store the name for the SQL insert formats but is optional
var SQLProject = ""
// RemapUnknown allows remapping of unknown files with a string to search the content for
var RemapUnknown = ""
// RemapAll allows remapping of all files with a string to search the content for
var RemapAll = ""
// CurrencySymbol allows setting the currency symbol for cocomo project cost estimation
var CurrencySymbol = ""
// FileOutput sets the file that output should be written to
var FileOutput = ""
// PathDenyList sets the paths that should be skipped
var PathDenyList = []string{}
// DirectoryWalkerJobWorkers is the number of workers which will walk the directory tree
var DirectoryWalkerJobWorkers = runtime.NumCPU()
// FileListQueueSize is the queue of files found and ready to be read into memory
var FileListQueueSize = runtime.NumCPU()
// FileProcessJobWorkers is the number of workers that process the file collecting stats
var FileProcessJobWorkers = runtime.NumCPU() * 4
// FileSummaryJobQueueSize is the queue used to hold processed file statistics before formatting
var FileSummaryJobQueueSize = runtime.NumCPU()
// AllowListExtensions is a list of extensions which are allowed to be processed
var AllowListExtensions = []string{}
// ExcludeListExtensions is a list of extensions which should be ignored
var ExcludeListExtensions = []string{}
// ExcludeFilename is a list of filenames which should be ignored
var ExcludeFilename = []string{}
// AverageWage is the average wage in dollars used for the COCOMO cost estimate
var AverageWage int64 = 56286
// Overhead is the overhead multiplier for corporate overhead (facilities, equipment, accounting, etc.)
var Overhead float64 = 2.4
// EAF is the effort adjustment factor derived from the cost drivers, i.e. 1.0 if rated nominal
var EAF float64 = 1.0
// GcFileCount is the number of files to process before turning the GC back on
var GcFileCount = 10000
var gcPercent = -1
var isLazy = false
// NoLarge if set true will ignore files over a certain number of lines or bytes
var NoLarge = false
// IncludeSymLinks if set true will count symlink files
var IncludeSymLinks = false
// LargeLineCount number of lines before being counted as a large file based on https://github.com/pinpt/ripsrc/blob/master/ripsrc/fileinfo/fileinfo.go#L44
var LargeLineCount int64 = 40000
// LargeByteCount number of bytes before being counted as a large file based on https://github.com/pinpt/ripsrc/blob/master/ripsrc/fileinfo/fileinfo.go#L44
var LargeByteCount int64 = 1000000
// DirFilePaths is not set via flags but by arguments following the flags for file or directory to process
var DirFilePaths = []string{}
// Raw languageDatabase loaded
var languageDatabase = map[string]Language{}
// ExtensionToLanguage is loaded from the JSON that is in constants.go
var ExtensionToLanguage = map[string][]string{}
// ShebangLookup loaded from the JSON in constants.go contains shebang lookups
var ShebangLookup = map[string][]string{}
// FilenameToLanguage similar to ExtensionToLanguage loaded from the JSON in constants.go
var FilenameToLanguage = map[string]string{}
// LanguageFeatures contains the processed languages from processLanguageFeature
var LanguageFeatures = map[string]LanguageFeature{}
// LanguageFeaturesMutex is the shared mutex used to control getting and setting of language features
// used rather than sync.Map because it turned out to be marginally faster
var LanguageFeaturesMutex = sync.Mutex{}
// Start time in milli seconds in case we want the total time
var startTimeMilli = makeTimestampMilli()
// ConfigureLimits configures ulimits where possible
var ConfigureLimits func()
// ConfigureGc needs to be set outside of ProcessConstants because it should only be enabled in command line
// mode https://github.com/boyter/scc/issues/32
func ConfigureGc() {
gcPercent = debug.SetGCPercent(gcPercent)
}
// ConfigureLazy is a simple setter used to turn on lazy loading used only by command line
func ConfigureLazy(lazy bool) {
isLazy = lazy
}
// ProcessConstants is responsible for setting up the language features based on the JSON file that is stored in constants
// Needs to be called at least once in order for anything to actually happen
func ProcessConstants() {
languageDatabase = loadDatabase()
startTime := makeTimestampNano()
for name, value := range languageDatabase {
for _, ext := range value.Extensions {
ExtensionToLanguage[ext] = append(ExtensionToLanguage[ext], name)
}
for _, fname := range value.FileNames {
FilenameToLanguage[fname] = name
}
if len(value.SheBangs) != 0 {
ShebangLookup[name] = value.SheBangs
}
}
// If we have anything in CountAs set it up now
if len(CountAs) != 0 {
setupCountAs()
}
if Trace {
printTrace(fmt.Sprintf("nanoseconds build extension to language: %d", makeTimestampNano()-startTime))
}
// Configure COCOMO setting
_, ok := projectType[strings.ToLower(CocomoProjectType)]
if !ok {
// let's see if we can turn it into a custom one
spl := strings.Split(CocomoProjectType, ",")
val := []float64{}
if len(spl) == 5 {
// let's try to convert to float if we can
for i := 1; i < 5; i++ {
f, err := strconv.ParseFloat(spl[i], 64)
if err == nil {
val = append(val, f)
}
}
}
if len(val) == 4 {
projectType[CocomoProjectType] = val
} else {
// if nothing matches fall back to organic
CocomoProjectType = "organic"
}
}
// If lazy is set then we want to load in the features as we find them not in one go
// however otherwise being used as a library so just load them all in
if !isLazy {
startTime = makeTimestampMilli()
for name, value := range languageDatabase {
processLanguageFeature(name, value)
}
if Trace {
printTrace(fmt.Sprintf("milliseconds build language features: %d", makeTimestampMilli()-startTime))
}
} else {
if Trace {
printTrace("configured to lazy load language features")
}
}
// Fix for https://github.com/boyter/scc/issues/250
fixedPath := make([]string, 0, len(PathDenyList))
for _, path := range PathDenyList {
fixedPath = append(fixedPath, strings.TrimRight(path, "/"))
}
PathDenyList = fixedPath
}
// Configure and setup any count-as params the use has supplied
func setupCountAs() {
for _, s := range strings.Split(CountAs, ",") {
t := strings.Split(s, ":")
if len(t) == 2 {
identified := false
// There are two cases here.
// first is they provide the name e.g. "Cargo Lock"
// second is that the user supplies the extension EG wsdl
// we should support BOTH cases
// always remember we only need to validate t[1] as that's the one
// that tells us where we are trying to map
// See if we can identify based on language name which is the most
// reliable as the name should be unique
for name := range languageDatabase {
if strings.EqualFold(name, t[1]) {
ExtensionToLanguage[strings.ToLower(t[0])] = []string{name}
identified = true
if Debug {
printDebug(fmt.Sprintf("set to count extension: %s as language %s by language", t[0], name))
}
}
}
// If the above did not work, its a matter of extension match
// note that this is less reliable as some languages share extensions
if !identified {
target, ok := ExtensionToLanguage[strings.ToLower(t[1])]
if ok {
ExtensionToLanguage[strings.ToLower(t[0])] = target
if Debug {
printDebug(fmt.Sprintf("set to count extension: %s as language %s by extension", t[0], target))
}
}
}
}
}
}
// LoadLanguageFeature will load a single feature as requested given the name
func LoadLanguageFeature(loadName string) {
if !isLazy {
return
}
// Check if already loaded and if so return because we don't need to do it again
LanguageFeaturesMutex.Lock()
_, ok := LanguageFeatures[loadName]
LanguageFeaturesMutex.Unlock()
if ok {
return
}
var name string
var value Language
for name, value = range languageDatabase {
if name == loadName {
break
}
}
startTime := makeTimestampNano()
processLanguageFeature(loadName, value)
if Trace {
printTrace(fmt.Sprintf("nanoseconds to build language %s features: %d", loadName, makeTimestampNano()-startTime))
}
}
func processLanguageFeature(name string, value Language) {
complexityTrie := &Trie{}
slCommentTrie := &Trie{}
mlCommentTrie := &Trie{}
stringTrie := &Trie{}
tokenTrie := &Trie{}
complexityMask := byte(0)
singleLineCommentMask := byte(0)
multiLineCommentMask := byte(0)
stringMask := byte(0)
processMask := byte(0)
for _, v := range value.ComplexityChecks {
complexityMask |= v[0]
complexityTrie.Insert(TComplexity, []byte(v))
if !Complexity {
tokenTrie.Insert(TComplexity, []byte(v))
}
}
if !Complexity {
processMask |= complexityMask
}
for _, v := range value.LineComment {
singleLineCommentMask |= v[0]
slCommentTrie.Insert(TSlcomment, []byte(v))
tokenTrie.Insert(TSlcomment, []byte(v))
}
processMask |= singleLineCommentMask
for _, v := range value.MultiLine {
multiLineCommentMask |= v[0][0]
mlCommentTrie.InsertClose(TMlcomment, []byte(v[0]), []byte(v[1]))
tokenTrie.InsertClose(TMlcomment, []byte(v[0]), []byte(v[1]))
}
processMask |= multiLineCommentMask
for _, v := range value.Quotes {
stringMask |= v.Start[0]
stringTrie.InsertClose(TString, []byte(v.Start), []byte(v.End))
tokenTrie.InsertClose(TString, []byte(v.Start), []byte(v.End))
}
processMask |= stringMask
LanguageFeaturesMutex.Lock()
LanguageFeatures[name] = LanguageFeature{
Complexity: complexityTrie,
MultiLineComments: mlCommentTrie,
SingleLineComments: slCommentTrie,
Strings: stringTrie,
Tokens: tokenTrie,
Nested: value.NestedMultiLine,
ComplexityCheckMask: complexityMask,
MultiLineCommentMask: multiLineCommentMask,
SingleLineCommentMask: singleLineCommentMask,
StringCheckMask: stringMask,
ProcessMask: processMask,
Keywords: value.Keywords,
Quotes: value.Quotes,
}
LanguageFeaturesMutex.Unlock()
}
func processFlags() {
// If wide/more mode is enabled we want the complexity calculation
// to happen regardless as that is the only purpose of the flag
if More && Complexity {
Complexity = false
}
// If ignore minified/generated is on ensure we turn on the code to calculate that
if IgnoreMinifiedGenerate {
MinifiedGenerated = true
IgnoreMinified = true
IgnoreGenerated = true
}
if MinifiedGenerated {
Minified = true
Generated = true
}
if IgnoreMinified {
Minified = true
}
if IgnoreGenerated {
Generated = true
}
if Dryness {
UlocMode = true
}
if Debug {
printDebug(fmt.Sprintf("Path Deny List: %v", PathDenyList))
printDebug(fmt.Sprintf("Sort By: %s", SortBy))
printDebug(fmt.Sprintf("White List: %v", AllowListExtensions))
printDebug(fmt.Sprintf("Files Output: %t", Files))
printDebug(fmt.Sprintf("Verbose: %t", Verbose))
printDebug(fmt.Sprintf("Duplicates Detection: %t", Duplicates))
printDebug(fmt.Sprintf("Complexity Calculation: %t", !Complexity))
printDebug(fmt.Sprintf("Wide: %t", More))
printDebug(fmt.Sprintf("Average Wage: %d", AverageWage))
printDebug(fmt.Sprintf("Cocomo: %t", !Cocomo))
printDebug(fmt.Sprintf("Minified/Generated Detection: %t/%t", Minified, Generated))
printDebug(fmt.Sprintf("Ignore Minified/Generated: %t/%t", IgnoreMinified, IgnoreGenerated))
printDebug(fmt.Sprintf("IncludeSymLinks: %t", IncludeSymLinks))
printDebug(fmt.Sprintf("Uloc: %t", UlocMode))
printDebug(fmt.Sprintf("Dryness: %t", Dryness))
}
}
func loadDatabase() map[string]Language {
var database map[string]Language
startTime := makeTimestampMilli()
gzData, err := base64.StdEncoding.DecodeString(languages)
if err != nil {
panic(fmt.Sprintf("failed to base64 decode languages: %v", err))
}
dataReader, err := gzip.NewReader(bytes.NewReader(gzData))
if err != nil {
panic(fmt.Sprintf("failed to create gzip reader: %v", err))
}
var json = jsoniter.ConfigCompatibleWithStandardLibrary
if err := json.NewDecoder(dataReader).Decode(&database); err != nil {
panic(fmt.Sprintf("languages json invalid: %v", err))
}
if Trace {
printTrace(fmt.Sprintf("milliseconds unmarshal: %d", makeTimestampMilli()-startTime))
}
return database
}
func printLanguages() {
database := loadDatabase()
names := make([]string, 0, len(database))
for key := range database {
names = append(names, key)
}
slices.SortFunc(names, func(a, b string) int {
return strings.Compare(strings.ToLower(a), strings.ToLower(b))
})
for _, name := range names {
fmt.Printf("%s (%s)\n", name, strings.Join(append(database[name].Extensions, database[name].FileNames...), ","))
}
}
// global variables to deal with ULOC calculations
var ulocMutex = sync.Mutex{}
var ulocGlobalCount = map[string]struct{}{}
var ulocLanguageCount = map[string]map[string]struct{}{}
// Process is the main entry point of the command line it sets everything up and starts running
func Process() {
if Languages {
printLanguages()
return
}
ProcessConstants()
processFlags()
// Clean up any invalid arguments before setting everything up
if len(DirFilePaths) == 0 {
DirFilePaths = append(DirFilePaths, ".")
}
filePaths := []string{}
dirPaths := []string{}
// Check if the paths or files added exist and exit if not
for _, f := range DirFilePaths {
fpath := filepath.Clean(f)
s, err := os.Stat(fpath)
if os.IsNotExist(err) {
fmt.Println("file or directory does not exist: " + fpath)
os.Exit(1)
}
if s.IsDir() {
dirPaths = append(dirPaths, fpath)
} else {
filePaths = append(filePaths, fpath)
}
}
SortBy = strings.ToLower(SortBy)
if Debug {
printDebug(fmt.Sprintf("NumCPU: %d", runtime.NumCPU()))
printDebug(fmt.Sprintf("SortBy: %s", SortBy))
printDebug(fmt.Sprintf("PathDenyList: %v", PathDenyList))
}
potentialFilesQueue := make(chan *gocodewalker.File, FileListQueueSize) // files that pass the .gitignore checks
fileListQueue := make(chan *FileJob, FileListQueueSize) // Files ready to be read from disk
fileSummaryJobQueue := make(chan *FileJob, FileSummaryJobQueueSize) // Files ready to be summarised
fileWalker := gocodewalker.NewParallelFileWalker(dirPaths, potentialFilesQueue)
fileWalker.SetErrorHandler(func(e error) bool {
printError(e.Error())
return true
})
fileWalker.IgnoreGitIgnore = GitIgnore
fileWalker.IgnoreIgnoreFile = Ignore
fileWalker.IncludeHidden = true
fileWalker.ExcludeDirectory = PathDenyList
for _, exclude := range Exclude {
regexpResult, err := regexp.Compile(exclude)
if err == nil {
fileWalker.ExcludeFilenameRegex = append(fileWalker.ExcludeFilenameRegex, regexpResult)
fileWalker.ExcludeDirectoryRegex = append(fileWalker.ExcludeDirectoryRegex, regexpResult)
} else {
printError(err.Error())
}
}
go func() {
err := fileWalker.Start()
if err != nil {
printError(err.Error())
}
}()
go func() {
for _, f := range filePaths {
fileInfo, err := os.Lstat(f)
if err != nil {
continue
}
fileJob := newFileJob(f, f, fileInfo)
if fileJob != nil {
fileListQueue <- fileJob
}
}
for fi := range potentialFilesQueue {
fileInfo, err := os.Lstat(fi.Location)
if err != nil {
continue
}
if !fileInfo.IsDir() {
fileJob := newFileJob(fi.Location, fi.Filename, fileInfo)
if fileJob != nil {
fileListQueue <- fileJob
}
}
}
close(fileListQueue)
}()
go fileProcessorWorker(fileListQueue, fileSummaryJobQueue)
result := fileSummarize(fileSummaryJobQueue)
if FileOutput == "" {
fmt.Print(result)
} else {
_ = os.WriteFile(FileOutput, []byte(result), 0644)
fmt.Println("results written to " + FileOutput)
}
}