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