summaryrefslogtreecommitdiff
path: root/util/scripts/maintainers.go
blob: 53beb2ccf73da10d7d92094c14a986fa31716076 (plain)
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
/* SPDX-License-Identifier: GPL-2.0-only */

package main

import (
	"bufio"
	"flag"
	"fmt"
	"log"
	"os"
	"os/exec"
	"regexp"
	"strings"
)

type subsystem struct {
	name       string
	maintainer []string
	paths      []string
	globs      []*regexp.Regexp
}

var subsystems []subsystem

func get_git_files() ([]string, error) {
	var files []string

	/* Read in list of all files in the git repository */
	cmd := exec.Command("git", "ls-files")
	out, err := cmd.StdoutPipe()
	if err != nil {
		log.Fatalf("git ls-files failed: %v", err)
		return files, err
	}
	if err := cmd.Start(); err != nil {
		log.Fatalf("Could not start %v: %v", cmd, err)
		return files, err
	}

	r := bufio.NewScanner(out)
	for r.Scan() {
		/* Cut out leading tab */
		files = append(files, r.Text())
	}

	cmd.Wait()

	return files, nil
}

func get_maintainers() ([]string, error) {
	var maintainers []string

	/* Read in all maintainers */
	file, err := os.Open("MAINTAINERS")
	if err != nil {
		log.Fatalf("Can't open MAINTAINERS file: %v", err)
		log.Fatalf("Are you running from the top-level directory?")
		return maintainers, err
	}
	defer file.Close()

	keep := false
	s := bufio.NewScanner(file)
	for s.Scan() {
		/* Are we in the "data" section and have a non-empty line? */
		if keep && s.Text() != "" {
			maintainers = append(maintainers, s.Text())
		}
		/* Skip everything before the delimiter */
		if s.Text() == "\t\t-----------------------------------" {
			keep = true
		}
	}

	return maintainers, nil
}

func path_to_regexstr(path string) string {
	/* Add missing trailing slash if path is a directory */
	if path[len(path)-1] != '/' {
		fileInfo, err := os.Stat(path)
		if err == nil && fileInfo.IsDir() {
			path += "/"
		}
	}

	regexstr := glob_to_regex(path)

	/* Handle path with trailing '/' as prefix */
	if regexstr[len(regexstr)-2:] == "/$" {
		regexstr = regexstr[:len(regexstr)-1] + ".*$"
	}

	return regexstr;
}

func path_to_regex(path string) *regexp.Regexp {
	regexstr := path_to_regexstr(path)
	return regexp.MustCompile(regexstr)
}

func build_maintainers(maintainers []string) {
	var current *subsystem
	for _, line := range maintainers {
		if line[1] != ':' {
			/* Create new subsystem entry */
			var tmp subsystem
			subsystems = append(subsystems, tmp)
			current = &subsystems[len(subsystems)-1]
			current.name = line
		} else {
			switch line[0] {
			case 'R', 'M':
				/* Add subsystem maintainer */
				current.maintainer = append(current.maintainer, line[3:len(line)])
			case 'F':
				// add files
				current.paths = append(current.paths, line[3:len(line)])
				current.globs = append(current.globs, path_to_regex(line[3:len(line)]))
				break
			case 'L', 'S', 'T', 'W': // ignore
			default:
				fmt.Println("No such specifier: ", line)
			}
		}
	}
}

func print_maintainers() {
	for _, subsystem := range subsystems {
		fmt.Println(subsystem.name)
		fmt.Println("  ", subsystem.maintainer)
		fmt.Println("  ", subsystem.paths)
	}
}

func match_file(fname string, component subsystem) bool {
	for _, glob := range component.globs {
		if glob.Match([]byte(fname)) {
			return true
		}
	}
	return false
}

func find_maintainer(fname string) {
	var success bool

	for _, subsystem := range subsystems {
		matched := match_file(fname, subsystem)
		if matched {
			success = true
			fmt.Println(fname, "is in subsystem",
				subsystem.name)
			fmt.Println("Maintainers: ", strings.Join(subsystem.maintainer, ", "))
		}
	}
	if !success {
		fmt.Println(fname, "has no subsystem defined in MAINTAINERS")
	}
}

