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