chomp the output from git ls-files. Display a helpful message nothing is
[perl.git] / Porting / Maintainers.pm
1 #
2 # Maintainers.pm - show information about maintainers
3 #
4
5 package Maintainers;
6
7 use strict;
8
9 use lib "Porting";
10 # Please don't use post 5.008 features as this module is used by
11 # Porting/makemeta, and that in turn has to be run by the perl just built.
12 use 5.008;
13
14 require "Maintainers.pl";
15 use vars qw(%Modules %Maintainers);
16
17 use vars qw(@ISA @EXPORT_OK $VERSION);
18 @ISA = qw(Exporter);
19 @EXPORT_OK = qw(%Modules %Maintainers
20                 get_module_files get_module_pat
21                 show_results process_options);
22 $VERSION = 0.02;
23 require Exporter;
24
25 use File::Find;
26 use Getopt::Long;
27
28 my %MANIFEST;
29 if (open(MANIFEST, "MANIFEST")) {
30     while (<MANIFEST>) {
31         if (/^(\S+)\t+(.+)$/) {
32             $MANIFEST{$1}++;
33         }
34     }
35     close MANIFEST;
36 } else {
37     die "$0: Failed to open MANIFEST for reading: $!\n";
38 }
39
40 sub get_module_pat {
41     my $m = shift;
42     split ' ', $Modules{$m}{FILES};
43 }
44
45 sub get_module_files {
46     my $m = shift;
47     sort { lc $a cmp lc $b }
48     map {
49         -f $_ ? # Files as-is.
50             $_ :
51             -d _ ? # Recurse into directories.
52             do {
53                 my @files;
54                 find(
55                      sub {
56                          push @files, $File::Find::name
57                              if -f $_ && exists $MANIFEST{$File::Find::name};
58                      }, $_);
59                 @files;
60             }
61         : glob($_) # The rest are globbable patterns.
62         } get_module_pat($m);
63 }
64
65 sub get_maintainer_modules {
66     my $m = shift;
67     sort { lc $a cmp lc $b }
68     grep { $Modules{$_}{MAINTAINER} eq $m }
69     keys %Modules;
70 }
71
72 sub usage {
73     print <<__EOF__;
74 $0: Usage: $0 [[--maintainer M --module M --files]|[--check] file ...]
75 --maintainer M  list all maintainers matching M
76 --module M      list all modules matching M
77 --files         list all files
78 --check         check consistency of Maintainers.pl
79                         with a file     checks if it has a maintainer
80                         with a dir      checks all files have a maintainer
81                         otherwise       checks for multiple maintainers
82 --opened        list all modules of modified files
83 Matching is case-ignoring regexp, author matching is both by
84 the short id and by the full name and email.  A "module" may
85 not be just a module, it may be a file or files or a subdirectory.
86 The options may be abbreviated to their unique prefixes
87 __EOF__
88     exit(0);
89 }
90
91 my $Maintainer;
92 my $Module;
93 my $Files;
94 my $Check;
95 my $Opened;
96
97 sub process_options {
98     usage()
99         unless
100             GetOptions(
101                        'maintainer=s'   => \$Maintainer,
102                        'module=s'       => \$Module,
103                        'files'          => \$Files,
104                        'check'          => \$Check,
105                        'opened'         => \$Opened,
106                       );
107
108     my @Files;
109
110     if ($Opened) {
111         chomp (@Files = `git ls-files -m --full-name`);
112         die if $?;
113     } else {
114         @Files = @ARGV;
115     }
116
117     usage() if @Files && ($Maintainer || $Module || $Files);
118
119     for my $mean ($Maintainer, $Module) {
120         warn "$0: Did you mean '$0 $mean'?\n"
121             if $mean && -e $mean && $mean ne '.' && !$Files;
122     }
123
124     warn "$0: Did you mean '$0 -mo $Maintainer'?\n"
125         if defined $Maintainer && exists $Modules{$Maintainer};
126
127     warn "$0: Did you mean '$0 -ma $Module'?\n"
128         if defined $Module     && exists $Maintainers{$Module};
129
130     return ($Maintainer, $Module, $Files, @Files);
131 }
132
133 sub show_results {
134     my ($Maintainer, $Module, $Files, @Files) = @_;
135
136     if ($Maintainer) {
137         for my $m (sort keys %Maintainers) {
138             if ($m =~ /$Maintainer/io || $Maintainers{$m} =~ /$Maintainer/io) {
139                 my @modules = get_maintainer_modules($m);
140                 if ($Module) {
141                     @modules = grep { /$Module/io } @modules;
142                 }
143                 if ($Files) {
144                     my @files;
145                     for my $module (@modules) {
146                         push @files, get_module_files($module);
147                     }
148                     printf "%-15s @files\n", $m;
149                 } else {
150                     if ($Module) {
151                         printf "%-15s @modules\n", $m;
152                     } else {
153                         printf "%-15s $Maintainers{$m}\n", $m;
154                     }
155                 }
156             }
157         }
158     } elsif ($Module) {
159         for my $m (sort { lc $a cmp lc $b } keys %Modules) {
160             if ($m =~ /$Module/io) {
161                 if ($Files) {
162                     my @files = get_module_files($m);
163                     printf "%-15s @files\n", $m;
164                 } else {
165                     printf "%-15s %-12s %s\n", $m, $Modules{$m}{MAINTAINER}, $Modules{$m}{UPSTREAM}||'unknown';
166                 }
167             }
168         }
169     } elsif ($Check) {
170         if( @Files ) {
171             missing_maintainers( qr{\.(?:[chty]|p[lm]|xs)\z}msx, @Files)
172         }
173         else { 
174             duplicated_maintainers();
175         }
176     } elsif (@Files) {
177         my %ModuleByFile;
178
179         for (@Files) { s:^\./:: }
180
181         @ModuleByFile{@Files} = ();
182
183         # First try fast match.
184
185         my %ModuleByPat;
186         for my $module (keys %Modules) {
187             for my $pat (get_module_pat($module)) {
188                 $ModuleByPat{$pat} = $module;
189             }
190         }
191         # Expand any globs.
192         my %ExpModuleByPat;
193         for my $pat (keys %ModuleByPat) {
194             if (-e $pat) {
195                 $ExpModuleByPat{$pat} = $ModuleByPat{$pat};
196             } else {
197                 for my $exp (glob($pat)) {
198                     $ExpModuleByPat{$exp} = $ModuleByPat{$pat};
199                 }
200             }
201         }
202         %ModuleByPat = %ExpModuleByPat;
203         for my $file (@Files) {
204             $ModuleByFile{$file} = $ModuleByPat{$file}
205                 if exists $ModuleByPat{$file};
206         }
207
208         # If still unresolved files...
209         if (my @ToDo = grep { !defined $ModuleByFile{$_} } keys %ModuleByFile) {
210
211             # Cannot match what isn't there.
212             @ToDo = grep { -e $_ } @ToDo;
213
214             if (@ToDo) {
215                 # Try prefix matching.
216
217                 # Remove trailing slashes.
218                 for (@ToDo) { s|/$|| }
219
220                 my %ToDo;
221                 @ToDo{@ToDo} = ();
222
223                 for my $pat (keys %ModuleByPat) {
224                     last unless keys %ToDo;
225                     if (-d $pat) {
226                         my @Done;
227                         for my $file (keys %ToDo) {
228                             if ($file =~ m|^$pat|i) {
229                                 $ModuleByFile{$file} = $ModuleByPat{$pat};
230                                 push @Done, $file;
231                             }
232                         }
233                         delete @ToDo{@Done};
234                     }
235                 }
236             }
237         }
238
239         for my $file (@Files) {
240             if (defined $ModuleByFile{$file}) {
241                 my $module     = $ModuleByFile{$file};
242                 my $maintainer = $Modules{$ModuleByFile{$file}}{MAINTAINER};
243                 printf "%-15s $module $maintainer $Maintainers{$maintainer}\n", $file;
244             } else {
245                 printf "%-15s ?\n", $file;
246             }
247         }
248     }
249     elsif ($Opened) {
250         print "(No files are modified)\n";
251     }
252     else {
253         usage();
254     }
255 }
256
257 my %files;
258
259 sub maintainers_files {
260     %files = ();
261     for my $k (keys %Modules) {
262         for my $f (get_module_files($k)) {
263             ++$files{$f};
264         }
265     }
266 }
267
268 sub duplicated_maintainers {
269     maintainers_files();
270     for my $f (keys %files) {
271         if ($files{$f} > 1) {
272             warn "File $f appears $files{$f} times in Maintainers.pl\n";
273         }
274     }
275 }
276
277 sub warn_maintainer {
278     my $name = shift;
279     warn "File $name has no maintainer\n" if not $files{$name};
280 }
281
282 sub missing_maintainers {
283     my($check, @path) = @_;
284     maintainers_files();
285     my @dir;
286     for my $d (@path) {
287         if( -d $d ) { push @dir, $d } else { warn_maintainer($d) }
288     }
289     find sub { warn_maintainer($File::Find::name) if /$check/; }, @dir
290         if @dir;
291 }
292
293 1;
294