#!/usr/bin/perl -w # (c) 2007, Joe Perches <joe@perches.com> # created from checkpatch.pl # # Print selected MAINTAINERS information for # the files modified in a patch or for a file # # usage: perl scripts/get_maintainers.pl [OPTIONS] <patch> # perl scripts/get_maintainers.pl [OPTIONS] -f <file> # # Licensed under the terms of the GNU GPL License version 2 use strict; my $P = $0; my $V = '0.17'; use Getopt::Long qw(:config no_auto_abbrev); my $lk_path = "./"; my $email = 1; my $email_usename = 1; my $email_maintainer = 1; my $email_list = 1; my $email_subscriber_list = 0; my $email_git = 1; my $email_git_penguin_chiefs = 0; my $email_git_min_signatures = 1; my $email_git_max_maintainers = 5; my $email_git_min_percent = 5; my $email_git_since = "1-year-ago"; my $output_multiline = 1; my $output_separator = ", "; my $scm = 0; my $web = 0; my $subsystem = 0; my $status = 0; my $from_filename = 0; my $version = 0; my $help = 0; my $exit = 0; my @penguin_chief = (); push(@penguin_chief,"Linus Torvalds:torvalds\@linux-foundation.org"); #Andrew wants in on most everything - 2009/01/14 #push(@penguin_chief,"Andrew Morton:akpm\@linux-foundation.org"); my @penguin_chief_names = (); foreach my $chief (@penguin_chief) { if ($chief =~ m/^(.*):(.*)/) { my $chief_name = $1; my $chief_addr = $2; push(@penguin_chief_names, $chief_name); } } my $penguin_chiefs = "\(" . join("|",@penguin_chief_names) . "\)"; # rfc822 email address - preloaded methods go here. my $rfc822_lwsp = "(?:(?:\\r\\n)?[ \\t])"; my $rfc822_char = '[\\000-\\377]'; if (!GetOptions( 'email!' => \$email, 'git!' => \$email_git, 'git-chief-penguins!' => \$email_git_penguin_chiefs, 'git-min-signatures=i' => \$email_git_min_signatures, 'git-max-maintainers=i' => \$email_git_max_maintainers, 'git-min-percent=i' => \$email_git_min_percent, 'git-since=s' => \$email_git_since, 'm!' => \$email_maintainer, 'n!' => \$email_usename, 'l!' => \$email_list, 's!' => \$email_subscriber_list, 'multiline!' => \$output_multiline, 'separator=s' => \$output_separator, 'subsystem!' => \$subsystem, 'status!' => \$status, 'scm!' => \$scm, 'web!' => \$web, 'f|file' => \$from_filename, 'v|version' => \$version, 'h|help' => \$help, )) { usage(); die "$P: invalid argument\n"; } if ($help != 0) { usage(); exit 0; } if ($version != 0) { print("${P} ${V}\n"); exit 0; } if ($#ARGV < 0) { usage(); die "$P: argument missing: patchfile or -f file please\n"; } my $selections = $email + $scm + $status + $subsystem + $web; if ($selections == 0) { usage(); die "$P: Missing required option: email, scm, status, subsystem or web\n"; } if ($email && ($email_maintainer + $email_list + $email_subscriber_list + $email_git + $email_git_penguin_chiefs) == 0) { usage(); die "$P: Please select at least 1 email option\n"; } if (!top_of_kernel_tree($lk_path)) { die "$P: The current directory does not appear to be " . "a linux kernel source tree.\n"; } ## Read MAINTAINERS for type/value pairs my @typevalue = (); open(MAINT, "<${lk_path}MAINTAINERS") || die "$P: Can't open MAINTAINERS\n"; while (<MAINT>) { my $line = $_; if ($line =~ m/^(\C):\s*(.*)/) { my $type = $1; my $value = $2; ##Filename pattern matching if ($type eq "F" || $type eq "X") { $value =~ s@\.@\\\.@g; ##Convert . to \. $value =~ s/\*/\.\*/g; ##Convert * to .* $value =~ s/\?/\./g; ##Convert ? to . ##if pattern is a directory and it lacks a trailing slash, add one if ((-d $value)) { $value =~ s@([^/])$@$1/@; } } push(@typevalue, "$type:$value"); } elsif (!/^(\s)*$/) { $line =~ s/\n$//g; push(@typevalue, $line); } } close(MAINT); ## use the filenames on the command line or find the filenames in the patchfiles my @files = (); foreach my $file (@ARGV) { ##if $file is a directory and it lacks a trailing slash, add one if ((-d $file)) { $file =~ s@([^/])$@$1/@; } elsif (!(-f $file)) { die "$P: file '${file}' not found\n"; } if ($from_filename) { push(@files, $file); } else { my $file_cnt = @files; open(PATCH, "<$file") or die "$P: Can't open ${file}\n"; while (<PATCH>) { if (m/^\+\+\+\s+(\S+)/) { my $filename = $1; $filename =~ s@^[^/]*/@@; $filename =~ s@\n@@; push(@files, $filename); } } close(PATCH); if ($file_cnt == @files) { warn "$P: file '${file}' doesn't appear to be a patch. " . "Add -f to options?\n"; } @files = sort_and_uniq(@files); } } my @email_to = (); my @list_to = (); my @scm = (); my @web = (); my @subsystem = (); my @status = (); # Find responsible parties foreach my $file (@files) { #Do not match excluded file patterns my $exclude = 0; foreach my $line (@typevalue) { if ($line =~ m/^(\C):\s*(.*)/) { my $type = $1; my $value = $2; if ($type eq 'X') { if (file_match_pattern($file, $value)) { $exclude = 1; } } } } if (!$exclude) { my $tvi = 0; foreach my $line (@typevalue) { if ($line =~ m/^(\C):\s*(.*)/) { my $type = $1; my $value = $2; if ($type eq 'F') { if (file_match_pattern($file, $value)) { add_categories($tvi); } } } $tvi++; } } if ($email && $email_git) { recent_git_signoffs($file); } } if ($email) { foreach my $chief (@penguin_chief) { if ($chief =~ m/^(.*):(.*)/) { my $email_address; if ($email_usename) { $email_address = format_email($1, $2); } else { $email_address = $2; } if ($email_git_penguin_chiefs) { push(@email_to, $email_address); } else { @email_to = grep(!/${email_address}/, @email_to); } } } } if ($email || $email_list) { my @to = (); if ($email) { @to = (@to, @email_to); } if ($email_list) { @to = (@to, @list_to); } output(uniq(@to)); } if ($scm) { @scm = sort_and_uniq(@scm); output(@scm); } if ($status) { @status = sort_and_uniq(@status); output(@status); } if ($subsystem) { @subsystem = sort_and_uniq(@subsystem); output(@subsystem); } if ($web) { @web = sort_and_uniq(@web); output(@web); } exit($exit); sub file_match_pattern { my ($file, $pattern) = @_; if (substr($pattern, -1) eq "/") { if ($file =~ m@^$pattern@) { return 1; } } else { if ($file =~ m@^$pattern@) { my $s1 = ($file =~ tr@/@@); my $s2 = ($pattern =~ tr@/@@); if ($s1 == $s2) { return 1; } } } return 0; } sub usage { print <<EOT; usage: $P [options] patchfile $P [options] -f file|directory version: $V MAINTAINER field selection options: --email => print email address(es) if any --git => include recent git \*-by: signers --git-chief-penguins => include ${penguin_chiefs} --git-min-signatures => number of signatures required (default: 1) --git-max-maintainers => maximum maintainers to add (default: 5) --git-min-percent => minimum percentage of commits required (default: 5) --git-since => git history to use (default: 1-year-ago) --m => include maintainer(s) if any --n => include name 'Full Name <addr\@domain.tld>' --l => include list(s) if any --s => include subscriber only list(s) if any --scm => print SCM tree(s) if any --status => print status if any --subsystem => print subsystem name if any --web => print website(s) if any Output type options: --separator [, ] => separator for multiple entries on 1 line --multiline => print 1 entry per line Default options: [--email --git --m --n --l --multiline] Other options: --version => show version --help => show this help information Notes: Using "-f directory" may give unexpected results: Used with "--git", git signators for _all_ files in and below directory are examined as git recurses directories. Any specified X: (exclude) pattern matches are _not_ ignored. Used with "--nogit", directory is used as a pattern match, no individual file within the directory or subdirectory is matched. EOT } sub top_of_kernel_tree { my ($lk_path) = @_; if ($lk_path ne "" && substr($lk_path,length($lk_path)-1,1) ne "/") { $lk_path .= "/"; } if ( (-f "${lk_path}COPYING") && (-f "${lk_path}CREDITS") && (-f "${lk_path}Kbuild") && (-f "${lk_path}MAINTAINERS") && (-f "${lk_path}Makefile") && (-f "${lk_path}README") && (-d "${lk_path}Documentation") && (-d "${lk_path}arch") && (-d "${lk_path}include") && (-d "${lk_path}drivers") && (-d "${lk_path}fs") && (-d "${lk_path}init") && (-d "${lk_path}ipc") && (-d "${lk_path}kernel") && (-d "${lk_path}lib") && (-d "${lk_path}scripts")) { return 1; } return 0; } sub format_email { my ($name, $email) = @_; $name =~ s/^\s+|\s+$//g; $name =~ s/^\"|\"$//g; $email =~ s/^\s+|\s+$//g; my $formatted_email = ""; if ($name =~ /[^a-z0-9 \.\-]/i) { ##has "must quote" chars $name =~ s/(?<!\\)"/\\"/g; ##escape quotes $formatted_email = "\"${name}\"\ \<${email}\>"; } else { $formatted_email = "${name} \<${email}\>"; } return $formatted_email; } sub add_categories { my ($index) = @_; $index = $index - 1; while ($index >= 0) { my $tv = $typevalue[$index]; if ($tv =~ m/^(\C):\s*(.*)/) { my $ptype = $1; my $pvalue = $2; if ($ptype eq "L") { my $list_address = $pvalue; my $list_additional = ""; if ($list_address =~ m/([^\s]+)\s+(.*)$/) { $list_address = $1; $list_additional = $2; } if ($list_additional =~ m/subscribers-only/) { if ($email_subscriber_list) { push(@list_to, $list_address); } } else { if ($email_list) { push(@list_to, $list_address); } } } elsif ($ptype eq "M") { my $p_used = 0; if ($index >= 0) { my $tv = $typevalue[$index - 1]; if ($tv =~ m/^(\C):\s*(.*)/) { if ($1 eq "P") { if ($email_usename) { push_email_address(format_email($2, $pvalue)); $p_used = 1; } } } } if (!$p_used) { push_email_addresses($pvalue); } } elsif ($ptype eq "T") { push(@scm, $pvalue); } elsif ($ptype eq "W") { push(@web, $pvalue); } elsif ($ptype eq "S") { push(@status, $pvalue); } $index--; } else { push(@subsystem,$tv); $index = -1; } } } sub push_email_address { my ($email_address) = @_; my $email_name = ""; if ($email_address =~ m/([^<]+)<(.*\@.*)>$/) { $email_name = $1; $email_address = $2; } if ($email_maintainer) { if ($email_usename && $email_name) { push(@email_to, format_email($email_name, $email_address)); } else { push(@email_to, $email_address); } } } sub push_email_addresses { my ($address) = @_; my @address_list = (); if (rfc822_valid($address)) { push_email_address($address); } elsif (@address_list = rfc822_validlist($address)) { my $array_count = shift(@address_list); while (my $entry = shift(@address_list)) { push_email_address($entry); } } else { warn("Invalid MAINTAINERS address: '" . $address . "'\n"); } } sub which { my ($bin) = @_; foreach my $path (split(/:/, $ENV{PATH})) { if (-e "$path/$bin") { return "$path/$bin"; } } return ""; } sub recent_git_signoffs { my ($file) = @_; my $sign_offs = ""; my $cmd = ""; my $output = ""; my $count = 0; my @lines = (); my $total_sign_offs; if (which("git") eq "") { warn("$P: git not found. Add --nogit to options?\n"); return; } if (!(-d ".git")) { warn("$P: .git directory not found. Use a git repository for better results.\n"); warn("$P: perhaps 'git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git'\n"); return; } $cmd = "git log --since=${email_git_since} -- ${file}"; $cmd .= " | grep -Ei \"^[-_ a-z]+by:.*\\\@.*\$\""; if (!$email_git_penguin_chiefs) { $cmd .= " | grep -Ev \"${penguin_chiefs}\""; } $cmd .= " | cut -f2- -d\":\""; $cmd .= " | sort | uniq -c | sort -rn"; $output = `${cmd}`; $output =~ s/^\s*//gm; @lines = split("\n", $output); $total_sign_offs = 0; foreach my $line (@lines) { if ($line =~ m/([0-9]+)\s+(.*)/) { $total_sign_offs += $1; } else { die("$P: Unexpected git output: ${line}\n"); } } foreach my $line (@lines) { if ($line =~ m/([0-9]+)\s+(.*)/) { my $sign_offs = $1; $line = $2; $count++; if ($sign_offs < $email_git_min_signatures || $count > $email_git_max_maintainers || $sign_offs * 100 / $total_sign_offs < $email_git_min_percent) { last; } } if ($line =~ m/(.+)<(.+)>/) { my $git_name = $1; my $git_addr = $2; if ($email_usename) { push(@email_to, format_email($git_name, $git_addr)); } else { push(@email_to, $git_addr); } } elsif ($line =~ m/<(.+)>/) { my $git_addr = $1; push(@email_to, $git_addr); } else { push(@email_to, $line); } } } sub uniq { my @parms = @_; my %saw; @parms = grep(!$saw{$_}++, @parms); return @parms; } sub sort_and_uniq { my @parms = @_; my %saw; @parms = sort @parms; @parms = grep(!$saw{$_}++, @parms); return @parms; } sub output { my @parms = @_; if ($output_multiline) { foreach my $line (@parms) { print("${line}\n"); } } else { print(join($output_separator, @parms)); print("\n"); } } my $rfc822re; sub make_rfc822re { # Basic lexical tokens are specials, domain_literal, quoted_string, atom, and # comment. We must allow for rfc822_lwsp (or comments) after each of these. # This regexp will only work on addresses which have had comments stripped # and replaced with rfc822_lwsp. my $specials = '()<>@,;:\\\\".\\[\\]'; my $controls = '\\000-\\037\\177'; my $dtext = "[^\\[\\]\\r\\\\]"; my $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$rfc822_lwsp*"; my $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$rfc822_lwsp)*\"$rfc822_lwsp*"; # Use zero-width assertion to spot the limit of an atom. A simple # $rfc822_lwsp* causes the regexp engine to hang occasionally. my $atom = "[^$specials $controls]+(?:$rfc822_lwsp+|\\Z|(?=[\\[\"$specials]))"; my $word = "(?:$atom|$quoted_string)"; my $localpart = "$word(?:\\.$rfc822_lwsp*$word)*"; my $sub_domain = "(?:$atom|$domain_literal)"; my $domain = "$sub_domain(?:\\.$rfc822_lwsp*$sub_domain)*"; my $addr_spec = "$localpart\@$rfc822_lwsp*$domain"; my $phrase = "$word*"; my $route = "(?:\@$domain(?:,\@$rfc822_lwsp*$domain)*:$rfc822_lwsp*)"; my $route_addr = "\\<$rfc822_lwsp*$route?$addr_spec\\>$rfc822_lwsp*"; my $mailbox = "(?:$addr_spec|$phrase$route_addr)"; my $group = "$phrase:$rfc822_lwsp*(?:$mailbox(?:,\\s*$mailbox)*)?;\\s*"; my $address = "(?:$mailbox|$group)"; return "$rfc822_lwsp*$address"; } sub rfc822_strip_comments { my $s = shift; # Recursively remove comments, and replace with a single space. The simpler # regexps in the Email Addressing FAQ are imperfect - they will miss escaped # chars in atoms, for example. while ($s =~ s/^((?:[^"\\]|\\.)* (?:"(?:[^"\\]|\\.)*"(?:[^"\\]|\\.)*)*) \((?:[^()\\]|\\.)*\)/$1 /osx) {} return $s; } # valid: returns true if the parameter is an RFC822 valid address # sub rfc822_valid ($) { my $s = rfc822_strip_comments(shift); if (!$rfc822re) { $rfc822re = make_rfc822re(); } return $s =~ m/^$rfc822re$/so && $s =~ m/^$rfc822_char*$/; } # validlist: In scalar context, returns true if the parameter is an RFC822 # valid list of addresses. # # In list context, returns an empty list on failure (an invalid # address was found); otherwise a list whose first element is the # number of addresses found and whose remaining elements are the # addresses. This is needed to disambiguate failure (invalid) # from success with no addresses found, because an empty string is # a valid list. sub rfc822_validlist ($) { my $s = rfc822_strip_comments(shift); if (!$rfc822re) { $rfc822re = make_rfc822re(); } # * null list items are valid according to the RFC # * the '1' business is to aid in distinguishing failure from no results my @r; if ($s =~ m/^(?:$rfc822re)?(?:,(?:$rfc822re)?)*$/so && $s =~ m/^$rfc822_char*$/) { while ($s =~ m/(?:^|,$rfc822_lwsp*)($rfc822re)/gos) { push @r, $1; } return wantarray ? (scalar(@r), @r) : 1; } else { return wantarray ? () : 0; } }