func find_unmaintained(fname string) {
	var success bool

	for _, subsystem := range subsystems {
		matched := match_file(fname, subsystem)
		if matched {
			success = true
			fmt.Println(fname, "is in subsystem",
				subsystem.name)
		}
	}
	if !success {
		fmt.Println(fname, "has no subsystem defined in MAINTAINERS")
	}
}

// taken from https://github.com/zyedidia/glob/blob/master/glob.go which is
// Copyright (c) 2016: Zachary Yedidia.
// and was published under the MIT "Expat" license.
//
// only change: return the string, instead of a compiled golang regex
func glob_to_regex(glob string) string {
	regex := ""
	inGroup := 0
	inClass := 0
	firstIndexInClass := -1
	arr := []byte(glob)

	for i := 0; i < len(arr); i++ {
		ch := arr[i]

		switch ch {
		case '\\':
			i++
			if i >= len(arr) {
				regex += "\\"
			} else {
				next := arr[i]
				switch next {
				case ',':
					// Nothing
				case 'Q', 'E':
					regex += "\\\\"
				default:
					regex += "\\"
				}
				regex += string(next)
			}
		case '*':
			if inClass == 0 {
				regex += "[^/]*"
			} else {
				regex += "*"
			}
		case '?':
			if inClass == 0 {
				regex += "."
			} else {
				regex += "?"
			}
		case '[':
			inClass++
			firstIndexInClass = i + 1
			regex += "["
		case ']':
			inClass--
			regex += "]"
		case '.', '(', ')', '+', '|', '^', '$', '@', '%':
			if inClass == 0 || (firstIndexInClass == i && ch == '^') {
				regex += "\\"
			}
			regex += string(ch)
		case '!':
			if firstIndexInClass == i {
				regex += "^"
			} else {
				regex += "!"
			}
		case '{':
			inGroup++
			regex += "("
		case '}':
			inGroup--
			regex += ")"
		case ',':
			if inGroup > 0 {
				regex += "|"
			} else {
				regex += ","
			}
		default:
			regex += string(ch)
		}
	}
	return "^" + regex + "$"
}

var is_email *regexp.Regexp

func extract_maintainer(maintainer string) string {
	if is_email == nil {
		is_email = regexp.MustCompile("<[^>]*>")
	}

	if match := is_email.FindStringSubmatch(maintainer); match != nil {
		return match[0][1 : len(match[0])-1]
	}
	return maintainer
}

func do_print_gerrit_rules() {
	for _, subsystem := range subsystems {
		if len(subsystem.paths) == 0 || len(subsystem.maintainer) == 0 {
			continue
		}
		fmt.Println("#", subsystem.name)
		for _, path := range subsystem.paths {
			fmt.Println("[filter \"file:\\\"" + path_to_regexstr(path) + "\\\"\"]")
			for _, maint := range subsystem.maintainer {
				fmt.Println("  reviewer =", extract_maintainer(maint))
			}
		}
		fmt.Println()
	}
}

func main() {
	var (
		files              []string
		err                error
		print_gerrit_rules = flag.Bool("print-gerrit-rules", false, "emit the MAINTAINERS rules in a format suitable for Gerrit's reviewers plugin")
		debug              = flag.Bool("debug", false, "emit additional debug output")
	)
	flag.Parse()

	/* get and build subsystem database */
	maintainers, err := get_maintainers()
	if err != nil {
		log.Fatalf("Oops.")
		return
	}
	build_maintainers(maintainers)

	if *debug {
		print_maintainers()
	}

	if *print_gerrit_rules {
		do_print_gerrit_rules()
		return
	}

	args := flag.Args()
	if len(args) == 0 {
		/* get the filenames */
		files, err = get_git_files()
		if err != nil {
			log.Fatalf("Oops.")
			return
		}
		for _, file := range files {
			find_unmaintained(file)
		}
	} else {
		files = args

		/* Find maintainers for each file */
		for _, file := range files {
			find_maintainer(file)
		}
	}
}