Porting/corelist.pl

   1 #!perl
   2 # Generates info for Module::CoreList from this perl tree
   3 # run this from the root of a perl tree
   4 #
   5 # Data is on STDOUT.
   6 #
   7 # With an optional arg specifying the root of a CPAN mirror, outputs the
   8 # %upstream and %bug_tracker hashes too.
   9
  10 use autodie;
  11 use strict;
  12 use warnings;
  13 no  warnings 'experimental::autoderef';
  14 use File::Find;
  15 use ExtUtils::MM_Unix;
  16 use version;
  17 use lib "Porting";
  18 use Maintainers qw(%Modules files_to_modules);
  19 use File::Spec;
  20 use Parse::CPAN::Meta;
  21 use IPC::Cmd 'can_run';
  22 use HTTP::Tiny;
  23 use IO::Uncompress::Gunzip;
  24
  25 my $corelist_file = 'dist/Module-CoreList/lib/Module/CoreList.pm';
  26 my $utils_file = 'dist/Module-CoreList/lib/Module/CoreList/Utils.pm';
  27 my $pod_file = 'dist/Module-CoreList/lib/Module/CoreList.pod';
  28
  29 my %lines;
  30 my %module_to_file;
  31 my %modlist;
  32
  33 die "usage: $0 [ cpan-mirror/ ] [ 5.x.y] \n" unless @ARGV <= 2;
  34 my $cpan         = shift;
  35 my $raw_version  = shift || $];
  36 my $perl_version = version->parse("$raw_version");
  37 my $perl_vnum    = $perl_version->numify;
  38 my $perl_vstring = $perl_version->normal; # how do we get version.pm to not give us leading v?
  39 $perl_vstring =~ s/^v//;
  40
  41 if ( !-f 'MANIFEST' ) {
  42     die "Must be run from the root of a clean perl tree\n";
  43 }
  44
  45 open( my $corelist_fh, '<', $corelist_file );
  46 my $corelist = join( '', <$corelist_fh> );
  47 close $corelist_fh;
  48
  49 unless (
  50     $corelist =~ /^%released \s* = \s* \(
  51         .*?
  52         $perl_vnum \s* => \s* .*?
  53         \);/ismx
  54     )
  55 {
  56     warn "Adding $perl_vnum to the list of released perl versions. Please consider adding a release date.\n";
  57     $corelist =~ s/^(%released \s* = \s* .*?) ( \) )
  58                 /$1  $perl_vnum => '????-??-??',\n  $2/ismx;
  59 }
  60
  61 if ($cpan) {
  62     my $modlistfile = File::Spec->catfile( $cpan, 'modules', '02packages.details.txt' );
  63     my $content;
  64
  65     my $fh;
  66     if ( -e $modlistfile ) {
  67         warn "Reading the module list from $modlistfile";
  68         open $fh, '<', $modlistfile;
  69     } elsif ( -e $modlistfile . ".gz" ) {
  70         my $zcat = can_run('gzcat') || can_run('zcat') or die "Can't find gzcat or zcat";
  71         warn "Reading the module list from $modlistfile.gz";
  72         open $fh, '-|', "$zcat $modlistfile.gz";
  73     } else {
  74         warn "About to fetch 02packages from ftp.funet.fi. This may take a few minutes\n";
  75         my $gzipped_content = fetch_url('http://ftp.funet.fi/pub/CPAN/modules/02packages.details.txt.gz');
  76         unless ($gzipped_content) {
  77             die "Unable to read 02packages.details.txt from either your CPAN mirror or ftp.funet.fi";
  78         }
  79         IO::Uncompress::Gunzip::gunzip(\$gzipped_content, \$content, Transparent => 0)
  80             or die "Can't gunzip content: $IO::Uncompress::Gunzip::GunzipError";
  81     }
  82
  83     if ( $fh and !$content ) {
  84         local $/ = "\n";
  85         $content = join( '', <$fh> );
  86     }
  87
  88     die "Incompatible modlist format"
  89         unless $content =~ /^Columns: +package name, version, path/m;
  90
  91     # Converting the file to a hash is about 5 times faster than a regexp flat
  92     # lookup.
  93     for ( split( qr/\n/, $content ) ) {
  94         next unless /^([A-Za-z_:0-9]+) +[-0-9.undefHASHVERSIONvsetwhenloadingbogus]+ +(\S+)/;
  95         $modlist{$1} = $2;
  96     }
  97 }
  98
  99 find(
 100     sub {
 101         /(\.pm|_pm\.PL)$/ or return;
 102         /PPPort\.pm$/ and return;
 103         my $module = $File::Find::name;
 104         $module =~ /\b(demo|t|private)\b/ and return;    # demo or test modules
 105         my $version = MM->parse_version($_);
 106         defined $version or $version = 'undef';
 107         $version =~ /\d/ and $version = "'$version'";
 108
 109         # some heuristics to figure out the module name from the file name
 110         $module =~ s{^(lib|cpan|dist|(?:symbian/)?ext|os2/OS2)/}{}
 111                         and $1 ne 'lib'
 112             and (
 113             $module =~ s{\b(\w+)/\1\b}{$1},
 114             $module =~ s{^B/O}{O},
 115             $module =~ s{^Devel-PPPort}{Devel},
 116             $module =~ s{^libnet/}{},
 117             $module =~ s{^PathTools/}{},
 118             $module =~ s{REXX/DLL}{DLL},
 119             $module =~ s{^Encode/encoding}{encoding},
 120             $module =~ s{^IPC-SysV/}{IPC/},
 121             $module =~ s{^MIME-Base64/QuotedPrint}{MIME/QuotedPrint},
 122             $module =~ s{^(?:DynaLoader|Errno|Opcode|XSLoader)/}{},
 123             $module =~ s{^Sys-Syslog/win32}{Sys-Syslog},
 124             $module =~ s{^Time-Piece/Seconds}{Time/Seconds},
 125             );
 126                 $module =~ s{^lib/}{}g;
 127         $module =~ s{/}{::}g;
 128         $module =~ s{-}{::}g;
 129                 $module =~ s{^.*::lib::}{}; # turns Foo/lib/Foo.pm into Foo.pm
 130         $module =~ s/(\.pm|_pm\.PL)$//;
 131         $lines{$module}          = $version;
 132         $module_to_file{$module} = $File::Find::name;
 133     },
 134     'os2/OS2',
 135     'symbian/ext',
 136     'lib',
 137     'ext',
 138         'cpan',
 139         'dist'
 140 );
 141
 142 -e 'configpm' and $lines{Config} = "$]";
 143
 144 if ( open my $ucdv, "<", "lib/unicore/version" ) {
 145     chomp( my $ucd = <$ucdv> );
 146     $lines{Unicode} = "'$ucd'";
 147     close $ucdv;
 148 }
 149
 150 my $delta_data = make_corelist_delta(
 151   $perl_vnum,
 152   \%lines,
 153   \%Module::CoreList::version
 154 );
 155
 156 my $versions_in_release = "    " . $perl_vnum . " => {\n";
 157 $versions_in_release .= "        delta_from => $delta_data->{delta_from},\n";
 158 $versions_in_release .= "        changed => {\n";
 159 foreach my $key (sort keys $delta_data->{changed}) {
 160   $versions_in_release .= sprintf "            %-24s=> %s,\n", "'$key'",
 161       defined $delta_data->{changed}{$key} ? "'"
 162         . $delta_data->{changed}{$key} . "'" : "undef";
 163 }
 164 $versions_in_release .= "        },\n";
 165 $versions_in_release .= "        removed => {\n";
 166 for my $key (sort keys($delta_data->{removed} || {})) {
 167   $versions_in_release .= sprintf "            %-24s=> %s,\n", "'$key'", 1;
 168 }
 169 $versions_in_release .= "        }\n";
 170 $versions_in_release .= "    },\n";
 171
 172 $corelist =~ s/^(%delta\s*=\s*.*?)^\s*$perl_vnum\s*=>\s*{.*?},\s*(^\);)$/$1$2/ism;
 173 $corelist =~ s/^(%delta\s*=\s*.*?)(^\);)$/$1$versions_in_release$2/ism;
 174
 175 exit unless %modlist;
 176
 177 # We have to go through this two stage lookup, given how Maintainers.pl keys its
 178 # data by "Module", which is really a dist.
 179 my $file_to_M = files_to_modules( values %module_to_file );
 180
 181 sub slurp_utf8($) {
 182     open my $fh, "<:utf8", "$_[0]"
 183         or die "can't open $_[0] for reading: $!";
 184     return do { local $/; <$fh> };
 185 }
 186
 187 sub parse_cpan_meta($) {
 188     return Parse::CPAN::Meta->${
 189         $_[0] =~ /\A\x7b/ ? \"load_json_string" : \"load_yaml_string"
 190     }($_[0]);
 191 }
 192
 193 my %module_to_upstream;
 194 my %module_to_dist;
 195 my %dist_to_meta_YAML;
 196 my %module_to_deprecated;
 197 while ( my ( $module, $file ) = each %module_to_file ) {
 198     my $M = $file_to_M->{$file};
 199     next unless $M;
 200     next if $Modules{$M}{MAINTAINER} && $Modules{$M}{MAINTAINER} eq 'P5P';
 201     $module_to_upstream{$module} = $Modules{$M}{UPSTREAM};
 202     $module_to_deprecated{$module} = 1 if $Modules{$M}{DEPRECATED};
 203     next
 204         if defined $module_to_upstream{$module}
 205             && $module_to_upstream{$module} eq 'blead';
 206     my $dist = $modlist{$module};
 207     unless ($dist) {
 208         warn "Can't find a distribution for $module\n";
 209         next;
 210     }
 211     $module_to_dist{$module} = $dist;
 212
 213     next if exists $dist_to_meta_YAML{$dist};
 214
 215     $dist_to_meta_YAML{$dist} = undef;
 216
 217     # Like it or lump it, this has to be Unix format.
 218     my $meta_YAML_path = "authors/id/$dist";
 219     $meta_YAML_path =~ s/(?:tar\.gz|tar\.bz2|zip|tgz)$/meta/
 220         or die "ERROR: bad meta YAML path: '$meta_YAML_path'";
 221     my $meta_YAML_url = 'http://ftp.funet.fi/pub/CPAN/' . $meta_YAML_path;
 222
 223     if ( -e "$cpan/$meta_YAML_path" ) {
 224         $dist_to_meta_YAML{$dist} = parse_cpan_meta(slurp_utf8( $cpan . "/" . $meta_YAML_path ));
 225     } elsif ( my $content = fetch_url($meta_YAML_url) ) {
 226         unless ($content) {
 227             warn "Failed to fetch $meta_YAML_url\n";
 228             next;
 229         }
 230         eval { $dist_to_meta_YAML{$dist} = parse_cpan_meta($content); };
 231         if ( my $err = $@ ) {
 232             warn "$meta_YAML_path: ".$err;
 233             next;
 234         }
 235     } else {
 236         warn "$meta_YAML_path does not exist for $module\n";
 237
 238         # I tried code to open the tarballs with Archive::Tar to find and
 239         # extract META.yml, but only Text-Tabs+Wrap-2006.1117.tar.gz had one,
 240         # so it's not worth including.
 241         next;
 242     }
 243 }
 244
 245 my $upstream_stanza = "%upstream = (\n";
 246 foreach my $module ( sort keys %module_to_upstream ) {
 247     my $upstream = defined $module_to_upstream{$module} ? "'$module_to_upstream{$module}'" : 'undef';
 248     $upstream_stanza .= sprintf "    %-24s=> %s,\n", "'$module'", $upstream;
 249 }
 250 $upstream_stanza .= ");";
 251
 252 $corelist =~ s/^%upstream .*? ;$/$upstream_stanza/ismx;
 253
 254 # Deprecation generation
 255 {
 256   my $delta_data = make_corelist_delta(
 257     $perl_vnum,
 258     \%module_to_deprecated,
 259     do { no warnings 'once'; \%Module::CoreList::deprecated },
 260   );
 261
 262   my $deprecated_stanza = "    " . $perl_vnum . " => {\n";
 263   $deprecated_stanza .= "        delta_from => $delta_data->{delta_from},\n";
 264   $deprecated_stanza .= "        changed => {\n";
 265   foreach my $key (sort keys $delta_data->{changed}) {
 266     $deprecated_stanza .= sprintf "            %-24s=> %s,\n", "'$key'",
 267         defined $delta_data->{changed}{$key} ? "'"
 268           . $delta_data->{changed}{$key} . "'" : "undef";
 269   }
 270   $deprecated_stanza .= "        },\n";
 271   $deprecated_stanza .= "        removed => {\n";
 272   for my $key (sort keys($delta_data->{removed} || {})) {
 273     $deprecated_stanza .= sprintf "           %-24s=> %s,\n", "'$key'", 1;
 274   }
 275   $deprecated_stanza .= "        }\n";
 276   $deprecated_stanza .= "    },\n";
 277
 278   $corelist =~ s/^(%deprecated\s*=\s*.*?)^\s*$perl_vnum\s*=>\s*{.*?},\s*(^\);)$/$1$2/ism;
 279   $corelist =~ s/^(%deprecated\s*=\s*.*?)(^\);)$/$1$deprecated_stanza$2/xism;
 280 }
 281
 282 my $tracker = "%bug_tracker = (\n";
 283 foreach my $module ( sort keys %module_to_upstream ) {
 284     my $upstream = defined $module_to_upstream{$module};
 285     next
 286         if defined $upstream and $upstream eq 'blead';
 287
 288     my $bug_tracker;
 289
 290     my $dist = $module_to_dist{$module};
 291     $bug_tracker = $dist_to_meta_YAML{$dist}->{resources}{bugtracker}
 292         if $dist;
 293     $bug_tracker = $bug_tracker->{web} if ref($bug_tracker) eq "HASH";
 294
 295     $bug_tracker = defined $bug_tracker ? quote($bug_tracker) : 'undef';
 296         next if $bug_tracker eq "'http://rt.perl.org/perlbug/'";
 297     $tracker .= sprintf "    %-24s=> %s,\n", "'$module'", $bug_tracker;
 298 }
 299 $tracker .= ");";
 300
 301 $corelist =~ s/^%bug_tracker .*? ;/$tracker/eismx;
 302
 303 write_corelist($corelist,$corelist_file);
 304
 305 open( my $pod_fh, '<', $pod_file );
 306 my $pod = join( '', <$pod_fh> );
 307
 308 unless ( $pod =~ /and $perl_vstring releases of perl/ ) {
 309     warn "Adding $perl_vstring to the list of perl versions covered by Module::CoreList\n";
 310     $pod =~ s/(currently\s+covers\s+(?:.*?))\s*and\s+(.*?)\s+releases\s+of\s+perl/$1, $2 and $perl_vstring releases of perl/ism;
 311 }
 312
 313 write_corelist($pod,$pod_file);
 314
 315 open( my $utils_fh, '<', $utils_file );
 316 my $utils = join( '', <$utils_fh> );
 317 close $utils_fh;
 318
 319 my %utils = map { ( $_ => 1 ) } parse_utils_lst();
 320
 321 my $delta_utils = make_coreutils_delta($perl_vnum, \%utils);
 322
 323 my $utilities_in_release = "    " . $perl_vnum . " => {\n";
 324 $utilities_in_release .= "        delta_from => $delta_utils->{delta_from},\n";
 325 $utilities_in_release .= "        changed => {\n";
 326 foreach my $key (sort keys $delta_utils->{changed}) {
 327   $utilities_in_release .= sprintf "            %-24s=> %s,\n", "'$key'",
 328       defined $delta_utils->{changed}{$key} ? "'"
 329         . $delta_utils->{changed}{$key} . "'" : "undef";
 330 }
 331 $utilities_in_release .= "        },\n";
 332 $utilities_in_release .= "        removed => {\n";
 333 for my $key (sort keys($delta_utils->{removed} || {})) {
 334   $utilities_in_release .= sprintf "            %-24s=> %s,\n", "'$key'", 1;
 335 }
 336 $utilities_in_release .= "        }\n";
 337 $utilities_in_release .= "    },\n";
 338
 339 $utils =~ s/^(my %delta\s*=\s*.*?)^\s*$perl_vnum\s*=>\s*{.*?},\s*(^\);)$/$1$2/ism;
 340 $utils =~ s/^(my %delta\s*=\s*.*?)(^\);)$/$1$utilities_in_release$2/ism;
 341
 342 write_corelist($utils,$utils_file);
 343
 344 warn "All done. Please check over the following files carefully before committing.\nThanks!\n";
 345 warn "$corelist_file\n$pod_file\n$utils_file\n";
 346
 347 sub write_corelist {
 348     my $content = shift;
 349     my $filename = shift;
 350     open (my $clfh, ">", $filename);
 351     binmode $clfh;
 352     print $clfh $content;
 353     close($clfh);
 354 }
 355
 356 sub fetch_url {
 357     my $url = shift;
 358     my $http = HTTP::Tiny->new;
 359     my $response = $http->get($url);
 360     if ($response->{success}) {
 361         return $response->{content};
 362     } else {
 363         warn "Error fetching $url: $response->{status} $response->{reason}\n";
 364         return;
 365     }
 366 }
 367
 368 sub make_corelist_delta {
 369   my($version, $lines, $existing) = @_;
 370   # Trust core perl, if someone does use a weird version number the worst that
 371   # can happen is an extra delta entry for a module.
 372   my %versions = map { $_ => eval $lines->{$_} } keys %$lines;
 373
 374   # Ensure we have the corelist data loaded from this perl checkout, not the system one.
 375   require $corelist_file;
 376
 377   my %deltas;
 378   # Search for the release with the least amount of changes (this avoids having
 379   # to ask for where this perl was branched from).
 380   for my $previous (reverse sort keys %$existing) {
 381     # Shouldn't happen, but ensure we don't load weird data...
 382     next if $previous > $version || $previous == $version && $previous eq $version;
 383
 384     my $delta = $deltas{$previous} = {};
 385     ($delta->{changed}, $delta->{removed}) = calculate_delta(
 386       $existing->{$previous}, \%versions);
 387   }
 388
 389   my $smallest = (sort {
 390       ((keys($deltas{$a}->{changed}) + keys($deltas{$a}->{removed})) <=>
 391        (keys($deltas{$b}->{changed}) + keys($deltas{$b}->{removed}))) ||
 392       $b <=> $a
 393     } keys %deltas)[0];
 394
 395   return {
 396     delta_from => $smallest,
 397     changed => $deltas{$smallest}{changed},
 398     removed => $deltas{$smallest}{removed},
 399   }
 400 }
 401
 402 sub make_coreutils_delta {
 403   my($version, $lines) = @_;
 404   # Trust core perl, if someone does use a weird version number the worst that
 405   # can happen is an extra delta entry for a module.
 406   my %utilities = map { $_ => eval $lines->{$_} } keys %$lines;
 407
 408   # Ensure we have the corelist data loaded from this perl checkout, not the system one.
 409   require $utils_file;
 410
 411   my %deltas;
 412   # Search for the release with the least amount of changes (this avoids having
 413   # to ask for where this perl was branched from).
 414   for my $previous (reverse sort keys %Module::CoreList::Utils::utilities) {
 415     # Shouldn't happen, but ensure we don't load weird data...
 416     next if $previous > $version || $previous == $version && $previous eq $version;
 417
 418     my $delta = $deltas{$previous} = {};
 419     ($delta->{changed}, $delta->{removed}) = calculate_delta(
 420       $Module::CoreList::Utils::utilities{$previous}, \%utilities);
 421   }
 422
 423   my $smallest = (sort {
 424       ((keys($deltas{$a}->{changed}) + keys($deltas{$a}->{removed})) <=>
 425        (keys($deltas{$b}->{changed}) + keys($deltas{$b}->{removed}))) ||
 426       $b <=> $a
 427     } keys %deltas)[0];
 428
 429   return {
 430     delta_from => $smallest,
 431     changed => $deltas{$smallest}{changed},
 432     removed => $deltas{$smallest}{removed},
 433   }
 434 }
 435
 436 # Calculate (changed, removed) modules between two versions.
 437 sub calculate_delta {
 438   my($from, $to) = @_;
 439   my(%changed, %removed);
 440
 441   for my $package(keys $from) {
 442     if(not exists $to->{$package}) {
 443       $removed{$package} = 1;
 444     }
 445   }
 446
 447   for my $package(keys $to) {
 448     if(!exists $from->{$package}
 449         || (defined $from->{$package} && !defined $to->{$package})
 450         || (!defined $from->{$package} && defined $to->{$package})
 451         || (defined $from->{$package} && defined $to->{$package}
 452             && $from->{$package} ne $to->{$package})) {
 453       $changed{$package} = $to->{$package};
 454     }
 455   }
 456
 457   return \%changed, \%removed;
 458 }
 459
 460 sub quote {
 461     my ($str) = @_;
 462     # There's gotta be something already doing this properly that we could just
 463     # reuse, but I can't quite thing of where to look for it, so I'm gonna do
 464     # the simplest possible thing that'll allow me to release 5.17.7.  --rafl
 465     $str =~ s/'/\\'/g;
 466     "'${str}'";
 467 }
 468
 469 sub parse_utils_lst {
 470   require File::Spec::Unix;
 471   my @scripts;
 472   open my $fh, '<', 'utils.lst' or die "$!\n";
 473   while (<$fh>) {
 474     chomp;
 475     my ($file,$extra) = split m!#!;
 476     $file =~ s!\s+!!g;
 477     push @scripts, $file;
 478     $extra =~ s!\s+!!g if $extra;
 479     if ( $extra and my ($link) = $extra =~ m!^link=(.+?)$! ) {
 480       push @scripts, $link;
 481     }
 482   }
 483   return map { +( File::Spec::Unix->splitpath( $_ ) )[-1] } @scripts;
 484 }