add missing file from change#1943
[p5sagit/p5-mst-13.2.git] / Porting / patchls
CommitLineData
08aa1457 1#!/bin/perl -w
2#
3e3baf6d 3# patchls - patch listing utility
08aa1457 4#
5# Input is one or more patchfiles, output is a list of files to be patched.
6#
3e3baf6d 7# Copyright (c) 1997 Tim Bunce. All rights reserved.
8# This program is free software; you can redistribute it and/or
9# modify it under the same terms as Perl itself.
10#
11# With thanks to Tom Horsley for the seed code.
fb73857a 12
08aa1457 13
3e3baf6d 14use Getopt::Std;
08aa1457 15use Text::Wrap qw(wrap $columns);
16use Text::Tabs qw(expand unexpand);
17use strict;
fb73857a 18use vars qw($VERSION);
19
b73f5677 20$VERSION = 2.08;
08aa1457 21
3e3baf6d 22sub usage {
43051805 23die qq{
3e3baf6d 24 patchls [options] patchfile [ ... ]
25
84902520 26 -h no filename headers (like grep), only the listing.
27 -l no listing (like grep), only the filename headers.
fb73857a 28 -i Invert: for each patched file list which patch files patch it.
84902520 29 -c Categorise the patch and sort by category (perl specific).
30 -m print formatted Meta-information (Subject,From,Msg-ID etc).
31 -p N strip N levels of directory Prefix (like patch), else automatic.
32 -v more verbose (-d for noisy debugging).
b73f5677 33 -n give a count of the number of patches applied to a file if >1.
84902520 34 -f F only list patches which patch files matching regexp F
43051805 35 (F has \$ appended unless it contains a /).
36 -e Expect patched files to Exist (relative to current directory)
37 Will print warnings for files which don't. Also affects -4 option.
fb73857a 38 other options for special uses:
84902520 39 -I just gather and display summary Information about the patches.
fb73857a 40 -4 write to stdout the PerForce commands to prepare for patching.
43051805 41 -5 like -4 but add "|| exit 1" after each command
fb73857a 42 -M T Like -m but only output listed meta tags (eg -M 'Title From')
43 -W N set wrap width to N (defaults to 70, use 0 for no wrap)
b73f5677 44 -X list patchfiles that may clash (i.e. patch the same file)
43051805 45
46 patchls version $VERSION by Tim Bunce
3e3baf6d 47}
48}
49
3e3baf6d 50$::opt_p = undef; # undef != 0
08aa1457 51$::opt_d = 0;
52$::opt_v = 0;
53$::opt_m = 0;
b73f5677 54$::opt_n = 0;
08aa1457 55$::opt_i = 0;
56$::opt_h = 0;
57$::opt_l = 0;
58$::opt_c = 0;
84902520 59$::opt_f = '';
43051805 60$::opt_e = 0;
fb73857a 61
62# special purpose options
84902520 63$::opt_I = 0;
fb73857a 64$::opt_4 = 0; # output PerForce commands to prepare for patching
43051805 65$::opt_5 = 0;
fb73857a 66$::opt_M = ''; # like -m but only output these meta items (-M Title)
67$::opt_W = 70; # set wrap width columns (see Text::Wrap module)
43051805 68$::opt_C = 0; # 'Chip' mode (handle from/tags/article/bug files) undocumented
b73f5677 69$::opt_X = 0; # list patchfiles that patch the same file
08aa1457 70
3e3baf6d 71usage unless @ARGV;
08aa1457 72
b73f5677 73getopts("dmnihlvecC45Xp:f:IM:W:") or usage;
fb73857a 74
75$columns = $::opt_W || 9999999;
76
77$::opt_m = 1 if $::opt_M;
43051805 78$::opt_4 = 1 if $::opt_5;
b73f5677 79$::opt_i = 1 if $::opt_X;
80
81# see get_meta_info()
82my @show_meta = split(' ', $::opt_M || 'Title From Msg-ID Files');
83my %show_meta = map { ($_,1) } @show_meta;
08aa1457 84
3e3baf6d 85my %cat_title = (
84902520 86 'BUILD' => 'BUILD PROCESS',
87 'CORE' => 'CORE LANGUAGE',
3e3baf6d 88 'DOC' => 'DOCUMENTATION',
b73f5677 89 'LIB' => 'LIBRARY',
84902520 90 'PORT1' => 'PORTABILITY - WIN32',
fb73857a 91 'PORT2' => 'PORTABILITY - GENERAL',
84902520 92 'TEST' => 'TESTS',
93 'UTIL' => 'UTILITIES',
94 'OTHER' => 'OTHER CHANGES',
b73f5677 95 'EXT' => 'EXTENSIONS',
96 'UNKNOWN' => 'UNKNOWN - NO FILES PATCH',
3e3baf6d 97);
08aa1457 98
43051805 99
100sub get_meta_info {
101 my $ls = shift;
102 local($_) = shift;
b73f5677 103 if (/^From:\s+(.*\S)/i) {;
104 my $from = $1; # temporary measure for Chip Salzenberg
105 $from =~ s/chip\@(atlantic\.net|perlsupport\.com)/chip\@pobox.com/;
106 $from =~ s/\(Tim Bunce\) \(Tim Bunce\)/(Tim Bunce)/;
107 $ls->{From}{$from} = 1
108 }
109 if (/^Subject:\s+(?:Re: )?(.*\S)/i) {
110 my $title = $1;
111 $title =~ s/\[(PATCH|PERL)[\w\. ]*\]:?//g;
112 $title =~ s/\b(PATCH|PERL)[\w\.]*://g;
113 $title =~ s/\bRe:\s+/ /g;
114 $title =~ s/\s+/ /g;
115 $title =~ s/^\s*(.*?)\s*$/$1/g;
116 $ls->{Title}{$title} = 1;
117 }
43051805 118 $ls->{'Msg-ID'}{$1}=1 if /^Message-Id:\s+(.*\S)/i;
119 $ls->{Date}{$1}=1 if /^Date:\s+(.*\S)/i;
120 $ls->{$1}{$2}=1 if $::opt_M && /^([-\w]+):\s+(.*\S)/;
121}
122
08aa1457 123
124# Style 1:
125# *** perl-5.004/embed.h Sat May 10 03:39:32 1997
126# --- perl-5.004.fixed/embed.h Thu May 29 19:48:46 1997
127# ***************
128# *** 308,313 ****
129# --- 308,314 ----
130#
131# Style 2:
132# --- perl5.004001/mg.c Sun Jun 08 12:26:24 1997
133# +++ perl5.004-bc/mg.c Sun Jun 08 11:56:08 1997
134# @@ -656,9 +656,27 @@
135# or (rcs, note the different date format)
136# --- 1.18 1997/05/23 19:22:04
137# +++ ./pod/perlembed.pod 1997/06/03 21:41:38
138#
139# Variation:
140# Index: embed.h
141
43051805 142my %ls;
143
b73f5677 144my $in;
145my $ls;
146my $prevline = '';
43051805 147my $prevtype = '';
148my (@removed, @added);
fb73857a 149my $prologue = 1; # assume prologue till patch or /^exit\b/ seen
08aa1457 150
43051805 151
08aa1457 152foreach my $argv (@ARGV) {
153 $in = $argv;
154 unless (open F, "<$in") {
155 warn "Unable to open $in: $!\n";
156 next;
157 }
158 print "Reading $in...\n" if $::opt_v and @ARGV > 1;
3e3baf6d 159 $ls = $ls{$in} ||= { is_in => 1, in => $in };
08aa1457 160 my $type;
161 while (<F>) {
162 unless (/^([-+*]{3}) / || /^(Index):/) {
fb73857a 163 # not an interesting patch line
164 # but possibly meta-information or prologue
165 if ($prologue) {
166 push @added, $1 if /^touch\s+(\S+)/;
167 push @removed, $1 if /^rm\s+(?:-f)?\s*(\S+)/;
168 $prologue = 0 if /^exit\b/;
169 }
43051805 170 get_meta_info($ls, $_) if $::opt_m;
08aa1457 171 next;
172 }
173 $type = $1;
174 next if /^--- [0-9,]+ ----$/ || /^\*\*\* [0-9,]+ \*\*\*\*$/;
fb73857a 175 $prologue = 0;
08aa1457 176
b73f5677 177 print "Last: $prevline","This: ${_}Got: $type\n\n" if $::opt_d;
08aa1457 178
179 # Some patches have Index lines but not diff headers
3e3baf6d 180 # Patch copes with this, so must we. It's also handy for
181 # documenting manual changes by simply adding Index: lines
b73f5677 182 # to the file which describes the problem being fixed.
183 if (/^Index:\s+(.*)/) {
184 my $f;
185 foreach $f (split(/ /, $1)) { add_file($ls, $f) }
186 next;
187 }
08aa1457 188
189 if ( ($type eq '---' and $prevtype eq '***') # Style 1
190 or ($type eq '+++' and $prevtype eq '---') # Style 2
191 ) {
fb73857a 192 if (/^[-+*]{3} (\S+)\s*(.*?\d\d:\d\d:\d\d)?/) { # double check
08aa1457 193 add_file($ls, $1);
194 }
195 else {
196 warn "$in $.: parse error (prev $prevtype, type $type)\n$prevline$_";
197 }
198 }
199 }
200 continue {
201 $prevline = $_;
b73f5677 202 $prevtype = $type || '';
08aa1457 203 $type = '';
204 }
43051805 205
206 # special mode for patch sets from Chip
b73f5677 207 if ($in =~ m:[\\/]patch$:) {
208 my $is_chip;
43051805 209 my $chip;
210 my $dir; ($dir = $in) =~ s:[\\/]patch$::;
211 if (!$ls->{From} && (open(CHIP,"$dir/article") || open(CHIP,"$dir/bug"))) {
212 get_meta_info($ls, $_) while (<CHIP>);
b73f5677 213 $is_chip = 1;
43051805 214 }
215 if (open CHIP,"<$dir/from") {
216 chop($chip = <CHIP>);
217 $ls->{From} = { $chip => 1 };
b73f5677 218 $is_chip = 1;
43051805 219 }
220 if (open CHIP,"<$dir/tag") {
221 chop($chip = <CHIP>);
222 $ls->{Title} = { $chip => 1 };
b73f5677 223 $is_chip = 1;
43051805 224 }
b73f5677 225 $ls->{From} = { "Chip Salzenberg" => 1 } if $is_chip && !$ls->{From};
43051805 226 }
227
3e3baf6d 228 # if we don't have a title for -m then use the file name
229 $ls->{Title}{$in}=1 if $::opt_m
230 and !$ls->{Title} and $ls->{out};
231
232 $ls->{category} = $::opt_c
233 ? categorize_files([keys %{ $ls->{out} }], $::opt_v) : '';
08aa1457 234}
3e3baf6d 235print scalar(@ARGV)." files read.\n" if $::opt_v and @ARGV > 1;
236
237
fb73857a 238# --- Firstly we filter and sort as needed ---
239
240my @ls = values %ls;
08aa1457 241
84902520 242if ($::opt_f) { # filter out patches based on -f <regexp>
84902520 243 $::opt_f .= '$' unless $::opt_f =~ m:/:;
244 @ls = grep {
84902520 245 my $match = 0;
b73f5677 246 if ($_->{is_in}) {
247 my @out = keys %{ $_->{out} };
248 $match=1 if grep { m/$::opt_f/o } @out;
249 }
250 else {
251 $match=1 if $_->{in} =~ m/$::opt_f/o;
84902520 252 }
253 $match;
254 } @ls;
255}
256
fb73857a 257@ls = sort {
258 $a->{category} cmp $b->{category} || $a->{in} cmp $b->{in}
259} @ls;
260
261
262# --- Handle special modes ---
263
264if ($::opt_4) {
43051805 265 my $tail = ($::opt_5) ? "|| exit 1" : "";
266 print map { "p4 delete $_$tail\n" } @removed if @removed;
267 print map { "p4 add $_$tail\n" } @added if @added;
b73f5677 268 my @patches = sort grep { $_->{is_in} } @ls;
269 my @no_outs = grep { keys %{$_->{out}} == 0 } @patches;
270 warn "Warning: Some files contain no patches:",
271 join("\n\t", '', map { $_->{in} } @no_outs), "\n" if @no_outs;
fb73857a 272 my %patched = map { ($_, 1) } map { keys %{$_->{out}} } @patches;
273 delete @patched{@added};
274 my @patched = sort keys %patched;
b73f5677 275 foreach(@patched) {
43051805 276 my $edit = ($::opt_e && !-f $_) ? "add " : "edit";
b73f5677 277 print "p4 $edit $_$tail\n";
278 }
43051805 279 exit 0 unless $::opt_C;
fb73857a 280}
281
b73f5677 282
84902520 283if ($::opt_I) {
284 my $n_patches = 0;
285 my($in,$out);
286 my %all_out;
b73f5677 287 my @no_outs;
84902520 288 foreach $in (@ls) {
289 next unless $in->{is_in};
290 ++$n_patches;
291 my @outs = keys %{$in->{out}};
b73f5677 292 push @no_outs, $in unless @outs;
84902520 293 @all_out{@outs} = ($in->{in}) x @outs;
294 }
295 my @all_out = sort keys %all_out;
296 my @missing = grep { ! -f $_ } @all_out;
297 print "$n_patches patch files patch ".@all_out." files (".@missing." missing)\n";
b73f5677 298 print @no_outs." patch files don't contain patches.\n" if @no_outs;
fb73857a 299 print "(use -v to list patches which patch 'missing' files)\n"
b73f5677 300 if (@missing || @no_outs) && !$::opt_v;
301 if ($::opt_v and @no_outs) {
302 print "Patch files which don't contain patches:\n";
303 foreach $out (@no_outs) {
304 printf " %-20s\n", $out->{in};
305 }
306 }
84902520 307 if ($::opt_v and @missing) {
308 print "Missing files:\n";
309 foreach $out (@missing) {
b73f5677 310 printf " %-20s\t", $out unless $::opt_h;
311 print $all_out{$out} unless $::opt_l;
312 print "\n";
84902520 313 }
314 }
fb73857a 315 print "Added files: @added\n" if @added;
316 print "Removed files: @removed\n" if @removed;
84902520 317 exit 0+@missing;
318}
319
08aa1457 320unless ($::opt_c and $::opt_m) {
3e3baf6d 321 foreach $ls (@ls) {
322 next unless ($::opt_i) ? $ls->{is_out} : $ls->{is_in};
b73f5677 323 next if $::opt_X and keys %{$ls->{out}} <= 1;
08aa1457 324 list_files_by_patch($ls);
325 }
326}
327else {
328 my $c = '';
3e3baf6d 329 foreach $ls (@ls) {
330 next unless ($::opt_i) ? $ls->{is_out} : $ls->{is_in};
84902520 331 print "\n ------ $cat_title{$ls->{category}} ------\n"
332 if $ls->{category} ne $c;
08aa1457 333 $c = $ls->{category};
3e3baf6d 334 unless ($::opt_i) {
335 list_files_by_patch($ls);
336 }
337 else {
338 my $out = $ls->{in};
339 print "\n$out patched by:\n";
340 # find all the patches which patch $out and list them
341 my @p = grep { $_->{out}->{$out} } values %ls;
342 foreach $ls (@p) {
343 list_files_by_patch($ls, '');
344 }
345 }
08aa1457 346 }
347 print "\n";
348}
349
3e3baf6d 350exit 0;
351
352
353# ---
354
08aa1457 355
356sub add_file {
357 my $ls = shift;
b73f5677 358 print "add_file '$_[0]'\n" if $::opt_d;
08aa1457 359 my $out = trim_name(shift);
3e3baf6d 360
361 $ls->{out}->{$out} = 1;
362
43051805 363 warn "$out patched but not present\n" if $::opt_e && !-f $out;
364
3e3baf6d 365 # do the -i inverse as well, even if we're not doing -i
366 my $i = $ls{$out} ||= {
367 is_out => 1,
368 in => $out,
369 category => $::opt_c ? categorize_files([ $out ], $::opt_v) : '',
370 };
371 $i->{out}->{$in} = 1;
08aa1457 372}
373
374
375sub trim_name { # reduce/tidy file paths from diff lines
376 my $name = shift;
377 $name = "$name ($in)" if $name eq "/dev/null";
84902520 378 $name =~ s:\\:/:g; # adjust windows paths
379 $name =~ s://:/:g; # simplify (and make win \\share into absolute path)
08aa1457 380 if (defined $::opt_p) {
381 # strip on -p levels of directory prefix
382 my $dc = $::opt_p;
383 $name =~ s:^[^/]+/(.+)$:$1: while $dc-- > 0;
384 }
385 else { # try to strip off leading path to perl directory
386 # if absolute path, strip down to any *perl* directory first
387 $name =~ s:^/.*?perl.*?/::i;
84902520 388 $name =~ s:.*perl[-_]?5?[._]?[-_a-z0-9.+]*/::i;
08aa1457 389 $name =~ s:^\./::;
390 }
391 return $name;
392}
393
394
395sub list_files_by_patch {
3e3baf6d 396 my($ls, $name) = @_;
397 $name = $ls->{in} unless defined $name;
08aa1457 398 my @meta;
399 if ($::opt_m) {
fb73857a 400 my $meta;
401 foreach $meta (@show_meta) {
402 next unless $ls->{$meta};
403 my @list = sort keys %{$ls->{$meta}};
404 push @meta, sprintf "%7s: ", $meta;
405 if ($meta eq 'Title') {
b73f5677 406 @list = map { "\"$_\""; } @list;
43051805 407 push @list, "#$1" if $::opt_C && $ls->{in} =~ m:\b(\w\d+)/patch$:;
fb73857a 408 }
409 elsif ($meta eq 'From') {
410 # fix-up bizzare addresses from japan and ibm :-)
411 foreach(@list) {
412 s:\W+=?iso.*?<: <:;
413 s/\d\d-\w\w\w-\d{4}\s+\d\d:\S+\s*//;
414 }
415 }
416 elsif ($meta eq 'Msg-ID') {
417 my %from; # limit long threads to one msg-id per site
418 @list = map {
419 $from{(/@(.*?)>/ ? $1 : $_)}++ ? () : ($_);
420 } @list;
421 }
08aa1457 422 push @meta, my_wrap(""," ", join(", ",@list)."\n");
423 }
3e3baf6d 424 $name = "\n$name" if @meta and $name;
08aa1457 425 }
426 # don't print the header unless the file contains something interesting
b73f5677 427 return if !@meta and !$ls->{out} and !$::opt_v;
428 if ($::opt_l) { # -l = no listing, just names
429 print "$ls->{in}";
430 my $n = keys %{ $ls->{out} };
431 print " ($n patches)" if $::opt_n and $n>1;
432 print "\n";
433 return;
434 }
08aa1457 435
3e3baf6d 436 # a twisty maze of little options
437 my $cat = ($ls->{category} and !$::opt_m) ? "\t$ls->{category}" : "";
438 print "$name$cat: " unless ($::opt_h and !$::opt_v) or !"$name$cat";
08aa1457 439 print join('',"\n",@meta) if @meta;
440
b73f5677 441 return if $::opt_m && !$show_meta{Files};
3e3baf6d 442 my @v = sort PATORDER keys %{ $ls->{out} };
b73f5677 443 my $n = @v;
444 my $v = "@v";
08aa1457 445 print $::opt_m ? " Files: ".my_wrap(""," ",$v) : $v;
b73f5677 446 print " ($n patches)" if $::opt_n and $n>1;
447 print "\n";
08aa1457 448}
449
450
451sub my_wrap {
84902520 452 my $txt = eval { expand(wrap(@_)) }; # die's on long lines!
453 return $txt unless $@;
454 return expand("@_");
08aa1457 455}
456
457
458
3e3baf6d 459sub categorize_files {
460 my($files, $verb) = @_;
08aa1457 461 my(%c, $refine);
3e3baf6d 462
463 foreach (@$files) { # assign a score to a file path
464 # the order of some of the tests is important
465 $c{TEST} += 5,next if m:^t/:;
466 $c{DOC} += 5,next if m:^pod/:;
467 $c{UTIL} += 10,next if m:^(utils|x2p|h2pl)/:;
84902520 468 $c{PORT1}+= 15,next if m:^win32:;
469 $c{PORT2} += 15,next
470 if m:^(cygwin32|os2|plan9|qnx|vms)/:
08aa1457 471 or m:^(hints|Porting|ext/DynaLoader)/:
472 or m:^README\.:;
b73f5677 473 $c{EXT} += 10,next
474 if m:^(ext|lib/ExtUtils)/:;
3e3baf6d 475 $c{LIB} += 10,next
b73f5677 476 if m:^(lib)/:;
3e3baf6d 477 $c{'CORE'} += 15,next
84902520 478 if m:^[^/]+[\._]([chH]|sym|pl)$:;
3e3baf6d 479 $c{BUILD} += 10,next
08aa1457 480 if m:^[A-Z]+$: or m:^[^/]+\.SH$:
84902520 481 or m:^(install|configure|configpm):i;
08aa1457 482 print "Couldn't categorise $_\n" if $::opt_v;
3e3baf6d 483 $c{OTHER} += 1;
484 }
485 if (keys %c > 1) { # sort to find category with highest score
486 refine:
487 ++$refine;
488 my @c = sort { $c{$b} <=> $c{$a} || $a cmp $b } keys %c;
489 my @v = map { $c{$_} } @c;
490 if (@v > 1 and $refine <= 1 and "@v" =~ /^(\d) \1/
491 and $c[0] =~ m/^(DOC|TESTS|OTHER)/) { # rare
492 print "Tie, promoting $c[1] over $c[0]\n" if $::opt_d;
493 ++$c{$c[1]};
494 goto refine;
495 }
496 print " ".@$files." patches: ", join(", ", map { "$_: $c{$_}" } @c),".\n"
497 if $verb;
498 return $c[0] || 'OTHER';
08aa1457 499 }
3e3baf6d 500 else {
501 my($c, $v) = %c;
b73f5677 502 $c ||= 'UNKNOWN'; $v ||= 0;
3e3baf6d 503 print " ".@$files." patches: $c: $v\n" if $verb;
504 return $c;
08aa1457 505 }
08aa1457 506}
507
508
509sub PATORDER { # PATORDER sort by Chip Salzenberg
510 my ($i, $j);
511
512 $i = ($a =~ m#^[A-Z]+$#);
513 $j = ($b =~ m#^[A-Z]+$#);
514 return $j - $i if $i != $j;
515
516 $i = ($a =~ m#configure|hint#i) || ($a =~ m#[S_]H$#);
517 $j = ($b =~ m#configure|hint#i) || ($b =~ m#[S_]H$#);
518 return $j - $i if $i != $j;
519
520 $i = ($a =~ m#\.pod$#);
521 $j = ($b =~ m#\.pod$#);
522 return $j - $i if $i != $j;
523
524 $i = ($a =~ m#include/#);
525 $j = ($b =~ m#include/#);
526 return $j - $i if $i != $j;
527
528 if ((($i = $a) =~ s#/+[^/]*$##)
529 && (($j = $b) =~ s#/+[^/]*$##)) {
530 return $i cmp $j if $i ne $j;
531 }
532
533 $i = ($a =~ m#\.h$#);
534 $j = ($b =~ m#\.h$#);
535 return $j - $i if $i != $j;
536
537 return $a cmp $b;
538}
539