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