Loading...
1#!/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#
8# usage: perl scripts/get_maintainer.pl [OPTIONS] <patch>
9# perl scripts/get_maintainer.pl [OPTIONS] -f <file>
10#
11# Licensed under the terms of the GNU GPL License version 2
12
13use strict;
14
15my $P = $0;
16my $V = '0.26';
17
18use Getopt::Long qw(:config no_auto_abbrev);
19use Cwd;
20
21my $cur_path = fastgetcwd() . '/';
22my $lk_path = "./";
23my $email = 1;
24my $email_usename = 1;
25my $email_maintainer = 1;
26my $email_reviewer = 1;
27my $email_list = 1;
28my $email_subscriber_list = 0;
29my $email_git_penguin_chiefs = 0;
30my $email_git = 0;
31my $email_git_all_signature_types = 0;
32my $email_git_blame = 0;
33my $email_git_blame_signatures = 1;
34my $email_git_fallback = 1;
35my $email_git_min_signatures = 1;
36my $email_git_max_maintainers = 5;
37my $email_git_min_percent = 5;
38my $email_git_since = "1-year-ago";
39my $email_hg_since = "-365";
40my $interactive = 0;
41my $email_remove_duplicates = 1;
42my $email_use_mailmap = 1;
43my $output_multiline = 1;
44my $output_separator = ", ";
45my $output_roles = 0;
46my $output_rolestats = 1;
47my $output_section_maxlen = 50;
48my $scm = 0;
49my $web = 0;
50my $subsystem = 0;
51my $status = 0;
52my $letters = "";
53my $keywords = 1;
54my $sections = 0;
55my $file_emails = 0;
56my $from_filename = 0;
57my $pattern_depth = 0;
58my $version = 0;
59my $help = 0;
60
61my $vcs_used = 0;
62
63my $exit = 0;
64
65my %commit_author_hash;
66my %commit_signer_hash;
67
68my @penguin_chief = ();
69push(@penguin_chief, "Linus Torvalds:torvalds\@linux-foundation.org");
70#Andrew wants in on most everything - 2009/01/14
71#push(@penguin_chief, "Andrew Morton:akpm\@linux-foundation.org");
72
73my @penguin_chief_names = ();
74foreach my $chief (@penguin_chief) {
75 if ($chief =~ m/^(.*):(.*)/) {
76 my $chief_name = $1;
77 my $chief_addr = $2;
78 push(@penguin_chief_names, $chief_name);
79 }
80}
81my $penguin_chiefs = "\(" . join("|", @penguin_chief_names) . "\)";
82
83# Signature types of people who are either
84# a) responsible for the code in question, or
85# b) familiar enough with it to give relevant feedback
86my @signature_tags = ();
87push(@signature_tags, "Signed-off-by:");
88push(@signature_tags, "Reviewed-by:");
89push(@signature_tags, "Acked-by:");
90
91my $signature_pattern = "\(" . join("|", @signature_tags) . "\)";
92
93# rfc822 email address - preloaded methods go here.
94my $rfc822_lwsp = "(?:(?:\\r\\n)?[ \\t])";
95my $rfc822_char = '[\\000-\\377]';
96
97# VCS command support: class-like functions and strings
98
99my %VCS_cmds;
100
101my %VCS_cmds_git = (
102 "execute_cmd" => \&git_execute_cmd,
103 "available" => '(which("git") ne "") && (-e ".git")',
104 "find_signers_cmd" =>
105 "git log --no-color --follow --since=\$email_git_since " .
106 '--numstat --no-merges ' .
107 '--format="GitCommit: %H%n' .
108 'GitAuthor: %an <%ae>%n' .
109 'GitDate: %aD%n' .
110 'GitSubject: %s%n' .
111 '%b%n"' .
112 " -- \$file",
113 "find_commit_signers_cmd" =>
114 "git log --no-color " .
115 '--numstat ' .
116 '--format="GitCommit: %H%n' .
117 'GitAuthor: %an <%ae>%n' .
118 'GitDate: %aD%n' .
119 'GitSubject: %s%n' .
120 '%b%n"' .
121 " -1 \$commit",
122 "find_commit_author_cmd" =>
123 "git log --no-color " .
124 '--numstat ' .
125 '--format="GitCommit: %H%n' .
126 'GitAuthor: %an <%ae>%n' .
127 'GitDate: %aD%n' .
128 'GitSubject: %s%n"' .
129 " -1 \$commit",
130 "blame_range_cmd" => "git blame -l -L \$diff_start,+\$diff_length \$file",
131 "blame_file_cmd" => "git blame -l \$file",
132 "commit_pattern" => "^GitCommit: ([0-9a-f]{40,40})",
133 "blame_commit_pattern" => "^([0-9a-f]+) ",
134 "author_pattern" => "^GitAuthor: (.*)",
135 "subject_pattern" => "^GitSubject: (.*)",
136 "stat_pattern" => "^(\\d+)\\t(\\d+)\\t\$file\$",
137 "file_exists_cmd" => "git ls-files \$file",
138);
139
140my %VCS_cmds_hg = (
141 "execute_cmd" => \&hg_execute_cmd,
142 "available" => '(which("hg") ne "") && (-d ".hg")',
143 "find_signers_cmd" =>
144 "hg log --date=\$email_hg_since " .
145 "--template='HgCommit: {node}\\n" .
146 "HgAuthor: {author}\\n" .
147 "HgSubject: {desc}\\n'" .
148 " -- \$file",
149 "find_commit_signers_cmd" =>
150 "hg log " .
151 "--template='HgSubject: {desc}\\n'" .
152 " -r \$commit",
153 "find_commit_author_cmd" =>
154 "hg log " .
155 "--template='HgCommit: {node}\\n" .
156 "HgAuthor: {author}\\n" .
157 "HgSubject: {desc|firstline}\\n'" .
158 " -r \$commit",
159 "blame_range_cmd" => "", # not supported
160 "blame_file_cmd" => "hg blame -n \$file",
161 "commit_pattern" => "^HgCommit: ([0-9a-f]{40,40})",
162 "blame_commit_pattern" => "^([ 0-9a-f]+):",
163 "author_pattern" => "^HgAuthor: (.*)",
164 "subject_pattern" => "^HgSubject: (.*)",
165 "stat_pattern" => "^(\\d+)\t(\\d+)\t\$file\$",
166 "file_exists_cmd" => "hg files \$file",
167);
168
169my $conf = which_conf(".get_maintainer.conf");
170if (-f $conf) {
171 my @conf_args;
172 open(my $conffile, '<', "$conf")
173 or warn "$P: Can't find a readable .get_maintainer.conf file $!\n";
174
175 while (<$conffile>) {
176 my $line = $_;
177
178 $line =~ s/\s*\n?$//g;
179 $line =~ s/^\s*//g;
180 $line =~ s/\s+/ /g;
181
182 next if ($line =~ m/^\s*#/);
183 next if ($line =~ m/^\s*$/);
184
185 my @words = split(" ", $line);
186 foreach my $word (@words) {
187 last if ($word =~ m/^#/);
188 push (@conf_args, $word);
189 }
190 }
191 close($conffile);
192 unshift(@ARGV, @conf_args) if @conf_args;
193}
194
195my @ignore_emails = ();
196my $ignore_file = which_conf(".get_maintainer.ignore");
197if (-f $ignore_file) {
198 open(my $ignore, '<', "$ignore_file")
199 or warn "$P: Can't find a readable .get_maintainer.ignore file $!\n";
200 while (<$ignore>) {
201 my $line = $_;
202
203 $line =~ s/\s*\n?$//;
204 $line =~ s/^\s*//;
205 $line =~ s/\s+$//;
206 $line =~ s/#.*$//;
207
208 next if ($line =~ m/^\s*$/);
209 if (rfc822_valid($line)) {
210 push(@ignore_emails, $line);
211 }
212 }
213 close($ignore);
214}
215
216if (!GetOptions(
217 'email!' => \$email,
218 'git!' => \$email_git,
219 'git-all-signature-types!' => \$email_git_all_signature_types,
220 'git-blame!' => \$email_git_blame,
221 'git-blame-signatures!' => \$email_git_blame_signatures,
222 'git-fallback!' => \$email_git_fallback,
223 'git-chief-penguins!' => \$email_git_penguin_chiefs,
224 'git-min-signatures=i' => \$email_git_min_signatures,
225 'git-max-maintainers=i' => \$email_git_max_maintainers,
226 'git-min-percent=i' => \$email_git_min_percent,
227 'git-since=s' => \$email_git_since,
228 'hg-since=s' => \$email_hg_since,
229 'i|interactive!' => \$interactive,
230 'remove-duplicates!' => \$email_remove_duplicates,
231 'mailmap!' => \$email_use_mailmap,
232 'm!' => \$email_maintainer,
233 'r!' => \$email_reviewer,
234 'n!' => \$email_usename,
235 'l!' => \$email_list,
236 's!' => \$email_subscriber_list,
237 'multiline!' => \$output_multiline,
238 'roles!' => \$output_roles,
239 'rolestats!' => \$output_rolestats,
240 'separator=s' => \$output_separator,
241 'subsystem!' => \$subsystem,
242 'status!' => \$status,
243 'scm!' => \$scm,
244 'web!' => \$web,
245 'letters=s' => \$letters,
246 'pattern-depth=i' => \$pattern_depth,
247 'k|keywords!' => \$keywords,
248 'sections!' => \$sections,
249 'fe|file-emails!' => \$file_emails,
250 'f|file' => \$from_filename,
251 'v|version' => \$version,
252 'h|help|usage' => \$help,
253 )) {
254 die "$P: invalid argument - use --help if necessary\n";
255}
256
257if ($help != 0) {
258 usage();
259 exit 0;
260}
261
262if ($version != 0) {
263 print("${P} ${V}\n");
264 exit 0;
265}
266
267if (-t STDIN && !@ARGV) {
268 # We're talking to a terminal, but have no command line arguments.
269 die "$P: missing patchfile or -f file - use --help if necessary\n";
270}
271
272$output_multiline = 0 if ($output_separator ne ", ");
273$output_rolestats = 1 if ($interactive);
274$output_roles = 1 if ($output_rolestats);
275
276if ($sections || $letters ne "") {
277 $sections = 1;
278 $email = 0;
279 $email_list = 0;
280 $scm = 0;
281 $status = 0;
282 $subsystem = 0;
283 $web = 0;
284 $keywords = 0;
285 $interactive = 0;
286} else {
287 my $selections = $email + $scm + $status + $subsystem + $web;
288 if ($selections == 0) {
289 die "$P: Missing required option: email, scm, status, subsystem or web\n";
290 }
291}
292
293if ($email &&
294 ($email_maintainer + $email_reviewer +
295 $email_list + $email_subscriber_list +
296 $email_git + $email_git_penguin_chiefs + $email_git_blame) == 0) {
297 die "$P: Please select at least 1 email option\n";
298}
299
300if (!top_of_kernel_tree($lk_path)) {
301 die "$P: The current directory does not appear to be "
302 . "a linux kernel source tree.\n";
303}
304
305## Read MAINTAINERS for type/value pairs
306
307my @typevalue = ();
308my %keyword_hash;
309
310open (my $maint, '<', "${lk_path}MAINTAINERS")
311 or die "$P: Can't open MAINTAINERS: $!\n";
312while (<$maint>) {
313 my $line = $_;
314
315 if ($line =~ m/^([A-Z]):\s*(.*)/) {
316 my $type = $1;
317 my $value = $2;
318
319 ##Filename pattern matching
320 if ($type eq "F" || $type eq "X") {
321 $value =~ s@\.@\\\.@g; ##Convert . to \.
322 $value =~ s/\*/\.\*/g; ##Convert * to .*
323 $value =~ s/\?/\./g; ##Convert ? to .
324 ##if pattern is a directory and it lacks a trailing slash, add one
325 if ((-d $value)) {
326 $value =~ s@([^/])$@$1/@;
327 }
328 } elsif ($type eq "K") {
329 $keyword_hash{@typevalue} = $value;
330 }
331 push(@typevalue, "$type:$value");
332 } elsif (!/^(\s)*$/) {
333 $line =~ s/\n$//g;
334 push(@typevalue, $line);
335 }
336}
337close($maint);
338
339
340#
341# Read mail address map
342#
343
344my $mailmap;
345
346read_mailmap();
347
348sub read_mailmap {
349 $mailmap = {
350 names => {},
351 addresses => {}
352 };
353
354 return if (!$email_use_mailmap || !(-f "${lk_path}.mailmap"));
355
356 open(my $mailmap_file, '<', "${lk_path}.mailmap")
357 or warn "$P: Can't open .mailmap: $!\n";
358
359 while (<$mailmap_file>) {
360 s/#.*$//; #strip comments
361 s/^\s+|\s+$//g; #trim
362
363 next if (/^\s*$/); #skip empty lines
364 #entries have one of the following formats:
365 # name1 <mail1>
366 # <mail1> <mail2>
367 # name1 <mail1> <mail2>
368 # name1 <mail1> name2 <mail2>
369 # (see man git-shortlog)
370
371 if (/^([^<]+)<([^>]+)>$/) {
372 my $real_name = $1;
373 my $address = $2;
374
375 $real_name =~ s/\s+$//;
376 ($real_name, $address) = parse_email("$real_name <$address>");
377 $mailmap->{names}->{$address} = $real_name;
378
379 } elsif (/^<([^>]+)>\s*<([^>]+)>$/) {
380 my $real_address = $1;
381 my $wrong_address = $2;
382
383 $mailmap->{addresses}->{$wrong_address} = $real_address;
384
385 } elsif (/^(.+)<([^>]+)>\s*<([^>]+)>$/) {
386 my $real_name = $1;
387 my $real_address = $2;
388 my $wrong_address = $3;
389
390 $real_name =~ s/\s+$//;
391 ($real_name, $real_address) =
392 parse_email("$real_name <$real_address>");
393 $mailmap->{names}->{$wrong_address} = $real_name;
394 $mailmap->{addresses}->{$wrong_address} = $real_address;
395
396 } elsif (/^(.+)<([^>]+)>\s*(.+)\s*<([^>]+)>$/) {
397 my $real_name = $1;
398 my $real_address = $2;
399 my $wrong_name = $3;
400 my $wrong_address = $4;
401
402 $real_name =~ s/\s+$//;
403 ($real_name, $real_address) =
404 parse_email("$real_name <$real_address>");
405
406 $wrong_name =~ s/\s+$//;
407 ($wrong_name, $wrong_address) =
408 parse_email("$wrong_name <$wrong_address>");
409
410 my $wrong_email = format_email($wrong_name, $wrong_address, 1);
411 $mailmap->{names}->{$wrong_email} = $real_name;
412 $mailmap->{addresses}->{$wrong_email} = $real_address;
413 }
414 }
415 close($mailmap_file);
416}
417
418## use the filenames on the command line or find the filenames in the patchfiles
419
420my @files = ();
421my @range = ();
422my @keyword_tvi = ();
423my @file_emails = ();
424
425if (!@ARGV) {
426 push(@ARGV, "&STDIN");
427}
428
429foreach my $file (@ARGV) {
430 if ($file ne "&STDIN") {
431 ##if $file is a directory and it lacks a trailing slash, add one
432 if ((-d $file)) {
433 $file =~ s@([^/])$@$1/@;
434 } elsif (!(-f $file)) {
435 die "$P: file '${file}' not found\n";
436 }
437 }
438 if ($from_filename || ($file ne "&STDIN" && vcs_file_exists($file))) {
439 $file =~ s/^\Q${cur_path}\E//; #strip any absolute path
440 $file =~ s/^\Q${lk_path}\E//; #or the path to the lk tree
441 push(@files, $file);
442 if ($file ne "MAINTAINERS" && -f $file && ($keywords || $file_emails)) {
443 open(my $f, '<', $file)
444 or die "$P: Can't open $file: $!\n";
445 my $text = do { local($/) ; <$f> };
446 close($f);
447 if ($keywords) {
448 foreach my $line (keys %keyword_hash) {
449 if ($text =~ m/$keyword_hash{$line}/x) {
450 push(@keyword_tvi, $line);
451 }
452 }
453 }
454 if ($file_emails) {
455 my @poss_addr = $text =~ m$[A-Za-zÀ-ÿ\"\' \,\.\+-]*\s*[\,]*\s*[\(\<\{]{0,1}[A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+\.[A-Za-z0-9]+[\)\>\}]{0,1}$g;
456 push(@file_emails, clean_file_emails(@poss_addr));
457 }
458 }
459 } else {
460 my $file_cnt = @files;
461 my $lastfile;
462
463 open(my $patch, "< $file")
464 or die "$P: Can't open $file: $!\n";
465
466 # We can check arbitrary information before the patch
467 # like the commit message, mail headers, etc...
468 # This allows us to match arbitrary keywords against any part
469 # of a git format-patch generated file (subject tags, etc...)
470
471 my $patch_prefix = ""; #Parsing the intro
472
473 while (<$patch>) {
474 my $patch_line = $_;
475 if (m/^\+\+\+\s+(\S+)/ or m/^---\s+(\S+)/) {
476 my $filename = $1;
477 $filename =~ s@^[^/]*/@@;
478 $filename =~ s@\n@@;
479 $lastfile = $filename;
480 push(@files, $filename);
481 $patch_prefix = "^[+-].*"; #Now parsing the actual patch
482 } elsif (m/^\@\@ -(\d+),(\d+)/) {
483 if ($email_git_blame) {
484 push(@range, "$lastfile:$1:$2");
485 }
486 } elsif ($keywords) {
487 foreach my $line (keys %keyword_hash) {
488 if ($patch_line =~ m/${patch_prefix}$keyword_hash{$line}/x) {
489 push(@keyword_tvi, $line);
490 }
491 }
492 }
493 }
494 close($patch);
495
496 if ($file_cnt == @files) {
497 warn "$P: file '${file}' doesn't appear to be a patch. "
498 . "Add -f to options?\n";
499 }
500 @files = sort_and_uniq(@files);
501 }
502}
503
504@file_emails = uniq(@file_emails);
505
506my %email_hash_name;
507my %email_hash_address;
508my @email_to = ();
509my %hash_list_to;
510my @list_to = ();
511my @scm = ();
512my @web = ();
513my @subsystem = ();
514my @status = ();
515my %deduplicate_name_hash = ();
516my %deduplicate_address_hash = ();
517
518my @maintainers = get_maintainers();
519
520if (@maintainers) {
521 @maintainers = merge_email(@maintainers);
522 output(@maintainers);
523}
524
525if ($scm) {
526 @scm = uniq(@scm);
527 output(@scm);
528}
529
530if ($status) {
531 @status = uniq(@status);
532 output(@status);
533}
534
535if ($subsystem) {
536 @subsystem = uniq(@subsystem);
537 output(@subsystem);
538}
539
540if ($web) {
541 @web = uniq(@web);
542 output(@web);
543}
544
545exit($exit);
546
547sub ignore_email_address {
548 my ($address) = @_;
549
550 foreach my $ignore (@ignore_emails) {
551 return 1 if ($ignore eq $address);
552 }
553
554 return 0;
555}
556
557sub range_is_maintained {
558 my ($start, $end) = @_;
559
560 for (my $i = $start; $i < $end; $i++) {
561 my $line = $typevalue[$i];
562 if ($line =~ m/^([A-Z]):\s*(.*)/) {
563 my $type = $1;
564 my $value = $2;
565 if ($type eq 'S') {
566 if ($value =~ /(maintain|support)/i) {
567 return 1;
568 }
569 }
570 }
571 }
572 return 0;
573}
574
575sub range_has_maintainer {
576 my ($start, $end) = @_;
577
578 for (my $i = $start; $i < $end; $i++) {
579 my $line = $typevalue[$i];
580 if ($line =~ m/^([A-Z]):\s*(.*)/) {
581 my $type = $1;
582 my $value = $2;
583 if ($type eq 'M') {
584 return 1;
585 }
586 }
587 }
588 return 0;
589}
590
591sub get_maintainers {
592 %email_hash_name = ();
593 %email_hash_address = ();
594 %commit_author_hash = ();
595 %commit_signer_hash = ();
596 @email_to = ();
597 %hash_list_to = ();
598 @list_to = ();
599 @scm = ();
600 @web = ();
601 @subsystem = ();
602 @status = ();
603 %deduplicate_name_hash = ();
604 %deduplicate_address_hash = ();
605 if ($email_git_all_signature_types) {
606 $signature_pattern = "(.+?)[Bb][Yy]:";
607 } else {
608 $signature_pattern = "\(" . join("|", @signature_tags) . "\)";
609 }
610
611 # Find responsible parties
612
613 my %exact_pattern_match_hash = ();
614
615 foreach my $file (@files) {
616
617 my %hash;
618 my $tvi = find_first_section();
619 while ($tvi < @typevalue) {
620 my $start = find_starting_index($tvi);
621 my $end = find_ending_index($tvi);
622 my $exclude = 0;
623 my $i;
624
625 #Do not match excluded file patterns
626
627 for ($i = $start; $i < $end; $i++) {
628 my $line = $typevalue[$i];
629 if ($line =~ m/^([A-Z]):\s*(.*)/) {
630 my $type = $1;
631 my $value = $2;
632 if ($type eq 'X') {
633 if (file_match_pattern($file, $value)) {
634 $exclude = 1;
635 last;
636 }
637 }
638 }
639 }
640
641 if (!$exclude) {
642 for ($i = $start; $i < $end; $i++) {
643 my $line = $typevalue[$i];
644 if ($line =~ m/^([A-Z]):\s*(.*)/) {
645 my $type = $1;
646 my $value = $2;
647 if ($type eq 'F') {
648 if (file_match_pattern($file, $value)) {
649 my $value_pd = ($value =~ tr@/@@);
650 my $file_pd = ($file =~ tr@/@@);
651 $value_pd++ if (substr($value,-1,1) ne "/");
652 $value_pd = -1 if ($value =~ /^\.\*/);
653 if ($value_pd >= $file_pd &&
654 range_is_maintained($start, $end) &&
655 range_has_maintainer($start, $end)) {
656 $exact_pattern_match_hash{$file} = 1;
657 }
658 if ($pattern_depth == 0 ||
659 (($file_pd - $value_pd) < $pattern_depth)) {
660 $hash{$tvi} = $value_pd;
661 }
662 }
663 } elsif ($type eq 'N') {
664 if ($file =~ m/$value/x) {
665 $hash{$tvi} = 0;
666 }
667 }
668 }
669 }
670 }
671 $tvi = $end + 1;
672 }
673
674 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
675 add_categories($line);
676 if ($sections) {
677 my $i;
678 my $start = find_starting_index($line);
679 my $end = find_ending_index($line);
680 for ($i = $start; $i < $end; $i++) {
681 my $line = $typevalue[$i];
682 if ($line =~ /^[FX]:/) { ##Restore file patterns
683 $line =~ s/([^\\])\.([^\*])/$1\?$2/g;
684 $line =~ s/([^\\])\.$/$1\?/g; ##Convert . back to ?
685 $line =~ s/\\\./\./g; ##Convert \. to .
686 $line =~ s/\.\*/\*/g; ##Convert .* to *
687 }
688 my $count = $line =~ s/^([A-Z]):/$1:\t/g;
689 if ($letters eq "" || (!$count || $letters =~ /$1/i)) {
690 print("$line\n");
691 }
692 }
693 print("\n");
694 }
695 }
696 }
697
698 if ($keywords) {
699 @keyword_tvi = sort_and_uniq(@keyword_tvi);
700 foreach my $line (@keyword_tvi) {
701 add_categories($line);
702 }
703 }
704
705 foreach my $email (@email_to, @list_to) {
706 $email->[0] = deduplicate_email($email->[0]);
707 }
708
709 foreach my $file (@files) {
710 if ($email &&
711 ($email_git || ($email_git_fallback &&
712 !$exact_pattern_match_hash{$file}))) {
713 vcs_file_signoffs($file);
714 }
715 if ($email && $email_git_blame) {
716 vcs_file_blame($file);
717 }
718 }
719
720 if ($email) {
721 foreach my $chief (@penguin_chief) {
722 if ($chief =~ m/^(.*):(.*)/) {
723 my $email_address;
724
725 $email_address = format_email($1, $2, $email_usename);
726 if ($email_git_penguin_chiefs) {
727 push(@email_to, [$email_address, 'chief penguin']);
728 } else {
729 @email_to = grep($_->[0] !~ /${email_address}/, @email_to);
730 }
731 }
732 }
733
734 foreach my $email (@file_emails) {
735 my ($name, $address) = parse_email($email);
736
737 my $tmp_email = format_email($name, $address, $email_usename);
738 push_email_address($tmp_email, '');
739 add_role($tmp_email, 'in file');
740 }
741 }
742
743 my @to = ();
744 if ($email || $email_list) {
745 if ($email) {
746 @to = (@to, @email_to);
747 }
748 if ($email_list) {
749 @to = (@to, @list_to);
750 }
751 }
752
753 if ($interactive) {
754 @to = interactive_get_maintainers(\@to);
755 }
756
757 return @to;
758}
759
760sub file_match_pattern {
761 my ($file, $pattern) = @_;
762 if (substr($pattern, -1) eq "/") {
763 if ($file =~ m@^$pattern@) {
764 return 1;
765 }
766 } else {
767 if ($file =~ m@^$pattern@) {
768 my $s1 = ($file =~ tr@/@@);
769 my $s2 = ($pattern =~ tr@/@@);
770 if ($s1 == $s2) {
771 return 1;
772 }
773 }
774 }
775 return 0;
776}
777
778sub usage {
779 print <<EOT;
780usage: $P [options] patchfile
781 $P [options] -f file|directory
782version: $V
783
784MAINTAINER field selection options:
785 --email => print email address(es) if any
786 --git => include recent git \*-by: signers
787 --git-all-signature-types => include signers regardless of signature type
788 or use only ${signature_pattern} signers (default: $email_git_all_signature_types)
789 --git-fallback => use git when no exact MAINTAINERS pattern (default: $email_git_fallback)
790 --git-chief-penguins => include ${penguin_chiefs}
791 --git-min-signatures => number of signatures required (default: $email_git_min_signatures)
792 --git-max-maintainers => maximum maintainers to add (default: $email_git_max_maintainers)
793 --git-min-percent => minimum percentage of commits required (default: $email_git_min_percent)
794 --git-blame => use git blame to find modified commits for patch or file
795 --git-blame-signatures => when used with --git-blame, also include all commit signers
796 --git-since => git history to use (default: $email_git_since)
797 --hg-since => hg history to use (default: $email_hg_since)
798 --interactive => display a menu (mostly useful if used with the --git option)
799 --m => include maintainer(s) if any
800 --r => include reviewer(s) if any
801 --n => include name 'Full Name <addr\@domain.tld>'
802 --l => include list(s) if any
803 --s => include subscriber only list(s) if any
804 --remove-duplicates => minimize duplicate email names/addresses
805 --roles => show roles (status:subsystem, git-signer, list, etc...)
806 --rolestats => show roles and statistics (commits/total_commits, %)
807 --file-emails => add email addresses found in -f file (default: 0 (off))
808 --scm => print SCM tree(s) if any
809 --status => print status if any
810 --subsystem => print subsystem name if any
811 --web => print website(s) if any
812
813Output type options:
814 --separator [, ] => separator for multiple entries on 1 line
815 using --separator also sets --nomultiline if --separator is not [, ]
816 --multiline => print 1 entry per line
817
818Other options:
819 --pattern-depth => Number of pattern directory traversals (default: 0 (all))
820 --keywords => scan patch for keywords (default: $keywords)
821 --sections => print all of the subsystem sections with pattern matches
822 --letters => print all matching 'letter' types from all matching sections
823 --mailmap => use .mailmap file (default: $email_use_mailmap)
824 --version => show version
825 --help => show this help information
826
827Default options:
828 [--email --nogit --git-fallback --m --r --n --l --multiline --pattern-depth=0
829 --remove-duplicates --rolestats]
830
831Notes:
832 Using "-f directory" may give unexpected results:
833 Used with "--git", git signators for _all_ files in and below
834 directory are examined as git recurses directories.
835 Any specified X: (exclude) pattern matches are _not_ ignored.
836 Used with "--nogit", directory is used as a pattern match,
837 no individual file within the directory or subdirectory
838 is matched.
839 Used with "--git-blame", does not iterate all files in directory
840 Using "--git-blame" is slow and may add old committers and authors
841 that are no longer active maintainers to the output.
842 Using "--roles" or "--rolestats" with git send-email --cc-cmd or any
843 other automated tools that expect only ["name"] <email address>
844 may not work because of additional output after <email address>.
845 Using "--rolestats" and "--git-blame" shows the #/total=% commits,
846 not the percentage of the entire file authored. # of commits is
847 not a good measure of amount of code authored. 1 major commit may
848 contain a thousand lines, 5 trivial commits may modify a single line.
849 If git is not installed, but mercurial (hg) is installed and an .hg
850 repository exists, the following options apply to mercurial:
851 --git,
852 --git-min-signatures, --git-max-maintainers, --git-min-percent, and
853 --git-blame
854 Use --hg-since not --git-since to control date selection
855 File ".get_maintainer.conf", if it exists in the linux kernel source root
856 directory, can change whatever get_maintainer defaults are desired.
857 Entries in this file can be any command line argument.
858 This file is prepended to any additional command line arguments.
859 Multiple lines and # comments are allowed.
860 Most options have both positive and negative forms.
861 The negative forms for --<foo> are --no<foo> and --no-<foo>.
862
863EOT
864}
865
866sub top_of_kernel_tree {
867 my ($lk_path) = @_;
868
869 if ($lk_path ne "" && substr($lk_path,length($lk_path)-1,1) ne "/") {
870 $lk_path .= "/";
871 }
872 if ( (-f "${lk_path}COPYING")
873 && (-f "${lk_path}CREDITS")
874 && (-f "${lk_path}Kbuild")
875 && (-f "${lk_path}MAINTAINERS")
876 && (-f "${lk_path}Makefile")
877 && (-f "${lk_path}README")
878 && (-d "${lk_path}Documentation")
879 && (-d "${lk_path}arch")
880 && (-d "${lk_path}include")
881 && (-d "${lk_path}drivers")
882 && (-d "${lk_path}fs")
883 && (-d "${lk_path}init")
884 && (-d "${lk_path}ipc")
885 && (-d "${lk_path}kernel")
886 && (-d "${lk_path}lib")
887 && (-d "${lk_path}scripts")) {
888 return 1;
889 }
890 return 0;
891}
892
893sub parse_email {
894 my ($formatted_email) = @_;
895
896 my $name = "";
897 my $address = "";
898
899 if ($formatted_email =~ /^([^<]+)<(.+\@.*)>.*$/) {
900 $name = $1;
901 $address = $2;
902 } elsif ($formatted_email =~ /^\s*<(.+\@\S*)>.*$/) {
903 $address = $1;
904 } elsif ($formatted_email =~ /^(.+\@\S*).*$/) {
905 $address = $1;
906 }
907
908 $name =~ s/^\s+|\s+$//g;
909 $name =~ s/^\"|\"$//g;
910 $address =~ s/^\s+|\s+$//g;
911
912 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
913 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
914 $name = "\"$name\"";
915 }
916
917 return ($name, $address);
918}
919
920sub format_email {
921 my ($name, $address, $usename) = @_;
922
923 my $formatted_email;
924
925 $name =~ s/^\s+|\s+$//g;
926 $name =~ s/^\"|\"$//g;
927 $address =~ s/^\s+|\s+$//g;
928
929 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
930 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
931 $name = "\"$name\"";
932 }
933
934 if ($usename) {
935 if ("$name" eq "") {
936 $formatted_email = "$address";
937 } else {
938 $formatted_email = "$name <$address>";
939 }
940 } else {
941 $formatted_email = $address;
942 }
943
944 return $formatted_email;
945}
946
947sub find_first_section {
948 my $index = 0;
949
950 while ($index < @typevalue) {
951 my $tv = $typevalue[$index];
952 if (($tv =~ m/^([A-Z]):\s*(.*)/)) {
953 last;
954 }
955 $index++;
956 }
957
958 return $index;
959}
960
961sub find_starting_index {
962 my ($index) = @_;
963
964 while ($index > 0) {
965 my $tv = $typevalue[$index];
966 if (!($tv =~ m/^([A-Z]):\s*(.*)/)) {
967 last;
968 }
969 $index--;
970 }
971
972 return $index;
973}
974
975sub find_ending_index {
976 my ($index) = @_;
977
978 while ($index < @typevalue) {
979 my $tv = $typevalue[$index];
980 if (!($tv =~ m/^([A-Z]):\s*(.*)/)) {
981 last;
982 }
983 $index++;
984 }
985
986 return $index;
987}
988
989sub get_subsystem_name {
990 my ($index) = @_;
991
992 my $start = find_starting_index($index);
993
994 my $subsystem = $typevalue[$start];
995 if ($output_section_maxlen && length($subsystem) > $output_section_maxlen) {
996 $subsystem = substr($subsystem, 0, $output_section_maxlen - 3);
997 $subsystem =~ s/\s*$//;
998 $subsystem = $subsystem . "...";
999 }
1000 return $subsystem;
1001}
1002
1003sub get_maintainer_role {
1004 my ($index) = @_;
1005
1006 my $i;
1007 my $start = find_starting_index($index);
1008 my $end = find_ending_index($index);
1009
1010 my $role = "unknown";
1011 my $subsystem = get_subsystem_name($index);
1012
1013 for ($i = $start + 1; $i < $end; $i++) {
1014 my $tv = $typevalue[$i];
1015 if ($tv =~ m/^([A-Z]):\s*(.*)/) {
1016 my $ptype = $1;
1017 my $pvalue = $2;
1018 if ($ptype eq "S") {
1019 $role = $pvalue;
1020 }
1021 }
1022 }
1023
1024 $role = lc($role);
1025 if ($role eq "supported") {
1026 $role = "supporter";
1027 } elsif ($role eq "maintained") {
1028 $role = "maintainer";
1029 } elsif ($role eq "odd fixes") {
1030 $role = "odd fixer";
1031 } elsif ($role eq "orphan") {
1032 $role = "orphan minder";
1033 } elsif ($role eq "obsolete") {
1034 $role = "obsolete minder";
1035 } elsif ($role eq "buried alive in reporters") {
1036 $role = "chief penguin";
1037 }
1038
1039 return $role . ":" . $subsystem;
1040}
1041
1042sub get_list_role {
1043 my ($index) = @_;
1044
1045 my $subsystem = get_subsystem_name($index);
1046
1047 if ($subsystem eq "THE REST") {
1048 $subsystem = "";
1049 }
1050
1051 return $subsystem;
1052}
1053
1054sub add_categories {
1055 my ($index) = @_;
1056
1057 my $i;
1058 my $start = find_starting_index($index);
1059 my $end = find_ending_index($index);
1060
1061 push(@subsystem, $typevalue[$start]);
1062
1063 for ($i = $start + 1; $i < $end; $i++) {
1064 my $tv = $typevalue[$i];
1065 if ($tv =~ m/^([A-Z]):\s*(.*)/) {
1066 my $ptype = $1;
1067 my $pvalue = $2;
1068 if ($ptype eq "L") {
1069 my $list_address = $pvalue;
1070 my $list_additional = "";
1071 my $list_role = get_list_role($i);
1072
1073 if ($list_role ne "") {
1074 $list_role = ":" . $list_role;
1075 }
1076 if ($list_address =~ m/([^\s]+)\s+(.*)$/) {
1077 $list_address = $1;
1078 $list_additional = $2;
1079 }
1080 if ($list_additional =~ m/subscribers-only/) {
1081 if ($email_subscriber_list) {
1082 if (!$hash_list_to{lc($list_address)}) {
1083 $hash_list_to{lc($list_address)} = 1;
1084 push(@list_to, [$list_address,
1085 "subscriber list${list_role}"]);
1086 }
1087 }
1088 } else {
1089 if ($email_list) {
1090 if (!$hash_list_to{lc($list_address)}) {
1091 $hash_list_to{lc($list_address)} = 1;
1092 if ($list_additional =~ m/moderated/) {
1093 push(@list_to, [$list_address,
1094 "moderated list${list_role}"]);
1095 } else {
1096 push(@list_to, [$list_address,
1097 "open list${list_role}"]);
1098 }
1099 }
1100 }
1101 }
1102 } elsif ($ptype eq "M") {
1103 my ($name, $address) = parse_email($pvalue);
1104 if ($name eq "") {
1105 if ($i > 0) {
1106 my $tv = $typevalue[$i - 1];
1107 if ($tv =~ m/^([A-Z]):\s*(.*)/) {
1108 if ($1 eq "P") {
1109 $name = $2;
1110 $pvalue = format_email($name, $address, $email_usename);
1111 }
1112 }
1113 }
1114 }
1115 if ($email_maintainer) {
1116 my $role = get_maintainer_role($i);
1117 push_email_addresses($pvalue, $role);
1118 }
1119 } elsif ($ptype eq "R") {
1120 my ($name, $address) = parse_email($pvalue);
1121 if ($name eq "") {
1122 if ($i > 0) {
1123 my $tv = $typevalue[$i - 1];
1124 if ($tv =~ m/^([A-Z]):\s*(.*)/) {
1125 if ($1 eq "P") {
1126 $name = $2;
1127 $pvalue = format_email($name, $address, $email_usename);
1128 }
1129 }
1130 }
1131 }
1132 if ($email_reviewer) {
1133 my $subsystem = get_subsystem_name($i);
1134 push_email_addresses($pvalue, "reviewer:$subsystem");
1135 }
1136 } elsif ($ptype eq "T") {
1137 push(@scm, $pvalue);
1138 } elsif ($ptype eq "W") {
1139 push(@web, $pvalue);
1140 } elsif ($ptype eq "S") {
1141 push(@status, $pvalue);
1142 }
1143 }
1144 }
1145}
1146
1147sub email_inuse {
1148 my ($name, $address) = @_;
1149
1150 return 1 if (($name eq "") && ($address eq ""));
1151 return 1 if (($name ne "") && exists($email_hash_name{lc($name)}));
1152 return 1 if (($address ne "") && exists($email_hash_address{lc($address)}));
1153
1154 return 0;
1155}
1156
1157sub push_email_address {
1158 my ($line, $role) = @_;
1159
1160 my ($name, $address) = parse_email($line);
1161
1162 if ($address eq "") {
1163 return 0;
1164 }
1165
1166 if (!$email_remove_duplicates) {
1167 push(@email_to, [format_email($name, $address, $email_usename), $role]);
1168 } elsif (!email_inuse($name, $address)) {
1169 push(@email_to, [format_email($name, $address, $email_usename), $role]);
1170 $email_hash_name{lc($name)}++ if ($name ne "");
1171 $email_hash_address{lc($address)}++;
1172 }
1173
1174 return 1;
1175}
1176
1177sub push_email_addresses {
1178 my ($address, $role) = @_;
1179
1180 my @address_list = ();
1181
1182 if (rfc822_valid($address)) {
1183 push_email_address($address, $role);
1184 } elsif (@address_list = rfc822_validlist($address)) {
1185 my $array_count = shift(@address_list);
1186 while (my $entry = shift(@address_list)) {
1187 push_email_address($entry, $role);
1188 }
1189 } else {
1190 if (!push_email_address($address, $role)) {
1191 warn("Invalid MAINTAINERS address: '" . $address . "'\n");
1192 }
1193 }
1194}
1195
1196sub add_role {
1197 my ($line, $role) = @_;
1198
1199 my ($name, $address) = parse_email($line);
1200 my $email = format_email($name, $address, $email_usename);
1201
1202 foreach my $entry (@email_to) {
1203 if ($email_remove_duplicates) {
1204 my ($entry_name, $entry_address) = parse_email($entry->[0]);
1205 if (($name eq $entry_name || $address eq $entry_address)
1206 && ($role eq "" || !($entry->[1] =~ m/$role/))
1207 ) {
1208 if ($entry->[1] eq "") {
1209 $entry->[1] = "$role";
1210 } else {
1211 $entry->[1] = "$entry->[1],$role";
1212 }
1213 }
1214 } else {
1215 if ($email eq $entry->[0]
1216 && ($role eq "" || !($entry->[1] =~ m/$role/))
1217 ) {
1218 if ($entry->[1] eq "") {
1219 $entry->[1] = "$role";
1220 } else {
1221 $entry->[1] = "$entry->[1],$role";
1222 }
1223 }
1224 }
1225 }
1226}
1227
1228sub which {
1229 my ($bin) = @_;
1230
1231 foreach my $path (split(/:/, $ENV{PATH})) {
1232 if (-e "$path/$bin") {
1233 return "$path/$bin";
1234 }
1235 }
1236
1237 return "";
1238}
1239
1240sub which_conf {
1241 my ($conf) = @_;
1242
1243 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1244 if (-e "$path/$conf") {
1245 return "$path/$conf";
1246 }
1247 }
1248
1249 return "";
1250}
1251
1252sub mailmap_email {
1253 my ($line) = @_;
1254
1255 my ($name, $address) = parse_email($line);
1256 my $email = format_email($name, $address, 1);
1257 my $real_name = $name;
1258 my $real_address = $address;
1259
1260 if (exists $mailmap->{names}->{$email} ||
1261 exists $mailmap->{addresses}->{$email}) {
1262 if (exists $mailmap->{names}->{$email}) {
1263 $real_name = $mailmap->{names}->{$email};
1264 }
1265 if (exists $mailmap->{addresses}->{$email}) {
1266 $real_address = $mailmap->{addresses}->{$email};
1267 }
1268 } else {
1269 if (exists $mailmap->{names}->{$address}) {
1270 $real_name = $mailmap->{names}->{$address};
1271 }
1272 if (exists $mailmap->{addresses}->{$address}) {
1273 $real_address = $mailmap->{addresses}->{$address};
1274 }
1275 }
1276 return format_email($real_name, $real_address, 1);
1277}
1278
1279sub mailmap {
1280 my (@addresses) = @_;
1281
1282 my @mapped_emails = ();
1283 foreach my $line (@addresses) {
1284 push(@mapped_emails, mailmap_email($line));
1285 }
1286 merge_by_realname(@mapped_emails) if ($email_use_mailmap);
1287 return @mapped_emails;
1288}
1289
1290sub merge_by_realname {
1291 my %address_map;
1292 my (@emails) = @_;
1293
1294 foreach my $email (@emails) {
1295 my ($name, $address) = parse_email($email);
1296 if (exists $address_map{$name}) {
1297 $address = $address_map{$name};
1298 $email = format_email($name, $address, 1);
1299 } else {
1300 $address_map{$name} = $address;
1301 }
1302 }
1303}
1304
1305sub git_execute_cmd {
1306 my ($cmd) = @_;
1307 my @lines = ();
1308
1309 my $output = `$cmd`;
1310 $output =~ s/^\s*//gm;
1311 @lines = split("\n", $output);
1312
1313 return @lines;
1314}
1315
1316sub hg_execute_cmd {
1317 my ($cmd) = @_;
1318 my @lines = ();
1319
1320 my $output = `$cmd`;
1321 @lines = split("\n", $output);
1322
1323 return @lines;
1324}
1325
1326sub extract_formatted_signatures {
1327 my (@signature_lines) = @_;
1328
1329 my @type = @signature_lines;
1330
1331 s/\s*(.*):.*/$1/ for (@type);
1332
1333 # cut -f2- -d":"
1334 s/\s*.*:\s*(.+)\s*/$1/ for (@signature_lines);
1335
1336## Reformat email addresses (with names) to avoid badly written signatures
1337
1338 foreach my $signer (@signature_lines) {
1339 $signer = deduplicate_email($signer);
1340 }
1341
1342 return (\@type, \@signature_lines);
1343}
1344
1345sub vcs_find_signers {
1346 my ($cmd, $file) = @_;
1347 my $commits;
1348 my @lines = ();
1349 my @signatures = ();
1350 my @authors = ();
1351 my @stats = ();
1352
1353 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
1354
1355 my $pattern = $VCS_cmds{"commit_pattern"};
1356 my $author_pattern = $VCS_cmds{"author_pattern"};
1357 my $stat_pattern = $VCS_cmds{"stat_pattern"};
1358
1359 $stat_pattern =~ s/(\$\w+)/$1/eeg; #interpolate $stat_pattern
1360
1361 $commits = grep(/$pattern/, @lines); # of commits
1362
1363 @authors = grep(/$author_pattern/, @lines);
1364 @signatures = grep(/^[ \t]*${signature_pattern}.*\@.*$/, @lines);
1365 @stats = grep(/$stat_pattern/, @lines);
1366
1367# print("stats: <@stats>\n");
1368
1369 return (0, \@signatures, \@authors, \@stats) if !@signatures;
1370
1371 save_commits_by_author(@lines) if ($interactive);
1372 save_commits_by_signer(@lines) if ($interactive);
1373
1374 if (!$email_git_penguin_chiefs) {
1375 @signatures = grep(!/${penguin_chiefs}/i, @signatures);
1376 }
1377
1378 my ($author_ref, $authors_ref) = extract_formatted_signatures(@authors);
1379 my ($types_ref, $signers_ref) = extract_formatted_signatures(@signatures);
1380
1381 return ($commits, $signers_ref, $authors_ref, \@stats);
1382}
1383
1384sub vcs_find_author {
1385 my ($cmd) = @_;
1386 my @lines = ();
1387
1388 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
1389
1390 if (!$email_git_penguin_chiefs) {
1391 @lines = grep(!/${penguin_chiefs}/i, @lines);
1392 }
1393
1394 return @lines if !@lines;
1395
1396 my @authors = ();
1397 foreach my $line (@lines) {
1398 if ($line =~ m/$VCS_cmds{"author_pattern"}/) {
1399 my $author = $1;
1400 my ($name, $address) = parse_email($author);
1401 $author = format_email($name, $address, 1);
1402 push(@authors, $author);
1403 }
1404 }
1405
1406 save_commits_by_author(@lines) if ($interactive);
1407 save_commits_by_signer(@lines) if ($interactive);
1408
1409 return @authors;
1410}
1411
1412sub vcs_save_commits {
1413 my ($cmd) = @_;
1414 my @lines = ();
1415 my @commits = ();
1416
1417 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
1418
1419 foreach my $line (@lines) {
1420 if ($line =~ m/$VCS_cmds{"blame_commit_pattern"}/) {
1421 push(@commits, $1);
1422 }
1423 }
1424
1425 return @commits;
1426}
1427
1428sub vcs_blame {
1429 my ($file) = @_;
1430 my $cmd;
1431 my @commits = ();
1432
1433 return @commits if (!(-f $file));
1434
1435 if (@range && $VCS_cmds{"blame_range_cmd"} eq "") {
1436 my @all_commits = ();
1437
1438 $cmd = $VCS_cmds{"blame_file_cmd"};
1439 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
1440 @all_commits = vcs_save_commits($cmd);
1441
1442 foreach my $file_range_diff (@range) {
1443 next if (!($file_range_diff =~ m/(.+):(.+):(.+)/));
1444 my $diff_file = $1;
1445 my $diff_start = $2;
1446 my $diff_length = $3;
1447 next if ("$file" ne "$diff_file");
1448 for (my $i = $diff_start; $i < $diff_start + $diff_length; $i++) {
1449 push(@commits, $all_commits[$i]);
1450 }
1451 }
1452 } elsif (@range) {
1453 foreach my $file_range_diff (@range) {
1454 next if (!($file_range_diff =~ m/(.+):(.+):(.+)/));
1455 my $diff_file = $1;
1456 my $diff_start = $2;
1457 my $diff_length = $3;
1458 next if ("$file" ne "$diff_file");
1459 $cmd = $VCS_cmds{"blame_range_cmd"};
1460 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
1461 push(@commits, vcs_save_commits($cmd));
1462 }
1463 } else {
1464 $cmd = $VCS_cmds{"blame_file_cmd"};
1465 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
1466 @commits = vcs_save_commits($cmd);
1467 }
1468
1469 foreach my $commit (@commits) {
1470 $commit =~ s/^\^//g;
1471 }
1472
1473 return @commits;
1474}
1475
1476my $printed_novcs = 0;
1477sub vcs_exists {
1478 %VCS_cmds = %VCS_cmds_git;
1479 return 1 if eval $VCS_cmds{"available"};
1480 %VCS_cmds = %VCS_cmds_hg;
1481 return 2 if eval $VCS_cmds{"available"};
1482 %VCS_cmds = ();
1483 if (!$printed_novcs) {
1484 warn("$P: No supported VCS found. Add --nogit to options?\n");
1485 warn("Using a git repository produces better results.\n");
1486 warn("Try Linus Torvalds' latest git repository using:\n");
1487 warn("git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git\n");
1488 $printed_novcs = 1;
1489 }
1490 return 0;
1491}
1492
1493sub vcs_is_git {
1494 vcs_exists();
1495 return $vcs_used == 1;
1496}
1497
1498sub vcs_is_hg {
1499 return $vcs_used == 2;
1500}
1501
1502sub interactive_get_maintainers {
1503 my ($list_ref) = @_;
1504 my @list = @$list_ref;
1505
1506 vcs_exists();
1507
1508 my %selected;
1509 my %authored;
1510 my %signed;
1511 my $count = 0;
1512 my $maintained = 0;
1513 foreach my $entry (@list) {
1514 $maintained = 1 if ($entry->[1] =~ /^(maintainer|supporter)/i);
1515 $selected{$count} = 1;
1516 $authored{$count} = 0;
1517 $signed{$count} = 0;
1518 $count++;
1519 }
1520
1521 #menu loop
1522 my $done = 0;
1523 my $print_options = 0;
1524 my $redraw = 1;
1525 while (!$done) {
1526 $count = 0;
1527 if ($redraw) {
1528 printf STDERR "\n%1s %2s %-65s",
1529 "*", "#", "email/list and role:stats";
1530 if ($email_git ||
1531 ($email_git_fallback && !$maintained) ||
1532 $email_git_blame) {
1533 print STDERR "auth sign";
1534 }
1535 print STDERR "\n";
1536 foreach my $entry (@list) {
1537 my $email = $entry->[0];
1538 my $role = $entry->[1];
1539 my $sel = "";
1540 $sel = "*" if ($selected{$count});
1541 my $commit_author = $commit_author_hash{$email};
1542 my $commit_signer = $commit_signer_hash{$email};
1543 my $authored = 0;
1544 my $signed = 0;
1545 $authored++ for (@{$commit_author});
1546 $signed++ for (@{$commit_signer});
1547 printf STDERR "%1s %2d %-65s", $sel, $count + 1, $email;
1548 printf STDERR "%4d %4d", $authored, $signed
1549 if ($authored > 0 || $signed > 0);
1550 printf STDERR "\n %s\n", $role;
1551 if ($authored{$count}) {
1552 my $commit_author = $commit_author_hash{$email};
1553 foreach my $ref (@{$commit_author}) {
1554 print STDERR " Author: @{$ref}[1]\n";
1555 }
1556 }
1557 if ($signed{$count}) {
1558 my $commit_signer = $commit_signer_hash{$email};
1559 foreach my $ref (@{$commit_signer}) {
1560 print STDERR " @{$ref}[2]: @{$ref}[1]\n";
1561 }
1562 }
1563
1564 $count++;
1565 }
1566 }
1567 my $date_ref = \$email_git_since;
1568 $date_ref = \$email_hg_since if (vcs_is_hg());
1569 if ($print_options) {
1570 $print_options = 0;
1571 if (vcs_exists()) {
1572 print STDERR <<EOT
1573
1574Version Control options:
1575g use git history [$email_git]
1576gf use git-fallback [$email_git_fallback]
1577b use git blame [$email_git_blame]
1578bs use blame signatures [$email_git_blame_signatures]
1579c# minimum commits [$email_git_min_signatures]
1580%# min percent [$email_git_min_percent]
1581d# history to use [$$date_ref]
1582x# max maintainers [$email_git_max_maintainers]
1583t all signature types [$email_git_all_signature_types]
1584m use .mailmap [$email_use_mailmap]
1585EOT
1586 }
1587 print STDERR <<EOT
1588
1589Additional options:
15900 toggle all
1591tm toggle maintainers
1592tg toggle git entries
1593tl toggle open list entries
1594ts toggle subscriber list entries
1595f emails in file [$file_emails]
1596k keywords in file [$keywords]
1597r remove duplicates [$email_remove_duplicates]
1598p# pattern match depth [$pattern_depth]
1599EOT
1600 }
1601 print STDERR
1602"\n#(toggle), A#(author), S#(signed) *(all), ^(none), O(options), Y(approve): ";
1603
1604 my $input = <STDIN>;
1605 chomp($input);
1606
1607 $redraw = 1;
1608 my $rerun = 0;
1609 my @wish = split(/[, ]+/, $input);
1610 foreach my $nr (@wish) {
1611 $nr = lc($nr);
1612 my $sel = substr($nr, 0, 1);
1613 my $str = substr($nr, 1);
1614 my $val = 0;
1615 $val = $1 if $str =~ /^(\d+)$/;
1616
1617 if ($sel eq "y") {
1618 $interactive = 0;
1619 $done = 1;
1620 $output_rolestats = 0;
1621 $output_roles = 0;
1622 last;
1623 } elsif ($nr =~ /^\d+$/ && $nr > 0 && $nr <= $count) {
1624 $selected{$nr - 1} = !$selected{$nr - 1};
1625 } elsif ($sel eq "*" || $sel eq '^') {
1626 my $toggle = 0;
1627 $toggle = 1 if ($sel eq '*');
1628 for (my $i = 0; $i < $count; $i++) {
1629 $selected{$i} = $toggle;
1630 }
1631 } elsif ($sel eq "0") {
1632 for (my $i = 0; $i < $count; $i++) {
1633 $selected{$i} = !$selected{$i};
1634 }
1635 } elsif ($sel eq "t") {
1636 if (lc($str) eq "m") {
1637 for (my $i = 0; $i < $count; $i++) {
1638 $selected{$i} = !$selected{$i}
1639 if ($list[$i]->[1] =~ /^(maintainer|supporter)/i);
1640 }
1641 } elsif (lc($str) eq "g") {
1642 for (my $i = 0; $i < $count; $i++) {
1643 $selected{$i} = !$selected{$i}
1644 if ($list[$i]->[1] =~ /^(author|commit|signer)/i);
1645 }
1646 } elsif (lc($str) eq "l") {
1647 for (my $i = 0; $i < $count; $i++) {
1648 $selected{$i} = !$selected{$i}
1649 if ($list[$i]->[1] =~ /^(open list)/i);
1650 }
1651 } elsif (lc($str) eq "s") {
1652 for (my $i = 0; $i < $count; $i++) {
1653 $selected{$i} = !$selected{$i}
1654 if ($list[$i]->[1] =~ /^(subscriber list)/i);
1655 }
1656 }
1657 } elsif ($sel eq "a") {
1658 if ($val > 0 && $val <= $count) {
1659 $authored{$val - 1} = !$authored{$val - 1};
1660 } elsif ($str eq '*' || $str eq '^') {
1661 my $toggle = 0;
1662 $toggle = 1 if ($str eq '*');
1663 for (my $i = 0; $i < $count; $i++) {
1664 $authored{$i} = $toggle;
1665 }
1666 }
1667 } elsif ($sel eq "s") {
1668 if ($val > 0 && $val <= $count) {
1669 $signed{$val - 1} = !$signed{$val - 1};
1670 } elsif ($str eq '*' || $str eq '^') {
1671 my $toggle = 0;
1672 $toggle = 1 if ($str eq '*');
1673 for (my $i = 0; $i < $count; $i++) {
1674 $signed{$i} = $toggle;
1675 }
1676 }
1677 } elsif ($sel eq "o") {
1678 $print_options = 1;
1679 $redraw = 1;
1680 } elsif ($sel eq "g") {
1681 if ($str eq "f") {
1682 bool_invert(\$email_git_fallback);
1683 } else {
1684 bool_invert(\$email_git);
1685 }
1686 $rerun = 1;
1687 } elsif ($sel eq "b") {
1688 if ($str eq "s") {
1689 bool_invert(\$email_git_blame_signatures);
1690 } else {
1691 bool_invert(\$email_git_blame);
1692 }
1693 $rerun = 1;
1694 } elsif ($sel eq "c") {
1695 if ($val > 0) {
1696 $email_git_min_signatures = $val;
1697 $rerun = 1;
1698 }
1699 } elsif ($sel eq "x") {
1700 if ($val > 0) {
1701 $email_git_max_maintainers = $val;
1702 $rerun = 1;
1703 }
1704 } elsif ($sel eq "%") {
1705 if ($str ne "" && $val >= 0) {
1706 $email_git_min_percent = $val;
1707 $rerun = 1;
1708 }
1709 } elsif ($sel eq "d") {
1710 if (vcs_is_git()) {
1711 $email_git_since = $str;
1712 } elsif (vcs_is_hg()) {
1713 $email_hg_since = $str;
1714 }
1715 $rerun = 1;
1716 } elsif ($sel eq "t") {
1717 bool_invert(\$email_git_all_signature_types);
1718 $rerun = 1;
1719 } elsif ($sel eq "f") {
1720 bool_invert(\$file_emails);
1721 $rerun = 1;
1722 } elsif ($sel eq "r") {
1723 bool_invert(\$email_remove_duplicates);
1724 $rerun = 1;
1725 } elsif ($sel eq "m") {
1726 bool_invert(\$email_use_mailmap);
1727 read_mailmap();
1728 $rerun = 1;
1729 } elsif ($sel eq "k") {
1730 bool_invert(\$keywords);
1731 $rerun = 1;
1732 } elsif ($sel eq "p") {
1733 if ($str ne "" && $val >= 0) {
1734 $pattern_depth = $val;
1735 $rerun = 1;
1736 }
1737 } elsif ($sel eq "h" || $sel eq "?") {
1738 print STDERR <<EOT
1739
1740Interactive mode allows you to select the various maintainers, submitters,
1741commit signers and mailing lists that could be CC'd on a patch.
1742
1743Any *'d entry is selected.
1744
1745If you have git or hg installed, you can choose to summarize the commit
1746history of files in the patch. Also, each line of the current file can
1747be matched to its commit author and that commits signers with blame.
1748
1749Various knobs exist to control the length of time for active commit
1750tracking, the maximum number of commit authors and signers to add,
1751and such.
1752
1753Enter selections at the prompt until you are satisfied that the selected
1754maintainers are appropriate. You may enter multiple selections separated
1755by either commas or spaces.
1756
1757EOT
1758 } else {
1759 print STDERR "invalid option: '$nr'\n";
1760 $redraw = 0;
1761 }
1762 }
1763 if ($rerun) {
1764 print STDERR "git-blame can be very slow, please have patience..."
1765 if ($email_git_blame);
1766 goto &get_maintainers;
1767 }
1768 }
1769
1770 #drop not selected entries
1771 $count = 0;
1772 my @new_emailto = ();
1773 foreach my $entry (@list) {
1774 if ($selected{$count}) {
1775 push(@new_emailto, $list[$count]);
1776 }
1777 $count++;
1778 }
1779 return @new_emailto;
1780}
1781
1782sub bool_invert {
1783 my ($bool_ref) = @_;
1784
1785 if ($$bool_ref) {
1786 $$bool_ref = 0;
1787 } else {
1788 $$bool_ref = 1;
1789 }
1790}
1791
1792sub deduplicate_email {
1793 my ($email) = @_;
1794
1795 my $matched = 0;
1796 my ($name, $address) = parse_email($email);
1797 $email = format_email($name, $address, 1);
1798 $email = mailmap_email($email);
1799
1800 return $email if (!$email_remove_duplicates);
1801
1802 ($name, $address) = parse_email($email);
1803
1804 if ($name ne "" && $deduplicate_name_hash{lc($name)}) {
1805 $name = $deduplicate_name_hash{lc($name)}->[0];
1806 $address = $deduplicate_name_hash{lc($name)}->[1];
1807 $matched = 1;
1808 } elsif ($deduplicate_address_hash{lc($address)}) {
1809 $name = $deduplicate_address_hash{lc($address)}->[0];
1810 $address = $deduplicate_address_hash{lc($address)}->[1];
1811 $matched = 1;
1812 }
1813 if (!$matched) {
1814 $deduplicate_name_hash{lc($name)} = [ $name, $address ];
1815 $deduplicate_address_hash{lc($address)} = [ $name, $address ];
1816 }
1817 $email = format_email($name, $address, 1);
1818 $email = mailmap_email($email);
1819 return $email;
1820}
1821
1822sub save_commits_by_author {
1823 my (@lines) = @_;
1824
1825 my @authors = ();
1826 my @commits = ();
1827 my @subjects = ();
1828
1829 foreach my $line (@lines) {
1830 if ($line =~ m/$VCS_cmds{"author_pattern"}/) {
1831 my $author = $1;
1832 $author = deduplicate_email($author);
1833 push(@authors, $author);
1834 }
1835 push(@commits, $1) if ($line =~ m/$VCS_cmds{"commit_pattern"}/);
1836 push(@subjects, $1) if ($line =~ m/$VCS_cmds{"subject_pattern"}/);
1837 }
1838
1839 for (my $i = 0; $i < @authors; $i++) {
1840 my $exists = 0;
1841 foreach my $ref(@{$commit_author_hash{$authors[$i]}}) {
1842 if (@{$ref}[0] eq $commits[$i] &&
1843 @{$ref}[1] eq $subjects[$i]) {
1844 $exists = 1;
1845 last;
1846 }
1847 }
1848 if (!$exists) {
1849 push(@{$commit_author_hash{$authors[$i]}},
1850 [ ($commits[$i], $subjects[$i]) ]);
1851 }
1852 }
1853}
1854
1855sub save_commits_by_signer {
1856 my (@lines) = @_;
1857
1858 my $commit = "";
1859 my $subject = "";
1860
1861 foreach my $line (@lines) {
1862 $commit = $1 if ($line =~ m/$VCS_cmds{"commit_pattern"}/);
1863 $subject = $1 if ($line =~ m/$VCS_cmds{"subject_pattern"}/);
1864 if ($line =~ /^[ \t]*${signature_pattern}.*\@.*$/) {
1865 my @signatures = ($line);
1866 my ($types_ref, $signers_ref) = extract_formatted_signatures(@signatures);
1867 my @types = @$types_ref;
1868 my @signers = @$signers_ref;
1869
1870 my $type = $types[0];
1871 my $signer = $signers[0];
1872
1873 $signer = deduplicate_email($signer);
1874
1875 my $exists = 0;
1876 foreach my $ref(@{$commit_signer_hash{$signer}}) {
1877 if (@{$ref}[0] eq $commit &&
1878 @{$ref}[1] eq $subject &&
1879 @{$ref}[2] eq $type) {
1880 $exists = 1;
1881 last;
1882 }
1883 }
1884 if (!$exists) {
1885 push(@{$commit_signer_hash{$signer}},
1886 [ ($commit, $subject, $type) ]);
1887 }
1888 }
1889 }
1890}
1891
1892sub vcs_assign {
1893 my ($role, $divisor, @lines) = @_;
1894
1895 my %hash;
1896 my $count = 0;
1897
1898 return if (@lines <= 0);
1899
1900 if ($divisor <= 0) {
1901 warn("Bad divisor in " . (caller(0))[3] . ": $divisor\n");
1902 $divisor = 1;
1903 }
1904
1905 @lines = mailmap(@lines);
1906
1907 return if (@lines <= 0);
1908
1909 @lines = sort(@lines);
1910
1911 # uniq -c
1912 $hash{$_}++ for @lines;
1913
1914 # sort -rn
1915 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
1916 my $sign_offs = $hash{$line};
1917 my $percent = $sign_offs * 100 / $divisor;
1918
1919 $percent = 100 if ($percent > 100);
1920 next if (ignore_email_address($line));
1921 $count++;
1922 last if ($sign_offs < $email_git_min_signatures ||
1923 $count > $email_git_max_maintainers ||
1924 $percent < $email_git_min_percent);
1925 push_email_address($line, '');
1926 if ($output_rolestats) {
1927 my $fmt_percent = sprintf("%.0f", $percent);
1928 add_role($line, "$role:$sign_offs/$divisor=$fmt_percent%");
1929 } else {
1930 add_role($line, $role);
1931 }
1932 }
1933}
1934
1935sub vcs_file_signoffs {
1936 my ($file) = @_;
1937
1938 my $authors_ref;
1939 my $signers_ref;
1940 my $stats_ref;
1941 my @authors = ();
1942 my @signers = ();
1943 my @stats = ();
1944 my $commits;
1945
1946 $vcs_used = vcs_exists();
1947 return if (!$vcs_used);
1948
1949 my $cmd = $VCS_cmds{"find_signers_cmd"};
1950 $cmd =~ s/(\$\w+)/$1/eeg; # interpolate $cmd
1951
1952 ($commits, $signers_ref, $authors_ref, $stats_ref) = vcs_find_signers($cmd, $file);
1953
1954 @signers = @{$signers_ref} if defined $signers_ref;
1955 @authors = @{$authors_ref} if defined $authors_ref;
1956 @stats = @{$stats_ref} if defined $stats_ref;
1957
1958# print("commits: <$commits>\nsigners:<@signers>\nauthors: <@authors>\nstats: <@stats>\n");
1959
1960 foreach my $signer (@signers) {
1961 $signer = deduplicate_email($signer);
1962 }
1963
1964 vcs_assign("commit_signer", $commits, @signers);
1965 vcs_assign("authored", $commits, @authors);
1966 if ($#authors == $#stats) {
1967 my $stat_pattern = $VCS_cmds{"stat_pattern"};
1968 $stat_pattern =~ s/(\$\w+)/$1/eeg; #interpolate $stat_pattern
1969
1970 my $added = 0;
1971 my $deleted = 0;
1972 for (my $i = 0; $i <= $#stats; $i++) {
1973 if ($stats[$i] =~ /$stat_pattern/) {
1974 $added += $1;
1975 $deleted += $2;
1976 }
1977 }
1978 my @tmp_authors = uniq(@authors);
1979 foreach my $author (@tmp_authors) {
1980 $author = deduplicate_email($author);
1981 }
1982 @tmp_authors = uniq(@tmp_authors);
1983 my @list_added = ();
1984 my @list_deleted = ();
1985 foreach my $author (@tmp_authors) {
1986 my $auth_added = 0;
1987 my $auth_deleted = 0;
1988 for (my $i = 0; $i <= $#stats; $i++) {
1989 if ($author eq deduplicate_email($authors[$i]) &&
1990 $stats[$i] =~ /$stat_pattern/) {
1991 $auth_added += $1;
1992 $auth_deleted += $2;
1993 }
1994 }
1995 for (my $i = 0; $i < $auth_added; $i++) {
1996 push(@list_added, $author);
1997 }
1998 for (my $i = 0; $i < $auth_deleted; $i++) {
1999 push(@list_deleted, $author);
2000 }
2001 }
2002 vcs_assign("added_lines", $added, @list_added);
2003 vcs_assign("removed_lines", $deleted, @list_deleted);
2004 }
2005}
2006
2007sub vcs_file_blame {
2008 my ($file) = @_;
2009
2010 my @signers = ();
2011 my @all_commits = ();
2012 my @commits = ();
2013 my $total_commits;
2014 my $total_lines;
2015
2016 $vcs_used = vcs_exists();
2017 return if (!$vcs_used);
2018
2019 @all_commits = vcs_blame($file);
2020 @commits = uniq(@all_commits);
2021 $total_commits = @commits;
2022 $total_lines = @all_commits;
2023
2024 if ($email_git_blame_signatures) {
2025 if (vcs_is_hg()) {
2026 my $commit_count;
2027 my $commit_authors_ref;
2028 my $commit_signers_ref;
2029 my $stats_ref;
2030 my @commit_authors = ();
2031 my @commit_signers = ();
2032 my $commit = join(" -r ", @commits);
2033 my $cmd;
2034
2035 $cmd = $VCS_cmds{"find_commit_signers_cmd"};
2036 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
2037
2038 ($commit_count, $commit_signers_ref, $commit_authors_ref, $stats_ref) = vcs_find_signers($cmd, $file);
2039 @commit_authors = @{$commit_authors_ref} if defined $commit_authors_ref;
2040 @commit_signers = @{$commit_signers_ref} if defined $commit_signers_ref;
2041
2042 push(@signers, @commit_signers);
2043 } else {
2044 foreach my $commit (@commits) {
2045 my $commit_count;
2046 my $commit_authors_ref;
2047 my $commit_signers_ref;
2048 my $stats_ref;
2049 my @commit_authors = ();
2050 my @commit_signers = ();
2051 my $cmd;
2052
2053 $cmd = $VCS_cmds{"find_commit_signers_cmd"};
2054 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
2055
2056 ($commit_count, $commit_signers_ref, $commit_authors_ref, $stats_ref) = vcs_find_signers($cmd, $file);
2057 @commit_authors = @{$commit_authors_ref} if defined $commit_authors_ref;
2058 @commit_signers = @{$commit_signers_ref} if defined $commit_signers_ref;
2059
2060 push(@signers, @commit_signers);
2061 }
2062 }
2063 }
2064
2065 if ($from_filename) {
2066 if ($output_rolestats) {
2067 my @blame_signers;
2068 if (vcs_is_hg()) {{ # Double brace for last exit
2069 my $commit_count;
2070 my @commit_signers = ();
2071 @commits = uniq(@commits);
2072 @commits = sort(@commits);
2073 my $commit = join(" -r ", @commits);
2074 my $cmd;
2075
2076 $cmd = $VCS_cmds{"find_commit_author_cmd"};
2077 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
2078
2079 my @lines = ();
2080
2081 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
2082
2083 if (!$email_git_penguin_chiefs) {
2084 @lines = grep(!/${penguin_chiefs}/i, @lines);
2085 }
2086
2087 last if !@lines;
2088
2089 my @authors = ();
2090 foreach my $line (@lines) {
2091 if ($line =~ m/$VCS_cmds{"author_pattern"}/) {
2092 my $author = $1;
2093 $author = deduplicate_email($author);
2094 push(@authors, $author);
2095 }
2096 }
2097
2098 save_commits_by_author(@lines) if ($interactive);
2099 save_commits_by_signer(@lines) if ($interactive);
2100
2101 push(@signers, @authors);
2102 }}
2103 else {
2104 foreach my $commit (@commits) {
2105 my $i;
2106 my $cmd = $VCS_cmds{"find_commit_author_cmd"};
2107 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
2108 my @author = vcs_find_author($cmd);
2109 next if !@author;
2110
2111 my $formatted_author = deduplicate_email($author[0]);
2112
2113 my $count = grep(/$commit/, @all_commits);
2114 for ($i = 0; $i < $count ; $i++) {
2115 push(@blame_signers, $formatted_author);
2116 }
2117 }
2118 }
2119 if (@blame_signers) {
2120 vcs_assign("authored lines", $total_lines, @blame_signers);
2121 }
2122 }
2123 foreach my $signer (@signers) {
2124 $signer = deduplicate_email($signer);
2125 }
2126 vcs_assign("commits", $total_commits, @signers);
2127 } else {
2128 foreach my $signer (@signers) {
2129 $signer = deduplicate_email($signer);
2130 }
2131 vcs_assign("modified commits", $total_commits, @signers);
2132 }
2133}
2134
2135sub vcs_file_exists {
2136 my ($file) = @_;
2137
2138 my $exists;
2139
2140 my $vcs_used = vcs_exists();
2141 return 0 if (!$vcs_used);
2142
2143 my $cmd = $VCS_cmds{"file_exists_cmd"};
2144 $cmd =~ s/(\$\w+)/$1/eeg; # interpolate $cmd
2145 $cmd .= " 2>&1";
2146 $exists = &{$VCS_cmds{"execute_cmd"}}($cmd);
2147
2148 return 0 if ($? != 0);
2149
2150 return $exists;
2151}
2152
2153sub uniq {
2154 my (@parms) = @_;
2155
2156 my %saw;
2157 @parms = grep(!$saw{$_}++, @parms);
2158 return @parms;
2159}
2160
2161sub sort_and_uniq {
2162 my (@parms) = @_;
2163
2164 my %saw;
2165 @parms = sort @parms;
2166 @parms = grep(!$saw{$_}++, @parms);
2167 return @parms;
2168}
2169
2170sub clean_file_emails {
2171 my (@file_emails) = @_;
2172 my @fmt_emails = ();
2173
2174 foreach my $email (@file_emails) {
2175 $email =~ s/[\(\<\{]{0,1}([A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+)[\)\>\}]{0,1}/\<$1\>/g;
2176 my ($name, $address) = parse_email($email);
2177 if ($name eq '"[,\.]"') {
2178 $name = "";
2179 }
2180
2181 my @nw = split(/[^A-Za-zÀ-ÿ\'\,\.\+-]/, $name);
2182 if (@nw > 2) {
2183 my $first = $nw[@nw - 3];
2184 my $middle = $nw[@nw - 2];
2185 my $last = $nw[@nw - 1];
2186
2187 if (((length($first) == 1 && $first =~ m/[A-Za-z]/) ||
2188 (length($first) == 2 && substr($first, -1) eq ".")) ||
2189 (length($middle) == 1 ||
2190 (length($middle) == 2 && substr($middle, -1) eq "."))) {
2191 $name = "$first $middle $last";
2192 } else {
2193 $name = "$middle $last";
2194 }
2195 }
2196
2197 if (substr($name, -1) =~ /[,\.]/) {
2198 $name = substr($name, 0, length($name) - 1);
2199 } elsif (substr($name, -2) =~ /[,\.]"/) {
2200 $name = substr($name, 0, length($name) - 2) . '"';
2201 }
2202
2203 if (substr($name, 0, 1) =~ /[,\.]/) {
2204 $name = substr($name, 1, length($name) - 1);
2205 } elsif (substr($name, 0, 2) =~ /"[,\.]/) {
2206 $name = '"' . substr($name, 2, length($name) - 2);
2207 }
2208
2209 my $fmt_email = format_email($name, $address, $email_usename);
2210 push(@fmt_emails, $fmt_email);
2211 }
2212 return @fmt_emails;
2213}
2214
2215sub merge_email {
2216 my @lines;
2217 my %saw;
2218
2219 for (@_) {
2220 my ($address, $role) = @$_;
2221 if (!$saw{$address}) {
2222 if ($output_roles) {
2223 push(@lines, "$address ($role)");
2224 } else {
2225 push(@lines, $address);
2226 }
2227 $saw{$address} = 1;
2228 }
2229 }
2230
2231 return @lines;
2232}
2233
2234sub output {
2235 my (@parms) = @_;
2236
2237 if ($output_multiline) {
2238 foreach my $line (@parms) {
2239 print("${line}\n");
2240 }
2241 } else {
2242 print(join($output_separator, @parms));
2243 print("\n");
2244 }
2245}
2246
2247my $rfc822re;
2248
2249sub make_rfc822re {
2250# Basic lexical tokens are specials, domain_literal, quoted_string, atom, and
2251# comment. We must allow for rfc822_lwsp (or comments) after each of these.
2252# This regexp will only work on addresses which have had comments stripped
2253# and replaced with rfc822_lwsp.
2254
2255 my $specials = '()<>@,;:\\\\".\\[\\]';
2256 my $controls = '\\000-\\037\\177';
2257
2258 my $dtext = "[^\\[\\]\\r\\\\]";
2259 my $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$rfc822_lwsp*";
2260
2261 my $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$rfc822_lwsp)*\"$rfc822_lwsp*";
2262
2263# Use zero-width assertion to spot the limit of an atom. A simple
2264# $rfc822_lwsp* causes the regexp engine to hang occasionally.
2265 my $atom = "[^$specials $controls]+(?:$rfc822_lwsp+|\\Z|(?=[\\[\"$specials]))";
2266 my $word = "(?:$atom|$quoted_string)";
2267 my $localpart = "$word(?:\\.$rfc822_lwsp*$word)*";
2268
2269 my $sub_domain = "(?:$atom|$domain_literal)";
2270 my $domain = "$sub_domain(?:\\.$rfc822_lwsp*$sub_domain)*";
2271
2272 my $addr_spec = "$localpart\@$rfc822_lwsp*$domain";
2273
2274 my $phrase = "$word*";
2275 my $route = "(?:\@$domain(?:,\@$rfc822_lwsp*$domain)*:$rfc822_lwsp*)";
2276 my $route_addr = "\\<$rfc822_lwsp*$route?$addr_spec\\>$rfc822_lwsp*";
2277 my $mailbox = "(?:$addr_spec|$phrase$route_addr)";
2278
2279 my $group = "$phrase:$rfc822_lwsp*(?:$mailbox(?:,\\s*$mailbox)*)?;\\s*";
2280 my $address = "(?:$mailbox|$group)";
2281
2282 return "$rfc822_lwsp*$address";
2283}
2284
2285sub rfc822_strip_comments {
2286 my $s = shift;
2287# Recursively remove comments, and replace with a single space. The simpler
2288# regexps in the Email Addressing FAQ are imperfect - they will miss escaped
2289# chars in atoms, for example.
2290
2291 while ($s =~ s/^((?:[^"\\]|\\.)*
2292 (?:"(?:[^"\\]|\\.)*"(?:[^"\\]|\\.)*)*)
2293 \((?:[^()\\]|\\.)*\)/$1 /osx) {}
2294 return $s;
2295}
2296
2297# valid: returns true if the parameter is an RFC822 valid address
2298#
2299sub rfc822_valid {
2300 my $s = rfc822_strip_comments(shift);
2301
2302 if (!$rfc822re) {
2303 $rfc822re = make_rfc822re();
2304 }
2305
2306 return $s =~ m/^$rfc822re$/so && $s =~ m/^$rfc822_char*$/;
2307}
2308
2309# validlist: In scalar context, returns true if the parameter is an RFC822
2310# valid list of addresses.
2311#
2312# In list context, returns an empty list on failure (an invalid
2313# address was found); otherwise a list whose first element is the
2314# number of addresses found and whose remaining elements are the
2315# addresses. This is needed to disambiguate failure (invalid)
2316# from success with no addresses found, because an empty string is
2317# a valid list.
2318
2319sub rfc822_validlist {
2320 my $s = rfc822_strip_comments(shift);
2321
2322 if (!$rfc822re) {
2323 $rfc822re = make_rfc822re();
2324 }
2325 # * null list items are valid according to the RFC
2326 # * the '1' business is to aid in distinguishing failure from no results
2327
2328 my @r;
2329 if ($s =~ m/^(?:$rfc822re)?(?:,(?:$rfc822re)?)*$/so &&
2330 $s =~ m/^$rfc822_char*$/) {
2331 while ($s =~ m/(?:^|,$rfc822_lwsp*)($rfc822re)/gos) {
2332 push(@r, $1);
2333 }
2334 return wantarray ? (scalar(@r), @r) : 1;
2335 }
2336 return wantarray ? () : 0;
2337}
1#!/usr/bin/env perl
2# SPDX-License-Identifier: GPL-2.0
3#
4# (c) 2007, Joe Perches <joe@perches.com>
5# created from checkpatch.pl
6#
7# Print selected MAINTAINERS information for
8# the files modified in a patch or for a file
9#
10# usage: perl scripts/get_maintainer.pl [OPTIONS] <patch>
11# perl scripts/get_maintainer.pl [OPTIONS] -f <file>
12
13use warnings;
14use strict;
15
16my $P = $0;
17my $V = '0.26';
18
19use Getopt::Long qw(:config no_auto_abbrev);
20use Cwd;
21use File::Find;
22use File::Spec::Functions;
23use open qw(:std :encoding(UTF-8));
24
25my $cur_path = fastgetcwd() . '/';
26my $lk_path = "./";
27my $email = 1;
28my $email_usename = 1;
29my $email_maintainer = 1;
30my $email_reviewer = 1;
31my $email_fixes = 1;
32my $email_list = 1;
33my $email_moderated_list = 1;
34my $email_subscriber_list = 0;
35my $email_git_penguin_chiefs = 0;
36my $email_git = 0;
37my $email_git_all_signature_types = 0;
38my $email_git_blame = 0;
39my $email_git_blame_signatures = 1;
40my $email_git_fallback = 1;
41my $email_git_min_signatures = 1;
42my $email_git_max_maintainers = 5;
43my $email_git_min_percent = 5;
44my $email_git_since = "1-year-ago";
45my $email_hg_since = "-365";
46my $interactive = 0;
47my $email_remove_duplicates = 1;
48my $email_use_mailmap = 1;
49my $output_multiline = 1;
50my $output_separator = ", ";
51my $output_roles = 0;
52my $output_rolestats = 1;
53my $output_section_maxlen = 50;
54my $scm = 0;
55my $tree = 1;
56my $web = 0;
57my $bug = 0;
58my $subsystem = 0;
59my $status = 0;
60my $letters = "";
61my $keywords = 1;
62my $keywords_in_file = 0;
63my $sections = 0;
64my $email_file_emails = 0;
65my $from_filename = 0;
66my $pattern_depth = 0;
67my $self_test = undef;
68my $version = 0;
69my $help = 0;
70my $find_maintainer_files = 0;
71my $maintainer_path;
72my $vcs_used = 0;
73
74my $exit = 0;
75
76my @files = ();
77my @fixes = (); # If a patch description includes Fixes: lines
78my @range = ();
79my @keyword_tvi = ();
80my @file_emails = ();
81
82my %commit_author_hash;
83my %commit_signer_hash;
84
85my @penguin_chief = ();
86push(@penguin_chief, "Linus Torvalds:torvalds\@linux-foundation.org");
87#Andrew wants in on most everything - 2009/01/14
88#push(@penguin_chief, "Andrew Morton:akpm\@linux-foundation.org");
89
90my @penguin_chief_names = ();
91foreach my $chief (@penguin_chief) {
92 if ($chief =~ m/^(.*):(.*)/) {
93 my $chief_name = $1;
94 my $chief_addr = $2;
95 push(@penguin_chief_names, $chief_name);
96 }
97}
98my $penguin_chiefs = "\(" . join("|", @penguin_chief_names) . "\)";
99
100# Signature types of people who are either
101# a) responsible for the code in question, or
102# b) familiar enough with it to give relevant feedback
103my @signature_tags = ();
104push(@signature_tags, "Signed-off-by:");
105push(@signature_tags, "Reviewed-by:");
106push(@signature_tags, "Acked-by:");
107
108my $signature_pattern = "\(" . join("|", @signature_tags) . "\)";
109
110# rfc822 email address - preloaded methods go here.
111my $rfc822_lwsp = "(?:(?:\\r\\n)?[ \\t])";
112my $rfc822_char = '[\\000-\\377]';
113
114# VCS command support: class-like functions and strings
115
116my %VCS_cmds;
117
118my %VCS_cmds_git = (
119 "execute_cmd" => \&git_execute_cmd,
120 "available" => '(which("git") ne "") && (-e ".git")',
121 "find_signers_cmd" =>
122 "git log --no-color --follow --since=\$email_git_since " .
123 '--numstat --no-merges ' .
124 '--format="GitCommit: %H%n' .
125 'GitAuthor: %an <%ae>%n' .
126 'GitDate: %aD%n' .
127 'GitSubject: %s%n' .
128 '%b%n"' .
129 " -- \$file",
130 "find_commit_signers_cmd" =>
131 "git log --no-color " .
132 '--numstat ' .
133 '--format="GitCommit: %H%n' .
134 'GitAuthor: %an <%ae>%n' .
135 'GitDate: %aD%n' .
136 'GitSubject: %s%n' .
137 '%b%n"' .
138 " -1 \$commit",
139 "find_commit_author_cmd" =>
140 "git log --no-color " .
141 '--numstat ' .
142 '--format="GitCommit: %H%n' .
143 'GitAuthor: %an <%ae>%n' .
144 'GitDate: %aD%n' .
145 'GitSubject: %s%n"' .
146 " -1 \$commit",
147 "blame_range_cmd" => "git blame -l -L \$diff_start,+\$diff_length \$file",
148 "blame_file_cmd" => "git blame -l \$file",
149 "commit_pattern" => "^GitCommit: ([0-9a-f]{40,40})",
150 "blame_commit_pattern" => "^([0-9a-f]+) ",
151 "author_pattern" => "^GitAuthor: (.*)",
152 "subject_pattern" => "^GitSubject: (.*)",
153 "stat_pattern" => "^(\\d+)\\t(\\d+)\\t\$file\$",
154 "file_exists_cmd" => "git ls-files \$file",
155 "list_files_cmd" => "git ls-files \$file",
156);
157
158my %VCS_cmds_hg = (
159 "execute_cmd" => \&hg_execute_cmd,
160 "available" => '(which("hg") ne "") && (-d ".hg")',
161 "find_signers_cmd" =>
162 "hg log --date=\$email_hg_since " .
163 "--template='HgCommit: {node}\\n" .
164 "HgAuthor: {author}\\n" .
165 "HgSubject: {desc}\\n'" .
166 " -- \$file",
167 "find_commit_signers_cmd" =>
168 "hg log " .
169 "--template='HgSubject: {desc}\\n'" .
170 " -r \$commit",
171 "find_commit_author_cmd" =>
172 "hg log " .
173 "--template='HgCommit: {node}\\n" .
174 "HgAuthor: {author}\\n" .
175 "HgSubject: {desc|firstline}\\n'" .
176 " -r \$commit",
177 "blame_range_cmd" => "", # not supported
178 "blame_file_cmd" => "hg blame -n \$file",
179 "commit_pattern" => "^HgCommit: ([0-9a-f]{40,40})",
180 "blame_commit_pattern" => "^([ 0-9a-f]+):",
181 "author_pattern" => "^HgAuthor: (.*)",
182 "subject_pattern" => "^HgSubject: (.*)",
183 "stat_pattern" => "^(\\d+)\t(\\d+)\t\$file\$",
184 "file_exists_cmd" => "hg files \$file",
185 "list_files_cmd" => "hg manifest -R \$file",
186);
187
188my $conf = which_conf(".get_maintainer.conf");
189if (-f $conf) {
190 my @conf_args;
191 open(my $conffile, '<', "$conf")
192 or warn "$P: Can't find a readable .get_maintainer.conf file $!\n";
193
194 while (<$conffile>) {
195 my $line = $_;
196
197 $line =~ s/\s*\n?$//g;
198 $line =~ s/^\s*//g;
199 $line =~ s/\s+/ /g;
200
201 next if ($line =~ m/^\s*#/);
202 next if ($line =~ m/^\s*$/);
203
204 my @words = split(" ", $line);
205 foreach my $word (@words) {
206 last if ($word =~ m/^#/);
207 push (@conf_args, $word);
208 }
209 }
210 close($conffile);
211 unshift(@ARGV, @conf_args) if @conf_args;
212}
213
214my @ignore_emails = ();
215my $ignore_file = which_conf(".get_maintainer.ignore");
216if (-f $ignore_file) {
217 open(my $ignore, '<', "$ignore_file")
218 or warn "$P: Can't find a readable .get_maintainer.ignore file $!\n";
219 while (<$ignore>) {
220 my $line = $_;
221
222 $line =~ s/\s*\n?$//;
223 $line =~ s/^\s*//;
224 $line =~ s/\s+$//;
225 $line =~ s/#.*$//;
226
227 next if ($line =~ m/^\s*$/);
228 if (rfc822_valid($line)) {
229 push(@ignore_emails, $line);
230 }
231 }
232 close($ignore);
233}
234
235if ($#ARGV > 0) {
236 foreach (@ARGV) {
237 if ($_ =~ /^-{1,2}self-test(?:=|$)/) {
238 die "$P: using --self-test does not allow any other option or argument\n";
239 }
240 }
241}
242
243if (!GetOptions(
244 'email!' => \$email,
245 'git!' => \$email_git,
246 'git-all-signature-types!' => \$email_git_all_signature_types,
247 'git-blame!' => \$email_git_blame,
248 'git-blame-signatures!' => \$email_git_blame_signatures,
249 'git-fallback!' => \$email_git_fallback,
250 'git-chief-penguins!' => \$email_git_penguin_chiefs,
251 'git-min-signatures=i' => \$email_git_min_signatures,
252 'git-max-maintainers=i' => \$email_git_max_maintainers,
253 'git-min-percent=i' => \$email_git_min_percent,
254 'git-since=s' => \$email_git_since,
255 'hg-since=s' => \$email_hg_since,
256 'i|interactive!' => \$interactive,
257 'remove-duplicates!' => \$email_remove_duplicates,
258 'mailmap!' => \$email_use_mailmap,
259 'm!' => \$email_maintainer,
260 'r!' => \$email_reviewer,
261 'n!' => \$email_usename,
262 'l!' => \$email_list,
263 'fixes!' => \$email_fixes,
264 'moderated!' => \$email_moderated_list,
265 's!' => \$email_subscriber_list,
266 'multiline!' => \$output_multiline,
267 'roles!' => \$output_roles,
268 'rolestats!' => \$output_rolestats,
269 'separator=s' => \$output_separator,
270 'subsystem!' => \$subsystem,
271 'status!' => \$status,
272 'scm!' => \$scm,
273 'tree!' => \$tree,
274 'web!' => \$web,
275 'bug!' => \$bug,
276 'letters=s' => \$letters,
277 'pattern-depth=i' => \$pattern_depth,
278 'k|keywords!' => \$keywords,
279 'kf|keywords-in-file!' => \$keywords_in_file,
280 'sections!' => \$sections,
281 'fe|file-emails!' => \$email_file_emails,
282 'f|file' => \$from_filename,
283 'find-maintainer-files' => \$find_maintainer_files,
284 'mpath|maintainer-path=s' => \$maintainer_path,
285 'self-test:s' => \$self_test,
286 'v|version' => \$version,
287 'h|help|usage' => \$help,
288 )) {
289 die "$P: invalid argument - use --help if necessary\n";
290}
291
292if ($help != 0) {
293 usage();
294 exit 0;
295}
296
297if ($version != 0) {
298 print("${P} ${V}\n");
299 exit 0;
300}
301
302if (defined $self_test) {
303 read_all_maintainer_files();
304 self_test();
305 exit 0;
306}
307
308if (-t STDIN && !@ARGV) {
309 # We're talking to a terminal, but have no command line arguments.
310 die "$P: missing patchfile or -f file - use --help if necessary\n";
311}
312
313$output_multiline = 0 if ($output_separator ne ", ");
314$output_rolestats = 1 if ($interactive);
315$output_roles = 1 if ($output_rolestats);
316
317if ($sections || $letters ne "") {
318 $sections = 1;
319 $email = 0;
320 $email_list = 0;
321 $scm = 0;
322 $status = 0;
323 $subsystem = 0;
324 $web = 0;
325 $bug = 0;
326 $keywords = 0;
327 $keywords_in_file = 0;
328 $interactive = 0;
329} else {
330 my $selections = $email + $scm + $status + $subsystem + $web + $bug;
331 if ($selections == 0) {
332 die "$P: Missing required option: email, scm, status, subsystem, web or bug\n";
333 }
334}
335
336if ($email &&
337 ($email_maintainer + $email_reviewer +
338 $email_list + $email_subscriber_list +
339 $email_git + $email_git_penguin_chiefs + $email_git_blame) == 0) {
340 die "$P: Please select at least 1 email option\n";
341}
342
343if ($tree && !top_of_kernel_tree($lk_path)) {
344 die "$P: The current directory does not appear to be "
345 . "a linux kernel source tree.\n";
346}
347
348## Read MAINTAINERS for type/value pairs
349
350my @typevalue = ();
351my %keyword_hash;
352my @mfiles = ();
353my @self_test_info = ();
354
355sub read_maintainer_file {
356 my ($file) = @_;
357
358 open (my $maint, '<', "$file")
359 or die "$P: Can't open MAINTAINERS file '$file': $!\n";
360 my $i = 1;
361 while (<$maint>) {
362 my $line = $_;
363 chomp $line;
364
365 if ($line =~ m/^([A-Z]):\s*(.*)/) {
366 my $type = $1;
367 my $value = $2;
368
369 ##Filename pattern matching
370 if ($type eq "F" || $type eq "X") {
371 $value =~ s@\.@\\\.@g; ##Convert . to \.
372 $value =~ s/\*/\.\*/g; ##Convert * to .*
373 $value =~ s/\?/\./g; ##Convert ? to .
374 ##if pattern is a directory and it lacks a trailing slash, add one
375 if ((-d $value)) {
376 $value =~ s@([^/])$@$1/@;
377 }
378 } elsif ($type eq "K") {
379 $keyword_hash{@typevalue} = $value;
380 }
381 push(@typevalue, "$type:$value");
382 } elsif (!(/^\s*$/ || /^\s*\#/)) {
383 push(@typevalue, $line);
384 }
385 if (defined $self_test) {
386 push(@self_test_info, {file=>$file, linenr=>$i, line=>$line});
387 }
388 $i++;
389 }
390 close($maint);
391}
392
393sub find_is_maintainer_file {
394 my ($file) = $_;
395 return if ($file !~ m@/MAINTAINERS$@);
396 $file = $File::Find::name;
397 return if (! -f $file);
398 push(@mfiles, $file);
399}
400
401sub find_ignore_git {
402 return grep { $_ !~ /^\.git$/; } @_;
403}
404
405read_all_maintainer_files();
406
407sub read_all_maintainer_files {
408 my $path = "${lk_path}MAINTAINERS";
409 if (defined $maintainer_path) {
410 $path = $maintainer_path;
411 # Perl Cookbook tilde expansion if necessary
412 $path =~ s@^~([^/]*)@ $1 ? (getpwnam($1))[7] : ( $ENV{HOME} || $ENV{LOGDIR} || (getpwuid($<))[7])@ex;
413 }
414
415 if (-d $path) {
416 $path .= '/' if ($path !~ m@/$@);
417 if ($find_maintainer_files) {
418 find( { wanted => \&find_is_maintainer_file,
419 preprocess => \&find_ignore_git,
420 no_chdir => 1,
421 }, "$path");
422 } else {
423 opendir(DIR, "$path") or die $!;
424 my @files = readdir(DIR);
425 closedir(DIR);
426 foreach my $file (@files) {
427 push(@mfiles, "$path$file") if ($file !~ /^\./);
428 }
429 }
430 } elsif (-f "$path") {
431 push(@mfiles, "$path");
432 } else {
433 die "$P: MAINTAINER file not found '$path'\n";
434 }
435 die "$P: No MAINTAINER files found in '$path'\n" if (scalar(@mfiles) == 0);
436 foreach my $file (@mfiles) {
437 read_maintainer_file("$file");
438 }
439}
440
441sub maintainers_in_file {
442 my ($file) = @_;
443
444 return if ($file =~ m@\bMAINTAINERS$@);
445
446 if (-f $file && ($email_file_emails || $file =~ /\.yaml$/)) {
447 open(my $f, '<', $file)
448 or die "$P: Can't open $file: $!\n";
449 my $text = do { local($/) ; <$f> };
450 close($f);
451
452 my @poss_addr = $text =~ m$[\p{L}\"\' \,\.\+-]*\s*[\,]*\s*[\(\<\{]{0,1}[A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+\.[A-Za-z0-9]+[\)\>\}]{0,1}$g;
453 push(@file_emails, clean_file_emails(@poss_addr));
454 }
455}
456
457#
458# Read mail address map
459#
460
461my $mailmap;
462
463read_mailmap();
464
465sub read_mailmap {
466 $mailmap = {
467 names => {},
468 addresses => {}
469 };
470
471 return if (!$email_use_mailmap || !(-f "${lk_path}.mailmap"));
472
473 open(my $mailmap_file, '<', "${lk_path}.mailmap")
474 or warn "$P: Can't open .mailmap: $!\n";
475
476 while (<$mailmap_file>) {
477 s/#.*$//; #strip comments
478 s/^\s+|\s+$//g; #trim
479
480 next if (/^\s*$/); #skip empty lines
481 #entries have one of the following formats:
482 # name1 <mail1>
483 # <mail1> <mail2>
484 # name1 <mail1> <mail2>
485 # name1 <mail1> name2 <mail2>
486 # (see man git-shortlog)
487
488 if (/^([^<]+)<([^>]+)>$/) {
489 my $real_name = $1;
490 my $address = $2;
491
492 $real_name =~ s/\s+$//;
493 ($real_name, $address) = parse_email("$real_name <$address>");
494 $mailmap->{names}->{$address} = $real_name;
495
496 } elsif (/^<([^>]+)>\s*<([^>]+)>$/) {
497 my $real_address = $1;
498 my $wrong_address = $2;
499
500 $mailmap->{addresses}->{$wrong_address} = $real_address;
501
502 } elsif (/^(.+)<([^>]+)>\s*<([^>]+)>$/) {
503 my $real_name = $1;
504 my $real_address = $2;
505 my $wrong_address = $3;
506
507 $real_name =~ s/\s+$//;
508 ($real_name, $real_address) =
509 parse_email("$real_name <$real_address>");
510 $mailmap->{names}->{$wrong_address} = $real_name;
511 $mailmap->{addresses}->{$wrong_address} = $real_address;
512
513 } elsif (/^(.+)<([^>]+)>\s*(.+)\s*<([^>]+)>$/) {
514 my $real_name = $1;
515 my $real_address = $2;
516 my $wrong_name = $3;
517 my $wrong_address = $4;
518
519 $real_name =~ s/\s+$//;
520 ($real_name, $real_address) =
521 parse_email("$real_name <$real_address>");
522
523 $wrong_name =~ s/\s+$//;
524 ($wrong_name, $wrong_address) =
525 parse_email("$wrong_name <$wrong_address>");
526
527 my $wrong_email = format_email($wrong_name, $wrong_address, 1);
528 $mailmap->{names}->{$wrong_email} = $real_name;
529 $mailmap->{addresses}->{$wrong_email} = $real_address;
530 }
531 }
532 close($mailmap_file);
533}
534
535## use the filenames on the command line or find the filenames in the patchfiles
536
537if (!@ARGV) {
538 push(@ARGV, "&STDIN");
539}
540
541foreach my $file (@ARGV) {
542 if ($file ne "&STDIN") {
543 $file = canonpath($file);
544 ##if $file is a directory and it lacks a trailing slash, add one
545 if ((-d $file)) {
546 $file =~ s@([^/])$@$1/@;
547 } elsif (!(-f $file)) {
548 die "$P: file '${file}' not found\n";
549 }
550 }
551 if ($from_filename && (vcs_exists() && !vcs_file_exists($file))) {
552 warn "$P: file '$file' not found in version control $!\n";
553 }
554 if ($from_filename || ($file ne "&STDIN" && vcs_file_exists($file))) {
555 $file =~ s/^\Q${cur_path}\E//; #strip any absolute path
556 $file =~ s/^\Q${lk_path}\E//; #or the path to the lk tree
557 push(@files, $file);
558 if ($file ne "MAINTAINERS" && -f $file && $keywords && $keywords_in_file) {
559 open(my $f, '<', $file)
560 or die "$P: Can't open $file: $!\n";
561 my $text = do { local($/) ; <$f> };
562 close($f);
563 foreach my $line (keys %keyword_hash) {
564 if ($text =~ m/$keyword_hash{$line}/x) {
565 push(@keyword_tvi, $line);
566 }
567 }
568 }
569 } else {
570 my $file_cnt = @files;
571 my $lastfile;
572
573 open(my $patch, "< $file")
574 or die "$P: Can't open $file: $!\n";
575
576 # We can check arbitrary information before the patch
577 # like the commit message, mail headers, etc...
578 # This allows us to match arbitrary keywords against any part
579 # of a git format-patch generated file (subject tags, etc...)
580
581 my $patch_prefix = ""; #Parsing the intro
582
583 while (<$patch>) {
584 my $patch_line = $_;
585 if (m/^ mode change [0-7]+ => [0-7]+ (\S+)\s*$/) {
586 my $filename = $1;
587 push(@files, $filename);
588 } elsif (m/^rename (?:from|to) (\S+)\s*$/) {
589 my $filename = $1;
590 push(@files, $filename);
591 } elsif (m/^diff --git a\/(\S+) b\/(\S+)\s*$/) {
592 my $filename1 = $1;
593 my $filename2 = $2;
594 push(@files, $filename1);
595 push(@files, $filename2);
596 } elsif (m/^Fixes:\s+([0-9a-fA-F]{6,40})/) {
597 push(@fixes, $1) if ($email_fixes);
598 } elsif (m/^\+\+\+\s+(\S+)/ or m/^---\s+(\S+)/) {
599 my $filename = $1;
600 $filename =~ s@^[^/]*/@@;
601 $filename =~ s@\n@@;
602 $lastfile = $filename;
603 push(@files, $filename);
604 $patch_prefix = "^[+-].*"; #Now parsing the actual patch
605 } elsif (m/^\@\@ -(\d+),(\d+)/) {
606 if ($email_git_blame) {
607 push(@range, "$lastfile:$1:$2");
608 }
609 } elsif ($keywords) {
610 foreach my $line (keys %keyword_hash) {
611 if ($patch_line =~ m/${patch_prefix}$keyword_hash{$line}/x) {
612 push(@keyword_tvi, $line);
613 }
614 }
615 }
616 }
617 close($patch);
618
619 if ($file_cnt == @files) {
620 warn "$P: file '${file}' doesn't appear to be a patch. "
621 . "Add -f to options?\n";
622 }
623 @files = sort_and_uniq(@files);
624 }
625}
626
627@file_emails = uniq(@file_emails);
628@fixes = uniq(@fixes);
629
630my %email_hash_name;
631my %email_hash_address;
632my @email_to = ();
633my %hash_list_to;
634my @list_to = ();
635my @scm = ();
636my @web = ();
637my @bug = ();
638my @subsystem = ();
639my @status = ();
640my %deduplicate_name_hash = ();
641my %deduplicate_address_hash = ();
642
643my @maintainers = get_maintainers();
644if (@maintainers) {
645 @maintainers = merge_email(@maintainers);
646 output(@maintainers);
647}
648
649if ($scm) {
650 @scm = uniq(@scm);
651 output(@scm);
652}
653
654if ($status) {
655 @status = uniq(@status);
656 output(@status);
657}
658
659if ($subsystem) {
660 @subsystem = uniq(@subsystem);
661 output(@subsystem);
662}
663
664if ($web) {
665 @web = uniq(@web);
666 output(@web);
667}
668
669if ($bug) {
670 @bug = uniq(@bug);
671 output(@bug);
672}
673
674exit($exit);
675
676sub self_test {
677 my @lsfiles = ();
678 my @good_links = ();
679 my @bad_links = ();
680 my @section_headers = ();
681 my $index = 0;
682
683 @lsfiles = vcs_list_files($lk_path);
684
685 for my $x (@self_test_info) {
686 $index++;
687
688 ## Section header duplication and missing section content
689 if (($self_test eq "" || $self_test =~ /\bsections\b/) &&
690 $x->{line} =~ /^\S[^:]/ &&
691 defined $self_test_info[$index] &&
692 $self_test_info[$index]->{line} =~ /^([A-Z]):\s*\S/) {
693 my $has_S = 0;
694 my $has_F = 0;
695 my $has_ML = 0;
696 my $status = "";
697 if (grep(m@^\Q$x->{line}\E@, @section_headers)) {
698 print("$x->{file}:$x->{linenr}: warning: duplicate section header\t$x->{line}\n");
699 } else {
700 push(@section_headers, $x->{line});
701 }
702 my $nextline = $index;
703 while (defined $self_test_info[$nextline] &&
704 $self_test_info[$nextline]->{line} =~ /^([A-Z]):\s*(\S.*)/) {
705 my $type = $1;
706 my $value = $2;
707 if ($type eq "S") {
708 $has_S = 1;
709 $status = $value;
710 } elsif ($type eq "F" || $type eq "N") {
711 $has_F = 1;
712 } elsif ($type eq "M" || $type eq "R" || $type eq "L") {
713 $has_ML = 1;
714 }
715 $nextline++;
716 }
717 if (!$has_ML && $status !~ /orphan|obsolete/i) {
718 print("$x->{file}:$x->{linenr}: warning: section without email address\t$x->{line}\n");
719 }
720 if (!$has_S) {
721 print("$x->{file}:$x->{linenr}: warning: section without status \t$x->{line}\n");
722 }
723 if (!$has_F) {
724 print("$x->{file}:$x->{linenr}: warning: section without file pattern\t$x->{line}\n");
725 }
726 }
727
728 next if ($x->{line} !~ /^([A-Z]):\s*(.*)/);
729
730 my $type = $1;
731 my $value = $2;
732
733 ## Filename pattern matching
734 if (($type eq "F" || $type eq "X") &&
735 ($self_test eq "" || $self_test =~ /\bpatterns\b/)) {
736 $value =~ s@\.@\\\.@g; ##Convert . to \.
737 $value =~ s/\*/\.\*/g; ##Convert * to .*
738 $value =~ s/\?/\./g; ##Convert ? to .
739 ##if pattern is a directory and it lacks a trailing slash, add one
740 if ((-d $value)) {
741 $value =~ s@([^/])$@$1/@;
742 }
743 if (!grep(m@^$value@, @lsfiles)) {
744 print("$x->{file}:$x->{linenr}: warning: no file matches\t$x->{line}\n");
745 }
746
747 ## Link reachability
748 } elsif (($type eq "W" || $type eq "Q" || $type eq "B") &&
749 $value =~ /^https?:/ &&
750 ($self_test eq "" || $self_test =~ /\blinks\b/)) {
751 next if (grep(m@^\Q$value\E$@, @good_links));
752 my $isbad = 0;
753 if (grep(m@^\Q$value\E$@, @bad_links)) {
754 $isbad = 1;
755 } else {
756 my $output = `wget --spider -q --no-check-certificate --timeout 10 --tries 1 $value`;
757 if ($? == 0) {
758 push(@good_links, $value);
759 } else {
760 push(@bad_links, $value);
761 $isbad = 1;
762 }
763 }
764 if ($isbad) {
765 print("$x->{file}:$x->{linenr}: warning: possible bad link\t$x->{line}\n");
766 }
767
768 ## SCM reachability
769 } elsif ($type eq "T" &&
770 ($self_test eq "" || $self_test =~ /\bscm\b/)) {
771 next if (grep(m@^\Q$value\E$@, @good_links));
772 my $isbad = 0;
773 if (grep(m@^\Q$value\E$@, @bad_links)) {
774 $isbad = 1;
775 } elsif ($value !~ /^(?:git|quilt|hg)\s+\S/) {
776 print("$x->{file}:$x->{linenr}: warning: malformed entry\t$x->{line}\n");
777 } elsif ($value =~ /^git\s+(\S+)(\s+([^\(]+\S+))?/) {
778 my $url = $1;
779 my $branch = "";
780 $branch = $3 if $3;
781 my $output = `git ls-remote --exit-code -h "$url" $branch > /dev/null 2>&1`;
782 if ($? == 0) {
783 push(@good_links, $value);
784 } else {
785 push(@bad_links, $value);
786 $isbad = 1;
787 }
788 } elsif ($value =~ /^(?:quilt|hg)\s+(https?:\S+)/) {
789 my $url = $1;
790 my $output = `wget --spider -q --no-check-certificate --timeout 10 --tries 1 $url`;
791 if ($? == 0) {
792 push(@good_links, $value);
793 } else {
794 push(@bad_links, $value);
795 $isbad = 1;
796 }
797 }
798 if ($isbad) {
799 print("$x->{file}:$x->{linenr}: warning: possible bad link\t$x->{line}\n");
800 }
801 }
802 }
803}
804
805sub ignore_email_address {
806 my ($address) = @_;
807
808 foreach my $ignore (@ignore_emails) {
809 return 1 if ($ignore eq $address);
810 }
811
812 return 0;
813}
814
815sub range_is_maintained {
816 my ($start, $end) = @_;
817
818 for (my $i = $start; $i < $end; $i++) {
819 my $line = $typevalue[$i];
820 if ($line =~ m/^([A-Z]):\s*(.*)/) {
821 my $type = $1;
822 my $value = $2;
823 if ($type eq 'S') {
824 if ($value =~ /(maintain|support)/i) {
825 return 1;
826 }
827 }
828 }
829 }
830 return 0;
831}
832
833sub range_has_maintainer {
834 my ($start, $end) = @_;
835
836 for (my $i = $start; $i < $end; $i++) {
837 my $line = $typevalue[$i];
838 if ($line =~ m/^([A-Z]):\s*(.*)/) {
839 my $type = $1;
840 my $value = $2;
841 if ($type eq 'M') {
842 return 1;
843 }
844 }
845 }
846 return 0;
847}
848
849sub get_maintainers {
850 %email_hash_name = ();
851 %email_hash_address = ();
852 %commit_author_hash = ();
853 %commit_signer_hash = ();
854 @email_to = ();
855 %hash_list_to = ();
856 @list_to = ();
857 @scm = ();
858 @web = ();
859 @bug = ();
860 @subsystem = ();
861 @status = ();
862 %deduplicate_name_hash = ();
863 %deduplicate_address_hash = ();
864 if ($email_git_all_signature_types) {
865 $signature_pattern = "(.+?)[Bb][Yy]:";
866 } else {
867 $signature_pattern = "\(" . join("|", @signature_tags) . "\)";
868 }
869
870 # Find responsible parties
871
872 my %exact_pattern_match_hash = ();
873
874 foreach my $file (@files) {
875
876 my %hash;
877 my $tvi = find_first_section();
878 while ($tvi < @typevalue) {
879 my $start = find_starting_index($tvi);
880 my $end = find_ending_index($tvi);
881 my $exclude = 0;
882 my $i;
883
884 #Do not match excluded file patterns
885
886 for ($i = $start; $i < $end; $i++) {
887 my $line = $typevalue[$i];
888 if ($line =~ m/^([A-Z]):\s*(.*)/) {
889 my $type = $1;
890 my $value = $2;
891 if ($type eq 'X') {
892 if (file_match_pattern($file, $value)) {
893 $exclude = 1;
894 last;
895 }
896 }
897 }
898 }
899
900 if (!$exclude) {
901 for ($i = $start; $i < $end; $i++) {
902 my $line = $typevalue[$i];
903 if ($line =~ m/^([A-Z]):\s*(.*)/) {
904 my $type = $1;
905 my $value = $2;
906 if ($type eq 'F') {
907 if (file_match_pattern($file, $value)) {
908 my $value_pd = ($value =~ tr@/@@);
909 my $file_pd = ($file =~ tr@/@@);
910 $value_pd++ if (substr($value,-1,1) ne "/");
911 $value_pd = -1 if ($value =~ /^\.\*/);
912 if ($value_pd >= $file_pd &&
913 range_is_maintained($start, $end) &&
914 range_has_maintainer($start, $end)) {
915 $exact_pattern_match_hash{$file} = 1;
916 }
917 if ($pattern_depth == 0 ||
918 (($file_pd - $value_pd) < $pattern_depth)) {
919 $hash{$tvi} = $value_pd;
920 }
921 }
922 } elsif ($type eq 'N') {
923 if ($file =~ m/$value/x) {
924 $hash{$tvi} = 0;
925 }
926 }
927 }
928 }
929 }
930 $tvi = $end + 1;
931 }
932
933 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
934 add_categories($line, "");
935 if ($sections) {
936 my $i;
937 my $start = find_starting_index($line);
938 my $end = find_ending_index($line);
939 for ($i = $start; $i < $end; $i++) {
940 my $line = $typevalue[$i];
941 if ($line =~ /^[FX]:/) { ##Restore file patterns
942 $line =~ s/([^\\])\.([^\*])/$1\?$2/g;
943 $line =~ s/([^\\])\.$/$1\?/g; ##Convert . back to ?
944 $line =~ s/\\\./\./g; ##Convert \. to .
945 $line =~ s/\.\*/\*/g; ##Convert .* to *
946 }
947 my $count = $line =~ s/^([A-Z]):/$1:\t/g;
948 if ($letters eq "" || (!$count || $letters =~ /$1/i)) {
949 print("$line\n");
950 }
951 }
952 print("\n");
953 }
954 }
955
956 maintainers_in_file($file);
957 }
958
959 if ($keywords) {
960 @keyword_tvi = sort_and_uniq(@keyword_tvi);
961 foreach my $line (@keyword_tvi) {
962 add_categories($line, ":Keyword:$keyword_hash{$line}");
963 }
964 }
965
966 foreach my $email (@email_to, @list_to) {
967 $email->[0] = deduplicate_email($email->[0]);
968 }
969
970 foreach my $file (@files) {
971 if ($email &&
972 ($email_git ||
973 ($email_git_fallback &&
974 $file !~ /MAINTAINERS$/ &&
975 !$exact_pattern_match_hash{$file}))) {
976 vcs_file_signoffs($file);
977 }
978 if ($email && $email_git_blame) {
979 vcs_file_blame($file);
980 }
981 }
982
983 if ($email) {
984 foreach my $chief (@penguin_chief) {
985 if ($chief =~ m/^(.*):(.*)/) {
986 my $email_address;
987
988 $email_address = format_email($1, $2, $email_usename);
989 if ($email_git_penguin_chiefs) {
990 push(@email_to, [$email_address, 'chief penguin']);
991 } else {
992 @email_to = grep($_->[0] !~ /${email_address}/, @email_to);
993 }
994 }
995 }
996
997 foreach my $email (@file_emails) {
998 $email = mailmap_email($email);
999 my ($name, $address) = parse_email($email);
1000
1001 my $tmp_email = format_email($name, $address, $email_usename);
1002 push_email_address($tmp_email, '');
1003 add_role($tmp_email, 'in file');
1004 }
1005 }
1006
1007 foreach my $fix (@fixes) {
1008 vcs_add_commit_signers($fix, "blamed_fixes");
1009 }
1010
1011 my @to = ();
1012 if ($email || $email_list) {
1013 if ($email) {
1014 @to = (@to, @email_to);
1015 }
1016 if ($email_list) {
1017 @to = (@to, @list_to);
1018 }
1019 }
1020
1021 if ($interactive) {
1022 @to = interactive_get_maintainers(\@to);
1023 }
1024
1025 return @to;
1026}
1027
1028sub file_match_pattern {
1029 my ($file, $pattern) = @_;
1030 if (substr($pattern, -1) eq "/") {
1031 if ($file =~ m@^$pattern@) {
1032 return 1;
1033 }
1034 } else {
1035 if ($file =~ m@^$pattern@) {
1036 my $s1 = ($file =~ tr@/@@);
1037 my $s2 = ($pattern =~ tr@/@@);
1038 if ($s1 == $s2) {
1039 return 1;
1040 }
1041 }
1042 }
1043 return 0;
1044}
1045
1046sub usage {
1047 print <<EOT;
1048usage: $P [options] patchfile
1049 $P [options] -f file|directory
1050version: $V
1051
1052MAINTAINER field selection options:
1053 --email => print email address(es) if any
1054 --git => include recent git \*-by: signers
1055 --git-all-signature-types => include signers regardless of signature type
1056 or use only ${signature_pattern} signers (default: $email_git_all_signature_types)
1057 --git-fallback => use git when no exact MAINTAINERS pattern (default: $email_git_fallback)
1058 --git-chief-penguins => include ${penguin_chiefs}
1059 --git-min-signatures => number of signatures required (default: $email_git_min_signatures)
1060 --git-max-maintainers => maximum maintainers to add (default: $email_git_max_maintainers)
1061 --git-min-percent => minimum percentage of commits required (default: $email_git_min_percent)
1062 --git-blame => use git blame to find modified commits for patch or file
1063 --git-blame-signatures => when used with --git-blame, also include all commit signers
1064 --git-since => git history to use (default: $email_git_since)
1065 --hg-since => hg history to use (default: $email_hg_since)
1066 --interactive => display a menu (mostly useful if used with the --git option)
1067 --m => include maintainer(s) if any
1068 --r => include reviewer(s) if any
1069 --n => include name 'Full Name <addr\@domain.tld>'
1070 --l => include list(s) if any
1071 --moderated => include moderated lists(s) if any (default: true)
1072 --s => include subscriber only list(s) if any (default: false)
1073 --remove-duplicates => minimize duplicate email names/addresses
1074 --roles => show roles (status:subsystem, git-signer, list, etc...)
1075 --rolestats => show roles and statistics (commits/total_commits, %)
1076 --file-emails => add email addresses found in -f file (default: 0 (off))
1077 --fixes => for patches, add signatures of commits with 'Fixes: <commit>' (default: 1 (on))
1078 --scm => print SCM tree(s) if any
1079 --status => print status if any
1080 --subsystem => print subsystem name if any
1081 --web => print website(s) if any
1082 --bug => print bug reporting info if any
1083
1084Output type options:
1085 --separator [, ] => separator for multiple entries on 1 line
1086 using --separator also sets --nomultiline if --separator is not [, ]
1087 --multiline => print 1 entry per line
1088
1089Other options:
1090 --pattern-depth => Number of pattern directory traversals (default: 0 (all))
1091 --keywords => scan patch for keywords (default: $keywords)
1092 --keywords-in-file => scan file for keywords (default: $keywords_in_file)
1093 --sections => print all of the subsystem sections with pattern matches
1094 --letters => print all matching 'letter' types from all matching sections
1095 --mailmap => use .mailmap file (default: $email_use_mailmap)
1096 --no-tree => run without a kernel tree
1097 --self-test => show potential issues with MAINTAINERS file content
1098 --version => show version
1099 --help => show this help information
1100
1101Default options:
1102 [--email --tree --nogit --git-fallback --m --r --n --l --multiline
1103 --pattern-depth=0 --remove-duplicates --rolestats --keywords]
1104
1105Notes:
1106 Using "-f directory" may give unexpected results:
1107 Used with "--git", git signators for _all_ files in and below
1108 directory are examined as git recurses directories.
1109 Any specified X: (exclude) pattern matches are _not_ ignored.
1110 Used with "--nogit", directory is used as a pattern match,
1111 no individual file within the directory or subdirectory
1112 is matched.
1113 Used with "--git-blame", does not iterate all files in directory
1114 Using "--git-blame" is slow and may add old committers and authors
1115 that are no longer active maintainers to the output.
1116 Using "--roles" or "--rolestats" with git send-email --cc-cmd or any
1117 other automated tools that expect only ["name"] <email address>
1118 may not work because of additional output after <email address>.
1119 Using "--rolestats" and "--git-blame" shows the #/total=% commits,
1120 not the percentage of the entire file authored. # of commits is
1121 not a good measure of amount of code authored. 1 major commit may
1122 contain a thousand lines, 5 trivial commits may modify a single line.
1123 If git is not installed, but mercurial (hg) is installed and an .hg
1124 repository exists, the following options apply to mercurial:
1125 --git,
1126 --git-min-signatures, --git-max-maintainers, --git-min-percent, and
1127 --git-blame
1128 Use --hg-since not --git-since to control date selection
1129 File ".get_maintainer.conf", if it exists in the linux kernel source root
1130 directory, can change whatever get_maintainer defaults are desired.
1131 Entries in this file can be any command line argument.
1132 This file is prepended to any additional command line arguments.
1133 Multiple lines and # comments are allowed.
1134 Most options have both positive and negative forms.
1135 The negative forms for --<foo> are --no<foo> and --no-<foo>.
1136
1137EOT
1138}
1139
1140sub top_of_kernel_tree {
1141 my ($lk_path) = @_;
1142
1143 if ($lk_path ne "" && substr($lk_path,length($lk_path)-1,1) ne "/") {
1144 $lk_path .= "/";
1145 }
1146 if ( (-f "${lk_path}COPYING")
1147 && (-f "${lk_path}CREDITS")
1148 && (-f "${lk_path}Kbuild")
1149 && (-e "${lk_path}MAINTAINERS")
1150 && (-f "${lk_path}Makefile")
1151 && (-f "${lk_path}README")
1152 && (-d "${lk_path}Documentation")
1153 && (-d "${lk_path}arch")
1154 && (-d "${lk_path}include")
1155 && (-d "${lk_path}drivers")
1156 && (-d "${lk_path}fs")
1157 && (-d "${lk_path}init")
1158 && (-d "${lk_path}ipc")
1159 && (-d "${lk_path}kernel")
1160 && (-d "${lk_path}lib")
1161 && (-d "${lk_path}scripts")) {
1162 return 1;
1163 }
1164 return 0;
1165}
1166
1167sub escape_name {
1168 my ($name) = @_;
1169
1170 if ($name =~ /[^\w \-]/ai) { ##has "must quote" chars
1171 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1172 $name = "\"$name\"";
1173 }
1174
1175 return $name;
1176}
1177
1178sub parse_email {
1179 my ($formatted_email) = @_;
1180
1181 my $name = "";
1182 my $address = "";
1183
1184 if ($formatted_email =~ /^([^<]+)<(.+\@.*)>.*$/) {
1185 $name = $1;
1186 $address = $2;
1187 } elsif ($formatted_email =~ /^\s*<(.+\@\S*)>.*$/) {
1188 $address = $1;
1189 } elsif ($formatted_email =~ /^(.+\@\S*).*$/) {
1190 $address = $1;
1191 }
1192
1193 $name =~ s/^\s+|\s+$//g;
1194 $name =~ s/^\"|\"$//g;
1195 $name = escape_name($name);
1196 $address =~ s/^\s+|\s+$//g;
1197
1198 return ($name, $address);
1199}
1200
1201sub format_email {
1202 my ($name, $address, $usename) = @_;
1203
1204 my $formatted_email;
1205
1206 $name =~ s/^\s+|\s+$//g;
1207 $name =~ s/^\"|\"$//g;
1208 $name = escape_name($name);
1209 $address =~ s/^\s+|\s+$//g;
1210
1211 if ($usename) {
1212 if ("$name" eq "") {
1213 $formatted_email = "$address";
1214 } else {
1215 $formatted_email = "$name <$address>";
1216 }
1217 } else {
1218 $formatted_email = $address;
1219 }
1220
1221 return $formatted_email;
1222}
1223
1224sub find_first_section {
1225 my $index = 0;
1226
1227 while ($index < @typevalue) {
1228 my $tv = $typevalue[$index];
1229 if (($tv =~ m/^([A-Z]):\s*(.*)/)) {
1230 last;
1231 }
1232 $index++;
1233 }
1234
1235 return $index;
1236}
1237
1238sub find_starting_index {
1239 my ($index) = @_;
1240
1241 while ($index > 0) {
1242 my $tv = $typevalue[$index];
1243 if (!($tv =~ m/^([A-Z]):\s*(.*)/)) {
1244 last;
1245 }
1246 $index--;
1247 }
1248
1249 return $index;
1250}
1251
1252sub find_ending_index {
1253 my ($index) = @_;
1254
1255 while ($index < @typevalue) {
1256 my $tv = $typevalue[$index];
1257 if (!($tv =~ m/^([A-Z]):\s*(.*)/)) {
1258 last;
1259 }
1260 $index++;
1261 }
1262
1263 return $index;
1264}
1265
1266sub get_subsystem_name {
1267 my ($index) = @_;
1268
1269 my $start = find_starting_index($index);
1270
1271 my $subsystem = $typevalue[$start];
1272 if ($output_section_maxlen && length($subsystem) > $output_section_maxlen) {
1273 $subsystem = substr($subsystem, 0, $output_section_maxlen - 3);
1274 $subsystem =~ s/\s*$//;
1275 $subsystem = $subsystem . "...";
1276 }
1277 return $subsystem;
1278}
1279
1280sub get_maintainer_role {
1281 my ($index) = @_;
1282
1283 my $i;
1284 my $start = find_starting_index($index);
1285 my $end = find_ending_index($index);
1286
1287 my $role = "unknown";
1288 my $subsystem = get_subsystem_name($index);
1289
1290 for ($i = $start + 1; $i < $end; $i++) {
1291 my $tv = $typevalue[$i];
1292 if ($tv =~ m/^([A-Z]):\s*(.*)/) {
1293 my $ptype = $1;
1294 my $pvalue = $2;
1295 if ($ptype eq "S") {
1296 $role = $pvalue;
1297 }
1298 }
1299 }
1300
1301 $role = lc($role);
1302 if ($role eq "supported") {
1303 $role = "supporter";
1304 } elsif ($role eq "maintained") {
1305 $role = "maintainer";
1306 } elsif ($role eq "odd fixes") {
1307 $role = "odd fixer";
1308 } elsif ($role eq "orphan") {
1309 $role = "orphan minder";
1310 } elsif ($role eq "obsolete") {
1311 $role = "obsolete minder";
1312 } elsif ($role eq "buried alive in reporters") {
1313 $role = "chief penguin";
1314 }
1315
1316 return $role . ":" . $subsystem;
1317}
1318
1319sub get_list_role {
1320 my ($index) = @_;
1321
1322 my $subsystem = get_subsystem_name($index);
1323
1324 if ($subsystem eq "THE REST") {
1325 $subsystem = "";
1326 }
1327
1328 return $subsystem;
1329}
1330
1331sub add_categories {
1332 my ($index, $suffix) = @_;
1333
1334 my $i;
1335 my $start = find_starting_index($index);
1336 my $end = find_ending_index($index);
1337
1338 push(@subsystem, $typevalue[$start]);
1339
1340 for ($i = $start + 1; $i < $end; $i++) {
1341 my $tv = $typevalue[$i];
1342 if ($tv =~ m/^([A-Z]):\s*(.*)/) {
1343 my $ptype = $1;
1344 my $pvalue = $2;
1345 if ($ptype eq "L") {
1346 my $list_address = $pvalue;
1347 my $list_additional = "";
1348 my $list_role = get_list_role($i);
1349
1350 if ($list_role ne "") {
1351 $list_role = ":" . $list_role;
1352 }
1353 if ($list_address =~ m/([^\s]+)\s+(.*)$/) {
1354 $list_address = $1;
1355 $list_additional = $2;
1356 }
1357 if ($list_additional =~ m/subscribers-only/) {
1358 if ($email_subscriber_list) {
1359 if (!$hash_list_to{lc($list_address)}) {
1360 $hash_list_to{lc($list_address)} = 1;
1361 push(@list_to, [$list_address,
1362 "subscriber list${list_role}" . $suffix]);
1363 }
1364 }
1365 } else {
1366 if ($email_list) {
1367 if (!$hash_list_to{lc($list_address)}) {
1368 if ($list_additional =~ m/moderated/) {
1369 if ($email_moderated_list) {
1370 $hash_list_to{lc($list_address)} = 1;
1371 push(@list_to, [$list_address,
1372 "moderated list${list_role}" . $suffix]);
1373 }
1374 } else {
1375 $hash_list_to{lc($list_address)} = 1;
1376 push(@list_to, [$list_address,
1377 "open list${list_role}" . $suffix]);
1378 }
1379 }
1380 }
1381 }
1382 } elsif ($ptype eq "M") {
1383 if ($email_maintainer) {
1384 my $role = get_maintainer_role($i);
1385 push_email_addresses($pvalue, $role . $suffix);
1386 }
1387 } elsif ($ptype eq "R") {
1388 if ($email_reviewer) {
1389 my $subsystem = get_subsystem_name($i);
1390 push_email_addresses($pvalue, "reviewer:$subsystem" . $suffix);
1391 }
1392 } elsif ($ptype eq "T") {
1393 push(@scm, $pvalue . $suffix);
1394 } elsif ($ptype eq "W") {
1395 push(@web, $pvalue . $suffix);
1396 } elsif ($ptype eq "B") {
1397 push(@bug, $pvalue . $suffix);
1398 } elsif ($ptype eq "S") {
1399 push(@status, $pvalue . $suffix);
1400 }
1401 }
1402 }
1403}
1404
1405sub email_inuse {
1406 my ($name, $address) = @_;
1407
1408 return 1 if (($name eq "") && ($address eq ""));
1409 return 1 if (($name ne "") && exists($email_hash_name{lc($name)}));
1410 return 1 if (($address ne "") && exists($email_hash_address{lc($address)}));
1411
1412 return 0;
1413}
1414
1415sub push_email_address {
1416 my ($line, $role) = @_;
1417
1418 my ($name, $address) = parse_email($line);
1419
1420 if ($address eq "") {
1421 return 0;
1422 }
1423
1424 if (!$email_remove_duplicates) {
1425 push(@email_to, [format_email($name, $address, $email_usename), $role]);
1426 } elsif (!email_inuse($name, $address)) {
1427 push(@email_to, [format_email($name, $address, $email_usename), $role]);
1428 $email_hash_name{lc($name)}++ if ($name ne "");
1429 $email_hash_address{lc($address)}++;
1430 }
1431
1432 return 1;
1433}
1434
1435sub push_email_addresses {
1436 my ($address, $role) = @_;
1437
1438 my @address_list = ();
1439
1440 if (rfc822_valid($address)) {
1441 push_email_address($address, $role);
1442 } elsif (@address_list = rfc822_validlist($address)) {
1443 my $array_count = shift(@address_list);
1444 while (my $entry = shift(@address_list)) {
1445 push_email_address($entry, $role);
1446 }
1447 } else {
1448 if (!push_email_address($address, $role)) {
1449 warn("Invalid MAINTAINERS address: '" . $address . "'\n");
1450 }
1451 }
1452}
1453
1454sub add_role {
1455 my ($line, $role) = @_;
1456
1457 my ($name, $address) = parse_email($line);
1458 my $email = format_email($name, $address, $email_usename);
1459
1460 foreach my $entry (@email_to) {
1461 if ($email_remove_duplicates) {
1462 my ($entry_name, $entry_address) = parse_email($entry->[0]);
1463 if (($name eq $entry_name || $address eq $entry_address)
1464 && ($role eq "" || !($entry->[1] =~ m/$role/))
1465 ) {
1466 if ($entry->[1] eq "") {
1467 $entry->[1] = "$role";
1468 } else {
1469 $entry->[1] = "$entry->[1],$role";
1470 }
1471 }
1472 } else {
1473 if ($email eq $entry->[0]
1474 && ($role eq "" || !($entry->[1] =~ m/$role/))
1475 ) {
1476 if ($entry->[1] eq "") {
1477 $entry->[1] = "$role";
1478 } else {
1479 $entry->[1] = "$entry->[1],$role";
1480 }
1481 }
1482 }
1483 }
1484}
1485
1486sub which {
1487 my ($bin) = @_;
1488
1489 foreach my $path (split(/:/, $ENV{PATH})) {
1490 if (-e "$path/$bin") {
1491 return "$path/$bin";
1492 }
1493 }
1494
1495 return "";
1496}
1497
1498sub which_conf {
1499 my ($conf) = @_;
1500
1501 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1502 if (-e "$path/$conf") {
1503 return "$path/$conf";
1504 }
1505 }
1506
1507 return "";
1508}
1509
1510sub mailmap_email {
1511 my ($line) = @_;
1512
1513 my ($name, $address) = parse_email($line);
1514 my $email = format_email($name, $address, 1);
1515 my $real_name = $name;
1516 my $real_address = $address;
1517
1518 if (exists $mailmap->{names}->{$email} ||
1519 exists $mailmap->{addresses}->{$email}) {
1520 if (exists $mailmap->{names}->{$email}) {
1521 $real_name = $mailmap->{names}->{$email};
1522 }
1523 if (exists $mailmap->{addresses}->{$email}) {
1524 $real_address = $mailmap->{addresses}->{$email};
1525 }
1526 } else {
1527 if (exists $mailmap->{names}->{$address}) {
1528 $real_name = $mailmap->{names}->{$address};
1529 }
1530 if (exists $mailmap->{addresses}->{$address}) {
1531 $real_address = $mailmap->{addresses}->{$address};
1532 }
1533 }
1534 return format_email($real_name, $real_address, 1);
1535}
1536
1537sub mailmap {
1538 my (@addresses) = @_;
1539
1540 my @mapped_emails = ();
1541 foreach my $line (@addresses) {
1542 push(@mapped_emails, mailmap_email($line));
1543 }
1544 merge_by_realname(@mapped_emails) if ($email_use_mailmap);
1545 return @mapped_emails;
1546}
1547
1548sub merge_by_realname {
1549 my %address_map;
1550 my (@emails) = @_;
1551
1552 foreach my $email (@emails) {
1553 my ($name, $address) = parse_email($email);
1554 if (exists $address_map{$name}) {
1555 $address = $address_map{$name};
1556 $email = format_email($name, $address, 1);
1557 } else {
1558 $address_map{$name} = $address;
1559 }
1560 }
1561}
1562
1563sub git_execute_cmd {
1564 my ($cmd) = @_;
1565 my @lines = ();
1566
1567 my $output = `$cmd`;
1568 $output =~ s/^\s*//gm;
1569 @lines = split("\n", $output);
1570
1571 return @lines;
1572}
1573
1574sub hg_execute_cmd {
1575 my ($cmd) = @_;
1576 my @lines = ();
1577
1578 my $output = `$cmd`;
1579 @lines = split("\n", $output);
1580
1581 return @lines;
1582}
1583
1584sub extract_formatted_signatures {
1585 my (@signature_lines) = @_;
1586
1587 my @type = @signature_lines;
1588
1589 s/\s*(.*):.*/$1/ for (@type);
1590
1591 # cut -f2- -d":"
1592 s/\s*.*:\s*(.+)\s*/$1/ for (@signature_lines);
1593
1594## Reformat email addresses (with names) to avoid badly written signatures
1595
1596 foreach my $signer (@signature_lines) {
1597 $signer = deduplicate_email($signer);
1598 }
1599
1600 return (\@type, \@signature_lines);
1601}
1602
1603sub vcs_find_signers {
1604 my ($cmd, $file) = @_;
1605 my $commits;
1606 my @lines = ();
1607 my @signatures = ();
1608 my @authors = ();
1609 my @stats = ();
1610
1611 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
1612
1613 my $pattern = $VCS_cmds{"commit_pattern"};
1614 my $author_pattern = $VCS_cmds{"author_pattern"};
1615 my $stat_pattern = $VCS_cmds{"stat_pattern"};
1616
1617 $stat_pattern =~ s/(\$\w+)/$1/eeg; #interpolate $stat_pattern
1618
1619 $commits = grep(/$pattern/, @lines); # of commits
1620
1621 @authors = grep(/$author_pattern/, @lines);
1622 @signatures = grep(/^[ \t]*${signature_pattern}.*\@.*$/, @lines);
1623 @stats = grep(/$stat_pattern/, @lines);
1624
1625# print("stats: <@stats>\n");
1626
1627 return (0, \@signatures, \@authors, \@stats) if !@signatures;
1628
1629 save_commits_by_author(@lines) if ($interactive);
1630 save_commits_by_signer(@lines) if ($interactive);
1631
1632 if (!$email_git_penguin_chiefs) {
1633 @signatures = grep(!/${penguin_chiefs}/i, @signatures);
1634 }
1635
1636 my ($author_ref, $authors_ref) = extract_formatted_signatures(@authors);
1637 my ($types_ref, $signers_ref) = extract_formatted_signatures(@signatures);
1638
1639 return ($commits, $signers_ref, $authors_ref, \@stats);
1640}
1641
1642sub vcs_find_author {
1643 my ($cmd) = @_;
1644 my @lines = ();
1645
1646 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
1647
1648 if (!$email_git_penguin_chiefs) {
1649 @lines = grep(!/${penguin_chiefs}/i, @lines);
1650 }
1651
1652 return @lines if !@lines;
1653
1654 my @authors = ();
1655 foreach my $line (@lines) {
1656 if ($line =~ m/$VCS_cmds{"author_pattern"}/) {
1657 my $author = $1;
1658 my ($name, $address) = parse_email($author);
1659 $author = format_email($name, $address, 1);
1660 push(@authors, $author);
1661 }
1662 }
1663
1664 save_commits_by_author(@lines) if ($interactive);
1665 save_commits_by_signer(@lines) if ($interactive);
1666
1667 return @authors;
1668}
1669
1670sub vcs_save_commits {
1671 my ($cmd) = @_;
1672 my @lines = ();
1673 my @commits = ();
1674
1675 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
1676
1677 foreach my $line (@lines) {
1678 if ($line =~ m/$VCS_cmds{"blame_commit_pattern"}/) {
1679 push(@commits, $1);
1680 }
1681 }
1682
1683 return @commits;
1684}
1685
1686sub vcs_blame {
1687 my ($file) = @_;
1688 my $cmd;
1689 my @commits = ();
1690
1691 return @commits if (!(-f $file));
1692
1693 if (@range && $VCS_cmds{"blame_range_cmd"} eq "") {
1694 my @all_commits = ();
1695
1696 $cmd = $VCS_cmds{"blame_file_cmd"};
1697 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
1698 @all_commits = vcs_save_commits($cmd);
1699
1700 foreach my $file_range_diff (@range) {
1701 next if (!($file_range_diff =~ m/(.+):(.+):(.+)/));
1702 my $diff_file = $1;
1703 my $diff_start = $2;
1704 my $diff_length = $3;
1705 next if ("$file" ne "$diff_file");
1706 for (my $i = $diff_start; $i < $diff_start + $diff_length; $i++) {
1707 push(@commits, $all_commits[$i]);
1708 }
1709 }
1710 } elsif (@range) {
1711 foreach my $file_range_diff (@range) {
1712 next if (!($file_range_diff =~ m/(.+):(.+):(.+)/));
1713 my $diff_file = $1;
1714 my $diff_start = $2;
1715 my $diff_length = $3;
1716 next if ("$file" ne "$diff_file");
1717 $cmd = $VCS_cmds{"blame_range_cmd"};
1718 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
1719 push(@commits, vcs_save_commits($cmd));
1720 }
1721 } else {
1722 $cmd = $VCS_cmds{"blame_file_cmd"};
1723 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
1724 @commits = vcs_save_commits($cmd);
1725 }
1726
1727 foreach my $commit (@commits) {
1728 $commit =~ s/^\^//g;
1729 }
1730
1731 return @commits;
1732}
1733
1734my $printed_novcs = 0;
1735sub vcs_exists {
1736 %VCS_cmds = %VCS_cmds_git;
1737 return 1 if eval $VCS_cmds{"available"};
1738 %VCS_cmds = %VCS_cmds_hg;
1739 return 2 if eval $VCS_cmds{"available"};
1740 %VCS_cmds = ();
1741 if (!$printed_novcs && $email_git) {
1742 warn("$P: No supported VCS found. Add --nogit to options?\n");
1743 warn("Using a git repository produces better results.\n");
1744 warn("Try Linus Torvalds' latest git repository using:\n");
1745 warn("git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git\n");
1746 $printed_novcs = 1;
1747 }
1748 return 0;
1749}
1750
1751sub vcs_is_git {
1752 vcs_exists();
1753 return $vcs_used == 1;
1754}
1755
1756sub vcs_is_hg {
1757 return $vcs_used == 2;
1758}
1759
1760sub vcs_add_commit_signers {
1761 return if (!vcs_exists());
1762
1763 my ($commit, $desc) = @_;
1764 my $commit_count = 0;
1765 my $commit_authors_ref;
1766 my $commit_signers_ref;
1767 my $stats_ref;
1768 my @commit_authors = ();
1769 my @commit_signers = ();
1770 my $cmd;
1771
1772 $cmd = $VCS_cmds{"find_commit_signers_cmd"};
1773 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
1774
1775 ($commit_count, $commit_signers_ref, $commit_authors_ref, $stats_ref) = vcs_find_signers($cmd, "");
1776 @commit_authors = @{$commit_authors_ref} if defined $commit_authors_ref;
1777 @commit_signers = @{$commit_signers_ref} if defined $commit_signers_ref;
1778
1779 foreach my $signer (@commit_signers) {
1780 $signer = deduplicate_email($signer);
1781 }
1782
1783 vcs_assign($desc, 1, @commit_signers);
1784}
1785
1786sub interactive_get_maintainers {
1787 my ($list_ref) = @_;
1788 my @list = @$list_ref;
1789
1790 vcs_exists();
1791
1792 my %selected;
1793 my %authored;
1794 my %signed;
1795 my $count = 0;
1796 my $maintained = 0;
1797 foreach my $entry (@list) {
1798 $maintained = 1 if ($entry->[1] =~ /^(maintainer|supporter)/i);
1799 $selected{$count} = 1;
1800 $authored{$count} = 0;
1801 $signed{$count} = 0;
1802 $count++;
1803 }
1804
1805 #menu loop
1806 my $done = 0;
1807 my $print_options = 0;
1808 my $redraw = 1;
1809 while (!$done) {
1810 $count = 0;
1811 if ($redraw) {
1812 printf STDERR "\n%1s %2s %-65s",
1813 "*", "#", "email/list and role:stats";
1814 if ($email_git ||
1815 ($email_git_fallback && !$maintained) ||
1816 $email_git_blame) {
1817 print STDERR "auth sign";
1818 }
1819 print STDERR "\n";
1820 foreach my $entry (@list) {
1821 my $email = $entry->[0];
1822 my $role = $entry->[1];
1823 my $sel = "";
1824 $sel = "*" if ($selected{$count});
1825 my $commit_author = $commit_author_hash{$email};
1826 my $commit_signer = $commit_signer_hash{$email};
1827 my $authored = 0;
1828 my $signed = 0;
1829 $authored++ for (@{$commit_author});
1830 $signed++ for (@{$commit_signer});
1831 printf STDERR "%1s %2d %-65s", $sel, $count + 1, $email;
1832 printf STDERR "%4d %4d", $authored, $signed
1833 if ($authored > 0 || $signed > 0);
1834 printf STDERR "\n %s\n", $role;
1835 if ($authored{$count}) {
1836 my $commit_author = $commit_author_hash{$email};
1837 foreach my $ref (@{$commit_author}) {
1838 print STDERR " Author: @{$ref}[1]\n";
1839 }
1840 }
1841 if ($signed{$count}) {
1842 my $commit_signer = $commit_signer_hash{$email};
1843 foreach my $ref (@{$commit_signer}) {
1844 print STDERR " @{$ref}[2]: @{$ref}[1]\n";
1845 }
1846 }
1847
1848 $count++;
1849 }
1850 }
1851 my $date_ref = \$email_git_since;
1852 $date_ref = \$email_hg_since if (vcs_is_hg());
1853 if ($print_options) {
1854 $print_options = 0;
1855 if (vcs_exists()) {
1856 print STDERR <<EOT
1857
1858Version Control options:
1859g use git history [$email_git]
1860gf use git-fallback [$email_git_fallback]
1861b use git blame [$email_git_blame]
1862bs use blame signatures [$email_git_blame_signatures]
1863c# minimum commits [$email_git_min_signatures]
1864%# min percent [$email_git_min_percent]
1865d# history to use [$$date_ref]
1866x# max maintainers [$email_git_max_maintainers]
1867t all signature types [$email_git_all_signature_types]
1868m use .mailmap [$email_use_mailmap]
1869EOT
1870 }
1871 print STDERR <<EOT
1872
1873Additional options:
18740 toggle all
1875tm toggle maintainers
1876tg toggle git entries
1877tl toggle open list entries
1878ts toggle subscriber list entries
1879f emails in file [$email_file_emails]
1880k keywords in file [$keywords]
1881r remove duplicates [$email_remove_duplicates]
1882p# pattern match depth [$pattern_depth]
1883EOT
1884 }
1885 print STDERR
1886"\n#(toggle), A#(author), S#(signed) *(all), ^(none), O(options), Y(approve): ";
1887
1888 my $input = <STDIN>;
1889 chomp($input);
1890
1891 $redraw = 1;
1892 my $rerun = 0;
1893 my @wish = split(/[, ]+/, $input);
1894 foreach my $nr (@wish) {
1895 $nr = lc($nr);
1896 my $sel = substr($nr, 0, 1);
1897 my $str = substr($nr, 1);
1898 my $val = 0;
1899 $val = $1 if $str =~ /^(\d+)$/;
1900
1901 if ($sel eq "y") {
1902 $interactive = 0;
1903 $done = 1;
1904 $output_rolestats = 0;
1905 $output_roles = 0;
1906 last;
1907 } elsif ($nr =~ /^\d+$/ && $nr > 0 && $nr <= $count) {
1908 $selected{$nr - 1} = !$selected{$nr - 1};
1909 } elsif ($sel eq "*" || $sel eq '^') {
1910 my $toggle = 0;
1911 $toggle = 1 if ($sel eq '*');
1912 for (my $i = 0; $i < $count; $i++) {
1913 $selected{$i} = $toggle;
1914 }
1915 } elsif ($sel eq "0") {
1916 for (my $i = 0; $i < $count; $i++) {
1917 $selected{$i} = !$selected{$i};
1918 }
1919 } elsif ($sel eq "t") {
1920 if (lc($str) eq "m") {
1921 for (my $i = 0; $i < $count; $i++) {
1922 $selected{$i} = !$selected{$i}
1923 if ($list[$i]->[1] =~ /^(maintainer|supporter)/i);
1924 }
1925 } elsif (lc($str) eq "g") {
1926 for (my $i = 0; $i < $count; $i++) {
1927 $selected{$i} = !$selected{$i}
1928 if ($list[$i]->[1] =~ /^(author|commit|signer)/i);
1929 }
1930 } elsif (lc($str) eq "l") {
1931 for (my $i = 0; $i < $count; $i++) {
1932 $selected{$i} = !$selected{$i}
1933 if ($list[$i]->[1] =~ /^(open list)/i);
1934 }
1935 } elsif (lc($str) eq "s") {
1936 for (my $i = 0; $i < $count; $i++) {
1937 $selected{$i} = !$selected{$i}
1938 if ($list[$i]->[1] =~ /^(subscriber list)/i);
1939 }
1940 }
1941 } elsif ($sel eq "a") {
1942 if ($val > 0 && $val <= $count) {
1943 $authored{$val - 1} = !$authored{$val - 1};
1944 } elsif ($str eq '*' || $str eq '^') {
1945 my $toggle = 0;
1946 $toggle = 1 if ($str eq '*');
1947 for (my $i = 0; $i < $count; $i++) {
1948 $authored{$i} = $toggle;
1949 }
1950 }
1951 } elsif ($sel eq "s") {
1952 if ($val > 0 && $val <= $count) {
1953 $signed{$val - 1} = !$signed{$val - 1};
1954 } elsif ($str eq '*' || $str eq '^') {
1955 my $toggle = 0;
1956 $toggle = 1 if ($str eq '*');
1957 for (my $i = 0; $i < $count; $i++) {
1958 $signed{$i} = $toggle;
1959 }
1960 }
1961 } elsif ($sel eq "o") {
1962 $print_options = 1;
1963 $redraw = 1;
1964 } elsif ($sel eq "g") {
1965 if ($str eq "f") {
1966 bool_invert(\$email_git_fallback);
1967 } else {
1968 bool_invert(\$email_git);
1969 }
1970 $rerun = 1;
1971 } elsif ($sel eq "b") {
1972 if ($str eq "s") {
1973 bool_invert(\$email_git_blame_signatures);
1974 } else {
1975 bool_invert(\$email_git_blame);
1976 }
1977 $rerun = 1;
1978 } elsif ($sel eq "c") {
1979 if ($val > 0) {
1980 $email_git_min_signatures = $val;
1981 $rerun = 1;
1982 }
1983 } elsif ($sel eq "x") {
1984 if ($val > 0) {
1985 $email_git_max_maintainers = $val;
1986 $rerun = 1;
1987 }
1988 } elsif ($sel eq "%") {
1989 if ($str ne "" && $val >= 0) {
1990 $email_git_min_percent = $val;
1991 $rerun = 1;
1992 }
1993 } elsif ($sel eq "d") {
1994 if (vcs_is_git()) {
1995 $email_git_since = $str;
1996 } elsif (vcs_is_hg()) {
1997 $email_hg_since = $str;
1998 }
1999 $rerun = 1;
2000 } elsif ($sel eq "t") {
2001 bool_invert(\$email_git_all_signature_types);
2002 $rerun = 1;
2003 } elsif ($sel eq "f") {
2004 bool_invert(\$email_file_emails);
2005 $rerun = 1;
2006 } elsif ($sel eq "r") {
2007 bool_invert(\$email_remove_duplicates);
2008 $rerun = 1;
2009 } elsif ($sel eq "m") {
2010 bool_invert(\$email_use_mailmap);
2011 read_mailmap();
2012 $rerun = 1;
2013 } elsif ($sel eq "k") {
2014 bool_invert(\$keywords);
2015 $rerun = 1;
2016 } elsif ($sel eq "p") {
2017 if ($str ne "" && $val >= 0) {
2018 $pattern_depth = $val;
2019 $rerun = 1;
2020 }
2021 } elsif ($sel eq "h" || $sel eq "?") {
2022 print STDERR <<EOT
2023
2024Interactive mode allows you to select the various maintainers, submitters,
2025commit signers and mailing lists that could be CC'd on a patch.
2026
2027Any *'d entry is selected.
2028
2029If you have git or hg installed, you can choose to summarize the commit
2030history of files in the patch. Also, each line of the current file can
2031be matched to its commit author and that commits signers with blame.
2032
2033Various knobs exist to control the length of time for active commit
2034tracking, the maximum number of commit authors and signers to add,
2035and such.
2036
2037Enter selections at the prompt until you are satisfied that the selected
2038maintainers are appropriate. You may enter multiple selections separated
2039by either commas or spaces.
2040
2041EOT
2042 } else {
2043 print STDERR "invalid option: '$nr'\n";
2044 $redraw = 0;
2045 }
2046 }
2047 if ($rerun) {
2048 print STDERR "git-blame can be very slow, please have patience..."
2049 if ($email_git_blame);
2050 goto &get_maintainers;
2051 }
2052 }
2053
2054 #drop not selected entries
2055 $count = 0;
2056 my @new_emailto = ();
2057 foreach my $entry (@list) {
2058 if ($selected{$count}) {
2059 push(@new_emailto, $list[$count]);
2060 }
2061 $count++;
2062 }
2063 return @new_emailto;
2064}
2065
2066sub bool_invert {
2067 my ($bool_ref) = @_;
2068
2069 if ($$bool_ref) {
2070 $$bool_ref = 0;
2071 } else {
2072 $$bool_ref = 1;
2073 }
2074}
2075
2076sub deduplicate_email {
2077 my ($email) = @_;
2078
2079 my $matched = 0;
2080 my ($name, $address) = parse_email($email);
2081 $email = format_email($name, $address, 1);
2082 $email = mailmap_email($email);
2083
2084 return $email if (!$email_remove_duplicates);
2085
2086 ($name, $address) = parse_email($email);
2087
2088 if ($name ne "" && $deduplicate_name_hash{lc($name)}) {
2089 $name = $deduplicate_name_hash{lc($name)}->[0];
2090 $address = $deduplicate_name_hash{lc($name)}->[1];
2091 $matched = 1;
2092 } elsif ($deduplicate_address_hash{lc($address)}) {
2093 $name = $deduplicate_address_hash{lc($address)}->[0];
2094 $address = $deduplicate_address_hash{lc($address)}->[1];
2095 $matched = 1;
2096 }
2097 if (!$matched) {
2098 $deduplicate_name_hash{lc($name)} = [ $name, $address ];
2099 $deduplicate_address_hash{lc($address)} = [ $name, $address ];
2100 }
2101 $email = format_email($name, $address, 1);
2102 $email = mailmap_email($email);
2103 return $email;
2104}
2105
2106sub save_commits_by_author {
2107 my (@lines) = @_;
2108
2109 my @authors = ();
2110 my @commits = ();
2111 my @subjects = ();
2112
2113 foreach my $line (@lines) {
2114 if ($line =~ m/$VCS_cmds{"author_pattern"}/) {
2115 my $author = $1;
2116 $author = deduplicate_email($author);
2117 push(@authors, $author);
2118 }
2119 push(@commits, $1) if ($line =~ m/$VCS_cmds{"commit_pattern"}/);
2120 push(@subjects, $1) if ($line =~ m/$VCS_cmds{"subject_pattern"}/);
2121 }
2122
2123 for (my $i = 0; $i < @authors; $i++) {
2124 my $exists = 0;
2125 foreach my $ref(@{$commit_author_hash{$authors[$i]}}) {
2126 if (@{$ref}[0] eq $commits[$i] &&
2127 @{$ref}[1] eq $subjects[$i]) {
2128 $exists = 1;
2129 last;
2130 }
2131 }
2132 if (!$exists) {
2133 push(@{$commit_author_hash{$authors[$i]}},
2134 [ ($commits[$i], $subjects[$i]) ]);
2135 }
2136 }
2137}
2138
2139sub save_commits_by_signer {
2140 my (@lines) = @_;
2141
2142 my $commit = "";
2143 my $subject = "";
2144
2145 foreach my $line (@lines) {
2146 $commit = $1 if ($line =~ m/$VCS_cmds{"commit_pattern"}/);
2147 $subject = $1 if ($line =~ m/$VCS_cmds{"subject_pattern"}/);
2148 if ($line =~ /^[ \t]*${signature_pattern}.*\@.*$/) {
2149 my @signatures = ($line);
2150 my ($types_ref, $signers_ref) = extract_formatted_signatures(@signatures);
2151 my @types = @$types_ref;
2152 my @signers = @$signers_ref;
2153
2154 my $type = $types[0];
2155 my $signer = $signers[0];
2156
2157 $signer = deduplicate_email($signer);
2158
2159 my $exists = 0;
2160 foreach my $ref(@{$commit_signer_hash{$signer}}) {
2161 if (@{$ref}[0] eq $commit &&
2162 @{$ref}[1] eq $subject &&
2163 @{$ref}[2] eq $type) {
2164 $exists = 1;
2165 last;
2166 }
2167 }
2168 if (!$exists) {
2169 push(@{$commit_signer_hash{$signer}},
2170 [ ($commit, $subject, $type) ]);
2171 }
2172 }
2173 }
2174}
2175
2176sub vcs_assign {
2177 my ($role, $divisor, @lines) = @_;
2178
2179 my %hash;
2180 my $count = 0;
2181
2182 return if (@lines <= 0);
2183
2184 if ($divisor <= 0) {
2185 warn("Bad divisor in " . (caller(0))[3] . ": $divisor\n");
2186 $divisor = 1;
2187 }
2188
2189 @lines = mailmap(@lines);
2190
2191 return if (@lines <= 0);
2192
2193 @lines = sort(@lines);
2194
2195 # uniq -c
2196 $hash{$_}++ for @lines;
2197
2198 # sort -rn
2199 foreach my $line (sort {$hash{$b} <=> $hash{$a}} keys %hash) {
2200 my $sign_offs = $hash{$line};
2201 my $percent = $sign_offs * 100 / $divisor;
2202
2203 $percent = 100 if ($percent > 100);
2204 next if (ignore_email_address($line));
2205 $count++;
2206 last if ($sign_offs < $email_git_min_signatures ||
2207 $count > $email_git_max_maintainers ||
2208 $percent < $email_git_min_percent);
2209 push_email_address($line, '');
2210 if ($output_rolestats) {
2211 my $fmt_percent = sprintf("%.0f", $percent);
2212 add_role($line, "$role:$sign_offs/$divisor=$fmt_percent%");
2213 } else {
2214 add_role($line, $role);
2215 }
2216 }
2217}
2218
2219sub vcs_file_signoffs {
2220 my ($file) = @_;
2221
2222 my $authors_ref;
2223 my $signers_ref;
2224 my $stats_ref;
2225 my @authors = ();
2226 my @signers = ();
2227 my @stats = ();
2228 my $commits;
2229
2230 $vcs_used = vcs_exists();
2231 return if (!$vcs_used);
2232
2233 my $cmd = $VCS_cmds{"find_signers_cmd"};
2234 $cmd =~ s/(\$\w+)/$1/eeg; # interpolate $cmd
2235
2236 ($commits, $signers_ref, $authors_ref, $stats_ref) = vcs_find_signers($cmd, $file);
2237
2238 @signers = @{$signers_ref} if defined $signers_ref;
2239 @authors = @{$authors_ref} if defined $authors_ref;
2240 @stats = @{$stats_ref} if defined $stats_ref;
2241
2242# print("commits: <$commits>\nsigners:<@signers>\nauthors: <@authors>\nstats: <@stats>\n");
2243
2244 foreach my $signer (@signers) {
2245 $signer = deduplicate_email($signer);
2246 }
2247
2248 vcs_assign("commit_signer", $commits, @signers);
2249 vcs_assign("authored", $commits, @authors);
2250 if ($#authors == $#stats) {
2251 my $stat_pattern = $VCS_cmds{"stat_pattern"};
2252 $stat_pattern =~ s/(\$\w+)/$1/eeg; #interpolate $stat_pattern
2253
2254 my $added = 0;
2255 my $deleted = 0;
2256 for (my $i = 0; $i <= $#stats; $i++) {
2257 if ($stats[$i] =~ /$stat_pattern/) {
2258 $added += $1;
2259 $deleted += $2;
2260 }
2261 }
2262 my @tmp_authors = uniq(@authors);
2263 foreach my $author (@tmp_authors) {
2264 $author = deduplicate_email($author);
2265 }
2266 @tmp_authors = uniq(@tmp_authors);
2267 my @list_added = ();
2268 my @list_deleted = ();
2269 foreach my $author (@tmp_authors) {
2270 my $auth_added = 0;
2271 my $auth_deleted = 0;
2272 for (my $i = 0; $i <= $#stats; $i++) {
2273 if ($author eq deduplicate_email($authors[$i]) &&
2274 $stats[$i] =~ /$stat_pattern/) {
2275 $auth_added += $1;
2276 $auth_deleted += $2;
2277 }
2278 }
2279 for (my $i = 0; $i < $auth_added; $i++) {
2280 push(@list_added, $author);
2281 }
2282 for (my $i = 0; $i < $auth_deleted; $i++) {
2283 push(@list_deleted, $author);
2284 }
2285 }
2286 vcs_assign("added_lines", $added, @list_added);
2287 vcs_assign("removed_lines", $deleted, @list_deleted);
2288 }
2289}
2290
2291sub vcs_file_blame {
2292 my ($file) = @_;
2293
2294 my @signers = ();
2295 my @all_commits = ();
2296 my @commits = ();
2297 my $total_commits;
2298 my $total_lines;
2299
2300 $vcs_used = vcs_exists();
2301 return if (!$vcs_used);
2302
2303 @all_commits = vcs_blame($file);
2304 @commits = uniq(@all_commits);
2305 $total_commits = @commits;
2306 $total_lines = @all_commits;
2307
2308 if ($email_git_blame_signatures) {
2309 if (vcs_is_hg()) {
2310 my $commit_count;
2311 my $commit_authors_ref;
2312 my $commit_signers_ref;
2313 my $stats_ref;
2314 my @commit_authors = ();
2315 my @commit_signers = ();
2316 my $commit = join(" -r ", @commits);
2317 my $cmd;
2318
2319 $cmd = $VCS_cmds{"find_commit_signers_cmd"};
2320 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
2321
2322 ($commit_count, $commit_signers_ref, $commit_authors_ref, $stats_ref) = vcs_find_signers($cmd, $file);
2323 @commit_authors = @{$commit_authors_ref} if defined $commit_authors_ref;
2324 @commit_signers = @{$commit_signers_ref} if defined $commit_signers_ref;
2325
2326 push(@signers, @commit_signers);
2327 } else {
2328 foreach my $commit (@commits) {
2329 my $commit_count;
2330 my $commit_authors_ref;
2331 my $commit_signers_ref;
2332 my $stats_ref;
2333 my @commit_authors = ();
2334 my @commit_signers = ();
2335 my $cmd;
2336
2337 $cmd = $VCS_cmds{"find_commit_signers_cmd"};
2338 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
2339
2340 ($commit_count, $commit_signers_ref, $commit_authors_ref, $stats_ref) = vcs_find_signers($cmd, $file);
2341 @commit_authors = @{$commit_authors_ref} if defined $commit_authors_ref;
2342 @commit_signers = @{$commit_signers_ref} if defined $commit_signers_ref;
2343
2344 push(@signers, @commit_signers);
2345 }
2346 }
2347 }
2348
2349 if ($from_filename) {
2350 if ($output_rolestats) {
2351 my @blame_signers;
2352 if (vcs_is_hg()) {{ # Double brace for last exit
2353 my $commit_count;
2354 my @commit_signers = ();
2355 @commits = uniq(@commits);
2356 @commits = sort(@commits);
2357 my $commit = join(" -r ", @commits);
2358 my $cmd;
2359
2360 $cmd = $VCS_cmds{"find_commit_author_cmd"};
2361 $cmd =~ s/(\$\w+)/$1/eeg; #substitute variables in $cmd
2362
2363 my @lines = ();
2364
2365 @lines = &{$VCS_cmds{"execute_cmd"}}($cmd);
2366
2367 if (!$email_git_penguin_chiefs) {
2368 @lines = grep(!/${penguin_chiefs}/i, @lines);
2369 }
2370
2371 last if !@lines;
2372
2373 my @authors = ();
2374 foreach my $line (@lines) {
2375 if ($line =~ m/$VCS_cmds{"author_pattern"}/) {
2376 my $author = $1;
2377 $author = deduplicate_email($author);
2378 push(@authors, $author);
2379 }
2380 }
2381
2382 save_commits_by_author(@lines) if ($interactive);
2383 save_commits_by_signer(@lines) if ($interactive);
2384
2385 push(@signers, @authors);
2386 }}
2387 else {
2388 foreach my $commit (@commits) {
2389 my $i;
2390 my $cmd = $VCS_cmds{"find_commit_author_cmd"};
2391 $cmd =~ s/(\$\w+)/$1/eeg; #interpolate $cmd
2392 my @author = vcs_find_author($cmd);
2393 next if !@author;
2394
2395 my $formatted_author = deduplicate_email($author[0]);
2396
2397 my $count = grep(/$commit/, @all_commits);
2398 for ($i = 0; $i < $count ; $i++) {
2399 push(@blame_signers, $formatted_author);
2400 }
2401 }
2402 }
2403 if (@blame_signers) {
2404 vcs_assign("authored lines", $total_lines, @blame_signers);
2405 }
2406 }
2407 foreach my $signer (@signers) {
2408 $signer = deduplicate_email($signer);
2409 }
2410 vcs_assign("commits", $total_commits, @signers);
2411 } else {
2412 foreach my $signer (@signers) {
2413 $signer = deduplicate_email($signer);
2414 }
2415 vcs_assign("modified commits", $total_commits, @signers);
2416 }
2417}
2418
2419sub vcs_file_exists {
2420 my ($file) = @_;
2421
2422 my $exists;
2423
2424 my $vcs_used = vcs_exists();
2425 return 0 if (!$vcs_used);
2426
2427 my $cmd = $VCS_cmds{"file_exists_cmd"};
2428 $cmd =~ s/(\$\w+)/$1/eeg; # interpolate $cmd
2429 $cmd .= " 2>&1";
2430 $exists = &{$VCS_cmds{"execute_cmd"}}($cmd);
2431
2432 return 0 if ($? != 0);
2433
2434 return $exists;
2435}
2436
2437sub vcs_list_files {
2438 my ($file) = @_;
2439
2440 my @lsfiles = ();
2441
2442 my $vcs_used = vcs_exists();
2443 return 0 if (!$vcs_used);
2444
2445 my $cmd = $VCS_cmds{"list_files_cmd"};
2446 $cmd =~ s/(\$\w+)/$1/eeg; # interpolate $cmd
2447 @lsfiles = &{$VCS_cmds{"execute_cmd"}}($cmd);
2448
2449 return () if ($? != 0);
2450
2451 return @lsfiles;
2452}
2453
2454sub uniq {
2455 my (@parms) = @_;
2456
2457 my %saw;
2458 @parms = grep(!$saw{$_}++, @parms);
2459 return @parms;
2460}
2461
2462sub sort_and_uniq {
2463 my (@parms) = @_;
2464
2465 my %saw;
2466 @parms = sort @parms;
2467 @parms = grep(!$saw{$_}++, @parms);
2468 return @parms;
2469}
2470
2471sub clean_file_emails {
2472 my (@file_emails) = @_;
2473 my @fmt_emails = ();
2474
2475 foreach my $email (@file_emails) {
2476 $email =~ s/[\(\<\{]{0,1}([A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+)[\)\>\}]{0,1}/\<$1\>/g;
2477 my ($name, $address) = parse_email($email);
2478
2479 # Strip quotes for easier processing, format_email will add them back
2480 $name =~ s/^"(.*)"$/$1/;
2481
2482 # Split into name-like parts and remove stray punctuation particles
2483 my @nw = split(/[^\p{L}\'\,\.\+-]/, $name);
2484 @nw = grep(!/^[\'\,\.\+-]$/, @nw);
2485
2486 # Make a best effort to extract the name, and only the name, by taking
2487 # only the last two names, or in the case of obvious initials, the last
2488 # three names.
2489 if (@nw > 2) {
2490 my $first = $nw[@nw - 3];
2491 my $middle = $nw[@nw - 2];
2492 my $last = $nw[@nw - 1];
2493
2494 if (((length($first) == 1 && $first =~ m/\p{L}/) ||
2495 (length($first) == 2 && substr($first, -1) eq ".")) ||
2496 (length($middle) == 1 ||
2497 (length($middle) == 2 && substr($middle, -1) eq "."))) {
2498 $name = "$first $middle $last";
2499 } else {
2500 $name = "$middle $last";
2501 }
2502 } else {
2503 $name = "@nw";
2504 }
2505
2506 if (substr($name, -1) =~ /[,\.]/) {
2507 $name = substr($name, 0, length($name) - 1);
2508 }
2509
2510 if (substr($name, 0, 1) =~ /[,\.]/) {
2511 $name = substr($name, 1, length($name) - 1);
2512 }
2513
2514 my $fmt_email = format_email($name, $address, $email_usename);
2515 push(@fmt_emails, $fmt_email);
2516 }
2517 return @fmt_emails;
2518}
2519
2520sub merge_email {
2521 my @lines;
2522 my %saw;
2523
2524 for (@_) {
2525 my ($address, $role) = @$_;
2526 if (!$saw{$address}) {
2527 if ($output_roles) {
2528 push(@lines, "$address ($role)");
2529 } else {
2530 push(@lines, $address);
2531 }
2532 $saw{$address} = 1;
2533 }
2534 }
2535
2536 return @lines;
2537}
2538
2539sub output {
2540 my (@parms) = @_;
2541
2542 if ($output_multiline) {
2543 foreach my $line (@parms) {
2544 print("${line}\n");
2545 }
2546 } else {
2547 print(join($output_separator, @parms));
2548 print("\n");
2549 }
2550}
2551
2552my $rfc822re;
2553
2554sub make_rfc822re {
2555# Basic lexical tokens are specials, domain_literal, quoted_string, atom, and
2556# comment. We must allow for rfc822_lwsp (or comments) after each of these.
2557# This regexp will only work on addresses which have had comments stripped
2558# and replaced with rfc822_lwsp.
2559
2560 my $specials = '()<>@,;:\\\\".\\[\\]';
2561 my $controls = '\\000-\\037\\177';
2562
2563 my $dtext = "[^\\[\\]\\r\\\\]";
2564 my $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$rfc822_lwsp*";
2565
2566 my $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$rfc822_lwsp)*\"$rfc822_lwsp*";
2567
2568# Use zero-width assertion to spot the limit of an atom. A simple
2569# $rfc822_lwsp* causes the regexp engine to hang occasionally.
2570 my $atom = "[^$specials $controls]+(?:$rfc822_lwsp+|\\Z|(?=[\\[\"$specials]))";
2571 my $word = "(?:$atom|$quoted_string)";
2572 my $localpart = "$word(?:\\.$rfc822_lwsp*$word)*";
2573
2574 my $sub_domain = "(?:$atom|$domain_literal)";
2575 my $domain = "$sub_domain(?:\\.$rfc822_lwsp*$sub_domain)*";
2576
2577 my $addr_spec = "$localpart\@$rfc822_lwsp*$domain";
2578
2579 my $phrase = "$word*";
2580 my $route = "(?:\@$domain(?:,\@$rfc822_lwsp*$domain)*:$rfc822_lwsp*)";
2581 my $route_addr = "\\<$rfc822_lwsp*$route?$addr_spec\\>$rfc822_lwsp*";
2582 my $mailbox = "(?:$addr_spec|$phrase$route_addr)";
2583
2584 my $group = "$phrase:$rfc822_lwsp*(?:$mailbox(?:,\\s*$mailbox)*)?;\\s*";
2585 my $address = "(?:$mailbox|$group)";
2586
2587 return "$rfc822_lwsp*$address";
2588}
2589
2590sub rfc822_strip_comments {
2591 my $s = shift;
2592# Recursively remove comments, and replace with a single space. The simpler
2593# regexps in the Email Addressing FAQ are imperfect - they will miss escaped
2594# chars in atoms, for example.
2595
2596 while ($s =~ s/^((?:[^"\\]|\\.)*
2597 (?:"(?:[^"\\]|\\.)*"(?:[^"\\]|\\.)*)*)
2598 \((?:[^()\\]|\\.)*\)/$1 /osx) {}
2599 return $s;
2600}
2601
2602# valid: returns true if the parameter is an RFC822 valid address
2603#
2604sub rfc822_valid {
2605 my $s = rfc822_strip_comments(shift);
2606
2607 if (!$rfc822re) {
2608 $rfc822re = make_rfc822re();
2609 }
2610
2611 return $s =~ m/^$rfc822re$/so && $s =~ m/^$rfc822_char*$/;
2612}
2613
2614# validlist: In scalar context, returns true if the parameter is an RFC822
2615# valid list of addresses.
2616#
2617# In list context, returns an empty list on failure (an invalid
2618# address was found); otherwise a list whose first element is the
2619# number of addresses found and whose remaining elements are the
2620# addresses. This is needed to disambiguate failure (invalid)
2621# from success with no addresses found, because an empty string is
2622# a valid list.
2623
2624sub rfc822_validlist {
2625 my $s = rfc822_strip_comments(shift);
2626
2627 if (!$rfc822re) {
2628 $rfc822re = make_rfc822re();
2629 }
2630 # * null list items are valid according to the RFC
2631 # * the '1' business is to aid in distinguishing failure from no results
2632
2633 my @r;
2634 if ($s =~ m/^(?:$rfc822re)?(?:,(?:$rfc822re)?)*$/so &&
2635 $s =~ m/^$rfc822_char*$/) {
2636 while ($s =~ m/(?:^|,$rfc822_lwsp*)($rfc822re)/gos) {
2637 push(@r, $1);
2638 }
2639 return wantarray ? (scalar(@r), @r) : 1;
2640 }
2641 return wantarray ? () : 0;
2642}