blob: 81a67a458e78ddd494343e5746a195ef4e821440 [file] [log] [blame]
Joe Perchescb7301c2009-04-07 20:40:12 -07001#!/usr/bin/perl -w
2# (c) 2007, Joe Perches <joe@perches.com>
3# created from checkpatch.pl
4#
5# Print selected MAINTAINERS information for
6# the files modified in a patch or for a file
7#
Roel Kluin3bd7bf52009-11-11 14:26:13 -08008# usage: perl scripts/get_maintainer.pl [OPTIONS] <patch>
9# perl scripts/get_maintainer.pl [OPTIONS] -f <file>
Joe Perchescb7301c2009-04-07 20:40:12 -070010#
11# Licensed under the terms of the GNU GPL License version 2
12
13use strict;
14
15my $P = $0;
Joe Perchesdcf36a92009-10-26 16:49:47 -070016my $V = '0.21';
Joe Perchescb7301c2009-04-07 20:40:12 -070017
18use Getopt::Long qw(:config no_auto_abbrev);
19
20my $lk_path = "./";
21my $email = 1;
22my $email_usename = 1;
23my $email_maintainer = 1;
24my $email_list = 1;
25my $email_subscriber_list = 0;
26my $email_git = 1;
27my $email_git_penguin_chiefs = 0;
28my $email_git_min_signatures = 1;
29my $email_git_max_maintainers = 5;
Joe Perchesafa81ee2009-07-29 15:04:28 -070030my $email_git_min_percent = 5;
Joe Perchescb7301c2009-04-07 20:40:12 -070031my $email_git_since = "1-year-ago";
Joe Perchesf5492662009-09-21 17:04:13 -070032my $email_git_blame = 0;
Joe Perches11ecf532009-09-21 17:04:22 -070033my $email_remove_duplicates = 1;
Joe Perchescb7301c2009-04-07 20:40:12 -070034my $output_multiline = 1;
35my $output_separator = ", ";
36my $scm = 0;
37my $web = 0;
38my $subsystem = 0;
39my $status = 0;
Joe Perchesdcf36a92009-10-26 16:49:47 -070040my $keywords = 1;
Joe Perches4a7fdb52009-04-10 12:28:57 -070041my $from_filename = 0;
Joe Perches3fb55652009-09-21 17:04:17 -070042my $pattern_depth = 0;
Joe Perchescb7301c2009-04-07 20:40:12 -070043my $version = 0;
44my $help = 0;
45
46my $exit = 0;
47
48my @penguin_chief = ();
49push(@penguin_chief,"Linus Torvalds:torvalds\@linux-foundation.org");
50#Andrew wants in on most everything - 2009/01/14
51#push(@penguin_chief,"Andrew Morton:akpm\@linux-foundation.org");
52
53my @penguin_chief_names = ();
54foreach my $chief (@penguin_chief) {
55 if ($chief =~ m/^(.*):(.*)/) {
56 my $chief_name = $1;
57 my $chief_addr = $2;
58 push(@penguin_chief_names, $chief_name);
59 }
60}
61my $penguin_chiefs = "\(" . join("|",@penguin_chief_names) . "\)";
62
Joe Perches5f2441e2009-06-16 15:34:02 -070063# rfc822 email address - preloaded methods go here.
Joe Perches1b5e1cf2009-06-16 15:34:01 -070064my $rfc822_lwsp = "(?:(?:\\r\\n)?[ \\t])";
Joe Perchesdf4cc032009-06-16 15:34:04 -070065my $rfc822_char = '[\\000-\\377]';
Joe Perches1b5e1cf2009-06-16 15:34:01 -070066
Joe Perchescb7301c2009-04-07 20:40:12 -070067if (!GetOptions(
68 'email!' => \$email,
69 'git!' => \$email_git,
70 'git-chief-penguins!' => \$email_git_penguin_chiefs,
71 'git-min-signatures=i' => \$email_git_min_signatures,
72 'git-max-maintainers=i' => \$email_git_max_maintainers,
Joe Perchesafa81ee2009-07-29 15:04:28 -070073 'git-min-percent=i' => \$email_git_min_percent,
Joe Perchescb7301c2009-04-07 20:40:12 -070074 'git-since=s' => \$email_git_since,
Joe Perchesf5492662009-09-21 17:04:13 -070075 'git-blame!' => \$email_git_blame,
Joe Perches11ecf532009-09-21 17:04:22 -070076 'remove-duplicates!' => \$email_remove_duplicates,
Joe Perchescb7301c2009-04-07 20:40:12 -070077 'm!' => \$email_maintainer,
78 'n!' => \$email_usename,
79 'l!' => \$email_list,
80 's!' => \$email_subscriber_list,
81 'multiline!' => \$output_multiline,
82 'separator=s' => \$output_separator,
83 'subsystem!' => \$subsystem,
84 'status!' => \$status,
85 'scm!' => \$scm,
86 'web!' => \$web,
Joe Perches3fb55652009-09-21 17:04:17 -070087 'pattern-depth=i' => \$pattern_depth,
Joe Perchesdcf36a92009-10-26 16:49:47 -070088 'k|keywords!' => \$keywords,
Joe Perches4a7fdb52009-04-10 12:28:57 -070089 'f|file' => \$from_filename,
Joe Perchescb7301c2009-04-07 20:40:12 -070090 'v|version' => \$version,
91 'h|help' => \$help,
92 )) {
93 usage();
94 die "$P: invalid argument\n";
95}
96
97if ($help != 0) {
98 usage();
99 exit 0;
100}
101
102if ($version != 0) {
103 print("${P} ${V}\n");
104 exit 0;
105}
106
Joe Perchescb7301c2009-04-07 20:40:12 -0700107if ($#ARGV < 0) {
108 usage();
109 die "$P: argument missing: patchfile or -f file please\n";
110}
111
Joe Perches42498312009-09-21 17:04:21 -0700112if ($output_separator ne ", ") {
113 $output_multiline = 0;
114}
115
Joe Perchescb7301c2009-04-07 20:40:12 -0700116my $selections = $email + $scm + $status + $subsystem + $web;
117if ($selections == 0) {
118 usage();
119 die "$P: Missing required option: email, scm, status, subsystem or web\n";
120}
121
Joe Perchesf5492662009-09-21 17:04:13 -0700122if ($email &&
123 ($email_maintainer + $email_list + $email_subscriber_list +
124 $email_git + $email_git_penguin_chiefs + $email_git_blame) == 0) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700125 usage();
126 die "$P: Please select at least 1 email option\n";
127}
128
129if (!top_of_kernel_tree($lk_path)) {
130 die "$P: The current directory does not appear to be "
131 . "a linux kernel source tree.\n";
132}
133
134## Read MAINTAINERS for type/value pairs
135
136my @typevalue = ();
Joe Perchesdcf36a92009-10-26 16:49:47 -0700137my %keyword_hash;
138
Joe Perchescb7301c2009-04-07 20:40:12 -0700139open(MAINT, "<${lk_path}MAINTAINERS") || die "$P: Can't open MAINTAINERS\n";
140while (<MAINT>) {
141 my $line = $_;
142
143 if ($line =~ m/^(\C):\s*(.*)/) {
144 my $type = $1;
145 my $value = $2;
146
147 ##Filename pattern matching
148 if ($type eq "F" || $type eq "X") {
149 $value =~ s@\.@\\\.@g; ##Convert . to \.
150 $value =~ s/\*/\.\*/g; ##Convert * to .*
151 $value =~ s/\?/\./g; ##Convert ? to .
Joe Perches870020f2009-07-29 15:04:28 -0700152 ##if pattern is a directory and it lacks a trailing slash, add one
153 if ((-d $value)) {
154 $value =~ s@([^/])$@$1/@;
155 }
Joe Perchesdcf36a92009-10-26 16:49:47 -0700156 } elsif ($type eq "K") {
157 $keyword_hash{@typevalue} = $value;
Joe Perchescb7301c2009-04-07 20:40:12 -0700158 }
159 push(@typevalue, "$type:$value");
160 } elsif (!/^(\s)*$/) {
161 $line =~ s/\n$//g;
162 push(@typevalue, $line);
163 }
164}
165close(MAINT);
166
Joe Perches8cbb3a72009-09-21 17:04:21 -0700167my %mailmap;
168
Joe Perches11ecf532009-09-21 17:04:22 -0700169if ($email_remove_duplicates) {
170 open(MAILMAP, "<${lk_path}.mailmap") || warn "$P: Can't open .mailmap\n";
171 while (<MAILMAP>) {
172 my $line = $_;
Joe Perches8cbb3a72009-09-21 17:04:21 -0700173
Joe Perches11ecf532009-09-21 17:04:22 -0700174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
Joe Perches8cbb3a72009-09-21 17:04:21 -0700176
Joe Perches11ecf532009-09-21 17:04:22 -0700177 my ($name, $address) = parse_email($line);
178 $line = format_email($name, $address);
Joe Perches8cbb3a72009-09-21 17:04:21 -0700179
Joe Perches11ecf532009-09-21 17:04:22 -0700180 next if ($line =~ m/^\s*$/);
Joe Perches8cbb3a72009-09-21 17:04:21 -0700181
Joe Perches11ecf532009-09-21 17:04:22 -0700182 if (exists($mailmap{$name})) {
183 my $obj = $mailmap{$name};
184 push(@$obj, $address);
185 } else {
186 my @arr = ($address);
187 $mailmap{$name} = \@arr;
188 }
Joe Perches8cbb3a72009-09-21 17:04:21 -0700189 }
Joe Perches11ecf532009-09-21 17:04:22 -0700190 close(MAILMAP);
Joe Perches8cbb3a72009-09-21 17:04:21 -0700191}
192
Joe Perches4a7fdb52009-04-10 12:28:57 -0700193## use the filenames on the command line or find the filenames in the patchfiles
Joe Perchescb7301c2009-04-07 20:40:12 -0700194
195my @files = ();
Joe Perchesf5492662009-09-21 17:04:13 -0700196my @range = ();
Joe Perchesdcf36a92009-10-26 16:49:47 -0700197my @keyword_tvi = ();
Joe Perchescb7301c2009-04-07 20:40:12 -0700198
Joe Perches4a7fdb52009-04-10 12:28:57 -0700199foreach my $file (@ARGV) {
Joe Perches870020f2009-07-29 15:04:28 -0700200 ##if $file is a directory and it lacks a trailing slash, add one
201 if ((-d $file)) {
202 $file =~ s@([^/])$@$1/@;
203 } elsif (!(-f $file)) {
Joe Perches4a7fdb52009-04-10 12:28:57 -0700204 die "$P: file '${file}' not found\n";
Joe Perchescb7301c2009-04-07 20:40:12 -0700205 }
Joe Perches4a7fdb52009-04-10 12:28:57 -0700206 if ($from_filename) {
207 push(@files, $file);
Joe Perchesdcf36a92009-10-26 16:49:47 -0700208 if (-f $file && $keywords) {
209 open(FILE, "<$file") or die "$P: Can't open ${file}\n";
210 while (<FILE>) {
211 my $patch_line = $_;
212 foreach my $line (keys %keyword_hash) {
213 if ($patch_line =~ m/^.*$keyword_hash{$line}/x) {
214 push(@keyword_tvi, $line);
215 }
216 }
217 }
218 close(FILE);
219 }
Joe Perches4a7fdb52009-04-10 12:28:57 -0700220 } else {
221 my $file_cnt = @files;
Joe Perchesf5492662009-09-21 17:04:13 -0700222 my $lastfile;
Joe Perches4a7fdb52009-04-10 12:28:57 -0700223 open(PATCH, "<$file") or die "$P: Can't open ${file}\n";
224 while (<PATCH>) {
Joe Perchesdcf36a92009-10-26 16:49:47 -0700225 my $patch_line = $_;
Joe Perches4a7fdb52009-04-10 12:28:57 -0700226 if (m/^\+\+\+\s+(\S+)/) {
227 my $filename = $1;
228 $filename =~ s@^[^/]*/@@;
229 $filename =~ s@\n@@;
Joe Perchesf5492662009-09-21 17:04:13 -0700230 $lastfile = $filename;
Joe Perches4a7fdb52009-04-10 12:28:57 -0700231 push(@files, $filename);
Joe Perchesf5492662009-09-21 17:04:13 -0700232 } elsif (m/^\@\@ -(\d+),(\d+)/) {
233 if ($email_git_blame) {
234 push(@range, "$lastfile:$1:$2");
235 }
Joe Perchesdcf36a92009-10-26 16:49:47 -0700236 } elsif ($keywords) {
237 foreach my $line (keys %keyword_hash) {
238 if ($patch_line =~ m/^[+-].*$keyword_hash{$line}/x) {
239 push(@keyword_tvi, $line);
240 }
241 }
Joe Perches4a7fdb52009-04-10 12:28:57 -0700242 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700243 }
Joe Perches4a7fdb52009-04-10 12:28:57 -0700244 close(PATCH);
245 if ($file_cnt == @files) {
Joe Perches7f29fd272009-06-16 15:34:04 -0700246 warn "$P: file '${file}' doesn't appear to be a patch. "
Joe Perches4a7fdb52009-04-10 12:28:57 -0700247 . "Add -f to options?\n";
248 }
249 @files = sort_and_uniq(@files);
Joe Perchescb7301c2009-04-07 20:40:12 -0700250 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700251}
252
253my @email_to = ();
Joe Perches290603c2009-06-16 15:33:58 -0700254my @list_to = ();
Joe Perchescb7301c2009-04-07 20:40:12 -0700255my @scm = ();
256my @web = ();
257my @subsystem = ();
258my @status = ();
259
260# Find responsible parties
261
262foreach my $file (@files) {
263
264#Do not match excluded file patterns
265
266 my $exclude = 0;
267 foreach my $line (@typevalue) {
Joe Perches290603c2009-06-16 15:33:58 -0700268 if ($line =~ m/^(\C):\s*(.*)/) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700269 my $type = $1;
270 my $value = $2;
271 if ($type eq 'X') {
272 if (file_match_pattern($file, $value)) {
273 $exclude = 1;
Joe Perches1d606b42009-09-21 17:04:14 -0700274 last;
Joe Perchescb7301c2009-04-07 20:40:12 -0700275 }
276 }
277 }
278 }
279
280 if (!$exclude) {
281 my $tvi = 0;
Joe Perches1d606b42009-09-21 17:04:14 -0700282 my %hash;
Joe Perchescb7301c2009-04-07 20:40:12 -0700283 foreach my $line (@typevalue) {
Joe Perches290603c2009-06-16 15:33:58 -0700284 if ($line =~ m/^(\C):\s*(.*)/) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700285 my $type = $1;
286 my $value = $2;
287 if ($type eq 'F') {
288 if (file_match_pattern($file, $value)) {
Joe Perches3fb55652009-09-21 17:04:17 -0700289 my $value_pd = ($value =~ tr@/@@);
290 my $file_pd = ($file =~ tr@/@@);
291 $value_pd++ if (substr($value,-1,1) ne "/");
292 if ($pattern_depth == 0 ||
293 (($file_pd - $value_pd) < $pattern_depth)) {
294 $hash{$tvi} = $value_pd;
295 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700296 }
297 }
298 }
299 $tvi++;
300 }
Joe Perches1d606b42009-09-21 17:04:14 -0700301 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
302 add_categories($line);
303 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700304 }
305
Joe Perches4a7fdb52009-04-10 12:28:57 -0700306 if ($email && $email_git) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700307 recent_git_signoffs($file);
308 }
309
Joe Perchesf5492662009-09-21 17:04:13 -0700310 if ($email && $email_git_blame) {
311 git_assign_blame($file);
312 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700313}
314
Joe Perchesdcf36a92009-10-26 16:49:47 -0700315if ($keywords) {
316 @keyword_tvi = sort_and_uniq(@keyword_tvi);
317 foreach my $line (@keyword_tvi) {
318 add_categories($line);
319 }
320}
321
Joe Perchesf5f50782009-06-16 15:34:00 -0700322if ($email) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700323 foreach my $chief (@penguin_chief) {
324 if ($chief =~ m/^(.*):(.*)/) {
Joe Perchesf5f50782009-06-16 15:34:00 -0700325 my $email_address;
Joe Perches0e70e832009-09-21 17:04:20 -0700326
327 $email_address = format_email($1, $2);
Joe Perchesf5f50782009-06-16 15:34:00 -0700328 if ($email_git_penguin_chiefs) {
329 push(@email_to, $email_address);
330 } else {
331 @email_to = grep(!/${email_address}/, @email_to);
Joe Perchescb7301c2009-04-07 20:40:12 -0700332 }
333 }
334 }
335}
336
Joe Perches290603c2009-06-16 15:33:58 -0700337if ($email || $email_list) {
338 my @to = ();
339 if ($email) {
340 @to = (@to, @email_to);
Joe Perchescb7301c2009-04-07 20:40:12 -0700341 }
Joe Perches290603c2009-06-16 15:33:58 -0700342 if ($email_list) {
Joe Perches290603c2009-06-16 15:33:58 -0700343 @to = (@to, @list_to);
Joe Perches290603c2009-06-16 15:33:58 -0700344 }
345 output(uniq(@to));
Joe Perchescb7301c2009-04-07 20:40:12 -0700346}
347
348if ($scm) {
Joe Perchesb7816552009-09-21 17:04:24 -0700349 @scm = uniq(@scm);
Joe Perchescb7301c2009-04-07 20:40:12 -0700350 output(@scm);
351}
352
353if ($status) {
Joe Perchesb7816552009-09-21 17:04:24 -0700354 @status = uniq(@status);
Joe Perchescb7301c2009-04-07 20:40:12 -0700355 output(@status);
356}
357
358if ($subsystem) {
Joe Perchesb7816552009-09-21 17:04:24 -0700359 @subsystem = uniq(@subsystem);
Joe Perchescb7301c2009-04-07 20:40:12 -0700360 output(@subsystem);
361}
362
363if ($web) {
Joe Perchesb7816552009-09-21 17:04:24 -0700364 @web = uniq(@web);
Joe Perchescb7301c2009-04-07 20:40:12 -0700365 output(@web);
366}
367
368exit($exit);
369
370sub file_match_pattern {
371 my ($file, $pattern) = @_;
372 if (substr($pattern, -1) eq "/") {
373 if ($file =~ m@^$pattern@) {
374 return 1;
375 }
376 } else {
377 if ($file =~ m@^$pattern@) {
378 my $s1 = ($file =~ tr@/@@);
379 my $s2 = ($pattern =~ tr@/@@);
380 if ($s1 == $s2) {
381 return 1;
382 }
383 }
384 }
385 return 0;
386}
387
388sub usage {
389 print <<EOT;
390usage: $P [options] patchfile
Joe Perches870020f2009-07-29 15:04:28 -0700391 $P [options] -f file|directory
Joe Perchescb7301c2009-04-07 20:40:12 -0700392version: $V
393
394MAINTAINER field selection options:
395 --email => print email address(es) if any
396 --git => include recent git \*-by: signers
397 --git-chief-penguins => include ${penguin_chiefs}
398 --git-min-signatures => number of signatures required (default: 1)
399 --git-max-maintainers => maximum maintainers to add (default: 5)
Joe Perches3d202ae2009-07-29 15:04:29 -0700400 --git-min-percent => minimum percentage of commits required (default: 5)
Joe Perchescb7301c2009-04-07 20:40:12 -0700401 --git-since => git history to use (default: 1-year-ago)
Joe Perchesf5492662009-09-21 17:04:13 -0700402 --git-blame => use git blame to find modified commits for patch or file
Joe Perchescb7301c2009-04-07 20:40:12 -0700403 --m => include maintainer(s) if any
404 --n => include name 'Full Name <addr\@domain.tld>'
405 --l => include list(s) if any
406 --s => include subscriber only list(s) if any
Joe Perches11ecf532009-09-21 17:04:22 -0700407 --remove-duplicates => minimize duplicate email names/addresses
Joe Perchescb7301c2009-04-07 20:40:12 -0700408 --scm => print SCM tree(s) if any
409 --status => print status if any
410 --subsystem => print subsystem name if any
411 --web => print website(s) if any
412
413Output type options:
414 --separator [, ] => separator for multiple entries on 1 line
Joe Perches42498312009-09-21 17:04:21 -0700415 using --separator also sets --nomultiline if --separator is not [, ]
Joe Perchescb7301c2009-04-07 20:40:12 -0700416 --multiline => print 1 entry per line
417
Joe Perchescb7301c2009-04-07 20:40:12 -0700418Other options:
Joe Perches3fb55652009-09-21 17:04:17 -0700419 --pattern-depth => Number of pattern directory traversals (default: 0 (all))
Joe Perchesdcf36a92009-10-26 16:49:47 -0700420 --keywords => scan patch for keywords (default: 1 (on))
Joe Perchesf5f50782009-06-16 15:34:00 -0700421 --version => show version
Joe Perchescb7301c2009-04-07 20:40:12 -0700422 --help => show this help information
423
Joe Perches3fb55652009-09-21 17:04:17 -0700424Default options:
Joe Perches11ecf532009-09-21 17:04:22 -0700425 [--email --git --m --n --l --multiline --pattern-depth=0 --remove-duplicates]
Joe Perches3fb55652009-09-21 17:04:17 -0700426
Joe Perches870020f2009-07-29 15:04:28 -0700427Notes:
428 Using "-f directory" may give unexpected results:
Joe Perchesf5492662009-09-21 17:04:13 -0700429 Used with "--git", git signators for _all_ files in and below
430 directory are examined as git recurses directories.
431 Any specified X: (exclude) pattern matches are _not_ ignored.
432 Used with "--nogit", directory is used as a pattern match,
433 no individual file within the directory or subdirectory
434 is matched.
435 Used with "--git-blame", does not iterate all files in directory
436 Using "--git-blame" is slow and may add old committers and authors
437 that are no longer active maintainers to the output.
Joe Perchescb7301c2009-04-07 20:40:12 -0700438EOT
439}
440
441sub top_of_kernel_tree {
442 my ($lk_path) = @_;
443
444 if ($lk_path ne "" && substr($lk_path,length($lk_path)-1,1) ne "/") {
445 $lk_path .= "/";
446 }
447 if ( (-f "${lk_path}COPYING")
448 && (-f "${lk_path}CREDITS")
449 && (-f "${lk_path}Kbuild")
450 && (-f "${lk_path}MAINTAINERS")
451 && (-f "${lk_path}Makefile")
452 && (-f "${lk_path}README")
453 && (-d "${lk_path}Documentation")
454 && (-d "${lk_path}arch")
455 && (-d "${lk_path}include")
456 && (-d "${lk_path}drivers")
457 && (-d "${lk_path}fs")
458 && (-d "${lk_path}init")
459 && (-d "${lk_path}ipc")
460 && (-d "${lk_path}kernel")
461 && (-d "${lk_path}lib")
462 && (-d "${lk_path}scripts")) {
463 return 1;
464 }
465 return 0;
466}
467
Joe Perches0e70e832009-09-21 17:04:20 -0700468sub parse_email {
469 my ($formatted_email) = @_;
470
471 my $name = "";
472 my $address = "";
473
Joe Perches11ecf532009-09-21 17:04:22 -0700474 if ($formatted_email =~ /^([^<]+)<(.+\@.*)>.*$/) {
Joe Perches0e70e832009-09-21 17:04:20 -0700475 $name = $1;
476 $address = $2;
Joe Perches11ecf532009-09-21 17:04:22 -0700477 } elsif ($formatted_email =~ /^\s*<(.+\@\S*)>.*$/) {
Joe Perches0e70e832009-09-21 17:04:20 -0700478 $address = $1;
Joe Perchesb7816552009-09-21 17:04:24 -0700479 } elsif ($formatted_email =~ /^(.+\@\S*).*$/) {
Joe Perches0e70e832009-09-21 17:04:20 -0700480 $address = $1;
481 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700482
483 $name =~ s/^\s+|\s+$//g;
Joe Perchesd7895042009-06-16 15:34:02 -0700484 $name =~ s/^\"|\"$//g;
Joe Perches0e70e832009-09-21 17:04:20 -0700485 $address =~ s/^\s+|\s+$//g;
Joe Perchescb7301c2009-04-07 20:40:12 -0700486
487 if ($name =~ /[^a-z0-9 \.\-]/i) { ##has "must quote" chars
488 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
Joe Perches0e70e832009-09-21 17:04:20 -0700489 $name = "\"$name\"";
Joe Perchescb7301c2009-04-07 20:40:12 -0700490 }
Joe Perches0e70e832009-09-21 17:04:20 -0700491
492 return ($name, $address);
493}
494
495sub format_email {
496 my ($name, $address) = @_;
497
498 my $formatted_email;
499
500 $name =~ s/^\s+|\s+$//g;
501 $name =~ s/^\"|\"$//g;
502 $address =~ s/^\s+|\s+$//g;
503
504 if ($name =~ /[^a-z0-9 \.\-]/i) { ##has "must quote" chars
505 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
506 $name = "\"$name\"";
507 }
508
509 if ($email_usename) {
510 if ("$name" eq "") {
511 $formatted_email = "$address";
512 } else {
513 $formatted_email = "$name <${address}>";
514 }
515 } else {
516 $formatted_email = $address;
517 }
518
Joe Perchescb7301c2009-04-07 20:40:12 -0700519 return $formatted_email;
520}
521
Joe Perchesb7816552009-09-21 17:04:24 -0700522sub find_starting_index {
Joe Perchesb7816552009-09-21 17:04:24 -0700523 my ($index) = @_;
524
525 while ($index > 0) {
526 my $tv = $typevalue[$index];
527 if (!($tv =~ m/^(\C):\s*(.*)/)) {
528 last;
529 }
530 $index--;
531 }
532
533 return $index;
534}
535
536sub find_ending_index {
537 my ($index) = @_;
538
539 while ($index < @typevalue) {
540 my $tv = $typevalue[$index];
541 if (!($tv =~ m/^(\C):\s*(.*)/)) {
542 last;
543 }
544 $index++;
545 }
546
547 return $index;
548}
549
Joe Perchescb7301c2009-04-07 20:40:12 -0700550sub add_categories {
551 my ($index) = @_;
552
Joe Perchesb7816552009-09-21 17:04:24 -0700553 my $i;
554 my $start = find_starting_index($index);
555 my $end = find_ending_index($index);
556
557 push(@subsystem, $typevalue[$start]);
558
559 for ($i = $start + 1; $i < $end; $i++) {
560 my $tv = $typevalue[$i];
Joe Perches290603c2009-06-16 15:33:58 -0700561 if ($tv =~ m/^(\C):\s*(.*)/) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700562 my $ptype = $1;
563 my $pvalue = $2;
564 if ($ptype eq "L") {
Joe Perches290603c2009-06-16 15:33:58 -0700565 my $list_address = $pvalue;
566 my $list_additional = "";
567 if ($list_address =~ m/([^\s]+)\s+(.*)$/) {
568 $list_address = $1;
569 $list_additional = $2;
570 }
Joe Perchesbdf7c682009-06-16 15:33:59 -0700571 if ($list_additional =~ m/subscribers-only/) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700572 if ($email_subscriber_list) {
Joe Perches290603c2009-06-16 15:33:58 -0700573 push(@list_to, $list_address);
Joe Perchescb7301c2009-04-07 20:40:12 -0700574 }
575 } else {
576 if ($email_list) {
Joe Perches290603c2009-06-16 15:33:58 -0700577 push(@list_to, $list_address);
Joe Perchescb7301c2009-04-07 20:40:12 -0700578 }
579 }
580 } elsif ($ptype eq "M") {
Joe Perches0e70e832009-09-21 17:04:20 -0700581 my ($name, $address) = parse_email($pvalue);
582 if ($name eq "") {
Joe Perchesb7816552009-09-21 17:04:24 -0700583 if ($i > 0) {
584 my $tv = $typevalue[$i - 1];
Joe Perches0e70e832009-09-21 17:04:20 -0700585 if ($tv =~ m/^(\C):\s*(.*)/) {
586 if ($1 eq "P") {
587 $name = $2;
Joe Perchesb7816552009-09-21 17:04:24 -0700588 $pvalue = format_email($name, $address);
Joe Perches5f2441e2009-06-16 15:34:02 -0700589 }
590 }
591 }
592 }
Joe Perches0e70e832009-09-21 17:04:20 -0700593 if ($email_maintainer) {
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700594 push_email_addresses($pvalue);
Joe Perchescb7301c2009-04-07 20:40:12 -0700595 }
596 } elsif ($ptype eq "T") {
597 push(@scm, $pvalue);
598 } elsif ($ptype eq "W") {
599 push(@web, $pvalue);
600 } elsif ($ptype eq "S") {
601 push(@status, $pvalue);
602 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700603 }
604 }
605}
606
Joe Perches11ecf532009-09-21 17:04:22 -0700607my %email_hash_name;
608my %email_hash_address;
Joe Perches0e70e832009-09-21 17:04:20 -0700609
Joe Perches11ecf532009-09-21 17:04:22 -0700610sub email_inuse {
611 my ($name, $address) = @_;
Joe Perches0e70e832009-09-21 17:04:20 -0700612
Joe Perches11ecf532009-09-21 17:04:22 -0700613 return 1 if (($name eq "") && ($address eq ""));
614 return 1 if (($name ne "") && exists($email_hash_name{$name}));
615 return 1 if (($address ne "") && exists($email_hash_address{$address}));
616
Joe Perches0e70e832009-09-21 17:04:20 -0700617 return 0;
618}
619
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700620sub push_email_address {
Joe Perches0e70e832009-09-21 17:04:20 -0700621 my ($line) = @_;
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700622
Joe Perches0e70e832009-09-21 17:04:20 -0700623 my ($name, $address) = parse_email($line);
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700624
Joe Perchesb7816552009-09-21 17:04:24 -0700625 if ($address eq "") {
626 return 0;
627 }
628
Joe Perches11ecf532009-09-21 17:04:22 -0700629 if (!$email_remove_duplicates) {
Joe Perches0e70e832009-09-21 17:04:20 -0700630 push(@email_to, format_email($name, $address));
Joe Perches11ecf532009-09-21 17:04:22 -0700631 } elsif (!email_inuse($name, $address)) {
632 push(@email_to, format_email($name, $address));
633 $email_hash_name{$name}++;
634 $email_hash_address{$address}++;
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700635 }
Joe Perchesb7816552009-09-21 17:04:24 -0700636
637 return 1;
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700638}
639
640sub push_email_addresses {
641 my ($address) = @_;
642
643 my @address_list = ();
644
Joe Perches5f2441e2009-06-16 15:34:02 -0700645 if (rfc822_valid($address)) {
646 push_email_address($address);
647 } elsif (@address_list = rfc822_validlist($address)) {
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700648 my $array_count = shift(@address_list);
649 while (my $entry = shift(@address_list)) {
650 push_email_address($entry);
651 }
Joe Perches5f2441e2009-06-16 15:34:02 -0700652 } else {
Joe Perchesb7816552009-09-21 17:04:24 -0700653 if (!push_email_address($address)) {
654 warn("Invalid MAINTAINERS address: '" . $address . "'\n");
655 }
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700656 }
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700657}
658
Joe Perchescb7301c2009-04-07 20:40:12 -0700659sub which {
660 my ($bin) = @_;
661
Joe Perchesf5f50782009-06-16 15:34:00 -0700662 foreach my $path (split(/:/, $ENV{PATH})) {
Joe Perchescb7301c2009-04-07 20:40:12 -0700663 if (-e "$path/$bin") {
664 return "$path/$bin";
665 }
666 }
667
668 return "";
669}
670
Joe Perches8cbb3a72009-09-21 17:04:21 -0700671sub mailmap {
672 my @lines = @_;
673 my %hash;
674
675 foreach my $line (@lines) {
676 my ($name, $address) = parse_email($line);
677 if (!exists($hash{$name})) {
678 $hash{$name} = $address;
Joe Perches11ecf532009-09-21 17:04:22 -0700679 } elsif ($address ne $hash{$name}) {
680 $address = $hash{$name};
681 $line = format_email($name, $address);
Joe Perches8cbb3a72009-09-21 17:04:21 -0700682 }
683 if (exists($mailmap{$name})) {
684 my $obj = $mailmap{$name};
685 foreach my $map_address (@$obj) {
686 if (($map_address eq $address) &&
687 ($map_address ne $hash{$name})) {
688 $line = format_email($name, $hash{$name});
689 }
690 }
691 }
692 }
693
694 return @lines;
695}
696
Joe Perchescb7301c2009-04-07 20:40:12 -0700697sub recent_git_signoffs {
698 my ($file) = @_;
699
700 my $sign_offs = "";
701 my $cmd = "";
702 my $output = "";
703 my $count = 0;
704 my @lines = ();
Joe Perches0e70e832009-09-21 17:04:20 -0700705 my %hash;
Joe Perchesafa81ee2009-07-29 15:04:28 -0700706 my $total_sign_offs;
Joe Perchescb7301c2009-04-07 20:40:12 -0700707
708 if (which("git") eq "") {
Joe Perchesde2fc492009-06-16 15:34:01 -0700709 warn("$P: git not found. Add --nogit to options?\n");
710 return;
711 }
712 if (!(-d ".git")) {
Joe Perches5f2441e2009-06-16 15:34:02 -0700713 warn("$P: .git directory not found. Use a git repository for better results.\n");
714 warn("$P: perhaps 'git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git'\n");
Joe Perchesde2fc492009-06-16 15:34:01 -0700715 return;
Joe Perchescb7301c2009-04-07 20:40:12 -0700716 }
717
718 $cmd = "git log --since=${email_git_since} -- ${file}";
Joe Perchescb7301c2009-04-07 20:40:12 -0700719
720 $output = `${cmd}`;
721 $output =~ s/^\s*//gm;
722
723 @lines = split("\n", $output);
Joe Perchesafa81ee2009-07-29 15:04:28 -0700724
Joe Perches0e70e832009-09-21 17:04:20 -0700725 @lines = grep(/^[-_ a-z]+by:.*\@.*$/i, @lines);
726 if (!$email_git_penguin_chiefs) {
727 @lines = grep(!/${penguin_chiefs}/i, @lines);
728 }
729 # cut -f2- -d":"
730 s/.*:\s*(.+)\s*/$1/ for (@lines);
731
Joe Perches8cbb3a72009-09-21 17:04:21 -0700732 $total_sign_offs = @lines;
733
Joe Perches11ecf532009-09-21 17:04:22 -0700734 if ($email_remove_duplicates) {
735 @lines = mailmap(@lines);
736 }
Joe Perches0e70e832009-09-21 17:04:20 -0700737
Joe Perches0e70e832009-09-21 17:04:20 -0700738 @lines = sort(@lines);
Joe Perchesafa81ee2009-07-29 15:04:28 -0700739
Joe Perches11ecf532009-09-21 17:04:22 -0700740 # uniq -c
741 $hash{$_}++ for @lines;
742
743 # sort -rn
744 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
745 my $sign_offs = $hash{$line};
746 $count++;
747 last if ($sign_offs < $email_git_min_signatures ||
748 $count > $email_git_max_maintainers ||
749 $sign_offs * 100 / $total_sign_offs < $email_git_min_percent);
750 push_email_address($line);
Joe Perchesf5492662009-09-21 17:04:13 -0700751 }
752}
753
754sub save_commits {
755 my ($cmd, @commits) = @_;
756 my $output;
757 my @lines = ();
758
759 $output = `${cmd}`;
760
761 @lines = split("\n", $output);
762 foreach my $line (@lines) {
763 if ($line =~ m/^(\w+) /) {
764 push (@commits, $1);
Joe Perchescb7301c2009-04-07 20:40:12 -0700765 }
766 }
Joe Perchesf5492662009-09-21 17:04:13 -0700767 return @commits;
768}
769
770sub git_assign_blame {
771 my ($file) = @_;
772
773 my @lines = ();
774 my @commits = ();
775 my $cmd;
776 my $output;
777 my %hash;
778 my $total_sign_offs;
779 my $count;
780
781 if (@range) {
782 foreach my $file_range_diff (@range) {
783 next if (!($file_range_diff =~ m/(.+):(.+):(.+)/));
784 my $diff_file = $1;
785 my $diff_start = $2;
786 my $diff_length = $3;
787 next if (!("$file" eq "$diff_file"));
Joe Perches8cbb3a72009-09-21 17:04:21 -0700788 $cmd = "git blame -l -L $diff_start,+$diff_length $file";
Joe Perchesf5492662009-09-21 17:04:13 -0700789 @commits = save_commits($cmd, @commits);
790 }
791 } else {
792 if (-f $file) {
Joe Perches8cbb3a72009-09-21 17:04:21 -0700793 $cmd = "git blame -l $file";
Joe Perchesf5492662009-09-21 17:04:13 -0700794 @commits = save_commits($cmd, @commits);
795 }
796 }
797
798 $total_sign_offs = 0;
799 @commits = uniq(@commits);
800 foreach my $commit (@commits) {
801 $cmd = "git log -1 ${commit}";
Joe Perchesf5492662009-09-21 17:04:13 -0700802
803 $output = `${cmd}`;
804 $output =~ s/^\s*//gm;
805 @lines = split("\n", $output);
Joe Perches0e70e832009-09-21 17:04:20 -0700806
807 @lines = grep(/^[-_ a-z]+by:.*\@.*$/i, @lines);
808 if (!$email_git_penguin_chiefs) {
809 @lines = grep(!/${penguin_chiefs}/i, @lines);
810 }
Joe Perches8cbb3a72009-09-21 17:04:21 -0700811
Joe Perches0e70e832009-09-21 17:04:20 -0700812 # cut -f2- -d":"
813 s/.*:\s*(.+)\s*/$1/ for (@lines);
814
Joe Perchesf5492662009-09-21 17:04:13 -0700815 $total_sign_offs += @lines;
Joe Perches8cbb3a72009-09-21 17:04:21 -0700816
Joe Perches11ecf532009-09-21 17:04:22 -0700817 if ($email_remove_duplicates) {
818 @lines = mailmap(@lines);
819 }
Joe Perches8cbb3a72009-09-21 17:04:21 -0700820
821 $hash{$_}++ for @lines;
Joe Perchesf5492662009-09-21 17:04:13 -0700822 }
823
824 $count = 0;
825 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
826 my $sign_offs = $hash{$line};
827 $count++;
828 last if ($sign_offs < $email_git_min_signatures ||
829 $count > $email_git_max_maintainers ||
830 $sign_offs * 100 / $total_sign_offs < $email_git_min_percent);
831 push_email_address($line);
832 }
Joe Perchescb7301c2009-04-07 20:40:12 -0700833}
834
835sub uniq {
836 my @parms = @_;
837
838 my %saw;
839 @parms = grep(!$saw{$_}++, @parms);
840 return @parms;
841}
842
843sub sort_and_uniq {
844 my @parms = @_;
845
846 my %saw;
847 @parms = sort @parms;
848 @parms = grep(!$saw{$_}++, @parms);
849 return @parms;
850}
851
852sub output {
853 my @parms = @_;
854
855 if ($output_multiline) {
856 foreach my $line (@parms) {
857 print("${line}\n");
858 }
859 } else {
860 print(join($output_separator, @parms));
861 print("\n");
862 }
863}
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700864
865my $rfc822re;
866
867sub make_rfc822re {
868# Basic lexical tokens are specials, domain_literal, quoted_string, atom, and
869# comment. We must allow for rfc822_lwsp (or comments) after each of these.
870# This regexp will only work on addresses which have had comments stripped
871# and replaced with rfc822_lwsp.
872
873 my $specials = '()<>@,;:\\\\".\\[\\]';
874 my $controls = '\\000-\\037\\177';
875
876 my $dtext = "[^\\[\\]\\r\\\\]";
877 my $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$rfc822_lwsp*";
878
879 my $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$rfc822_lwsp)*\"$rfc822_lwsp*";
880
881# Use zero-width assertion to spot the limit of an atom. A simple
882# $rfc822_lwsp* causes the regexp engine to hang occasionally.
883 my $atom = "[^$specials $controls]+(?:$rfc822_lwsp+|\\Z|(?=[\\[\"$specials]))";
884 my $word = "(?:$atom|$quoted_string)";
885 my $localpart = "$word(?:\\.$rfc822_lwsp*$word)*";
886
887 my $sub_domain = "(?:$atom|$domain_literal)";
888 my $domain = "$sub_domain(?:\\.$rfc822_lwsp*$sub_domain)*";
889
890 my $addr_spec = "$localpart\@$rfc822_lwsp*$domain";
891
892 my $phrase = "$word*";
893 my $route = "(?:\@$domain(?:,\@$rfc822_lwsp*$domain)*:$rfc822_lwsp*)";
894 my $route_addr = "\\<$rfc822_lwsp*$route?$addr_spec\\>$rfc822_lwsp*";
895 my $mailbox = "(?:$addr_spec|$phrase$route_addr)";
896
897 my $group = "$phrase:$rfc822_lwsp*(?:$mailbox(?:,\\s*$mailbox)*)?;\\s*";
898 my $address = "(?:$mailbox|$group)";
899
900 return "$rfc822_lwsp*$address";
901}
902
903sub rfc822_strip_comments {
904 my $s = shift;
905# Recursively remove comments, and replace with a single space. The simpler
906# regexps in the Email Addressing FAQ are imperfect - they will miss escaped
907# chars in atoms, for example.
908
909 while ($s =~ s/^((?:[^"\\]|\\.)*
910 (?:"(?:[^"\\]|\\.)*"(?:[^"\\]|\\.)*)*)
911 \((?:[^()\\]|\\.)*\)/$1 /osx) {}
912 return $s;
913}
914
915# valid: returns true if the parameter is an RFC822 valid address
916#
917sub rfc822_valid ($) {
918 my $s = rfc822_strip_comments(shift);
919
920 if (!$rfc822re) {
921 $rfc822re = make_rfc822re();
922 }
923
924 return $s =~ m/^$rfc822re$/so && $s =~ m/^$rfc822_char*$/;
925}
926
927# validlist: In scalar context, returns true if the parameter is an RFC822
928# valid list of addresses.
929#
930# In list context, returns an empty list on failure (an invalid
931# address was found); otherwise a list whose first element is the
932# number of addresses found and whose remaining elements are the
933# addresses. This is needed to disambiguate failure (invalid)
934# from success with no addresses found, because an empty string is
935# a valid list.
936
937sub rfc822_validlist ($) {
938 my $s = rfc822_strip_comments(shift);
939
940 if (!$rfc822re) {
941 $rfc822re = make_rfc822re();
942 }
943 # * null list items are valid according to the RFC
944 # * the '1' business is to aid in distinguishing failure from no results
945
946 my @r;
947 if ($s =~ m/^(?:$rfc822re)?(?:,(?:$rfc822re)?)*$/so &&
948 $s =~ m/^$rfc822_char*$/) {
Joe Perches5f2441e2009-06-16 15:34:02 -0700949 while ($s =~ m/(?:^|,$rfc822_lwsp*)($rfc822re)/gos) {
Joe Perches1b5e1cf2009-06-16 15:34:01 -0700950 push @r, $1;
951 }
952 return wantarray ? (scalar(@r), @r) : 1;
953 }
954 else {
955 return wantarray ? () : 0;
956 }
957}