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] [commit] | [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     } elsif (@ARGV == 1 &&
 114              $ARGV[0] =~ /^(?:HEAD|[0-9a-f]{4,40})(?:~\d+)?\^*$/) {
 115         my $command = "git diff --name-only $ARGV[0]^ $ARGV[0]";
 116         chomp (@Files = `$command`);
 117         die "'$command' failed: $?" if $?;
 118     } else {
 119         @Files = @ARGV;
 120     }
 121
 122     usage() if @Files && ($Maintainer || $Module || $Files);
 123
 124     for my $mean ($Maintainer, $Module) {
 125         warn "$0: Did you mean '$0 $mean'?\n"
 126             if $mean && -e $mean && $mean ne '.' && !$Files;
 127     }
 128
 129     warn "$0: Did you mean '$0 -mo $Maintainer'?\n"
 130         if defined $Maintainer && exists $Modules{$Maintainer};
 131
 132     warn "$0: Did you mean '$0 -ma $Module'?\n"
 133         if defined $Module     && exists $Maintainers{$Module};
 134
 135     return ($Maintainer, $Module, $Files, @Files);
 136 }
 137
 138 sub show_results {
 139     my ($Maintainer, $Module, $Files, @Files) = @_;
 140
 141     if ($Maintainer) {
 142         for my $m (sort keys %Maintainers) {
 143             if ($m =~ /$Maintainer/io || $Maintainers{$m} =~ /$Maintainer/io) {
 144                 my @modules = get_maintainer_modules($m);
 145                 if ($Module) {
 146                     @modules = grep { /$Module/io } @modules;
 147                 }
 148                 if ($Files) {
 149                     my @files;
 150                     for my $module (@modules) {
 151                         push @files, get_module_files($module);
 152                     }
 153                     printf "%-15s @files\n", $m;
 154                 } else {
 155                     if ($Module) {
 156                         printf "%-15s @modules\n", $m;
 157                     } else {
 158                         printf "%-15s $Maintainers{$m}\n", $m;
 159                     }
 160                 }
 161             }
 162         }
 163     } elsif ($Module) {
 164         for my $m (sort { lc $a cmp lc $b } keys %Modules) {
 165             if ($m =~ /$Module/io) {
 166                 if ($Files) {
 167                     my @files = get_module_files($m);
 168                     printf "%-15s @files\n", $m;
 169                 } else {
 170                     printf "%-15s %-12s %s\n", $m, $Modules{$m}{MAINTAINER}, $Modules{$m}{UPSTREAM}||'unknown';
 171                 }
 172             }
 173         }
 174     } elsif ($Check) {
 175         if( @Files ) {
 176             missing_maintainers( qr{\.(?:[chty]|p[lm]|xs)\z}msx, @Files)
 177         }
 178         else {
 179             duplicated_maintainers();
 180         }
 181     } elsif (@Files) {
 182         my %ModuleByFile;
 183
 184         for (@Files) { s:^\./:: }
 185
 186         @ModuleByFile{@Files} = ();
 187
 188         # First try fast match.
 189
 190         my %ModuleByPat;
 191         for my $module (keys %Modules) {
 192             for my $pat (get_module_pat($module)) {
 193                 $ModuleByPat{$pat} = $module;
 194             }
 195         }
 196         # Expand any globs.
 197         my %ExpModuleByPat;
 198         for my $pat (keys %ModuleByPat) {
 199             if (-e $pat) {
 200                 $ExpModuleByPat{$pat} = $ModuleByPat{$pat};
 201             } else {
 202                 for my $exp (glob($pat)) {
 203                     $ExpModuleByPat{$exp} = $ModuleByPat{$pat};
 204                 }
 205             }
 206         }
 207         %ModuleByPat = %ExpModuleByPat;
 208         for my $file (@Files) {
 209             $ModuleByFile{$file} = $ModuleByPat{$file}
 210                 if exists $ModuleByPat{$file};
 211         }
 212
 213         # If still unresolved files...
 214         if (my @ToDo = grep { !defined $ModuleByFile{$_} } keys %ModuleByFile) {
 215
 216             # Cannot match what isn't there.
 217             @ToDo = grep { -e $_ } @ToDo;
 218
 219             if (@ToDo) {
 220                 # Try prefix matching.
 221
 222                 # Remove trailing slashes.
 223                 for (@ToDo) { s|/$|| }
 224
 225                 my %ToDo;
 226                 @ToDo{@ToDo} = ();
 227
 228                 for my $pat (keys %ModuleByPat) {
 229                     last unless keys %ToDo;
 230                     if (-d $pat) {
 231                         my @Done;
 232                         for my $file (keys %ToDo) {
 233                             if ($file =~ m|^$pat|i) {
 234                                 $ModuleByFile{$file} = $ModuleByPat{$pat};
 235                                 push @Done, $file;
 236                             }
 237                         }
 238                         delete @ToDo{@Done};
 239                     }
 240                 }
 241             }
 242         }
 243
 244         for my $file (@Files) {
 245             if (defined $ModuleByFile{$file}) {
 246                 my $module     = $ModuleByFile{$file};
 247                 my $maintainer = $Modules{$ModuleByFile{$file}}{MAINTAINER};
 248                 my $upstream   = $Modules{$module}{UPSTREAM}||'unknown';
 249                 printf "%-15s [%-7s] $module $maintainer $Maintainers{$maintainer}\n", $file, $upstream;
 250             } else {
 251                 printf "%-15s ?\n", $file;
 252             }
 253         }
 254     }
 255     elsif ($Opened) {
 256         print STDERR "(No files are modified)\n";
 257     }
 258     else {
 259         usage();
 260     }
 261 }
 262
 263 my %files;
 264
 265 sub maintainers_files {
 266     %files = ();
 267     for my $k (keys %Modules) {
 268         for my $f (get_module_files($k)) {
 269             ++$files{$f};
 270         }
 271     }
 272 }
 273
 274 sub duplicated_maintainers {
 275     maintainers_files();
 276     for my $f (keys %files) {
 277         if ($files{$f} > 1) {
 278             warn "File $f appears $files{$f} times in Maintainers.pl\n";
 279         }
 280     }
 281 }
 282
 283 sub warn_maintainer {
 284     my $name = shift;
 285     warn "File $name has no maintainer\n" if not $files{$name};
 286 }
 287
 288 sub missing_maintainers {
 289     my($check, @path) = @_;
 290     maintainers_files();
 291     my @dir;
 292     for my $d (@path) {
 293         if( -d $d ) { push @dir, $d } else { warn_maintainer($d) }
 294     }
 295     find sub { warn_maintainer($File::Find::name) if /$check/; }, @dir
 296         if @dir;
 297 }
 298
 299 1;
 300